hightop 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bfda8167d2141d8bd0be9678f1f285fe8417d0deecac5a04cee44f50efcf876
-  data.tar.gz: 0414c92e5702679fc169dbecb03d754e79461968e97a39cd2cca15d94ec4daa3
+  metadata.gz: 3e2fc0f11b1504620f8989548410fb965f5399f10a2a160f8911c72e1ee9be73
+  data.tar.gz: b9a4289ebbd844162263c513bfcc93ebcb1a7c97f27b7ec8bee511729d7b0d37
 SHA512:
-  metadata.gz: baad6fa1e6f4f404fd2f33448a971412ea9bf50257f5dd69531e341aa0a3afb69c816ac3191a9988ed8f30b19cce2c1d0837fb077e78fe589a7975b0283ec6d7
-  data.tar.gz: a66db10388aff6057d63f9ae977a700c0065d222a52dd04df0e7ea4bbd87f5ee51a145ff875aea5b9042dbbbaff2a10543f612519b3c65ec525852728aef5f82
+  metadata.gz: 4bb15ebfacc0e6383ca32f46cca4839d8f8a69180154ddf2a6a9fca65b5fe11cfbdcf087b3ec767d21fabfa75db197c4b7b1d1f68bd332e030076f1ea5c8f0e2
+  data.tar.gz: 5659dc207fb18a98d70febfbd51f28a5155672365ed9b9a8e06dceff27d0c640abbb99461c1410f6209571f4e283201724383d82fd732c7ddab49cbcc665a66d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.2
+
+- Added support for Mongoid
+
 ## 0.2.1
 
 - Added support for arrays and hashes

data/README.md

@@ -4,23 +4,16 @@ A nice shortcut for group count queries
 
 ```ruby
 Visit.top(:browser)
+# {
+#   "Chrome"  => 63,
+#   "Safari"  => 50,
+#   "Firefox" => 34
+# }
 ```
 
-instead of
+Works with Active Record, Mongoid, arrays and hashes
 
-```ruby
-Visit.group(:browser).where("browser IS NOT NULL").order("count_all DESC, browser").count
-```
-
-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)
+[![Build Status](https://travis-ci.org/ankane/hightop.svg?branch=master)](https://travis-ci.org/ankane/hightop)
 
 ## Installation
 
@@ -68,6 +61,19 @@ And min count
 Visit.top(:city, min: 10)
 ```
 
+## User Input
+
+If passing user input as the column, be sure to sanitize it first [like you must](https://rails-sqli.org/) with `group`.
+
+```ruby
+column = params[:column]
+
+# check against permitted columns
+raise "Unpermitted column" unless ["column_a", "column_b"].include?(column)
+
+User.top(column)
+```
+
 ## Arrays and Hashes
 
 Arrays

data/lib/hightop.rb

@@ -3,9 +3,14 @@ require "active_support"
 
 # modules
 require "hightop/enumerable"
-require "hightop/kicks"
 require "hightop/version"
 
 ActiveSupport.on_load(:active_record) do
+  require "hightop/kicks"
   extend Hightop::Kicks
 end
+
+ActiveSupport.on_load(:mongoid) do
+  require "hightop/mongoid"
+  Mongoid::Document::ClassMethods.include(Hightop::Mongoid)
+end

data/lib/hightop/enumerable.rb

@@ -1,6 +1,6 @@
 module Enumerable
   def top(*args, &block)
-    if block || !respond_to?(:scoping)
+    if block || !(respond_to?(:scoping) || respond_to?(:with_scope))
       limit, options, _ = args
       if limit.is_a?(Hash) && args.size == 1
         options = limit
@@ -19,8 +19,10 @@ module Enumerable
       arr = counts.sort_by { |_, v| -v }
       arr = arr[0...limit] if limit
       Hash[arr]
-    else
+    elsif respond_to?(:scoping)
       scoping { @klass.send(:top, *args, &block) }
+    else
+      with_scope(self) { klass.send(:top, *args, &block) }
     end
   end
 end

data/lib/hightop/mongoid.rb

@@ -0,0 +1,52 @@
+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)
+      distinct ||= uniq
+
+      relation = all
+
+      # terribly named option
+      unless binding.local_variable_get(:nil)
+        (column.is_a?(Array) ? column : [column]).each do |c|
+          relation = relation.and(c.ne => nil)
+        end
+      end
+
+      ids = {}
+      Array(column).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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hightop
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,6 +92,7 @@ files:
 - lib/hightop.rb
 - lib/hightop/enumerable.rb
 - lib/hightop/kicks.rb
+- lib/hightop/mongoid.rb
 - lib/hightop/version.rb
 homepage: https://github.com/ankane/hightop
 licenses: