active_median 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 898f80afa3c78ec2137b1c8f2f2dae6e4604ff657f472725f10f9486a82fc32f
-  data.tar.gz: '080da5da53ea03e6a20f8a5e80d70afdec3e6fa2d1d140e18f680ac361bc077d'
+  metadata.gz: cbc48a266db4698647e93b35bdad3e2ed1fc131ec48a2a00e1ac33583f693c4d
+  data.tar.gz: 9e49da11f496e63c1fca879b7f6b509cbc80b6551f22743f9f586dfdf6f3d2f3
 SHA512:
-  metadata.gz: e60fa9abc00e89da32390c0608a8e297e8ba4a36a869eea44b0ac94c6dcff00a49b71823f1942313d7709489c9af78b52260f8d1c48d739ec842b2aebdc0ebf6
-  data.tar.gz: a1ee8deb9ba6352732ed008f8bb255c4a7f248bc63beb27d3c74893306af57a0f0d00ae7848c1e6356263a345fbf70151d0b59d633071aa407685117dc6ccb1c
+  metadata.gz: 7c37697facc95126f6b11bd29831f0aa685b781242a729c86e938e9f4be0a0b7fbfadbdf8ae246f987f452bb7977de21f2f879860f945f1a7bc9db005f85dc49
+  data.tar.gz: d37c90a02b845b8a2cd8e41ed5109da758ca51c9921675f7f63e30e0921e430eed193d6ae02676e3aa08c5eaf97207d29fd8f50540e1be060924022aa818dc03

data/CHANGELOG.md

@@ -1,4 +1,27 @@
-## 0.2.0
+## 0.2.5 (2020-09-07)
+
+- Added warning for non-attribute argument
+
+## 0.2.4 (2020-03-12)
+
+- Added `percentile` method
+
+## 0.2.3 (2019-09-03)
+
+- Added support for Mongoid
+- Dropped support for Rails 4.2
+
+## 0.2.2 (2018-10-29)
+
+- Added support for MySQL with udf_infusion
+- Added support for SQL Server and Redshift
+
+## 0.2.1 (2018-10-15)
+
+- Added support for arrays and hashes
+- Added compatibility with Groupdate 4
+
+## 0.2.0 (2018-10-15)
 
 - Added support for MariaDB 10.3.3+ and SQLite
 - Use `PERCENTILE_CONT` for 4x performance increase
@@ -7,23 +30,23 @@ Breaking
 
 - Dropped support for Postgres < 9.4
 
-## 0.1.4
+## 0.1.4 (2016-12-03)
 
 - Added `drop_function` method
 
-## 0.1.3
+## 0.1.3 (2016-03-22)
 
 - Added support for ActiveRecord 5.0
 
-## 0.1.2
+## 0.1.2 (2014-12-27)
 
 - Added support for ActiveRecord 4.2
 
-## 0.1.1
+## 0.1.1 (2014-08-12)
 
 - 10x faster median
 - Added tests
 
-## 0.1.0
+## 0.1.0 (2014-03-13)
 
 - First release

data/LICENSE.txt

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

data/README.md

@@ -1,34 +1,96 @@
 # ActiveMedian
 
-Median for ActiveRecord
+Median and percentile for Active Record, Mongoid, arrays, and hashes
 
-Supports PostgreSQL 9.4+, MariaDB 10.3.3+, and SQLite
+Supports:
+
+- PostgreSQL 9.4+
+- MariaDB 10.3.3+
+- MySQL and SQL (with extensions)
+- SQL Server 2012+
+- MongoDB 2.1+
 
 :fire: Uses native functions for blazing performance
 
-[![Build Status](https://travis-ci.org/ankane/active_median.svg)](https://travis-ci.org/ankane/active_median)
+[![Build Status](https://travis-ci.org/ankane/active_median.svg?branch=master)](https://travis-ci.org/ankane/active_median)
+
+## Getting Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'active_median'
+```
+
+For MySQL and SQLite, also follow [these instructions](#additional-instructions).
+
+## Models
 
-## Usage
+Median
 
 ```ruby
 Item.median(:price)
 ```
 
-Works with grouping, too.
+Percentile
 
 ```ruby
-Order.group("date_trunc('week', created_at)").median(:total)
+Request.percentile(:response_time, 0.95)
 ```
 
-## Installation
+Works with grouping, too
 
-Add this line to your application’s Gemfile:
+```ruby
+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
-gem 'active_median'
+column = params[:column]
+
+# check against permitted columns
+raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
+
+User.median(column)
+```
+
+## Arrays and Hashes
+
+Median
+
+```ruby
+[1, 2, 3].median
+```
+
+Percentile
+
+```ruby
+[1, 2, 3].percentile(0.95)
+```
+
+You can also pass a block
+
+```ruby
+{a: 1, b: 2, c: 3}.median { |k, v| v }
 ```
 
-For SQLite, also follow the instructions below.
+## Additional Instructions
+
+### MySQL
+
+MySQL requires the `PERCENTILE_CONT` function from [udf_infusion](https://github.com/infusion/udf_infusion). To install it, do:
+
+```sh
+git clone https://github.com/infusion/udf_infusion.git
+cd udf_infusion
+./configure --enable-functions="percentile_cont"
+make
+sudo make install
+mysql <options> < load.sql
+```
 
 ### SQLite
 
@@ -51,7 +113,7 @@ db.enable_load_extension(0)
 
 ### 0.2.0
 
-A user-defined function is no longer needed. Create a migration with `ActiveMedian.drop_function` to remove it.
+A user-defined function is no longer needed for Postgres. Create a migration with `ActiveMedian.drop_function` to remove it.
 
 ## Contributing
 
@@ -61,3 +123,13 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/active_median/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/active_median.git
+cd active_median
+createdb active_median_test
+bundle install
+bundle exec rake test
+```

data/lib/active_median.rb

@@ -1,6 +1,6 @@
 require "active_support"
 
-require "active_median/model"
+require "active_median/enumerable"
 require "active_median/version"
 
 module ActiveMedian
@@ -14,5 +14,11 @@ module ActiveMedian
 end
 
 ActiveSupport.on_load(:active_record) do
+  require "active_median/model"
   extend(ActiveMedian::Model)
 end
+
+ActiveSupport.on_load(:mongoid) do
+  require "active_median/mongoid"
+  Mongoid::Document::ClassMethods.include(ActiveMedian::Mongoid)
+end

data/lib/active_median/enumerable.rb

@@ -0,0 +1,41 @@
+module Enumerable
+  unless method_defined?(:median)
+    def median(*args, &block)
+      if !block && respond_to?(:scoping)
+        scoping { @klass.median(*args) }
+      elsif !block && respond_to?(:with_scope)
+        with_scope(self) { klass.median(*args) }
+      else
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0)" if args.any?
+        percentile(0.5, &block)
+      end
+    end
+  end
+
+  unless method_defined?(:percentile)
+    def percentile(*args, &block)
+      if !block && respond_to?(:scoping)
+        scoping { @klass.percentile(*args) }
+      elsif !block && respond_to?(:with_scope)
+        with_scope(self) { klass.percentile(*args) }
+      else
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 1)" if args.size != 1
+
+        percentile = args[0].to_f
+        raise ArgumentError, "percentile is not between 0 and 1" if percentile < 0 || percentile > 1
+
+        # uses C=1 variant, like percentile_cont
+        # https://en.wikipedia.org/wiki/Percentile#The_linear_interpolation_between_closest_ranks_method
+        sorted = map(&block).sort
+        x = percentile * (sorted.size - 1)
+        r = x % 1
+        i = x.floor
+        if i == sorted.size - 1
+          sorted[-1]
+        else
+          sorted[i] + r * (sorted[i + 1] - sorted[i])
+        end
+      end
+    end
+  end
+end

data/lib/active_median/model.rb

@@ -1,20 +1,69 @@
 module ActiveMedian
   module Model
     def median(column)
+      percentile(column, 0.5)
+    end
+
+    def percentile(column, percentile)
+      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"
+      end
+
+      # column resolution
+      node = relation.send(:arel_columns, [column]).first
+      node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
+      column = relation.connection.visitor.accept(node, Arel::Collectors::SQLString.new).value
+
+      # prevent SQL injection
+      percentile = connection.quote(percentile)
+
       group_values = all.group_values
 
       relation =
         case connection.adapter_name
         when /mysql/i
+          # assume mariadb by default
+          # use send as this method is private in Rails 4.2
+          mariadb = connection.send(:mariadb?) rescue true
+
+          if mariadb
+            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)
+          else
+            # if mysql gets native function, check (and memoize) version first
+            select(*group_values, "PERCENTILE_CONT(#{column}, #{percentile})")
+          end
+        when /sqlserver/i
           if group_values.any?
             over = "PARTITION BY #{group_values.join(", ")}"
           end
 
-          select(*group_values, "PERCENTILE_CONT(0.50) WITHIN GROUP (ORDER BY #{column}) OVER (#{over})").unscope(:group)
+          select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over})").unscope(:group)
         when /sqlite/i
