hightop 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340c609cb491de09f5c69f80b3e237126c081a8167565c78d6f28cac692cc34b
-  data.tar.gz: 0aa4d15e3ac6503a73f664602d0d07f1a0e956202f93411ec51d663dcca9b2ff
+  metadata.gz: e986b06b74104ea5fb99fe92abdb061eab4cc225ba9fa4f34216eadcd704e556
+  data.tar.gz: 5ca8954b8ce39c1212e0bc0b651e22450ff26b17795665b561cc7e4bbb134067
 SHA512:
-  metadata.gz: 31bcc5dcc655886f5dad2ebe27f33a7f56702b0503883bac779a944b502dc9bf1f27694c1eb83e4d36ca908fbb1bbe5e9b09706b5536f1ba53616e555204c579
-  data.tar.gz: 1e4d59093c22c49d3166368d8b23386ca7366dd9fc1b31e813e9df81bdd5d3b3e7d87ece4d36bf6b94deef69d2cd093927c0d9eeb62582fd357feed0c381564d
+  metadata.gz: e9d93d7b9edcce9dcfb6f3b7912ef3252454731bcc68d45cc9ff391df854a6fe49e5d7ca269780e55e98cf1481a17ef3472427de69694d6098cfdcacf9e61c7d
+  data.tar.gz: cd86dfd59b77d39482d06d0a6e9f59869ca15eaab6eef6e5cc62f754ad9d3addd781e21749a192a181385620b2508b520ee22da1f2c397566ac82159778a65d2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
+## 0.2.4 (2020-09-07)
+
+- Added warning for non-attribute argument
+- Added deprecation warning for `uniq`
+
 ## 0.2.3 (2020-06-18)
 
-- Dropped support for Rails 4.2 and Ruby 2.3
+- Dropped support for Active Record 4.2 and Ruby 2.3
 - Fixed deprecation warning in Ruby 2.7
 
 ## 0.2.2 (2019-08-12)

data/lib/hightop.rb

@@ -6,6 +6,7 @@ require "hightop/enumerable"
 require "hightop/version"
 
 ActiveSupport.on_load(:active_record) do
+  require "hightop/utils"
   require "hightop/kicks"
   extend Hightop::Kicks
 end

data/lib/hightop/kicks.rb

@@ -1,22 +1,34 @@
 module Hightop
   module Kicks
     def top(column, limit = nil, distinct: nil, uniq: nil, min: nil, nil: nil)
+      warn "[hightop] uniq is deprecated. Use distinct instead" if uniq
+
+      columns = column.is_a?(Array) ? column : [column]
+      columns.each { |c| Utils.validate_column(c) }
+
       distinct ||= uniq
-      order_str = column.is_a?(Array) ? column.map(&:to_s).join(", ") : column
-      relation = group(column).order(["count_#{distinct || 'all'} DESC", order_str])
+      Utils.validate_column(distinct) if distinct
+
+      relation = group(*columns).order("1 DESC", *columns)
       if limit
         relation = relation.limit(limit)
       end
 
       # terribly named option
       unless binding.local_variable_get(:nil)
-        (column.is_a?(Array) ? column : [column]).each do |c|
+        columns.each do |c|
+          c = Utils.resolve_column(self, c)
           relation = relation.where("#{c} IS NOT NULL")
         end
       end
 
       if min
-        relation = relation.having("COUNT(#{distinct ? "DISTINCT #{distinct}" : '*'}) >= #{min.to_i}")
+        if distinct
+          d = Utils.resolve_column(self, distinct)
+          relation = relation.having("COUNT(DISTINCT #{d}) >= #{min.to_i}")
+        else
+          relation = relation.having("COUNT(*) >= #{min.to_i}")
+        end
       end
 
       if distinct

data/lib/hightop/mongoid.rb

@@ -3,19 +3,23 @@ module Hightop
     # super helpful article
     # https://maximomussini.com/posts/mongoid-aggregation-dsl/
     def top(column, limit = nil, distinct: nil, uniq: nil, min: nil, nil: nil)
+      warn "[hightop] uniq is deprecated. Use distinct instead" if uniq
+
+      columns = column.is_a?(Array) ? column : [column]
+
       distinct ||= uniq
 
       relation = all
 
       # terribly named option
       unless binding.local_variable_get(:nil)
-        (column.is_a?(Array) ? column : [column]).each do |c|
+        columns.each do |c|
           relation = relation.and(c.ne => nil)
         end
       end
 
       ids = {}
-      Array(column).each_with_index do |c, i|
+      columns.each_with_index do |c, i|
         ids["c#{i}"] = "$#{c}"
       end
 

data/lib/hightop/utils.rb

@@ -0,0 +1,21 @@
+module Hightop
+  module Utils
+    class << self
+      # basic version of Active Record disallow_raw_sql!
+      # symbol = column (safe), Arel node = SQL (safe), other = untrusted
+      # matches table.column and column
+      def validate_column(column)
+        unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral) || /\A\w+(\.\w+)?\z/i.match(column.to_s)
+          warn "[hightop] Non-attribute argument: #{column}. Use Arel.sql() for known-safe values. This will raise an error in Hightop 0.3.0"
+        end
+      end
+
+      # resolves eagerly
+      def resolve_column(relation, column)
+        node = relation.send(:relation).send(:arel_columns, [column]).first
+        node = Arel::Nodes::SqlLiteral.new(node) if node.is_a?(String)
+        relation.connection.visitor.accept(node, Arel::Collectors::SQLString.new).value
+      end
+    end
+  end
+end

data/lib/hightop/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hightop
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -93,6 +93,7 @@ files:
 - lib/hightop/enumerable.rb
 - lib/hightop/kicks.rb
 - lib/hightop/mongoid.rb
+- lib/hightop/utils.rb
 - lib/hightop/version.rb
 homepage: https://github.com/ankane/hightop
 licenses: