groupdate 4.1.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bdc7848103a019e737a44e522ae42dcdb521c2ae136d9a52d1bafba795127d4
-  data.tar.gz: fccb9acee92d478d605ac8022e75173bccd4825ad5118a32d5aaaf3ef34c5349
+  metadata.gz: c661470fa1d3e85d4cff490be69845b175f5c095956ae674bda74e25e8713d1e
+  data.tar.gz: d2f4a2adb3dec4d73fdfc36302514c7c9c051766bb2703057b4074e3f480223c
 SHA512:
-  metadata.gz: 9ad47038f6ec8193721ebc56509c1bda0feff36ecb65a7c08e63859592d55de1387e3e0fb907ac55c16329bf8c275265492ab45b6d7217643203d1c94419d324
-  data.tar.gz: c53eb19f798e162eef984cf6dc32b8be7b3b9e40008dfed445653fae618ae0d1db65e1420db6896f254f5c48daf49f3e97e163c5ed41958e75ad98c7d77590a0
+  metadata.gz: f7e3309e4f687cb88839c23d07f6ad9dce57ee3f8f18c335d695d79fe4c0d7fe4e236d1362071180ba07daf3eb6edd62ace05f4d15e0f4392c2dc48e81139c17
+  data.tar.gz: 2b1682b63429bb482b01cb8f50a5bd0ab03a0677b9a806244c7d26054579611b1678f056c713d23278cd5cd3e8616def5c77d0897caccda7c5a6d297e4eaa863

data/CHANGELOG.md

@@ -1,25 +1,42 @@
-## 4.1.1
+## 4.3.0 (2019-12-26)
+
+- Fixed error with empty results in Ruby 2.7
+- Fixed deprecation warnings in Ruby 2.7
+- Deprecated positional arguments for time zone and range
+
+## 4.2.0 (2019-10-28)
+
+- Added `day_of_year`
+- Dropped support for Rails 4.2
+
+## 4.1.2 (2019-05-26)
+
+- Fixed error with empty data and `current: false`
+- Fixed error in time zone check for Rails < 5.2
+- Prevent infinite loop with endless ranges
+
+## 4.1.1 (2018-12-11)
 
 - Made column resolution consistent with `group`
 - Added support for `alias_attribute`
 
-## 4.1.0
+## 4.1.0 (2018-11-04)
 
 - Many performance improvements
 - Added check for consistent time zone info
 - Fixed error message for invalid queries with MySQL and SQLite
 - Fixed issue with enumerable methods ignoring nils
 
-## 4.0.2
+## 4.0.2 (2018-10-15)
 
 - Make `current` option work without `last`
 - Fixed default value for `maximum`, `minimum`, and `average` (periods with no results now return `nil` instead of `0`, pass `default_value: 0` for previous behavior)
 
-## 4.0.1
+## 4.0.1 (2018-05-03)
 
 - Fixed incorrect range with `last` option near time change
 
-## 4.0.0
+## 4.0.0 (2018-02-21)
 
 - Custom calculation methods are supported by default - `groupdate_calculation_methods` is no longer needed
 
@@ -31,37 +48,37 @@ Breaking changes
 - `week_start` now affects `day_of_week`
 - Removed support for `reverse_order` (was never supported in Rails 5)
 
-## 3.2.1
+## 3.2.1 (2018-02-21)
 
 - Added `minute_of_hour`
 - Added support for `unscoped`
 
-## 3.2.0
+## 3.2.0 (2017-01-30)
 
 - Added limited support for SQLite
 
-## 3.1.1
+## 3.1.1 (2016-10-25)
 
 - Fixed `current: false`
 - Fixed `last` with `group_by_quarter`
 - Raise `ArgumentError` when `last` option is not supported
 
-## 3.1.0
+## 3.1.0 (2016-10-22)
 
 - Better support for date columns with `time_zone: false`
 - Better date range handling for `range` option
 
-## 3.0.2
+## 3.0.2 (2016-08-09)
 
 - Fixed `group_by_period` with associations
 - Fixed `week_start` option for enumerables
 
-## 3.0.1
+## 3.0.1 (2016-07-13)
 
 - Added support for Redshift
 - Fix for infinite loop in certain cases for Rails 5
 
-## 3.0.0
+## 3.0.0 (2016-05-30)
 
 Breaking changes
 
@@ -69,16 +86,16 @@ Breaking changes
 - Array and hash methods no longer return the entire series by default. Use `series: true` for the previous behavior.
 - The `series: false` option now returns the correct types and order, and plays nicely with other options.
 
-## 2.5.3
+## 2.5.3 (2016-04-28)
 
 - All tests green with `mysql` gem
 - Added support for decimal day start
 
-## 2.5.2
+## 2.5.2 (2016-02-16)
 
 - Added `dates` option to return dates for day, week, month, quarter, and year
 
-## 2.5.1
+## 2.5.1 (2016-02-03)
 
 - Added `group_by_quarter`
 - Added `default_value` option
@@ -86,13 +103,13 @@ Breaking changes
 - Raise `ArgumentError` if no field specified
 - Added support for ActiveRecord 5 beta
 
-## 2.5.0
+## 2.5.0 (2015-09-29)
 
 - Added `group_by_period` method
 - Added `current` option
 - Raise `ArgumentError` if no block given to enumerable
 
-## 2.4.0
+## 2.4.0 (2014-12-28)
 
 - Added localization
 - Added `carry_forward` option
@@ -100,77 +117,77 @@ Breaking changes
 - Fixed issue w/ Brasilia Summer Time
 - Fixed issues w/ ActiveRecord 4.2
 
-## 2.3.0
+## 2.3.0 (2014-08-31)
 
 - Raise error when ActiveRecord::Base.default_timezone is not `:utc`
 - Added `day_of_month`
 - Added `month_of_year`
 - Do not quote column name
 
-## 2.2.1
+## 2.2.1 (2014-06-23)
 
 - Fixed ActiveRecord 3 associations
 
-## 2.2.0
+## 2.2.0 (2014-06-22)
 
 - Added support for arrays and hashes
 
-## 2.1.1
+## 2.1.1 (2014-05-17)
 
 - Fixed format option with multiple groups
 - Better error message if time zone support is missing for MySQL
 
-## 2.1.0
+## 2.1.0 (2014-03-16)
 
 - Added last option
 - Added format option
 
-## 2.0.4
+## 2.0.4 (2014-03-12)
 
 - Added multiple groups
 - Added order
 - Subsequent methods no longer modify relation
 
-## 2.0.3
+## 2.0.3 (2014-03-11)
 
 - Implemented respond_to?
 
-## 2.0.2
+## 2.0.2 (2014-03-11)
 
 - where, joins, and includes no longer need to be before the group_by method
 
-## 2.0.1
+## 2.0.1 (2014-03-07)
 
 - Use time zone instead of UTC for results
 
-## 2.0.0
+## 2.0.0 (2014-03-07)
 
 - Returns entire series by default
 - Added day_start option
 - Better interface
 
-## 1.0.5
+## 1.0.5 (2014-03-06)
 
 - Added global time_zone option
 
-## 1.0.4
+## 1.0.4 (2013-07-20)
 
 - Added global week_start option
 - Fixed bug with NULL values and series
 
-## 1.0.3
+## 1.0.3 (2013-07-05)
 
 - Fixed deprecation warning when used with will_paginate
 - Fixed bug with DateTime series
 
-## 1.0.2
+## 1.0.2 (2013-06-10)
 
 - Added :start option for custom week start for group_by_week
 
-## 1.0.1
+## 1.0.1 (2013-06-03)
 
 - Fixed series for Rails < 3.2 and MySQL
 
-## 1.0.0
+## 1.0.0 (2013-05-15)
 
 - First major release

data/CONTRIBUTING.md

@@ -57,7 +57,7 @@ brew services start mysql
 
 # create databases
 createdb groupdate_test
-mysql -u root -e "create database groupdate_test"
+mysqladmin create groupdate_test
 mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
 
 # clone the repo and run the tests

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2018 Andrew Kane
+Copyright (c) 2013-2019 Andrew Kane
 
 MIT License
 

data/README.md

@@ -17,7 +17,17 @@ Supports PostgreSQL, MySQL, and Redshift, plus arrays and hashes (and limited su
 
 [![Build Status](https://travis-ci.org/ankane/groupdate.svg?branch=master)](https://travis-ci.org/ankane/groupdate)
 
-## Get Started
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'groupdate'
+```
+
+For MySQL and SQLite, also follow [these instructions](#additional-instructions).
+
+## Getting Started
 
 ```ruby
 User.group_by_day(:created_at).count
@@ -46,9 +56,10 @@ and
 - hour_of_day
 - day_of_week (Sunday = 0, Monday = 1, etc)
 - day_of_month
+- day_of_year
 - month_of_year
 
-Use it anywhere you can use `group`. Works with `count`, `sum`, `minimum`, `maximum`, and `average`. For `median`, check out [ActiveMedian](https://github.com/ankane/active_median). For other aggregate functions, including multiple together, check out [CalculateAll](https://github.com/codesnik/calculate-all).
+Use it anywhere you can use `group`. Works with `count`, `sum`, `minimum`, `maximum`, and `average`. For `median`, check out [ActiveMedian](https://github.com/ankane/active_median).
 
 ### Time Zones
 
@@ -215,23 +226,23 @@ Supports the same options as above
 users.group_by_day(time_zone: time_zone) { |u| u.created_at }
 ```
 
-Count
+Get the entire series with:
 
 ```ruby
-Hash[ users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.size] } ]
+users.group_by_day(series: true) { |u| u.created_at }
 ```
 
-## Installation
-
-Add this line to your application’s Gemfile:
+Count
 
 ```ruby
-gem 'groupdate'
+users.group_by_day { |u| u.created_at }.map { |k, v| [k, v.count] }.to_h
 ```
 
-#### For MySQL
+## Additional Instructions
 
-[Time zone support](https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html) must be installed on the server.
+### For MySQL
+
+[Time zone support](https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html) must be installed on the server.
 
 ```sh
 mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
@@ -247,7 +258,7 @@ SELECT CONVERT_TZ(NOW(), '+00:00', 'Pacific/Honolulu');
 
 It should return the time instead of `NULL`.
 
-#### For SQLite
+### For SQLite
 
 Groupdate has limited support for SQLite.
 
@@ -301,3 +312,5 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/groupdate/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing, check out the [Contributing Guide](CONTRIBUTING.md).

data/lib/groupdate/enumerable.rb

@@ -1,31 +1,32 @@
 module Enumerable
   Groupdate::PERIODS.each do |period|
-    define_method :"group_by_#{period}" do |*args, &block|
+    define_method :"group_by_#{period}" do |*args, **options, &block|
       if block
-        Groupdate::Magic::Enumerable.group_by(self, period, args[0] || {}, &block)
+        # TODO throw error in Groupdate 5
+        warn "[groupdate] positional arguments are deprecated" if args.any?
+        Groupdate::Magic::Enumerable.group_by(self, period, (args[0] || {}).merge(options), &block)
       elsif respond_to?(:scoping)
-        scoping { @klass.send(:"group_by_#{period}", *args, &block) }
+        scoping { @klass.send(:"group_by_#{period}", *args, **options, &block) }
       else
         raise ArgumentError, "no block given"
       end
     end
   end
 
-  def group_by_period(*args, &block)
+  def group_by_period(period, *args, **options, &block)
     if block || !respond_to?(:scoping)
-      period = args[0]
-      options = args[1] || {}
-
-      options = options.dup
+      # TODO throw error in Groupdate 5
+      warn "[groupdate] positional arguments are deprecated" if args.any?
+      options = (args[0] || {}).merge(options)
       # to_sym is unsafe on user input, so convert to strings
       permitted_periods = ((options.delete(:permit) || Groupdate::PERIODS).map(&:to_sym) & Groupdate::PERIODS).map(&:to_s)
       if permitted_periods.include?(period.to_s)
-        send("group_by_#{period}", options, &block)
+        send("group_by_#{period}", **options, &block)
       else
         raise ArgumentError, "Unpermitted period"
       end
     else
-      scoping { @klass.send(:group_by_period, *args, &block) }
+      scoping { @klass.send(:group_by_period, period, *args, **options, &block) }
     end
   end
 end

data/lib/groupdate/magic.rb

@@ -13,6 +13,7 @@ module Groupdate
 
       raise Groupdate::Error, "Unrecognized time zone" unless time_zone
       raise Groupdate::Error, "Unrecognized :week_start option" if period == :week && !week_start
+      raise Groupdate::Error, "Cannot use endless range for :range option" if options[:range].is_a?(Range) && !options[:range].end
     end
 
     def time_zone
@@ -86,7 +87,7 @@ module Groupdate
           case period
           when :day_of_week
             lambda { |k| (k.to_i - 1 - week_start) % 7 }
-          when :hour_of_day, :day_of_month, :month_of_year, :minute_of_hour
+          when :hour_of_day, :day_of_month, :day_of_year, :month_of_year, :minute_of_hour
             lambda { |k| k.to_i }
           else
             utc = ActiveSupport::TimeZone["UTC"]
@@ -110,7 +111,8 @@ module Groupdate
 
       def time_zone_support?(relation)
         if relation.connection.adapter_name =~ /mysql/i
-          sql = relation.send(:sanitize_sql_array, ["SELECT CONVERT_TZ(NOW(), '+00:00', ?)", time_zone.tzinfo.name])
+          # need to call klass for Rails < 5.2
+          sql = relation.klass.send(:sanitize_sql_array, ["SELECT CONVERT_TZ(NOW(), '+00:00', ?)", time_zone.tzinfo.name])
           !relation.connection.select_all(sql).first.values.first.nil?
         else
           true

data/lib/groupdate/query_methods.rb

@@ -2,6 +2,8 @@ module Groupdate
   module QueryMethods
     Groupdate::PERIODS.each do |period|
       define_method :"group_by_#{period}" do |field, time_zone = nil, range = nil, **options|
+        warn "[groupdate] positional arguments for time zone and range are deprecated" if time_zone || range
+
         Groupdate::Magic::Relation.generate_relation(self,
           period: period,
           field: field,

data/lib/groupdate/relation_builder.rb

@@ -31,6 +31,8 @@ module Groupdate
           case period
           when :day_of_week
             ["DAYOFWEEK(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?)) - 1", time_zone]
+          when :day_of_year
+            ["DAYOFYEAR(CONVERT_TZ(DATE_SUB(#{column}, INTERVAL #{day_start} second), '+00:00', ?))", time_zone]
           when :hour_of_day
             ["(EXTRACT(HOUR from CONVERT_TZ(#{column}, '+00:00', ?)) + 24 - #{day_start / 3600}) % 24", time_zone]
           when :minute_of_hour
@@ -66,6 +68,8 @@ module Groupdate
           case period
           when :day_of_week
             ["EXTRACT(DOW from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :day_of_year
+            ["EXTRACT(DOY from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
           when :hour_of_day
             ["EXTRACT(HOUR from #{column}::timestamptz AT TIME ZONE ? - INTERVAL '#{day_start} second')::integer", time_zone]
           when :minute_of_hour
@@ -99,6 +103,8 @@ module Groupdate
                 "%d"
               when :month_of_year
                 "%m"
+              when :day_of_year
+                "%j"
               when :second
                 "%Y-%m-%d %H:%M:%S UTC"
               when :minute
@@ -127,6 +133,8 @@ module Groupdate
             ["EXTRACT(MINUTE from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
           when :day_of_month
             ["EXTRACT(DAY from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
+          when :day_of_year
+            ["EXTRACT(DOY from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
           when :month_of_year
             ["EXTRACT(MONTH from CONVERT_TIMEZONE(?, #{column}::timestamp) - INTERVAL '#{day_start} second')::integer", time_zone]
           when :week # start on Sunday, not Redshift default Monday

data/lib/groupdate/series_builder.rb

@@ -79,6 +79,8 @@ module Groupdate
           time.day
         when :month_of_year
           time.month
+        when :day_of_year
+          time.yday
         else
           raise Groupdate::Error, "Invalid period"
         end
@@ -141,6 +143,8 @@ module Groupdate
         0..59
       when :day_of_month
         1..31
+      when :day_of_year
+        1..366
       when :month_of_year
         1..12
       else
@@ -158,14 +162,14 @@ module Groupdate
               end
 
             tr = sorted_keys.first..sorted_keys.last
-            if options[:current] == false && round_time(now) >= tr.last
+            if options[:current] == false && sorted_keys.any? && round_time(now) >= tr.last
               tr = tr.first...round_time(now)
             end
             tr
           end
 
-        if time_range.first
-          series = [round_time(time_range.first)]
+        if time_range.begin
+          series = [round_time(time_range.begin)]
 
           if period == :quarter
             step = 3.months

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "4.1.1"
+  VERSION = "4.3.0"
 end

data/lib/groupdate.rb

@@ -8,7 +8,7 @@ require "groupdate/magic"
 module Groupdate
   class Error < RuntimeError; end
 
-  PERIODS = [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week, :hour_of_day, :minute_of_hour, :day_of_month, :month_of_year]
+  PERIODS = [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week, :hour_of_day, :minute_of_hour, :day_of_month, :day_of_year, :month_of_year]
   METHODS = PERIODS.map { |v| :"group_by_#{v}" } + [:group_by_period]
 
   mattr_accessor :week_start, :day_start, :time_zone, :dates

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2019-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,30 +84,30 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -153,15 +153,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The simplest way to group temporal data