README.md
Groupdate
The simplest way to group by:
- day
- week
- month
- day of the week
- hour of the day
- and more (complete list at bottom)
:tada: Time zones supported!!
PostgreSQL and MySQL only at the moment - support for other datastores coming soon
Usage
User.group_by_day(:created_at).count
# {
# "2013-04-16 00:00:00+00" => 50,
# "2013-04-17 00:00:00+00" => 100,
# "2013-04-18 00:00:00+00" => 34
# }
Task.group_by_month(:updated_at).count
# {
# "2013-02-01 00:00:00+00" => 84,
# "2013-03-01 00:00:00+00" => 23,
# "2013-04-01 00:00:00+00" => 44
# }
Goal.group_by_year(:accomplished_at).count
# {
# "2011-01-01 00:00:00+00" => 7,
# "2012-01-01 00:00:00+00" => 11,
# "2013-01-01 00:00:00+00" => 3
# }
The default time zone is Time.zone. Pass a time zone as the second argument.
User.group_by_week(:created_at, "Pacific Time (US & Canada)").count
# {
# "2013-03-03 08:00:00+00" => 80,
# "2013-03-10 08:00:00+00" => 70,
# "2013-03-17 07:00:00+00" => 54
# }
# equivalently
time_zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
User.group_by_week(:created_at, time_zone).count
Note: Weeks start on Sunday.
You can also group by the day of the week or hour of the day.
# day of the week
User.group_by_day_of_week(:created_at).count
# {
# "0" => 54, # Sunday
# "1" => 2, # Monday
# ...
# "6" => 3 # Saturday
# }
# hour of the day
User.group_by_hour_of_day(:created_at, "Pacific Time (US & Canada)").count
# {
# "0" => 34,
# "1" => 61,
# ...
# "23" => 12
# }
Use it with anything you can use group with:
Task.completed.group_by_hour(:completed_at).average(:priority)
Go nuts!
Request.where(page: "/home").group_by_minute(:started_at).maximum(:request_time)
Note: On Rails 4 edge, queries return a Time object (much better!) as a result of this commit
Installation
Add this line to your application's Gemfile:
gem 'groupdate'
Complete list
group_by_?
- second
- minute
- hour
- day
- week
- month
- year
- hour_of_day
- day_of_week
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request