groupdate 3.2.0 → 6.2.1

data/lib/groupdate/series_builder.rb

@@ -0,0 +1,304 @@
+module Groupdate
+  class SeriesBuilder
+    attr_reader :period, :time_zone, :day_start, :week_start, :n_seconds, :options
+
+    def initialize(period:, time_zone:, day_start:, week_start:, n_seconds:, **options)
+      @period = period
+      @time_zone = time_zone
+      @week_start = week_start
+      @day_start = day_start
+      @n_seconds = n_seconds
+      @options = options
+      @week_start_key = Groupdate::Magic::DAYS[@week_start] if @week_start
+    end
+
+    def generate(data, default_value:, series_default: true, multiple_groups: false, group_index: nil)
+      series = generate_series(data, multiple_groups, group_index)
+      series = handle_multiple(data, series, multiple_groups, group_index)
+
+      verified_data = {}
+      series.each do |k|
+        verified_data[k] = data.delete(k)
+      end
+
+      unless entire_series?(series_default)
+        series = series.select { |k| verified_data[k] }
+      end
+
+      value = 0
+      result = series.to_h do |k|
+        value = verified_data[k] || (@options[:carry_forward] && value) || default_value
+        key =
+          if multiple_groups
+            k[0...group_index] + [key_format.call(k[group_index])] + k[(group_index + 1)..-1]
+          else
+            key_format.call(k)
+          end
+
+        [key, value]
+      end
+
+      result
+    end
+
+    def round_time(time)
+      if period == :custom
+        return time_zone.at((time.to_time.to_i / n_seconds) * n_seconds)
+      end
+
+      time = time.to_time.in_time_zone(time_zone)
+
+      if day_start != 0
+        # apply day_start to a time object that's not affected by DST
+        time = time.change(zone: utc)
+        time -= day_start.seconds
+      end
+
+      time =
+        case period
+        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(@week_start_key)
+        when :month
+          time.beginning_of_month
+        when :quarter
+          time.beginning_of_quarter
+        when :year
+          time.beginning_of_year
+        when :hour_of_day
+          time.hour
+        when :minute_of_hour
+          time.min
+        when :day_of_week
+          time.days_to_week_start(@week_start_key)
+        when :day_of_month
+          time.day
+        when :month_of_year
+          time.month
+        when :day_of_year
+          time.yday
+        else
+          raise Groupdate::Error, "Invalid period"
+        end
+
+      if day_start != 0 && time.is_a?(Time)
+        time += day_start.seconds
+        time = time.change(zone: time_zone)
+      end
+
+      time
+    end
+
+    def time_range
+      @time_range ||= begin
+        time_range = options[:range]
+
+        if time_range.is_a?(Range)
+          # check types
+          [time_range.begin, time_range.end].each do |v|
+            case v
+            when nil, Date, Time
+              # good
+            else
+              raise ArgumentError, "Range bounds should be Date or Time, not #{v.class.name}"
+            end
+          end
+
+          start = time_range.begin
+          start = start.in_time_zone(time_zone) if start
+
+          exclude_end = time_range.exclude_end?
+
+          finish = time_range.end
+          finish = finish.in_time_zone(time_zone) if finish
+          if time_range.end.is_a?(Date) && !time_range.end.is_a?(DateTime) && !exclude_end
+            finish += 1.day
+            exclude_end = true
+          end
+
+          if options[:expand_range]
+            start = round_time(start) if start
+            if finish && !(finish == round_time(finish) && exclude_end)
+              finish = round_time(finish) + step
+              exclude_end = true
+            end
+          end
+
+          time_range = Range.new(start, finish, exclude_end)
+        elsif !time_range && options[:last]
+          step = step()
+          raise ArgumentError, "Cannot use last option with #{period}" unless step
+
+          # loop instead of multiply to change start_at - see #151
+          start_at = now
+          (options[:last].to_i - 1).times do
+            start_at -= step
+          end
+
+          time_range =
+            if options[:current] == false
+              round_time(start_at - step)...round_time(now)
+            else
+              # extend to end of current period
+              round_time(start_at)...(round_time(now) + step)
+            end
+        end
+        time_range
+      end
+    end
+
+    private
+
+    def now
+      @now ||= time_zone.now
+    end
+
+    def generate_series(data, multiple_groups, group_index)
+      case period
+      when :day_of_week
+        0..6
+      when :hour_of_day
+        0..23
+      when :minute_of_hour
+        0..59
+      when :day_of_month
+        1..31
+      when :day_of_year
+        1..366
+      when :month_of_year
+        1..12
+      else
+        time_range = self.time_range
+        time_range =
+          if time_range.is_a?(Range) && time_range.begin && time_range.end
+            time_range
+          else
+            # use first and last values
+            sorted_keys =
+              if multiple_groups
+                data.keys.map { |k| k[group_index] }.sort
+              else
+                data.keys.sort
+              end
+
+            if time_range.is_a?(Range)
+              if sorted_keys.any?
+                if time_range.begin
+                  time_range.begin..sorted_keys.last
+                else
+                  Range.new(sorted_keys.first, time_range.end, time_range.exclude_end?)
+                end
+              else
+                nil..nil
+              end
+            else
+              tr = sorted_keys.first..sorted_keys.last
+              if options[:current] == false && sorted_keys.any? && round_time(now) >= tr.last
+                tr = tr.first...round_time(now)
+              end
+              tr
+            end
+          end
+
+        if time_range.begin
+          series = [round_time(time_range.begin)]
+
+          step = step()
+
+          last_step = series.last
+          day_start_hour = day_start / 3600
+          loop do
+            next_step = last_step + step
+            next_step = round_time(next_step) if next_step.hour != day_start_hour # add condition to speed up
+            break unless time_range.cover?(next_step)
+
+            if next_step == last_step
+              last_step += step
+              next
+            end
+            series << next_step
+            last_step = next_step
+          end
+
+          series
+        else
+          []
+        end
+      end
+    end
+
+    def key_format
+      @key_format ||= begin
+        locale = options[:locale] || I18n.locale
+
+        if options[:format]
+          if options[:format].respond_to?(:call)
+            options[:format]
+          else
+            sunday = time_zone.parse("2014-03-02 00:00:00")
+            lambda do |key|
+              case period
+              when :hour_of_day
+                key = sunday + key.hours + day_start.seconds
+              when :minute_of_hour
+                key = sunday + key.minutes + day_start.seconds
+              when :day_of_week
+                key = sunday + key.days + (week_start + 1).days
+              when :day_of_month
+                key = Date.new(2014, 1, key).to_time
+              when :month_of_year
+                key = Date.new(2014, key, 1).to_time
+              end
+              I18n.localize(key, format: options[:format], locale: locale)
+            end
+          end
+        elsif [:day, :week, :month, :quarter, :year].include?(period)
+          lambda { |k| k.to_date }
+        else
+          lambda { |k| k }
+        end
+      end
+    end
+
+    def step
+      if period == :quarter
+        3.months
+      elsif period == :custom
+        n_seconds
+      elsif 1.respond_to?(period)
+        1.send(period)
+      end
+    end
+
+    def handle_multiple(data, series, multiple_groups, group_index)
+      reverse = options[:reverse]
+
+      if multiple_groups
+        keys = data.keys.map { |k| k[0...group_index] + k[(group_index + 1)..-1] }.uniq
+        series = series.to_a.reverse if reverse
+        keys.flat_map do |k|
+          series.map { |s| k[0...group_index] + [s] + k[group_index..-1] }
+        end
+      elsif reverse
+        series.to_a.reverse
+      else
+        series
+      end
+    end
+
+    def entire_series?(series_default)
+      options.key?(:series) ? options[:series] : series_default
+    end
+
+    def utc
+      @utc ||= ActiveSupport::TimeZone["Etc/UTC"]
+    end
+  end
+end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "3.2.0"
+  VERSION = "6.2.1"
 end

data/lib/groupdate.rb

@@ -1,22 +1,52 @@
+# dependencies
+require "active_support"
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/time"
-require "groupdate/version"
+
+# modules
 require "groupdate/magic"
+require "groupdate/series_builder"
+require "groupdate/version"
+
+# adapters
+require "groupdate/adapters/base_adapter"
+require "groupdate/adapters/mysql_adapter"
+require "groupdate/adapters/postgresql_adapter"
+require "groupdate/adapters/sqlite_adapter"
 
 module Groupdate
   class Error < RuntimeError; end
 
-  PERIODS = [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week, :hour_of_day, :day_of_month, :month_of_year]
-  # backwards compatibility for anyone who happened to use it
-  FIELDS = PERIODS
+  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
-  self.week_start = :sun
+  mattr_accessor :week_start, :day_start, :time_zone
+  self.week_start = :sunday
   self.day_start = 0
-  self.dates = true
+
+  # api for gems like ActiveMedian
+  def self.process_result(relation, result, **options)
+    if relation.groupdate_values
+      result = Groupdate::Magic::Relation.process_result(relation, result, **options)
+    end
+    result
+  end
+
+  def self.adapters
+    @adapters ||= {}
+  end
+
+  def self.register_adapter(name, adapter)
+    Array(name).each do |n|
+      adapters[n] = adapter
+    end
+  end
 end
 
+Groupdate.register_adapter ["Mysql2", "Mysql2Spatial", "Mysql2Rgeo"], Groupdate::Adapters::MySQLAdapter
+Groupdate.register_adapter ["PostgreSQL", "PostGIS", "Redshift"], Groupdate::Adapters::PostgreSQLAdapter
+Groupdate.register_adapter "SQLite", Groupdate::Adapters::SQLiteAdapter
+
 require "groupdate/enumerable"
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 6.2.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,153 +16,41 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.20
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.20
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: The simplest way to group temporal data
-email:
-- andrew@chartkick.com
+        version: '5.2'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- groupdate.gemspec
 - lib/groupdate.rb
 - lib/groupdate/active_record.rb
-- lib/groupdate/calculations.rb
+- lib/groupdate/adapters/base_adapter.rb
+- lib/groupdate/adapters/mysql_adapter.rb
+- lib/groupdate/adapters/postgresql_adapter.rb
+- lib/groupdate/adapters/sqlite_adapter.rb
 - lib/groupdate/enumerable.rb
 - lib/groupdate/magic.rb
-- lib/groupdate/order_hack.rb
-- lib/groupdate/scopes.rb
-- lib/groupdate/series.rb
+- lib/groupdate/query_methods.rb
+- lib/groupdate/relation.rb
+- lib/groupdate/series_builder.rb
 - lib/groupdate/version.rb
-- test/enumerable_test.rb
-- test/gemfiles/activerecord31.gemfile
-- test/gemfiles/activerecord32.gemfile
-- test/gemfiles/activerecord40.gemfile
-- test/gemfiles/activerecord41.gemfile
-- test/gemfiles/activerecord42.gemfile
-- test/gemfiles/redshift.gemfile
-- test/mysql_test.rb
-- test/postgresql_test.rb
-- test/redshift_test.rb
-- test/sqlite_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/groupdate
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,28 +58,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: The simplest way to group temporal data
-test_files:
-- test/enumerable_test.rb
-- test/gemfiles/activerecord31.gemfile
-- test/gemfiles/activerecord32.gemfile
-- test/gemfiles/activerecord40.gemfile
-- test/gemfiles/activerecord41.gemfile
-- test/gemfiles/activerecord42.gemfile
-- test/gemfiles/redshift.gemfile
-- test/mysql_test.rb
-- test/postgresql_test.rb
-- test/redshift_test.rb
-- test/sqlite_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-*.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.ruby-version
-.ruby-gemset

data/.travis.yml

@@ -1,25 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.4
-  - jruby-9.1.5.0
-gemfile:
-  - Gemfile
-  - test/gemfiles/activerecord32.gemfile
-  - test/gemfiles/activerecord40.gemfile
-  - test/gemfiles/activerecord41.gemfile
-  - test/gemfiles/activerecord42.gemfile
-sudo: false
-script: RUBYOPT=W0 bundle exec rake test
-before_install:
-  - gem install bundler
-  - 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
-matrix:
-  allow_failures:
-    - rvm: jruby-9.1.5.0
-      gemfile: Gemfile

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in groupdate.gemspec
-gemspec
-
-gem "activerecord", "~> 5.0.0"

data/Rakefile

@@ -1,24 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_test.rb"].exclude(/redshift/)
-  t.warning = false
-end
-
-namespace :test do
-  Rake::TestTask.new(:postgresql) do |t|
-    t.libs << "test"
-    t.pattern = "test/postgresql_test.rb"
-  end
-  Rake::TestTask.new(:mysql) do |t|
-    t.libs << "test"
-    t.pattern = "test/mysql_test.rb"
-  end
-  Rake::TestTask.new(:redshift) do |t|
-    t.libs << "test"
-    t.pattern = "test/redshift_test.rb"
-  end
-end

data/groupdate.gemspec

@@ -1,37 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "groupdate/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "groupdate"
-  spec.version       = Groupdate::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  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.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", ">= 3"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "activerecord"
-
-  if RUBY_PLATFORM == "java"
-    spec.add_development_dependency "activerecord-jdbcpostgresql-adapter"
-    spec.add_development_dependency "activerecord-jdbcmysql-adapter"
-    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter"
-  else
-    spec.add_development_dependency "pg"
-    spec.add_development_dependency "mysql2", "~> 0.3.20"
-    spec.add_development_dependency "sqlite3"
-  end
-end