search_object 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8e073aa014abee0b28d16becee73863464fd881
-  data.tar.gz: 3bc4009abae195732fc8d20e77e4c42b8f080c13
+  metadata.gz: dfd3ff677d11a1e11bed9b477960df1e286a162d
+  data.tar.gz: 60cabe41c79f8596ce290c52cfe88317fb28fd00
 SHA512:
-  metadata.gz: b39a094a23b0721756303b3988e12acded95e775bd649b15ea9a7a0f0941d79cf0362d78a46ba56154273ed93c7bb8c1a18788255313a5ed290abf9505346a52
-  data.tar.gz: 7ae9c659722f908b487d44fd099a5e4aca80465624cf5849412384cef82c3a2632d930480fac40814c5b3c2c911ee129bf88b03302e3908acf9184b2d371cd2b
+  metadata.gz: 331c98690d13135b9a3fb0427c9a6df1139785af9df0c53755fddd1c30db4b93c48a38f094156829f4d6a419eea9ba1b381f9fcd105dabcb06f04a6a936acaf4
+  data.tar.gz: c9d14a709fd31ad3cdafdda6ce8028edd80da3549ae6e0c0e96e4f9afa64384cf3805a258f46776a684ed19c605f7d69e472e96864d4ac30cb874ebad03f7c92

data/.rubocop.yml

@@ -26,6 +26,14 @@ Style/EachWithObject:
 Style/CollectionMethods:
   Enabled: false
 
-# Disables "Example has too many lines"
+# Disables "Block has too many lines."
+Metrics/BlockLength:
+  Enabled: false
+
+# Disables "Example has too many lines."
 RSpec/ExampleLength:
   Enabled: false
+
+# Disables "Too many expectations."
+RSpec/MultipleExpectations:
+  Enabled: false

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
   - 2.2
+  - 2.3
 script:
   - bundle exec rubocop
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,12 +1,17 @@
 # Changelog
 
+## Version 1.1.2
+
+* __[fix]__ Fix a warning due to Rails 5 `ActionController::Parameters` not being a Hash (@rstankov)
+* __[fix]__ Ensure `sort_by` prefixes with table_name. (@andreasklinger)
+
 ## Version 1.1.1
 
-* Fix a bug in inheriting search objects
+* __[fix]__ Fix a bug in inheriting search objects (@avlazarov)
 
 ## Version 1.1
 
-* Search objects now can be inherited
+* __[feature]__ Search objects now can be inherited  (@rstankov)
 
  ```ruby
  class BaseSearch
@@ -20,7 +25,7 @@
  end
  ```
 
-* Using instance method for straight dispatch
+* __[feature]__ Use instance method for straight dispatch (@gsamokovarov)
 
   ```ruby
   class ProductSearch
@@ -28,31 +33,25 @@
 
     scope { Product.all }
 
-    option :name
-    option :category_name
+    option :date, with: :parse_dates
 
-    attr_reader :page
-
-    def initialize(filters = {}, page = 0)
-      super filters
-      @page = page.to_i.abc
-    end
+    private
 
-    def fetch_results
-      super.paginate page: @page
+    def parse_dates(scope, value)
+      # some "magic" method to parse dates
     end
   end
   ```
 
 ## Version 1.0
 
-* Added min_per_page and max_per_page to paging plugin
+* __[feature]__ Added min_per_page and max_per_page to paging plugin (@rstankov)
 
-* Default paging behaves more like 'kaminari' and 'will_paginate' by treating 1 page as 0 index (__backward incompatible__)
+* __[change]__ Default paging behaves more like 'kaminari' and 'will_paginate' by treating 1 page as 0 index (__backward incompatible__) (@rstankov)
 
-* Raise `SearchObject::MissingScopeError` when no scope is provided
+* __[feature]__ Raise `SearchObject::MissingScopeError` when no scope is provided (@rstankov)
 
-* Replace position arguments with Hash of options (__backward incompatible__)
+* __[change]__ Replace position arguments with Hash of options (__backward incompatible__) (@rstankov)
 
   ```diff
   - Search.new params[:f], params[:page]
@@ -61,10 +60,10 @@
 
 ## Version 0.2
 
-* Added `.results` shortcut for `new(*arg).results`
+* __[feature]__ Added `.results` shortcut for `new(*arg).results` (@rstankov)
 
-* Fix wrong limit and offset in default paging
+* __[fix]__ Fix wrong limit and offset in default paging (@rstankov)
 
 ## Version 0.1
 
-* Initial release
+* Initial release (@rstankov)

data/README.md

@@ -293,7 +293,7 @@ class ProductSearch
 
   def initialize(filters = {}, page = 0)
     super filters
-    @page = page.to_i.abc
+    @page = page.to_i.abs
   end
 
   def fetch_results

data/example/Gemfile

@@ -1,11 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'rails', '4.2.0'
-gem 'sqlite3'
+gem 'rails', '5.0.1'
+
+gem 'bootstrap-sass'
+gem 'jquery-rails'
+gem 'rspec-rails'
 gem 'sass-rails', '~> 5.0.0'
 gem 'slim'
-gem 'jquery-rails'
-gem 'bootstrap-sass'
+gem 'sqlite3'
 gem 'will_paginate'
 gem 'will_paginate-bootstrap'
-gem 'rspec-rails'

data/example/config/environments/test.rb

@@ -13,8 +13,8 @@ Example::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
-  config.static_cache_control = "public, max-age=3600"
+  config.public_file_server.enabled  = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true

data/example/spec/models/post_search_spec.rb

@@ -74,10 +74,10 @@ describe PostSearch do
   end
 
   it 'can sort by views count' do
-    post_3 = create views_count: 3
-    post_2 = create views_count: 2
-    post_1 = create views_count: 1
+    post3 = create views_count: 3
+    post2 = create views_count: 2
+    post1 = create views_count: 1
 
-    expect_search(sort: 'views_count').to eq [post_3, post_2, post_1]
+    expect_search(sort: 'views_count').to eq [post3, post2, post1]
   end
 end

data/lib/search_object/helper.rb

@@ -1,11 +1,15 @@
 module SearchObject
+  # :api: private
   module Helper
     class << self
       def stringify_keys(hash)
+        # Note(rstankov): From Rails 5+ ActionController::Parameters aren't Hash
+        #   In a lot of cases `stringify_keys` is used on action params
+        hash = hash.to_unsafe_h if hash.respond_to? :to_unsafe_h
         Hash[(hash || {}).map { |k, v| [k.to_s, v] }]
       end
 
-      def select_keys(hash, keys)
+      def slice_keys(hash, keys)
         keys.inject({}) do |memo, key|
           memo[key] = hash[key] if hash.key? key
           memo

data/lib/search_object/plugin/sorting.rb

@@ -5,7 +5,7 @@ module SearchObject
         base.extend ClassMethods
         base.instance_eval do
           option :sort do |scope, _|
-            scope.order "#{sort_attribute} #{sort_direction}"
+            scope.order sort_attribute => sort_direction
           end
         end
       end

data/lib/search_object/plugin/will_paginate.rb

@@ -10,7 +10,7 @@ module SearchObject
       private
 
       def apply_paging(scope)
-        scope.paginate per_page: per_page, page: page == 0 ? nil : page
+        scope.paginate per_page: per_page, page: page.zero? ? nil : page
       end
     end
   end

data/lib/search_object/search.rb

@@ -6,7 +6,7 @@ module SearchObject
       def build_for(config, options)
         scope   = options.fetch(:scope) { config[:scope] && config[:scope].call }
         filters = Helper.stringify_keys(options.fetch(:filters, {}))
-        params  = config[:defaults].merge Helper.select_keys(filters, config[:actions].keys)
+        params  = config[:defaults].merge Helper.slice_keys(filters, config[:actions].keys)
 
         raise MissingScopeError unless scope
 

data/lib/search_object/version.rb

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

data/search_object.gemspec

@@ -18,15 +18,16 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 1.13"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', '~> 2.14'
-  spec.add_development_dependency 'rspec-mocks', '>= 2.12.3'
-  spec.add_development_dependency 'activerecord', '>= 3.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.5'
+  spec.add_development_dependency 'activerecord', '~> 5.0'
+  spec.add_development_dependency 'actionpack', '~> 5.0'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'will_paginate'
   spec.add_development_dependency 'kaminari'
-  spec.add_development_dependency 'rubocop', '0.40.0'
-  spec.add_development_dependency 'rubocop-rspec', '1.5.0'
+  spec.add_development_dependency 'rubocop', '0.46.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.8.0'
 end

data/spec/search_object/helper_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'action_controller'
 
 module SearchObject
   describe Helper do
@@ -7,16 +8,22 @@ module SearchObject
         hash = Helper.stringify_keys a: 1, b: nil, c: false
         expect(hash).to eq 'a' => 1, 'b' => nil, 'c' => false
       end
+
+      it 'converts ActionController::Parameters to hash' do
+        params = ::ActionController::Parameters.new a: 1, b: nil, c: false
+        hash = Helper.stringify_keys params
+        expect(hash).to eq 'a' => 1, 'b' => nil, 'c' => false
+      end
     end
 
-    describe '.select_keys' do
+    describe '.slice_keys' do
       it 'selects only given keys' do
-        hash = Helper.select_keys({ a: 1, b: 2, c: 3 }, [:a, :b])
+        hash = Helper.slice_keys({ a: 1, b: 2, c: 3 }, [:a, :b])
         expect(hash).to eq a: 1, b: 2
       end
 
       it 'ignores not existing keys' do
-        hash = Helper.select_keys({}, [:a, :b])
+        hash = Helper.slice_keys({}, [:a, :b])
         expect(hash).to eq({})
       end
     end

data/spec/search_object/plugin/model_spec.rb

@@ -25,9 +25,7 @@ module SearchObject
     describe ExtendedModel do
       include ActiveModel::Lint::Tests
 
-      before do
-        @model = subject
-      end
+      let(:model) { subject }
 
       def assert(condition, message = nil)
         expect(condition).to be_truthy, message

data/spec/search_object/plugin/sorting_spec.rb

@@ -9,10 +9,11 @@ module SearchObject
 
           scope { Product.all }
 
-          sort_by :name, :price
+          sort_by :name, :price, :created_at
 
           option :name
           option :price
+          option(:category) { |scope, _| scope.joins(:category) }
         end
       end
 
@@ -48,6 +49,18 @@ module SearchObject
           search = search_with_sort 'invalid attribute'
           expect { search.results.to_a }.not_to raise_error
         end
+
+        it 'can handle renames of sorting in joins' do
+          older_category = Category.create! name: 'older'
+          newer_category = Category.create! name: 'newer'
+
+          product_of_newer_category = Product.create! name: 'older product', category: newer_category
+          product_of_older_category = Product.create! name: 'newer product', category: older_category
+
+          search = search_with_sort 'created_at desc', category: ''
+
+          expect(search.results.map(&:name)).to eq [product_of_older_category.name, product_of_newer_category.name]
+        end
       end
 
       describe '#sort?' do

data/spec/spec_helper_active_record.rb

@@ -9,12 +9,22 @@ ActiveRecord::Schema.define do
 
   create_table :products, force: true do |t|
     t.string :name
-    t.string :category_name
+    t.integer :category_id
     t.integer :price
 
     t.timestamps null: true
   end
+
+  create_table :categories, force: true do |t|
+    t.string :name
+
+    t.timestamps null: true
+  end
 end
 
 class Product < ActiveRecord::Base
+  belongs_to :category
+end
+
+class Category < ActiveRecord::Base
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.3
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.3
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +156,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.46.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.46.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.8.0
 description: Search object DSL
 email:
 - rstankov@gmail.com