groupdate 5.2.0 → 5.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d18870af57fc18006c5f176fa3138dfe36a715b16e5a6113f447aee6d3b7468
-  data.tar.gz: 889870a1a2db8784e28413c6071a784dff66d00b4aaf05a323e70e5d16f09fd8
+  metadata.gz: 2b6c83f192d439e35025586a076762413d80daab15b85e81561404bdf078acad
+  data.tar.gz: 382dd612bbd1db8e131345981576b7a6c61c525d8a991fb8a3fc60678ce8d6ef
 SHA512:
-  metadata.gz: 2ae29a1e8d0eb14c4ef904fbe366cb5f7029d9e94429a74f6f70073a880f2910f62d5161d39618808c09dc937185cc79ba233ac3fc7e34f983a8e32d60e0be70
-  data.tar.gz: 6348f6853cf2015f6777bcc63e1e416a31456a0e779678164992bd6424daca73272bb5fcb12016d1f3c085b4e14e991afa067f4f93354982e7229699f3ea2eab
+  metadata.gz: 2d33022921907669f28eed522daec36e84552aabd41a411ff556923c0029cc72a003d30cd9cbeecba27e3d795fc279f71ca05a01cbc8c5cf6a0bd7256a478f72
+  data.tar.gz: 87c778a1972590cc6609a3c5a096fef6dde88c70ab663b5ebac820de89ec356359f802ea1d8ba38280378e877caabb1974e1d6a81c689eef92e6d7accf2f356a

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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

data/LICENSE.txt

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

data/README.md

@@ -15,7 +15,7 @@ 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
 
@@ -223,6 +223,14 @@ raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
 User.group_by_day(column).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
@@ -257,8 +265,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

data/lib/groupdate/adapters/base_adapter.rb

@@ -0,0 +1,76 @@
+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:)
+        # very important
+        column = 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 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
+
+      # 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)
+            warn "[groupdate] Non-attribute argument: #{column}. Use Arel.sql() for known-safe values. This will raise an error in Groupdate 6"
+          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
+  end
+end

data/lib/groupdate/adapters/mysql_adapter.rb

@@ -0,0 +1,57 @@
+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
+            ["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
+
+        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,44 @@
+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 ?) 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
+
+        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/redshift_adapter.rb

@@ -0,0 +1,39 @@
+module Groupdate
+  module Adapters
+    class RedshiftAdapter < BaseAdapter
+      def group_clause
+        time_zone = @time_zone.tzinfo.name
+        day_start_column = "CONVERT_TIMEZONE(?, #{column}::timestamp) - 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 # 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
+
+        @relation.send(:sanitize_sql_array, query)
+      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 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
+
+        @relation.send(:sanitize_sql_array, query)
+      end
+    end
+  end
+end

data/lib/groupdate/magic.rb

@@ -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
@@ -176,9 +189,13 @@ 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
+
         # generate ActiveRecord relation
         relation =
-          RelationBuilder.new(
+          adapter.new(
             relation,
             column: field,
             period: magic.period,

data/lib/groupdate/series_builder.rb

@@ -141,16 +141,35 @@ module Groupdate
     def time_range
       @time_range ||= begin
         time_range = options[:range]
-        # entire range must be Date if begin or end is Date
-        if time_range.is_a?(Range) && (time_range.begin.is_a?(Date) || time_range.end.is_a?(Date))
-          if time_range.begin
-            start = time_zone.parse(time_range.first.to_s)
+
+        if time_range.is_a?(Range)
+          # check types
+          [time_range.begin, time_range.end].each do |v|
+            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
           end
-          if time_range.end
-            last = time_zone.parse(time_range.last.to_s)
-            last += 1.day unless time_range.exclude_end?
+
+          start = time_range.begin
+          start = start.in_time_zone(time_zone) if start
+
+          exclude_end = time_range.exclude_end?
+
+          finish = time_range.end
+          finish = finish.in_time_zone(time_zone) if finish
+          if time_range.end.is_a?(Date) && !exclude_end
+            finish += 1.day
+            exclude_end = true
           end
-          time_range = Range.new(start, last, true)
+
+          time_range = Range.new(start, finish, exclude_end)
         elsif !time_range && options[:last]
           if period == :quarter
             step = 3.months

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "5.2.0"
+  VERSION = "5.2.4"
 end

data/lib/groupdate.rb

@@ -1,13 +1,20 @@
 # 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/redshift_adapter"
+require "groupdate/adapters/sqlite_adapter"
+
 module Groupdate
   class Error < RuntimeError; end
 
@@ -26,8 +33,23 @@ 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"], Groupdate::Adapters::PostgreSQLAdapter
+Groupdate.register_adapter "Redshift", Groupdate::Adapters::RedshiftAdapter
+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.0
+  version: 5.2.4
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,106 +24,8 @@ dependencies:
     - - ">="
       - !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
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -134,18 +36,22 @@ 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/redshift_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
@@ -160,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+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.first, @time_range.last]
-          else
-            ["#{column} #{op} ?", @time_range.last]
-          end
-        else
-          ["#{column} >= ?", @time_range.first]
-        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