ransack_mongo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa14d28f6e8b1cd4f880003a75f9fbe386065fde
-  data.tar.gz: db5b0fc818f5624ba66e18d310cecf139a3c7a12
+  metadata.gz: 653de3c263786edc9d472e925e4c2802b9d8723e
+  data.tar.gz: 6bc873650e072552a2582dca3fdc4f3a6606c5d0
 SHA512:
-  metadata.gz: d1990c1854b2d5b6c9ac567b412d0f7ee967496acad4908cf60c372d72f956d729f160a2efd4a8881857be18aa907dab013e9231095abf95957d705236078545
-  data.tar.gz: b0b08055f284c65882ea7cd9d67d8b0527af1ce091e5ee53120a7504148654b9ccc53c03c4f1d63e0d08528b861fe069127388ddf32757c33224c272dc5d774f
+  metadata.gz: add84c5b3298b51116656d07c7d541fa6733a1b0dc568caf6a15297921edc2342042a32408dfb797b526ddb8a80c9b2e246106a5ae9f028109e6d5a404303edf
+  data.tar.gz: 23e2806cc27103853ccf12a53d224ac93cc319c47f09e675556493e140947f4f3e91914fabf864c4f49eb4d553dd34328aa8904b759553fa1799088796f4661c

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0
+  # - 2.1.0
+  # - ruby-head
+  - jruby-19mode
+  - jruby-head
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+script: bundle exec rspec spec

data/README.md

@@ -1,6 +1,14 @@
-# RansackMongo
+# Ransack Mongo
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/phstc/ransack_mongo.svg)](https://travis-ci.org/phstc/ransack_mongo)
+
+Ransack Mongo is based on [Ransack](https://github.com/activerecord-hackery/ransack), but for MongoDB.
+
+With Ransack Mongo you can convert query params into Mongo queries.
+
+## Why another gem?
+
+> [Given that Ransack is built on top of ARel and that ARel only works with relational databases, I don't see how we could add Mongoid support without dramatically changing everything.](https://github.com/activerecord-hackery/ransack/issues/120#issuecomment-7539851)
 
 ## Installation
 
@@ -18,11 +26,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# GET /customers?q[name_eq]=Pablo&q[middle_name_or_last_name_cont]=Cantero
+# params[:q]
+# => { name_eq: 'Pablo', middle_name_or_last_name_cont: 'Cantero' }
+# query.to_query(params[:q])
+# => { name: 'Pablo', '$or' => { middle_name: /Cantero/i, last_name: /Cantero/i } }
+
+# GET /customers
+def index
+  query = RansackMongo::Query.new
+  selector = query.to_query(params[:q])
+
+  # Mongo Ruby Driver
+  @customers = db.customers.find(selector)
+
+  # Mongoid
+  @customers = Customer.where(selector)
+end
+```
+
+### Available predicates
+
+* eq
+* not_eq
+* cont
+* in
+* gt
+* lt
+* gteq
+* lteq
+
+### OR operator
+
+You can also combine predicates for OR queries.
+
+```ruby
+query_param = { name_eq: 'Pablo', middle_name_or_last_name_cont: 'Cantero' }
+query.to_query(params[:q])
+# => { name: 'Pablo', '$or' => { middle_name: /Cantero/i, last_name: /Cantero/i } }
+```
+
+### to_query!
+
+You can use to_query! for stricter validations. This method will raise an exception if a query cannot be produced.
+```ruby
+ # xpto isn't a valid predicate
+
+query.to_query(name_xpto: 'Pablo')
+# => {}
+query.to_query!(name_xpto: 'Pablo')
+# => RansackMongo::MatcherNotFound: No matchers found. To allow empty queries use .to_query instead
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/ransack_mongo/fork )
+1. Fork it ( https://github.com/phstc/ransack_mongo/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/ransack_mongo/mongo_adapter.rb

@@ -27,23 +27,19 @@ module RansackMongo
     end
 
     def gt_matcher(attr, value)
-      @query[attr] ||= {}
-      @query[attr]['$gt'] = value.to_f
+      append_sizeable_matcher('$gt', attr, value)
     end
 
     def lt_matcher(attr, value)
-      @query[attr] ||= {}
-      @query[attr]['$lt'] = value.to_f
+      append_sizeable_matcher('$lt', attr, value)
     end
 
     def gteq_matcher(attr, value)
-      @query[attr] ||= {}
-      @query[attr]['$gte'] = value.to_f
+      append_sizeable_matcher('$gte', attr, value)
     end
 
     def lteq_matcher(attr, value)
-      @query[attr] ||= {}
-      @query[attr]['$lte'] = value.to_f
+      append_sizeable_matcher('$lte', attr, value)
     end
 
     def or_op # or operation
@@ -60,13 +56,24 @@ module RansackMongo
       @query = original_query
     end
 
-    def sanitize(unsanitized)
-      # http://docs.mongodb.org/manual/faq/developers/#how-does-mongodb-address-sql-or-query-injection
-      unsanitized
-    end
-
     def self.predicates
       PREDICATES
     end
+
+    private
+
+    def append_sizeable_matcher(m, attr, value)
+      @query[attr] ||= {}
+      @query[attr][m] = parse_sizeable_value(value)
+    end
+
+    def parse_sizeable_value(value)
+      case value
+      when Date, Time
+        value
+      else
+        Float(value) rescue value
+      end
+    end
   end
 end

data/lib/ransack_mongo/query.rb

@@ -14,8 +14,8 @@ module RansackMongo
 
       parsed_predicates.keys.each do |p|
         parsed_predicates[p].each do |parsed_predicate|
-          attr  = db_adapter.sanitize(parsed_predicate['attr'])
-          value = db_adapter.sanitize(parsed_predicate['value'])
+          attr  = parsed_predicate['attr']
+          value = parsed_predicate['value']
 
           begin
             if attr.include? '_or_'
@@ -34,6 +34,16 @@ module RansackMongo
       db_adapter.to_query
     end
 
+    def to_query!(params)
+      selector = to_query params
+
+      if selector.empty?
+        raise MatcherNotFound,  "No matchers found. To allow empty queries use .to_query instead"
+      end
+
+      selector
+    end
+
     def or_query(db_adapter, attr, value, p)
       db_adapter.or_op do
         attr.split('_or_').each do |or_attr|

data/lib/ransack_mongo/version.rb

@@ -1,3 +1,3 @@
 module RansackMongo
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/ransack_mongo.gemspec

@@ -9,9 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Pablo Cantero']
   spec.email         = ['pablo@pablocantero.com']
   spec.homepage      = 'https://github.com/phstc/ransack_mongo'
-  spec.summary       = %q{Object-based searching for MongoDB (currently).}
-  spec.description   = %q{Ransack Mongo is inspired/based on Ransack but for MongoDB}
-  spec.homepage      = ''
+  spec.summary       = %q{Query params based searching for MongoDB}
+  spec.description   = %q{Ransack Mongo is based on Ransack but for MongoDB}
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

data/spec/ransack_mongo/mongo_adapter_spec.rb

@@ -48,35 +48,38 @@ module RansackMongo
       end
     end
 
-    describe '#gt_matcher' do
-      it 'returns the matcher' do
-        subject.gt_matcher('quantity', 1)
+    %w[gt lt gteq lteq].each do |m|
+      op_name = { 'gteq' => 'gte', 'lteq' => 'lte' }[m] || m
 
-        expect(subject.to_query).to eq('quantity' => { '$gt' => 1 })
-      end
-    end
+      describe "##{m}_matcher" do
+        it 'returns the matcher' do
+          subject.send "#{m}_matcher", 'quantity', 1
 
-    describe '#lt_matcher' do
-      it 'returns the matcher' do
-        subject.lt_matcher('quantity', 1)
+          expect(subject.to_query).to eq('quantity' => { "$#{op_name}" => 1 })
+        end
 
-        expect(subject.to_query).to eq('quantity' => { '$lt' => 1 })
-      end
-    end
+        it 'accepts time' do
+          updated_at = Time.now
+          subject.send "#{m}_matcher", 'updated_at', updated_at
 
-    describe '#gteq_matcher' do
-      it 'returns the matcher' do
-        subject.gteq_matcher('quantity', 1)
+          expect(subject.to_query).to eq('updated_at' => { "$#{op_name}" => updated_at })
+        end
 
-        expect(subject.to_query).to eq('quantity' => { '$gte' => 1 })
-      end
-    end
+        it 'accepts time as a string' do
+          updated_at = '2014-10-11 14:48:07 -0300'
 
-    describe '#lteq_matcher' do
-      it 'returns the matcher' do
-        subject.lteq_matcher('quantity', 1)
+          subject.send "#{m}_matcher", 'updated_at', updated_at
+
+          expect(subject.to_query).to eq('updated_at' => { "$#{op_name}" => updated_at })
+        end
+
+        it 'accepts date' do
+          updated_at = Date.new
 
-        expect(subject.to_query).to eq('quantity' => { '$lte' => 1 })
+          subject.send "#{m}_matcher", 'updated_at', updated_at
+
+          expect(subject.to_query).to eq('updated_at' => { "$#{op_name}" => updated_at })
+        end
       end
     end
 

data/spec/ransack_mongo/query_spec.rb

@@ -14,10 +14,6 @@ module RansackMongo
           @query
         end
 
-        def sanitize(unsanitized)
-          unsanitized
-        end
-
         def self.predicates
           PREDICATES
         end
@@ -36,6 +32,19 @@ module RansackMongo
     end
 
     context 'when MongoAdapter' do
+      describe '#to_query!' do
+        it 'raises exception when query evaluates to an empty hash' do
+          params = { 'name' => 'Pablo' }
+          expect { described_class.new.to_query!(params) }.to raise_error(MatcherNotFound)
+        end
+
+        it 'returns the query' do
+          params = { 'name_eq' => 'Pablo', 'fullname_cont' => 'Cantero' }
+
+          expect(described_class.new.to_query!(params)).to eq('name' => 'Pablo', 'fullname' => /Cantero/i)
+        end
+      end
+
       describe '#to_query' do
         it 'returns the query' do
           params = { 'name_eq' => 'Pablo', 'fullname_cont' => 'Cantero' }

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ Dir['../lib/**/*.rb'].each &method(:require)
 require './lib/ransack_mongo'
 
 RSpec.configure do |config|
-  config.color_enabled = true
   config.formatter = 'progress'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ransack_mongo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2014-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Ransack Mongo is inspired/based on Ransack but for MongoDB
+description: Ransack Mongo is based on Ransack but for MongoDB
 email:
 - pablo@pablocantero.com
 executables: []
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,7 +75,7 @@ files:
 - spec/ransack_mongo/predicate_spec.rb
 - spec/ransack_mongo/query_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/phstc/ransack_mongo
 licenses:
 - MIT
 metadata: {}
@@ -97,7 +98,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Object-based searching for MongoDB (currently).
+summary: Query params based searching for MongoDB
 test_files:
 - spec/ransack_mongo/mongo_adapter_spec.rb
 - spec/ransack_mongo/predicate_spec.rb