groupdate2 4.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a798d7e082e32adf30f0fd07348f8fec6369006
+  data.tar.gz: 6fc8861fc493d524bc29b8be51ef030887d38dd4
+SHA512:
+  metadata.gz: 3c3459a9aa602d466dac261078dcd3dda23481e57b9cf1cf644699353f18e03af3924d0fda5f45887a6fad83d715ea7a0fc07f5772b30b0d4c34159fa0092bd3
+  data.tar.gz: fe47222def4bec06307c1930aff1c81b2bc6dd2819e9413d4df7e766345834d80271fa899e06a3f6655b53337e3864c68a32b2351f99432760f46731ec7b6c7d

data/CHANGELOG.md

@@ -0,0 +1,182 @@
+## 4.1.2
+
+- 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
+
+- Made column resolution consistent with `group`
+- Added support for `alias_attribute`
+
+## 4.1.0
+
+- 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
+
+- 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
+
+- Fixed incorrect range with `last` option near time change
+
+## 4.0.0
+
+- Custom calculation methods are supported by default - `groupdate_calculation_methods` is no longer needed
+
+Breaking changes
+
+- Dropped support for Rails < 4.2
+- Invalid options now throw an `ArgumentError`
+- `group_by` methods return an `ActiveRecord::Relation` instead of a `Groupdate::Series`
+- `week_start` now affects `day_of_week`
+- Removed support for `reverse_order` (was never supported in Rails 5)
+
+## 3.2.1
+
+- Added `minute_of_hour`
+- Added support for `unscoped`
+
+## 3.2.0
+
+- Added limited support for SQLite
+
+## 3.1.1
+
+- Fixed `current: false`
+- Fixed `last` with `group_by_quarter`
+- Raise `ArgumentError` when `last` option is not supported
+
+## 3.1.0
+
+- Better support for date columns with `time_zone: false`
+- Better date range handling for `range` option
+
+## 3.0.2
+
+- Fixed `group_by_period` with associations
+- Fixed `week_start` option for enumerables
+
+## 3.0.1
+
+- Added support for Redshift
+- Fix for infinite loop in certain cases for Rails 5
+
+## 3.0.0
+
+Breaking changes
+
+- `Date` objects are now returned for day, week, month, quarter, and year by default. Use `dates: false` for the previous behavior, or change this globally with `Groupdate.dates = false`.
+- 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
+
+- All tests green with `mysql` gem
+- Added support for decimal day start
+
+## 2.5.2
+
+- Added `dates` option to return dates for day, week, month, quarter, and year
+
+## 2.5.1
+
+- Added `group_by_quarter`
+- Added `default_value` option
+- Accept symbol for `format` option
+- Raise `ArgumentError` if no field specified
+- Added support for ActiveRecord 5 beta
+
+## 2.5.0
+
+- Added `group_by_period` method
+- Added `current` option
+- Raise `ArgumentError` if no block given to enumerable
+
+## 2.4.0
+
+- Added localization
+- Added `carry_forward` option
+- Added `series: false` option for arrays and hashes
+- Fixed issue w/ Brasilia Summer Time
+- Fixed issues w/ ActiveRecord 4.2
+
+## 2.3.0
+
+- 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
+
+- Fixed ActiveRecord 3 associations
+
+## 2.2.0
+
+- Added support for arrays and hashes
+
+## 2.1.1
+
+- Fixed format option with multiple groups
+- Better error message if time zone support is missing for MySQL
+
+## 2.1.0
+
+- Added last option
+- Added format option
+
+## 2.0.4
+
+- Added multiple groups
+- Added order
+- Subsequent methods no longer modify relation
+
+## 2.0.3
+
+- Implemented respond_to?
+
+## 2.0.2
+
+- where, joins, and includes no longer need to be before the group_by method
+
+## 2.0.1
+
+- Use time zone instead of UTC for results
+
+## 2.0.0
+
+- Returns entire series by default
+- Added day_start option
+- Better interface
+
+## 1.0.5
+
+- Added global time_zone option
+
+## 1.0.4
+
+- Added global week_start option
+- Fixed bug with NULL values and series
+
+## 1.0.3
+
+- Fixed deprecation warning when used with will_paginate
+- Fixed bug with DateTime series
+
+## 1.0.2
+
+- Added :start option for custom week start for group_by_week
+
+## 1.0.1
+
+- Fixed series for Rails < 3.2 and MySQL
+
+## 1.0.0
+
+- First major release

data/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Help
+
+We’re not able to provide support through GitHub Issues. If you’re looking for help with your code, try posting on [Stack Overflow](https://stackoverflow.com/).
+
+All features should be documented. If you don’t see a feature in the docs, assume it doesn’t exist.
+
+## Bugs
+
+Think you’ve discovered a bug?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "groupdate", github: "ankane/groupdate"
+```
+
+If the above steps don’t help, create an issue. Include:
+
+- Detailed steps to reproduce
+- Complete backtraces for exceptions
+
+## New Features
+
+If you’d like to discuss a new feature, create an issue and start the title with `[Idea]`.
+
+## Pull Requests
+
+Fork the project and create a pull request. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+- Add one or more tests if possible. Make sure existing tests pass with:
+
+```sh
+bundle exec rake test
+```
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+## Dev Setup
+
+On Mac:
+
+```sh
+# install and run PostgreSQL
+brew install postgresql
+brew services start postgresql
+
+# install and run MySQL
+brew install mysql
+brew services start mysql
+
+# create databases
+createdb groupdate_test
+mysql -u root -e "create database groupdate_test"
+mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
+
+# clone the repo and run the tests
+git clone https://github.com/ankane/groupdate.git
+cd groupdate
+bundle install
+bundle exec rake test
+
+# run a single test file
+ruby test/postgresql_test.rb
+```
+
+---
+
+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2019 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+# Groupdate2
+groupdate2 is an enhanced version of the beautiful [Groupdate](https://github.com/ankane/groupdate) gem.
+It adds MS SQL Server (2016 and above) support by using `(AT TIME ZONE)`.
+
+In JRuby, it relies on `activerecord-sqlserver-adapter` `jdbc-mode` branch, which is not ideal. The plan is using `activerecord-jdbcsqlserver-adapter` when JRuby 9.2+ is supported.
+
+# Version
+## 4.1.x
+This version corresponds to groupdate 4.1.2 with SQL Server support.
+
+## Installation
+Add this line to your application’s Gemfile:
+```ruby
+gem 'groupdate2'
+```
+

data/lib/groupdate/active_record.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require "groupdate/query_methods"
+require "groupdate/relation"
+
+ActiveRecord::Base.extend(Groupdate::QueryMethods)
+ActiveRecord::Relation.include(Groupdate::Relation)

data/lib/groupdate/enumerable.rb

@@ -0,0 +1,31 @@
+module Enumerable
+  Groupdate::PERIODS.each do |period|
+    define_method :"group_by_#{period}" do |*args, &block|
+      if block
+        Groupdate::Magic::Enumerable.group_by(self, period, args[0] || {}, &block)
+      elsif respond_to?(:scoping)
+        scoping { @klass.send(:"group_by_#{period}", *args, &block) }
+      else
+        raise ArgumentError, "no block given"
+      end
+    end
+  end
+
+  def group_by_period(*args, &block)
+    if block || !respond_to?(:scoping)
+      period = args[0]
+      options = args[1] || {}
+
+      options = options.dup
+      # 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)
+      else
+        raise ArgumentError, "Unpermitted period"
+      end
+    else
+      scoping { @klass.send(:group_by_period, *args, &block) }
+    end
+  end
+end

data/lib/groupdate/magic.rb

@@ -0,0 +1,164 @@
+require "i18n"
+
+module Groupdate
+  class Magic
+    attr_accessor :period, :options, :group_index
+
+    def initialize(period:, **options)
+      @period = period
+      @options = options
+
+      unknown_keywords = options.keys - [:day_start, :time_zone, :dates, :series, :week_start, :format, :locale, :range, :reverse]
+      raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
+
+      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
+      @time_zone ||= begin
+        time_zone = "Etc/UTC" if options[:time_zone] == false
+        time_zone ||= options[:time_zone] || Groupdate.time_zone || (Groupdate.time_zone == false && "Etc/UTC") || Time.zone || "Etc/UTC"
+        time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone]
+      end
+    end
+
+    def week_start
+      @week_start ||= [:mon, :tue, :wed, :thu, :fri, :sat, :sun].index((options[:week_start] || options[:start] || Groupdate.week_start).to_sym)
+    end
+
+    def day_start
+      @day_start ||= ((options[:day_start] || Groupdate.day_start).to_f * 3600).round
+    end
+
+    def series_builder
+      @series_builder ||=
+        SeriesBuilder.new(
+          **options,
+          period: period,
+          time_zone: time_zone,
+          day_start: day_start,
+          week_start: week_start
+        )
+    end
+
+    def time_range
+      series_builder.time_range
+    end
+
+    class Enumerable < Magic
+      def group_by(enum, &_block)
+        group = enum.group_by do |v|
+          v = yield(v)
+          raise ArgumentError, "Not a time" unless v.respond_to?(:to_time)
+          series_builder.round_time(v)
+        end
+        series_builder.generate(group, default_value: [], series_default: false)
+      end
+
+      def self.group_by(enum, period, options, &block)
+        Groupdate::Magic::Enumerable.new(period: period, **options).group_by(enum, &block)
+      end
+    end
+
+    class Relation < Magic
+      def initialize(**options)
+        super(**options.reject { |k, _| [:default_value, :carry_forward, :last, :current].include?(k) })
+        @options = options
+      end
+
+      def perform(relation, result, default_value:)
+        multiple_groups = relation.group_values.size > 1
+
+        check_nils(result, multiple_groups, relation)
+        result = cast_result(result, multiple_groups)
+
+        series_builder.generate(
+          result,
+          default_value: options.key?(:default_value) ? options[:default_value] : default_value,
+          multiple_groups: multiple_groups,
+          group_index: group_index
+        )
+      end
+
+      def cast_method
+        @cast_method ||= begin
+          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
+            lambda { |k| k.to_i }
+          else
+            utc = ActiveSupport::TimeZone["UTC"]
+            lambda { |k| (k.is_a?(String) || !k.respond_to?(:to_time) ? utc.parse(k.to_s) : k.to_time).in_time_zone(time_zone) }
+          end
+        end
+      end
+
+      def cast_result(result, multiple_groups)
+        new_result = {}
+        result.each do |k, v|
+          if multiple_groups
+            k[group_index] = cast_method.call(k[group_index])
+          else
+            k = cast_method.call(k)
+          end
+          new_result[k] = v
+        end
+        new_result
+      end
+
+      def time_zone_support?(relation)
+        if relation.connection.adapter_name =~ /mysql/i
+          # 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
+        end
+      end
+
+      def check_nils(result, multiple_groups, relation)
+        has_nils = multiple_groups ? (result.keys.first && result.keys.first[group_index].nil?) : result.key?(nil)
+        if has_nils
+          if time_zone_support?(relation)
+            raise Groupdate::Error, "Invalid query - be sure to use a date or time column"
+          else
+            raise Groupdate::Error, "Database missing time zone support for #{time_zone.tzinfo.name} - see https://github.com/ankane/groupdate#for-mysql"
+          end
+        end
+      end
+
+      def self.generate_relation(relation, field:, **options)
+        magic = Groupdate::Magic::Relation.new(**options)
+
+        # generate ActiveRecord relation
+        relation =
+          RelationBuilder.new(
+            relation,
+            column: field,
+            period: magic.period,
+            time_zone: magic.time_zone,
+            time_range: magic.time_range,
+            week_start: magic.week_start,
+            day_start: magic.day_start
+          ).generate
+
+        # add Groupdate info
+        magic.group_index = relation.group_values.size - 1
+        (relation.groupdate_values ||= []) << magic
+
+        relation
+      end
+
+      # allow any options to keep flexible for future
+      def self.process_result(relation, result, **options)
+        relation.groupdate_values.reverse.each do |gv|
+          result = gv.perform(relation, result, default_value: options[:default_value])
+        end
+        result
+      end
+    end
+  end
+end