groupdate 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624c0ae83a0c0952676b3d3efb79826b2b470d0a5efab6da31523ca8284db8f3
-  data.tar.gz: 6c15c17557aee5b8babd8b2939af9325449a4831ed0ee24901c27d37b7352fe3
+  metadata.gz: e80d5888009185498959b5a739bc9a4517d45b801391a91cfcfc7a0f0b914b68
+  data.tar.gz: 2a6b502d0526c534ca2ffdfbe28cf1fa1c394e3643c9a9546e1c288305022642
 SHA512:
-  metadata.gz: dfa2c03830675352029e74768bad800acd7ac56edc9dbcdb01f58787f34858120c4f9f1d1436ee4bdb38480922b111d746b75e3f0b7ff59f5bb770e74e01c4c9
-  data.tar.gz: f300e95cb3a7098486c910a4e94a8ecd4313fad14988b78fc68495783d99f49fef643f8361a4566f9ad2737238393a88c79efbc7df41cd28251d962916264626
+  metadata.gz: '0867e9d04c7cf962813e9ed6ce4c3e8e94f4e468b198ade9278dabe03d5ae6b2538190cb427f074ac469b1ed19edc094f741461b550a6629de99b82aeca592c5'
+  data.tar.gz: 32244b184845925291bbc4cf399d0967413bd17456c9b534a9184f19e965654a8bad239a44d5b0555f7b63090d75e501ddaef449c83becfaf48d9ad136230ca0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 4.1.0
+
+- Many performance improvements
+- Added check for consistent time zone info
+- Fixed error message for invalid queries with MySQL and SQLite
+- Fixed issue with enumerable methods ignoring nils
+
 ## 4.0.2
 
 - Make `current` option work without `last`

data/README.md

@@ -48,7 +48,7 @@ and
 - day_of_month
 - month_of_year
 
-Use it anywhere you can use `group`.
+Use it anywhere you can use `group`. Works with `count`, `sum`, `minimum`, `maximum`, `average`, and [`median`](https://github.com/ankane/active_median).
 
 ### Time Zones
 
@@ -177,7 +177,7 @@ User.group_by_period(:day, :created_at).count
 Limit groupings with the `permit` option.
 
 ```ruby
-User.group_by_period(params[:period], :created_at, permit: %w[day week]).count
+User.group_by_period(params[:period], :created_at, permit: ["day", "week"]).count
 ```
 
 Raises an `ArgumentError` for unpermitted periods.
@@ -190,6 +190,19 @@ If grouping on date columns which don’t need time zone conversion, use:
 User.group_by_week(:created_on, time_zone: false).count
 ```
 
+### User Input
+
+If passing user input as the column, be sure to sanitize it first [like you must](https://rails-sqli.org/) with `group`.
+
+```ruby
+column = params[:column]
+
+# check against permitted columns
+raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
+
+User.group_by_day(column).count
+```
+
 ## Arrays and Hashes
 
 ```ruby
@@ -229,7 +242,7 @@ or copy and paste [these statements](https://gist.githubusercontent.com/ankane/1
 You can confirm it worked with:
 
 ```sql
-SELECT CONVERT_TZ(NOW(), '+00:00', 'Etc/UTC');
+SELECT CONVERT_TZ(NOW(), '+00:00', 'Pacific/Honolulu');
 ```
 
 It should return the time instead of `NULL`.

data/lib/groupdate/magic.rb

@@ -48,7 +48,11 @@ module Groupdate
 
     class Enumerable < Magic
       def group_by(enum, &_block)
-        group = enum.group_by { |v| v = yield(v); v ? series_builder.round_time(v) : nil }
+        group = enum.group_by do |v|
+          v = yield(v)
+          raise ArgumentError, "Not a time" unless v.respond_to?(:to_time)
+          series_builder.round_time(v)
+        end
         series_builder.generate(group, default_value: [], series_default: false)
       end
 
@@ -66,7 +70,7 @@ module Groupdate
       def perform(relation, result, default_value:)
         multiple_groups = relation.group_values.size > 1
 
-        check_time_zone_support(result, multiple_groups)
+        check_nils(result, multiple_groups, relation)
         result = cast_result(result, multiple_groups)
 
         series_builder.generate(
@@ -78,25 +82,49 @@ module Groupdate
       end
 
       def cast_method
-        case period
-        when :day_of_week
-          lambda { |k| (k.to_i - 1 - week_start) % 7 }
-        when :hour_of_day, :day_of_month, :month_of_year, :minute_of_hour
-          lambda { |k| k.to_i }
-        else
-          utc = ActiveSupport::TimeZone["UTC"]
-          lambda { |k| (k.is_a?(String) || !k.respond_to?(:to_time) ? utc.parse(k.to_s) : k.to_time).in_time_zone(time_zone) }
+        @cast_method ||= begin
+          case period
+          when :day_of_week
+            lambda { |k| (k.to_i - 1 - week_start) % 7 }
+          when :hour_of_day, :day_of_month, :month_of_year, :minute_of_hour
+            lambda { |k| k.to_i }
+          else
+            utc = ActiveSupport::TimeZone["UTC"]
+            lambda { |k| (k.is_a?(String) || !k.respond_to?(:to_time) ? utc.parse(k.to_s) : k.to_time).in_time_zone(time_zone) }
+          end
         end
       end
 
       def cast_result(result, multiple_groups)
-        Hash[result.map { |k, v| [multiple_groups ? k[0...group_index] + [cast_method.call(k[group_index])] + k[(group_index + 1)..-1] : cast_method.call(k), v] }]
+        new_result = {}
+        result.each do |k, v|
+          if multiple_groups
+            k[group_index] = cast_method.call(k[group_index])
+          else
+            k = cast_method.call(k)
+          end
+          new_result[k] = v
+        end
+        new_result
+      end
+
+      def time_zone_support?(relation)
+        if relation.connection.adapter_name =~ /mysql/i
+          sql = relation.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
+        end
       end
 
-      def check_time_zone_support(result, multiple_groups)
-        missing_time_zone_support = multiple_groups ? (result.keys.first && result.keys.first[group_index].nil?) : result.key?(nil)
-        if missing_time_zone_support
-          raise Groupdate::Error, "Be sure to install time zone support - https://github.com/ankane/groupdate#for-mysql"
+      def check_nils(result, multiple_groups, relation)
+        has_nils = multiple_groups ? (result.keys.first && result.keys.first[group_index].nil?) : result.key?(nil)
+        if has_nils
+          if time_zone_support?(relation)
+            raise Groupdate::Error, "Invalid query - be sure to use a date or time column"
+          else
+            raise Groupdate::Error, "Database missing time zone support for #{time_zone.tzinfo.name} - see https://github.com/ankane/groupdate#for-mysql"
+          end
         end
       end
 

data/lib/groupdate/relation_builder.rb

@@ -167,8 +167,8 @@ module Groupdate
 
     def where_clause
       if @time_range.is_a?(Range)
-        # doesn't matter whether we include the end of a ... range - it will be excluded later
-        ["#{column} >= ? AND #{column} <= ?", @time_range.first, @time_range.last]
+        op = @time_range.exclude_end? ? "<" : "<="
+        ["#{column} >= ? AND #{column} #{op} ?", @time_range.first, @time_range.last]
       else
         ["#{column} IS NOT NULL"]
       end

data/lib/groupdate/series_builder.rb

@@ -2,12 +2,15 @@ module Groupdate
   class SeriesBuilder
     attr_reader :period, :time_zone, :day_start, :week_start, :options
 
+    CHECK_PERIODS = [:day, :week, :month, :quarter, :year]
+
     def initialize(period:, time_zone:, day_start:, week_start:, **options)
       @period = period
       @time_zone = time_zone
       @week_start = week_start
       @day_start = day_start
       @options = options
+      @round_time = {}
     end
 
     def generate(data, default_value:, series_default: true, multiple_groups: false, group_index: nil)
@@ -19,8 +22,8 @@ module Groupdate
       end
 
       value = 0
-      Hash[series.map do |k|
-        value = data[k] || (@options[:carry_forward] && value) || default_value
+      result = Hash[series.map do |k|
+        value = data.delete(k) || (@options[:carry_forward] && value) || default_value
         key =
           if multiple_groups
             k[0...group_index] + [key_format.call(k[group_index])] + k[(group_index + 1)..-1]
@@ -30,10 +33,21 @@ module Groupdate
 
         [key, value]
       end]
+
+      # only check for database
+      # only checks remaining keys to avoid expensive calls to round_time
+      if series_default && CHECK_PERIODS.include?(period)
+        check_consistent_time_zone_info(data, multiple_groups, group_index)
+      end
+
+      result
     end
 
     def round_time(time)
-      time = time.to_time.in_time_zone(time_zone) - day_start.seconds
+      time = time.to_time.in_time_zone(time_zone)
+
+      # only if day_start != 0 for performance
+      time -= day_start.seconds if day_start != 0
 
       time =
         case period
@@ -69,7 +83,10 @@ module Groupdate
           raise Groupdate::Error, "Invalid period"
         end
 
-      time.is_a?(Time) ? time + day_start.seconds : time
+      # only if day_start != 0 for performance
+      time += day_start.seconds if day_start != 0 && time.is_a?(Time)
+
+      time
     end
 
     def time_range
@@ -157,7 +174,11 @@ module Groupdate
           end
 
           last_step = series.last
-          while (next_step = round_time(last_step + step)) && time_range.cover?(next_step)
+          loop do
+            next_step = last_step + step
+            next_step = round_time(next_step) if next_step.hour != 0 # add condition to speed up
+            break unless time_range.cover?(next_step)
+
             if next_step == last_step
               last_step += step
               next
@@ -221,6 +242,21 @@ module Groupdate
       end
     end
 
+    def check_consistent_time_zone_info(data, multiple_groups, group_index)
+      keys = data.keys
+      if multiple_groups
+        keys.map! { |k| k[group_index] }
+        keys.uniq!
+      end
+
+      keys.each do |key|
+        if key != round_time(key)
+          # only need to show what database returned since it will cast in Ruby time zone
+          raise Groupdate::Error, "Database and Ruby have inconsistent time zone info. Database returned #{key}"
+        end
+      end
+    end
+
     def entire_series?(series_default)
       options.key?(:series) ? options[:series] : series_default
     end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "4.0.2"
+  VERSION = "4.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport