hightop 0.1.4 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19538edc7ac8f8cc81df7ad682c47ec6dfe0d38e
-  data.tar.gz: 2f2bb4d909ead9b64fa293627a784c5adeaadd2d
+SHA256:
+  metadata.gz: e986b06b74104ea5fb99fe92abdb061eab4cc225ba9fa4f34216eadcd704e556
+  data.tar.gz: 5ca8954b8ce39c1212e0bc0b651e22450ff26b17795665b561cc7e4bbb134067
 SHA512:
-  metadata.gz: ac01a53983e69a760c745bcddd99287774ae73d7b743dcf4be327b252c0524e3147b6e815a1560b735f6cdf2252d651402ea9b775468bd93300d056fdcea18d3
-  data.tar.gz: 37252ef2688c355c2aa327f36fd5025c7809986abfc256bb4f8ea0df48442c8add698d944261b2a0ee0d16ee5c3d52b352023ad7c334a6ec39fe80e80a3922f0
+  metadata.gz: e9d93d7b9edcce9dcfb6f3b7912ef3252454731bcc68d45cc9ff391df854a6fe49e5d7ca269780e55e98cf1481a17ef3472427de69694d6098cfdcacf9e61c7d
+  data.tar.gz: cd86dfd59b77d39482d06d0a6e9f59869ca15eaab6eef6e5cc62f754ad9d3addd781e21749a192a181385620b2508b520ee22da1f2c397566ac82159778a65d2

data/CHANGELOG.md

@@ -1,37 +1,59 @@
-## 0.1.4
+## 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 Active Record 4.2 and Ruby 2.3
+- Fixed deprecation warning in Ruby 2.7
+
+## 0.2.2 (2019-08-12)
+
+- Added support for Mongoid
+
+## 0.2.1 (2019-08-04)
+
+- Added support for arrays and hashes
+
+## 0.2.0 (2017-03-19)
+
+- Use keyword arguments
+
+## 0.1.4 (2016-02-04)
 
 - Added `distinct` option to replace `uniq`
 
-## 0.1.3
+## 0.1.3 (2015-06-18)
 
 - Fixed `min` option with `uniq`
 
-## 0.1.2
+## 0.1.2 (2014-11-05)
 
 - Added `min` option
 
-## 0.1.1
+## 0.1.1 (2014-07-02)
 
 - Added `uniq` option
 - Fixed `Model.limit(n).top`
 
-## 0.1.0
+## 0.1.0 (2014-06-11)
 
 - No changes, just bump
 
-## 0.0.4
+## 0.0.4 (2014-06-11)
 
 - Added support for multiple groups
 - Added `nil` option
 
-## 0.0.3
+## 0.0.3 (2014-06-11)
 
 - Fixed escaping
 
-## 0.0.2
+## 0.0.2 (2014-05-29)
 
 - Added `limit` parameter
 
-## 0.0.1
+## 0.0.1 (2014-05-11)
 
 - First release

data/LICENSE.txt

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

data/README.md

@@ -2,19 +2,28 @@
 
 A nice shortcut for group count queries
 
-[![Build Status](https://travis-ci.org/ankane/hightop.svg)](https://travis-ci.org/ankane/hightop)
-
 ```ruby
 Visit.top(:browser)
+# {
+#   "Chrome"  => 63,
+#   "Safari"  => 50,
+#   "Firefox" => 34
+# }
 ```
 
-instead of
+Works with Active Record, Mongoid, arrays and hashes
+
+[![Build Status](https://travis-ci.org/ankane/hightop.svg?branch=master)](https://travis-ci.org/ankane/hightop)
+
+## Installation
+
+Add this line to your application’s Gemfile:
 
 ```ruby
-Visit.group(:browser).where("browser IS NOT NULL").order("count_all DESC, browser").count
+gem 'hightop'
 ```
 
-Be sure to [sanitize user input](http://rails-sqli.org/) like you must with `group`.
+## Options
 
 Limit the results
 
@@ -37,7 +46,7 @@ Visit.top([:city, :browser])
 And expressions
 
 ```ruby
-Visit.top("LOWER(referring_domain)")
+Visit.top(Arel.sql("LOWER(referring_domain)"))
 ```
 
 And distinct
@@ -52,18 +61,49 @@ And min count
 Visit.top(:city, min: 10)
 ```
 
-## Installation
+## User Input
 
-Add this line to your application’s Gemfile:
+If passing user input as the column, be sure to sanitize it first [like you must](https://rails-sqli.org/) with `group`.
 
 ```ruby
-gem 'hightop'
+column = params[:column]
+
+# check against permitted columns
+raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
+
+User.top(column)
 ```
 
-And then execute:
+## Arrays and Hashes
 
-```sh
-bundle
+Arrays
+
+```ruby
+["up", "up", "down"].top
+```
+
+Hashes
+
+```ruby
+{a: "up", b: "up", c: "down"}.top { |k, v| v }
+```
+
+Limit the results
+
+```ruby
+["up", "up", "down"].top(1)
+```
+
+Include nil values
+
+```ruby
+[nil, nil, "down"].top(nil: true)
+```
+
+Min count
+
+```ruby
+["up", "up", "down"].top(min: 2)
 ```
 
 ## History
@@ -78,3 +118,12 @@ 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/hightop/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/hightop.git
+cd hightop
+bundle install
+bundle exec rake test
+```

data/lib/hightop.rb

@@ -1,41 +1,17 @@
-require "hightop/version"
-require "active_record"
-
-module Hightop
-  def top(column, limit = nil, options = {})
-    if limit.is_a?(Hash)
-      options = limit
-      limit = nil
-    end
-
-    distinct = options[:distinct] || options[:uniq]
-    order_str = column.is_a?(Array) ? column.map(&:to_s).join(", ") : column
-    relation = group(column).order("count_#{distinct || 'all'} DESC, #{order_str}")
-    if limit
-      relation = relation.limit(limit)
-    end
+# dependencies
+require "active_support"
 
-    unless options[:nil]
-      (column.is_a?(Array) ? column : [column]).each do |c|
-        relation = relation.where("#{c} IS NOT NULL")
-      end
-    end
-
-    if options[:min]
-      relation = relation.having("COUNT(#{distinct ? "DISTINCT #{distinct}" : '*'}) >= #{options[:min].to_i}")
-    end
+# modules
+require "hightop/enumerable"
+require "hightop/version"
 
-    if distinct
-      # since relation.respond_to?(:distinct) can't be used
-      if ActiveRecord::VERSION::MAJOR > 3
-        relation.distinct.count(distinct)
-      else
-        relation.uniq.count(distinct)
-      end
-    else
-      relation.count
-    end
-  end
+ActiveSupport.on_load(:active_record) do
+  require "hightop/utils"
+  require "hightop/kicks"
+  extend Hightop::Kicks
 end
 
-ActiveRecord::Base.send :extend, Hightop
+ActiveSupport.on_load(:mongoid) do
+  require "hightop/mongoid"
+  Mongoid::Document::ClassMethods.include(Hightop::Mongoid)
+end

data/lib/hightop/enumerable.rb

@@ -0,0 +1,24 @@
+module Enumerable
+  def top(*args, **options, &block)
+    if block || !(respond_to?(:scoping) || respond_to?(:with_scope))
+      # TODO raise error if too many arguments
+      limit = args[0]
+      min = options[:min]
+
+      counts = Hash.new(0)
+      map(&block).each do |v|
+        counts[v] += 1
+      end
+      counts.delete(nil) unless options[:nil]
+      counts.select! { |_, v| v >= min } if min
+
+      arr = counts.sort_by { |_, v| -v }
+      arr = arr[0...limit] if limit
+      Hash[arr]
+    elsif respond_to?(:scoping)
+      scoping { @klass.send(:top, *args, **options, &block) }
+    else
+      with_scope(self) { klass.send(:top, *args, **options, &block) }
+    end
+  end
+end

data/lib/hightop/kicks.rb

@@ -0,0 +1,41 @@
+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
+      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)
+        columns.each do |c|
+          c = Utils.resolve_column(self, c)
+          relation = relation.where("#{c} IS NOT NULL")
+        end
+      end
+
+      if min
+        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
+        relation.distinct.count(distinct)
+      else
+        relation.count
+      end
+    end
+  end
+end

data/lib/hightop/mongoid.rb

@@ -0,0 +1,56 @@
+module Hightop
+  module Mongoid
+    # 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)
+        columns.each do |c|
+          relation = relation.and(c.ne => nil)
+        end
+      end
+
+      ids = {}
+      columns.each_with_index do |c, i|
+        ids["c#{i}"] = "$#{c}"
+      end
+
+      if distinct
+        # group with distinct column first, then group without it
+        # https://stackoverflow.com/questions/24761266/select-group-by-count-and-distinct-count-in-same-mongodb-query/24770233#24770233
+        distinct_ids = ids.merge("c#{ids.size}" => "$#{distinct}")
+        relation = relation.group(_id: distinct_ids, count: {"$sum" => 1})
+        ids.each_key do |k|
+          ids[k] = "$_id.#{k}"
+        end
+      end
+
+      relation = relation.group(_id: ids, count: {"$sum" => 1})
+
+      if min
+        relation.pipeline.push("$match" => {"count" => {"$gte" => min}})
+      end
+
+      relation = relation.desc(:count)
+      if limit
+        relation = relation.limit(limit)
+      end
+
+      result = {}
+      collection.aggregate(relation.pipeline).each do |doc|
+        key = doc["_id"].values
+        key = key[0] if key.size == 1
+        result[key] = doc["count"]
+      end
+      result
+    end
+  end
+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.1.4"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hightop
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 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: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -80,25 +80,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A nice shortcut for group count queries
-email:
-- andrew@chartkick.com
+description: 
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- hightop.gemspec
 - lib/hightop.rb
+- lib/hightop/enumerable.rb
+- lib/hightop/kicks.rb
+- lib/hightop/mongoid.rb
+- lib/hightop/utils.rb
 - lib/hightop/version.rb
-- test/hightop_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/hightop
 licenses:
 - MIT
@@ -111,19 +107,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A nice shortcut for group count queries
-test_files:
-- test/hightop_test.rb
-- test/test_helper.rb
-has_rdoc: 
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.1
-gemfile:
-  - Gemfile
-sudo: false
-before_install: gem install bundler
-script: bundle exec rake test
-notifications:
-  email:
-    on_success: never
-    on_failure: change

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in hightop.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-end

data/hightop.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "hightop/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "hightop"
-  spec.version       = Hightop::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "A nice shortcut for group count queries"
-  spec.description   = "A nice shortcut for group count queries"
-  spec.homepage      = "https://github.com/ankane/hightop"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activerecord"
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "sqlite3"
-end

data/test/hightop_test.rb

@@ -1,111 +0,0 @@
-require_relative "test_helper"
-
-class TestHightop < Minitest::Test
-  def setup
-    Visit.delete_all
-  end
-
-  def test_top
-    create_city("San Francisco", 3)
-    create_city("Chicago", 2)
-    expected = {
-      "San Francisco" => 3,
-      "Chicago" => 2
-    }
-    assert_equal expected, Visit.top(:city)
-  end
-
-  def test_limit
-    create_city("San Francisco", 3)
-    create_city("Chicago", 2)
-    create_city("Boston", 1)
-    expected = {
-      "San Francisco" => 3,
-      "Chicago" => 2
-    }
-    assert_equal expected, Visit.top(:city, 2)
-    assert_equal expected, Visit.limit(2).top(:city)
-  end
-
-  def test_nil_values
-    create_city("San Francisco", 3)
-    create_city(nil, 2)
-    expected = {
-      "San Francisco" => 3
-    }
-    assert_equal expected, Visit.top(:city)
-  end
-
-  def test_nil_option
-    create_city("San Francisco", 3)
-    create_city(nil, 2)
-    expected = {
-      "San Francisco" => 3,
-      nil => 2
-    }
-    assert_equal expected, Visit.top(:city, nil: true)
-  end
-
-  def test_multiple_groups
-    create_city("San Francisco")
-    expected = {
-      ["San Francisco", "San Francisco"] => 1
-    }
-    assert_equal expected, Visit.top([:city, :city])
-  end
-
-  def test_expressions
-    create_city("San Francisco")
-    expected = {
-      "san francisco" => 1
-    }
-    assert_equal expected, Visit.top("LOWER(city)")
-  end
-
-  def test_distinct
-    create(city: "San Francisco", user_id: 1)
-    create(city: "San Francisco", user_id: 1)
-    expected = {
-      "San Francisco" => 1
-    }
-    assert_equal expected, Visit.top(:city, distinct: :user_id)
-  end
-
-  def test_uniq
-    create(city: "San Francisco", user_id: 1)
-    create(city: "San Francisco", user_id: 1)
-    expected = {
-      "San Francisco" => 1
-    }
-    assert_equal expected, Visit.top(:city, uniq: :user_id)
-  end
-
-  def test_min
-    create_city("San Francisco", 3)
-    create_city("Chicago", 2)
-    expected = {
-      "San Francisco" => 3
-    }
-    assert_equal expected, Visit.top(:city, min: 3)
-  end
-
-  def test_min_distinct
-    create(city: "San Francisco", user_id: 1)
-    create(city: "San Francisco", user_id: 1)
-    create(city: "San Francisco", user_id: 2)
-    create(city: "Chicago", user_id: 1)
-    create(city: "Chicago", user_id: 1)
-    expected = {
-      "San Francisco" => 2
-    }
-    assert_equal expected, Visit.top(:city, min: 2, distinct: :user_id)
-  end
-
-  def create_city(city, count = 1)
-    create({city: city}, count)
-  end
-
-  def create(attributes, count = 1)
-    count.times { Visit.create!(attributes) }
-  end
-end

data/test/test_helper.rb

@@ -1,21 +0,0 @@
-require "bundler/setup"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-require "logger"
-
-Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
-
-# for debugging
-# ActiveRecord::Base.logger = Logger.new(STDOUT)
-
-# migrations
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-
-ActiveRecord::Migration.create_table :visits do |t|
-  t.string :city
-  t.string :user_id
-end
-
-class Visit < ActiveRecord::Base
-end