-          select(*group_values, "MEDIAN(#{column})")
+          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"
+          end
+        when /postg/i, /redshift/i # postgis too
+          select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column})")
         else
-          select(*group_values, "PERCENTILE_CONT(0.50) WITHIN GROUP (ORDER BY #{column})")
+          raise "Connection adapter not supported: #{connection.adapter_name}"
         end
 
       result = connection.select_all(relation.to_sql)
@@ -22,16 +71,20 @@ module ActiveMedian
       # typecast
       rows = []
       columns = result.columns
-      cast_method = ActiveRecord::VERSION::MAJOR < 5 ? :type_cast : :cast_value
       result.rows.each do |untyped_row|
-        rows << (result.column_types.empty? ? untyped_row : columns.each_with_index.map { |c, i| untyped_row[i] ? result.column_types[c].send(cast_method, untyped_row[i]) : untyped_row[i] })
+        rows << (result.column_types.empty? ? untyped_row : columns.each_with_index.map { |c, i| untyped_row[i] ? result.column_types[c].send(:cast_value, untyped_row[i]) : untyped_row[i] })
       end
 
-      if group_values.any?
-        Hash[rows.map { |r| [r.size == 2 ? r[0] : r[0..-2], r[-1]] }]
-      else
-        rows[0] && rows[0][0]
-      end
+      result =
+        if group_values.any?
+          Hash[rows.map { |r| [r.size == 2 ? r[0] : r[0..-2], r[-1]] }]
+        else
+          rows[0] && rows[0][0]
+        end
+
+      result = Groupdate.process_result(relation, result) if defined?(Groupdate.process_result)
+
+      result
     end
   end
 end

data/lib/active_median/mongoid.rb

@@ -0,0 +1,30 @@
+module ActiveMedian
+  module Mongoid
+    def median(column)
+      percentile(column, 0.5)
+    end
+
+    # https://www.compose.com/articles/mongo-metrics-finding-a-happy-median/
+    def percentile(column, percentile)
+      percentile = percentile.to_f
+      raise ArgumentError, "percentile is not between 0 and 1" if percentile < 0 || percentile > 1
+
+      relation =
+        all
+        .asc(column)
+        .group(_id: nil, values: {"$push" => "$#{column}"}, count: {"$sum" => 1})
+        .project(values: 1, count: {"$subtract" => ["$count", 1]})
+        .project(values: 1, count: 1, x: {"$multiply" => ["$count", percentile]})
+        .project(values: 1, count: 1, r: {"$mod" => ["$x", 1]}, i: {"$floor" => "$x"})
+        .project(values: 1, count: 1, r: 1, i: 1, i2: {"$add" => ["$i", 1]})
+        .project(values: 1, count: 1, r: 1, i: 1, i2: {"$min" => ["$i2", "$count"]})
+        .project(r: 1, beginValue: {"$arrayElemAt" => ["$values", "$i"]}, endValue: {"$arrayElemAt" => ["$values", "$i2"]})
+        .project(r: 1, beginValue: 1, result: {"$subtract" => ["$endValue", "$beginValue"]})
+        .project(beginValue: 1, result: {"$multiply" => ["$result", "$r"]})
+        .project(result: {"$add" => ["$beginValue", "$result"]})
+
+      res = collection.aggregate(relation.pipeline).first
+      res ? res["result"] : nil
+    end
+  end
+end

data/lib/active_median/version.rb

@@ -1,3 +1,3 @@
 module ActiveMedian
-  VERSION = "0.2.0"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_median
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !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'
 description: 
 email: andrew@chartkick.com
 executables: []
@@ -90,7 +118,9 @@ files:
 - LICENSE.txt
 - README.md
 - lib/active_median.rb
+- lib/active_median/enumerable.rb
 - lib/active_median/model.rb
+- lib/active_median/mongoid.rb
 - lib/active_median/version.rb
 homepage: https://github.com/ankane/active_median
 licenses:
@@ -104,16 +134,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Median for ActiveRecord
+summary: Median and percentile for Active Record, Mongoid, arrays, and hashes
 test_files: []