groupdate 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f508159d00896699f39ded75030c0a5222f995b
-  data.tar.gz: 3463e516136dec2e0f06cd321f4a8a8f7b913cab
+  metadata.gz: 30c3377f6edb6fe33f5d0ac0aab691a6a7a6c198
+  data.tar.gz: d725a9a605553a390055a4bbf55a132233aade70
 SHA512:
-  metadata.gz: 2fc8f83f7a9d755b4b4fd4ab6066b1d90d0160e1e0e4bb21f9d4a8d28ff0fe93840747c2618d3124bccf23b7415ad0bb553f7bd53d516ed8e17f9b49ffb5d452
-  data.tar.gz: b9f8b64e5a7a175f116a2079457d16c5d75515f791e3308a98bfc89ff4976b913e4f3e90f7cdeb762dc0aec8f95ad84168525fd594fa353b87939019421af1ee
+  metadata.gz: d121c447a7c6c4c6b9be3e28942c640ea4f7bb5da420314eb863d7ff9a1a648c77129afe726ae3311a61cef6a32d386fbf76e97948adc0313f0a87935f4fe181
+  data.tar.gz: 13e3ba1f7530160f450cb48aa1e5e67f65af979602e2c3ff0d392cc436079db1c12cd457c122e30d63e1c5cac75001af3dafb4b3839520402d1b115015200613

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+*.gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.0.4
+
+- added multiple groups
+- added order
+- subsequent methods no longer modify relation
+
 # 2.0.3
 
 - implemented respond_to?

data/Gemfile

@@ -2,12 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in groupdate.gemspec
 gemspec
-
-# gem "activerecord", github: "rails/rails"
-# gem "activerecord", "3.0.20"
-# gem "mysql2", "< 0.3.0"
-
-platform :jruby do
-  gem "activerecord-jdbcpostgresql-adapter", :github => "jruby/activerecord-jdbc-adapter"
-  gem "activerecord-jdbcmysql-adapter", :github => "jruby/activerecord-jdbc-adapter"
-end

data/README.md

@@ -32,7 +32,7 @@ User.group_by_day(:created_at).count
 # }
 ```
 
-Results are returned in ascending order, so no need to sort.
+Results are returned in ascending order by default, so no need to sort.
 
 You can also group by:
 
@@ -48,6 +48,8 @@ and
 - hour_of_day
 - day_of_week (Sunday = 0, Monday = 1, etc)
 
+Use it anywhere you can use `group`.
+
 ### Time Zones
 
 The default time zone is `Time.zone`.  Change this with:
@@ -105,6 +107,20 @@ To get a specific time range, use:
 User.group_by_day(:created_at, range: 2.weeks.ago.midnight..Time.now).count
 ```
 
+### Order
+
+You can order in descending order with:
+
+```ruby
+User.group_by_day(:created_at).reverse_order.count
+```
+
+or
+
+```ruby
+User.group_by_day(:created_at).order("day desc").count
+```
+
 ## Installation
 
 Add this line to your application’s Gemfile:

data/gemfiles/activerecord31.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchkick.gemspec
+gemspec path: "../"
+
+gem "activerecord", "3.1.12"

data/groupdate.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["acekane1@gmail.com"]
   spec.description   = %q{The simplest way to group temporal data}
   spec.summary       = %q{The simplest way to group temporal data}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/ankane/groupdate"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/groupdate/scopes.rb

@@ -76,7 +76,7 @@ module Groupdate
         group = group(Groupdate::OrderHack.new(sanitize_sql_array(query), field, time_zone))
         range = args[2] || options[:range] || true
         unless options[:series] == false
-          Series.new(group, field, column, time_zone_object, range, week_start, day_start)
+          Series.new(group, field, column, time_zone_object, range, week_start, day_start, group.group_values.size - 1)
         else
           group
         end

data/lib/groupdate/series.rb

@@ -1,23 +1,30 @@
 module Groupdate
   class Series
 
-    def initialize(relation, field, column, time_zone, time_range, week_start, day_start)
-      if time_range.is_a?(Range)
-        # doesn't matter whether we include the end of a ... range - it will be excluded later
-        @relation = relation.where("#{column} >= ? AND #{column} <= ?", time_range.first, time_range.last)
-      else
-        @relation = relation.where("#{column} IS NOT NULL")
-      end
+    def initialize(relation, field, column, time_zone, time_range, week_start, day_start, group_index)
+      @relation = relation
       @field = field
+      @column = column
       @time_zone = time_zone
       @time_range = time_range
       @week_start = week_start
       @day_start = day_start
+      @group_index = group_index
     end
 
     def build_series(count)
       utc = ActiveSupport::TimeZone["UTC"]
 
+      reverse = @reverse
+      order = @relation.order_values.first
+      if order.is_a?(String)
+        parts = order.split(" ")
+        reverse_order = (parts.size == 2 && parts[0] == @field && parts[1].to_s.downcase == "desc")
+        reverse = !reverse if reverse_order
+      end
+
+      multiple_groups = @relation.group_values.size > 1
+
       cast_method =
         case @field
         when "day_of_week", "hour_of_day"
@@ -26,7 +33,7 @@ module Groupdate
           lambda{|k| (k.is_a?(String) ? utc.parse(k) : k.to_time).in_time_zone(@time_zone) }
         end
 
-      count = Hash[ count.map{|k, v| [cast_method.call(k), v] } ]
+      count = Hash[ count.map{|k, v| [multiple_groups ? k[0...@group_index] + [cast_method.call(k[@group_index])] + k[(@group_index + 1)..-1] : cast_method.call(k), v] } ]
 
       series =
         case @field
@@ -40,7 +47,12 @@ module Groupdate
               @time_range
             else
               # use first and last values
-              sorted_keys = count.keys.sort
+              sorted_keys =
+                if multiple_groups
+                  count.keys.map{|k| k[@group_index] }.sort
+                else
+                  count.keys.sort
+                end
               sorted_keys.first..sorted_keys.last
             end
 
@@ -76,12 +88,25 @@ module Groupdate
               series << series.last + step
             end
 
-            series
+            if multiple_groups
+              keys = count.keys.map{|k| k[0...@group_index] + k[(@group_index + 1)..-1] }.uniq
+              series = series.reverse if reverse
+              keys.flat_map do |k|
+                series.map{|s| k[0...@group_index] + [s] + k[@group_index..-1] }
+              end
+            else
+              series
+            end
           else
             []
           end
         end
 
+      # reversed above if multiple groups
+      if !multiple_groups and reverse
+        series = series.to_a.reverse
+      end
+
       Hash[series.map do |k|
         [k, count[k] || 0]
       end]
@@ -90,10 +115,23 @@ module Groupdate
     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))
+        relation =
+          if @time_range.is_a?(Range)
+            # doesn't matter whether we include the end of a ... range - it will be excluded later
+            @relation.where("#{@column} >= ? AND #{@column} <= ?", @time_range.first, @time_range.last)
+          else
+            @relation.where("#{@column} IS NOT NULL")
+          end
+
+        # undo reverse since we do not want this to appear in the query
+        if relation.reverse_order_value
+          @reverse = true
+          relation = relation.reverse_order
+        end
+
+        build_series(relation.send(method, *args, &block))
       elsif @relation.respond_to?(method)
-        @relation = @relation.send(method, *args, &block)
-        self
+        Groupdate::Series.new(@relation.send(method, *args, &block), @field, @column, @time_zone, @time_range, @week_start, @day_start, @group_index)
       else
         super
       end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/test/mysql_test.rb

@@ -8,12 +8,4 @@ class TestMysql < Minitest::Unit::TestCase
     User.establish_connection :adapter => "mysql2", :database => "groupdate_test", :username => "root"
   end
 
-  def time_key(key)
-    key
-  end
-
-  def number_key(key)
-    key
-  end
-
 end

data/test/postgresql_test.rb

@@ -8,20 +8,4 @@ class TestPostgresql < Minitest::Unit::TestCase
     User.establish_connection :adapter => "postgresql", :database => "groupdate_test"
   end
 
-  def time_key(key)
-    if ActiveRecord::VERSION::MAJOR == 3
-      key.utc.strftime("%Y-%m-%d %H:%M:%S+00")
-    else
-      key
-    end
-  end
-
-  def number_key(key)
-    if RUBY_PLATFORM != "java" and ActiveRecord::VERSION::MAJOR == 3
-      key.to_s
-    else
-      key
-    end
-  end
-
 end

data/test/test_helper.rb

@@ -386,7 +386,7 @@ module TestGroupdate
     7.times do |n|
       expected[n] = n == 3 ? 1 : 0
     end
-    assert_equal expected, User.group_by_day_of_week(:created_at, range: true).count(:created_at)
+    assert_equal expected, User.group_by_day_of_week(:created_at, range: true).count
   end
 
   def test_zeros_hour_of_day
@@ -395,13 +395,13 @@ module TestGroupdate
     24.times do |n|
       expected[n] = n == 20 ? 1 : 0
     end
-    assert_equal expected, User.group_by_hour_of_day(:created_at, range: true).count(:created_at)
+    assert_equal expected, User.group_by_hour_of_day(:created_at, range: true).count
   end
 
   def test_zeros_excludes_end
     create_user "2013-05-02 00:00:00 UTC"
     expected = {
-      Time.parse("2013-05-01 00:00:00 UTC") => 0
+      utc.parse("2013-05-01 00:00:00 UTC") => 0
     }
     assert_equal expected, User.group_by_day(:created_at, range: Time.parse("2013-05-01 00:00:00 UTC")...Time.parse("2013-05-02 00:00:00 UTC")).count
   end
@@ -409,7 +409,7 @@ module TestGroupdate
   def test_zeros_previous_scope
     create_user "2013-05-01 00:00:00 UTC"
     expected = {
-      Time.parse("2013-05-01 00:00:00 UTC") => 0
+      utc.parse("2013-05-01 00:00:00 UTC") => 0
     }
     assert_equal expected, User.where("id = 0").group_by_day(:created_at, range: Time.parse("2013-05-01 00:00:00 UTC")..Time.parse("2013-05-01 23:59:59 UTC")).count
   end
@@ -417,7 +417,7 @@ module TestGroupdate
   def test_zeros_datetime
     create_user "2013-05-01 00:00:00 UTC"
     expected = {
-      Time.parse("2013-05-01 00:00:00 UTC") => 1
+      utc.parse("2013-05-01 00:00:00 UTC") => 1
     }
     assert_equal expected, User.group_by_day(:created_at, range: DateTime.parse("2013-05-01 00:00:00 UTC")..DateTime.parse("2013-05-01 00:00:00 UTC")).count
   end
@@ -432,9 +432,9 @@ module TestGroupdate
     create_user "2013-05-01 00:00:00 UTC"
     create_user "2013-05-03 00:00:00 UTC"
     expected = {
-      Time.parse("2013-05-01 00:00:00 UTC") => 1,
-      Time.parse("2013-05-02 00:00:00 UTC") => 0,
-      Time.parse("2013-05-03 00:00:00 UTC") => 1
+      utc.parse("2013-05-01 00:00:00 UTC") => 1,
+      utc.parse("2013-05-02 00:00:00 UTC") => 0,
+      utc.parse("2013-05-03 00:00:00 UTC") => 1
     }
     assert_equal expected, User.group_by_day(:created_at, range: true).count
   end
@@ -453,16 +453,20 @@ module TestGroupdate
 
   # misc
 
-  def test_order_day
-    assert_empty User.group_by_day(:created_at, series: false).order("day desc").limit(20).count
+  def test_order_hour_of_day
+    assert_equal 23, User.group_by_hour_of_day(:created_at).order("hour_of_day desc").count.keys.first
   end
 
-  def test_order_week
-    assert_empty User.group_by_week(:created_at, series: false).order("week asc").count
+  def test_order_hour_of_day_case
+    assert_equal 23, User.group_by_hour_of_day(:created_at).order("hour_of_day DESC").count.keys.first
   end
 
-  def test_order_hour_of_day
-    assert_empty User.group_by_hour_of_day(:created_at, series: false).order("hour_of_day desc").count
+  def test_order_hour_of_day_reverse
+    assert_equal 23, User.group_by_hour_of_day(:created_at).reverse_order.count.keys.first
+  end
+
+  def test_order_hour_of_day_order_reverse
+    assert_equal 0, User.group_by_hour_of_day(:created_at).order("hour_of_day desc").reverse_order.count.keys.first
   end
 
   def test_table_name
@@ -487,6 +491,52 @@ module TestGroupdate
     assert_equal expected, User.group_by_day(:created_at).where("created_at > ?", "2013-05-01 00:00:00 UTC").count
   end
 
