groupdate 3.2.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df818b929dceeddfccab948ceb591ad26c7334c8
-  data.tar.gz: 370a704d7ff6a17fb82bb057d717141ed87bc69f
+SHA256:
+  metadata.gz: 372cf4471ee65729f41e684b45f5b3e05333379390fab3956df568a2fa89c8cd
+  data.tar.gz: 549f1a34474348dfc96c7a0c244218688e4c2d45cd9b935a3c5ff63b03873968
 SHA512:
-  metadata.gz: 7a77d1af0c530bfab9552ddff8f7149575c9821bcff772d33454b50c0050561d861a7eb5f220c5aa19200f80194f07c6a550c412be2ac76eedd88dbddb143faf
-  data.tar.gz: 91d207a5493bcafe51e94a884809e37b8250e9c2e581bf26172a5d0810d32c64aa63f21aead7935d1096c4d27dcde4c8d49cc8de821cdae4c83634e6a168cf94
+  metadata.gz: 17009c3b4061583998a5419edca9b62fb138136097d9ef1a719dc04a09bd5f3583be45bae5639498000318cffa2d5d2e0a31b0e2f564a1d3cc61016d1db7f4f2
+  data.tar.gz: 1fcb4a2a87baf147fa763508f0b17b01bbae8c28fed284055282ec196163e92026548f87ddcf381fba280c2d5a2e4a61adb54d8e8f4334252ec481e4f04f92d9

data/CHANGELOG.md

@@ -1,29 +1,148 @@
-## 3.2.0
+## 6.2.1 (2023-04-18)
+
+- Fixed extra day with `DateTime` ranges
+
+## 6.2.0 (2023-01-29)
+
+- Added support for async methods with Active Record 7.1
+
+## 6.1.0 (2022-04-05)
+
+- Added `expand_range` option
+
+## 6.0.1 (2022-01-16)
+
+- Fixed incorrect results (error before 6.0) with `includes` with Active Record 6.1+
+
+## 6.0.0 (2022-01-15)
+
+- Raise `ActiveRecord::UnknownAttributeReference` for non-attribute arguments
+- Raise `ArgumentError` for ranges with string bounds
+- Added `n` option for Redshift
+- Changed SQL to return dates instead of times for day, week, month, quarter, and year
+- Removed `dates` option
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
+## 5.2.4 (2021-12-15)
+
+- Simplified queries for Active Record 7 and MySQL
+
+## 5.2.3 (2021-12-06)
+
+- Fixed error and warnings with Active Record 7
+
+## 5.2.2 (2021-02-08)
+
+- Added support for `nil..nil` ranges in `range` option
+
+## 5.2.1 (2020-09-09)
+
+- Improved error message for invalid ranges
+- Fixed bug with date string ranges
+
+## 5.2.0 (2020-09-07)
+
+- Added warning for non-attribute argument
+- Added support for beginless and endless ranges in `range` option
+
+## 5.1.0 (2020-07-30)
+
+- Added `n` option to minute and second for custom durations
+
+## 5.0.0 (2020-02-18)
+
+- Added support for `week_start` for SQLite
+- Added support for full weekday names
+- Made `day_start` behavior consistent between Active Record and enumerable
+- Made `last` option extend to end of current period
+- Raise error when `day_start` and `week_start` passed to unsupported methods
+- The `day_start` option no longer applies to shorter periods
+- Fixed `inconsistent time zone info` errors around DST with MySQL and PostgreSQL
+- Improved performance of `format` option
+- Removed deprecated positional arguments for time zone and range
+- Dropped support for `mysql` gem (last release was 2013)
+
+## 4.3.0 (2019-12-26)
+
+- Fixed error with empty results in Ruby 2.7
+- Fixed deprecation warnings in Ruby 2.7
+- Deprecated positional arguments for time zone and range
+
+## 4.2.0 (2019-10-28)
+
+- Added `day_of_year`
+- Dropped support for Rails 4.2
+
+## 4.1.2 (2019-05-26)
+
+- Fixed error with empty data and `current: false`
+- Fixed error in time zone check for Rails < 5.2
+- Prevent infinite loop with endless ranges
+
+## 4.1.1 (2018-12-11)
+
+- Made column resolution consistent with `group`
+- Added support for `alias_attribute`
+
+## 4.1.0 (2018-11-04)
+
+- Many performance improvements
+- Added check for consistent time zone info
+- Fixed error message for invalid queries with MySQL and SQLite
+- Fixed issue with enumerable methods ignoring nils
+
+## 4.0.2 (2018-10-15)
+
+- Make `current` option work without `last`
+- Fixed default value for `maximum`, `minimum`, and `average` (periods with no results now return `nil` instead of `0`, pass `default_value: 0` for previous behavior)
+
+## 4.0.1 (2018-05-03)
+
+- Fixed incorrect range with `last` option near time change
+
+## 4.0.0 (2018-02-21)
+
+- Custom calculation methods are supported by default - `groupdate_calculation_methods` is no longer needed
+
+Breaking changes
+
+- Dropped support for Rails < 4.2
+- Invalid options now throw an `ArgumentError`
+- `group_by` methods return an `ActiveRecord::Relation` instead of a `Groupdate::Series`
+- `week_start` now affects `day_of_week`
+- Removed support for `reverse_order` (was never supported in Rails 5)
+
+## 3.2.1 (2018-02-21)
+
+- Added `minute_of_hour`
+- Added support for `unscoped`
+
+## 3.2.0 (2017-01-30)
 
 - Added limited support for SQLite
 
-## 3.1.1
+## 3.1.1 (2016-10-25)
 
 - Fixed `current: false`
 - Fixed `last` with `group_by_quarter`
 - Raise `ArgumentError` when `last` option is not supported
 
-## 3.1.0
+## 3.1.0 (2016-10-22)
 
 - Better support for date columns with `time_zone: false`
 - Better date range handling for `range` option
 
-## 3.0.2
+## 3.0.2 (2016-08-09)
 
 - Fixed `group_by_period` with associations
 - Fixed `week_start` option for enumerables
 
-## 3.0.1
+## 3.0.1 (2016-07-13)
 
 - Added support for Redshift
 - Fix for infinite loop in certain cases for Rails 5
 
-## 3.0.0
+## 3.0.0 (2016-05-30)
 
 Breaking changes
 
@@ -31,16 +150,16 @@ Breaking changes
 - Array and hash methods no longer return the entire series by default. Use `series: true` for the previous behavior.
 - The `series: false` option now returns the correct types and order, and plays nicely with other options.
 
-## 2.5.3
+## 2.5.3 (2016-04-28)
 
 - All tests green with `mysql` gem
 - Added support for decimal day start
 
-## 2.5.2
+## 2.5.2 (2016-02-16)
 
 - Added `dates` option to return dates for day, week, month, quarter, and year
 
-## 2.5.1
+## 2.5.1 (2016-02-03)
 
 - Added `group_by_quarter`
 - Added `default_value` option
@@ -48,13 +167,13 @@ Breaking changes
 - Raise `ArgumentError` if no field specified
 - Added support for ActiveRecord 5 beta
 
-## 2.5.0
+## 2.5.0 (2015-09-29)
 
 - Added `group_by_period` method
 - Added `current` option
 - Raise `ArgumentError` if no block given to enumerable
 
-## 2.4.0
+## 2.4.0 (2014-12-28)
 
 - Added localization
 - Added `carry_forward` option
@@ -62,77 +181,77 @@ Breaking changes
 - Fixed issue w/ Brasilia Summer Time
 - Fixed issues w/ ActiveRecord 4.2
 
-## 2.3.0
+## 2.3.0 (2014-08-31)
 
 - Raise error when ActiveRecord::Base.default_timezone is not `:utc`
 - Added `day_of_month`
 - Added `month_of_year`
 - Do not quote column name
 
-## 2.2.1
+## 2.2.1 (2014-06-23)
 
 - Fixed ActiveRecord 3 associations
 
-## 2.2.0
+## 2.2.0 (2014-06-22)
 
 - Added support for arrays and hashes
 
-## 2.1.1
+## 2.1.1 (2014-05-17)
 
 - Fixed format option with multiple groups
 - Better error message if time zone support is missing for MySQL
 
-## 2.1.0
+## 2.1.0 (2014-03-16)
 
 - Added last option
 - Added format option
 
-## 2.0.4
+## 2.0.4 (2014-03-12)
 
 - Added multiple groups
 - Added order
 - Subsequent methods no longer modify relation
 
-## 2.0.3
+## 2.0.3 (2014-03-11)
 
 - Implemented respond_to?
 
-## 2.0.2
+## 2.0.2 (2014-03-11)
 
 - where, joins, and includes no longer need to be before the group_by method
 
-## 2.0.1
+## 2.0.1 (2014-03-07)
 
 - Use time zone instead of UTC for results
 
-## 2.0.0
+## 2.0.0 (2014-03-07)
 
 - Returns entire series by default
 - Added day_start option
 - Better interface
 
-## 1.0.5
+## 1.0.5 (2014-03-06)
 
 - Added global time_zone option
 
-## 1.0.4
+## 1.0.4 (2013-07-20)
 
 - Added global week_start option
 - Fixed bug with NULL values and series
 
-## 1.0.3
+## 1.0.3 (2013-07-05)
 
 - Fixed deprecation warning when used with will_paginate
 - Fixed bug with DateTime series
 
-## 1.0.2
+## 1.0.2 (2013-06-10)
 
 - Added :start option for custom week start for group_by_week
 
-## 1.0.1
+## 1.0.1 (2013-06-03)
 
 - Fixed series for Rails < 3.2 and MySQL
 
-## 1.0.0
+## 1.0.0 (2013-05-15)
 
 - First major release

data/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Help
+
+We’re not able to provide support through GitHub Issues. If you’re looking for help with your code, try posting on [Stack Overflow](https://stackoverflow.com/).
+
+All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist.
+
+## Bugs
+
+Think you’ve discovered a bug?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "groupdate", github: "ankane/groupdate"
+```
+
+If the above steps don’t help, create an issue. Include:
+
+- Detailed steps to reproduce
+- Complete backtraces for exceptions
+
+## New Features
+
+If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`.
+
+## Pull Requests
+
+Fork the project and create a pull request. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+- Add one or more tests if possible. Make sure existing tests pass with:
+
+```sh
+bundle exec rake test
+```
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+## Dev Setup
+
+On Mac:
+
+```sh
+# install and run PostgreSQL
+brew install postgresql
+brew services start postgresql
+
+# install and run MySQL
+brew install mysql
+brew services start mysql
+
+# create databases
+createdb groupdate_test
+mysqladmin create groupdate_test
+mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
+
+# clone the repo and run the tests
+git clone https://github.com/ankane/groupdate.git
+cd groupdate
+bundle install
+bundle exec rake test
+
+# run a single test file
+ruby test/postgresql_test.rb
+```
+
+---
+
+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Andrew Kane
+Copyright (c) 2013-2022 Andrew Kane
 
 MIT License
 

data/README.md

@@ -11,24 +11,30 @@ The simplest way to group by:
 
 :cake: Get the entire series - **the other best part**
 
-Supports PostgreSQL, MySQL, and Redshift, plus arrays and hashes
+Supports PostgreSQL, MySQL, and Redshift, plus arrays and hashes (and limited support for [SQLite](#for-sqlite))
 
-Limited support for [SQLite](#for-sqlite)
+:cupid: Goes hand in hand with [Chartkick](https://www.chartkick.com)
 
-[![Build Status](https://travis-ci.org/ankane/groupdate.svg?branch=master)](https://travis-ci.org/ankane/groupdate)
+[![Build Status](https://github.com/ankane/groupdate/workflows/build/badge.svg?branch=master)](https://github.com/ankane/groupdate/actions)
 
-:cupid: Goes hand in hand with [Chartkick](http://ankane.github.io/chartkick/)
+## Installation
+
+Add this line to your application’s Gemfile:
 
-**Groupdate 3.0 was just released!** See [instructions for upgrading](#30). If you use Chartkick with Groupdate, we recommend Chartkick 2.0 and above.
+```ruby
+gem "groupdate"
+```
 
-## Get Started
+For MySQL and SQLite, also follow [these instructions](#additional-instructions).
+
+## Getting Started
 
 ```ruby
 User.group_by_day(:created_at).count
 # {
-#   Sat, 28 May 2016 => 50,
-#   Sun, 29 May 2016 => 100,
-#   Mon, 30 May 2016 => 34
+#   Sat, 24 May 2020 => 50,
+#   Sun, 25 May 2020 => 100,
+#   Mon, 26 May 2020 => 34
 # }
 ```
 
@@ -47,12 +53,14 @@ You can group by:
 
 and
 
+- minute_of_hour
 - hour_of_day
 - day_of_week (Sunday = 0, Monday = 1, etc)
 - day_of_month
+- day_of_year
 - month_of_year
 
-Use it anywhere you can use `group`.
+Use it anywhere you can use `group`. Works with `count`, `sum`, `minimum`, `maximum`, and `average`. For `median` and `percentile`, check out [ActiveMedian](https://github.com/ankane/active_median).
 
 ### Time Zones
 
@@ -67,9 +75,9 @@ or
 ```ruby
 User.group_by_week(:created_at, time_zone: "Pacific Time (US & Canada)").count
 # {
-#   Sun, 06 Mar 2016 => 70,
-#   Sun, 13 Mar 2016 => 54,
-#   Sun, 20 Mar 2016 => 80
+#   Sun, 08 Mar 2020 => 70,
+#   Sun, 15 Mar 2020 => 54,
+#   Sun, 22 Mar 2020 => 80
 # }
 ```
 
@@ -80,13 +88,13 @@ Time zone objects also work. To see a list of available time zones in Rails, run
 Weeks start on Sunday by default. Change this with:
 
 ```ruby
-Groupdate.week_start = :mon # first three letters of day
+Groupdate.week_start = :monday
 ```
 
 or
 
 ```ruby
-User.group_by_week(:created_at, week_start: :mon).count
+User.group_by_week(:created_at, week_start: :monday).count
 ```
 
 ### Day Start
@@ -111,6 +119,12 @@ To get a specific time range, use:
 User.group_by_day(:created_at, range: 2.weeks.ago.midnight..Time.now).count
 ```
 
+To expand the range to the start and end of the time period, use:
+
+```ruby
+User.group_by_day(:created_at, range: 2.weeks.ago..Time.now, expand_range: true).count
+```
+
 To get the most recent time periods, use:
 
 ```ruby
@@ -140,8 +154,8 @@ To get keys in a different format, use:
 ```ruby
 User.group_by_month(:created_at, format: "%b %Y").count
 # {
-#   "Jan 2015" => 10
-#   "Feb 2015" => 12
+#   "Jan 2020" => 10
+#   "Feb 2020" => 12
 # }
 ```
 
@@ -181,11 +195,19 @@ User.group_by_period(:day, :created_at).count
 Limit groupings with the `permit` option.
 
 ```ruby
-User.group_by_period(params[:period], :created_at, permit: %w[day week]).count
+User.group_by_period(params[:period], :created_at, permit: ["day", "week"]).count
 ```
 
 Raises an `ArgumentError` for unpermitted periods.
 
+### Custom Duration
+
+To group by a specific number of minutes or seconds, use:
+
+```ruby
+User.group_by_minute(:created_at, n: 10).count # 10 minutes
+```
+
 ### Date Columns
 
 If grouping on date columns which don’t need time zone conversion, use:
@@ -194,6 +216,14 @@ If grouping on date columns which don’t need time zone conversion, use:
 User.group_by_week(:created_on, time_zone: false).count
 ```
 
+### Default Scopes
+
+If you use Postgres and have a default scope that uses `order`, you may get a `column must appear in the GROUP BY clause` error (just like with Active Record’s `group` method). Remove the `order` scope with:
+
+```ruby
+User.unscope(:order).group_by_day(:count).count
+```
+
 ## Arrays and Hashes
 
 ```ruby
@@ -206,44 +236,42 @@ Supports the same options as above
 users.group_by_day(time_zone: time_zone) { |u| u.created_at }
 ```
 
-Count
+Get the entire series with:
 
 ```ruby
-Hash[ users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.size] } ]
+users.group_by_day(series: true) { |u| u.created_at }
 ```
 
-## Installation
-
-Add this line to your application’s Gemfile:
+Count
 
 ```ruby
-gem 'groupdate'
+users.group_by_day { |u| u.created_at }.to_h { |k, v| [k, v.count] }
 ```
 
-#### For MySQL
+## Additional Instructions
 
-[Time zone support](http://dev.mysql.com/doc/refman/5.6/en/time-zone-support.html) must be installed on the server.
+### For MySQL
+
+[Time zone support](https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html) must be installed on the server.
 
 ```sh
 mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
 ```
 
-or copy and paste [these statements](https://gist.githubusercontent.com/ankane/1d6b0022173186accbf0/raw/time_zone_support.sql) into a SQL console.
-
 You can confirm it worked with:
 
 ```sql
-SELECT CONVERT_TZ(NOW(), '+00:00', 'Etc/UTC');
+SELECT CONVERT_TZ(NOW(), '+00:00', 'Pacific/Honolulu');
 ```
 
 It should return the time instead of `NULL`.
 
-#### For SQLite
+### For SQLite
 
 Groupdate has limited support for SQLite.
 
 - No time zone support
-- No `day_start` or `week_start` options
+- No `day_start` option
 - No `group_by_quarter` method
 
 If your application’s time zone is set to something other than `Etc/UTC` (the default), create an initializer with:
@@ -254,27 +282,20 @@ Groupdate.time_zone = false
 
 ## Upgrading
 
-### 3.0
-
-Groupdate 3.0 brings a number of improvements.  Here are a few to be aware of:
-
-- `Date` objects are now returned for day, week, month, quarter, and year by default. Use `dates: false` for the previous behavior, or change this globally with `Groupdate.dates = false`.
-- Array and hash methods no longer return the entire series by default. Use `series: true` for the previous behavior.
-- The `series: false` option now returns the correct type and order, and plays nicely with other options.
+### 6.0
 
-### 2.0
+Groupdate 6.0 protects against unsafe input by default. For non-attribute arguments, use:
 
-Groupdate 2.0 brings a number of improvements.  Here are two things to be aware of:
+```ruby
+User.group_by_day(Arel.sql(known_safe_value)).count
+```
 
-- the entire series is returned by default
-- `ActiveSupport::TimeWithZone` keys are now returned for every database adapter - adapters previously returned `Time` or `String` keys
+Also, the `dates` option has been removed.
 
 ## History
 
 View the [changelog](https://github.com/ankane/groupdate/blob/master/CHANGELOG.md)
 
-Groupdate follows [Semantic Versioning](http://semver.org/)
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -283,3 +304,5 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/groupdate/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing, check out the [Contributing Guide](CONTRIBUTING.md).

data/lib/groupdate/active_record.rb

@@ -1,53 +1,6 @@
 require "active_record"
-require "groupdate/order_hack"
-require "groupdate/scopes"
-require "groupdate/calculations"
-require "groupdate/series"
+require "groupdate/query_methods"
+require "groupdate/relation"
 
-ActiveRecord::Base.send(:extend, Groupdate::Scopes)
-
-module ActiveRecord
-  class Relation
-    if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR < 2
-
-      def method_missing_with_hack(method, *args, &block)
-        if Groupdate::METHODS.include?(method)
-          scoping { @klass.send(method, *args, &block) }
-        else
-          method_missing_without_hack(method, *args, &block)
-        end
-      end
-      alias_method_chain :method_missing, :hack
-
-    end
-  end
-end
-
-module ActiveRecord
-  module Associations
-    class CollectionProxy
-      if ActiveRecord::VERSION::MAJOR == 3
-        delegate(*Groupdate::METHODS, to: :scoped)
-      end
-    end
-  end
-end
-
-# hack for issue before Rails 5
-# https://github.com/rails/rails/issues/7121
-module ActiveRecord
-  module Calculations
-    private
-
-    if ActiveRecord::VERSION::MAJOR < 5
-      def column_alias_for_with_hack(*keys)
-        if keys.first.is_a?(Groupdate::OrderHack)
-          keys.first.field
-        else
-          column_alias_for_without_hack(*keys)
-        end
-      end
-      alias_method_chain :column_alias_for, :hack
-    end
-  end
-end
+ActiveRecord::Base.extend(Groupdate::QueryMethods)
+ActiveRecord::Relation.include(Groupdate::Relation)