groupdate 5.2.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448e7901aa2448bca591568110960048d18ac0f21faa5c3cae566fc4a6de30c4
-  data.tar.gz: ba242e41103ae9d2542ff0509de1f454f58142957f0da190482769a42a152887
+  metadata.gz: f0169fac01ba6b7b7a051ae37d2cc3d5b89b137b7bb3d609df7a633b534ac89b
+  data.tar.gz: ccdf270ed3726d0c0a52e9fafe0fb3b2281f6b31ac0a9a731eaedfbda8f42067
 SHA512:
-  metadata.gz: 91b008f8ee0d9ad419ec042ee2f417b621fba09793b223705a2898fe21083a09527885ead3be2d3b8003427473d1f996938098c9bd7139bcb9bffdad2810734c
-  data.tar.gz: d4eb493bdf4b7f40eda2733003263bee49e62f9f69fb6239bec118d1768ce0630c21244e819147ca6b5b1556a9b5e125ed69748e2ee69d3c325f31a2740a6ec5
+  metadata.gz: aa3150d5c5edd803e225045d745faf191fef78f483fec13aac05f4fb7dc0ee04a1b7a9340f1f8cf35a8d1c79ed09a6e6e6c4432e094d54faf5c7af48385c5e68
+  data.tar.gz: 97137d089ec745cdbcf08d1c7999f3efefab9c8cb3dd39e4e033f28184b8e4d4955cb4f7777cd7e8f8d28a3dda8b3dce2826242322de1949c2f72ad11f24a32d

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 6.0.0 (2022-01-15)
+
+- Changed SQL to return dates instead of times for day, week, month, quarter, and year
+- Added `n` option for Redshift
+- Removed `dates` option
+- Raise `ActiveRecord::UnknownAttributeReference` for non-attribute arguments
+- Raise `ArgumentError` for ranges with string bounds
+- 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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2020 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).
@@ -210,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
@@ -244,7 +239,7 @@ users.group_by_day(series: true) { |u| u.created_at }
 Count
 
 ```ruby
-users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.count] }.to_h
+users.group_by_day { |u| u.created_at }.to_h { |k, v| [k, v.count] }
 ```
 
 ## Additional Instructions
@@ -257,8 +252,6 @@ users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.count] }.to_h
 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
@@ -283,13 +276,15 @@ Groupdate.time_zone = false
 
 ## Upgrading
 
-### 5.0
+### 6.0
 
-Groupdate 5.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:
+
+```ruby
+User.group_by_day(Arel.sql(known_safe_value)).count
+```
 
-- The `week_start` option is now supported for SQLite
-- The `day_start` option is now consistent between Active Record and enumerable
-- Deprecated positional arguments for time zone and range have been removed
+Also, the `dates` option has been removed.
 
 ## History
 

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

data/lib/groupdate/adapters/sqlite_adapter.rb

@@ -0,0 +1,51 @@
+module Groupdate
+  module Adapters
+    class SQLiteAdapter < BaseAdapter
+      def group_clause
+        raise Groupdate::Error, "Time zones not supported for SQLite" unless @time_zone.utc_offset.zero?
+        raise Groupdate::Error, "day_start not supported for SQLite" unless day_start.zero?
+
+        query =
+          if period == :week
+            ["strftime('%Y-%m-%d', #{column}, '-6 days', ?)", "weekday #{(week_start + 1) % 7}"]
+          elsif period == :custom
+            ["datetime((strftime('%s', #{column}) / ?) * ?, 'unixepoch')", n_seconds, n_seconds]
+          else
+            format =
+              case period
+              when :minute_of_hour
+                "%M"
+              when :hour_of_day
+                "%H"
+              when :day_of_week
+                "%w"
+              when :day_of_month
+                "%d"
+              when :day_of_year
+                "%j"
+              when :month_of_year
+                "%m"
+              when :second
+                "%Y-%m-%d %H:%M:%S UTC"
+              when :minute
+                "%Y-%m-%d %H:%M:00 UTC"
+              when :hour
+                "%Y-%m-%d %H:00:00 UTC"
+              when :day
+                "%Y-%m-%d"
+              when :month
+                "%Y-%m-01"
+              when :quarter
+                raise Groupdate::Error, "Quarter not supported for SQLite"
+              else # year
+                "%Y-01-01"
+              end
+
+            ["strftime(?, #{column})", format]
+          end
+
+        @relation.send(:sanitize_sql_array, query)
+      end
+    end
+  end
+end

data/lib/groupdate/magic.rb

@@ -22,7 +22,7 @@ module Groupdate
     end
 
     def validate_keywords
-      known_keywords = [:time_zone, :dates, :series, :format, :locale, :range, :reverse]
+      known_keywords = [:time_zone, :series, :format, :locale, :range, :reverse]
 
       if %i[week day_of_week].include?(period)
         known_keywords << :week_start
@@ -69,12 +69,25 @@ module Groupdate
       @day_start ||= ((options[:day_start] || Groupdate.day_start).to_f * 3600).round
     end
 
+    def range
+      @range ||= begin
+        time_range = options[:range]
+
+        if time_range.is_a?(Range) && time_range.begin.nil? && time_range.end.nil?
+          nil
+        else
+          time_range
+        end
+      end
+    end
+
     def series_builder
       @series_builder ||=
         SeriesBuilder.new(
           **options,
           period: period,
           time_zone: time_zone,
+          range: range,
           day_start: day_start,
           week_start: week_start,
           n_seconds: n_seconds
@@ -132,6 +145,15 @@ module Groupdate
             lambda { |k| k.to_i }
           when :day_of_week
             lambda { |k| (k.to_i - 1 - week_start) % 7 }
+          when :day, :week, :month, :quarter, :year
+            if day_start != 0
+              day_start_hour = day_start / 3600
+              day_start_min = (day_start % 3600) / 60
+              day_start_sec = (day_start % 3600) % 60
+              lambda { |k| k.in_time_zone(time_zone).change(hour: day_start_hour, min: day_start_min, sec: day_start_sec) }
+            else
+              lambda { |k| k.in_time_zone(time_zone) }
+            end
           else
             utc = ActiveSupport::TimeZone["UTC"]
             lambda { |k| (k.is_a?(String) || !k.respond_to?(:to_time) ? utc.parse(k.to_s) : k.to_time).in_time_zone(time_zone) }
@@ -176,11 +198,19 @@ module Groupdate
       def self.generate_relation(relation, field:, **options)
         magic = Groupdate::Magic::Relation.new(**options)
 
+        adapter_name = relation.connection.adapter_name
+        adapter = Groupdate.adapters[adapter_name]
+        raise Groupdate::Error, "Connection adapter not supported: #{adapter_name}" unless adapter
+
+        # very important
+        column = validate_column(field)
+        column = resolve_column(relation, column)
+
         # generate ActiveRecord relation
         relation =
-          RelationBuilder.new(
+          adapter.new(
             relation,
-            column: field,
+            column: column,
             period: magic.period,
             time_zone: magic.time_zone,
             time_range: magic.time_range,
@@ -196,6 +226,30 @@ module Groupdate
         relation
       end
 
+      class << self
+        # basic version of Active Record disallow_raw_sql!
+        # symbol = column (safe), Arel node = SQL (safe), other = untrusted
+        # matches table.column and column
+        def validate_column(column)
+          unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral)
+            column = column.to_s
+            unless /\A\w+(\.\w+)?\z/i.match(column)
+              raise ActiveRecord::UnknownAttributeReference, "Query method called with non-attribute argument(s): #{column.inspect}. Use Arel.sql() for known-safe values."
+            end
+          end
+          column
+        end
+
+        # resolves eagerly
+        # need to convert both where_clause (easy)
+        # and group_clause (not easy) if want to avoid this
+        def resolve_column(relation, column)
+          node = relation.send(:relation).send(:arel_columns, [column]).first
+          node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
+          relation.connection.visitor.accept(node, Arel::Collectors::SQLString.new).value
+        end
+      end
+
       # allow any options to keep flexible for future
       def self.process_result(relation, result, **options)
         relation.groupdate_values.reverse.each do |gv|

data/lib/groupdate/series_builder.rb

@@ -2,8 +2,6 @@ module Groupdate
   class SeriesBuilder
     attr_reader :period, :time_zone, :day_start, :week_start, :n_seconds, :options
 
-    CHECK_PERIODS = [:day, :week, :month, :quarter, :year]
-
     def initialize(period:, time_zone:, day_start:, week_start:, n_seconds:, **options)
       @period = period
       @time_zone = time_zone
@@ -23,41 +21,12 @@ module Groupdate
         verified_data[k] = data.delete(k)
       end
 
-      # this is a fun one
-      # PostgreSQL and Ruby both return the 2nd hour when converting/parsing a backward DST change
-      # Other databases and Active Support return the 1st hour (as expected)
-      # Active Support good: ActiveSupport::TimeZone["America/Los_Angeles"].parse("2013-11-03 01:00:00")
-      # MySQL good: SELECT CONVERT_TZ('2013-11-03 01:00:00', 'America/Los_Angeles', 'Etc/UTC');
-      # Ruby not good: Time.parse("2013-11-03 01:00:00")
-      # PostgreSQL not good: SELECT '2013-11-03 01:00:00'::timestamp AT TIME ZONE 'America/Los_Angeles';
-      # we need to account for this here
-      if series_default && CHECK_PERIODS.include?(period)
-        data.each do |k, v|
-          key = multiple_groups ? k[group_index] : k
-          # TODO only do this for PostgreSQL
-          # this may mask some inconsistent time zone errors
-          # but not sure there's a better approach
-          if key.hour == (key - 1.hour).hour && series.include?(key - 1.hour)
-            key -= 1.hour
-            if multiple_groups
-              k[group_index]  = key
-            else
-              k = key
-            end
-            verified_data[k] = v
-          elsif key != round_time(key)
-            # only need to show what database returned since it will cast in Ruby time zone
-            raise Groupdate::Error, "Database and Ruby have inconsistent time zone info. Database returned #{key}"
-          end
-        end
-      end
-
       unless entire_series?(series_default)
         series = series.select { |k| verified_data[k] }
       end
 
       value = 0
-      result = Hash[series.map do |k|
+      result = series.to_h do |k|
         value = verified_data[k] || (@options[:carry_forward] && value) || default_value
         key =
           if multiple_groups
@@ -67,7 +36,7 @@ module Groupdate
           end
 
         [key, value]
-      end]
+      end
 
       result
     end
@@ -81,7 +50,7 @@ module Groupdate
 
       if day_start != 0
         # apply day_start to a time object that's not affected by DST
-        time = change_zone.call(time, utc)
+        time = time.change(zone: utc)
         time -= day_start.seconds
       end
 
@@ -121,23 +90,12 @@ module Groupdate
 
       if day_start != 0 && time.is_a?(Time)
         time += day_start.seconds
-        time = change_zone.call(time, time_zone)
+        time = time.change(zone: time_zone)
       end
 
       time
     end
 
-    def change_zone
-      @change_zone ||= begin
-        if ActiveSupport::VERSION::STRING >= "5.2"
-          ->(time, zone) { time.change(zone: zone) }
-        else
-          # TODO make more efficient
-          ->(time, zone) { zone.parse(time.strftime("%Y-%m-%d %H:%M:%S")) }
-        end
-      end
-    end
-
     def time_range
       @time_range ||= begin
         time_range = options[:range]
@@ -148,10 +106,6 @@ module Groupdate
             case v
             when nil, Date, Time
               # good
-            when String
-              # TODO raise error in Groupdate 6
-              warn "[groupdate] Range bounds should be Date or Time, not #{v.class.name}. This will raise an error in Groupdate 6"
-              break
             else
               raise ArgumentError, "Range bounds should be Date or Time, not #{v.class.name}"
             end
@@ -289,7 +243,6 @@ module Groupdate
     def key_format
       @key_format ||= begin
         locale = options[:locale] || I18n.locale
-        use_dates = options.key?(:dates) ? options[:dates] : Groupdate.dates
 
         if options[:format]
           if options[:format].respond_to?(:call)
@@ -312,7 +265,7 @@ module Groupdate
               I18n.localize(key, format: options[:format], locale: locale)
             end
           end
-        elsif [:day, :week, :month, :quarter, :year].include?(period) && use_dates
+        elsif [:day, :week, :month, :quarter, :year].include?(period)
           lambda { |k| k.to_date }
         else
           lambda { |k| k }

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "5.2.1"
+  VERSION = "6.0.0"
 end

data/lib/groupdate.rb

@@ -1,23 +1,28 @@
 # dependencies
+require "active_support"
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/time"
 
 # modules
 require "groupdate/magic"
-require "groupdate/relation_builder"
 require "groupdate/series_builder"
 require "groupdate/version"
 
+# adapters
+require "groupdate/adapters/base_adapter"
+require "groupdate/adapters/mysql_adapter"
+require "groupdate/adapters/postgresql_adapter"
+require "groupdate/adapters/sqlite_adapter"
+
 module Groupdate
   class Error < RuntimeError; end
 
   PERIODS = [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week, :hour_of_day, :minute_of_hour, :day_of_month, :day_of_year, :month_of_year]
   METHODS = PERIODS.map { |v| :"group_by_#{v}" } + [:group_by_period]
 
-  mattr_accessor :week_start, :day_start, :time_zone, :dates
+  mattr_accessor :week_start, :day_start, :time_zone
   self.week_start = :sunday
   self.day_start = 0
-  self.dates = true
 
   # api for gems like ActiveMedian
   def self.process_result(relation, result, **options)
@@ -26,8 +31,22 @@ module Groupdate
     end
     result
   end
+
+  def self.adapters
+    @adapters ||= {}
+  end
+
+  def self.register_adapter(name, adapter)
+    Array(name).each do |n|
+      adapters[n] = adapter
+    end
+  end
 end
 
+Groupdate.register_adapter ["Mysql2", "Mysql2Spatial", "Mysql2Rgeo"], Groupdate::Adapters::MySQLAdapter
+Groupdate.register_adapter ["PostgreSQL", "PostGIS", "Redshift"], Groupdate::Adapters::PostgreSQLAdapter
+Groupdate.register_adapter "SQLite", Groupdate::Adapters::SQLiteAdapter
+
 require "groupdate/enumerable"
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,114 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+        version: '5.2'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -134,18 +36,21 @@ files:
 - README.md
 - lib/groupdate.rb
 - lib/groupdate/active_record.rb
+- lib/groupdate/adapters/base_adapter.rb
+- lib/groupdate/adapters/mysql_adapter.rb
+- lib/groupdate/adapters/postgresql_adapter.rb
+- lib/groupdate/adapters/sqlite_adapter.rb
 - lib/groupdate/enumerable.rb
 - lib/groupdate/magic.rb
 - lib/groupdate/query_methods.rb
 - lib/groupdate/relation.rb
-- lib/groupdate/relation_builder.rb
 - lib/groupdate/series_builder.rb
 - lib/groupdate/version.rb
 homepage: https://github.com/ankane/groupdate
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,15 +58,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: The simplest way to group temporal data
 test_files: []

data/lib/groupdate/relation_builder.rb

@@ -1,227 +0,0 @@
-module Groupdate
-  class RelationBuilder
-    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:)
-      # very important
-      validate_column(column)
-
-      @relation = relation
-      @column = resolve_column(relation, column)
-      @period = period
-      @time_zone = time_zone
-      @time_range = time_range
-      @week_start = week_start
-      @day_start = day_start
-      @n_seconds = n_seconds
-
-      if relation.default_timezone == :local
-        raise Groupdate::Error, "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
-      end
-    end
-
-    def generate
-      @relation.group(group_clause).where(*where_clause)
-    end
-
-    private
-
-    def group_clause
-      time_zone = @time_zone.tzinfo.name
-      adapter_name = @relation.connection.adapter_name
-      query =
-        case adapter_name
-        when "Mysql2", "Mysql2Spatial", "Mysql2Rgeo"
-          day_start_column = "CONVERT_TZ(#{column}, '+00:00', ?) - INTERVAL ? second"
-
-          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
-            ["CONVERT_TZ(DATE_FORMAT(#{day_start_column} - INTERVAL ((? + DAYOFWEEK(#{day_start_column})) % 7) DAY, '%Y-%m-%d 00:00:00') + INTERVAL ? second, ?, '+00:00')", time_zone, day_start, 12 - week_start, time_zone, day_start, day_start, time_zone]
-          when :quarter
-            ["CONVERT_TZ(DATE_FORMAT(DATE(CONCAT(YEAR(#{day_start_column}), '-', LPAD(1 + 3 * (QUARTER(#{day_start_column}) - 1), 2, '00'), '-01')), '%Y-%m-%d %H:%i:%S') + INTERVAL ? second, ?, '+00:00')", time_zone, day_start, time_zone, day_start, day_start, time_zone]
-          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"
-              when :hour
-                "%Y-%m-%d %H:00:00"
-              when :day
-                "%Y-%m-%d 00:00:00"
-              when :month
-                "%Y-%m-01 00:00:00"
-              else # year
-                "%Y-01-01 00:00:00"
-              end
-
-            ["CONVERT_TZ(DATE_FORMAT(#{day_start_column}, ?) + INTERVAL ? second, ?, '+00:00')", time_zone, day_start, format, day_start, time_zone]
-          end
-        when "PostgreSQL", "PostGIS"
-          day_start_column = "#{column}::timestamptz AT TIME ZONE ? - INTERVAL ?"
-          day_start_interval = "#{day_start} second"
-
-          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 ?) AT TIME ZONE ?", time_zone, day_start_interval, 13 - week_start, time_zone, day_start_interval, day_start_interval, time_zone]
-          when :custom
-            ["TO_TIMESTAMP(FLOOR(EXTRACT(EPOCH FROM #{column}::timestamptz) / ?) * ?)", n_seconds, n_seconds]
-          else
-            if day_start == 0
-              # prettier
-              ["DATE_TRUNC(?, #{day_start_column}) AT TIME ZONE ?", period, time_zone, day_start_interval, time_zone]
-            else
-              ["(DATE_TRUNC(?, #{day_start_column}) + INTERVAL ?) AT TIME ZONE ?", period, time_zone, day_start_interval, day_start_interval, time_zone]
-            end
-          end
-        when "SQLite"
-          raise Groupdate::Error, "Time zones not supported for SQLite" unless @time_zone.utc_offset.zero?
-          raise Groupdate::Error, "day_start not supported for SQLite" unless day_start.zero?
-
-          if period == :week
-            ["strftime('%Y-%m-%d 00:00:00 UTC', #{column}, '-6 days', ?)", "weekday #{(week_start + 1) % 7}"]
-          elsif period == :custom
-            ["datetime((strftime('%s', #{column}) / ?) * ?, 'unixepoch')", n_seconds, n_seconds]
-          else
-            format =
-              case period
-              when :minute_of_hour
-                "%M"
-              when :hour_of_day
-                "%H"
-              when :day_of_week
-                "%w"
-              when :day_of_month
-                "%d"
-              when :day_of_year
-                "%j"
-              when :month_of_year
-                "%m"
-              when :second
-                "%Y-%m-%d %H:%M:%S UTC"
-              when :minute
-                "%Y-%m-%d %H:%M:00 UTC"
-              when :hour
-                "%Y-%m-%d %H:00:00 UTC"
-              when :day
-                "%Y-%m-%d 00:00:00 UTC"
-              when :month
-                "%Y-%m-01 00:00:00 UTC"
-              when :quarter
-                raise Groupdate::Error, "Quarter not supported for SQLite"
-              else # year
-                "%Y-01-01 00:00:00 UTC"
-              end
-
-            ["strftime(?, #{column})", format]
-          end
-        when "Redshift"
-          day_start_column = "CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL ?"
-          day_start_interval = "#{day_start} second"
-
-          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 # start on Sunday, not Redshift default Monday
-            # Redshift does not return timezone information; it
-            # always says it is in UTC time, so we must convert
-            # back to UTC to play properly with the rest of Groupdate.
-            week_start_interval = "#{week_start} day"
-            ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC('week', #{day_start_column} - INTERVAL ?) + INTERVAL ? + INTERVAL ?)::timestamp", time_zone, time_zone, day_start_interval, week_start_interval, week_start_interval, day_start_interval]
-          when :custom
-            raise Groupdate::Error, "Not implemented yet"
-          else
-            ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC(?, #{day_start_column}) + INTERVAL ?)::timestamp", time_zone, period, time_zone, day_start_interval, day_start_interval]
-          end
-        else
-          raise Groupdate::Error, "Connection adapter not supported: #{adapter_name}"
-        end
-
-      clause = @relation.send(:sanitize_sql_array, query)
-
-      # cleaner queries in logs
-      clause = clean_group_clause_postgresql(clause)
-      clean_group_clause_mysql(clause)
-    end
-
-    def clean_group_clause_postgresql(clause)
-      clause.gsub(/ (\-|\+) INTERVAL '0 second'/, "")
-    end
-
-    def clean_group_clause_mysql(clause)
-      clause.gsub(/ (\-|\+) INTERVAL 0 second/, "")
-    end
-
-    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
-
-    # basic version of Active Record disallow_raw_sql!
-    # symbol = column (safe), Arel node = SQL (safe), other = untrusted
-    def validate_column(column)
-      # matches table.column and column
-      unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral) || /\A\w+(\.\w+)?\z/i.match(column.to_s)
-        warn "[groupdate] Non-attribute argument: #{column}. Use Arel.sql() for known-safe values. This will raise an error in Groupdate 6"
-      end
-    end
-
-    # resolves eagerly
-    # need to convert both where_clause (easy)
-    # and group_clause (not easy) if want to avoid this
-    def resolve_column(relation, column)
-      node = relation.send(:relation).send(:arel_columns, [column]).first
-      node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
-      relation.connection.visitor.accept(node, Arel::Collectors::SQLString.new).value
-    end
-  end
-end