groupdate 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61482d521349112fbb247de01da256b7d2559574
-  data.tar.gz: ef39227bacbce05f6d382f4e7e70c8f3a69eea3d
+  metadata.gz: daf83ef79d462a5e64a5718a32473030971ac38c
+  data.tar.gz: f7223697deffaeca83fff949081837397da1aaea
 SHA512:
-  metadata.gz: 4b054169e094d93790241c3757e3f6171058e2379655394c8060db79417fb6bcafa39f7612f4462fc3ea2d6befd11dcfa700a1bde9073ab37037d2714db1ca8d
-  data.tar.gz: 478d53080c29fd79b2965c7804a76a16451f239151bb839aa26040d874d05f1c0bf83ba730b3f23ba670c6d8ffb35028e69d9f147328c735efca669422ead0f9
+  metadata.gz: 20e08fd6c4737c5624fbee1bb3651af4b50b30d863ce50d3a3ef6e574bfdc8b3b072149cff799bd62eb7d6a38a4d474b376f0f9caaff5e35fb226abcd0f72b4b
+  data.tar.gz: 7ef016743a24bab4dcc51b69f4a48cdd7670eb86165f4158f0dd3c3f56c8c720e92bbcfce1952cfbb0b72add483ec4492f973953c8acd5942a178808e05cc23a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.3.0
+
+- Raise error when ActiveRecord::Base.default_timezone is not `:utc`
+- Added `day_of_month`
+- Added `month_of_year`
+- Do not quote column name
+
 ## 2.2.1
 
 - Fixed ActiveRecord 3 associations

data/README.md

@@ -13,7 +13,7 @@ The simplest way to group by:
 
 Works with Rails 3.1+
 
-Supports PostgreSQL and MySQL, plus Arrays and Hashes
+Supports PostgreSQL and MySQL, plus arrays and hashes
 
 [![Build Status](https://travis-ci.org/ankane/groupdate.png)](https://travis-ci.org/ankane/groupdate)
 
@@ -47,6 +47,8 @@ and
 
 - hour_of_day
 - day_of_week (Sunday = 0, Monday = 1, etc)
+- day_of_month [master]
+- month_of_year [master]
 
 Use it anywhere you can use `group`.
 
@@ -171,6 +173,8 @@ gem 'groupdate'
 mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
 ```
 
+or copy and paste [these statements](https://gist.githubusercontent.com/ankane/1d6b0022173186accbf0/raw/time_zone_support.sql) into a SQL console.
+
 #### For JRuby
 
 Use the master version of your JDBC adapter.  You will get incorrect results for versions before [this commit](https://github.com/jruby/activerecord-jdbc-adapter/commit/c1cdb7cec8d3f06fc54995e8d872d830bd0a4d91).

data/lib/groupdate/magic.rb

@@ -20,7 +20,10 @@ module Groupdate
     end
 
     def relation(column, relation)
-      column = relation.connection.quote_table_name(column)
+      if relation.default_timezone == :local
+        raise "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
+      end
+
       time_zone = self.time_zone.tzinfo.name
 
       adapter_name = relation.connection.adapter_name
@@ -33,6 +36,10 @@ module Groupdate
             ["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', ?)) + 24 - #{day_start}) % 24", time_zone]
+          when :day_of_month
+            ["DAYOFMONTH(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} HOUR), '+00:00', ?))", time_zone]
+          when :month_of_year
+            ["MONTH(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} HOUR), '+00:00', ?))", time_zone]
           when :week
             ["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
@@ -57,9 +64,13 @@ module Groupdate
         when "PostgreSQL", "PostGIS"
           case field
           when :day_of_week
-            ["EXTRACT(DOW from (#{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} hour'))::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 ? - INTERVAL '#{day_start} hour')::integer", time_zone]
+          when :day_of_month
+            ["EXTRACT(DAY from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} hour')::integer", time_zone]
+          when :month_of_year
+            ["EXTRACT(MONTH 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' - INTERVAL '#{day_start}' hour) AT TIME ZONE ?) + INTERVAL '#{week_start} day' + INTERVAL '#{day_start}' hour) AT TIME ZONE ?", time_zone, time_zone]
           else
@@ -105,7 +116,7 @@ module Groupdate
 
       cast_method =
         case field
-        when :day_of_week, :hour_of_day
+        when :day_of_week, :hour_of_day, :day_of_month, :month_of_year
           lambda{|k| k.to_i }
         else
           utc = ActiveSupport::TimeZone["UTC"]
@@ -162,6 +173,10 @@ module Groupdate
           0..6
         when :hour_of_day
           0..23
+        when :day_of_month
+          1..31
+        when :month_of_year
+          1..12
         else
           time_range = self.time_range
           time_range =
@@ -218,6 +233,10 @@ module Groupdate
                 key = sunday + key.hours + day_start.hours
               when :day_of_week
                 key = sunday + key.days
+              when :day_of_month
+                key = Date.new(2014, 1, key).to_time
+              when :month_of_year
+                key = Date.new(2014, key, 1).to_time
               end
               key.strftime(options[:format].to_s)
             end
@@ -256,6 +275,10 @@ module Groupdate
           time.hour
         when :day_of_week
           (7 - week_start + ((time.wday - 1) % 7) % 7)
+        when :day_of_month
+          time.day
+        when :month_of_year
+          time.month
         else
           raise "Invalid field"
         end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 end

data/lib/groupdate.rb

@@ -4,7 +4,7 @@ require "groupdate/version"
 require "groupdate/magic"
 
 module Groupdate
-  FIELDS = [:second, :minute, :hour, :day, :week, :month, :year, :day_of_week, :hour_of_day]
+  FIELDS = [:second, :minute, :hour, :day, :week, :month, :year, :day_of_week, :hour_of_day, :day_of_month, :month_of_year]
   METHODS = FIELDS.map{|v| :"group_by_#{v}" }
 
   mattr_accessor :week_start, :day_start, :time_zone

data/test/test_helper.rb

@@ -328,6 +328,82 @@ module TestGroupdate
     assert_result :day_of_week, 3, "2013-01-02 10:00:00", true, :day_start => 2
   end
 
+  # day of month
+
+  def test_day_of_month_end_of_day
+    assert_result :day_of_month, 31, "2013-01-31 23:59:59"
+  end
+
+  def test_day_of_month_end_of_day_feb_leap_year
+    assert_result :day_of_month, 29, "2012-02-29 23:59:59"
+  end
+
+  def test_day_of_month_start_of_day
+    assert_result :day_of_month, 3, "2013-01-03 00:00:00"
+  end
+
+  def test_day_of_month_end_of_day_with_time_zone
+    assert_result :day_of_month, 31, "2013-02-01 07:59:59", true
+  end
+
+  def test_day_of_month_start_of_day_with_time_zone
+    assert_result :day_of_month, 1, "2013-01-01 08:00:00", true
+  end
+
+  # day of month starts at 2am
+
+  def test_day_of_month_end_of_day_day_start_2am
+    assert_result :day_of_month, 31, "2013-01-01 01:59:59", false, :day_start => 2
+  end
+
+  def test_day_of_month_start_of_day_day_start_2am
+    assert_result :day_of_month, 1, "2013-01-01 02:00:00", false, :day_start => 2
+  end
+
+  def test_day_of_month_end_of_day_with_time_zone_day_start_2am
+    assert_result :day_of_month, 31, "2013-01-01 09:59:59", true, :day_start => 2
+  end
+
+  def test_day_of_month_start_of_day_with_time_zone_day_start_2am
+    assert_result :day_of_month, 1, "2013-01-01 10:00:00", true, :day_start => 2
+  end
+
+  # month of year
+
+  def test_month_of_year_end_of_month
+    assert_result :month_of_year, 1, "2013-01-31 23:59:59"
+  end
+
+  def test_month_of_year_start_of_month
+    assert_result :month_of_year, 1, "2013-01-01 00:00:00"
+  end
+
+  def test_month_of_year_end_of_month_with_time_zone
+    assert_result :month_of_year, 1, "2013-02-01 07:59:59", true
+  end
+
+  def test_month_of_year_start_of_month_with_time_zone
+    assert_result :month_of_year, 1, "2013-01-01 08:00:00", true
+  end
+
+  # month of year starts at 2am
+
+  def test_month_of_year_end_of_month_day_start_2am
+    assert_result :month_of_year, 12, "2013-01-01 01:59:59", false, :day_start => 2
+  end
+
+  def test_month_of_year_start_of_month_day_start_2am
+    assert_result :month_of_year, 1, "2013-01-01 02:00:00", false, :day_start => 2
+  end
+
+  def test_month_of_year_end_of_month_with_time_zone_day_start_2am
+    assert_result :month_of_year, 12, "2013-01-01 09:59:59", true, :day_start => 2
+  end
+
+  def test_month_of_year_start_of_month_with_time_zone_day_start_2am
+    assert_result :month_of_year, 1, "2013-01-01 10:00:00", true, :day_start => 2
+  end
+
   # zeros
 
   def test_zeros_second
@@ -408,6 +484,24 @@ module TestGroupdate
     assert_equal expected, call_method(:hour_of_day, :created_at, {})
   end
 
+  def test_zeros_day_of_month
+    create_user "1978-12-18 00:00:00 UTC"
+    expected = {}
+    (1..31).each do |n|
+      expected[n] = n == 18 ? 1 : 0
+    end
+    assert_equal expected, call_method(:day_of_month, :created_at, {})
+  end
+
+  def test_zeros_month_of_year
+    create_user "2013-05-01 00:00:00 UTC"
+    expected = {}
+    (1..12).each do |n|
+      expected[n] = n == 5 ? 1 : 0
+    end
+    assert_equal expected, call_method(:month_of_year, :created_at, {})
+  end
+
   def test_zeros_excludes_end
     create_user "2013-05-02 00:00:00 UTC"
     expected = {
@@ -609,6 +703,16 @@ module TestGroupdate
     assert_format :day_of_week, "Sun", "%a", week_start: :sat
   end
 
+  def test_format_day_of_month
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :day_of_month, " 1", "%e"
+  end
+
+  def test_format_month_of_year
+    create_user "2014-01-01 00:00:00 UTC"
+    assert_format :month_of_year, "Jan", "%b"
+  end
+
   def test_format_multiple_groups
     create_user "2014-03-01 00:00:00 UTC"
     assert_equal ({["Sun", 1] => 1}), User.group_by_week(:created_at, format: "%a").group(:score).count
@@ -622,6 +726,17 @@ module TestGroupdate
     assert_empty user.posts.group_by_day(:created_at).count
   end
 
+  # activerecord default_timezone option
+
+  def test_default_timezone_local
+    begin
+      User.default_timezone = :local
+      assert_raises(RuntimeError){ User.group_by_day(:created_at).count }
+    ensure
+      User.default_timezone = :utc
+    end
+  end
+
   # 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: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -167,3 +167,4 @@ test_files:
 - test/mysql_test.rb
 - test/postgresql_test.rb
 - test/test_helper.rb
+has_rdoc: