calculate-all 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ccade1f3bc4b62c2842ef335e27d0c7a11a90fa18e90f3b1260bb572243a4b6
-  data.tar.gz: 9d8dd96e03c6155f828d5fb586a652e9f0d94a5cbb21cfb41fc3c5022772501c
+  metadata.gz: d3928cde50fac04c8f8602ab9e83c685d190e8466febbb2c0314cf962182f99c
+  data.tar.gz: 83f9636ffda1f25e0faabc5454a4c731648371ba20572e5df53357f72e9b5708
 SHA512:
-  metadata.gz: df3d5a6c997473a188f824f865951c05ed8d054758906c6647d4c868a55a37cb55cc0c5981b0bbe4106214d386a03c11fcb41211498c58b7f022a779b265d192
-  data.tar.gz: ca3c3d75e899ff84f85886aeb649f86cc81f0612476297102036a7d991ed872819381c9505f7ed34b3713aed508960f71d8377ac986d92599f9bf585fe493d78
+  metadata.gz: 0a13ddf4a236a27bebbdf1bf7f316c1137eff5eb6cfb3a0589a0f91dfa0548b6167cc4441173ca0ce4b174a156092aa50185ec5f111e54f6c0e75ee3c738d430
+  data.tar.gz: 95f229487220d5bb23ef2a6a50b9aef7a782e25b627c3d87716690a0673fc6890e28c3ab023481f475837a0d595baac84078ef31841c0e3b135081c61eda47b9

data/.github/workflows/build.yml

@@ -8,6 +8,8 @@ jobs:
         include:
         - ruby: "3.4"
           gemfile: Gemfile
+        - ruby: "3.2"
+          gemfile: gemfiles/activerecord71.gemfile
         - ruby: "3.1"
           gemfile: gemfiles/activerecord70.gemfile
         - ruby: "3.0"
@@ -16,11 +18,9 @@ jobs:
           gemfile: gemfiles/activerecord60.gemfile
         - ruby: "2.6"
           gemfile: gemfiles/activerecord52.gemfile
-        - ruby: "2.6"
-          gemfile: gemfiles/activerecord51.gemfile
         - ruby: "2.6"
           gemfile: gemfiles/activerecord50.gemfile
-        - ruby: "2.3"
+        - ruby: "2.6"
           gemfile: gemfiles/activerecord42.gemfile
     runs-on: ubuntu-latest
     env:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.4.0
+
+* Add #async_calculate_all for rails > 7.1
+* Drop support for ruby < 2.6, groupdate < 4
+
+## 0.3.1
+
+* Fix some arguments exceptions
+
 ## 0.3.0
 
 * Allow expression shortcuts as attribute values too for renaming

data/Gemfile

@@ -11,6 +11,7 @@ gem "pg"
 gem "mysql2"
 gem "sqlite3", ">= 2.1"
 
+gem "irb"
 gem "ostruct"
 
 gem "standardrb", require: false

data/README.md

@@ -8,7 +8,10 @@ in a single request, with support for grouping.
 
 Should be useful for dashboards, timeseries stats, and charts.
 
-Currently tested with PostgreSQL, MySQL and SQLite3, ruby >= 2.3, rails >= 4, groupdate >= 4.
+Currently tested with PostgreSQL, MySQL and SQLite3, ruby >= 2.6, rails >= 4, groupdate >= 4.
+
+With rails >= 7.1, `#async_calculate_all` is also available, which does the same but in a separate
+db connection and ruby thread, and returns `ActiveRecord::Promise`
 
 ## Usage
 
@@ -48,6 +51,16 @@ stats = Order.group(:department_id).group(:payment_method).order(:payment_method
 # }
 ```
 
+```ruby
+stats_by_department = Order.group(:department_id).async_calculate_all(:count, :price_sum)
+# continue with some other expensive stuff
+
+# later, in some view
+stats_by_department.value.each do |department_id, stats|
+   # ...
+end
+```
+
 ## Rationale
 
 Active Record makes it really easy to use most common database aggregate functions like COUNT(), MAX(), MIN(), AVG(), SUM().
@@ -78,7 +91,7 @@ or arbitrary symbols and keyword arguments with SQL snippets, aggregate function
   )
 ```
 
-For convenience, `calculate_all(:count, :avg_column)` is the same as `caculate(count: :count, avg_column: :avg_column)`
+For convenience, `calculate_all(:count, :avg_column)` is the same as `calculate_all(count: :count, avg_column: :avg_column)`
 
 Here's a cheatsheet of recognized shortcuts:
 
@@ -139,7 +152,7 @@ with aggregate functions.
 ```ruby
 Order.group(:payment_method).calculate_all('CAST(SUM(price) AS decimal) / COUNT(DISTINCT user_id)')
 # => {
-#   "card" => 0.524e3
+#   "card" => 0.524e3,
 #   "cash" => 0.132e3
 # }
 ```
@@ -186,7 +199,7 @@ Order.group_by_year(:created_at).calculate_all(*Stats.members, &Stats.method(:ne
 # => {
 #   Wed, 01 Jan 2014 => #<data Stats count=2, max_price=700>,
 #   Thu, 01 Jan 2015 => #<data Stats count=0, max_price=nil>,
-#   Fri, 01 Jan 2016 => #<data Stats count=3, max_price800>
+#   Fri, 01 Jan 2016 => #<data Stats count=3, max_price=800>
 # }
 ```
 
@@ -227,7 +240,7 @@ Or install it yourself as:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
 Run `BUNDLE_GEMFILE=gemfiles/activerecord60.gemfile bundle` then `BUNDLE_GEMFILE=gemfiles/activerecord60.gemfile rake`
-to test agains specific active record version.
+to test against specific active record version.
 
 To experiment you can load a test database and jump to IRB with
 

data/calculate-all.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = ">= 2.6.0"
 
   spec.add_dependency "activesupport", ">= 4.0.0"
 end

data/gemfiles/activerecord42.gemfile

@@ -6,7 +6,7 @@ gem "rake"
 gem "minitest", "~> 5.0"
 gem "minitest-reporters"
 gem "activerecord", "~> 4.2.0"
-gem "groupdate", "~> 3.0.0"
+gem "groupdate", "~> 4.0.0"
 gem "pg", "~> 0.15"
 gem "mysql2"
 gem "sqlite3", "~> 1.3.0"

data/gemfiles/{activerecord51.gemfile → activerecord71.gemfile}

@@ -5,8 +5,8 @@ gemspec path: ".."
 gem "rake"
 gem "minitest"
 gem "minitest-reporters"
-gem "activerecord", "~> 5.1.0"
-gem "groupdate", "~> 5.0.0"
+gem "activerecord", "~> 7.1.0"
+gem "groupdate", "~> 6.0.0"
 gem "pg"
 gem "mysql2"
-gem "sqlite3"
+gem "sqlite3", "~> 1.4"

data/lib/calculate-all/version.rb

@@ -1,3 +1,3 @@
 module CalculateAll
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/calculate-all.rb

@@ -11,7 +11,7 @@ module CalculateAll
       return_plain_values = true
     end
 
-    named_expressions = expression_shortcuts.map { |name| [name, name] }.to_h.merge(named_expressions)
+    named_expressions = expression_shortcuts.index_by(&:itself).merge(named_expressions)
 
     named_expressions.transform_values! do |shortcut|
       Helpers.decode_expression_shortcut(shortcut, group_values)
@@ -25,48 +25,55 @@ module CalculateAll
     value_mapping = named_expressions.transform_values { |column| columns.index(column) }
     columns.map! { |column| column.is_a?(String) ? Arel.sql(column) : column }
 
-    results = {}
-    pluck(*columns).each do |row|
-      # If pluck called with with a single argument
-      # it will return an array of sclars instead of array of arrays
-      row = [row] if columns.size == 1
-
-      key = if group_values.size == 0
-        :ALL
-      elsif group_values.size == 1
-        # If only one group is provided, the resulting key is just a scalar value
-        row.first
-      else
-        # if multiple groups, the key will be an array.
-        row.first(group_values.size)
-      end
+    pluck(*columns).then do |rows|
+      results = rows.to_h do |row|
+        # If pluck called with a single argument
+        # it will return an array of scalars instead of array of arrays
+        row = [row] if columns.size == 1
 
-      value = value_mapping.transform_values { |index| row[index] }
+        key = if group_values.size == 0
+          :ALL
+        elsif group_values.size == 1
+          # If only one group is provided, the resulting key is just a scalar value
+          row.first
+        else
+          # if multiple groups, the key will be an array.
+          row.first(group_values.size)
+        end
 
-      value = value.values.last if return_plain_values
+        value = value_mapping.transform_values { |index| row[index] }
 
-      results[key] = value
-    end
+        value = value.values.last if return_plain_values
 
-    # Additional groupdate magic of filling empty periods with defaults
-    if defined?(Groupdate.process_result)
-      # Since that hash is the same instance for every backfilled row, at least
-      # freeze it to prevent surprize modifications across multiple rows in the calling code.
-      default_value = return_plain_values ? nil : {}.freeze
-      results = Groupdate.process_result(self, results, default_value: default_value)
-    end
+        [key, value]
+      end
+
+      # Additional groupdate magic of filling empty periods with defaults
+      if defined?(Groupdate.process_result)
+        # Since that hash is the same instance for every backfilled row, at least
+        # freeze it to prevent surprise modifications across multiple rows in the calling code.
+        default_value = return_plain_values ? nil : {}.freeze
+        results = Groupdate.process_result(self, results, default_value: default_value)
+      end
 
-    if block
-      results.transform_values! do |value|
-        return_plain_values ? block.call(value) : block.call(**value)
+      if block
+        results.transform_values! do |value|
+          return_plain_values ? block.call(value) : block.call(**value)
+        end
+      end
+
+      # Return unwrapped hash directly for scope without any .group()
+      if group_values.empty?
+        results[:ALL]
+      else
+        results
       end
     end
+  end
 
-    # Return unwrapped hash directly for scope without any .group()
-    if group_values.empty?
-      results[:ALL]
-    else
-      results
+  if Gem::Version.new(ActiveRecord.version) >= Gem::Version.new('7.1.0')
+    def async_calculate_all(*expression_shortcuts, **named_expressions, &block)
+      async.calculate_all(*expression_shortcuts, **named_expressions, &block)
     end
   end
 
@@ -97,15 +104,22 @@ module CalculateAll
       when /^(\w+)_minimum$/, /^minimum_(\w+)$/
         "MIN(#{$1})"
       else
-        raise ArgumentError, "Can't recognize expression shortcut #{key}"
+        raise ArgumentError, "Can't recognize expression shortcut #{shortcut}"
       end
     end
   end
 
   module Querying
-    # @see CalculateAll#calculate_all
-    def calculate_all(*args, **kwargs, &block)
-      all.calculate_all(*args, **kwargs, &block)
+    # see CalculateAll#calculate_all
+    def calculate_all(*expression_shortcuts, **named_expressions, &block)
+      all.calculate_all(*expression_shortcuts, **named_expressions, &block)
+    end
+
+    if Gem::Version.new(ActiveRecord.version) >= Gem::Version.new('7.1.0')
+      # see CalculateAll#async_calculate_all
+      def async_calculate_all(*expression_shortcuts, **named_expressions, &block)
+        all.async_calculate_all(*expression_shortcuts, **named_expressions, &block)
+      end
     end
   end
 end
@@ -117,9 +131,4 @@ ActiveSupport.on_load(:active_record) do
   # Make the calculate_all method available for all ActiveRecord::Base classes
   # You can for example call Orders.calculate_all(:count, :sum_cents)
   ActiveRecord::Base.extend CalculateAll::Querying
-
-  # A hack for groupdate 3.0 since it checks if the calculate_all method is defined
-  # on the ActiveRecord::Calculations module. It is never called but it is just
-  # needed for the check.
-  ActiveRecord::Calculations.include CalculateAll::Querying
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: calculate-all
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexey Trofimenko
 bindir: exe
 cert_chain: []
-date: 2025-05-18 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,11 +42,11 @@ files:
 - calculate-all.gemspec
 - gemfiles/activerecord42.gemfile
 - gemfiles/activerecord50.gemfile
-- gemfiles/activerecord51.gemfile
 - gemfiles/activerecord52.gemfile
 - gemfiles/activerecord60.gemfile
 - gemfiles/activerecord61.gemfile
 - gemfiles/activerecord70.gemfile
+- gemfiles/activerecord71.gemfile
 - lib/calculate-all.rb
 - lib/calculate-all/version.rb
 homepage: http://github.com/codesnik/calculate-all
@@ -60,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="