rollups 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb7a00e9ed34a6924e0d6ea7c27fbe96275817274abcc5e0aed4c03edf38f9b2
-  data.tar.gz: cb52591ce2a2f40c173bb925659a7b31812522dd2c81c0906ad2aff80b03f000
+  metadata.gz: 13842cdbcce3b4b43bd7d8aeb91f1e7af030cdf17d3e030f1bfe8d30eadc3bf4
+  data.tar.gz: e86af13b7e72c7e236d341b5b46158389ae4c8f7425b1580d94b8969e22656c0
 SHA512:
-  metadata.gz: a7a044a8e1b85c51de0043e48381037adb080bded3dbd620fc1dec3715c8cf735a94778470672b269a66e31c764889dbc2d58f02dee7cb542eb739496d36d4c2
-  data.tar.gz: b66ea1e6f81de6bce70d947c816aee005363cdea4e61a1a98cdf4b83714f8b8c814bcba29806436589d6e5ee820f8704267944359341aa20afd84ceda215fb65
+  metadata.gz: 6c8a4add9c0e04504260e64db82573d131dd666f97ff5c7e6b9ea7dc6b28cf24a70c03e5b6ba67eb01539d66cf0ae915c76c1cfc69f7cbe7b56d78fc49f871dc
+  data.tar.gz: 582ed4c461e377e3fc1afa38f03c6c2cfcb0e4d08bfa0aa3b959cf8488731edc36d7371ee2a1ac5ba9ab63cdec90fb65ccc78283b6571ccd3124f472aad27244

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.3.0 (2023-07-02)
+
+- Dropped support for Ruby < 3 and Active Record < 6.1
+
+## 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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-2021 Andrew Kane
+Copyright (c) 2020-2023 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
@@ -213,6 +219,12 @@ If a series has dimensions, they must match exactly as well
 Rollup.series("Orders by platform and channel", dimensions: {platform: "Web", channel: "Search"})
 ```
 
+Get a specific time range
+
+```ruby
+Rollup.where(time: Date.current.all_year).series("New Users")
+```
+
 ### Multiple Series
 
 *PostgreSQL only*
@@ -235,6 +247,12 @@ Filter by dimensions
 Rollup.where_dimensions(platform: "Web").multi_series("Orders by platform and channel")
 ```
 
+Get a specific time range
+
+```ruby
+Rollup.where(time: Date.current.all_year).multi_series("Orders by platform")
+```
+
 ### Raw Data
 
 Uses the `Rollup` model to query the data directly

data/lib/generators/rollups_generator.rb

@@ -25,10 +25,6 @@ class RollupsGenerator < Rails::Generators::Base
   end
 
   def adapter
-    if ActiveRecord::VERSION::STRING.to_f >= 6.1
-      ActiveRecord::Base.connection_db_config.adapter.to_s
-    else
-      ActiveRecord::Base.connection_config[:adapter].to_s
-    end
+    ActiveRecord::Base.connection_db_config.adapter.to_s
   end
 end

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,6 +56,10 @@ 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
@@ -171,16 +183,8 @@ class Rollup
       conflict_target = [:name, :interval, :time]
       conflict_target << :dimensions if Utils.dimensions_supported?
 
-      if ActiveRecord::VERSION::MAJOR >= 6
-        options = Utils.mysql? ? {} : {unique_by: conflict_target}
-        Rollup.unscoped.upsert_all(records, **options)
-      else
-        update = Utils.mysql? ? [:value] : {columns: [:value], conflict_target: conflict_target}
-        Rollup.unscoped.import(records,
-          on_duplicate_key_update: update,
-          validate: false
-        )
-      end
+      options = Utils.mysql? ? {} : {unique_by: conflict_target}
+      Rollup.unscoped.upsert_all(records, **options)
     end
   end
 end

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.4"
+  VERSION = "0.3.0"
 end

data/lib/rollups.rb

@@ -4,14 +4,14 @@ require "groupdate"
 
 ActiveSupport.on_load(:active_record) do
   # must come first
-  require "rollup"
+  require_relative "rollup"
 
-  require "rollup/model"
+  require_relative "rollup/model"
   extend Rollup::Model
   Rollup.rollup_column = :time
 
   # modules
-  require "rollup/aggregator"
-  require "rollup/utils"
-  require "rollup/version"
+  require_relative "rollup/aggregator"
+  require_relative "rollup/utils"
+  require_relative "rollup/version"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollups
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: groupdate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description:
 email: andrew@ankane.org
 executables: []
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Rollup time-series data in Rails