groupdate 3.2.0 → 6.2.1

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/enumerable.rb

@@ -1,30 +1,25 @@
 module Enumerable
   Groupdate::PERIODS.each do |period|
-    define_method :"group_by_#{period}" do |*args, &block|
+    define_method :"group_by_#{period}" do |*args, **options, &block|
       if block
-        Groupdate::Magic.new(period, args[0] || {}).group_by(self, &block)
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0)" if args.any?
+        Groupdate::Magic::Enumerable.group_by(self, period, options, &block)
       elsif respond_to?(:scoping)
-        scoping { @klass.send(:"group_by_#{period}", *args, &block) }
+        scoping { @klass.group_by_period(period, *args, **options, &block) }
       else
         raise ArgumentError, "no block given"
       end
     end
   end
 
-  def group_by_period(*args, &block)
+  def group_by_period(period, *args, **options, &block)
     if block || !respond_to?(:scoping)
-      period = args[0]
-      options = args[1] || {}
+      raise ArgumentError, "wrong number of arguments (given #{args.size + 1}, expected 1)" if args.any?
 
-      # to_sym is unsafe on user input, so convert to strings
-      permitted_periods = ((options[:permit] || Groupdate::PERIODS).map(&:to_sym) & Groupdate::PERIODS).map(&:to_s)
-      if permitted_periods.include?(period.to_s)
-        send("group_by_#{period}", options, &block)
-      else
-        raise ArgumentError, "Unpermitted period"
-      end
+      Groupdate::Magic.validate_period(period, options.delete(:permit))
+      send("group_by_#{period}", **options, &block)
     else
-      scoping { @klass.send(:group_by_period, *args, &block) }
+      scoping { @klass.group_by_period(period, *args, **options, &block) }
     end
   end
 end