filter_factory 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a20357253719ea11df36bea4aa7d70143b595c69
-  data.tar.gz: f9ba46a6e9d1e41e8690dde28861fa5ff00c5d78
+  metadata.gz: 98cc7680f2b4d7e953b1251cdaea07d32fe50146
+  data.tar.gz: f4abb81717512dda2b4a464cb0727c1995e557ae
 SHA512:
-  metadata.gz: 053d07b99b084c136f9982e7b65f30fdb922759f6e669e1e0def7a31e45684e58961322cd160edce9bf08fbc87063ef940db8805cee1730a5f7a382b013644be
-  data.tar.gz: fc547558634b40fe8a0859d5ffb08d9948d3c04b238b36ad2e333f5c8dd61a2d14a45aaa2bf5b0f84d613b09f2f8ae7b747b67659a8a82474bc23d844790db82
+  metadata.gz: 2acd8f506f3823792fc0719ecdbe8b09db210e8a51596e9570671923e65dca7ac254a45207237394e67a9911ba2bbc1630bfedf4da90fcf27b4e5fa70fece95d
+  data.tar.gz: 120f459594e65d48148a89d1cb42f5a73944df872ac0a26eca85eef513a503b683f558463da958820e384aa45eb6666dc514a8dd03f6bb58ea427089c71f982a

data/Gemfile

@@ -3,9 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in filter_factory.gemspec
 gemspec
 
-gem 'rails', '>= 4.0'
+gem 'activesupport', '>= 4.0'
 
 group :development do
+  gem 'activerecord', '>= 4.0'
   gem 'mongoid', '>= 5.0'
   gem 'mysql2'
 end

data/Gemfile.lock

@@ -1,33 +1,11 @@
 PATH
   remote: .
   specs:
-    filter_factory (0.1.0)
+    filter_factory (0.1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.6)
-      actionview (= 4.2.6)
-      activesupport (= 4.2.6)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.6)
-      activesupport (= 4.2.6)
-      globalid (>= 0.3.0)
     activemodel (4.2.6)
       activesupport (= 4.2.6)
       builder (~> 3.1)
@@ -44,23 +22,11 @@ GEM
     arel (6.0.3)
     bson (4.0.4)
     builder (3.2.2)
-    concurrent-ruby (1.0.1)
     diff-lcs (1.2.5)
-    erubis (2.7.0)
     factory_girl (4.7.0)
       activesupport (>= 3.0.0)
-    globalid (0.3.6)
-      activesupport (>= 4.1.0)
     i18n (0.7.0)
     json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    mime-types (3.0)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0221)
-    mini_portile2 (2.0.0)
     minitest (5.8.4)
     mongo (2.2.4)
       bson (~> 4.0)
@@ -70,37 +36,7 @@ GEM
       origin (~> 2.2)
       tzinfo (>= 0.3.37)
     mysql2 (0.4.3)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
     origin (2.2.0)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.6)
-      actionmailer (= 4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      activemodel (= 4.2.6)
-      activerecord (= 4.2.6)
-      activesupport (= 4.2.6)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.6)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (4.2.6)
-      actionpack (= 4.2.6)
-      activesupport (= 4.2.6)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (11.1.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
@@ -114,14 +50,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    sprockets (3.6.0)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.0.4)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (0.19.1)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -130,11 +58,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 4.0)
+  activesupport (>= 4.0)
   factory_girl
   filter_factory!
   mongoid (>= 5.0)
   mysql2
-  rails (>= 4.0)
   rspec
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,6 @@
 # FilterFactory
 
