mongoid_filter 0.0.1

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,6 @@
+source 'https://rubygems.org'
+
+gem 'mongoid'
+
+# Specify your gem's dependencies in mongoid_filter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Egor Lynko
+
+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,59 @@
+# MongoidFilter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_filter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_filter
+
+## Usage
+
+### Example
+
+#### Model
+```ruby
+class Log
+  include Mongoid::Document
+  include MongoidFilter
+
+  field :event_type,  type: String
+  field :status,      type: Boolean
+
+  # It will allow us to filter by this three fields
+  can_filter_by :event_type, :status, :created_at
+
+  # Specify custom method to create object from params
+  special_filter :created_at, ->(date) { Date.strptime(date, '%m/%d/%Y') }
+end
+```
+#### Controller
+```ruby
+@logs = Log.where(user_id: user.id).filter_by(params[:search])
+```
+
+#### View
+```erb
+<%= form_for @request_logs.filter_form_object, as: :search do |f| %>
+  <%= f.select :event_type_eq, Log.event_types %>
+  <%= f.select :status_eq, Log.statuses %>
+  <%= f.text_area :created_at_gt %>
+<% end %>
+```
+
+## Contributing
+
+1. Fork it
+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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid_filter.rb

@@ -0,0 +1,93 @@
+require 'mongoid_filter/version'
+require 'mongoid_filter/form_object'
+
+require 'ostruct'
+require 'active_support/all'
+
+module MongoidFilter
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    attr_writer :filter_fields, :special_filters, :filter_field_aliases
+
+    def filter_fields
+      @filter_fields ||= []
+    end
+
+    def special_filters
+      @special_filters ||= {}
+    end
+
+    def filter_field_aliases
+      @filter_aliases ||= {}
+    end
+
+    def can_filter_by(*fields)
+      self.filter_fields.concat(fields.flatten.map(&:to_sym))
+    end
+
+    def special_filter(field, deserializing_proc, options = {})
+      self.special_filters.merge!(field => deserializing_proc)
+
+      field_name = options[:field_name]
+      self.filter_field_aliases.merge!(field => field_name)
+    end
+
+    def filter_by(filter_params)
+      condition = {}
+      prepare_filter_params(filter_params).each do |attribute, value|
+        field_name, operator = parse_attribute(attribute)
+        condition.merge!(build_expression(field_name, operator, value)) if field_name.in? filter_fields
+      end
+      criteria = where(condition)
+      criteria.instance_variable_set(:@filter_form_object, FormObject.new(filter_params))
+      criteria
+    end
+
+    def filter_form_object
+      criteria.instance_variable_get(:@filter_form_object) || FormObject.new({})
+    end
+
+    private
+      def parse_attribute(attribute)
+        parts = attribute.split('_')
+        field_name = parts[0...-1].join('_').to_sym
+        operator = parts[-1].to_sym
+        [field_name, operator]
+      end
+
+      def build_expression(field_name, operator, value)
+        field = selector_field_name(field_name)
+        value = deserialize_value(field_name, value)
+        case operator
+        when :eq
+          {field => value}
+        when :gt, :lt, :gte, :lte
+          {field.send(operator) => value}
+        when :from
+          build_expression(field_name, :gte, value)
+        when :to
+          build_expression(field_name, :lte, value)
+        when :in
+          {field.in => value}
+        when :cont
+          regexp = Regexp.new(".*#{ Regexp.escape(value) }.*", "i")
+          {field => regexp}
+        else
+          {}
+        end
+      end
+
+      def prepare_filter_params(filter_params)
+        (filter_params || {}).select { |key, value| value.present? }.with_indifferent_access
+      end
+
+      def deserialize_value(field_name, value)
+        self.special_filters[field_name].try(:call, value) || value
+      end
+
+      def selector_field_name(field_name)
+        filter_field_aliases[field_name] || field_name
+      end
+  end
+end

data/lib/mongoid_filter/form_object.rb

@@ -0,0 +1,19 @@
+module MongoidFilter
+  class FormObject
+    extend ActiveModel::Naming
+
+    attr_reader :form_fields_struct
+
+    def self.model_name
+      ActiveModel::Name.new(self)
+    end
+
+    def initialize(filter_params)
+      @form_fields_struct = OpenStruct.new(filter_params)
+    end
+
+    def method_missing(method, *args, &block)
+      @form_fields_struct.public_send(method, *args, &block)
+    end
+  end
+end

data/lib/mongoid_filter/version.rb

@@ -0,0 +1,3 @@
+module MongoidFilter
+  VERSION = "0.0.1"
+end

data/mongoid_filter.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_filter"
+  spec.version       = MongoidFilter::VERSION
+  spec.authors       = ["Egor Lynko"]
+  spec.email         = ["flexoid@gmail.com"]
+  spec.description   = %q{Provides methods to filter collections by form parameters}
+  spec.summary       = %q{Helper methods to filter collections}
+  spec.homepage      = "https://github.com/flexoid/mongoid-filter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rspec')
+end

