active_median 0.2.5 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -3
  3. data/LICENSE.txt +1 -1
  4. data/README.md +20 -19
  5. data/lib/active_median/model.rb +29 -19
  6. data/lib/active_median/version.rb +1 -1
  7. metadata +11 -95
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cbc48a266db4698647e93b35bdad3e2ed1fc131ec48a2a00e1ac33583f693c4d
4
- data.tar.gz: 9e49da11f496e63c1fca879b7f6b509cbc80b6551f22743f9f586dfdf6f3d2f3
3
+ metadata.gz: 629f5530448797da4aca90cd7d89f1b37550caeeacb64a7ce5f56c761dbad09a
4
+ data.tar.gz: 5d9b666c75a1c3ac976f968df91422e9cbc5d2c89f3f41a6cd58a7a409ef8c47
5
5
  SHA512:
6
- metadata.gz: 7c37697facc95126f6b11bd29831f0aa685b781242a729c86e938e9f4be0a0b7fbfadbdf8ae246f987f452bb7977de21f2f879860f945f1a7bc9db005f85dc49
7
- data.tar.gz: d37c90a02b845b8a2cd8e41ed5109da758ca51c9921675f7f63e30e0921e430eed193d6ae02676e3aa08c5eaf97207d29fd8f50540e1be060924022aa818dc03
6
+ metadata.gz: f45451ab6d041058e087a88e56c0faaccfb066a96f3c9f48fae7abc4edbca67dcbf3841bdd142133b5b272847e54e783591046ef8f77589305fb412bdc213c94
7
+ data.tar.gz: ed76ff4622fbc943d3190c060193a55fb2d74f16541ccf8965b32313019e22a4bbd45eeb120d8aa8eb3f6866a1601e975123bc1276367c9a8128c2d796e04860
data/CHANGELOG.md CHANGED
@@ -1,3 +1,26 @@
1
+ ## 0.3.1 (2021-02-21)
2
+
3
+ - Fixed error with relations with `select` clauses
4
+
5
+ ## 0.3.0 (2021-02-08)
6
+
7
+ - Added column alias
8
+ - Added support for percentiles with SQLite (switched extensions)
9
+ - Raise `ActiveRecord::UnknownAttributeReference` for non-attribute arguments
10
+ - Dropped support for Active Record < 5.2
11
+
12
+ ## 0.2.8 (2021-01-16)
13
+
14
+ - Fixed bug with removing order
15
+
16
+ ## 0.2.7 (2021-01-16)
17
+
18
+ - Fixed error with order
19
+
20
+ ## 0.2.6 (2020-12-18)
21
+
22
+ - Fixed error with certain column types for Active Record 6.1
23
+
1
24
  ## 0.2.5 (2020-09-07)
2
25
 
3
26
  - Added warning for non-attribute argument
@@ -9,7 +32,7 @@
9
32
  ## 0.2.3 (2019-09-03)
10
33
 
11
34
  - Added support for Mongoid
12
- - Dropped support for Rails 4.2
35
+ - Dropped support for Active Record 4.2
13
36
 
14
37
  ## 0.2.2 (2018-10-29)
15
38
 
@@ -36,11 +59,11 @@ Breaking
36
59
 
37
60
  ## 0.1.3 (2016-03-22)
38
61
 
39
- - Added support for ActiveRecord 5.0
62
+ - Added support for Active Record 5.0
40
63
 
41
64
  ## 0.1.2 (2014-12-27)
42
65
 
43
- - Added support for ActiveRecord 4.2
66
+ - Added support for Active Record 4.2
44
67
 
45
68
  ## 0.1.1 (2014-08-12)
46
69
 
data/LICENSE.txt CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2013-2020 Andrew Kane
1
+ Copyright (c) 2013-2021 Andrew Kane
2
2
 
3
3
  MIT License
4
4
 
data/README.md CHANGED
@@ -12,7 +12,7 @@ Supports:
12
12
 
13
13
  :fire: Uses native functions for blazing performance
14
14
 
15
- [![Build Status](https://travis-ci.org/ankane/active_median.svg?branch=master)](https://travis-ci.org/ankane/active_median)
15
+ [![Build Status](https://github.com/ankane/active_median/workflows/build/badge.svg?branch=master)](https://github.com/ankane/active_median/actions)
16
16
 
17
17
  ## Getting Started
18
18
 
@@ -44,19 +44,6 @@ Works with grouping, too
44
44
  Order.group(:store_id).median(:total)
45
45
  ```
46
46
 
47
- ## User Input
48
-
49
- 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`.
50
-
51
- ```ruby
52
- column = params[:column]
53
-
54
- # check against permitted columns
55
- raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
56
-
57
- User.median(column)
58
- ```
59
-
60
47
  ## Arrays and Hashes
61
48
 
62
49
  Median
@@ -94,10 +81,18 @@ mysql <options> < load.sql
94
81
 
95
82
  ### SQLite
96
83
 
97
- 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:
84
+ SQLite requires 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.
85
+
86
+ On Linux, use:
98
87
 
99
88
  ```sh
100
- gcc -g -fPIC -dynamiclib extension-functions.c -o extension-functions.dylib
89
+ gcc -g -fPIC -shared -lsqlite3 percentile.c -o percentile.so
90
+ ```
91
+
92
+ On Mac, use:
93
+
94
+ ```sh
95
+ gcc -g -fPIC -dynamiclib -L/usr/local/opt/sqlite/lib -lsqlite3 percentile.c -o percentile.dylib
101
96
  ```
102
97
 
103
98
  To load it in Rails, create an initializer with:
@@ -105,15 +100,21 @@ To load it in Rails, create an initializer with:
105
100
  ```ruby
106
101
  db = ActiveRecord::Base.connection.raw_connection
107
102
  db.enable_load_extension(1)
108
- db.load_extension("extension-functions.dylib")
103
+ db.load_extension("percentile.so") # or percentile.dylib
109
104
  db.enable_load_extension(0)
110
105
  ```
111
106
 
112
107
  ## Upgrading
113
108
 
114
- ### 0.2.0
109
+ ### 0.3.0
110
+
111
+ ActiveMedian 0.3.0 protects against unsafe input by default. For non-attribute arguments, use:
112
+
113
+ ```ruby
114
+ Item.median(Arel.sql(known_safe_value))
115
+ ```
115
116
 
116
- A user-defined function is no longer needed for Postgres. Create a migration with `ActiveMedian.drop_function` to remove it.
117
+ Also, percentiles are now supported with SQLite. Use the [percentile extension](#sqlite) instead of `extension-functions`.
117
118
 
118
119
  ## Contributing
119
120
 
data/lib/active_median/model.rb CHANGED
@@ -1,20 +1,34 @@
1
1
  module ActiveMedian
2
2
  module Model
3
3
  def median(column)
4
- percentile(column, 0.5)
4
+ calculate_percentile(column, 0.5, "median")
5
5
  end
6
6
 
7
7
  def percentile(column, percentile)
8
+ calculate_percentile(column, percentile, "percentile")
9
+ end
10
+
11
+ private
12
+
13
+ def calculate_percentile(column, percentile, operation)
8
14
  percentile = percentile.to_f
9
15
  raise ArgumentError, "percentile is not between 0 and 1" if percentile < 0 || percentile > 1
10
16
 
11
17
  # basic version of Active Record disallow_raw_sql!
12
18
  # symbol = column (safe), Arel node = SQL (safe), other = untrusted
13
19
  # matches table.column and column
14
- unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral) || /\A\w+(\.\w+)?\z/i.match(column.to_s)
15
- warn "[active_median] Non-attribute argument: #{column}. Use Arel.sql() for known-safe values. This will raise an error in ActiveMedian 0.3.0"
20
+ unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral)
21
+ column = column.to_s
22
+ unless /\A\w+(\.\w+)?\z/i.match(column)
23
+ raise ActiveRecord::UnknownAttributeReference, "Query method called with non-attribute argument(s): #{column.inspect}. Use Arel.sql() for known-safe values."
24
+ end
16
25
  end
17
26
 
27
+ column_alias = relation.send(:column_alias_for, "#{operation} #{column.to_s.downcase}")
28
+ # safety check
29
+ # could quote, but want to keep consistent with Active Record
30
+ raise "Bad column alias: #{column_alias}. Please report a bug." unless column_alias =~ /\A[a-z0-9_]+\z/
31
+
18
32
  # column resolution
19
33
  node = relation.send(:arel_columns, [column]).first
20
34
  node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
@@ -25,6 +39,9 @@ module ActiveMedian
25
39
 
26
40
  group_values = all.group_values
27
41
 
42
+ # replace select to match behavior of average
43
+ relation = unscope(:select)
44
+
28
45
  relation =
29
46
  case connection.adapter_name
30
47
  when /mysql/i
@@ -37,42 +54,35 @@ module ActiveMedian
37
54
  over = "PARTITION BY #{group_values.join(", ")}"
38
55
  end
39
56
 
40
- select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over})").unscope(:group)
57
+ relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over}) AS #{column_alias}").unscope(:group)
41
58
  else
