mongoid-filterable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 112246751dd972a531a49a44a390f5410c5e4381
+  data.tar.gz: 88a7ccd863fe6c8c0caef1622bf961150d3d53c4
+SHA512:
+  metadata.gz: 46e4dfeec6248cf4d023d68c6d555aea1ff3ab40388181b0c3e964ff08cadd69ef5a77c7890c09d11fa141f482424612804f656fe63b059eda18f27dc59eda8c
+  data.tar.gz: 5c9db4c56af8acb8de1f93cb4945c2070973b42e226fcf436e752b971f362406e5bcc62aa584a8c8aeb715f677f9d3ff0ea9589b4fefc2f71c8e6ad3c0b12130

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rafael Jurado
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# Mongoid::Filterable
+
+Let you add scopes to mongoid document for filters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-filterable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-filterable
+
+## Usage
+
+#### Model
+
+```ruby
+class City
+  include Mongoid::Document
+  include Mongoid::Filterable
+
+  field :name
+  field :people
+
+  filter_by(:name)
+  filter_by(:people, lambda{|value| where(:people.gt => value)})
+end
+
+City.create(name: 'city1', people: 100)
+City.create(name: 'city2', people: 1000)
+City.filter({name: 'city1'}).count # => 1
+City.filter({people: 500}) # => 1
+```
+
+#### Operator
+
+You can specify selector operator: 
+
+* $and (default operator)
+* $or
+
+```ruby
+City.filter({name: 'city1', people: 1000}, '$and').count # => 0
+City.filter({name: 'city1', people: 1000}, '$or').count # => 1
+```
+
+#### Rails controller
+
+```ruby
+class CitiesController
+  def index
+    respond_with City.filter(filter_params)
+  end
+  
+  private
+
+  def filter_params
+    params.slice(:name, :people)
+  end
+end
+```
+
+#### With [mongoid-normalize-string](https://github.com/nosolosoftware/mongoid-normalize-strings) gem
+
+```ruby
+class City
+  include Mongoid::Document
+  include Mongoid::Filterable
+  include Mongoid::NormalizeStrings
+
+  field :name
+  normalize :name
+
+  filter_by_normalize(:name)
+end
+
+City.create(name: 'Cíty1')
+City.create(name: 'Cíty2')
+City.filter({name: 'city1'}).count # => 1
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/mongoid-filterable/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongoid-filterable.rb

@@ -0,0 +1,2 @@
+require "mongoid-filterable/version"
+require "mongoid-filterable/filterable"

data/lib/mongoid-filterable/filterable.rb

@@ -0,0 +1,52 @@
+##
+# Let you add scopes to mongoid document for filters.
+#
+module Mongoid
+  module Filterable
+    module ClassMethods
+      ##
+      # Applies params scopes to current scope
+      #
+      def filter(filtering_params, operator='$and')
+        results = self.all
+        selectors = []
+
+        filtering_params.each do |key, value|
+          selectors.push self.public_send("filter_with_#{key}", value).selector if value.present?
+        end
+
+        results.selector = {operator => selectors} if selectors.size > 0
+        results
+      end
+
+      ##
+      # Adds attr scope
+      #
+      def filter_by(attr, filter=nil)
+        if filter
+          self.scope "filter_with_#{attr}", filter
+        else
+          self.scope "filter_with_#{attr}", lambda{ |value| where(attr => value)}
+        end
+      end
+
+      ##
+      # Adds attr scope using normalized values
+      # (see gem mongoid-normalize-strings)
+      #
+      def filter_by_normalized(attr)
+        normalized_name = (attr.to_s + '_normalized').to_sym
+        self.scope "filter_with_#{attr}", lambda{ |value|
+          where( normalized_name => Regexp.new(I18n.transliterate(value), 'i') )
+        }
+      end
+    end
+
+    ##
+    # Adds class methods
+    #
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/mongoid-filterable/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Filterable
+    VERSION = "0.0.1"
+  end
+end

data/mongoid-filterable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-filterable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-filterable"
+  spec.version       = Mongoid::Filterable::VERSION
+  spec.authors       = ["Rafael Jurado"]
+  spec.email         = ["rjurado@nosolosoftware.biz"]
+  spec.summary       = %q{Easy way to add scopes to your models.}
+  spec.description   = %q{Easy way to add scopes to your models.}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "i18n"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'mongoid'
+end

data/spec/filterable_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Mongoid::Filterable do
+  class City
+    include Mongoid::Document
+    include Mongoid::Filterable
+
+    field :name
+    field :people
+    field :country_normalized
+
+    filter_by(:name)
+    filter_by(:people, lambda{|value| where(:people.gt => value)})
+    filter_by_normalized(:country)
+  end
+
+  before do
+    City.destroy_all
+  end
+
+  context 'when use default operator' do
+    it 'should filter by default filter' do
+      City.create(name: 'city1')
+      City.create(name: 'city2')
+      expect(City.filter({name: 'city1'}).count).to eq(1)
+      expect(City.filter({name: 'city1'}).first.name).to eq('city1')
+    end
+
+    it 'should filter by custom filter' do
+      City.create(people: 100)
+      City.create(people: 1000)
+      expect(City.filter({people: 500}).count).to eq(1)
+      expect(City.filter({people: 500}).first.people).to eq(1000)
+    end
+
+    it 'should filter by normalized filter' do
+      City.create(country_normalized: 'spain')
+      City.create(country_normalized: 'france')
+      expect(City.filter({country: 'spain'}).count).to eq(1)
+      expect(City.filter({country: 'spain'}).first.country_normalized).to eq('spain')
+    end
+  end
+
+  context 'when use $and operator' do
+    it 'should filter using and query' do
+      City.create(name: 'city1', people: 100)
+      City.create(name: 'city2', people: 2000)
+      expect(City.filter({name: 'city1', people: '2000'}, '$and').count).to eq(0)
+    end
+  end
+
+  context 'when use $or operator' do
+    it 'should filter using or query' do
+      City.create(name: 'city1', people: 100)
+      City.create(name: 'city2', people: 2000)
+      expect(City.filter({name: 'city1', people: '2000'}, '$or').count).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'mongoid'
+require 'mongoid-filterable'
+
+Mongoid.load!("spec/support/mongoid.yml", :development)

data/spec/support/mongoid.yml

@@ -0,0 +1,6 @@
+development:
+  sessions:
+    default:
+      database: mongoid
+      hosts:
+        - localhost:27017

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-filterable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafael Jurado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy way to add scopes to your models.
+email:
+- rjurado@nosolosoftware.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-filterable.rb
+- lib/mongoid-filterable/filterable.rb
+- lib/mongoid-filterable/version.rb
+- mongoid-filterable.gemspec
+- spec/filterable_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Easy way to add scopes to your models.
+test_files:
+- spec/filterable_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.yml