data/spec/mongoid_filter/mongoid_filter_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe MongoidFilter do
+  let(:movie_klass) do
+    Class.new do
+      include Mongoid::Document
+      include MongoidFilter
+    end
+  end
+
+  let(:movie) { movie_klass.new }
+  let(:filter_params) { {year_gte: 2005, director_eq: 'Christopher Nolan'} }
+
+  describe "accessors" do
+    it "exist in class" do
+      expect(movie_klass.respond_to?(:filter_fields)).to be_true
+      expect(movie_klass.respond_to?(:filter_fields=)).to be_true
+      expect(movie_klass.respond_to?(:special_filters)).to be_true
+      expect(movie_klass.respond_to?(:special_filters=)).to be_true
+      expect(movie_klass.respond_to?(:filter_field_aliases)).to be_true
+      expect(movie_klass.respond_to?(:filter_field_aliases=)).to be_true
+    end
+  end
+
+  describe "#can_filter_by" do
+    before(:each) do
+      movie_klass.instance_eval do
+        can_filter_by :director, :rating, :premiere_date
+        can_filter_by :year
+      end
+    end
+
+    it "adds fields to class_attribute" do
+      expect(movie_klass.filter_fields).to eq([:director, :rating, :premiere_date, :year])
+    end
+  end
+
+  describe "#special_filter" do
+    @special_filter_proc = ->(date) { Date.strptime(date, '%m/%d/%Y') }
+    before(:each) do
+      movie_klass.instance_eval do
+        special_filter :premiere_date, @special_filter_proc, field_name: :release_date
+      end
+    end
+
+    it "adds filter proc to spefial filters" do
+      expect(movie_klass.special_filters).to eq({premiere_date: @special_filter_proc})
+    end
+
+    it "adds field alias to aliases hash" do
+      expect(movie_klass.filter_field_aliases).to eq({premiere_date: :release_date})
+    end
+  end
+
+  describe "#filter_form_object" do
+    context "returns empty form object" do
+      let(:empty_ostruct) { OpenStruct.new }
+
+      it "when #filter_by isn't applied to model" do
+        form_object = movie_klass.filter_form_object
+        expect(form_object.form_fields_struct).to eq(empty_ostruct)
+      end
+
+      it "when #filter_by invoked on model with empty hash" do
+        form_object = movie_klass.filter_by({}).filter_form_object
+        expect(form_object.form_fields_struct).to eq(empty_ostruct)
+      end
+
+      it "when #filter_by invoked on criteria with empty hash" do
+        form_object = movie_klass.where(year: 2013).filter_by({}).filter_form_object
+        expect(form_object.form_fields_struct).to eq(empty_ostruct)
+      end
+    end
+
+    context "returns correct form object" do
+      let(:ostruct) { MongoidFilter::FormObject.new(filter_params).form_fields_struct }
+
+      it "when #filter_by invoked on model with params" do
+        form_object = movie_klass.filter_by(filter_params).filter_form_object
+        expect(form_object.form_fields_struct).to eq(ostruct)
+      end
+
+      it "when #filter_by invoked on criteria with params" do
+        form_object = movie_klass.where(year: 2013).
+          filter_by(filter_params).filter_form_object
+        expect(form_object.form_fields_struct).to eq(ostruct)
+      end
+    end
+  end
+
+  describe "#filter_by" do
+    before(:each) do
+      movie_klass.instance_eval do
+        can_filter_by :director, :year, :premiere_date, :score
+        special_filter :score,
+          ->(score) { score * 10 },
+          field_name: :rating
+      end
+    end
+
+    describe "operator" do
+      %w(gt gte lt lte).each do |operator|
+        it operator do
+          expect(movie_klass.filter_by({:"year_#{operator}" => 2000}).selector).
+            to eq({'year' => {"$#{operator}" => 2000}})
+        end
+      end
+
+      it "from" do
+        expect(movie_klass.filter_by({year_from: 2000}).selector).
+          to eq({'year' => {'$gte' => 2000}})
+      end
+
+      it "to" do
+        expect(movie_klass.filter_by({year_to: 2000}).selector).
+          to eq({'year' => {'$lte' => 2000}})
+      end
+
+      it "in" do
+        expect(movie_klass.filter_by({year_in: [2000, 2001]}).selector).
+          to eq({'year' => {'$in' => [2000, 2001]}})
+      end
+
+      it "cont" do
+        expect(movie_klass.filter_by({director_cont: 'Nolan'}).selector).
+          to eq({'director' => /.*Nolan.*/i})
+      end
+
+      it "combination of operators" do
+        expect(movie_klass.filter_by(filter_params).selector).
+          to eq({'year' => {'$gte' => 2005}, 'director' => 'Christopher Nolan'})
+      end
+
+      it "unsupported operator" do
+        expect(movie_klass.filter_by({year_greater: 2000}).selector).to eq({})
+      end
+    end
+
+    describe 'special filter' do
+      it 'with custom field name' do
+        expect(movie_klass.filter_by({score_gt: 10}).selector).
+          to eq({'rating' => {'$gt' => 100}})
+      end
+    end
+  end
+
+  describe "FormObject" do
+    subject { MongoidFilter::FormObject.new(filter_params) }
+    it "forwards getting values to inner OStruct" do
+      expect(subject.year_gte).to eq(2005)
+      expect(subject.director_eq).to eq('Christopher Nolan')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'mongoid'
+require 'mongoid_filter'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Egor Lynko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides methods to filter collections by form parameters
+email:
+- flexoid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_filter.rb
+- lib/mongoid_filter/form_object.rb
+- lib/mongoid_filter/version.rb
+- mongoid_filter.gemspec
+- spec/mongoid_filter/mongoid_filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flexoid/mongoid-filter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Helper methods to filter collections
+test_files:
+- spec/mongoid_filter/mongoid_filter_spec.rb
+- spec/spec_helper.rb