active_median 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d759f5155e0a9687eeb845cf25a65daae5fe2a475bed1dcc071b742413b8c4
-  data.tar.gz: 9eb8b10f9ff8526adcea04beb4fa68fb11e61b544f11413925280c5d37f10e2b
+  metadata.gz: 86998cba53771c73de5fcc9c5dc8a869a4ff061029828dcf0ce8fab89852e346
+  data.tar.gz: 23482bad0017c7b16422e9be9961783a6674576a65955a6d228db22f556ef84b
 SHA512:
-  metadata.gz: af49d340ff2b1298d1706381a7879ac3666e9077a56607c2d8809b132f93eef3eb8beb9996aa7599157a3d900ad3951e606413cb936f23d045115d8baead0121
-  data.tar.gz: ed82a1e318b79372aace81c56d2ca9bd9c59f373be5795f2e595fc8a60c7a7bdd9f9191e5a46069c4ea7405347e3057abb3c1ad6ae794a252cdce6de7f5411b6
+  metadata.gz: 6c5f02aa5f51169214536006caa8509b4fcc7041d1be680805388019d092f1517c54fbdb0738f4fa80d89609ea959ba1c741a83460c651da62288916c47e1a5e
+  data.tar.gz: d53d94e2835a54521a17977f035c04d40766d958473890cfcacfd4cae5d99d792fdea5c8f18ff975155f0d25d5854134c7770f1d0e578e70d5c4aceddeed115c

data/CHANGELOG.md

@@ -1,19 +1,23 @@
-## 0.2.3
+## 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
+## 0.2.2 (2018-10-29)
 
 - Added support for MySQL with udf_infusion
 - Added support for SQL Server and Redshift
 
-## 0.2.1
+## 0.2.1 (2018-10-15)
 
 - Added support for arrays and hashes
 - Added compatibility with Groupdate 4
 
-## 0.2.0
+## 0.2.0 (2018-10-15)
 
 - Added support for MariaDB 10.3.3+ and SQLite
 - Use `PERCENTILE_CONT` for 4x performance increase
@@ -22,23 +26,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-2019 Andrew Kane
+Copyright (c) 2013-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # ActiveMedian
 
-Median for Active Record, Mongoid, arrays, and hashes
+Median and percentile for Active Record, Mongoid, arrays, and hashes
 
 Supports:
 
@@ -11,7 +11,7 @@ Supports:
 
 :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
 
@@ -25,11 +25,19 @@ For MySQL and SQLite, also follow [these instructions](#additional-instructions)
 
 ## Models
 
+Median
+
 ```ruby
 Item.median(:price)
 ```
 
-Works with grouping, too.
+Percentile
+
+```ruby
+Item.percentile(:price, 0.95)
+```
+
+Works with grouping, too
 
 ```ruby
 Order.group(:store_id).median(:total)
@@ -37,11 +45,19 @@ Order.group(:store_id).median(:total)
 
 ## Arrays and Hashes
 
+Median
+
 ```ruby
 [1, 2, 3].median
 ```
 
-You can also pass a block.
+Percentile
+
+```ruby
+[1, 2, 3].percentile(0.75)
+```
+
+You can also pass a block
 
 ```ruby
 {a: 1, b: 2, c: 3}.median { |k, v| v }
@@ -106,3 +122,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/enumerable.rb

@@ -6,9 +6,35 @@ module Enumerable
       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
-        len = sorted.length
-        (sorted[(len - 1) / 2] + sorted[len / 2]) / 2.0
+        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

data/lib/active_median/model.rb

@@ -1,6 +1,16 @@
 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
+
+      # prevent SQL injection
+      percentile = connection.quote(percentile)
+
       group_values = all.group_values
 
       relation =
@@ -15,21 +25,31 @@ module ActiveMedian
               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)
           else
             # if mysql gets native function, check (and memoize) version first
-            select(*group_values, "PERCENTILE_CONT(#{column}, 0.50)")
+            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(0.50) WITHIN GROUP (ORDER BY #{column})")
+          select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column})")
         else
           raise "Connection adapter not supported: #{connection.adapter_name}"
         end

data/lib/active_median/mongoid.rb

@@ -1,21 +1,30 @@
 module ActiveMedian
   module Mongoid
-    # https://www.compose.com/articles/mongo-metrics-finding-a-happy-median/
     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
-        .group(_id: nil, count: {"$sum" => 1}, values: {"$push" => "$#{column}"})
-        .unwind("$values")
-        .asc(:values)
-        .project(count: {"$subtract" => ["$count", 1]}, values: 1)
-        .project(count: 1, values: 1, midpoint: {"$divide" => ["$count", 2]})
-        .project(count: 1, values: 1, midpoint: 1, high: {"$ceil" => "$midpoint"}, low: {"$floor" => "$midpoint"})
-        .group(_id: nil, values: {"$push" => "$values"}, high: {"$avg" => "$high"}, low: {"$avg" => "$low"})
-        .project(beginValue: {"$arrayElemAt" => ["$values", "$high"]}, endValue: {"$arrayElemAt" => ["$values", "$low"]})
-        .project(median: {"$avg" => ["$beginValue", "$endValue"]})
+        .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["median"] : nil
+      res ? res["result"] : nil
     end
   end
 end

data/lib/active_median/version.rb

@@ -1,3 +1,3 @@
 module ActiveMedian
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_median
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -141,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Median for Active Record, Mongoid, arrays, and hashes
+summary: Median and percentile for Active Record, Mongoid, arrays, and hashes
 test_files: []