search_object 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b14c3e7ec2492dc899f0a81a022089073be982
-  data.tar.gz: 8bee82cac11549acebcc9d35cc9cbb2aac25f456
+  metadata.gz: f8e073aa014abee0b28d16becee73863464fd881
+  data.tar.gz: 3bc4009abae195732fc8d20e77e4c42b8f080c13
 SHA512:
-  metadata.gz: ba172f5b05a65e43bbbb3c3ab28e4b62c397757a6e9e1cb2bbe9e1b78a1fd94bba980d7d86ed1c286471adefe2bc99bacbb82c37f085f541ce2f407ecb2aa410
-  data.tar.gz: e5dc94ed98f6f947dc7a2f44b854ebc1a4bfe98000d00d6451200855860ce0ccc51a4b844e6d09638137038f3f3786c12d6a46a0d8d29bc80ef01558ed2ebb1d
+  metadata.gz: b39a094a23b0721756303b3988e12acded95e775bd649b15ea9a7a0f0941d79cf0362d78a46ba56154273ed93c7bb8c1a18788255313a5ed290abf9505346a52
+  data.tar.gz: 7ae9c659722f908b487d44fd099a5e4aca80465624cf5849412384cef82c3a2632d930480fac40814c5b3c2c911ee129bf88b03302e3908acf9184b2d371cd2b

data/.rubocop.yml

@@ -1,7 +1,6 @@
 require: rubocop-rspec
 
 AllCops:
-  RunRailsCops: true
   Exclude:
     - example/db/**/*
     - example/config/**/*
@@ -11,6 +10,10 @@ AllCops:
 LineLength:
   Enabled: false
 
+# Disables Module has too many lines
+ModuleLength:
+  Enabled: false
+
 # Disables "Missing top-level class documentation comment"
 Documentation:
   Enabled: false
@@ -22,3 +25,7 @@ Style/EachWithObject:
 # Disables "Prefer reduce over inject."
 Style/CollectionMethods:
   Enabled: false
+
+# Disables "Example has too many lines"
+RSpec/ExampleLength:
+  Enabled: false

data/.travis.yml

@@ -8,3 +8,5 @@ script:
   - bundle exec rspec spec
 notifications:
   email: false
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 1.1.1
+
+* Fix a bug in inheriting search objects
+
 ## Version 1.1
 
 * Search objects now can be inherited

data/README.md

@@ -1,7 +1,7 @@
-[![Gem Version](https://badge.fury.io/rb/search_object.png)](http://badge.fury.io/rb/search_object)
-[![Code Climate](https://codeclimate.com/github/RStankov/SearchObject.png)](https://codeclimate.com/github/RStankov/SearchObject)
-[![Build Status](https://secure.travis-ci.org/RStankov/SearchObject.png)](http://travis-ci.org/RStankov/SearchObject)
-[![Code coverage](https://coveralls.io/repos/RStankov/SearchObject/badge.png?branch=master)](https://coveralls.io/r/RStankov/SearchObject)
+[![Gem Version](https://badge.fury.io/rb/search_object.svg)](http://badge.fury.io/rb/search_object)
+[![Code Climate](https://codeclimate.com/github/RStankov/SearchObject.svg)](https://codeclimate.com/github/RStankov/SearchObject)
+[![Build Status](https://secure.travis-ci.org/RStankov/SearchObject.svg)](http://travis-ci.org/RStankov/SearchObject)
+[![Code coverage](https://coveralls.io/repos/RStankov/SearchObject/badge.svg?branch=master)](https://coveralls.io/r/RStankov/SearchObject)
 
 # SearchObject
 
@@ -34,9 +34,9 @@ class PostSearch
   # Use .all (Rails4) or .scoped (Rails3) for ActiveRecord objects
   scope { Post.all }
 
-  option :name             { |scope, value| scope.where name: value }
-  option :created_at       { |scope, dates| scope.created_after dates }
-  option :published, false { |scope, value| value ? scope.unopened : scope.opened }
+  option(:name)             { |scope, value| scope.where name: value }
+  option(:created_at)       { |scope, dates| scope.created_after dates }
+  option(:published, false) { |scope, value| value ? scope.unopened : scope.opened }
 end
 ```
 
@@ -179,8 +179,6 @@ ProductSearch.new(params).results == ProductSearch.results(params)
 ``` ruby
 class ProductSearch
   include SearchObject.module
-
-  scope :name
 end
 
 # first arguments is treated as scope (if no scope option is provided)
@@ -198,7 +196,7 @@ class ProductSearch
   scope { Product.all }
 
   # nil values returned from option blocks are ignored
-  scope :sold { |scope, value| scope.sold if value }
+  option(:sold) { |scope, value| scope.sold if value }
 end
 ```
 
@@ -222,7 +220,7 @@ class ProductSearch
 
   scope { Product.all }
 
-  option :date { |scope, value| scope.by_date parse_dates(value) }
+  option(:date) { |scope, value| scope.by_date parse_dates(value) }
 
   private
 
@@ -258,8 +256,8 @@ class ProductSearch
 
   scope { RemoteEndpoint.fetch_product_as_hashes }
 
-  option :name     { |scope, value| scope.select { |product| product[:name] == value } }
-  option :category { |scope, value| scope.select { |product| product[:category] == value } }
+  option(:name)     { |scope, value| scope.select { |product| product[:name] == value } }
+  option(:category) { |scope, value| scope.select { |product| product[:category] == value } }
 end
 ```
 
@@ -309,19 +307,19 @@ end
 You can extarct a basic search class for your application.
 
 ```ruby
- class BaseSearch
-   include SearchObject.module
+class BaseSearch
+  include SearchObject.module
 
-   # ... options and configuration
- end
- ```
+  # ... options and configuration
+end
+```
 
  Then use it like:
 
  ```ruby
- class ProductSearch < BaseSearch
-   scope { Product }
- end
+class ProductSearch < BaseSearch
+  scope { Product }
+end
 ```
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: :spec
+task default: [:rubocop, :spec]

data/example/app/models/post_search.rb

@@ -37,8 +37,10 @@ class PostSearch
 
   private
 
-  def parse_date(date)
-    Date.strptime(date, '%Y-%m-%d') rescue nil
+  def parse_date(value)
+    Date.parse(value).strftime('%Y-%m-%d')
+  rescue
+    nil
   end
 
   def escape_search_term(term)

data/example/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/example/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/lib/search_object/base.rb

@@ -45,11 +45,7 @@ module SearchObject
       attr_reader :config
 
       def inherited(base)
-        new_config = config.dup
-
-        base.instance_eval do
-          @config = new_config
-        end
+        base.instance_variable_set '@config', Helper.deep_copy(config)
       end
 
       def scope(&block)

data/lib/search_object/helper.rb

@@ -39,6 +39,22 @@ module SearchObject
         else ->(scope, value) { scope.where name => value unless value.blank? }
         end
       end
+
+      def deep_copy(object) # rubocop:disable Metrics/MethodLength
+        case object
+        when Array
+          object.map { |element| deep_copy(element) }
+        when Hash
+          object.inject({}) do |result, (key, value)|
+            result[key] = deep_copy(value)
+            result
+          end
+        when NilClass, FalseClass, TrueClass, Symbol, Method, Numeric
+          object
+        else
+          object.dup
+        end
+      end
     end
   end
 end

data/lib/search_object/plugin/paging.rb

@@ -26,17 +26,17 @@ module SearchObject
 
       module ClassMethods
         def per_page(number)
-          fail InvalidNumberError.new('Per page', number) unless number > 0
+          raise InvalidNumberError.new('Per page', number) unless number > 0
           config[:per_page] = number
         end
 
         def min_per_page(number)
-          fail InvalidNumberError.new('Min per page', number) unless number > 0
+          raise InvalidNumberError.new('Min per page', number) unless number > 0
           config[:min_per_page] = number
         end
 
         def max_per_page(number)
-          fail InvalidNumberError.new('Max per page', number) unless number > 0
+          raise InvalidNumberError.new('Max per page', number) unless number > 0
           config[:max_per_page] = number
         end
 

data/lib/search_object/search.rb

@@ -8,7 +8,7 @@ module SearchObject
         filters = Helper.stringify_keys(options.fetch(:filters, {}))
         params  = config[:defaults].merge Helper.select_keys(filters, config[:actions].keys)
 
-        fail MissingScopeError unless scope
+        raise MissingScopeError unless scope
 
         new scope, params, config[:actions]
       end

data/lib/search_object/version.rb

@@ -1,3 +1,3 @@
 module SearchObject
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'.freeze
 end

data/search_object.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'will_paginate'
   spec.add_development_dependency 'kaminari'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '0.40.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.5.0'
 end

data/spec/search_object/base_spec.rb

@@ -61,13 +61,20 @@ module SearchObject
     end
 
     it 'can be inherited' do
-      child_class = Class.new(search_class([1, 2, 3])) do
+      equality_search = Class.new(search_class([1, 2, 3])) do
         option :value do |scope, value|
           scope.select { |v| v == value }
         end
       end
 
-      expect(child_class.new(filters: { value: 1 }).results).to eq [1]
+      inequality_search = Class.new(search_class([1, 2, 3])) do
+        option :value do |scope, value|
+          scope.select { |v| v > value }
+        end
+      end
+
+      expect(equality_search.new(filters: { value: 1 }).results).to eq [1]
+      expect(inequality_search.new(filters: { value: 1 }).results).to eq [2, 3]
     end
 
     context 'scope' do
@@ -182,7 +189,7 @@ module SearchObject
       end
 
       it 'can apply several options' do
-        values  = [1, 2, 3, 4, 5, 6, 7]
+        values = [1, 2, 3, 4, 5, 6, 7]
         search = new_search values, bigger_than: 3, odd: true do
           option :bigger_than do |scope, value|
             scope.select { |v| v > value }

data/spec/search_object/helper_spec.rb

@@ -26,5 +26,30 @@ module SearchObject
         expect(Helper.camelize(:paging)).to eq 'Paging'
       end
     end
+
+    describe 'deep_copy' do
+      it 'returns a deep copy on the given object' do
+        original = {
+          array: [1, 2, 3],
+          hash: { key: 'value' },
+          boolean: true,
+          number: 1,
+          null: nil
+        }
+
+        deep_copy = Helper.deep_copy(original)
+
+        original[:array][0] = 42
+        original[:hash][:key] = 'other value'
+
+        expect(deep_copy).to eq(
+          array: [1, 2, 3],
+          hash: { key: 'value' },
+          boolean: true,
+          number: 1,
+          null: nil
+        )
+      end
+    end
   end
 end

data/spec/search_object/plugin/kaminari_spec.rb

@@ -8,7 +8,7 @@ module SearchObject
       it_behaves_like 'a paging plugin' do
         it 'uses kaminari gem' do
           search = search_with_page
-          expect(search.results.respond_to? :total_pages).to be_truthy
+          expect(search.results.respond_to?(:total_pages)).to be_truthy
         end
       end
     end

data/spec/search_object/plugin/model_spec.rb

@@ -42,7 +42,7 @@ module SearchObject
       end
 
       ActiveModel::Lint::Tests.public_instance_methods.map(&:to_s).grep(/^test/).each do |method|
-        example(method.gsub('_', ' ')) { send method }
+        example(method.tr('_', ' ')) { send method }
       end
     end
   end

data/spec/search_object/plugin/will_paginate_spec.rb

@@ -9,7 +9,7 @@ module SearchObject
       it_behaves_like 'a paging plugin' do
         it 'uses will_paginate gem' do
           search = search_with_page
-          expect(search.results.respond_to? :total_entries).to be_truthy
+          expect(search.results.respond_to?(:total_entries)).to be_truthy
         end
       end
     end

data/spec/search_object/search_spec.rb

@@ -32,7 +32,7 @@ module SearchObject
           max: ->(scope, max) { scope.select { |v| v < max } }
         }
 
-        search = Search.new [1, 2, 3, 4, 5], { min: 2, max: 5 },  actions
+        search = Search.new [1, 2, 3, 4, 5], { min: 2, max: 5 }, actions
         expect(search.query(Object.new)).to eq [3, 4]
       end
 
@@ -50,7 +50,7 @@ module SearchObject
           search: ->(scope, _) { scope.select { |v| v == target_value } }
         }
 
-        context = double target_value: 2
+        context = OpenStruct.new target_value: 2
 
         search = Search.new [1, 2, 3, 4, 5], { search: true }, actions
         expect(search.query(context)).to eq [2]

metadata

@@ -1,169 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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: coveralls
   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: will_paginate
   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: kaminari
   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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 description: Search object DSL
 email:
 - rstankov@gmail.com
@@ -171,10 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -254,17 +254,17 @@ 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.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Provides DSL for creating search objects