rollups 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b33b1111b50f1f8fcc5b6982932a09c840ca4f4a81191380737e8cdf68775c9e
-  data.tar.gz: 85d9688173df57cd7ab8eb40a4def91adde625303df8374a397e2e136820256f
+  metadata.gz: 5bc765589c1bb3ac755335e36a1a283ef4aeac8ac54a6bc102d3358c57768628
+  data.tar.gz: 0eab24b5cd948823ab190674618fec7ce0935b91d740384854e0474b931d9318
 SHA512:
-  metadata.gz: f64fac7253c86ae3bbc92086551f8c76cb565d5d0630b700707ffd059630bb60017469be586126bc54051ca8df6ccfdfbb42664eacefc982e9618457f4e5e65b
-  data.tar.gz: a7971f424d126c532f03208cf7fb9f72d505787dd3251df33db10d6487d39e29ab6de7d55249d064c9153d50cf2bb07a29a0a3124c1c1111cb585560565b6418
+  metadata.gz: 8a64dd7d050f06d49a5d8261b09b0437faf7a579e086b154903daf86de86ad799a1b97c98d44149b0e0fb20e4531a9d435b787adccefff7b89afb91f4cc44af3
+  data.tar.gz: 60ac29b15fb518bfaad4026ca02d55a926a829f1229f758993a07cace6117030247211750fb1bc33deb9547e55e406ab81e1a06f2ecc3f9208d626d62744aa3c

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.2.0 (2022-04-05)
+
+- Added `range` option
+- Dropped support for Active Record < 5.2
+
+## 0.1.4 (2021-12-15)
+
+- Fixed warning with Active Record 7
+
+## 0.1.3 (2021-10-20)
+
+- Fixed issue rolling up rollups
+
 ## 0.1.2 (2021-06-07)
 
 - Fixed deprecation warning with Active Record 6.1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Andrew Kane
+Copyright (c) 2020-2022 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -11,13 +11,13 @@ Works great with [Ahoy](https://github.com/ankane/ahoy) and [Searchjoy](https://
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'rollups'
+gem "rollups"
 ```
 
 For Rails < 6, also add:
 
 ```ruby
-gem 'activerecord-import'
+gem "activerecord-import"
 ```
 
 And run:
@@ -173,6 +173,12 @@ To recalculate the last few intervals, use:
 User.rollup("New users", last: 3)
 ```
 
+To recalculate a time range, use:
+
+```ruby
+User.rollup("New users", range: 1.week.ago.all_week)
+```
+
 To only store data for completed intervals, use:
 
 ```ruby

data/lib/rollup/aggregator.rb

@@ -4,13 +4,15 @@ class Rollup
       @klass = klass # or relation
     end
 
-    def rollup(name, column: nil, interval: "day", dimension_names: nil, time_zone: nil, current: true, last: nil, clear: false, &block)
+    def rollup(name, column: nil, interval: "day", dimension_names: nil, time_zone: nil, current: nil, last: nil, clear: false, range: nil, &block)
       raise "Name can't be blank" if name.blank?
 
       column ||= @klass.rollup_column || :created_at
-      validate_column(column)
+      # Groupdate 6+ validates, but keep this for now for additional safety
+      # no need to quote/resolve column here, as Groupdate handles it
+      column = validate_column(column)
 
-      relation = perform_group(name, column: column, interval: interval, time_zone: time_zone, current: current, last: last, clear: clear)
+      relation = perform_group(name, column: column, interval: interval, time_zone: time_zone, current: current, last: last, clear: clear, range: range)
       result = perform_calculation(relation, &block)
 
       dimension_names = set_dimension_names(dimension_names, relation)
@@ -23,18 +25,24 @@ class Rollup
 
     # basic version of Active Record disallow_raw_sql!
     # symbol = column (safe), Arel node = SQL (safe), other = untrusted
-    # no need to quote/resolve column here, as Groupdate handles it
-    # TODO remove this method when gem depends on Groupdate 6+
+    # matches table.column and column
     def validate_column(column)
-      # matches table.column and column
-      unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral) || /\A\w+(\.\w+)?\z/i.match(column.to_s)
-        raise "Non-attribute argument: #{column}. Use Arel.sql() for known-safe values"
+      unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral)
+        column = column.to_s
+        unless /\A\w+(\.\w+)?\z/i.match(column)
+          raise ActiveRecord::UnknownAttributeReference, "Query method called with non-attribute argument(s): #{column.inspect}. Use Arel.sql() for known-safe values."
+        end
       end
+      column
     end
 
-    def perform_group(name, column:, interval:, time_zone:, current:, last:, clear:)
+    def perform_group(name, column:, interval:, time_zone:, current:, last:, clear:, range:)
+      raise ArgumentError, "Cannot use last and range together" if last && range
       raise ArgumentError, "Cannot use last and clear together" if last && clear
+      raise ArgumentError, "Cannot use range and clear together" if range && clear
+      raise ArgumentError, "Cannot use range and current together" if range && !current.nil?
 
+      current = true if current.nil?
       time_zone ||= Rollup.time_zone
 
       gd_options = {
@@ -48,10 +56,14 @@ class Rollup
 
       if last
         gd_options[:last] = last
+      elsif range
+        gd_options[:range] = range
+        gd_options[:expand_range] = true
+        gd_options.delete(:current)
       elsif !clear
         # if no rollups, compute all intervals
         # if rollups, recompute last interval
-        max_time = Rollup.where(name: name, interval: interval).maximum(Utils.time_sql(interval))
+        max_time = Rollup.unscoped.where(name: name, interval: interval).maximum(Utils.time_sql(interval))
         if max_time
           # for MySQL on Ubuntu 18.04 (and likely other platforms)
           if max_time.is_a?(String)
@@ -157,7 +169,7 @@ class Rollup
     def maybe_clear(clear, name, interval)
       if clear
         Rollup.transaction do
-          Rollup.where(name: name, interval: interval).delete_all
+          Rollup.unscoped.where(name: name, interval: interval).delete_all
           yield
         end
       else
@@ -173,10 +185,10 @@ class Rollup
 
       if ActiveRecord::VERSION::MAJOR >= 6
         options = Utils.mysql? ? {} : {unique_by: conflict_target}
-        Rollup.upsert_all(records, **options)
+        Rollup.unscoped.upsert_all(records, **options)
       else
         update = Utils.mysql? ? [:value] : {columns: [:value], conflict_target: conflict_target}
-        Rollup.import(records,
+        Rollup.unscoped.import(records,
           on_duplicate_key_update: update,
           validate: false
         )

data/lib/rollup/version.rb

@@ -1,5 +1,5 @@
 class Rollup
   # not used in gemspec to avoid superclass mismatch
   # be sure to update there as well
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/rollup.rb

@@ -75,7 +75,7 @@ class Rollup < ActiveRecord::Base
   # feels cleaner than overriding _read_attribute
   def inspect
     if Utils.date_interval?(interval)
-      super.sub(/time: "[^"]+"/, "time: \"#{time.to_s(:db)}\"")
+      super.sub(/time: "[^"]+"/, "time: \"#{time.to_formatted_s(:db)}\"")
     else
       super
     end

data/lib/rollups.rb

@@ -8,6 +8,7 @@ ActiveSupport.on_load(:active_record) do
 
   require "rollup/model"
   extend Rollup::Model
+  Rollup.rollup_column = :time
 
   # modules
   require "rollup/aggregator"

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rollups
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: groupdate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,105 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  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: 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: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-- !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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: groupdate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '6.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
 description:
-email: andrew@chartkick.com
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -173,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rollup time-series data in Rails