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!! the best part
Get the entire series - the other best part
Works with Rails 3.0+
Supports PostgreSQL and MySQL
:cupid: Goes hand in hand with Chartkick
Get Started
User.group_by_day(:created_at).count
# {
# 2013-04-16 00:00:00 UTC => 50,
# 2013-04-17 00:00:00 UTC => 100,
# 2013-04-18 00:00:00 UTC => 34
# }
Task.group_by_month(:updated_at).count
# {
# 2013-02-01 00:00:00 UTC => 84,
# 2013-03-01 00:00:00 UTC => 23,
# 2013-04-01 00:00:00 UTC => 44
# }
Goal.group_by_year(:accomplished_at).count
# {
# 2011-01-01 00:00:00 UTC => 7,
# 2012-01-01 00:00:00 UTC => 11,
# 2013-01-01 00:00:00 UTC => 3
# }
Results are returned in ascending order, so no need to sort.
The default time zone is Time.zone. Pass a time zone with:
User.group_by_week(:created_at, time_zone: "Pacific Time (US & Canada)").count
# {
# 2013-03-03 08:00:00 UTC => 80,
# 2013-03-10 08:00:00 UTC => 70,
# 2013-03-17 07:00:00 UTC => 54
# }
# equivalently
time_zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
User.group_by_week(:created_at, time_zone: time_zone).count
Note: Weeks start on Sunday by default.
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).count
# {
# 0 => 34,
# 1 => 61,
# ...
# 23 => 12
# }
Works with all aggregate functions, like average, minimum, and maximum.
Request.group_by_minute(:started_at).average(:request_time)
Customize
You can change the day weeks start with:
User.group_by_week(:created_at, week_start: :mon) # first three letters of day
# change globally
Groupdate.week_start = :mon
You can change the hour days start with:
User.group_by_day(:created_at, day_start: 2) # 2 am - 2 am
# change globally
Groupdate.day_start = 2
Works with day, week, month, year and hour_of_day.
The default time zone is Time.zone. To change this, use:
Groupdate.time_zone = "Pacific Time (US & Canada)"
To return an ActiveRecord::Relation instead of a Groupdate::Series, use:
User.group_by_day(:created_at, series: false)
Note: Results will be unordered, and days with no records will not appear.
Installation
Add this line to your application’s Gemfile:
gem 'groupdate'
For MySQL
Time zone support must be installed on the server.
mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
For JRuby
Use the master version of your JDBC adapter. You will get incorrect results for versions before this commit.
# postgresql
gem "activerecord-jdbcpostgresql-adapter", :github => "jruby/activerecord-jdbc-adapter"
# mysql
gem "activerecord-jdbcmysql-adapter", :github => "jruby/activerecord-jdbc-adapter"
Complete list
group_by_?
- second
- minute
- hour
- day
- week
- month
- year
- hour_of_day
- day_of_week
History
View the changelog
Groupdate follows Semantic Versioning
Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- Report bugs
- Fix bugs and submit pull requests
- Write, clarify, or fix documentation
- Suggest or add new features