42
59
  # if mysql gets native function, check (and memoize) version first
43
- select(*group_values, "PERCENTILE_CONT(#{column}, #{percentile})")
60
+ relation.select(*group_values, "PERCENTILE_CONT(#{column}, #{percentile}) AS #{column_alias}")
44
61
  end
45
62
  when /sqlserver/i
46
63
  if group_values.any?
47
64
  over = "PARTITION BY #{group_values.join(", ")}"
48
65
  end
49
66
 
50
- select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over})").unscope(:group)
67
+ relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) OVER (#{over}) AS #{column_alias}").unscope(:group)
51
68
  when /sqlite/i
52
- case percentile.to_f
53
- when 0
54
- select(*group_values, "MIN(#{column})")
55
- when 0.5
56
- select(*group_values, "MEDIAN(#{column})")
57
- when 1
58
- select(*group_values, "MAX(#{column})")
59
- else
60
- # LOWER_QUARTILE and UPPER_QUARTILE use different calculation than 0.25 and 0.75
61
- raise "SQLite only supports 0, 0.5, and 1 percentiles"
62
- end
69
+ relation.select(*group_values, "PERCENTILE(#{column}, #{percentile} * 100) AS #{column_alias}")
63
70
  when /postg/i, /redshift/i # postgis too
64
- select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column})")
71
+ relation.select(*group_values, "PERCENTILE_CONT(#{percentile}) WITHIN GROUP (ORDER BY #{column}) AS #{column_alias}")
65
72
  else
66
73
  raise "Connection adapter not supported: #{connection.adapter_name}"
67
74
  end
68
75
 
76
+ # same as average
77
+ relation = relation.unscope(:order).distinct!(false) if group_values.empty?
78
+
69
79
  result = connection.select_all(relation.to_sql)
70
80
 
71
81
  # typecast
72
82
  rows = []
73
83
  columns = result.columns
74
84
  result.rows.each do |untyped_row|
75
- 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] })
85
+ rows << (result.column_types.empty? ? untyped_row : columns.each_with_index.map { |c, i| untyped_row[i] && result.column_types[c] ? result.column_types[c].send(:cast_value, untyped_row[i]) : untyped_row[i] })
76
86
  end
77
87
 
78
88
  result =
data/lib/active_median/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module ActiveMedian
2
- VERSION = "0.2.5"
2
+ VERSION = "0.3.1"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: active_median
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.5
4
+ version: 0.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Kane
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-09-07 00:00:00.000000000 Z
11
+ date: 2021-02-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport
@@ -16,100 +16,16 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '5'
19
+ version: '5.2'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: '5'
27
- - !ruby/object:Gem::Dependency
28
- name: bundler
29
- requirement: !ruby/object:Gem::Requirement
30
- requirements:
31
- - - ">="
32
- - !ruby/object:Gem::Version
33
- version: '0'
34
- type: :development
35
- prerelease: false
36
- version_requirements: !ruby/object:Gem::Requirement
37
- requirements:
38
- - - ">="
39
- - !ruby/object:Gem::Version
40
- version: '0'
41
- - !ruby/object:Gem::Dependency
42
- name: minitest
43
- requirement: !ruby/object:Gem::Requirement
44
- requirements:
45
- - - ">="
46
- - !ruby/object:Gem::Version
47
- version: '0'
48
- type: :development
49
- prerelease: false
50
- version_requirements: !ruby/object:Gem::Requirement
51
- requirements:
52
- - - ">="
53
- - !ruby/object:Gem::Version
54
- version: '0'
55
- - !ruby/object:Gem::Dependency
56
- name: pg
57
- requirement: !ruby/object:Gem::Requirement
58
- requirements:
59
- - - ">="
60
- - !ruby/object:Gem::Version
61
- version: '0'
62
- type: :development
63
- prerelease: false
64
- version_requirements: !ruby/object:Gem::Requirement
65
- requirements:
66
- - - ">="
67
- - !ruby/object:Gem::Version
68
- version: '0'
69
- - !ruby/object:Gem::Dependency
70
- name: rake
71
- requirement: !ruby/object:Gem::Requirement
72
- requirements:
73
- - - ">="
74
- - !ruby/object:Gem::Version
75
- version: '0'
76
- type: :development
77
- prerelease: false
78
- version_requirements: !ruby/object:Gem::Requirement
79
- requirements:
80
- - - ">="
81
- - !ruby/object:Gem::Version
82
- version: '0'
83
- - !ruby/object:Gem::Dependency
84
- name: activerecord
85
- requirement: !ruby/object:Gem::Requirement
86
- requirements:
87
- - - ">="
88
- - !ruby/object:Gem::Version
89
- version: '0'
90
- type: :development
91
- prerelease: false
92
- version_requirements: !ruby/object:Gem::Requirement
93
- requirements:
94
- - - ">="
95
- - !ruby/object:Gem::Version
96
- version: '0'
97
- - !ruby/object:Gem::Dependency
98
- name: groupdate
99
- requirement: !ruby/object:Gem::Requirement
100
- requirements:
101
- - - ">="
102
- - !ruby/object:Gem::Version
103
- version: '0'
104
- type: :development
105
- prerelease: false
106
- version_requirements: !ruby/object:Gem::Requirement
107
- requirements:
108
- - - ">="
109
- - !ruby/object:Gem::Version
110
- version: '0'
111
- description:
112
- email: andrew@chartkick.com
26
+ version: '5.2'
27
+ description:
28
+ email: andrew@ankane.org
113
29
  executables: []
114
30
  extensions: []
115
31
  extra_rdoc_files: []
@@ -126,7 +42,7 @@ homepage: https://github.com/ankane/active_median
126
42
  licenses:
127
43
  - MIT
128
44
  metadata: {}
129
- post_install_message:
45
+ post_install_message:
130
46
  rdoc_options: []
131
47
  require_paths:
132
48
  - lib
@@ -134,15 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
134
50
  requirements:
135
51
  - - ">="
136
52
  - !ruby/object:Gem::Version
137
- version: '2.4'
53
+ version: '2.6'
138
54
  required_rubygems_version: !ruby/object:Gem::Requirement
139
55
  requirements:
140
56
  - - ">="
141
57
  - !ruby/object:Gem::Version
142
58
  version: '0'
143
59
  requirements: []
144
- rubygems_version: 3.1.2
145
- signing_key:
60
+ rubygems_version: 3.2.3
61
+ signing_key:
146
62
  specification_version: 4
147
63
  summary: Median and percentile for Active Record, Mongoid, arrays, and hashes
148
64
  test_files: []