groupdate 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96aed6d659f986f853f50f45bc93663f884235ac
-  data.tar.gz: b33a101116de8a25f3fde64ab7824aeb5e09d72b
+  metadata.gz: 81ffab786c4714072fad2155f8475839010822af
+  data.tar.gz: 33dd72742440609989c5c61cb267574f8a5611b3
 SHA512:
-  metadata.gz: a7756158b511af490af7f6c6c6f516674161c5e2f5957380d4d6c7eb30cf733f25b4d7acdd203d9f835c7a98b9126ec91c3027910f71717eeb455ad993c37200
-  data.tar.gz: 3c1998ad9aec8d3a93001e86ad6d4e54d43547cc32689a32a247566b3bb010b9792799077a5c9485fbfdb906cf2f830d080d3c05856a432988d5d9764c75637b
+  metadata.gz: 0df29d96f26fb544e20d768f980c930cf53806c3a4da0ba1e1e4963a814ad8fee09049c3996d9e3f45c9547cdd3147effcf9b3d22ef2deff06170fb2f75b1023
+  data.tar.gz: 75b9c0e7c01cd1d936e4fbd9832a460827a1340d6a95b17fdde3a1898236edacc26daf9a87968e38f9210222083d7717b92bfcfa016090eefcd291f09f1ab083

data/README.md

@@ -9,7 +9,9 @@ The simplest way to group by:
 - hour of the day
 - and more (complete list at bottom)
 
-:tada: Time zones supported!! **The best part**
+:tada: Time zones supported!! **the best part**
+
+:cake: Get the entire series - **the other best part**
 
 Works with Rails 3.0+
 
@@ -103,6 +105,55 @@ Go nuts!
 Request.where(page: "/home").group_by_minute(:started_at).maximum(:request_time)
 ```
 
+### Show me the series :moneybag:
+
+You have two users - one created on May 2 and one on May 5.
+
+```ruby
+User.group_by_day(:created_at).count
+# {
+#   2013-05-02 00:00:00 UTC => 1,
+#   2013-05-05 00:00:00 UTC => 1
+# }
+```
+
+Awesome, but you want to see the first week of May.  Pass a range as the third argument.
+
+```ruby
+# pretend today is May 7
+time_range = 6.days.ago..Time.now
+
+User.group_by_day(:created_at, Time.zone, time_range).count(:created_at)
+# {
+#   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
+# }
+```
+
+Wow, SQL magic!
+
+**Note:** Be sure to pass the column name to `count`.  Otherwise, you get `1` for empty groups.
+
+For the day of the week and hour of the day, just pass `true`.
+
+```ruby
+User.group_by_day_of_week(:created_at, Time.zone, true).count(:created_at)
+# {
+#   0 => 0,
+#   1 => 1,
+#   2 => 0,
+#   3 => 0,
+#   4 => 1,
+#   5 => 0,
+#   6 => 0
+# }
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/groupdate.rb

@@ -28,8 +28,9 @@ module Groupdate
     included do
       # Field list from
       # http://www.postgresql.org/docs/9.1/static/functions-datetime.html
-      fields = %w(second minute hour day week month year day_of_week hour_of_day)
-      fields.each do |field|
+      time_fields = %w(second minute hour day week month year)
+      number_fields = %w(day_of_week hour_of_day)
+      (time_fields + number_fields).each do |field|
         self.scope :"group_by_#{field}", lambda {|*args|
           column = connection.quote_table_name(args[0])
           time_zone = args[1] || Time.zone || "Etc/UTC"
@@ -83,7 +84,66 @@ module Groupdate
               raise "Connection adapter not supported: #{connection.adapter_name}"
             end
 
-          group(Groupdate::OrderHack.new(sanitize_sql_array(query), field))
+          if args[2] # zeros
+            if time_fields.include?(field)
+              range = args[2]
+              unless range.is_a?(Range)
+                raise "Expecting a range"
+              end
+
+              # determine start time
+              time = range.first.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"
+                  time.beginning_of_week(:sunday)
+                when "month"
+                  time.beginning_of_month
+                else # year
+                  time.beginning_of_year
+                end
+
+              series = [starts_at]
+
+              step = 1.send(field)
+
+              while range.cover?(series.last + step)
+                series << series.last + step
+              end
+            end
+
+            derived_table =
+              case connection.adapter_name
+              when "PostgreSQL"
+                case field
+                when "day_of_week", "hour_of_day"
+                  max = field == "day_of_week" ? 6 : 23
+                  "SELECT generate_series(0, #{max}, 1) AS #{field}"
+                else
+                  sanitize_sql_array(["SELECT (generate_series(CAST(? AS timestamptz) AT TIME ZONE ?, ?, ?) AT TIME ZONE ?) AS #{field}", starts_at, time_zone, series.last, "1 #{field}", time_zone])
+                end
+              else # MySQL
+                case field
+                when "day_of_week", "hour_of_day"
+                  max = field == "day_of_week" ? 6 : 23
+                  (0..max).map{|i| "SELECT #{i} AS #{field}" }.join(" UNION ")
+                else
+                  sanitize_sql_array([series.map{|i| "SELECT CAST(? AS DATETIME) AS #{field}" }.join(" UNION ")] + series)
+                end
+              end
+
+            joins("RIGHT OUTER JOIN (#{derived_table}) groupdate_series ON groupdate_series.#{field} = (#{sanitize_sql_array(query)})").group(Groupdate::OrderHack.new("groupdate_series.#{field}", field))
+          else
+            group(Groupdate::OrderHack.new(sanitize_sql_array(query), field))
+          end
         }
       end
     end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/groupdate_test.rb

@@ -121,6 +121,81 @@ describe Groupdate do
       it "group_by_day_of_week with time zone" do
         assert_group_number_tz :day_of_week, "2013-03-03 00:00:00 UTC", 6
       end
+
+      describe "returns zeros" do
+
+        it "group_by_second" do
+          assert_zeros :second, "2013-05-01 00:00:01 UTC", ["2013-05-01 00:00:00 UTC", "2013-05-01 00:00:01 UTC", "2013-05-01 00:00:02 UTC"], "2013-05-01 00:00:00.999 UTC", "2013-05-01 00:00:02 UTC"
+        end
+
+        it "group_by_minute" do
+          assert_zeros :minute, "2013-05-01 00:01:00 UTC", ["2013-05-01 00:00:00 UTC", "2013-05-01 00:01:00 UTC", "2013-05-01 00:02:00 UTC"], "2013-05-01 00:00:59 UTC", "2013-05-01 00:02:00 UTC"
+        end
+
+        it "group_by_hour" do
+          assert_zeros :hour, "2013-05-01 04:01:01 UTC", ["2013-05-01 03:00:00 UTC", "2013-05-01 04:00:00 UTC", "2013-05-01 05:00:00 UTC"], "2013-05-01 03:59:59 UTC", "2013-05-01 05:00:00 UTC"
+        end
+
+        it "group_by_day" do
+          assert_zeros :day, "2013-05-01 20:00:00 UTC", ["2013-04-30 00:00:00 UTC", "2013-05-01 00:00:00 UTC", "2013-05-02 00:00:00 UTC"], "2013-04-30 00:00:00 UTC", "2013-05-02 23:59:59 UTC"
+        end
+
+        it "group_by_day with time zone" do
+          assert_zeros_tz :day, "2013-05-01 20:00:00 PDT", ["2013-04-30 00:00:00 PDT", "2013-05-01 00:00:00 PDT", "2013-05-02 00:00:00 PDT"], "2013-04-30 00:00:00 PDT", "2013-05-02 23:59:59 PDT"
+        end
+
+        it "group_by_week" do
+          assert_zeros :week, "2013-05-01 20:00:00 UTC", ["2013-04-21 00:00:00 UTC", "2013-04-28 00:00:00 UTC", "2013-05-05 00:00:00 UTC"], "2013-04-27 23:59:59 UTC", "2013-05-11 23:59:59 UTC"
+        end
+
+        it "group_by_week with time zone" do
+          assert_zeros_tz :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"
+        end
+
+        it "group_by_month" do
+          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
+
+        it "group_by_month with time zone" do
+          assert_zeros_tz :month, "2013-04-16 20:00:00 PDT", ["2013-03-01 00:00:00 PST", "2013-04-01 00:00:00 PDT", "2013-05-01 00:00:00 PDT"], "2013-03-01 00:00:00 PST", "2013-05-31 23:59:59 PDT"
+        end
+
+        it "group_by_year" do
+          assert_zeros :year, "2013-04-16 20:00:00 UTC", ["2012-01-01 00:00:00 UTC", "2013-01-01 00:00:00 UTC", "2014-01-01 00:00:00 UTC"], "2012-01-01 00:00:00 UTC", "2014-12-31 23:59:59 UTC"
+        end
+
+        it "group_by_year with time zone" do
+          assert_zeros_tz :year, "2013-04-16 20:00:00 PDT", ["2012-01-01 00:00:00 PST", "2013-01-01 00:00:00 PST", "2014-01-01 00:00:00 PST"], "2012-01-01 00:00:00 PST", "2014-12-31 23:59:59 PST"
+        end
+
+        it "group_by_day_of_week" do
+          create_user "2013-05-01 00:00:00 UTC"
+          expected = {}
+          7.times do |n|
+            expected[number_key(n, true)] = n == 3 ? 1 : 0
+          end
+          assert_equal(expected, User.group_by_day_of_week(:created_at, Time.zone, true).count(:created_at))
+        end
+
+        it "group_by_hour_of_day" do
+          create_user "2013-05-01 20:00:00 UTC"
+          expected = {}
+          24.times do |n|
+            expected[number_key(n, true)] = n == 20 ? 1 : 0
+          end
+          assert_equal(expected, User.group_by_hour_of_day(:created_at, Time.zone, true).count(:created_at))
+        end
+
+        it "excludes end" do
+          create_user "2013-05-02 00:00:00 UTC"
+          expected = {
+            time_key("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(:created_at))
+        end
+
+      end
+
     end
   end
 
@@ -128,7 +203,7 @@ describe Groupdate do
 
   def assert_group(method, created_at, key, time_zone = nil)
     create_user created_at
-    assert_equal(ordered_hash({time_key(key) => 1}), User.send(:"group_by_#{method}", :created_at, time_zone).count)
+    assert_equal(ordered_hash({time_key(key) => 1}), User.send(:"group_by_#{method}", :created_at, time_zone).order(method).count)
   end
 
   def assert_group_tz(method, created_at, key)
@@ -137,26 +212,57 @@ describe Groupdate do
 
   def assert_group_number(method, created_at, key, time_zone = nil)
     create_user created_at
-    assert_equal(ordered_hash({number_key(key) => 1}), User.send(:"group_by_#{method}", :created_at, time_zone).count)
+    assert_equal(ordered_hash({number_key(key) => 1}), User.send(:"group_by_#{method}", :created_at, time_zone).order(method).count)
   end
 
   def assert_group_number_tz(method, created_at, key)
     assert_group_number method, created_at, key, "Pacific Time (US & Canada)"
   end
 
-  def time_key(key)
+  def assert_zeros(method, created_at, keys, range_start, range_end, time_zone = nil, java_hack = false)
+    create_user created_at
+    expected = {}
+    keys.each_with_index do |key, i|
+      expected[time_key(key, java_hack)] = i == 1 ? 1 : 0
+    end
+    assert_equal(expected, User.send(:"group_by_#{method}", :created_at, time_zone, Time.parse(range_start)..Time.parse(range_end)).order(method).count(:created_at))
+  end
+
+  def assert_zeros_tz(method, created_at, keys, range_start, range_end)
+    assert_zeros method, created_at, keys, range_start, range_end, "Pacific Time (US & Canada)", true
+  end
+
+  def time_key(key, java_hack = false)
     if RUBY_PLATFORM == "java"
-      User.connection.adapter_name == "PostgreSQL" ? Time.parse(key).strftime("%Y-%m-%d %H:%M:%S%z")[0..-3] : Time.parse(key).strftime("%Y-%m-%d %H:%M:%S").gsub(/ 00\:00\:00\z/, "")
+      if User.connection.adapter_name == "PostgreSQL"
+        Time.parse(key).utc.strftime("%Y-%m-%d %H:%M:%S%z")[0..-3]
+      elsif java_hack
+        Time.parse(key).utc.strftime("%Y-%m-%d %H:%M:%S")
+      else
+        Time.parse(key).strftime("%Y-%m-%d %H:%M:%S").gsub(/ 00\:00\:00\z/, "")
+      end
     else
-      User.connection.adapter_name == "PostgreSQL" && ActiveRecord::VERSION::MAJOR == 3 ? Time.parse(key).strftime("%Y-%m-%d %H:%M:%S+00") : Time.parse(key)
+      if User.connection.adapter_name == "PostgreSQL" and ActiveRecord::VERSION::MAJOR == 3
+        Time.parse(key).utc.strftime("%Y-%m-%d %H:%M:%S+00")
+      else
+        Time.parse(key)
+      end
     end
   end
 
-  def number_key(key)
+  def number_key(key, java_hack = false)
     if RUBY_PLATFORM == "java"
-      User.connection.adapter_name == "PostgreSQL" ? key.to_f : key
+      if User.connection.adapter_name == "PostgreSQL" and !java_hack
+        key.to_f
+      else
+        key
+      end
     else
-      User.connection.adapter_name == "PostgreSQL" ? (ActiveRecord::VERSION::MAJOR == 3 ? key.to_s : key.to_f) : key
+      if User.connection.adapter_name == "PostgreSQL"
+        ActiveRecord::VERSION::MAJOR == 3 ? key.to_s : key.to_f
+      else
+        key
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord