active_median 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7589b66aa9d74af6afe94a766603a36feadf9b0f36d7be01212e97a4ae1de423
-  data.tar.gz: de6fa949edc2220610f97ff42a03ce7f50cc1cf9e66979846c570c3a13e3e6b8
+  metadata.gz: d5ba23ce76f2234aaba1595b26ce41faeba63c03807b8b101d7e0152d48df133
+  data.tar.gz: 15fb7d99f6991034b9f93bdfa6c7aeb681518cf45ab618bcd11e471ff163eb48
 SHA512:
-  metadata.gz: d2739f3b083658090a61b283d5d416f61e4b998576fe8a704cbcb22a7c2fb621f8b1c89c422bae8cf67cf3784624d5f056837980c2fa80737df67edbc337490c
-  data.tar.gz: 9bac410d399bf81668e999d28da3f804ad4ab7e8891db726bbb07980a201902ca107d866b0f27866170df41c97c63d72cf4be4768666f67197f593d559da88b7
+  metadata.gz: c4078461f5f215b8d5632f2c75caf7f57289af0b979e51fa2cf6f3c8a0dc83c7661bd6677efd5800e81337123681c111a8f908807d66203f5e0d713db9c5be3e
+  data.tar.gz: b96f21e8135e91a4d1e4ec78e128852b364319d7c56af0a15c77d810cf1276ec421ff37b91d1a2d5f66bd7683617d45e5483740f4f6f9c948354d9280d70ff62

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.4.0 (2023-05-25)
+
+- Fixed error with Active Record 7.0.5
+- Raise `ArgumentError` for invalid percentiles
+- Dropped support for Ruby < 3 and Active Record < 6.1
+
+## 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

data/LICENSE.txt

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

data/README.md

@@ -20,7 +20,7 @@ Supports:
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'active_median'
+gem "active_median"
 ```
 
 For MySQL, also follow [these instructions](#additional-instructions).
@@ -105,18 +105,6 @@ db.load_extension("percentile.so") # or percentile.dylib
 db.enable_load_extension(0)
 ```
 
-## Upgrading
-
-### 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))
-```
-
-Also, percentiles are now supported with SQLite. Use the [percentile extension](#sqlite) instead of `extension-functions`.
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -126,12 +114,29 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
-To get started with development and testing:
+To get started with development:
 
 ```sh
 git clone https://github.com/ankane/active_median.git
 cd active_median
-createdb active_median_test
 bundle install
+
+# Postgres
+createdb active_median_test
 bundle exec rake test
+
+# SQLite
+ADAPTER=sqlite3 BUNDLE_GEMFILE=gemfiles/sqlite3.gemfile bundle exec rake test
+
+# MariaDB and MySQL (for MySQL, install the extension first)
+mysqladmin create active_median_test
+ADAPTER=mysql2 BUNDLE_GEMFILE=gemfiles/mysql2.gemfile bundle exec rake test
+
+# SQL Server
+docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=YourStrong!Passw0rd' -p 1433:1433 -d mcr.microsoft.com/mssql/server:2022-latest
+docker exec -it <container-id> /opt/mssql-tools/bin/sqlcmd -S localhost -U SA -P YourStrong\!Passw0rd -Q "CREATE DATABASE active_median_test"
+ADAPTER=sqlserver BUNDLE_GEMFILE=gemfiles/sqlserver.gemfile bundle exec rake test
+
+# MongoDB
+BUNDLE_GEMFILE=gemfiles/mongoid7.gemfile bundle exec rake test
 ```

data/lib/active_median/model.rb

@@ -11,7 +11,8 @@ module ActiveMedian
     private
 
     def calculate_percentile(column, percentile, operation)
-      percentile = percentile.to_f
+      percentile = Float(percentile, exception: false)
+      raise ArgumentError, "invalid percentile" if percentile.nil?
       raise ArgumentError, "percentile is not between 0 and 1" if percentile < 0 || percentile > 1
 
       # basic version of Active Record disallow_raw_sql!
@@ -24,7 +25,13 @@ module ActiveMedian
         end
       end
 
-      column_alias = relation.send(:column_alias_for, "#{operation} #{column.to_s.downcase}")
+      column_alias =
+        if relation.respond_to?(:column_alias_for, true)
+          relation.send(:column_alias_for, "#{operation} #{column.to_s.downcase}")
+        else
+          # Active Record 7.0.5+
+          ActiveRecord::Calculations::ColumnAliasTracker.new(connection).alias_for("#{operation} #{column.to_s.downcase}")
+        end
       # 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/
@@ -67,12 +74,12 @@ module ActiveMedian
           relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over}) AS #{column_alias}").unscope(:group)
         when /sqlite/i
           db = connection.raw_connection
-          unless db.instance_variable_get(:@active_median_handler)
+          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_handler, true)
+            db.instance_variable_set(:@active_median, true)
           end
 
           relation.select(*group_values, "PERCENTILE(#{column}, #{percentile} * 100) AS #{column_alias}")

data/lib/active_median/mongoid.rb

@@ -6,11 +6,13 @@ module ActiveMedian
 
     # https://www.compose.com/articles/mongo-metrics-finding-a-happy-median/
     def percentile(column, percentile)
-      percentile = percentile.to_f
+      percentile = Float(percentile, exception: false)
+      raise ArgumentError, "invalid percentile" if percentile.nil?
       raise ArgumentError, "percentile is not between 0 and 1" if percentile < 0 || percentile > 1
 
       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

@@ -18,6 +18,7 @@ module ActiveMedian
     # 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

data/lib/active_median/version.rb

@@ -1,3 +1,3 @@
 module ActiveMedian
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/active_median.rb

@@ -1,25 +1,16 @@
+# dependencies
 require "active_support"
 
-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);
-      DROP FUNCTION IF EXISTS median(anyarray);
-    SQL
-    true
-  end
-end
+# modules
+require_relative "active_median/enumerable"
+require_relative "active_median/version"
 
 ActiveSupport.on_load(:active_record) do
-  require "active_median/model"
+  require_relative "active_median/model"
   extend(ActiveMedian::Model)
 end
 
 ActiveSupport.on_load(:mongoid) do
-  require "active_median/mongoid"
+  require_relative "active_median/mongoid"
   Mongoid::Document::ClassMethods.include(ActiveMedian::Mongoid)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_median
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     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: []
@@ -51,14 +51,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.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Median and percentile for Active Record, Mongoid, arrays, and hashes