activerecord-summarize 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86517402b9294b544b4d452e8198a49e23148141bf1614cdedff938970a32213
-  data.tar.gz: d87578a41a70e44cce3efea3114a1e465ecf2428af4f2aa8be86556fff55a655
+  metadata.gz: fbba2c0577555f891c1f860b76cc9f0194504d47d59922c8337afb9a1b3ab1a0
+  data.tar.gz: 3c1945b1652a4305ec4df2d13a0c5a6966e308018d2b34c5c21e396f02a1e31c
 SHA512:
-  metadata.gz: fd7587584640872da28f5cf78d16f547f6965d9227f665a65658a1ecf5349ad1cb9bb06ddcba57e777acda9d03133f5f83a9bf0095b0e24c853428d98db28ed0
-  data.tar.gz: 42f7a3c1f745f41edb882d681c85ea02c3672739a4edff781b6af0756c99ff0923348b89438969392a2b659ab3bf4613acc9454c5817ef278db0684918de3521
+  metadata.gz: a2a9e27420e30861c5c713e757ae66ead1af9d5aa9e10b259620b10d9289652464fc561745e720bae100cbda1b265e9f551cfd1f05c78f53c8dae39bfd788c33
+  data.tar.gz: 7e8632ae8ced794bdfb539624a64ebeef8d4a0a6568e3f625cca13b0d669365dd309981d351649c2af3a33f21c45e0fed2848853d581681dd0656d55b8163005

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.3)
+    activerecord-summarize (0.3.0)
       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/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.3"
+    VERSION = "0.3.0"
   end
 end

data/lib/activerecord/summarize.rb

@@ -137,6 +137,10 @@ module ActiveRecord::Summarize
       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,
@@ -145,14 +149,14 @@ module ActiveRecord::Summarize
         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
           }
         ]
@@ -237,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
@@ -272,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-summarize
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Joshua Paine
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-01 00:00:00.000000000 Z
+date: 2022-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord