groupdate 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e0f474a6785462e83ab5811c44e54bc71689ce
-  data.tar.gz: 7b66609e83996472c4e501f1502d4b76f73f4908
+  metadata.gz: 0b555424def0887e8b0ab933f26c84844a6e9b8b
+  data.tar.gz: c16d375c965c0d289ffc8476435b47b61e09ebf2
 SHA512:
-  metadata.gz: 260e9bf32e334238baa95e59b085418aedc824046312699d69827f6b54a736287d68a70a87bb22a62f936b5336efe0f60012c59e1d1d9babc0c9b5434702767c
-  data.tar.gz: 5fe2dab3320cb3b0b119191440a490d967a12174290afa872d499858173c9a0c099867fff28e018369a3a8d8bc0e1afd2bc532ebcfa70c649e6dbbc4ae7a79f3
+  metadata.gz: 835b67dacd82ce1fde549847fcf2647cad712ef75a14841c13b42d06ce95f606c4f5db124f0795dedace821d9c0113211b6d4c011a9c29cfc717fe2cbbc4e643
+  data.tar.gz: 3cb677877505d1f09ad3067fbc0777f4db8d0330429710d43f38544b0782dec7ce1c98f7f9d488c947f9c8de4bb638fced6475e98514c06c6a4ad72891852a01

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.1
+  - 2.2
   - jruby
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.5.0
+
+- Added `group_by_period` method
+- Added `current` option
+- Raise `ArgumentError` if no block given to enumerable
+
 ## 2.4.0
 
 - Added localization

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in groupdate.gemspec
 gemspec

data/README.md

@@ -15,7 +15,7 @@ Works with Rails 3.1+
 
 Supports PostgreSQL and MySQL, plus arrays and hashes
 