-[![Build Status](https://travis-ci.org/hck/filter_factory.png)](https://travis-ci.org/hck/filter_factory)
+[![Build Status](https://travis-ci.org/hck/filter_factory.png)](https://travis-ci.org/hck/filter_factory) [![Code Climate](https://codeclimate.com/github/hck/filter_factory/badges/gpa.svg)](https://codeclimate.com/github/hck/filter_factory)
 
 FilterFactory allows you to easily fetch ActiveRecord/Mongoid models that match specified filters.
 

data/lib/filter_factory/active_record/condition.rb

@@ -25,8 +25,8 @@ module FilterFactory
         obj.where("#{field_name} >= ?", value)
       end
 
-      def all(obj)
-        raise NotImplementedError, "all operator is not available for ActiveRecord"
+      def all(_obj)
+        fail NotImplementedError, "all operator is not available for ActiveRecord"
       end
 
       def in(obj)
@@ -41,8 +41,8 @@ module FilterFactory
         obj.where("#{field_name} REGEXP ?", value)
       end
 
-      def exists(obj)
-        raise NotImplementedError, "all operator is not available for ActiveRecord"
+      def exists(_obj)
+        fail NotImplementedError, "exists operator is not available for ActiveRecord"
       end
 
       def presents(obj)
@@ -50,4 +50,4 @@ module FilterFactory
       end
     end
   end
-end
+end

data/lib/filter_factory/active_record/filter.rb

@@ -1,12 +1,18 @@
 module FilterFactory
   module ActiveRecord
     module Filter
+      # Applies the filter passed as an argument to model class or relation
+      #
+      # @param [Filter] filter_object filter object used to filter records
+      # @return [ActiveRecord::Relation]
       def filter(filter_object)
         conditions = filter_object.filled_fields.map do |field|
           FilterFactory::ActiveRecord::Condition.new(field.name, field.value).method(field.condition)
         end
 
-        conditions.inject(nil) do |res,condition|
+        relation = self.is_a?(::ActiveRecord::Relation) ? self : nil
+
+        conditions.inject(relation) do |res, condition|
           res ? res.instance_eval(&condition) : instance_eval(&condition)
         end
       end
@@ -14,4 +20,6 @@ module FilterFactory
   end
 end
 
-ActiveRecord::Base.send(:extend, FilterFactory::ActiveRecord::Filter) if defined?(ActiveRecord::Base)
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:extend, FilterFactory::ActiveRecord::Filter)
+end

data/lib/filter_factory/condition.rb

@@ -2,8 +2,12 @@ module FilterFactory
   class Condition
     attr_reader :field_name, :value
 
+    # Initializes new instance of Condition class.
+    #
+    # @param [Symbol] field_name field name which will be used in condition
+    # @param [Object] value value which will be used in condition
     def initialize(field_name, value)
       @field_name, @value = field_name, value
     end
   end
-end
+end

data/lib/filter_factory/field.rb

@@ -3,19 +3,31 @@ module FilterFactory
     attr_reader :name, :condition, :alias, :options
     attr_accessor :value
 
+    # Initializes new instance of Field.
+    #
+    # @param [Symbol, String] name
+    # @param [Symbol] condition
+    # @param [Hash] options
+    # @option options [Symbol, String] :alias field alias
     def initialize(name, condition, options = {})
-      raise ArgumentError unless FilterFactory::Filter::CONDITIONS.include?(condition)
+      fail ArgumentError unless FilterFactory::Filter::CONDITIONS.include?(condition)
 
       valid_options = [:alias]
-      @name, @condition, @options = name, condition, options.reject{|k,| !valid_options.include?(k)}
+      @name, @condition, @options = name, condition, options.reject { |k,| !valid_options.include?(k) }
       @alias = @options[:alias] || @name
     end
 
+    # Checks whether two objects are equal.
+    # Returns true if obj is of the same class and has name,
+    # condition and alias attributes equal to current object.
+    #
+    # @param [Object] obj object to compare with
+    # @return [Boolean]
     def ==(obj)
       return false unless obj.is_a?(self.class)
-      [:name, :condition, :alias].inject(true) do |acc,attr|
+      [:name, :condition, :alias].inject(true) do |acc, attr|
         acc && public_send(attr) == obj.public_send(attr)
       end
     end
   end
-end
+end

data/lib/filter_factory/filter.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'active_support/hash_with_indifferent_access'
 
 module FilterFactory
   class Filter
@@ -9,17 +10,24 @@ module FilterFactory
 
     CONDITIONS = [:eq, :ne, :lt, :lte, :gt, :gte, :all, :in, :nin, :regex, :exists, :presents].freeze
 
+    # Initializes new instance of Filter class.
     def initialize
       @fields = []
     end
 
+    # Returns list of filter attributes.
+    #
+    # @return [HashWithIndifferentAccess]
     def attributes
-      @fields.inject(HashWithIndifferentAccess.new) do |acc, field|
+      fields.inject(HashWithIndifferentAccess.new) do |acc, field|
         acc[field.alias] = field.value
         acc
       end
     end
 
+    # Assigns values to filter's attributes.
+    #
+    # @param [Hash] attributes hash of new attributes' values
     def attributes=(attributes = {})
       return unless attributes
       attributes.each do |name, value|
@@ -27,14 +35,26 @@ module FilterFactory
       end
     end
 
+    # Returns list of filled fields.
+    # Field is considered to be filled if it's value is not nil
+    # and is not an empty string.
+    # @return [Array<Field>]
     def filled_fields
       fields.select { |f| !f.value.nil? && f.value != '' }
     end
 
+    # Returns field by its name.
+    #
+    # @param [Symbol, String] name name of the field
+    # @return [Field, nil]
     def get_field(name)
       fields.find { |f| f.name == name }
     end
 
+    # Required by ActiveModel.
+    # May be removed in newer Rails versions.
+    #
+    # @returns [Boolean] true
     def persisted?
       false
     end
@@ -46,19 +66,24 @@ module FilterFactory
     end
 
     class << self
+      # Creates a new filter instance and executes block on it
+      #
+      # @param [Proc] block block to be executed in context of new filter instance
+      # @return [Filter]
       def create(&block)
-        new.tap { |filter| filter.instance_eval &block }
+        new.tap { |filter| filter.instance_eval(&block) }
       end
     end
 
+    # Error class which represents error when filter already has the same field defined.
     class DuplicateFieldError < StandardError;
     end
 
     private
 
-    def field(name, condition, options={})
+    def field(name, condition, options = {})
       Field.new(name, condition, options).tap do |field|
-        raise DuplicateFieldError if fields.include?(field)
+        fail DuplicateFieldError if fields.include?(field)
 
         define_singleton_method(field.alias) { field.value }
         define_singleton_method("#{field.alias}=") { |val| field.value = val }

data/lib/filter_factory/mongoid/condition.rb

@@ -46,13 +46,8 @@ module FilterFactory
       end
 
       def presents(obj)
-        query_opts = if ['true', '1', 1].include?(value)
-          { field_name => { '$nin' => [nil, '', []] } }
-        else
-          { field_name => { '$in' => [nil, '', []] } }
-        end
-
-        obj.where(query_opts)
+        operator = ['true', '1', 1].include?(value) ? '$nin' : '$in'
+        obj.where(field_name => { operator => [nil, '', []] })
       end
     end
   end

data/lib/filter_factory/mongoid/filter.rb

@@ -1,6 +1,10 @@
 module FilterFactory
   module Mongoid
     module Filter
+      # Applies the filter passed as an argument to model class or Mongoid::Criteria
+      #
+      # @param [Filter] filter_object filter object used to filter records
+      # @return [Mongoid::Criteria]
       def filter(filter_object)
         conditions = filter_object.filled_fields.map do |field|
           FilterFactory::Mongoid::Condition.new(field.name, field.value).method(field.condition)

data/lib/filter_factory/version.rb

@@ -1,3 +1,3 @@
 module FilterFactory
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/spec/filter_factory/active_record/model_spec.rb

@@ -22,6 +22,17 @@ RSpec.describe ARPost do
     expect(described_class.filter(filter).to_a).to eq([sample])
   end
 
+  it 'applies filter to existing relation' do
+    rel = described_class.where('views < ?', posts.last.views)
+
+    filter = FilterFactory.create do
+      gt :views
+    end
+    filter.views = 0
+
+    expect(rel.filter(filter).to_a).to eq(posts[0..-2])
+  end
+
   it 'returns records with column values equal to specified value' do
     sample = posts.sample
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filter_factory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Hck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies: []
 description: Gem for easy ActiveRecord/Mongoid models filtering
 email: