groupdate 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a15c2188ffbf51536333cfad342a88325d5866c
-  data.tar.gz: 962f3ddeffa87168994308c6740ad126393db9e3
+  metadata.gz: 87e6343538ca0aa70041863153b514d765952ca9
+  data.tar.gz: a5121f5bab5c8f9de575e5adcf09885c88abd08a
 SHA512:
-  metadata.gz: caf2a8b62b7d05e4934f3035b1d7e16c739bef41d316ced765ceb48b0b5c36cb29bad12579ca90b3cfdacdb870d4ab721bc0d925aa5d1c791b15a393a067d4ba
-  data.tar.gz: dabd8ea049f07f730c219348dc247996838831221252eecb3a58a40fd650aa6a16b552a707db4aba1e6b522e984300888e4a7615fb8737bb0360ae2f2ff8e73b
+  metadata.gz: 62c9cc55ca4f808911727d3513a50f79b379b041589b38a52214b9d87fe38d2d321ce6bb4d41a7b0fc9a8fc9a780f039d626582ce71cd65fdfe81467ac1a9107
+  data.tar.gz: b0dd02d55c7f72247e1bb5c7b9f221cddd4321fcb4e77d2101b9b759948e145385987e938134d5888ee95864066fbb943aae7a6226b7bc26fc334ffb6c219402

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
   - 2.2.4
-  - jruby
+  - jruby-9.1.5.0
 gemfile:
   - Gemfile
-  - test/gemfiles/activerecord31.gemfile
   - test/gemfiles/activerecord32.gemfile
   - test/gemfiles/activerecord40.gemfile
   - test/gemfiles/activerecord41.gemfile
@@ -22,7 +21,5 @@ notifications:
     on_failure: change
 matrix:
   allow_failures:
-    - rvm: jruby
+    - rvm: jruby-9.1.5.0
       gemfile: Gemfile
-    - rvm: jruby
-      gemfile: test/gemfiles/activerecord42.gemfile

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.0
+
+- Better support for date columns with `time_zone: false`
+- Better date range handling for `range` option
+
 ## 3.0.2
 
 - Fixed `group_by_period` with associations

data/README.md

@@ -190,6 +190,14 @@ User.group_by_period(params[:period], :created_at, permit: %w[day week]).count
 
 Raises an `ArgumentError` for unpermitted periods.
 
+### Date Columns
+
+If grouping on date columns which don’t need time zone conversion, use:
+
+```ruby
+User.group_by_week(:created_on, time_zone: false).count
+```
+
 ## Arrays and Hashes
 
 ```ruby

data/lib/groupdate/active_record.rb

@@ -1,6 +1,7 @@
 require "active_record"
 require "groupdate/order_hack"
 require "groupdate/scopes"
+require "groupdate/calculations"
 require "groupdate/series"
 
 ActiveRecord::Base.send(:extend, Groupdate::Scopes)

data/lib/groupdate/calculations.rb

@@ -0,0 +1,26 @@
+module Groupdate
+  class Calculations
+    attr_reader :relation
+
+    def initialize(relation)
+      @relation = relation
+    end
+
+    def include?(method)
+      # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
+      ActiveRecord::Calculations.method_defined?(method) || custom_calculations.include?(method)
+    end
+
+    def custom_calculations
+      return [] if !model.respond_to?(:groupdate_calculation_methods)
+      model.groupdate_calculation_methods
+    end
+
+    private
+
+    def model
+      return if !relation.respond_to?(:klass)
+      relation.klass
+    end
+  end
+end

data/lib/groupdate/magic.rb

@@ -158,7 +158,8 @@ module Groupdate
 
     def time_zone
       @time_zone ||= begin
-        time_zone = options[:time_zone] || Groupdate.time_zone || Time.zone || "Etc/UTC"
+        time_zone = "Etc/UTC" if options[:time_zone] == false
+        time_zone ||= options[:time_zone] || Groupdate.time_zone || Time.zone || "Etc/UTC"
         time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone]
       end
     end
@@ -174,7 +175,13 @@ module Groupdate
     def time_range
       @time_range ||= begin
         time_range = options[:range]
-        if !time_range && options[:last]
+        if time_range.is_a?(Range) && time_range.first.is_a?(Date)
+          # convert range of dates to range of times
+          # use parsing instead of in_time_zone due to Rails < 4
+          last = time_zone.parse(time_range.last.to_s)
+          last += 1.day unless time_range.exclude_end?
+          time_range = Range.new(time_zone.parse(time_range.first.to_s), last, true)
+        elsif !time_range && options[:last]
           step = 1.send(field) if 1.respond_to?(field)
           if step
             now = Time.now

data/lib/groupdate/series.rb

@@ -5,14 +5,14 @@ module Groupdate
     def initialize(magic, relation)
       @magic = magic
       @relation = relation
+      @calculations = Groupdate::Calculations.new(relation)
     end
 
     # clone to prevent modifying original variables
     def method_missing(method, *args, &block)
-      # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
-      if ActiveRecord::Calculations.method_defined?(method)
+      if @calculations.include?(method)
         magic.perform(relation, method, *args, &block)
-      elsif @relation.respond_to?(method, true)
+      elsif relation.respond_to?(method, true)
         Groupdate::Series.new(magic, relation.send(method, *args, &block))
       else
         super
@@ -20,7 +20,7 @@ module Groupdate
     end
 
     def respond_to?(method, include_all = false)
-      ActiveRecord::Calculations.method_defined?(method) || relation.respond_to?(method) || super
+      @calculations.include?(method) || relation.respond_to?(method) || super
     end
 
     def reverse_order_value

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "3.0.2"
+  VERSION = "3.1.0"
 end

data/test/test_helper.rb

@@ -18,6 +18,18 @@ ActiveRecord::Base.time_zone_aware_attributes = true
 
 class User < ActiveRecord::Base
   has_many :posts
+
+  def self.groupdate_calculation_methods
+    [:custom_count, :undefined_calculation]
+  end
+
+  def self.custom_count
+    count
+  end
+
+  def self.unlisted_calculation
+    count
+  end
 end
 
 class Post < ActiveRecord::Base
@@ -93,6 +105,8 @@ module TestDatabase
   end
 
   def test_table_name
+    # This test is to ensure there's not an error when using the table
+    # name as part of the column name.
     assert_empty User.group_by_day("users.created_at").count
   end
 
@@ -192,7 +206,7 @@ module TestDatabase
     assert_raises(NoMethodError) { User.group_by_day(:created_at).no_such_method }
   end
 
-  def test_respond_to_where
+  def test_respond_to_order
     assert User.group_by_day(:created_at).respond_to?(:order)
   end
 
@@ -333,17 +347,40 @@ module TestDatabase
     assert_equal 2, User.group_by_day(:created_at, carry_forward: true).count[Date.parse("2014-05-02")]
   end
 
-  # dates
-
-  def test_dates
-    create_user "2014-03-01 12:00:00 UTC"
-    assert_equal ({Date.parse("2014-03-01") => 1}), User.group_by_day(:created_at, dates: true).count
-  end
+  # no column
 
   def test_no_column
     assert_raises(ArgumentError) { User.group_by_day.first }
   end
 
+  # custom model calculation methods
+
+  def test_custom_model_calculation_method
+    create_user "2014-05-01"
+    create_user "2014-05-01"
+    create_user "2014-05-03"
+
+    expected = {
+      Date.parse("2014-05-01") => 2,
+      Date.parse("2014-05-02") => 0,
+      Date.parse("2014-05-03") => 1
+    }
+
+    assert_equal expected, User.group_by_day(:created_at).custom_count
+  end
+
+  def test_using_unlisted_calculation_method_returns_new_series_instance
+    assert_instance_of Groupdate::Series, User.group_by_day(:created_at).unlisted_calculation
+  end
+
+  def test_using_listed_but_undefined_custom_calculation_method_raises_error
+    assert_raises(RuntimeError) do
+      User.group_by_day(:created_at).undefined_calculation
+    end
+  end
+
+  private
+
   def call_method(method, field, options)
     User.group_by_period(method, field, options).count
   end
@@ -1005,16 +1042,51 @@ module TestGroupdate
     expected = {
       Date.parse("2013-05-03") => 1
     }
-    assert_equal expected, result(:day, "2013-05-03", false, dates: true)
+    assert_equal expected, result(:day, "2013-05-03", false)
   end
 
   def test_date_column_with_time_zone
     # TODO change for Groupdate 3.0
-    skip
+    expected = {
+      Date.parse("2013-05-02") => 1
+    }
+    assert_equal expected, result(:day, "2013-05-03", true)
+  end
+
+  def test_date_column_with_time_zone_false
+    Time.zone = pt
+    create_user "2013-05-03"
     expected = {
       Date.parse("2013-05-03") => 1
     }
-    assert_equal expected, result(:day, "2013-05-03", true, dates: true)
+    assert_equal expected, call_method(:day, :created_at, time_zone: false)
+  ensure
+    Time.zone = nil
+  end
+
+  # date range
+
+  def test_date_range
+    ENV["TZ"] = "Europe/Oslo"
+    expected = {
+      Date.parse("2013-05-01") => 0,
+      Date.parse("2013-05-02") => 0,
+      Date.parse("2013-05-03") => 0
+    }
+    assert_equal expected, call_method(:day, :created_at, series: true, range: Date.parse("2013-05-01")..Date.parse("2013-05-03"))
+  ensure
+    ENV["TZ"] = "UTC"
+  end
+
+  def test_date_range_exclude_end
+    ENV["TZ"] = "Europe/Oslo"
+    expected = {
+      Date.parse("2013-05-01") => 0,
+      Date.parse("2013-05-02") => 0
+    }
+    assert_equal expected, call_method(:day, :created_at, series: true, range: Date.parse("2013-05-01")...Date.parse("2013-05-03"))
+  ensure
+    ENV["TZ"] = "UTC"
   end
 
   # day start
@@ -1027,6 +1099,8 @@ module TestGroupdate
     assert_result_date :day, "2013-05-03", "2013-05-03 02:30:00", false, day_start: 2.5
   end
 
+  private
+
   # helpers
 
   def assert_format(method, expected, format, options = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,6 +125,7 @@ files:
 - groupdate.gemspec
 - lib/groupdate.rb
 - lib/groupdate/active_record.rb
+- lib/groupdate/calculations.rb
 - lib/groupdate/enumerable.rb
 - lib/groupdate/magic.rb
 - lib/groupdate/order_hack.rb
@@ -162,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: The simplest way to group temporal data
@@ -178,4 +179,3 @@ test_files:
 - test/postgresql_test.rb
 - test/redshift_test.rb
 - test/test_helper.rb
-has_rdoc: