groupdate 5.1.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 163a969c3eb174890b78b4512c6a6631e02722a43f1fbcc30926f3e48cdba461
-  data.tar.gz: 256ee01a6e991c7513390e8cdf6d27b3e4458018e0980d63e9506bccfc6923d8
+  metadata.gz: 448e7901aa2448bca591568110960048d18ac0f21faa5c3cae566fc4a6de30c4
+  data.tar.gz: ba242e41103ae9d2542ff0509de1f454f58142957f0da190482769a42a152887
 SHA512:
-  metadata.gz: 37093986846259dc59a17187af24097a2ed9d881de6a48ff9a394883e5a936a569fd758daf820cc9444e69212d29548ab21a816f7fac0cba1b7e502ac2d99198
-  data.tar.gz: d1639375454ed0d1d33600226287a484ae7001c3759446b2c196dd24f1e003f3fce7f0c8f2253d90819bc280260bedfed2fa6f622f24ad46c590c05739177df2
+  metadata.gz: 91b008f8ee0d9ad419ec042ee2f417b621fba09793b223705a2898fe21083a09527885ead3be2d3b8003427473d1f996938098c9bd7139bcb9bffdad2810734c
+  data.tar.gz: d4eb493bdf4b7f40eda2733003263bee49e62f9f69fb6239bec118d1768ce0630c21244e819147ca6b5b1556a9b5e125ed69748e2ee69d3c325f31a2740a6ec5

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 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
+- Added support for beginless and endless ranges in `range` option
+
 ## 5.1.0 (2020-07-30)
 
 - Added `n` option to minute and second for custom durations

data/README.md

@@ -60,7 +60,7 @@ and
 - day_of_year
 - month_of_year
 
-Use it anywhere you can use `group`. Works with `count`, `sum`, `minimum`, `maximum`, and `average`. For `median`, check out [ActiveMedian](https://github.com/ankane/active_median).
+Use it anywhere you can use `group`. Works with `count`, `sum`, `minimum`, `maximum`, and `average`. For `median` and `percentile`, check out [ActiveMedian](https://github.com/ankane/active_median).
 
 ### Time Zones
 

data/lib/groupdate/magic.rb

@@ -47,7 +47,6 @@ module Groupdate
       # TODO better messages
       raise ArgumentError, "Unrecognized time zone" unless time_zone
       raise ArgumentError, "Unrecognized :week_start option" unless week_start
-      raise ArgumentError, "Cannot use endless range for :range option" if options[:range].is_a?(Range) && !options[:range].end
       raise ArgumentError, ":day_start must be between 0 and 24" if (day_start / 3600) < 0 || (day_start / 3600) >= 24
     end
 

data/lib/groupdate/relation_builder.rb

@@ -3,6 +3,9 @@ module Groupdate
     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
@@ -188,13 +191,30 @@ module Groupdate
 
     def where_clause
       if @time_range.is_a?(Range)
-        op = @time_range.exclude_end? ? "<" : "<="
-        ["#{column} >= ? AND #{column} #{op} ?", @time_range.first, @time_range.last]
+        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

data/lib/groupdate/series_builder.rb

@@ -11,7 +11,6 @@ module Groupdate
       @day_start = day_start
       @n_seconds = n_seconds
       @options = options
-      @round_time = {}
       @week_start_key = Groupdate::Magic::DAYS[@week_start] if @week_start
     end
 
@@ -142,11 +141,35 @@ module Groupdate
     def time_range
       @time_range ||= begin
         time_range = options[:range]
-        if time_range.is_a?(Range) && time_range.first.is_a?(Date)
-          # convert range of dates to range of times
-          last = time_range.last.in_time_zone(time_zone)
-          last += 1.day unless time_range.exclude_end?
-          time_range = Range.new(time_range.first.in_time_zone(time_zone), last, true)
+
+        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
+
+          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, finish, exclude_end)
         elsif !time_range && options[:last]
           if period == :quarter
             step = 3.months
@@ -200,7 +223,7 @@ module Groupdate
       else
         time_range = self.time_range
         time_range =
-          if time_range.is_a?(Range)
+          if time_range.is_a?(Range) && time_range.begin && time_range.end
             time_range
           else
             # use first and last values
@@ -211,11 +234,23 @@ module Groupdate
                 data.keys.sort
               end
 
-            tr = sorted_keys.first..sorted_keys.last
-            if options[:current] == false && sorted_keys.any? && round_time(now) >= tr.last
-              tr = tr.first...round_time(now)
+            if time_range.is_a?(Range)
+              if sorted_keys.any?
+                if time_range.begin
+                  time_range.begin..sorted_keys.last
+                else
+                  Range.new(sorted_keys.first, time_range.end, time_range.exclude_end?)
+                end
+              else
+                nil..nil
+              end
+            else
+              tr = sorted_keys.first..sorted_keys.last
+              if options[:current] == false && sorted_keys.any? && round_time(now) >= tr.last
+                tr = tr.first...round_time(now)
+              end
+              tr
             end
-            tr
           end
 
         if time_range.begin

data/lib/groupdate/version.rb

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

metadata

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