groupdate 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b79c5fbce92b20167a5d590b155aa54a5f9a7719
-  data.tar.gz: 8fc3b7483fbb78e6dd28b1aa993eb6f7554aea49
+  metadata.gz: 00f2a25fe5b1a02e4b8a6e2b483e407ed4d5d76e
+  data.tar.gz: 5f6c81ee95f601a8ad189d706c53b5e57cf6d483
 SHA512:
-  metadata.gz: 23fb19dd4593f11e762e9728c9e637831aa00e64a466e8a3def9ccc0e51817c14150f387c27461d457cb27a6c310c76975f0383b4c24bc635d5fe06d04963554
-  data.tar.gz: d53817d4a0825181dafd79532107184aaab0ae473f3e697b26e6a44baa00674be21532b7757e8f119cc03aa26c1ae49bc6710eb180614133eb2b0e6e913cae2a
+  metadata.gz: e3f980694ad4a61ae5a3915720f8e90a4d01fd62e865aa5db751f06c3fb4bc87b3b91f0681cf0d49ba39287b08aeb1ba7bbfe78b86d1fe3d8554b3f4754e6113
+  data.tar.gz: 6700771e7de2ad8e0153e58efaa417fcbc73e5fd8f55beaa5af5314fc54d46425ea2d9ecacbed8a28a71f49931fa64f717f657b51da26e9203c2ed2b3f99fae9

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
+.ruby-gemset

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.0.0
+
+- Returns entire series by default
+- Added day_start option
+- Better interface
+
 # 1.0.5
 
 - Added global time_zone option

data/README.md

@@ -4,10 +4,8 @@ The simplest way to group by:
 
 - day
 - week
-- month
-- day of the week
 - hour of the day
-- and more (complete list at bottom)
+- and more (complete list below)
 
 :tada: Time zones supported!! **the best part**
 
@@ -21,7 +19,9 @@ Supports PostgreSQL and MySQL
 
 :cupid: Goes hand in hand with [Chartkick](http://ankane.github.io/chartkick/)
 
-## Usage
+## Get Started
+
+Group by day
 
 ```ruby
 User.group_by_day(:created_at).count
@@ -30,141 +30,76 @@ User.group_by_day(:created_at).count
 #   2013-04-17 00:00:00 UTC => 100,
 #   2013-04-18 00:00:00 UTC => 34
 # }
-
-Task.group_by_month(:updated_at).count
-# {
-#   2013-02-01 00:00:00 UTC => 84,
-#   2013-03-01 00:00:00 UTC => 23,
-#   2013-04-01 00:00:00 UTC => 44
-# }
-
-Goal.group_by_year(:accomplished_at).count
-# {
-#   2011-01-01 00:00:00 UTC => 7,
-#   2012-01-01 00:00:00 UTC => 11,
-#   2013-01-01 00:00:00 UTC => 3
-# }
 ```
 
-The default time zone is `Time.zone`.  Pass a time zone as the second argument.
+Results are returned in ascending order, so no need to sort.
 
-```ruby
-User.group_by_week(:created_at, "Pacific Time (US & Canada)").count
-# {
-#   2013-03-03 08:00:00 UTC => 80,
-#   2013-03-10 08:00:00 UTC => 70,
-#   2013-03-17 07:00:00 UTC => 54
-# }
+You can also group by:
 
-# equivalently
-time_zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
-User.group_by_week(:created_at, time_zone).count
-```
+- second
+- minute
+- hour
+- week
+- month
+- year
 
-**Note:** Weeks start on Sunday by default. For other days, use:
+and
 
-```ruby
-User.group_by_week(:created_at, :start => :mon) # first three letters of day
+- hour_of_day
+- day_of_week (Sunday = 0, Monday = 1, etc)
+
+### Time Zones
 
-# must be the last argument
-User.group_by_week(:created_at, time_zone, :start => :sat)
+The default time zone is `Time.zone`.  Change this with:
 
-# change globally
-Groupdate.week_start = :mon
+```ruby
+Groupdate.time_zone = "Pacific Time (US & Canada)"
 ```
 
-You can also group by the day of the week or hour of the day.
+or
 
 ```ruby
-# day of the week
-User.group_by_day_of_week(:created_at).count
+User.group_by_week(:created_at, time_zone: "Pacific Time (US & Canada)").count
 # {
-#   0 => 54, # Sunday
-#   1 => 2,  # Monday
-#   ...
-#   6 => 3   # Saturday
-# }
-
-# hour of the day
-User.group_by_hour_of_day(:created_at, "Pacific Time (US & Canada)").count
-# {
-#   0 => 34,
-#   1 => 61,
-#   ...
-#   23 => 12
+#   2013-03-03 08:00:00 UTC => 80,
+#   2013-03-10 08:00:00 UTC => 70,
+#   2013-03-17 07:00:00 UTC => 54
 # }
 ```
 
-You can order results with:
-
-```ruby
-User.group_by_day(:created_at).order("day asc").count
-
-User.group_by_week(:created_at).order("week desc").count
+Time zone objects also work.
 
-User.group_by_hour_of_day(:created_at).order("hour_of_day asc").count
-```
+### Week Start
 
-Use it with anywhere you can use `group`.
+Weeks start on Sunday by default. Change this with:
 
 ```ruby
-Task.completed.group_by_hour(:completed_at).average(:priority)
+Groupdate.week_start = :mon # first three letters of day
 ```
 
-Go nuts!
+or
 
 ```ruby
-Request.where(page: "/home").group_by_minute(:started_at).maximum(:request_time)
+User.group_by_week(:created_at, week_start: :mon).count
 ```
 
-### Show me the series :moneybag:
+### Day Start
 
-You have two users - one created on May 2 and one on May 5.
+You can change the hour days start with:
 
 ```ruby
-User.group_by_day(:created_at).count
-# {
-#   2013-05-02 00:00:00 UTC => 1,
-#   2013-05-05 00:00:00 UTC => 1
-# }
+Groupdate.day_start = 2 # 2 am - 2 am
 ```
 
-Awesome, but you want to see the first week of May.  Pass a range as the third argument.
+or
 
 ```ruby
-# pretend today is May 7
-time_range = 6.days.ago..Time.now
-
-User.group_by_day(:created_at, Time.zone, time_range).count
-# {
-#   2013-05-01 00:00:00 UTC => 0,
-#   2013-05-02 00:00:00 UTC => 1,
-#   2013-05-03 00:00:00 UTC => 0,
-#   2013-05-04 00:00:00 UTC => 0,
-#   2013-05-05 00:00:00 UTC => 1,
-#   2013-05-06 00:00:00 UTC => 0,
-#   2013-05-07 00:00:00 UTC => 0
-# }
-
-User.group_by_day_of_week(:created_at, Time.zone, time_range).count
-# {
-#   0 => 0,
-#   1 => 1,
-#   2 => 0,
-#   3 => 0,
-#   4 => 1,
-#   5 => 0,
-#   6 => 0
-# }
+User.group_by_day(:created_at, day_start: 2).count
 ```
 
-Results are returned in ascending order, so no need to sort.
-
-Also, this form of the method returns a Groupdate::Series instead of an ActiveRecord::Relation.  ActiveRecord::Relation method calls (like `where` and `joins`) should come before this.
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
 ```ruby
 gem 'groupdate'
@@ -190,60 +125,31 @@ gem "activerecord-jdbcpostgresql-adapter", :github => "jruby/activerecord-jdbc-a
 gem "activerecord-jdbcmysql-adapter", :github => "jruby/activerecord-jdbc-adapter"
 ```
 
-## Reference
-
-The default time zone is `Time.zone`.  To change this, use:
-
-```ruby
-Groupdate.time_zone = "Pacific Time (US & Canada)"
-```
-
-## Complete list
-
-group_by_?
-
-- second
-- minute
-- hour
-- day
-- week
-- month
-- year
-- hour_of_day
-- day_of_week
-
-## Note
+## Upgrading to 2.0
 
-activerecord <= 4.0.0.beta1 and the pg gem returns String objects instead of Time objects.
-[This is fixed on activerecord master](https://github.com/rails/rails/commit/2cc09441c2de57b024b11ba666ba1e72c2b20cfe)
+Groupdate 2.0 brings a number a great improvements.
 
-```ruby
-User.group_by_day(:created_at).count
+- the entire series is returned by default
+- the `day_start` option
+- an improved interface
 
-# mysql2
-# pg and activerecord master
-{2013-04-22 00:00:00 UTC => 1} # Time object
+However, there are a few things to be aware of when upgrading.
 
-# pg and activerecord <= 4.0.0.beta1
-{"2013-04-22 00:00:00+00" => 1} # String
-```
-
-Another data type inconsistency
+1. Groupdate methods must come after any `where`, `joins`, or `includes`.
 
-```ruby
-User.group_by_day_of_week(:created_at).count
+  Throws error
 
-# mysql2
-{0 => 1, 4 => 1} # Integer
+  ```ruby
+  User.group_by_day(:created_at).where(company_id: 1).count
+  ```
 
-# pg and activerecord <= 4.0.0.beta1
-{"0" => 1, "4" => 1} # String
+  :moneybag:
 
-# pg and activerecord master
-{0.0 => 1, 4.0 => 1} # Float
-```
+  ```ruby
+  User.where(company_id: 1).group_by_day(:created_at).count
+  ```
 
-These are *not* a result of groupdate (and unfortunately cannot be fixed by groupdate)
+2. `Time` keys are now returned for every database adapter. Some older adapters previously returned `String` keys.
 
 ## History
 

data/lib/groupdate.rb

@@ -23,7 +23,7 @@ module ActiveRecord
 end
 
 module Groupdate
-  mattr_accessor :week_start
-  mattr_accessor :time_zone
+  mattr_accessor :week_start, :day_start, :time_zone
   self.week_start = :sun
+  self.day_start = 0
 end

data/lib/groupdate/scopes.rb

@@ -11,7 +11,7 @@ module Groupdate
         args = args.dup
         options = args[-1].is_a?(Hash) ? args.pop : {}
         column = connection.quote_table_name(args[0])
-        time_zone = args[1] || Groupdate.time_zone || Time.zone || "Etc/UTC"
+        time_zone = args[1] || options[:time_zone] || Groupdate.time_zone || Time.zone || "Etc/UTC"
         if time_zone.is_a?(ActiveSupport::TimeZone) or time_zone = ActiveSupport::TimeZone[time_zone]
           time_zone = time_zone.tzinfo.name
         else
@@ -19,22 +19,25 @@ module Groupdate
         end
 
         # for week
-        week_start = [:mon, :tue, :wed, :thu, :fri, :sat, :sun].index((options[:start] || Groupdate.week_start).to_sym)
+        week_start = [:mon, :tue, :wed, :thu, :fri, :sat, :sun].index((options[:week_start] || options[:start] || Groupdate.week_start).to_sym)
         if field == "week" and !week_start
           raise "Unrecognized :start option"
         end
 
+        # for day
+        day_start = (options[:day_start] || Groupdate.day_start).to_i
+
         query =
           case connection.adapter_name
           when "MySQL", "Mysql2"
             case field
             when "day_of_week" # Sunday = 0, Monday = 1, etc
               # use CONCAT for consistent return type (String)
-              ["DAYOFWEEK(CONVERT_TZ(#{column}, '+00:00', ?)) - 1", time_zone]
+              ["DAYOFWEEK(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} HOUR), '+00:00', ?)) - 1", time_zone]
             when "hour_of_day"
-              ["EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?))", time_zone]
+              ["(EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?)) + 24 - #{day_start}) % 24", time_zone]
             when "week"
-              ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL ((#{7 - week_start} + WEEKDAY(CONVERT_TZ(#{column}, '+00:00', ?))) % 7) DAY), '+00:00', ?), '%Y-%m-%d 00:00:00'), ?, '+00:00')", time_zone, time_zone, time_zone]
+              ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL ((#{7 - week_start} + WEEKDAY(CONVERT_TZ(#{column}, '+00:00', ?) - INTERVAL #{day_start} HOUR)) % 7) DAY) - INTERVAL #{day_start} HOUR, '+00:00', ?), '%Y-%m-%d 00:00:00') + INTERVAL #{day_start} HOUR, ?, '+00:00')", time_zone, time_zone, time_zone]
             else
               format =
                 case field
@@ -50,28 +53,29 @@ module Groupdate
                   "%Y-%m-01 00:00:00"
                 else # year
                   "%Y-01-01 00:00:00"
-                end
+              end
 
-              ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(#{column}, '+00:00', ?), '#{format}'), ?, '+00:00')", time_zone, time_zone]
+              ["DATE_ADD(CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} HOUR), '+00:00', ?), '#{format}'), ?, '+00:00'), INTERVAL #{day_start} HOUR)", time_zone, time_zone]
             end
           when "PostgreSQL", "PostGIS"
             case field
             when "day_of_week"
-              ["EXTRACT(DOW from #{column}::timestamptz AT TIME ZONE ?)::integer", time_zone]
+              ["EXTRACT(DOW from (#{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} hour'))::integer", time_zone]
             when "hour_of_day"
-              ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ?)::integer", time_zone]
+              ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} hour')::integer", time_zone]
             when "week" # start on Sunday, not PostgreSQL default Monday
-              ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{week_start} day') AT TIME ZONE ?) + INTERVAL '#{week_start} day') AT TIME ZONE ?", time_zone, time_zone]
+              ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{week_start} day' - INTERVAL '#{day_start}' hour) AT TIME ZONE ?) + INTERVAL '#{week_start} day' + INTERVAL '#{day_start}' hour) AT TIME ZONE ?", time_zone, time_zone]
             else
-              ["DATE_TRUNC('#{field}', #{column}::timestamptz AT TIME ZONE ?) AT TIME ZONE ?", time_zone, time_zone]
+              ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{day_start} hour') AT TIME ZONE ?) + INTERVAL '#{day_start} hour') AT TIME ZONE ?", time_zone, time_zone]
             end
           else
             raise "Connection adapter not supported: #{connection.adapter_name}"
           end
 
         group = group(Groupdate::OrderHack.new(sanitize_sql_array(query), field, time_zone))
-        if args[2]
-          Series.new(group, field, column, time_zone, args[2], week_start)
+        range = args[2] || options[:range] || true
+        unless options[:series] == false
+          Series.new(group, field, column, time_zone, range, week_start, day_start)
         else
           group
         end

data/lib/groupdate/series.rb

@@ -1,7 +1,7 @@
 module Groupdate
   class Series
 
-    def initialize(relation, field, column, time_zone, time_range, week_start)
+    def initialize(relation, field, column, time_zone, time_range, week_start, day_start)
       if time_range.is_a?(Range)
         # doesn't matter whether we include the end of a ... range - it will be excluded later
         @relation = relation.where("#{column} >= ? AND #{column} <= ?", time_range.first, time_range.last)
@@ -12,6 +12,7 @@ module Groupdate
       @time_zone = time_zone
       @time_range = time_range
       @week_start = week_start
+      @day_start = day_start
     end
 
     def build_series(count)
@@ -43,37 +44,42 @@ module Groupdate
               sorted_keys.first..sorted_keys.last
             end
 
-          # determine start time
-          time = time_range.first.to_time.in_time_zone(@time_zone)
-          starts_at =
-            case @field
-            when "second"
-              time.change(:usec => 0)
-            when "minute"
-              time.change(:sec => 0)
-            when "hour"
-              time.change(:min => 0)
-            when "day"
-              time.beginning_of_day
-            when "week"
-              # same logic as MySQL group
-              weekday = (time.wday - 1) % 7
-              (time - ((7 - @week_start + weekday) % 7).days).midnight
-            when "month"
-              time.beginning_of_month
-            else # year
-              time.beginning_of_year
-            end
+          if time_range.first
+            # determine start time
+            time = time_range.first.to_time.in_time_zone(@time_zone) - @day_start.hours
+            starts_at =
+              case @field
+              when "second"
+                time.change(:usec => 0)
+              when "minute"
+                time.change(:sec => 0)
+              when "hour"
+                time.change(:min => 0)
+              when "day"
+                time.beginning_of_day
+              when "week"
+                # same logic as MySQL group
+                weekday = (time.wday - 1) % 7
+                (time - ((7 - @week_start + weekday) % 7).days).midnight
+              when "month"
+                time.beginning_of_month
+              else # year
+                time.beginning_of_year
+              end
 
-          series = [starts_at]
+            starts_at += @day_start.hours
+            series = [starts_at]
 
-          step = 1.send(@field)
+            step = 1.send(@field)
 
-          while time_range.cover?(series.last + step)
-            series << series.last + step
-          end
+            while time_range.cover?(series.last + step)
+              series << series.last + step
+            end
 
-          series.map{|s| s.to_time.utc }
+            series.map{|s| s.to_time.utc }
+          else
+            []
+          end
         end
 
       Hash[series.map do |k|
@@ -85,6 +91,8 @@ module Groupdate
       # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
       if ActiveRecord::Calculations.method_defined?(method)
         build_series(@relation.send(method, *args, &block))
+      elsif [:joins, :includes, :where].include?(method)
+        raise NoMethodError, "#{method} must come before the group_by_#{@field} method"
       else
         raise NoMethodError, "valid methods are: #{ActiveRecord::Calculations.instance_methods.join(", ")}"
       end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "1.0.5"
+  VERSION = "2.0.0"
 end

data/test/mysql_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "test_helper"
 
 class TestMysql < Minitest::Unit::TestCase
   include TestGroupdate

data/test/postgresql_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "test_helper"
 
 class TestPostgresql < Minitest::Unit::TestCase
   include TestGroupdate

data/test/test_helper.rb

@@ -84,6 +84,24 @@ module TestGroupdate
     assert_result_time :day, "2013-05-03 00:00:00 PDT", "2013-05-03 07:00:00", true
   end
 
+  # day hour starts at 2 am
+
+  def test_test_day_end_of_day_day_start_2am
+    assert_result_time :day, "2013-05-03 02:00:00 UTC", "2013-05-04 01:59:59", false, :day_start => 2
+  end
+
+  def test_test_day_start_of_day_day_start_2am
+    assert_result_time :day, "2013-05-03 02:00:00 UTC", "2013-05-03 02:00:00", false, :day_start => 2
+  end
+
+  def test_test_day_end_of_day_with_time_zone_day_start_2am
+    assert_result_time :day, "2013-05-03 02:00:00 PDT", "2013-05-04 07:59:59", true, :day_start => 2
+  end
+
+  def test_test_day_start_of_day_with_time_zone_day_start_2am
+    assert_result_time :day, "2013-05-03 02:00:00 PDT", "2013-05-03 09:00:00", true, :day_start => 2
+  end
+
   # week
 
   def test_week_end_of_week
@@ -105,37 +123,55 @@ module TestGroupdate
   # week starting on monday
 
   def test_week_end_of_week_mon
-    assert_result_time :week, "2013-03-18 00:00:00 UTC", "2013-03-24 23:59:59", false, :start => :mon
+    assert_result_time :week, "2013-03-18 00:00:00 UTC", "2013-03-24 23:59:59", false, week_start: :mon
   end
 
   def test_week_start_of_week_mon
-    assert_result_time :week, "2013-03-25 00:00:00 UTC", "2013-03-25 00:00:00", false, :start => :mon
+    assert_result_time :week, "2013-03-25 00:00:00 UTC", "2013-03-25 00:00:00", false, week_start: :mon
   end
 
   def test_week_end_of_week_with_time_zone_mon
-    assert_result_time :week, "2013-03-11 00:00:00 PDT", "2013-03-18 06:59:59", true, :start => :mon
+    assert_result_time :week, "2013-03-11 00:00:00 PDT", "2013-03-18 06:59:59", true, week_start: :mon
   end
 
   def test_week_start_of_week_with_time_zone_mon
-    assert_result_time :week, "2013-03-18 00:00:00 PDT", "2013-03-18 07:00:00", true, :start => :mon
+    assert_result_time :week, "2013-03-18 00:00:00 PDT", "2013-03-18 07:00:00", true, week_start: :mon
   end
 
   # week starting on saturday
 
   def test_week_end_of_week_sat
-    assert_result_time :week, "2013-03-16 00:00:00 UTC", "2013-03-22 23:59:59", false, :start => :sat
+    assert_result_time :week, "2013-03-16 00:00:00 UTC", "2013-03-22 23:59:59", false, week_start: :sat
   end
 
   def test_week_start_of_week_sat
-    assert_result_time :week, "2013-03-23 00:00:00 UTC", "2013-03-23 00:00:00", false, :start => :sat
+    assert_result_time :week, "2013-03-23 00:00:00 UTC", "2013-03-23 00:00:00", false, week_start: :sat
   end
 
   def test_week_end_of_week_with_time_zone_sat
-    assert_result_time :week, "2013-03-09 00:00:00 PST", "2013-03-16 06:59:59", true, :start => :sat
+    assert_result_time :week, "2013-03-09 00:00:00 PST", "2013-03-16 06:59:59", true, week_start: :sat
   end
 
   def test_week_start_of_week_with_time_zone_sat
-    assert_result_time :week, "2013-03-16 00:00:00 PDT", "2013-03-16 07:00:00", true, :start => :sat
+    assert_result_time :week, "2013-03-16 00:00:00 PDT", "2013-03-16 07:00:00", true, week_start: :sat
+  end
+
+  # week starting at 2am
+
+  def test_week_end_of_week_day_start_2am
+    assert_result_time :week, "2013-03-17 02:00:00 UTC", "2013-03-24 01:59:59", false, :day_start => 2
+  end
+
+  def test_week_start_of_week_day_start_2am
+    assert_result_time :week, "2013-03-17 02:00:00 UTC", "2013-03-17 02:00:00", false, :day_start => 2
+  end
+
+  def test_week_end_of_week_day_with_time_zone_start_2am
+    assert_result_time :week, "2013-03-17 02:00:00 PDT", "2013-03-24 08:59:59", true, :day_start => 2
+  end
+
+  def test_week_start_of_week_day_with_time_zone_start_2am
+    assert_result_time :week, "2013-03-17 02:00:00 PDT", "2013-03-17 09:00:00", true, :day_start => 2
   end
 
   # month
@@ -156,6 +192,24 @@ module TestGroupdate
     assert_result_time :month, "2013-06-01 00:00:00 PDT", "2013-06-01 07:00:00", true
   end
 
+  # month starts at 2am
+
+  def test_month_end_of_month_day_start_2am
+    assert_result_time :month, "2013-03-01 02:00:00 UTC", "2013-04-01 01:59:59", false, :day_start => 2
+  end
+
+  def test_month_start_of_month_day_start_2am
+    assert_result_time :month, "2013-03-01 02:00:00 UTC", "2013-03-01 02:00:00", false, :day_start => 2
+  end
+
+  def test_month_end_of_month_with_time_zone_day_start_2am
+    assert_result_time :month, "2013-03-01 02:00:00 PST", "2013-04-01 08:59:59", true, :day_start => 2
+  end
+
+  def test_month_start_of_month_with_time_zone_day_start_2am
+    assert_result_time :month, "2013-03-01 02:00:00 PST", "2013-03-01 10:00:00", true, :day_start => 2
+  end
+
   # year
 
   def test_year_end_of_year
@@ -174,6 +228,24 @@ module TestGroupdate
     assert_result_time :year, "2014-01-01 00:00:00 PST", "2014-01-01 08:00:00", true
   end
 
+  # year starts at 2am
+
+  def test_year_end_of_year_day_start_2am
+    assert_result_time :year, "2013-01-01 02:00:00 UTC", "2014-01-01 01:59:59", false, :day_start => 2
+  end
+
+  def test_year_start_of_year_day_start_2am
+    assert_result_time :year, "2013-01-01 02:00:00 UTC", "2013-01-01 02:00:00", false, :day_start => 2
+  end
+
+  def test_year_end_of_year_with_time_zone_day_start_2am
+    assert_result_time :year, "2013-01-01 02:00:00 PST", "2014-01-01 09:59:59", true, :day_start => 2
+  end
+
+  def test_year_start_of_year_with_time_zone_day_start_2am
+    assert_result_time :year, "2013-01-01 02:00:00 PST", "2013-01-01 10:00:00", true, :day_start => 2
+  end
+
   # hour of day
 
   def test_hour_of_day_end_of_hour
@@ -192,6 +264,24 @@ module TestGroupdate
     assert_result :hour_of_day, 1, "2013-01-01 09:00:00", true
   end
 
+  # hour of day starts at 2am
+
+  def test_hour_of_day_end_of_day_day_start_2am
+    assert_result :hour_of_day, 23, "2013-01-01 01:59:59", false, :day_start => 2
+  end
+
+  def test_hour_of_day_start_of_day_day_start_2am
+    assert_result :hour_of_day, 0, "2013-01-01 02:00:00", false, :day_start => 2
+  end
+
+  def test_hour_of_day_end_of_day_with_time_zone_day_start_2am
+    assert_result :hour_of_day, 23, "2013-01-01 09:59:59", true, :day_start => 2
+  end
+
+  def test_hour_of_day_start_of_day_with_time_zone_day_start_2am
+    assert_result :hour_of_day, 0, "2013-01-01 10:00:00", true, :day_start => 2
+  end
+
   # day of week
 
   def test_day_of_week_end_of_day
@@ -210,6 +300,24 @@ module TestGroupdate
     assert_result :day_of_week, 3, "2013-01-02 08:00:00", true
   end
 
+  # day of week starts at 2am
+
+  def test_day_of_week_end_of_day_day_start_2am
+    assert_result :day_of_week, 3, "2013-01-03 01:59:59", false, :day_start => 2
+  end
+
+  def test_day_of_week_start_of_day_day_start_2am
+    assert_result :day_of_week, 3, "2013-01-02 02:00:00", false, :day_start => 2
+  end
+
+  def test_day_of_week_end_of_day_with_time_zone_day_start_2am
+    assert_result :day_of_week, 3, "2013-01-03 09:59:59", true, :day_start => 2
+  end
+
+  def test_day_of_week_start_of_day_with_time_zone_day_start_2am
+    assert_result :day_of_week, 3, "2013-01-02 10:00:00", true, :day_start => 2
+  end
+
   # zeros
 
   def test_zeros_second
@@ -241,19 +349,19 @@ module TestGroupdate
   end
 
   def test_zeros_week_mon
-    assert_zeros :week, "2013-05-01 20:00:00 UTC", ["2013-04-22 00:00:00 UTC", "2013-04-29 00:00:00 UTC", "2013-05-06 00:00:00 UTC"], "2013-04-27 23:59:59 UTC", "2013-05-11 23:59:59 UTC", false, :start => :mon
+    assert_zeros :week, "2013-05-01 20:00:00 UTC", ["2013-04-22 00:00:00 UTC", "2013-04-29 00:00:00 UTC", "2013-05-06 00:00:00 UTC"], "2013-04-27 23:59:59 UTC", "2013-05-11 23:59:59 UTC", false, week_start: :mon
   end
 
   def test_zeros_week_time_zone_mon
-    assert_zeros :week, "2013-05-01 20:00:00 PDT", ["2013-04-22 00:00:00 PDT", "2013-04-29 00:00:00 PDT", "2013-05-06 00:00:00 PDT"], "2013-04-27 23:59:59 PDT", "2013-05-11 23:59:59 PDT", true, :start => :mon
+    assert_zeros :week, "2013-05-01 20:00:00 PDT", ["2013-04-22 00:00:00 PDT", "2013-04-29 00:00:00 PDT", "2013-05-06 00:00:00 PDT"], "2013-04-27 23:59:59 PDT", "2013-05-11 23:59:59 PDT", true, week_start: :mon
   end
 
   def test_zeros_week_sat
-    assert_zeros :week, "2013-05-01 20:00:00 UTC", ["2013-04-20 00:00:00 UTC", "2013-04-27 00:00:00 UTC", "2013-05-04 00:00:00 UTC"], "2013-04-26 23:59:59 UTC", "2013-05-10 23:59:59 UTC", false, :start => :sat
+    assert_zeros :week, "2013-05-01 20:00:00 UTC", ["2013-04-20 00:00:00 UTC", "2013-04-27 00:00:00 UTC", "2013-05-04 00:00:00 UTC"], "2013-04-26 23:59:59 UTC", "2013-05-10 23:59:59 UTC", false, week_start: :sat
   end
 
   def test_zeros_week_time_zone_sat
-    assert_zeros :week, "2013-05-01 20:00:00 PDT", ["2013-04-20 00:00:00 PDT", "2013-04-27 00:00:00 PDT", "2013-05-04 00:00:00 PDT"], "2013-04-26 23:59:59 PDT", "2013-05-10 23:59:59 PDT", true, :start => :sat
+    assert_zeros :week, "2013-05-01 20:00:00 PDT", ["2013-04-20 00:00:00 PDT", "2013-04-27 00:00:00 PDT", "2013-05-04 00:00:00 PDT"], "2013-04-26 23:59:59 PDT", "2013-05-10 23:59:59 PDT", true, week_start: :sat
   end
 
   def test_zeros_month
@@ -278,7 +386,7 @@ module TestGroupdate
     7.times do |n|
       expected[n] = n == 3 ? 1 : 0
     end
-    assert_equal expected, User.group_by_day_of_week(:created_at, Time.zone, true).count(:created_at)
+    assert_equal expected, User.group_by_day_of_week(:created_at, range: true).count(:created_at)
   end
 
   def test_zeros_hour_of_day
@@ -287,7 +395,7 @@ module TestGroupdate
     24.times do |n|
       expected[n] = n == 20 ? 1 : 0
     end
-    assert_equal expected, User.group_by_hour_of_day(:created_at, Time.zone, true).count(:created_at)
+    assert_equal expected, User.group_by_hour_of_day(:created_at, range: true).count(:created_at)
   end
 
   def test_zeros_excludes_end
@@ -295,7 +403,7 @@ module TestGroupdate
     expected = {
       Time.parse("2013-05-01 00:00:00 UTC") => 0
     }
-    assert_equal expected, User.group_by_day(:created_at, Time.zone, Time.parse("2013-05-01 00:00:00 UTC")...Time.parse("2013-05-02 00:00:00 UTC")).count
+    assert_equal expected, User.group_by_day(:created_at, range: Time.parse("2013-05-01 00:00:00 UTC")...Time.parse("2013-05-02 00:00:00 UTC")).count
   end
 
   def test_zeros_previous_scope
@@ -303,7 +411,7 @@ module TestGroupdate
     expected = {
       Time.parse("2013-05-01 00:00:00 UTC") => 0
     }
-    assert_equal expected, User.where("id = 0").group_by_day(:created_at, Time.zone, Time.parse("2013-05-01 00:00:00 UTC")..Time.parse("2013-05-01 23:59:59 UTC")).count
+    assert_equal expected, User.where("id = 0").group_by_day(:created_at, range: Time.parse("2013-05-01 00:00:00 UTC")..Time.parse("2013-05-01 23:59:59 UTC")).count
   end
 
   def test_zeros_datetime
@@ -311,13 +419,13 @@ module TestGroupdate
     expected = {
       Time.parse("2013-05-01 00:00:00 UTC") => 1
     }
-    assert_equal expected, User.group_by_day(:created_at, Time.zone, DateTime.parse("2013-05-01 00:00:00 UTC")..DateTime.parse("2013-05-01 00:00:00 UTC")).count
+    assert_equal expected, User.group_by_day(:created_at, range: DateTime.parse("2013-05-01 00:00:00 UTC")..DateTime.parse("2013-05-01 00:00:00 UTC")).count
   end
 
   def test_zeros_null_value
     user = User.create!(name: "Andrew")
     user.update_column :created_at, nil
-    assert_equal 0, User.group_by_hour_of_day(:created_at, Time.zone, true).count[0]
+    assert_equal 0, User.group_by_hour_of_day(:created_at, range: true).count[0]
   end
 
   def test_zeroes_range_true
@@ -328,7 +436,7 @@ module TestGroupdate
       Time.parse("2013-05-02 00:00:00 UTC") => 0,
       Time.parse("2013-05-03 00:00:00 UTC") => 1
     }
-    assert_equal expected, User.group_by_day(:created_at, Time.zone, true).count
+    assert_equal expected, User.group_by_day(:created_at, range: true).count
   end
 
   # week_start
@@ -340,21 +448,21 @@ module TestGroupdate
 
   def test_week_start_and_start_option
     Groupdate.week_start = :mon
-    assert_result_time :week, "2013-03-16 00:00:00 UTC", "2013-03-22 23:59:59", false, :start => :sat
+    assert_result_time :week, "2013-03-16 00:00:00 UTC", "2013-03-22 23:59:59", false, week_start: :sat
   end
 
   # misc
 
   def test_order_day
-    assert_empty User.group_by_day(:created_at).order("day desc").limit(20).count
+    assert_empty User.group_by_day(:created_at, series: false).order("day desc").limit(20).count
   end
 
   def test_order_week
-    assert_empty User.group_by_week(:created_at).order("week asc").count
+    assert_empty User.group_by_week(:created_at, series: false).order("week asc").count
   end
 
   def test_order_hour_of_day
-    assert_empty User.group_by_hour_of_day(:created_at).order("hour_of_day desc").count
+    assert_empty User.group_by_hour_of_day(:created_at, series: false).order("hour_of_day desc").count
   end
 
   def test_table_name
@@ -375,8 +483,8 @@ module TestGroupdate
   def assert_result(method, expected, time_str, time_zone = false, options = {})
     create_user time_str
     expected = expected.is_a?(Time) ? time_key(expected) : number_key(expected)
-    assert_equal ordered_hash({expected => 1}), User.send(:"group_by_#{method}", :created_at, time_zone ? "Pacific Time (US & Canada)" : nil, options).order(method.to_s).count
-    assert_equal 1, User.send(:"group_by_#{method}", :created_at, time_zone ? "Pacific Time (US & Canada)" : nil, true, options).count[expected]
+    assert_equal ordered_hash({expected => 1}), User.send(:"group_by_#{method}", :created_at, options.merge(series: false, time_zone: time_zone ? "Pacific Time (US & Canada)" : nil)).order(method.to_s).count
+    assert_equal 1, User.send(:"group_by_#{method}", :created_at, options.merge(time_zone: time_zone ? "Pacific Time (US & Canada)" : nil)).count[expected]
   end
 
   def assert_zeros(method, created_at, keys, range_start, range_end, time_zone = nil, options = {})
@@ -385,7 +493,7 @@ module TestGroupdate
     keys.each_with_index do |key, i|
       expected[Time.parse(key)] = i == 1 ? 1 : 0
     end
-    assert_equal expected, User.send(:"group_by_#{method}", :created_at, time_zone ? "Pacific Time (US & Canada)" : nil, Time.parse(range_start)..Time.parse(range_end), options).count
+    assert_equal expected, User.send(:"group_by_#{method}", :created_at, options.merge(time_zone: time_zone ? "Pacific Time (US & Canada)" : nil, range: Time.parse(range_start)..Time.parse(range_end))).count
   end
 
   def ordered_hash(hash)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Kane