+  def test_group_before
+    create_user "2013-05-01 00:00:00 UTC", 1
+    create_user "2013-05-02 00:00:00 UTC", 2
+    create_user "2013-05-03 00:00:00 UTC", 2
+    expected = {
+      [1, utc.parse("2013-05-01 00:00:00 UTC")] => 1,
+      [1, utc.parse("2013-05-02 00:00:00 UTC")] => 0,
+      [1, utc.parse("2013-05-03 00:00:00 UTC")] => 0,
+      [2, utc.parse("2013-05-01 00:00:00 UTC")] => 0,
+      [2, utc.parse("2013-05-02 00:00:00 UTC")] => 1,
+      [2, utc.parse("2013-05-03 00:00:00 UTC")] => 1
+    }
+    assert_equal expected, User.group(:score).group_by_day(:created_at).order(:score).count
+  end
+
+  def test_group_after
+    create_user "2013-05-01 00:00:00 UTC", 1
+    create_user "2013-05-02 00:00:00 UTC", 2
+    create_user "2013-05-03 00:00:00 UTC", 2
+    expected = {
+      [utc.parse("2013-05-01 00:00:00 UTC"), 1] => 1,
+      [utc.parse("2013-05-02 00:00:00 UTC"), 1] => 0,
+      [utc.parse("2013-05-03 00:00:00 UTC"), 1] => 0,
+      [utc.parse("2013-05-01 00:00:00 UTC"), 2] => 0,
+      [utc.parse("2013-05-02 00:00:00 UTC"), 2] => 1,
+      [utc.parse("2013-05-03 00:00:00 UTC"), 2] => 1
+    }
+    assert_equal expected, User.group_by_day(:created_at).group(:score).order(:score).count
+  end
+
+  def test_groupdate_multiple
+    create_user "2013-05-01 00:00:00 UTC", 1
+    expected = {
+      [utc.parse("2013-05-01 00:00:00 UTC"), utc.parse("2013-01-01 00:00:00 UTC")] => 1
+    }
+    assert_equal expected, User.group_by_day(:created_at).group_by_year(:created_at).count
+  end
+
+  def test_not_modified
+    create_user "2013-05-01 00:00:00 UTC"
+    expected = {utc.parse("2013-05-01 00:00:00 UTC") => 1}
+    relation = User.group_by_day(:created_at)
+    relation.where("created_at > ?", "2013-05-01 00:00:00 UTC")
+    assert_equal expected, relation.count
+  end
+
   def test_bad_method
     assert_raises(NoMethodError) { User.group_by_day(:created_at).no_such_method }
   end
@@ -502,31 +552,30 @@ module TestGroupdate
   # helpers
 
   def assert_result_time(method, expected, time_str, time_zone = false, options = {})
-    assert_result method, Time.parse(expected), time_str, time_zone, options
+    expected = {utc.parse(expected).in_time_zone(time_zone ? "Pacific Time (US & Canada)" : utc) => 1}
+    assert_equal expected, result(method, time_str, time_zone, options)
   end
 
   def assert_result(method, expected, time_str, time_zone = false, options = {})
+    assert_equal 1, result(method, time_str, time_zone, options)[expected]
+  end
+
+  def result(method, time_str, time_zone = false, options = {})
     create_user time_str
-    expected = expected.is_a?(Time) ? time_key(expected) : number_key(expected)
-    assert_equal ordered_hash({expected => 1}), User.send(:"group_by_#{method}", :created_at, options.merge(series: false, time_zone: time_zone ? "Pacific Time (US & Canada)" : nil)).order(method.to_s).count
-    assert_equal 1, User.send(:"group_by_#{method}", :created_at, options.merge(time_zone: time_zone ? "Pacific Time (US & Canada)" : nil)).count[expected]
+    User.send(:"group_by_#{method}", :created_at, options.merge(time_zone: time_zone ? "Pacific Time (US & Canada)" : nil)).count
   end
 
   def assert_zeros(method, created_at, keys, range_start, range_end, time_zone = nil, options = {})
     create_user created_at
     expected = {}
     keys.each_with_index do |key, i|
-      expected[Time.parse(key)] = i == 1 ? 1 : 0
+      expected[utc.parse(key).in_time_zone(time_zone ? "Pacific Time (US & Canada)" : utc)] = i == 1 ? 1 : 0
     end
     assert_equal expected, User.send(:"group_by_#{method}", :created_at, options.merge(time_zone: time_zone ? "Pacific Time (US & Canada)" : nil, range: Time.parse(range_start)..Time.parse(range_end))).count
   end
 
-  def ordered_hash(hash)
-    RUBY_VERSION =~ /1\.8/ ? hash.inject(ActiveSupport::OrderedHash.new){|h, (k, v)| h[k] = v; h } : hash
-  end
-
-  def create_user(created_at)
-    User.create! :name => "Andrew", :score => 1, :created_at => utc.parse(created_at)
+  def create_user(created_at, score = 1)
+    User.create! :name => "Andrew", :score => score, :created_at => utc.parse(created_at)
   end
 
   def utc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/activerecord31.gemfile
 - groupdate.gemspec
 - lib/groupdate.rb
 - lib/groupdate/order_hack.rb
@@ -117,7 +118,7 @@ files:
 - test/mysql_test.rb
 - test/postgresql_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: https://github.com/ankane/groupdate
 licenses:
 - MIT
 metadata: {}