groupdate 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fee4526fc30babd6bcffe4121102670b945ac37e5017c47eff03e406a83bf029
-  data.tar.gz: ce960c7d5c3166f212f93c358ffae736b4306bdedfef6a6db4fe137aea628ade
+  metadata.gz: 163a969c3eb174890b78b4512c6a6631e02722a43f1fbcc30926f3e48cdba461
+  data.tar.gz: 256ee01a6e991c7513390e8cdf6d27b3e4458018e0980d63e9506bccfc6923d8
 SHA512:
-  metadata.gz: fbb0de4e049d1765067cc4c0a175be1e1808b2c56016e54566d00f9b87234cc90fa7ac61d3fbf7683597369d67e2be38dcd08dad9ce20d734224f102d00456be
-  data.tar.gz: 465694dd5bfb028c1f7f3cd3c9d5fc9ff3dab28de64f394bf765c5f71fdfed67a797ebaf9f24a7a8d3a808e684b296872f58cd71bae088676e3e767e089ab121
+  metadata.gz: 37093986846259dc59a17187af24097a2ed9d881de6a48ff9a394883e5a936a569fd758daf820cc9444e69212d29548ab21a816f7fac0cba1b7e502ac2d99198
+  data.tar.gz: d1639375454ed0d1d33600226287a484ae7001c3759446b2c196dd24f1e003f3fce7f0c8f2253d90819bc280260bedfed2fa6f622f24ad46c590c05739177df2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.1.0 (2020-07-30)
+
+- Added `n` option to minute and second for custom durations
+
 ## 5.0.0 (2020-02-18)
 
 - Added support for `week_start` for SQLite

data/README.md

@@ -194,6 +194,14 @@ User.group_by_period(params[:period], :created_at, permit: ["day", "week"]).coun
 
 Raises an `ArgumentError` for unpermitted periods.
 
+### Custom Duration
+
+To group by a specific number of minutes or seconds, use:
+
+```ruby
+User.group_by_minute(:created_at, n: 10).count # 10 minutes
+```
+
 ### Date Columns
 
 If grouping on date columns which don’t need time zone conversion, use:
@@ -287,8 +295,6 @@ Groupdate 5.0 brings a number of improvements. Here are a few to be aware of:
 
 View the [changelog](https://github.com/ankane/groupdate/blob/master/CHANGELOG.md)
 
-Groupdate follows [Semantic Versioning](https://semver.org/)
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/groupdate/magic.rb

@@ -4,7 +4,7 @@ module Groupdate
   class Magic
     DAYS = [:monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday]
 
-    attr_accessor :period, :options, :group_index
+    attr_accessor :period, :options, :group_index, :n_seconds
 
     def initialize(period:, **options)
       @period = period
@@ -12,6 +12,13 @@ module Groupdate
 
       validate_keywords
       validate_arguments
+
+      if options[:n]
+        raise ArgumentError, "n must be a positive integer" if !options[:n].is_a?(Integer) || options[:n] < 1
+        @period = :custom
+        @n_seconds = options[:n].to_i
+        @n_seconds *= 60 if period == :minute
+      end
     end
 
     def validate_keywords
@@ -28,6 +35,10 @@ module Groupdate
         @day_start = 0
       end
 
+      if %i[second minute].include?(period)
+        known_keywords << :n
+      end
+
       unknown_keywords = options.keys - known_keywords
       raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
     end
@@ -66,7 +77,8 @@ module Groupdate
           period: period,
           time_zone: time_zone,
           day_start: day_start,
-          week_start: week_start
+          week_start: week_start,
+          n_seconds: n_seconds
         )
     end
 
@@ -174,7 +186,8 @@ module Groupdate
             time_zone: magic.time_zone,
             time_range: magic.time_range,
             week_start: magic.week_start,
-            day_start: magic.day_start
+            day_start: magic.day_start,
+            n_seconds: magic.n_seconds
           ).generate
 
         # add Groupdate info

data/lib/groupdate/relation_builder.rb

@@ -1,8 +1,8 @@
 module Groupdate
   class RelationBuilder
-    attr_reader :period, :column, :day_start, :week_start
+    attr_reader :period, :column, :day_start, :week_start, :n_seconds
 
-    def initialize(relation, column:, period:, time_zone:, time_range:, week_start:, day_start:)
+    def initialize(relation, column:, period:, time_zone:, time_range:, week_start:, day_start:, n_seconds:)
       @relation = relation
       @column = resolve_column(relation, column)
       @period = period
@@ -10,6 +10,7 @@ module Groupdate
       @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"
@@ -47,6 +48,8 @@ module Groupdate
             ["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
@@ -85,6 +88,8 @@ module Groupdate
             ["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
@@ -99,6 +104,8 @@ module Groupdate
 
           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
@@ -155,6 +162,8 @@ module Groupdate
             # 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

data/lib/groupdate/series_builder.rb

@@ -1,14 +1,15 @@
 module Groupdate
   class SeriesBuilder
-    attr_reader :period, :time_zone, :day_start, :week_start, :options
+    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:, **options)
+    def initialize(period:, time_zone:, day_start:, week_start:, n_seconds:, **options)
       @period = period
       @time_zone = time_zone
       @week_start = week_start
       @day_start = day_start
+      @n_seconds = n_seconds
       @options = options
       @round_time = {}
       @week_start_key = Groupdate::Magic::DAYS[@week_start] if @week_start
@@ -73,6 +74,10 @@ module Groupdate
     end
 
     def round_time(time)
+      if period == :custom
+        return time_zone.at((time.to_time.to_i / n_seconds) * n_seconds)
+      end
+
       time = time.to_time.in_time_zone(time_zone)
 
       if day_start != 0
@@ -145,6 +150,8 @@ module Groupdate
         elsif !time_range && options[:last]
           if period == :quarter
             step = 3.months
+          elsif period == :custom
+            step = n_seconds
           elsif 1.respond_to?(period)
             step = 1.send(period)
           else
@@ -216,14 +223,17 @@ module Groupdate
 
           if period == :quarter
             step = 3.months
+          elsif period == :custom
+            step = n_seconds
           else
             step = 1.send(period)
           end
 
           last_step = series.last
+          day_start_hour = day_start / 3600
           loop do
             next_step = last_step + step
-            next_step = round_time(next_step) if next_step.hour != day_start # add condition to speed up
+            next_step = round_time(next_step) if next_step.hour != day_start_hour # add condition to speed up
             break unless time_range.cover?(next_step)
 
             if next_step == last_step

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "5.0.0"
+  VERSION = "5.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport