hightop 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b7e3f9ed74cce5d6a2e2a40f74634de04bcdcf8
-  data.tar.gz: a4b20f5a241a447bac6b3d1eefc3123d93d076e2
+SHA256:
+  metadata.gz: 7bfda8167d2141d8bd0be9678f1f285fe8417d0deecac5a04cee44f50efcf876
+  data.tar.gz: 0414c92e5702679fc169dbecb03d754e79461968e97a39cd2cca15d94ec4daa3
 SHA512:
-  metadata.gz: 8a9fa28eac3b9273a8cb63f74031c1bfd6698dd409601ab4ccc8182b9eca4f8233e7e1d8de67053de8ae9a0bc621eee849f34e60addbba089a566ee698603eaf
-  data.tar.gz: 046cb949463896d1ee5637dcb58529c5d6a9742c8f868fc6a2d85d252d353c6ccff2c8d0dd03e65e715c51d7d2347aaba309e18d1010171ac1b53f659ababcb1
+  metadata.gz: baad6fa1e6f4f404fd2f33448a971412ea9bf50257f5dd69531e341aa0a3afb69c816ac3191a9988ed8f30b19cce2c1d0837fb077e78fe589a7975b0283ec6d7
+  data.tar.gz: a66db10388aff6057d63f9ae977a700c0065d222a52dd04df0e7ea4bbd87f5ee51a145ff875aea5b9042dbbbaff2a10543f612519b3c65ec525852728aef5f82

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1
+
+- Added support for arrays and hashes
+
 ## 0.2.0
 
 - Use keyword arguments

data/LICENSE.txt

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

data/README.md

@@ -2,8 +2,6 @@
 
 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)
 ```
@@ -14,7 +12,25 @@ instead of
 Visit.group(:browser).where("browser IS NOT NULL").order("count_all DESC, browser").count
 ```
 
-Be sure to [sanitize user input](http://rails-sqli.org/) like you must with `group`.
+Be sure to [sanitize user input](https://rails-sqli.org/) like you must with `group`
+
+Also works with arrays and hashes
+
+```ruby
+["up", "up", "down"].top(1)
+```
+
+[![Build Status](https://travis-ci.org/ankane/hightop.svg)](https://travis-ci.org/ankane/hightop)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'hightop'
+```
+
+## Options
 
 Limit the results
 
@@ -37,7 +53,7 @@ Visit.top([:city, :browser])
 And expressions
 
 ```ruby
-Visit.top("LOWER(referring_domain)")
+Visit.top(Arel.sql("LOWER(referring_domain)"))
 ```
 
 And distinct
@@ -52,18 +68,36 @@ And min count
 Visit.top(:city, min: 10)
 ```
 
-## Installation
+## Arrays and Hashes
 
-Add this line to your application’s Gemfile:
+Arrays
 
 ```ruby
-gem 'hightop'
+["up", "up", "down"].top
 ```
 
-And then execute:
+Hashes
+
+```ruby
+{a: "up", b: "up", c: "down"}.top { |k, v| v }
+```
 
-```sh
-bundle
+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

data/lib/hightop/enumerable.rb

@@ -0,0 +1,26 @@
+module Enumerable
+  def top(*args, &block)
+    if block || !respond_to?(:scoping)
+      limit, options, _ = args
+      if limit.is_a?(Hash) && args.size == 1
+        options = limit
+        limit = nil
+      end
+      options ||= {}
+      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]
+    else
+      scoping { @klass.send(:top, *args, &block) }
+    end
+  end
+end

data/lib/hightop/kicks.rb

@@ -0,0 +1,29 @@
+module Hightop
+  module Kicks
+    def top(column, limit = nil, distinct: nil, uniq: nil, min: nil, nil: nil)
+      distinct ||= 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
+
+      # terribly named option
+      unless binding.local_variable_get(:nil)
+        (column.is_a?(Array) ? column : [column]).each do |c|
+          relation = relation.where("#{c} IS NOT NULL")
+        end
+      end
+
+      if min
+        relation = relation.having("COUNT(#{distinct ? "DISTINCT #{distinct}" : '*'}) >= #{min.to_i}")
+      end
+
+      if distinct
+        relation.distinct.count(distinct)
+      else
+        relation.count
+      end
+    end
+  end
+end

data/lib/hightop/version.rb

@@ -1,3 +1,3 @@
 module Hightop
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/hightop.rb

@@ -1,37 +1,11 @@
-require "hightop/version"
-require "active_record"
-
-module Hightop
-  def top(column, limit = nil, distinct: nil, uniq: nil, min: nil, nil: nil)
-    distinct ||= 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
-
-    # terribly named option
-    unless binding.local_variable_get(:nil)
-      (column.is_a?(Array) ? column : [column]).each do |c|
-        relation = relation.where("#{c} IS NOT NULL")
-      end
-    end
+# dependencies
+require "active_support"
 
-    if min
-      relation = relation.having("COUNT(#{distinct ? "DISTINCT #{distinct}" : '*'}) >= #{min.to_i}")
-    end
+# modules
+require "hightop/enumerable"
+require "hightop/kicks"
+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
+  extend Hightop::Kicks
 end
-
-ActiveRecord::Base.send :extend, Hightop

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hightop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2019-08-05 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: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !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,19 @@ 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/version.rb
-- test/hightop_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/hightop
 licenses:
 - MIT
@@ -111,18 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A nice shortcut for group count queries
-test_files:
-- test/hightop_test.rb
-- test/test_helper.rb
+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,11 +0,0 @@
-language: ruby
-rvm: 2.2.5
-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,117 +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 test_bad_argument
-    assert_raises(ArgumentError) do
-      Visit.top(:city, boom: true)
-    end
-  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