groupdate 4.1.2 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28ba8881c2af7869f774eceebed739e851e81d7d28b53473762260e7c4297134
-  data.tar.gz: e0031f94b52b53255bdbe01c0f72d5c7abcb20d94b02d81bf9e31344a957919a
+  metadata.gz: 12cfc48ae509ac20872022dd07429dd7bd8f24a5bfd81dcb16242f3519cb5385
+  data.tar.gz: 3079f700f956f141184fbc5bc8244ad90380804cea9f15fef51300985380d13e
 SHA512:
-  metadata.gz: cb863625ed13dea87c18b31bf897f0e6d6c00bb02b3c41aaf08a11221cc52a8cbfea5cb4f8fe991d33552b0f9294c9c2c04bfb1c220bdcfb8688dbacc848ceed
-  data.tar.gz: 805c5290d0652b2f82c3426fb253dc962bc9c2e4903b3edb1aa2451dc252f0c94bbc7737d3c1b8ddd429c5844ca99c8c01b1e872f1efd4980a747eb4cd2c4294
+  metadata.gz: 64b4e317731bc0032a914e4f07ca751ee276e41b7a30a2113bff9d9f2437196916c68e5f1f699c2e107861d0022b712b32315132cd0f530bb7caad5f41955e45
+  data.tar.gz: ea085f2e6985f4df40f591333935b88f8c59b2be87943f39241254dbbc8ac18cc1aaa2b54030880a804117ecdc0451a65463b07ea758d3fc93d99697a11a5711

data/CHANGELOG.md

@@ -1,31 +1,94 @@
-## 4.1.2
+## 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
+## 4.1.1 (2018-12-11)
 
 - Made column resolution consistent with `group`
 - Added support for `alias_attribute`
 
-## 4.1.0
+## 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
+## 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
+## 4.0.1 (2018-05-03)
 
 - Fixed incorrect range with `last` option near time change
 
-## 4.0.0
+## 4.0.0 (2018-02-21)
 
 - Custom calculation methods are supported by default - `groupdate_calculation_methods` is no longer needed
 
@@ -37,37 +100,37 @@ Breaking changes
 - `week_start` now affects `day_of_week`
 - Removed support for `reverse_order` (was never supported in Rails 5)
 
-## 3.2.1
+## 3.2.1 (2018-02-21)
 
 - Added `minute_of_hour`
 - Added support for `unscoped`
 
-## 3.2.0
+## 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
 
@@ -75,16 +138,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
@@ -92,13 +155,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
@@ -106,77 +169,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

@@ -57,7 +57,7 @@ brew services start mysql
 
 # create databases
 createdb groupdate_test
-mysql -u root -e "create database groupdate_test"
+mysqladmin create groupdate_test
 mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
 
 # clone the repo and run the tests

data/LICENSE.txt

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

data/README.md

@@ -15,14 +15,14 @@ Supports PostgreSQL, MySQL, and Redshift, plus arrays and hashes (and limited su
 
 :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)
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'groupdate'
+gem "groupdate"
 ```
 
 For MySQL and SQLite, also follow [these instructions](#additional-instructions).
@@ -32,9 +32,9 @@ For MySQL and SQLite, also follow [these instructions](#additional-instructions)
 ```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
 # }
 ```
 
@@ -53,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`. Works with `count`, `sum`, `minimum`, `maximum`, and `average`. For `median`, check out [ActiveMedian](https://github.com/ankane/active_median). For other aggregate functions, including multiple together, check out [CalculateAll](https://github.com/codesnik/calculate-all).
+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
 
@@ -73,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
 # }
 ```
 
@@ -86,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
@@ -146,8 +148,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
 # }
 ```
 
@@ -192,6 +194,14 @@ User.group_by_period(params[:period], :created_at, permit: ["day", "week"]).coun
 
 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:
@@ -200,17 +210,12 @@ If grouping on date columns which don’t need time zone conversion, use:
 User.group_by_week(:created_on, time_zone: false).count
 ```
 
-### User Input
+### Default Scopes
 
-If passing user input as the column, be sure to sanitize it first [like you must](https://rails-sqli.org/) with `group`.
+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
-column = params[:column]
-
-# check against permitted columns
-raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
-
-User.group_by_day(column).count
+User.unscope(:order).group_by_day(:count).count
 ```
 
 ## Arrays and Hashes
@@ -225,24 +230,28 @@ Supports the same options as above
 users.group_by_day(time_zone: time_zone) { |u| u.created_at }
 ```
 
+Get the entire series with:
+
+```ruby
+users.group_by_day(series: true) { |u| u.created_at }
+```
+
 Count
 
 ```ruby
-Hash[ users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.size] } ]
+users.group_by_day { |u| u.created_at }.to_h { |k, v| [k, v.count] }
 ```
 
 ## Additional Instructions
 
 ### For MySQL
 
-[Time zone support](https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html) must be installed on the server.
+[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
@@ -256,7 +265,7 @@ It should return the time instead of `NULL`.
 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:
@@ -267,36 +276,20 @@ Groupdate.time_zone = false
 
 ## Upgrading
 
-### 4.0
-
-Groupdate 4.0 brings a number of improvements. Here are a few to be aware of:
-
-- `group_by` methods return an `ActiveRecord::Relation` instead of a `Groupdate::Series`
-- Invalid options now throw an `ArgumentError`
-- `week_start` now affects `day_of_week`
-- Custom calculation methods are supported by default
-
-### 3.0
+### 6.0
 
-Groupdate 3.0 brings a number of improvements. Here are a few to be aware of:
+Groupdate 6.0 protects against unsafe input by default. For non-attribute arguments, use:
 
-- `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.
-
-### 2.0
-
-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](https://semver.org/)
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/groupdate/adapters/base_adapter.rb

@@ -0,0 +1,51 @@
+module Groupdate
+  module Adapters
+    class BaseAdapter
+      attr_reader :period, :column, :day_start, :week_start, :n_seconds
+
+      def initialize(relation, column:, period:, time_zone:, time_range:, week_start:, day_start:, n_seconds:)
+        @relation = relation
+        @column = column
+        @period = period
+        @time_zone = time_zone
+        @time_range = time_range
+        @week_start = week_start
+        @day_start = day_start
+        @n_seconds = n_seconds
+
+        if ActiveRecord::VERSION::MAJOR >= 7
+          if ActiveRecord.default_timezone == :local
+            raise Groupdate::Error, "ActiveRecord.default_timezone must be :utc to use Groupdate"
+          end
+        else
+          if relation.default_timezone == :local
+            raise Groupdate::Error, "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
+          end
+        end
+      end
+
+      def generate
+        @relation.group(group_clause).where(*where_clause)
+      end
+
+      private
+
+      def where_clause
+        if @time_range.is_a?(Range)
+          if @time_range.end
+            op = @time_range.exclude_end? ? "<" : "<="
+            if @time_range.begin
+              ["#{column} >= ? AND #{column} #{op} ?", @time_range.begin, @time_range.end]
+            else
+              ["#{column} #{op} ?", @time_range.end]
+            end
+          else
+            ["#{column} >= ?", @time_range.begin]
+          end
+        else
+          ["#{column} IS NOT NULL"]
+        end
+      end
+    end
+  end
+end

data/lib/groupdate/adapters/mysql_adapter.rb

@@ -0,0 +1,63 @@
+module Groupdate
+  module Adapters
+    class MySQLAdapter < BaseAdapter
+      def group_clause
+        time_zone = @time_zone.tzinfo.name
+        day_start_column = "CONVERT_TZ(#{column}, '+00:00', ?) - INTERVAL ? second"
+
+        query =
+          case period
+          when :minute_of_hour
+            ["MINUTE(#{day_start_column})", time_zone, day_start]
+          when :hour_of_day
+            ["HOUR(#{day_start_column})", time_zone, day_start]
+          when :day_of_week
+            ["DAYOFWEEK(#{day_start_column}) - 1", time_zone, day_start]
+          when :day_of_month
+            ["DAYOFMONTH(#{day_start_column})", time_zone, day_start]
+          when :day_of_year
+            ["DAYOFYEAR(#{day_start_column})", time_zone, day_start]
+          when :month_of_year
+            ["MONTH(#{day_start_column})", time_zone, day_start]
+          when :week
+            ["CAST(DATE_FORMAT(#{day_start_column} - INTERVAL ((? + DAYOFWEEK(#{day_start_column})) % 7) DAY, '%Y-%m-%d') AS DATE)", time_zone, day_start, 12 - week_start, time_zone, day_start]
+          when :quarter
+            ["CAST(CONCAT(YEAR(#{day_start_column}), '-', LPAD(1 + 3 * (QUARTER(#{day_start_column}) - 1), 2, '00'), '-01') AS DATE)", time_zone, day_start, time_zone, day_start]
+          when :day, :month, :year
+            format =
+              case period
+              when :day
+                "%Y-%m-%d"
+              when :month
+                "%Y-%m-01"
+              else # year
+                "%Y-01-01"
+              end
+
+            ["CAST(DATE_FORMAT(#{day_start_column}, ?) AS DATE)", time_zone, day_start, format]
+          when :custom
+            ["FROM_UNIXTIME((UNIX_TIMESTAMP(#{column}) DIV ?) * ?)", n_seconds, n_seconds]
+          else
+            format =
+              case period
+              when :second
+                "%Y-%m-%d %H:%i:%S"
+              when :minute
+                "%Y-%m-%d %H:%i:00"
+              else # hour
+                "%Y-%m-%d %H:00:00"
+              end
+
+            ["CONVERT_TZ(DATE_FORMAT(#{day_start_column}, ?) + INTERVAL ? second, ?, '+00:00')", time_zone, day_start, format, day_start, time_zone]
+          end
+
+        clean_group_clause(@relation.send(:sanitize_sql_array, query))
+      end
+
+      def clean_group_clause(clause)
+        # zero quoted in Active Record 7+
+        clause.gsub(/ (\-|\+) INTERVAL 0 second/, "").gsub(/ (\-|\+) INTERVAL '0' second/, "")
+      end
+    end
+  end
+end

data/lib/groupdate/adapters/postgresql_adapter.rb

@@ -0,0 +1,46 @@
+module Groupdate
+  module Adapters
+    class PostgreSQLAdapter < BaseAdapter
+      def group_clause
+        time_zone = @time_zone.tzinfo.name
+        day_start_column = "#{column}::timestamptz AT TIME ZONE ? - INTERVAL ?"
+        day_start_interval = "#{day_start} second"
+
+        query =
+          case period
+          when :minute_of_hour
+            ["EXTRACT(MINUTE FROM #{day_start_column})::integer", time_zone, day_start_interval]
+          when :hour_of_day
+            ["EXTRACT(HOUR FROM #{day_start_column})::integer", time_zone, day_start_interval]
+          when :day_of_week
+            ["EXTRACT(DOW FROM #{day_start_column})::integer", time_zone, day_start_interval]
+          when :day_of_month
+            ["EXTRACT(DAY FROM #{day_start_column})::integer", time_zone, day_start_interval]
+          when :day_of_year
+            ["EXTRACT(DOY FROM #{day_start_column})::integer", time_zone, day_start_interval]
+          when :month_of_year
+            ["EXTRACT(MONTH FROM #{day_start_column})::integer", time_zone, day_start_interval]
+          when :week
+            ["(DATE_TRUNC('day', #{day_start_column} - INTERVAL '1 day' * ((? + EXTRACT(DOW FROM #{day_start_column})::integer) % 7)) + INTERVAL ?)::date", time_zone, day_start_interval, 13 - week_start, time_zone, day_start_interval, day_start_interval]
+          when :custom
+            if @relation.connection.adapter_name == "Redshift"
+              ["TIMESTAMP 'epoch' + (FLOOR(EXTRACT(EPOCH FROM #{column}::timestamp) / ?) * ?) * INTERVAL '1 second'", n_seconds, n_seconds]
+            else
+              ["TO_TIMESTAMP(FLOOR(EXTRACT(EPOCH FROM #{column}::timestamptz) / ?) * ?)", n_seconds, n_seconds]
+            end
+          when :day, :month, :quarter, :year
+            ["DATE_TRUNC(?, #{day_start_column})::date", period, time_zone, day_start_interval]
+          else
+            # day start is always 0 for seconds, minute, hour
+            ["DATE_TRUNC(?, #{day_start_column}) AT TIME ZONE ?", period, time_zone, day_start_interval, time_zone]
+          end
+
+        clean_group_clause(@relation.send(:sanitize_sql_array, query))
+      end
+
+      def clean_group_clause(clause)
+        clause.gsub(/ (\-|\+) INTERVAL '0 second'/, "")
+      end
+    end
+  end
+end