-[![Build Status](https://travis-ci.org/ankane/groupdate.png)](https://travis-ci.org/ankane/groupdate)
+[![Build Status](https://travis-ci.org/ankane/groupdate.svg?branch=master)](https://travis-ci.org/ankane/groupdate)
 
 :cupid: Goes hand in hand with [Chartkick](http://ankane.github.io/chartkick/)
 
@@ -115,6 +115,12 @@ To get the most recent time periods, use:
 User.group_by_week(:created_at, last: 8).count # last 8 weeks
 ```
 
+To exclude the current period, use:
+
+```ruby
+User.group_by_week(:created_at, last: 8, current: false).count
+```
+
 ### Order
 
 You can order in descending order with:
@@ -129,32 +135,61 @@ or
 User.group_by_day(:created_at).order("day desc").count
 ```
 
-### Pretty Keys
+### Format
 
 To get keys in a different format, use:
 
 ```ruby
-User.group_by_hour_of_day(:created_at, format: "%l %P").count.keys.first # 12 am
+User.group_by_day(:created_at, format: "%b %-e, %Y").count
+# {
+#   "Jan 1, 2015" => 10
+#   "Jan 2, 2015" => 12
+# }
+```
+
+or
+
+```ruby
+User.group_by_hour_of_day(:created_at, format: "%-l %P").count
+# {
+#    "12 am" => 15,
+#    "1 am"  => 11
+#    ...
+# }
 ```
 
 Takes a `String`, which is passed to [strftime](http://strfti.me/), or a `Proc`.  You can pass a locale with the `locale` option.
 
+### Dynamic Grouping
+
+```ruby
+User.group_by_period(:day, :created_at).count
+```
+
+Limit groupings with the `permit` option.
+
+```ruby
+User.group_by_period(params[:period], :created_at, permit: %w[day week]).count
+```
+
+Raises an `ArgumentError` for unpermitted periods.
+
 ## Arrays and Hashes
 
 ```ruby
-users.group_by_day{|u| u.created_at } # or group_by_day(&:created_at)
+users.group_by_day { |u| u.created_at } # or group_by_day(&:created_at)
 ```
 
 Supports the same options as above
 
 ```ruby
-users.group_by_day(time_zone: time_zone){|u| u.created_at }
+users.group_by_day(time_zone: time_zone) { |u| u.created_at }
 ```
 
 Count
 
 ```ruby
-Hash[ users.group_by_day{|u| u.created_at }.map{|k, v| [k, v.size] } ]
+Hash[ users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.size] } ]
 ```
 
 ## Installation

data/groupdate.gemspec

@@ -1,19 +1,19 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'groupdate/version'
+require "groupdate/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "groupdate"
   spec.version       = Groupdate::VERSION
   spec.authors       = ["Andrew Kane"]
   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.description   = "The simplest way to group temporal data"
+  spec.summary       = "The simplest way to group temporal data"
   spec.homepage      = "https://github.com/ankane/groupdate"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency "activerecord-jdbcmysql-adapter"
   else
     spec.add_development_dependency "pg"
-    spec.add_development_dependency "mysql2"
+    spec.add_development_dependency "mysql2", "~> 0.3.20"
   end
 end

data/lib/groupdate.rb

@@ -5,7 +5,7 @@ require "groupdate/magic"
 
 module Groupdate
   FIELDS = [:second, :minute, :hour, :day, :week, :month, :year, :day_of_week, :hour_of_day, :day_of_month, :month_of_year]
-  METHODS = FIELDS.map{|v| :"group_by_#{v}" }
+  METHODS = FIELDS.map { |v| :"group_by_#{v}" }
 
   mattr_accessor :week_start, :day_start, :time_zone
   self.week_start = :sun

data/lib/groupdate/active_record.rb

@@ -7,8 +7,7 @@ ActiveRecord::Base.send(:extend, Groupdate::Scopes)
 
 module ActiveRecord
   class Relation
-
-    if ActiveRecord::VERSION::MAJOR == 3 and ActiveRecord::VERSION::MINOR < 2
+    if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR < 2
 
       def method_missing_with_hack(method, *args, &block)
         if Groupdate::METHODS.include?(method)
@@ -20,7 +19,6 @@ module ActiveRecord
       alias_method_chain :method_missing, :hack
 
     end
-
   end
 end
 
@@ -38,7 +36,6 @@ end
 # https://github.com/rails/rails/issues/7121
 module ActiveRecord
   module Calculations
-
     private
 
     def column_alias_for_with_hack(*keys)
@@ -49,6 +46,5 @@ module ActiveRecord
       end
     end
     alias_method_chain :column_alias_for, :hack
-
   end
 end

data/lib/groupdate/enumerable.rb

@@ -1,9 +1,21 @@
 module Enumerable
-
   Groupdate::FIELDS.each do |field|
     define_method :"group_by_#{field}" do |options = {}, &block|
-      Groupdate::Magic.new(field, options).group_by(self, &block)
+      if block
+        Groupdate::Magic.new(field, options).group_by(self, &block)
+      else
+        raise ArgumentError, "no block given"
+      end
     end
   end
 
+  def group_by_period(period, options = {}, &block)
+    # to_sym is unsafe on user input, so convert to strings
+    permitted_periods = ((options[:permit] || Groupdate::FIELDS).map(&:to_sym) & Groupdate::FIELDS).map(&:to_s)
+    if permitted_periods.include?(period.to_s)
+      send("group_by_#{period}", options, &block)
+    else
+      raise ArgumentError, "Unpermitted period"
+    end
+  end
 end

data/lib/groupdate/magic.rb

@@ -8,17 +8,17 @@ module Groupdate
       @field = field
       @options = options
 
-      if !time_zone
+      unless time_zone
         raise "Unrecognized time zone"
       end
 
-      if field == :week and !week_start
+      if field == :week && !week_start
         raise "Unrecognized :week_start option"
       end
     end
 
-    def group_by(enum, &block)
-      group = enum.group_by{|v| v = yield(v); v ? round_time(v) : nil }
+    def group_by(enum, &_block)
+      group = enum.group_by { |v| v = yield(v); v ? round_time(v) : nil }
       if options[:series] == false
         group
       else
@@ -108,7 +108,7 @@ module Groupdate
 
     def perform(relation, method, *args, &block)
       # undo reverse since we do not want this to appear in the query
-      reverse = relation.reverse_order_value
+      reverse = relation.send(:reverse_order_value)
       if reverse
         relation = relation.except(:reverse_order)
       end
@@ -127,15 +127,15 @@ module Groupdate
       cast_method =
         case field
         when :day_of_week, :hour_of_day, :day_of_month, :month_of_year
-          lambda{|k| k.to_i }
+          lambda { |k| k.to_i }
         else
           utc = ActiveSupport::TimeZone["UTC"]
-          lambda{|k| (k.is_a?(String) ? utc.parse(k) : k.to_time).in_time_zone(time_zone) }
+          lambda { |k| (k.is_a?(String) ? utc.parse(k) : k.to_time).in_time_zone(time_zone) }
         end
 
       count =
         begin
-          Hash[ relation.send(method, *args, &block).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] } ]
+          Hash[relation.send(method, *args, &block).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] }]
         rescue NoMethodError
           raise "Be sure to install time zone support - https://github.com/ankane/groupdate#for-mysql"
         end
@@ -163,10 +163,11 @@ module Groupdate
     def time_range
       @time_range ||= begin
         time_range = options[:range]
-        if !time_range and options[:last]
+        if !time_range && options[:last]
           step = 1.send(field) if 1.respond_to?(field)
           if step
             now = Time.now
+            now -= step if options[:current] == false
             time_range = round_time(now - (options[:last].to_i - 1).send(field))..now
           end
         end
@@ -196,7 +197,7 @@ module Groupdate
               # use first and last values
               sorted_keys =
                 if multiple_groups
-                  count.keys.map{|k| k[@group_index] }.sort
+                  count.keys.map { |k| k[@group_index] }.sort
                 else
                   count.keys.sort
                 end
@@ -208,26 +209,29 @@ module Groupdate
 
             step = 1.send(field)
 
-            while (next_step = round_time(series.last + step)) and time_range.cover?(next_step)
+            while (next_step = round_time(series.last + step)) && time_range.cover?(next_step)
               series << next_step
             end
 
-            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
+            series
           else
             []
           end
         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
+
       # reversed above if multiple groups
-      if !multiple_groups and reverse
+      if !multiple_groups && reverse
         series = series.to_a.reverse
       end
 
@@ -253,7 +257,7 @@ module Groupdate
             end
           end
         else
-          lambda{|k| k }
+          lambda { |k| k }
         end
 
       value = 0
@@ -302,6 +306,5 @@ module Groupdate
     def activerecord42?
       ActiveRecord::VERSION::STRING.starts_with?("4.2.")
     end
-
   end
 end

data/lib/groupdate/scopes.rb

@@ -1,6 +1,5 @@
 module Groupdate
   module Scopes
-
     Groupdate::FIELDS.each do |field|
       define_method :"group_by_#{field}" do |*args|
         args = args.dup
@@ -12,5 +11,14 @@ module Groupdate
       end
     end
 
+    def group_by_period(period, field, options = {})
+      # to_sym is unsafe on user input, so convert to strings
+      permitted_periods = ((options[:permit] || Groupdate::FIELDS).map(&:to_sym) & Groupdate::FIELDS).map(&:to_s)
+      if permitted_periods.include?(period.to_s)
+        send("group_by_#{period}", field, options)
+      else
+        raise ArgumentError, "Unpermitted period"
+      end
+    end
   end
 end

data/lib/groupdate/series.rb

@@ -12,7 +12,7 @@ module Groupdate
       # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
       if ActiveRecord::Calculations.method_defined?(method)
         magic.perform(relation, method, *args, &block)
-      elsif @relation.respond_to?(method)
+      elsif @relation.respond_to?(method, true)
         Groupdate::Series.new(magic, relation.send(method, *args, &block))
       else
         super
@@ -22,6 +22,5 @@ module Groupdate
     def respond_to?(method, include_all = false)
       ActiveRecord::Calculations.method_defined?(method) || relation.respond_to?(method) || super
     end
-
   end
 end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/test/enumerable_test.rb

@@ -14,8 +14,11 @@ class TestEnumerable < Minitest::Test
     assert_equal expected, [user_a, user_b].group_by_month(&:created_at)
   end
 
-  def call_method(method, field, options)
-    Hash[ User.all.to_a.send(:"group_by_#{method}", options){|u| u.send(field) }.map{|k, v| [k, v.size] } ]
+  def test_no_block
+    assert_raises(ArgumentError) { [].group_by_day(:created_at) }
   end
 
+  def call_method(method, field, options)
+    Hash[User.all.to_a.group_by_period(method, options) { |u| u.send(field) }.map { |k, v| [k, v.size] }]
+  end
 end

data/test/mysql_test.rb

@@ -7,5 +7,4 @@ class TestMysql < Minitest::Test
     super
     User.establish_connection :adapter => "mysql2", :database => "groupdate_test", :username => "root"
   end
-
 end

data/test/postgresql_test.rb

@@ -7,5 +7,4 @@ class TestPostgresql < Minitest::Test
     super
     User.establish_connection :adapter => "postgresql", :database => "groupdate_test"
   end
-
 end

data/test/test_helper.rb

@@ -24,10 +24,8 @@ end
 
 # i18n
 I18n.enforce_available_locales = true
-I18n.backend.store_translations :de, {
-  :date => {
-    :abbr_month_names => %w(Jan Feb Mar Apr Mai Jun Jul Aug Sep Okt Nov Dez).unshift(nil)
-  }
+I18n.backend.store_translations :de, :date => {
+  :abbr_month_names => %w(Jan Feb Mar Apr Mai Jun Jul Aug Sep Okt Nov Dez).unshift(nil)
 }
 
 # migrations
@@ -47,7 +45,6 @@ I18n.backend.store_translations :de, {
 end
 
 module TestGroupdate
-
   def setup
     Groupdate.week_start = :sun
   end
@@ -55,7 +52,7 @@ module TestGroupdate
   # second
 
   def test_second_end_of_second
-    if ActiveRecord::Base.connection.adapter_name == "Mysql2" and ActiveRecord::VERSION::STRING.starts_with?("4.2.")
+    if ActiveRecord::Base.connection.adapter_name == "Mysql2" && ActiveRecord::VERSION::STRING.starts_with?("4.2.")
       skip # no millisecond precision
     else
       assert_result_time :second, "2013-05-03 00:00:00 UTC", "2013-05-03 00:00:00.999"
@@ -639,6 +636,29 @@ module TestGroupdate
     assert_equal expected, User.group_by_day(:created_at).group(:score).order(:score).count
   end
 
+  def test_group_day_of_week
+    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, 0] => 0,
+      [1, 1] => 0,
+      [1, 2] => 0,
+      [1, 3] => 1,
+      [1, 4] => 0,
+      [1, 5] => 0,
+      [1, 6] => 0,
+      [2, 0] => 0,
+      [2, 1] => 0,
+      [2, 2] => 0,
+      [2, 3] => 0,
+      [2, 4] => 1,
+      [2, 5] => 1,
+      [2, 6] => 0
+    }
+    assert_equal expected, User.group(:score).group_by_day_of_week(:created_at).count
+  end
+
   def test_groupdate_multiple
     create_user "2013-05-01 00:00:00 UTC", 1
     expected = {
@@ -668,16 +688,26 @@ module TestGroupdate
   end
 
   def test_last
-    create_user "2011-05-01 00:00:00 UTC"
-    create_user "2013-05-01 00:00:00 UTC"
+    create_user "2012-05-01 00:00:00 UTC"
+    create_user "2014-05-01 00:00:00 UTC"
     expected = {
-      utc.parse("2012-01-01 00:00:00 UTC") => 0,
-      utc.parse("2013-01-01 00:00:00 UTC") => 1,
-      utc.parse("2014-01-01 00:00:00 UTC") => 0
+      utc.parse("2013-01-01 00:00:00 UTC") => 0,
+      utc.parse("2014-01-01 00:00:00 UTC") => 1,
+      utc.parse("2015-01-01 00:00:00 UTC") => 0
     }
     assert_equal expected, User.group_by_year(:created_at, last: 3).count
   end
 
+  def test_current
+    create_user "2012-05-01 00:00:00 UTC"
+    create_user "2014-05-01 00:00:00 UTC"
+    expected = {
+      utc.parse("2013-01-01 00:00:00 UTC") => 0,
+      utc.parse("2014-01-01 00:00:00 UTC") => 1
+    }
+    assert_equal expected, User.group_by_year(:created_at, last: 2, current: false).count
+  end
+
   def test_format_day
     create_user "2014-03-01 00:00:00 UTC"
     assert_format :day, "March 1, 2014", "%B %-e, %Y"
@@ -742,6 +772,32 @@ module TestGroupdate
     assert_equal ({[1, "Sun"] => 1}), User.group(:score).group_by_week(:created_at, format: "%a").count
   end
 
+  # permit
+
+  def test_permit
+    assert_raises(ArgumentError, "Unpermitted period") { User.group_by_period(:day, :created_at, permit: %w[week]).count }
+  end
+
+  def test_permit_bad_period
+    assert_raises(ArgumentError, "Unpermitted period") { User.group_by_period(:bad_period, :created_at).count }
+  end
+
+  def test_permit_symbol_symbols
+    assert_equal ({}), User.group_by_period(:day, :created_at, permit: [:day]).count
+  end
+
+  def test_permit_string_symbols
+    assert_equal ({}), User.group_by_period("day", :created_at, permit: [:day]).count
+  end
+
+  def test_permit_symbol_strings
+    assert_equal ({}), User.group_by_period(:day, :created_at, permit: %w[day]).count
+  end
+
+  def test_permit_string_strings
+    assert_equal ({}), User.group_by_period("day", :created_at, permit: %w[day]).count
+  end
+
   # associations
 
   def test_associations
@@ -752,12 +808,10 @@ module TestGroupdate
   # activerecord default_timezone option
 
   def test_default_timezone_local
-    begin
-      User.default_timezone = :local
-      assert_raises(RuntimeError){ User.group_by_day(:created_at).count }
-    ensure
-      User.default_timezone = :utc
-    end
+    User.default_timezone = :local
+    assert_raises(RuntimeError) { User.group_by_day(:created_at).count }
+  ensure
+    User.default_timezone = :utc
   end
 
   # Brasilia Summer Time
@@ -812,7 +866,7 @@ module TestGroupdate
   end
 
   def call_method(method, field, options)
-    User.send(:"group_by_#{method}", field, options).count
+    User.group_by_period(method, field, options).count
   end
 
   def create_user(created_at, score = 1)
@@ -830,5 +884,4 @@ module TestGroupdate
   def teardown
     User.delete_all
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,16 +98,16 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.20
 description: The simplest way to group temporal data
 email:
 - acekane1@gmail.com
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: The simplest way to group temporal data
@@ -168,3 +168,4 @@ test_files:
 - test/mysql_test.rb
 - test/postgresql_test.rb
 - test/test_helper.rb
+has_rdoc: