groupdate 6.4.0 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdca24f5af218da761aff856a2798e39d4469fa5cdf5186d061572cea4b256a6
-  data.tar.gz: 3b327397c8ba2638ccda503d3d3fd9d641b86cf8018161fc3cbb7891122d3b3f
+  metadata.gz: 07ae05090ff5047136472fd30bc78ff078350c4fab330f73d84c36316dbbfbcf
+  data.tar.gz: 824c766fa826aeb15bcd0e21ed85b264a6d2f1a45c9e3f06d408b0df3c773e64
 SHA512:
-  metadata.gz: 0b06dcf600f13158dbf4d5edeab2212aedd21b4a2e4efb36d26ab1635c035c562e28932b03ed26bdb452c5118c125d38fc8ea665e2dc5c458a986bd87e62912b
-  data.tar.gz: 0b78a8ee21b370052d1eacffa3c5c42ceb059ec1a1d14a7b992076cd02cfe158dc6ecee027578aeb233d2adc1c3fa4e71b2f572bf87affd51077b2282e6b2e21
+  metadata.gz: 5716c00f5cfd9ef21a4500b8936cdc42cbe476ea1acaf8cf72df82ea69d9595284300cdeb4aac43af434dfe3ab192b021fc247910b6f294bb4dcc6cd72807fb1
+  data.tar.gz: 845d022ae8bba825fa3f6ee6ba91cb5939a60c5a2933a942a2aa8b0802cb4de7507226570dc648c597b5d8e7dc46211e8d57ea93c32d5fa63247a2a7262f6712

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 6.7.0 (2025-06-02)
+
+- Added time zone support for SQLite
+- Added `day_start` support for SQLite
+- Added `group_by_quarter` support for SQLite
+
+## 6.6.0 (2025-05-04)
+
+- Dropped support for Ruby < 3.2 and Active Record < 7.1
+
+## 6.5.1 (2024-10-07)
+
+- Fixed connection leasing for Active Record 7.2+
+
+## 6.5.0 (2024-10-01)
+
+- Added support for Active Record 8
+- Dropped support for Ruby < 3.1 and Active Record < 7
+
 ## 6.4.0 (2023-09-13)
 
 - Added support for Trilogy
@@ -173,7 +192,7 @@ Breaking changes
 - Added `default_value` option
 - Accept symbol for `format` option
 - Raise `ArgumentError` if no field specified
-- Added support for ActiveRecord 5 beta
+- Added support for Active Record 5 beta
 
 ## 2.5.0 (2015-09-29)
 
@@ -187,18 +206,18 @@ Breaking changes
 - Added `carry_forward` option
 - Added `series: false` option for arrays and hashes
 - Fixed issue w/ Brasilia Summer Time
-- Fixed issues w/ ActiveRecord 4.2
+- Fixed issues w/ Active Record 4.2
 
 ## 2.3.0 (2014-08-31)
 
-- Raise error when ActiveRecord::Base.default_timezone is not `:utc`
+- 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 (2014-06-23)
 
-- Fixed ActiveRecord 3 associations
+- Fixed Active Record 3 associations
 
 ## 2.2.0 (2014-06-22)
 
@@ -263,3 +282,44 @@ Breaking changes
 ## 1.0.0 (2013-05-15)
 
 - First major release
+
+## 0.1.6 (2013-05-07)
+
+- Fixed error with Ruby 1.8
+
+## 0.1.5 (2013-05-01)
+
+- Added support for getting the entire series
+
+## 0.1.4 (2013-05-01)
+
+- Added support for Ruby 1.8
+
+## 0.1.3 (2013-04-25)
+
+- Improved field names for ordering
+
+## 0.1.2 (2013-04-24)
+
+- Added ability to order easily
+
+## 0.1.1 (2013-04-21)
+
+- Improved return types for MySQL
+
+## 0.1.0 (2013-04-21)
+
+- Added `day_of_week`
+- Added `hour_of_day`
+
+## 0.0.3 (2013-04-18)
+
+- Added support for Rails time zone strings
+
+## 0.0.2 (2013-04-18)
+
+- Added tests
+
+## 0.0.1 (2013-04-17)
+
+- First release

data/LICENSE.txt

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

data/README.md

@@ -11,11 +11,11 @@ The simplest way to group by:
 
 :cake: Get the entire series - **the other best part**
 
-Supports PostgreSQL, MySQL, and Redshift, plus arrays and hashes (and limited support for [SQLite](#for-sqlite))
+Supports PostgreSQL, MySQL, MariaDB, SQLite, and Redshift, plus arrays and hashes
 
 :cupid: Goes hand in hand with [Chartkick](https://www.chartkick.com)
 
-[![Build Status](https://github.com/ankane/groupdate/workflows/build/badge.svg?branch=master)](https://github.com/ankane/groupdate/actions)
+[![Build Status](https://github.com/ankane/groupdate/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/groupdate/actions)
 
 ## Installation
 
@@ -25,16 +25,16 @@ Add this line to your application’s Gemfile:
 gem "groupdate"
 ```
 
-For MySQL and SQLite, also follow [these instructions](#additional-instructions).
+For MySQL and MariaDB, also follow [these instructions](#additional-instructions).
 
 ## Getting Started
 
 ```ruby
 User.group_by_day(:created_at).count
 # {
-#   Sat, 24 May 2020 => 50,
-#   Sun, 25 May 2020 => 100,
-#   Mon, 26 May 2020 => 34
+#   Wed, 01 Jan 2025 => 50,
+#   Thu, 02 Jan 2025 => 100,
+#   Fri, 03 Jan 2025 => 34
 # }
 ```
 
@@ -75,9 +75,9 @@ or
 ```ruby
 User.group_by_week(:created_at, time_zone: "Pacific Time (US & Canada)").count
 # {
-#   Sun, 08 Mar 2020 => 70,
-#   Sun, 15 Mar 2020 => 54,
-#   Sun, 22 Mar 2020 => 80
+#   Sun, 05 Jan 2025 => 70,
+#   Sun, 12 Jan 2025 => 54,
+#   Sun, 19 Jan 2025 => 80
 # }
 ```
 
@@ -154,8 +154,8 @@ To get keys in a different format, use:
 ```ruby
 User.group_by_month(:created_at, format: "%b %Y").count
 # {
-#   "Jan 2020" => 10
-#   "Feb 2020" => 12
+#   "Jan 2025" => 10
+#   "Feb 2025" => 12
 # }
 ```
 
@@ -250,7 +250,9 @@ users.group_by_day { |u| u.created_at }.to_h { |k, v| [k, v.count] }
 
 ## Additional Instructions
 
-### For MySQL
+<a name="for-mysql"></a>
+
+### For MySQL and MariaDB
 
 [Time zone support](https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html) must be installed on the server.
 
@@ -266,32 +268,6 @@ SELECT CONVERT_TZ(NOW(), '+00:00', 'Pacific/Honolulu');
 
 It should return the time instead of `NULL`.
 
-### For SQLite
-
-Groupdate has limited support for SQLite.
-
-- No time zone support
-- 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:
-
-```ruby
-Groupdate.time_zone = false
-```
-
-## Upgrading
-
-### 6.0
-
-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
-```
-
-Also, the `dates` option has been removed.
-
 ## History
 
 View the [changelog](https://github.com/ankane/groupdate/blob/master/CHANGELOG.md)

data/lib/groupdate/adapters/base_adapter.rb

@@ -3,7 +3,7 @@ module Groupdate
     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:)
+      def initialize(relation, column:, period:, time_zone:, time_range:, week_start:, day_start:, n_seconds:, adapter_name: nil)
         @relation = relation
         @column = column
         @period = period
@@ -12,15 +12,10 @@ module Groupdate
         @week_start = week_start
         @day_start = day_start
         @n_seconds = n_seconds
+        @adapter_name = adapter_name
 
-        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
+        if ActiveRecord.default_timezone == :local
+          raise Groupdate::Error, "ActiveRecord.default_timezone must be :utc to use Groupdate"
         end
       end
 

data/lib/groupdate/adapters/postgresql_adapter.rb

@@ -23,7 +23,7 @@ module Groupdate
           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"
+            if @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]

data/lib/groupdate/adapters/sqlite_adapter.rb

@@ -2,9 +2,6 @@ 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}"]
@@ -36,7 +33,7 @@ module Groupdate
               when :month
                 "%Y-%m-01"
               when :quarter
-                raise Groupdate::Error, "Quarter not supported for SQLite"
+                nil
               else # year
                 "%Y-01-01"
               end
@@ -44,8 +41,46 @@ module Groupdate
             ["strftime(?, #{column})", format]
           end
 
+        if period != :custom && (@time_zone != SeriesBuilder.utc || day_start != 0 || period == :quarter)
+          setup_function
+          week_start = period == :week ? Groupdate::Magic::DAYS[self.week_start].to_s : nil
+          query = ["groupdate_internal(?, #{column}, ?, ?, ?)", period, @time_zone.tzinfo.name, day_start, week_start]
+        end
+
         @relation.send(:sanitize_sql_array, query)
       end
+
+      private
+
+      def setup_function
+        @relation.connection_pool.with_connection do |connection|
+          raw_connection = connection.raw_connection
+          return if raw_connection.instance_variable_defined?(:@groupdate_function)
+
+          utc = SeriesBuilder.utc
+          date_periods = %i[day week month quarter year]
+
+          # note: this function is part of the internal API and may change between releases
+          # TODO improve performance
+          raw_connection.create_function("groupdate_internal", 4) do |func, period, value, time_zone, day_start, week_start|
+            if value.nil?
+              func.result = nil
+            else
+              period = period.to_sym
+              # cast_result handles week_start for day_of_week
+              week_start = :sunday if period == :day_of_week
+              result = SeriesBuilder.round_time(utc.parse(value), period, ActiveSupport::TimeZone[time_zone], day_start.to_i, week_start&.to_sym)
+              if date_periods.include?(period)
+                result = result.strftime("%Y-%m-%d")
+              elsif result.is_a?(Time)
+                result = result.in_time_zone(utc).strftime("%Y-%m-%d %H:%M:%S")
+              end
+              func.result = result
+            end
+          end
+          raw_connection.instance_variable_set(:@groupdate_function, true)
+        end
+      end
     end
   end
 end

data/lib/groupdate/enumerable.rb

@@ -5,7 +5,7 @@ module Enumerable
         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.group_by_period(period, *args, **options, &block) }
+        scoping { klass.group_by_period(period, *args, **options, &block) }
       else
         raise ArgumentError, "no block given"
       end
@@ -19,7 +19,7 @@ module Enumerable
       Groupdate::Magic.validate_period(period, options.delete(:permit))
       send("group_by_#{period}", **options, &block)
     else
-      scoping { @klass.group_by_period(period, *args, **options, &block) }
+      scoping { klass.group_by_period(period, *args, **options, &block) }
     end
   end
 end

data/lib/groupdate/magic.rb

@@ -180,12 +180,13 @@ module Groupdate
       end
 
       def time_zone_support?(relation)
-        if relation.connection.adapter_name =~ /mysql/i
-          # need to call klass for Rails < 5.2
-          sql = relation.klass.send(:sanitize_sql_array, ["SELECT CONVERT_TZ(NOW(), '+00:00', ?)", time_zone.tzinfo.name])
-          !relation.connection.select_all(sql).first.values.first.nil?
-        else
-          true
+        relation.connection_pool.with_connection do |connection|
+          if connection.adapter_name.match?(/mysql|trilogy/i)
+            sql = relation.send(:sanitize_sql_array, ["SELECT CONVERT_TZ(NOW(), '+00:00', ?)", time_zone.tzinfo.name])
+            !connection.select_all(sql).to_a.first.values.first.nil?
+          else
+            true
+          end
         end
       end
 
@@ -203,7 +204,7 @@ module Groupdate
       def self.generate_relation(relation, field:, **options)
         magic = Groupdate::Magic::Relation.new(**options)
 
-        adapter_name = relation.connection.adapter_name
+        adapter_name = relation.connection_pool.with_connection { |c| c.adapter_name }
         adapter = Groupdate.adapters[adapter_name]
         raise Groupdate::Error, "Connection adapter not supported: #{adapter_name}" unless adapter
 
@@ -221,7 +222,8 @@ module Groupdate
             time_range: magic.time_range,
             week_start: magic.week_start,
             day_start: magic.day_start,
-            n_seconds: magic.n_seconds
+            n_seconds: magic.n_seconds,
+            adapter_name: adapter_name
           ).generate
 
         # add Groupdate info
@@ -238,7 +240,7 @@ module Groupdate
         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)
+            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
@@ -251,13 +253,13 @@ module Groupdate
         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
+          relation.connection_pool.with_connection { |c| c.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|
+        relation.groupdate_values.reverse_each do |gv|
           result = gv.perform(relation, result, default_value: options[:default_value])
         end
         result

data/lib/groupdate/series_builder.rb

@@ -46,7 +46,12 @@ module Groupdate
         return time_zone.at((time.to_time.to_i / n_seconds) * n_seconds)
       end
 
-      time = time.to_time.in_time_zone(time_zone)
+      # TODO avoid calling to_time on dates
+      self.class.round_time(time.to_time, period, time_zone, day_start, @week_start_key)
+    end
+
+    def self.round_time(time, period, time_zone, day_start, week_start_key)
+      time = time.in_time_zone(time_zone)
 
       if day_start != 0
         # apply day_start to a time object that's not affected by DST
@@ -65,7 +70,7 @@ module Groupdate
         when :day
           time.beginning_of_day
         when :week
-          time.beginning_of_week(@week_start_key)
+          time.beginning_of_week(week_start_key)
         when :month
           time.beginning_of_month
         when :quarter
@@ -77,7 +82,7 @@ module Groupdate
         when :minute_of_hour
           time.min
         when :day_of_week
-          time.days_to_week_start(@week_start_key)
+          time.days_to_week_start(week_start_key)
         when :day_of_month
           time.day
         when :month_of_year
@@ -297,7 +302,7 @@ module Groupdate
       options.key?(:series) ? options[:series] : series_default
     end
 
-    def utc
+    def self.utc
       @utc ||= ActiveSupport::TimeZone["Etc/UTC"]
     end
   end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "6.4.0"
+  VERSION = "6.7.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.7.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,15 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-description:
+        version: '7.1'
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -50,7 +48,6 @@ homepage: https://github.com/ankane/groupdate
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,15 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: The simplest way to group temporal data
 test_files: []