groupdate 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0cda5c33577e2d10a7701383aca6cd9571c2b70
-  data.tar.gz: 474344cbd117c863f407db920986d93aeaca2dc7
+  metadata.gz: 6718db413e208c0735f68167fd6347a0e0770c28
+  data.tar.gz: 15f3b021beac304cca17c302fecafe71ddc9249f
 SHA512:
-  metadata.gz: 344ec7cb8dd73d77ec23f18cb6f92ca58368084da1a9b8c02c658af92d0266fbb95598c4255ad6bc8616d1fc6111ee3fe386e322b65ea4d826362de5e1ed5074
-  data.tar.gz: 142f62737693d891f0af21b31dc7de1d2a8a36e04b59a88d7d637725b3720df771348da697f02be86e6df0a619a641c009a39110f2d421a49a335bfe3c7f4097
+  metadata.gz: 12ec543e69db27f0f499e170b8d10e3475024d08c776673fbd30423d9979e4407c7c6bbbd6a2ecee18d3687715e09dc77eec2b78f02981be330eddbaddb3d154
+  data.tar.gz: 7ae5b1a1d879fd25b4f20ff07c78c5840ec8b7b7241e876c3bc359c69c487adcdd1be9f5cf40f2fc6befae697bdf0da48606751a0957eff7ca74c40d9c419644

data/README.md

@@ -5,16 +5,8 @@ The simplest way to group by:
 - day
 - week
 - month
-- year
 - hour
-- microseconds
-- milliseconds
-- second
-- minute
-- quarter
-- decade
-- century
-- millennium
+- *and more* (complete list at bottom)
 
 :tada: Time zones supported!!
 
@@ -24,34 +16,37 @@ PostgreSQL only at the moment - support for other datastores coming soon
 
 ```ruby
 User.group_by_day(:created_at).count
-# => {2013-04-16 00:00:00 UTC=>50,2013-04-17 00:00:00 UTC=>100}
+# => {"2013-04-16 00:00:00+00" => 50, "2013-04-17 00:00:00+00" => 100}
 
 Task.group_by_month(:updated_at).count
-# => {2013-04-01 00:00:00 UTC=>23,2013-04-01 00:00:00 UTC=>44}
+# => {"2013-03-01 00:00:00+00" => 23, "2013-04-01 00:00:00+00" => 44}
 
 Goal.group_by_year(:accomplished_at).count
-# => {2012-01-01 00:00:00 UTC=>11,2013-01-01 00:00:00 UTC=>3}
+# => {"2012-01-01 00:00:00+00" => 11, "2013-01-01 00:00:00+00" => 3}
 ```
 
 The default time zone is `Time.zone`.  Pass a time zone as the second argument.
 
 ```ruby
-User.group_by_day(:created_at, ActiveSupport::TimeZone["Pacific Time (US & Canada)"]).count
-# => {2013-04-16 00:00:00 UTC=>80,2013-04-17 00:00:00 UTC=>70}
+time_zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
+User.group_by_week(:created_at, time_zone).count
+# => {"2013-04-16 07:00:00+00" => 80, "2013-04-17 07:00:00+00" => 70}
 ```
 
-Use it with anything that you can use `group` with:
+Use it with anything you can use `group` with:
 
 ```ruby
-User.group_by_week(:created_at).sum(:tasks_count)
-
-User.group_by_hour(:created_at).average(:tasks_count)
+Task.completed.group_by_hour(:completed_at).average(:priority)
+```
 
-User.group_by_quarter(:created_at).maximum(:tasks_count)
+Go nuts!
 
-User.group_by_second(:created_at).average(:tasks_count)
+```ruby
+Request.where(page: "/home").group_by_minute(:started_at).maximum(:request_time)
 ```
 
+**Note:** On Rails 4 edge, queries return a Time object (much better!) as a result of [this commit](https://github.com/rails/rails/commit/2cc09441c2de57b024b11ba666ba1e72c2b20cfe)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -60,6 +55,22 @@ Add this line to your application's Gemfile:
 gem 'groupdate'
 ```
 
+## Complete list
+
+- microseconds
+- milliseconds
+- second
+- minute
+- hour
+- day
+- week
+- month
+- quarter
+- year
+- decade
+- century
+- millennium
+
 ## Contributing
 
 1. Fork it

data/groupdate.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pg"
 end

data/lib/groupdate.rb

@@ -29,9 +29,10 @@ module Groupdate
       # 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|
-          if time_zone.is_a?(ActiveSupport::TimeZone)
+          if defined?(ActiveSupport::TimeZone) and time_zone.is_a?(ActiveSupport::TimeZone)
             time_zone = time_zone.tzinfo.name
           end
+          time_zone ||= "Etc/UTC"
           sql = "DATE_TRUNC('#{field}', #{column}::timestamptz AT TIME ZONE ?) AT TIME ZONE ?"
           group(sanitize_sql_array([sql, time_zone, time_zone]))
         }

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/groupdate_test.rb

@@ -0,0 +1,54 @@
+require "minitest/autorun"
+require "active_record"
+require "groupdate"
+require "logger"
+
+# for debugging
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# rails does this in activerecord/lib/active_record/railtie.rb
+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
+
+  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
+
+  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, "America/Los_Angeles").count
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kane
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pg
+  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
@@ -67,6 +95,7 @@ files:
 - groupdate.gemspec
 - lib/groupdate.rb
 - lib/groupdate/version.rb
+- test/groupdate_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -91,4 +120,5 @@ rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: The simplest way to group temporal data
-test_files: []
+test_files:
+- test/groupdate_test.rb