active_median 0.2.6 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97636a27f16c0024056aa067afe5d54dcb01247be3236573db0d4a5365cf72ee
-  data.tar.gz: 5c7dc9c490730959e05f4a633765ded663612f02543d62bb17ab05dfd1828f3e
+  metadata.gz: 8fac5b8a4669bedd7b9a7bd104c375df5acf6c9e60bc2c91ec97efb2ebea6969
+  data.tar.gz: afc2609d7983f06b975244e57ab4f6890916fdc3943870974a56d50cca19a832
 SHA512:
-  metadata.gz: 48a5936c99b5325a8b7ac43035c7207912911a2e5ddd0889ccc6a4478d35360482cb2062f1756b5e0ba499e54ffff7e79e8adfe9fe29851a028d70194a497949
-  data.tar.gz: abb786892e89b6361e7bf107d702ac4be5e9439f1a5364a7395c490c335c286bcdbcb6c106d130a6ef0870d3b2f100d6ded7c5c69db3ab87fbef4380dca8b9ca
+  metadata.gz: f3cff2041e5d602bd84f99f99cd75efbe6fba5c78faf4efbd6b3886edb91bf1db7deeca609ded57a859f10e670298f04a225f3f1b69ea8b4df9aecda68661b5e
+  data.tar.gz: d494fddff7e01063c99d549d4669f6efff207fef25f71761329d3c16166bc6a268f02020e12adde251be855ed0c31998f47fb73890689565bb67a0c320875b06

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 0.3.3 (2021-08-17)
+
+- Fixed null values for SQLite without an extension and MongoDB
+
+## 0.3.2 (2021-08-16)
+
+- Added support for SQLite without an extension
+
+## 0.3.1 (2021-02-21)
+
+- Fixed error with relations with `select` clauses
+
+## 0.3.0 (2021-02-08)
+
+- Added column alias
+- Added support for percentiles with SQLite (switched extensions)
+- Raise `ActiveRecord::UnknownAttributeReference` for non-attribute arguments
+- Dropped support for Active Record < 5.2
+
+## 0.2.8 (2021-01-16)
+
+- Fixed bug with removing order
+
+## 0.2.7 (2021-01-16)
+
+- Fixed error with order
+
 ## 0.2.6 (2020-12-18)
 
 - Fixed error with certain column types for Active Record 6.1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2020 Andrew Kane
+Copyright (c) 2013-2021 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,11 +4,12 @@ Median and percentile for Active Record, Mongoid, arrays, and hashes
 
 Supports:
 
-- PostgreSQL 9.4+
-- MariaDB 10.3.3+
-- MySQL and SQL (with extensions)
-- SQL Server 2012+
-- MongoDB 2.1+
+- PostgreSQL
+- SQLite
+- MariaDB
+- MySQL (with an extension)
+- SQL Server
+- MongoDB
 
 :fire: Uses native functions for blazing performance
 
@@ -22,7 +23,7 @@ Add this line to your application’s Gemfile:
 gem 'active_median'
 ```
 
-For MySQL and SQLite, also follow [these instructions](#additional-instructions).
+For MySQL, also follow [these instructions](#additional-instructions).
 
 ## Models
 
@@ -44,19 +45,6 @@ Works with grouping, too
 Order.group(:store_id).median(:total)
 ```
 
-## User Input
-
-If passing user input as the column, be sure to sanitize it first [like you must](https://rails-sqli.org/) with other aggregate methods like `sum`.
-
-```ruby
-column = params[:column]
-
-# check against permitted columns
-raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
-
-User.median(column)
-```
-
 ## Arrays and Hashes
 
 Median
@@ -94,10 +82,18 @@ mysql <options> < load.sql
 
 ### SQLite
 
-SQLite requires a [community extension](https://www.sqlite.org/contrib). Download [extension-functions.c](https://www.sqlite.org/contrib/download/extension-functions.c) and follow the [instructions for compiling loadable extensions](https://www.sqlite.org/loadext.html#compiling_a_loadable_extension) for your platform. On Mac, use:
+Improve performance with SQLite with an extension. Download [percentile.c](https://www.sqlite.org/src/file?name=ext/misc/percentile.c&ci=d49c32e6e7cc341b) and follow the [instructions for compiling loadable extensions](https://www.sqlite.org/loadext.html#compiling_a_loadable_extension) for your platform.
+
+On Linux, use:
 
 ```sh
-gcc -g -fPIC -dynamiclib extension-functions.c -o extension-functions.dylib
+gcc -g -fPIC -shared -lsqlite3 percentile.c -o percentile.so
+```
+
+On Mac, use:
+
+```sh
+gcc -g -fPIC -dynamiclib -L/usr/local/opt/sqlite/lib -lsqlite3 percentile.c -o percentile.dylib
 ```
 
 To load it in Rails, create an initializer with:
@@ -105,15 +101,21 @@ To load it in Rails, create an initializer with:
 ```ruby
 db = ActiveRecord::Base.connection.raw_connection
 db.enable_load_extension(1)
-db.load_extension("extension-functions.dylib")
+db.load_extension("percentile.so") # or percentile.dylib
 db.enable_load_extension(0)
 ```
 
 ## Upgrading
 
-### 0.2.0
+### 0.3.0
+
+ActiveMedian 0.3.0 protects against unsafe input by default. For non-attribute arguments, use:
+
+```ruby
+Item.median(Arel.sql(known_safe_value))
+```
 
-A user-defined function is no longer needed for Postgres. Create a migration with `ActiveMedian.drop_function` to remove it.
+Also, percentiles are now supported with SQLite. Use the [percentile extension](#sqlite) instead of `extension-functions`.
 
 ## Contributing
 

data/lib/active_median/model.rb

@@ -1,20 +1,34 @@
 module ActiveMedian
   module Model
     def median(column)
-      percentile(column, 0.5)
+      calculate_percentile(column, 0.5, "median")
     end
 
     def percentile(column, percentile)
+      calculate_percentile(column, percentile, "percentile")
+    end
+
+    private
+
+    def calculate_percentile(column, percentile, operation)
       percentile = percentile.to_f
       raise ArgumentError, "percentile is not between 0 and 1" if percentile < 0 || percentile > 1
 
       # basic version of Active Record disallow_raw_sql!
       # symbol = column (safe), Arel node = SQL (safe), other = untrusted
       # 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)
-        warn "[active_median] Non-attribute argument: #{column}. Use Arel.sql() for known-safe values. This will raise an error in ActiveMedian 0.3.0"
+      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_alias = relation.send(:column_alias_for, "#{operation} #{column.to_s.downcase}")
+      # safety check
+      # could quote, but want to keep consistent with Active Record
+      raise "Bad column alias: #{column_alias}. Please report a bug." unless column_alias =~ /\A[a-z0-9_]+\z/
+
       # column resolution
       node = relation.send(:arel_columns, [column]).first
       node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
@@ -25,6 +39,9 @@ module ActiveMedian
 
       group_values = all.group_values
 
+      # replace select to match behavior of average
+      relation = unscope(:select)
+
       relation =
         case connection.adapter_name
         when /mysql/i
@@ -37,35 +54,37 @@ module ActiveMedian
               over = "PARTITION BY #{group_values.join(", ")}"
             end
 
-            select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over})").unscope(:group)
+            relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over}) AS #{column_alias}").unscope(:group)
           else
             # if mysql gets native function, check (and memoize) version first
-            select(*group_values, "PERCENTILE_CONT(#{column}, #{percentile})")
+            relation.select(*group_values, "PERCENTILE_CONT(#{column}, #{percentile}) AS #{column_alias}")
           end
         when /sqlserver/i
           if group_values.any?
             over = "PARTITION BY #{group_values.join(", ")}"
           end
 
-          select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over})").unscope(:group)
+          relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over}) AS #{column_alias}").unscope(:group)
         when /sqlite/i
-          case percentile.to_f
-          when 0
-            select(*group_values, "MIN(#{column})")
-          when 0.5
-            select(*group_values, "MEDIAN(#{column})")
-          when 1
-            select(*group_values, "MAX(#{column})")
-          else
-            # LOWER_QUARTILE and UPPER_QUARTILE use different calculation than 0.25 and 0.75
-            raise "SQLite only supports 0, 0.5, and 1 percentiles"
+          db = connection.raw_connection
+          unless db.instance_variable_get(:@active_median)
+            if db.get_first_value("SELECT 1 FROM pragma_function_list WHERE name = 'percentile'").nil?
+              require "active_median/sqlite_handler"
+              db.create_aggregate_handler(ActiveMedian::SQLiteHandler)
+            end
+            db.instance_variable_set(:@active_median, true)
           end
+
+          relation.select(*group_values, "PERCENTILE(#{column}, #{percentile} * 100) AS #{column_alias}")
         when /postg/i, /redshift/i # postgis too
-          select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column})")
+          relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) AS #{column_alias}")
         else
           raise "Connection adapter not supported: #{connection.adapter_name}"
         end
 
+      # same as average
+      relation = relation.unscope(:order).distinct!(false) if group_values.empty?
+
       result = connection.select_all(relation.to_sql)
 
       # typecast

data/lib/active_median/mongoid.rb

@@ -11,6 +11,7 @@ module ActiveMedian
 
       relation =
         all
+        .where(column => {"$ne" => nil})
         .asc(column)
         .group(_id: nil, values: {"$push" => "$#{column}"}, count: {"$sum" => 1})
         .project(values: 1, count: {"$subtract" => ["$count", 1]})

data/lib/active_median/sqlite_handler.rb

@@ -0,0 +1,33 @@
+module ActiveMedian
+  class SQLiteHandler
+    def self.arity
+      2
+    end
+
+    def self.name
+      "percentile"
+    end
+
+    def initialize
+      @values = []
+      @percentile = nil
+    end
+
+    # skip checks for
+    # 1. percentile between 0 and 100
+    # 2. percentile same for all rows
+    # since input is already checked
+    def step(ctx, value, percentile)
+      return if value.nil?
+      raise ActiveRecord::StatementInvalid, "1st argument to percentile() is not numeric" unless value.is_a?(Numeric)
+      @percentile ||= percentile
+      @values << value
+    end
+
+    def finalize(ctx)
+      if @values.any?
+        ctx.result = @values.percentile(@percentile / 100.0)
+      end
+    end
+  end
+end

data/lib/active_median/version.rb

@@ -1,3 +1,3 @@
 module ActiveMedian
-  VERSION = "0.2.6"
+  VERSION = "0.3.3"
 end

data/lib/active_median.rb

@@ -4,6 +4,7 @@ require "active_median/enumerable"
 require "active_median/version"
 
 module ActiveMedian
+  # TODO remove in 0.4.0
   def self.drop_function
     ActiveRecord::Base.connection.execute <<-SQL
       DROP AGGREGATE IF EXISTS median(anyelement);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_median
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-19 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,100 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !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: minitest
-  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: 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: 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: groupdate
-  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'
+        version: '5.2'
 description:
-email: andrew@chartkick.com
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,6 +37,7 @@ files:
 - lib/active_median/enumerable.rb
 - lib/active_median/model.rb
 - lib/active_median/mongoid.rb
+- lib/active_median/sqlite_handler.rb
 - lib/active_median/version.rb
 homepage: https://github.com/ankane/active_median
 licenses:
@@ -134,14 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Median and percentile for Active Record, Mongoid, arrays, and hashes