activerecord-summarize 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd10ad02402bdba82cf06beb2d45b91002a2f94eb74322d86f4457360fa46ba
-  data.tar.gz: 7d1f8d4cec9fd857d1551a527af7dbab701900ee2530490581b4d29ee6ef1e2f
+  metadata.gz: d491ee7730156f77105ec7df6bac79b6410fa97b3387816f103dee233b43df8d
+  data.tar.gz: f33be41270ab955fcf2bf9b227cc7c212ae3aa385786da3a5b424a3e1e707e47
 SHA512:
-  metadata.gz: 3a39f8e9b7ff2ffb0bd142ca9c11ac810ef7f2d55c5a1a79d147f8c78eafc14e83a3f4215b6c0d37ae8cffe7e789de6e39ce8680dbf3449c6244b7292554a46a
-  data.tar.gz: b74a44bd31888fd681bb4e5d0fd6b605b935b794dc39334e18f3a533850097b74410d567b522f05ce38a841336891a35e87f68c849a524cbd8e4e42785e9746e
+  metadata.gz: 0d1f5308da4fc8b781e8dd5a69a10c671106acdb9b565c056d23b33114fc96f8d4ff9a60f3887b861f9142b2564c3f33f17d9e8ea52c212c27abbdacc861e2d6
+  data.tar.gz: 318bad930ac53001068e6e3396d921f71ff62c8a0899abe7a96a55d9dab59aa7e6e45c2cdc6e7a5f5ae60b67f18a47be79cb73ee29a85e1fac25a988c43dc47a

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.3.1] - 2022-06-23
+
+- **BUGFIX:** `with` didn't work correctly with a single argument. Embarassingly, both the time-traveling version of `with` and the trivial/fake one provided when `noop: true` is set had single argument bugs, and they were different bugs.
+- **IMPROVEMENT:** Automated tests covering every `with` invocation style I can think of for both implementations and a number of new tests to confirm that `noop: true` produces the same results as (default) `noop: false`.
+- **IMPROVEMENT:** After the initial release I forgot I had a CHANGELOG, and now I've back-filled it.
+
+## [0.3.0] - 2022-06-04
+
+- **BUGFIX:** `.sum(:foo)` of no rows or of all-null values now returns 0 instead of failing (completing partial fix from 0.2.3)
+- **BREAKING:** extremely unlikely to actually break anything, but `.count("distinct id")` now raises as `.distinct.count(:id)` already did. (AFAICT, by the nature of the techniques underlying `summarize`, `distinct` counts cannot be supported.)
+- **IMPROVEMENT:** Automated tests covering basic functions and past problem areas.
+
+## [0.2.3] - 2022-05-01
+
+- **BUGFIX:** Fix results for SQL `SUM(null)` (n.b., this turned out to be only a partial fix)
+- **BUGFIX:** Support summarize with only one query (not often very useful, but it should work!)
+
+## [0.2.2] - 2022-04-29
+
+- **BUGFIX:** Incorrect Arel generation when using `.where(*anything).sum` inside a `summarize` block
+
 ## [0.2.1] - 2022-02-17
 
 - Initial public release

data/Gemfile

@@ -6,7 +6,8 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "minitest", "~> 5.0"
-
 gem "standard", "~> 1.3"
+
+gem "activerecord", "7.0.3"
+gem "sqlite3", "1.4.2"

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    activerecord-summarize (0.2.2)
+    activerecord-summarize (0.3.1)
       activerecord (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activerecord (7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activesupport (7.0.2.2)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     minitest (5.15.0)
@@ -44,6 +44,7 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    sqlite3 (1.4.2)
     standard (1.7.2)
       rubocop (= 1.25.1)
       rubocop-performance (= 1.13.2)
@@ -56,9 +57,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  activerecord (= 7.0.3)
   activerecord-summarize!
   minitest (~> 5.0)
   rake (~> 13.0)
+  sqlite3 (= 1.4.2)
   standard (~> 1.3)
 
 BUNDLED WITH

data/activerecord-summarize.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci|vscode|standard)|appveyor)})
     end
   end
   spec.bindir = "exe"

data/docs/use_case_moderator_dashboard.md

@@ -11,6 +11,8 @@ For each subreddit that a user moderates, the user should see these stats with r
 - count of how many posts from this period were buried, i.e., ended up with negative karma
 - grouped by post creation date, the percentage of posts that ended up being popular, where popular means having a karma score greater than a per-subreddit-configured threshold
 - grouped by post creation day of the week, the average number of comments per non-buried post
+  
+  > *Below, grouping by day of the week is handled with `.group("EXTRACT(DOW FROM posts.created_at)")`*
 
 ## Background
 

data/lib/activerecord/summarize/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Summarize
-    VERSION = "0.2.2"
+    VERSION = "0.3.1"
   end
 end

data/lib/activerecord/summarize.rb

@@ -38,7 +38,7 @@ module ActiveRecord::Summarize
 
     def process(&block)
       # For noop, just yield the original relation and a transparent `with` proc.
-      return yield(@relation, ->(*results, &block) { [*results].then(&block) }) if noop?
+      return yield(@relation, ChainableResult::SYNC_WITH) if noop?
       # Within the block, the relation and its future clones intercept calls to
       # `count` and `sum`, registering them and returning a ChainableResult via
       # summarize.add_calculation.
@@ -127,28 +127,36 @@ module ActiveRecord::Summarize
       # grouped_query = groups.any? ? from_where.group(*groups) : from_where
       grouped_query = groups.any? ? from_where.group(*1..groups.size) : from_where
       data = grouped_query.pluck(*groups, *value_selects)
+      # .pluck(:one_column) returns an array of values instead of an array of arrays,
+      # which breaks the aggregation and assignment below in case anyone ever asks
+      # `summarize` for only one thing.
+      data = data.map { |d| [d] } if (groups.size + value_selects.size) == 1
 
       # Aggregate & assign results
       group_idx = groups.each_with_index.to_h
       starting_values, reducers = @calculations.each_with_index.map do |f, i|
         value_column = groups.size + i
         group_columns = f.relation.group_values.map { |k| group_idx[k] }
+        # `row[value_column] || 0` pattern in reducers because SQL SUM(NULL)
+        # returns NULL, but like ActiveRecord we always want .sum to return a
+        # number, and our "starting_values and reducers" implementation means
+        # we sometimes will have to add NULL to our numbers.
         case group_columns.size
         when 0 then [
           0,
-          ->(memo, row) { memo + row[value_column] }
+          ->(memo, row) { memo + (row[value_column] || 0) }
         ]
         when 1 then [
           Hash.new(0), # Default 0 makes the reducer much cleaner, but we have to clean it up later
           ->(memo, row) {
-            memo[row[group_columns[0]]] += row[value_column] unless row[value_column].zero?
+            memo[row[group_columns[0]]] += row[value_column] unless (row[value_column] || 0).zero?
             memo
           }
         ]
         else [
           Hash.new(0),
           ->(memo, row) {
-            memo[group_columns.map { |i| row[i] }] += row[value_column] unless row[value_column].zero?
+            memo[group_columns.map { |i| row[i] }] += row[value_column] unless (row[value_column] || 0).zero?
             memo
           }
         ]
@@ -233,14 +241,14 @@ module ActiveRecord::Summarize
     def select_value(base_relation)
       where = relation.where_clause - base_relation.where_clause
       for_select = column
-      for_select = Arel::Nodes::Case.new(where.ast).when(true, for_select).else(unmatch_value) unless where.empty?
+      for_select = Arel::Nodes::Case.new(where.ast).when(true, for_select).else(unmatch_arel_node) unless where.empty?
       function.new([for_select]).tap { |f| f.distinct = relation.distinct_value }
     end
 
-    def unmatch_value
+    def unmatch_arel_node
       case method
-      when "sum" then 0
-      when "count" then nil
+      when "sum" then 0 # Adding zero to a sum does nothing
+      when "count" then nil # In SQL, null is no value and is not counted
       else raise "Unknown calculation method"
       end
     end
@@ -268,6 +276,7 @@ module ActiveRecord::Summarize
       case operation = operation.to_s.downcase
       when "count", "sum"
         column_name = :id if [nil, "*", :all].include? column_name
+        raise Unsummarizable, "DISTINCT in SQL is not reliably correct with summarize" if column_name.is_a?(String) && /\bdistinct\b/i === column_name
         @summarize.add_calculation(self, operation, aggregate_column(column_name))
       else super
       end

data/lib/chainable_result.rb

@@ -69,7 +69,7 @@ class ChainableResult
   def self.wrap(v, method = nil, *args, **opts, &block)
     method ||= block ? :then : :itself
     klass = case v
-    when ChainableResult then return v # don't wrap, exit early
+    when ChainableResult then ChainableResult::Future
     when ::Array then ChainableResult::Array
     when ::Hash then ChainableResult::Hash
     else ChainableResult::Other
@@ -81,7 +81,13 @@ class ChainableResult
     ChainableResult.wrap(results.size == 1 ? results.first : results, :then, &block)
   end
 
+  def self.sync_with(*results, &block)
+    # Non-time-traveling, synchronous version of `with` for testing
+    (results.size == 1 ? results.first : results).then(&block)
+  end
+
   WITH = method(:with)
+  SYNC_WITH = method(:sync_with)
 
   def self.resolve_item(item)
     case item

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-summarize
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Joshua Paine
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -46,7 +46,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock

data/.standard.yml

@@ -1,5 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-# ignore:
-#   - 'lib/**/*':
-#     - Layout/DotPosition