groupdate 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 389dc65b32212f41266af6d39d4f422c5ed00143
-  data.tar.gz: b0345ab008fc00b1ae2ac0dffecb1b6677e29daf
+  metadata.gz: 51407cdc14a5d08e4a7f50111c5d5bd91f7d2a8a
+  data.tar.gz: 00650eedbd754abced4b15701c631eee2baa9e61
 SHA512:
-  metadata.gz: fe786c3908de9a1288f147b4bddac9f62d4e7f67c33734da2b94a98d1b2601ae8c35731a7cacdc0d439ba4a68d0a00dffe9554cee67ed95c907e111c44262e41
-  data.tar.gz: 6534a271d8e8a7730b58cdd0aa73f818a92194b3ee58d2259097634544b2667ef10be5ac75cd5368841e65e7601597f44227bbec4f9414c0e1264a70c1218c0a
+  metadata.gz: 9528a76cc3e2a523216c18b0692c5edb4b6739c34e720e2ae35797305266125bc059b60dbe5cca9ea36e981a85b538600f9aa1ebb8613c87538066453b0c0175
+  data.tar.gz: 2be5da38025c0865eaaf8e8086dd146378172187972ec80efa72171331134088388d96dd2296b1567e10ab0f2ff74bd2e3b63168129abf2ddf552986d4910e3b

data/README.md

@@ -5,12 +5,13 @@ The simplest way to group by:
 - day
 - week
 - month
-- hour
+- day of the week
+- hour of the day
 - *and more* (complete list at bottom)
 
 :tada: Time zones supported!!
 
-PostgreSQL only at the moment - support for other datastores coming soon
+PostgreSQL and MySQL only at the moment - support for other datastores coming soon
 
 ## Usage
 
@@ -42,9 +43,9 @@ The default time zone is `Time.zone`.  Pass a time zone as the second argument.
 ```ruby
 User.group_by_week(:created_at, "Pacific Time (US & Canada)").count
 # {
-#   "2013-02-25 08:00:00+00" => 80,
-#   "2013-03-04 08:00:00+00" => 70,
-#   "2013-03-11 07:00:00+00" => 54
+#   "2013-03-03 08:00:00+00" => 80,
+#   "2013-03-10 08:00:00+00" => 70,
+#   "2013-03-17 07:00:00+00" => 54
 # }
 
 # equivalently
@@ -52,6 +53,30 @@ time_zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
 User.group_by_week(:created_at, time_zone).count
 ```
 
+**Note:** Weeks start on Sunday.
+
+You can also group by the day of the week or hour of the day.
+
+```ruby
+# day of the week
+User.group_by_day_of_week(:created_at).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
+# }
+```
+
 Use it with anything you can use `group` with:
 
 ```ruby
@@ -76,19 +101,17 @@ gem 'groupdate'
 
 ## Complete list
 
-- microseconds
-- milliseconds
+group_by_?
+
 - second
 - minute
 - hour
 - day
 - week
 - month
-- quarter
 - year
-- decade
-- century
-- millennium
+- hour_of_day
+- day_of_week
 
 ## Contributing
 

data/groupdate.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql"
+  spec.add_development_dependency "mysql2"
 end

data/lib/groupdate.rb

@@ -27,16 +27,61 @@ module Groupdate
     included do
       # Field list from
       # http://www.postgresql.org/docs/9.1/static/functions-datetime.html
-      %w(microseconds milliseconds second minute hour day week month quarter year decade century millennium).each do |field|
-        self.scope :"group_by_#{field}", lambda {|column, time_zone = Time.zone|
+      fields = %w(second minute hour day week month year day_of_week hour_of_day)
+      fields.each do |field|
+        self.scope :"group_by_#{field}", lambda {|unsafe_column, time_zone = Time.zone|
+          column = connection.quote_column_name(unsafe_column)
           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
             raise "Unrecognized time zone"
           end
-          sql = "DATE_TRUNC('#{field}', #{column}::timestamptz AT TIME ZONE ?) AT TIME ZONE ?"
-          group(sanitize_sql_array([sql, time_zone, time_zone]))
+          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)
+                ["CONCAT('', DAYOFWEEK(CONVERT_TZ(#{column}, '+00:00', ?)) - 1)", time_zone]
+              when "hour_of_day"
+                ["CONCAT('', EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?)))", time_zone]
+              when "week"
+                ["CONCAT(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'), '+00')", time_zone, time_zone, time_zone]
+              else
+                format =
+                  case field
+                  when "second"
+                    "%Y-%m-%d %H:%i:%S"
+                  when "minute"
+                    "%Y-%m-%d %H:%i:00"
+                  when "hour"
+                    "%Y-%m-%d %H:00:00"
+                  when "day"
+                    "%Y-%m-%d 00:00:00"
+                  when "month"
+                    "%Y-%m-01 00:00:00"
+                  else # year
+                    "%Y-01-01 00:00:00"
+                  end
+
+                ["CONCAT(CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(#{column}, '+00:00', ?), '#{format}'), ?, '+00:00'), '+00')", time_zone, time_zone]
+              end
+            when "PostgreSQL"
+              case field
+              when "day_of_week"
+                ["EXTRACT(DOW from #{column}::timestamptz AT TIME ZONE ?)", time_zone]
+              when "hour_of_day"
+                ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ?)", 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]
+              else
+                ["DATE_TRUNC('#{field}', #{column}::timestamptz AT TIME ZONE ?) AT TIME ZONE ?", time_zone, time_zone]
+              end
+            else
+              raise "Connection adapter not supported"
+            end
+          group(sanitize_sql_array(query))
         }
       end
     end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/test/groupdate_test.rb

@@ -1,3 +1,4 @@
+require "minitest/spec"
 require "minitest/autorun"
 require "active_record"
 require "groupdate"
@@ -10,45 +11,118 @@ require "logger"
 ActiveRecord::Base.default_timezone = :utc
 ActiveRecord::Base.time_zone_aware_attributes = true
 
-# start connection
-ActiveRecord::Base.establish_connection adapter: "postgresql", database: "groupdate"
-
-# ActiveRecord::Migration.create_table :users do |t|
-#   t.string :name
-#   t.integer :score
-#   t.timestamps
-# end
-
 class User < ActiveRecord::Base
 end
 
-class TestGroupdate < MiniTest::Unit::TestCase
-  def setup
-    User.delete_all
-    [
-      {name: "Andrew", score: 1, created_at: Time.parse("2013-04-01 00:00:00 UTC")},
-      {name: "Jordan", score: 2, created_at: Time.parse("2013-04-01 00:00:00 UTC")},
-      {name: "Nick",   score: 3, created_at: Time.parse("2013-04-02 00:00:00 UTC")}
-    ].each{|u| User.create!(u) }
-  end
+describe Groupdate do
+  %w(postgresql mysql mysql2).each do |adapter|
+    describe adapter do
+      before do
+        ActiveRecord::Base.establish_connection adapter: adapter, database: "groupdate"
 
-  def test_count
-    expected = {
-      "2013-04-01 00:00:00+00" => 2,
-      "2013-04-02 00:00:00+00" => 1
-    }
-    assert_equal expected, User.group_by_day(:created_at).count
-  end
+        # ActiveRecord::Migration.create_table :users do |t|
+        #   t.string :name
+        #   t.integer :score
+        #   t.timestamps
+        # end
 
-  def test_time_zone
-    expected = {
-      "2013-03-31 07:00:00+00" => 2,
-      "2013-04-01 07:00:00+00" => 1
-    }
-    assert_equal expected, User.group_by_day(:created_at, "Pacific Time (US & Canada)").count
-  end
+        User.delete_all
+      end
+
+      it "works!" do
+        [
+          {name: "Andrew", score: 1, created_at: Time.parse("2013-04-01 00:00:10.200 UTC")},
+          {name: "Jordan", score: 2, created_at: Time.parse("2013-04-01 00:00:10.200 UTC")},
+          {name: "Nick",   score: 3, created_at: Time.parse("2013-04-02 00:00:20.800 UTC")}
+        ].each{|u| User.create!(u) }
+
+        assert_equal(
+          {"2013-04-01 00:00:00+00" => 1, "2013-04-02 00:00:00+00" => 1},
+          User.where("score > 1").group_by_day(:created_at).count
+        )
+      end
+
+      it "group_by_second" do
+        create_user "2013-04-01 00:00:01 UTC"
+        assert_equal({"2013-04-01 00:00:01+00" => 1}, User.group_by_second(:created_at).count)
+      end
+
+      it "group_by_minute" do
+        create_user "2013-04-01 00:01:01 UTC"
+        assert_equal({"2013-04-01 00:01:00+00" => 1}, User.group_by_minute(:created_at).count)
+      end
+
+      it "group_by_hour" do
+        create_user "2013-04-01 01:01:01 UTC"
+        assert_equal({"2013-04-01 01:00:00+00" => 1}, User.group_by_hour(:created_at).count)
+      end
+
+      it "group_by_day" do
+        create_user "2013-04-01 01:01:01 UTC"
+        assert_equal({"2013-04-01 00:00:00+00" => 1}, User.group_by_day(:created_at).count)
+      end
+
+      it "group_by_day with time zone" do
+        create_user "2013-04-01 01:01:01 UTC"
+        assert_equal({"2013-03-31 07:00:00+00" => 1}, User.group_by_day(:created_at, "Pacific Time (US & Canada)").count)
+      end
+
+      it "group_by_week" do
+        create_user "2013-03-17 01:01:01 UTC"
+        assert_equal({"2013-03-17 00:00:00+00" => 1}, User.group_by_week(:created_at).count)
+      end
+
+      it "group_by_week with time zone" do # day of DST
+        create_user "2013-03-17 01:01:01 UTC"
+        assert_equal({"2013-03-10 08:00:00+00" => 1}, User.group_by_week(:created_at, "Pacific Time (US & Canada)").count)
+      end
+
+      it "group_by_month" do
+        create_user "2013-04-01 01:01:01 UTC"
+        assert_equal({"2013-04-01 00:00:00+00" => 1}, User.group_by_month(:created_at).count)
+      end
+
+      it "group_by_month with time zone" do
+        create_user "2013-04-01 01:01:01 UTC"
+        assert_equal({"2013-03-01 08:00:00+00" => 1}, User.group_by_month(:created_at, "Pacific Time (US & Canada)").count)
+      end
+
+      it "group_by_year" do
+        create_user "2013-01-01 01:01:01 UTC"
+        assert_equal({"2013-01-01 00:00:00+00" => 1}, User.group_by_year(:created_at).count)
+      end
+
+      it "group_by_year with time zone" do
+        create_user "2013-01-01 01:01:01 UTC"
+        assert_equal({"2012-01-01 08:00:00+00" => 1}, User.group_by_year(:created_at, "Pacific Time (US & Canada)").count)
+      end
+
+      it "group_by_hour_of_day" do
+        create_user "2013-01-01 11:00:00 UTC"
+        assert_equal({"11" => 1}, User.group_by_hour_of_day(:created_at).count)
+      end
+
+      it "group_by_hour_of_day with time zone" do
+        create_user "2013-01-01 11:00:00 UTC"
+        assert_equal({"3" => 1}, User.group_by_hour_of_day(:created_at, "Pacific Time (US & Canada)").count)
+      end
+
+      it "group_by_day_of_week" do
+        create_user "2013-03-03 00:00:00 UTC"
+        assert_equal({"0" => 1}, User.group_by_day_of_week(:created_at).count)
+      end
+
+      it "group_by_day_of_week with time zone" do
+        create_user "2013-03-03 00:00:00 UTC"
+        assert_equal({"6" => 1}, User.group_by_day_of_week(:created_at, "Pacific Time (US & Canada)").count)
+      end
+
+      # helper methods
+
+      def create_user(created_at)
+        User.create!(name: "Andrew", score: 1, created_at: Time.parse(created_at))
+      end
 
-  def test_where
-    assert_equal({"2013-04-02 00:00:00+00" => 1}, User.where("score > 2").group_by_day(:created_at).count)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The simplest way to group temporal data
 email:
 - acekane1@gmail.com