groupdate 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81ffab786c4714072fad2155f8475839010822af
-  data.tar.gz: 33dd72742440609989c5c61cb267574f8a5611b3
+  metadata.gz: 20e5986d43228afba669a7b5928f555a302680bc
+  data.tar.gz: e0190e033c4fa7a3b51eefa09254a61f44d55337
 SHA512:
-  metadata.gz: 0df29d96f26fb544e20d768f980c930cf53806c3a4da0ba1e1e4963a814ad8fee09049c3996d9e3f45c9547cdd3147effcf9b3d22ef2deff06170fb2f75b1023
-  data.tar.gz: 75b9c0e7c01cd1d936e4fbd9832a460827a1340d6a95b17fdde3a1898236edacc26daf9a87968e38f9210222083d7717b92bfcfa016090eefcd291f09f1ab083
+  metadata.gz: 059e84d54ea52420c4d2fa12ae479623652b704b03246c937f249548b9f55db8ca1e3a469404350b62c8b127d9276cefdc22f2f463d62fcdb35aec6de90baaa8
+  data.tar.gz: 5d61f760f0cc7a01d83df61b11b687c20761fd345e8e6152ae4b7f1955d57d54ba6a2e03ec759364ab12da0baf94007b99a8db1990be3708a04e82ad2e89a22f

data/.travis.yml

@@ -9,3 +9,7 @@ before_script:
   - mysql -e 'create database groupdate_test;'
   - mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
   - psql -c 'create database groupdate_test;' -U postgres
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/README.md

@@ -123,7 +123,7 @@ Awesome, but you want to see the first week of May.  Pass a range as the third a
 # 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)
+User.group_by_day(:created_at, Time.zone, time_range).count
 # {
 #   2013-05-01 00:00:00 UTC => 0,
 #   2013-05-02 00:00:00 UTC => 1,
@@ -133,16 +133,8 @@ User.group_by_day(:created_at, Time.zone, time_range).count(:created_at)
 #   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)
+User.group_by_day_of_week(:created_at, Time.zone, time_range).count
 # {
 #   0 => 0,
 #   1 => 1,
@@ -154,6 +146,10 @@ User.group_by_day_of_week(:created_at, Time.zone, true).count(:created_at)
 # }
 ```
 
+Results are returned in ascending order, so no need to sort.
+
+Also, this form of the method returns a Groupdate::Series instead of an ActiveRecord::Relation.  ActiveRecord::Relation method calls (like `where` and `joins`) should come before this.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/groupdate.rb

@@ -1,171 +1,15 @@
 require "groupdate/version"
-require "active_record"
+require "groupdate/scopes"
 
-module Groupdate
-  extend ActiveSupport::Concern
-
-  # Pattern from kaminari
-  # https://github.com/amatsuda/kaminari/blob/master/lib/kaminari/models/active_record_extension.rb
-  included do
-    # Future subclasses will pick up the model extension
-    class << self
-      def inherited_with_groupdate(kls) #:nodoc:
-        inherited_without_groupdate kls
-        kls.send(:include, ClassMethods) if kls.superclass == ActiveRecord::Base
-      end
-      alias_method_chain :inherited, :groupdate
-    end
-
-    # Existing subclasses pick up the model extension as well
-    self.descendants.each do |kls|
-      kls.send(:include, ClassMethods) if kls.superclass == ActiveRecord::Base
-    end
-  end
-
-  module ClassMethods
-    extend ActiveSupport::Concern
-
-    included do
-      # Field list from
-      # http://www.postgresql.org/docs/9.1/static/functions-datetime.html
-      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"
-          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
-          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)
-                ["DAYOFWEEK(CONVERT_TZ(#{column}, '+00:00', ?)) - 1", time_zone]
-              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]
-              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
-
-                ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(#{column}, '+00:00', ?), '#{format}'), ?, '+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: #{connection.adapter_name}"
-            end
-
-          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
-  end
-
-  class OrderHack < String
-    attr_reader :field
-
-    def initialize(str, field)
-      super(str)
-      @field = field
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Groupdate
+ActiveRecord::Base.send :include, Groupdate::Scopes
 
 # hack for **unfixed** rails issue
 # https://github.com/rails/rails/issues/7121
 module ActiveRecord
   module Calculations
 
+    private
+
     def column_alias_for_with_hack(*keys)
       if keys.first.is_a?(Groupdate::OrderHack)
         keys.first.field

data/lib/groupdate/order_hack.rb

@@ -0,0 +1,11 @@
+module Groupdate
+  class OrderHack < String
+    attr_reader :field, :time_zone
+
+    def initialize(str, field, time_zone)
+      super(str)
+      @field = field
+      @time_zone = time_zone
+    end
+  end
+end

data/lib/groupdate/scopes.rb

@@ -0,0 +1,101 @@
+require "groupdate/order_hack"
+require "groupdate/series"
+require "active_record"
+
+module Groupdate
+  module Scopes
+    extend ActiveSupport::Concern
+
+    # Pattern from kaminari
+    # https://github.com/amatsuda/kaminari/blob/master/lib/kaminari/models/active_record_extension.rb
+    included do
+      # Future subclasses will pick up the model extension
+      class << self
+        def inherited_with_groupdate(kls) #:nodoc:
+          inherited_without_groupdate kls
+          kls.send(:include, ClassMethods) if kls.superclass == ActiveRecord::Base
+        end
+        alias_method_chain :inherited, :groupdate
+      end
+
+      # Existing subclasses pick up the model extension as well
+      self.descendants.each do |kls|
+        kls.send(:include, ClassMethods) if kls.superclass == ActiveRecord::Base
+      end
+    end
+
+    module ClassMethods
+      extend ActiveSupport::Concern
+
+      included do
+        # Field list from
+        # http://www.postgresql.org/docs/9.1/static/functions-datetime.html
+        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|
+          # no define_singleton_method in ruby 1.8
+          (class << self; self end).send :define_method, :"group_by_#{field}" do |*args|
+            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]
+              time_zone = time_zone.tzinfo.name
+            else
+              raise "Unrecognized time zone"
+            end
+            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)
+                  ["DAYOFWEEK(CONVERT_TZ(#{column}, '+00:00', ?)) - 1", time_zone]
+                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]
+                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
+
+                  ["CONVERT_TZ(DATE_FORMAT(CONVERT_TZ(#{column}, '+00:00', ?), '#{format}'), ?, '+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: #{connection.adapter_name}"
+              end
+
+            group = group(Groupdate::OrderHack.new(sanitize_sql_array(query), field, time_zone))
+            if args[2]
+              Series.new(group, field, column, time_zone, args[2])
+            else
+              group
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groupdate/series.rb

@@ -0,0 +1,89 @@
+module Groupdate
+  class Series
+
+    def initialize(relation, field, column, time_zone, time_range)
+      @relation = relation
+      if time_range.is_a?(Range)
+        @relation = relation.where("#{column} BETWEEN ? AND ?", time_range.first, time_range.last)
+      end
+      @field = field
+      @time_zone = time_zone
+      @time_range = time_range
+    end
+
+    def build_series(count)
+      cast_method =
+        case @field
+        when "day_of_week", "hour_of_day"
+          lambda{|k| k.to_i }
+        else
+          lambda{|k| k.is_a?(Time) ? k : Time.parse(k) }
+        end
+
+      count = Hash[count.map do |k, v|
+        [cast_method.call(k), v]
+      end]
+
+      series =
+        case @field
+        when "day_of_week"
+          0..6
+        when "hour_of_day"
+          0..23
+        else
+          time_range =
+            if @time_range.is_a?(Range)
+              @time_range
+            else
+              # use first and last values
+              sorted_keys = count.keys.sort
+              sorted_keys.first..sorted_keys.last
+            end
+
+          # determine start time
+          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 time_range.cover?(series.last + step)
+            series << series.last + step
+          end
+
+          series.map{|s| s.to_time }
+        end
+
+      Hash[series.map do |k|
+        [k, count[k] || 0]
+      end]
+    end
+
+    def method_missing(method, *args, &block)
+      # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
+      if ActiveRecord::Calculations.method_defined?(method)
+        build_series(@relation.send(method, *args, &block))
+      else
+        raise NoMethodError, "valid methods are: #{ActiveRecord::Calculations.instance_methods.join(", ")}"
+      end
+    end
+
+  end # Series
+end

data/lib/groupdate/version.rb

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

data/test/groupdate_test.rb

@@ -122,6 +122,11 @@ describe Groupdate do
         assert_group_number_tz :day_of_week, "2013-03-03 00:00:00 UTC", 6
       end
 
+      it "works with previous scopes" do
+        create_user "2013-05-01 00:00:00 UTC"
+        assert_equal({}, User.where("id = 0").group_by_day(:created_at).count)
+      end
+
       describe "returns zeros" do
 
         it "group_by_second" do
@@ -172,7 +177,7 @@ describe Groupdate do
           create_user "2013-05-01 00:00:00 UTC"
           expected = {}
           7.times do |n|
-            expected[number_key(n, true)] = n == 3 ? 1 : 0
+            expected[n] = n == 3 ? 1 : 0
           end
           assert_equal(expected, User.group_by_day_of_week(:created_at, Time.zone, true).count(:created_at))
         end
@@ -181,7 +186,7 @@ describe Groupdate do
           create_user "2013-05-01 20:00:00 UTC"
           expected = {}
           24.times do |n|
-            expected[number_key(n, true)] = n == 20 ? 1 : 0
+            expected[n] = n == 20 ? 1 : 0
           end
           assert_equal(expected, User.group_by_hour_of_day(:created_at, Time.zone, true).count(:created_at))
         end
@@ -189,9 +194,17 @@ describe Groupdate do
         it "excludes end" do
           create_user "2013-05-02 00:00:00 UTC"
           expected = {
-            time_key("2013-05-01 00:00:00 UTC") => 0
+            Time.parse("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)
+        end
+
+        it "works with previous scopes" do
+          create_user "2013-05-01 00:00:00 UTC"
+          expected = {
+            Time.parse("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))
+          assert_equal(expected, User.where("id = 0").group_by_day(:created_at, Time.zone, Time.parse("2013-05-01 00:00:00 UTC")..Time.parse("2013-05-01 23:59:59 UTC")).count)
         end
 
       end
@@ -203,7 +216,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).order(method).count)
+    assert_equal(ordered_hash({time_key(key) => 1}), User.send(:"group_by_#{method}", :created_at, time_zone).order(method.to_s).count)
   end
 
   def assert_group_tz(method, created_at, key)
@@ -212,7 +225,7 @@ 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).order(method).count)
+    assert_equal(ordered_hash({number_key(key) => 1}), User.send(:"group_by_#{method}", :created_at, time_zone).order(method.to_s).count)
   end
 
   def assert_group_number_tz(method, created_at, key)
@@ -223,9 +236,9 @@ describe Groupdate do
     create_user created_at
     expected = {}
     keys.each_with_index do |key, i|
-      expected[time_key(key, java_hack)] = i == 1 ? 1 : 0
+      expected[Time.parse(key)] = 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))
+    assert_equal(expected, User.send(:"group_by_#{method}", :created_at, time_zone, Time.parse(range_start)..Time.parse(range_end)).count)
   end
 
   def assert_zeros_tz(method, created_at, keys, range_start, range_end)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -109,6 +109,9 @@ files:
 - Rakefile
 - groupdate.gemspec
 - lib/groupdate.rb
+- lib/groupdate/order_hack.rb
+- lib/groupdate/scopes.rb
+- lib/groupdate/series.rb
 - lib/groupdate/version.rb
 - test/groupdate_test.rb
 homepage: ''