groupdate 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f1468425ce9451398c5c487174224dc971a30d2
-  data.tar.gz: 5fff75e9b44d6651ca75d634f3bff1ceb68901de
+  metadata.gz: 8e473d607f5f1bf038d605fb7bb99c07876d4e20
+  data.tar.gz: 33f2c1067c4ac21b2dcb4e9c07402426e7d0abc7
 SHA512:
-  metadata.gz: c14ee2daf271500e82db8e221fb8e1dcee97694355e244664c575b9e035c03fd62ba5e4a09189b4555b76f4b685ea9261e58a7101d707b892e2e8e52a051abb1
-  data.tar.gz: 33c9afbdc4ec5bf3e99329c99c6b41702507762f122acbae0addbac7faeda9c6e87aa147b4f3c53cefceb9b58bb7643d21674958815cdb3974dfaa4df920c36b
+  metadata.gz: 957ef7d7bb9ef5ef0857094c9330e5b294a7d4b001a2d83e04e536d0c6cc119fbab6f2c913b005029baba8f117444c181449e464a64258142d85c48734e03cf9
+  data.tar.gz: d8e4ac13ab0194543382942698373577fd40b8299f4b81acd220636d0bd505ba3ac92abe0581e28fb9b9a991235f3da7a1b542adb5fa86159717bdaf6ca14093

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 1.0.2
+
+- Added :start option for custom week start for group_by_week
+
 ## 1.0.1
 
-- Fixed series for Rails < 3.2 and MySQL 2
+- Fixed series for Rails < 3.2 and MySQL
 
 ## 1.0.0
 

data/README.md

@@ -61,7 +61,14 @@ time_zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
 User.group_by_week(:created_at, time_zone).count
 ```
 
-**Note:** Weeks start on Sunday.
+**Note:** Weeks start on Sunday by default. For other days, use:
+
+```ruby
+User.group_by_week(:created_at, :start => :mon) # first three letters of day
+
+# must be the last argument
+User.group_by_week(:created_at, time_zone, :start => :sat)
+```
 
 You can also group by the day of the week or hour of the day.
 

data/lib/groupdate/scopes.rb

@@ -35,6 +35,8 @@ module Groupdate
         (time_fields + number_fields).each do |field|
           # no define_singleton_method in ruby 1.8
           (class << self; self end).send :define_method, :"group_by_#{field}" do |*args|
+            args = args.dup
+            options = args[-1].is_a?(Hash) ? args.pop : {}
             column = connection.quote_table_name(args[0])
             time_zone = args[1] || Time.zone || "Etc/UTC"
             if time_zone.is_a?(ActiveSupport::TimeZone) or time_zone = ActiveSupport::TimeZone[time_zone]
@@ -42,6 +44,13 @@ module Groupdate
             else
               raise "Unrecognized time zone"
             end
+
+            # for week
+            week_start = [:mon, :tue, :wed, :thu, :fri, :sat, :sun].index((options[:start] || :sun).to_sym)
+            if field == "week" and !week_start
+              raise "Unrecognized :start option"
+            end
+
             query =
               case connection.adapter_name
               when "MySQL", "Mysql2"
@@ -52,7 +61,7 @@ module Groupdate
                 when "hour_of_day"
                   ["EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?))", time_zone]
                 when "week"
-                  ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL (DAYOFWEEK(CONVERT_TZ(#{column}, '+00:00', ?)) - 1) 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', ?))) % 7) DAY), '+00:00', ?), '%Y-%m-%d 00:00:00'), ?, '+00:00')", time_zone, time_zone, time_zone]
                 else
                   format =
                     case field
@@ -79,7 +88,7 @@ module Groupdate
                 when "hour_of_day"
                   ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ?)::integer", time_zone]
                 when "week" # start on Sunday, not PostgreSQL default Monday
-                  ["(DATE_TRUNC('#{field}', (#{column}::timestamptz + INTERVAL '1 day') AT TIME ZONE ?) - INTERVAL '1 day') AT TIME ZONE ?", time_zone, time_zone]
+                  ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{week_start} day') AT TIME ZONE ?) + INTERVAL '#{week_start} day') AT TIME ZONE ?", time_zone, time_zone]
                 else
                   ["DATE_TRUNC('#{field}', #{column}::timestamptz AT TIME ZONE ?) AT TIME ZONE ?", time_zone, time_zone]
                 end
@@ -89,7 +98,7 @@ module Groupdate
 
             group = group(Groupdate::OrderHack.new(sanitize_sql_array(query), field, time_zone))
             if args[2]
-              Series.new(group, field, column, time_zone, args[2])
+              Series.new(group, field, column, time_zone, args[2], week_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)
+    def initialize(relation, field, column, time_zone, time_range, week_start)
       @relation = relation
       if time_range.is_a?(Range)
         @relation = relation.where("#{column} BETWEEN ? AND ?", time_range.first, time_range.last)
@@ -9,6 +9,7 @@ module Groupdate
       @field = field
       @time_zone = time_zone
       @time_range = time_range
+      @week_start = week_start
     end
 
     def build_series(count)
@@ -19,7 +20,7 @@ module Groupdate
         when "day_of_week", "hour_of_day"
           lambda{|k| k.to_i }
         else
-          lambda{|k| (k.is_a?(Time) ? k : utc.parse(k)).utc }
+          lambda{|k| (k.is_a?(String) ? utc.parse(k) : k.to_time).utc }
         end
 
       count = Hash[count.map do |k, v|
@@ -55,8 +56,9 @@ module Groupdate
             when "day"
               time.beginning_of_day
             when "week"
-              # beginning_of_week does not support :sunday argument in activesupport < 3.2
-              (time - time.wday.days).midnight
+              # 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

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/test/test_helper.rb

@@ -95,6 +95,42 @@ module TestGroupdate
     assert_result_time :week, "2013-03-17 00:00:00 PDT", "2013-03-17 07:00:00", true
   end
 
+  # 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
+  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
+  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
+  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
+  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
+  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
+  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
+  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
+  end
+
   # month
 
   def test_month_end_of_month
@@ -197,6 +233,22 @@ module TestGroupdate
     assert_zeros :week, "2013-05-01 20:00:00 PDT", ["2013-04-21 00:00:00 PDT", "2013-04-28 00:00:00 PDT", "2013-05-05 00:00:00 PDT"], "2013-04-27 23:59:59 PDT", "2013-05-11 23:59:59 PDT", true
   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
+  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
+  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
+  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
+  end
+
   def test_zeros_month
     assert_zeros :month, "2013-04-16 20:00:00 UTC", ["2013-03-01 00:00:00 UTC", "2013-04-01 00:00:00 UTC", "2013-05-01 00:00:00 UTC"], "2013-03-01 00:00:00 UTC", "2013-05-31 23:59:59 UTC"
   end
@@ -272,23 +324,23 @@ module TestGroupdate
 
   # helpers
 
-  def assert_result_time(method, expected, time_str, time_zone = false)
-    assert_result method, Time.parse(expected), time_str, time_zone
+  def assert_result_time(method, expected, time_str, time_zone = false, options = {})
+    assert_result method, Time.parse(expected), time_str, time_zone, options
   end
 
-  def assert_result(method, expected, time_str, time_zone = false)
+  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).order(method.to_s).count)
+    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)
   end
 
-  def assert_zeros(method, created_at, keys, range_start, range_end, time_zone = nil)
+  def assert_zeros(method, created_at, keys, range_start, range_end, time_zone = nil, options = {})
     create_user created_at
     expected = {}
     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)).count)
+    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)
   end
 
   def ordered_hash(hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord