search_object 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19b1b27bb979fcee5671d55ef380f628fb8ba624c274166ad40aa8970d8ad2f
-  data.tar.gz: 4dc53dd30f010996cea99732d647d44d6d2d3eb07b8a39920b590dabdad5caa1
+  metadata.gz: 5f55c0e518e6eb83f63ca7670605b85c7caf3a3736b070759edd7e76688b85ec
+  data.tar.gz: 8435ace3621b80b7b146f9cb78f7586036fb6e849ce660844bbd0f49e4a8d3ec
 SHA512:
-  metadata.gz: 702e7451fa287d3e98c75dc00fe0977ed4bc901fd72b4bd26fd18089c6abc200f0a03b78be6312b3217a3ecbb193b9a0346cf14834000aecd517968d41b5384b
-  data.tar.gz: 3b2cdb6312c1ac99afcbb1ea498339c6f732ab38bd45359af4ee84fc7543b5966bc6e5b797fb2525975c478fca4e10d5719487f8da9a87884de13cbcc9509bb5
+  metadata.gz: 55a03c93e854a7de0aa2412a071a031219105131a036ca96c20f351ff5989566e278ee76b18d776adbed3d553f633ffd03158318667efef235a75748bfebb79c
+  data.tar.gz: 568572db3450627999c39fc0e5304f52dc06bb49cad958fe8f19e8506e17bfd6684b599a64027d91dcdc426f632454ccff89b4123510b624231b5434823fa04e

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
+
+## Version 1.2.2
+
+* __[feature]__ Added `SearchObject::Base#params=` method, to reset search results (@rstankov)
+* __[change]__ `option :orderBy, enum: %(price date)`, now expects a method `apply_order_by_x`, instead of `apply_orderBy_with_` (__backward incompatible__) (@rstankov)
+
 ## Version 1.2.1
 
-* __[feature]__ Add `default:` option to `sort_by` plugin (@rstankov)
+* __[feature]__ Added `default:` option to `sort_by` plugin (@rstankov)
 
 ```ruby
 class ProductSearch
@@ -16,7 +22,7 @@ end
 
 ## Version 1.2.0
 
-* __[feature]__ `enum` plugin added (@rstankov)
+* __[feature]__ Added `enum` plugin (@rstankov)
 
 ```ruby
 class ProductSearch

data/README.md

@@ -76,7 +76,7 @@ end
 Then you can just search the given scope:
 
 ```ruby
-search = PostSearch.new filters: params[:filters]
+search = PostSearch.new(filters: params[:filters])
 
 # accessing search options
 search.name                        # => name option
@@ -115,7 +115,7 @@ class ProductSearch
   option :name
   option :category_name
 
-  # per page defaults to 25
+  # per page defaults to 10
   per_page 10
 
   # range of values is also possible
@@ -123,7 +123,7 @@ class ProductSearch
   max_per_page 100
 end
 
-search = ProductSearch.new filters: params[:filters], page: params[:page], per_page: params[:per_page]
+search = ProductSearch.new(filters: params[:filters], page: params[:page], per_page: params[:per_page])
 
 search.page                                                 # => page number
 search.per_page                                             # => per page (10)
@@ -228,7 +228,7 @@ class ProductSearch
   sort_by :name, :price
 end
 
-search = ProductSearch.new filters: {sort: 'price desc'}
+search = ProductSearch.new(filters: {sort: 'price desc'})
 
 search.results                                # => Product sorted my price DESC
 search.sort_attribute                         # => 'price'
@@ -267,7 +267,7 @@ class ProductSearch
 end
 
 # first arguments is treated as scope (if no scope option is provided)
-search = ProductSearch.new scope: Product.visible, filters: params[:f]
+search = ProductSearch.new(scope: Product.visible, filters: params[:f])
 search.results # => includes only visible products
 ```
 

data/example/README.md

@@ -19,9 +19,9 @@ This is example application showing, one of the possible usages of ```SearchObje
 ```
 gem install bundler
 bundle install
-rake db:create
-rake db:migrate
-rake db:seed
+rails db:create
+rails db:migrate
+rails db:seed
 
 rails server
 ```

data/lib/search_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'search_object/version'
 require 'search_object/errors'
 require 'search_object/helper'

data/lib/search_object/base.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Base
     def self.included(base)
       base.extend ClassMethods
       base.instance_eval do
         @config = {
-          defaults:  {},
-          actions:   {},
-          scope:     nil
+          defaults: {},
+          options:  {}
         }
       end
     end
@@ -14,12 +15,15 @@ module SearchObject
     def initialize(options = {})
       config = self.class.config
       scope  = options[:scope] || (config[:scope] && instance_eval(&config[:scope]))
-      actions = config[:actions] || {}
-      params  = Helper.normalize_params(config[:defaults], options[:filters], actions.keys)
 
       raise MissingScopeError unless scope
 
-      @search = Search.new(scope, params, actions)
+      @search = Search.new(
+        scope: scope,
+        options: config[:options],
+        defaults: config[:defaults],
+        params: options[:filters]
+      )
     end
 
     def results
@@ -34,6 +38,12 @@ module SearchObject
       @count ||= @search.count self
     end
 
+    def params=(params)
+      @count = nil
+      @results = nil
+      @search.params = params
+    end
+
     def params(additions = {})
       if additions.empty?
         @search.params
@@ -67,7 +77,7 @@ module SearchObject
         handler = options[:with] || block
 
         config[:defaults][name] = default unless default.nil?
-        config[:actions][name]  = Helper.normalize_search_handler(handler, name)
+        config[:options][name]  = Helper.normalize_search_handler(handler, name)
 
         define_method(name) { @search.param name }
       end

data/lib/search_object/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   class MissingScopeError < ArgumentError
     def initialize(message = 'No scope provided. Scope can be defined on a class level or passed as an option.')

data/lib/search_object/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   # :api: private
   module Helper
@@ -54,10 +56,6 @@ module SearchObject
       end
     end
 
-    def normalize_params(defaults, filters, keys)
-      (defaults || {}).merge(slice_keys(stringify_keys(filters || {}), keys || []))
-    end
-
     def deep_copy(object) # rubocop:disable Metrics/MethodLength
       case object
       when Array

data/lib/search_object/plugin/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module Enum
@@ -34,7 +36,7 @@ module SearchObject
             return handle_invalid_value(object: object, option: option, enums: enums, scope: scope, value: value)
           end
 
-          object.send("apply_#{option}_with_#{Helper.underscore(value)}", scope)
+          object.send("apply_#{Helper.underscore(option)}_with_#{Helper.underscore(value)}", scope)
         end
 
         def handle_invalid_value(object:, option:, enums:, scope:, value:)

data/lib/search_object/plugin/kaminari.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module Kaminari

data/lib/search_object/plugin/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module Model

data/lib/search_object/plugin/paging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module Paging

data/lib/search_object/plugin/sorting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module Sorting

data/lib/search_object/plugin/will_paginate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
   module Plugin
     module WillPaginate

data/lib/search_object/search.rb

@@ -1,21 +1,29 @@
+# frozen_string_literal: true
+
 module SearchObject
   # :api: private
   class Search
     attr_reader :params
 
-    def initialize(scope, params, actions)
-      @scope    = scope
-      @actions  = actions
-      @params   = params
+    def initialize(scope:, options: nil, defaults: nil, params: nil)
+      @scope = scope
+      @options = options || {}
+      @defaults = defaults || {}
+
+      self.params = params
+    end
+
+    def params=(params)
+      @params = @defaults.merge(Helper.slice_keys(Helper.stringify_keys(params || {}), @options.keys))
     end
 
     def param(name)
-      @params[name]
+      @params[name.to_s]
     end
 
     def query(context)
       @params.inject(@scope) do |scope, (name, value)|
-        new_scope = context.instance_exec scope, value, &@actions[name]
+        new_scope = context.instance_exec scope, value, &@options[name]
         new_scope || scope
       end
     end

data/lib/search_object/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchObject
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/spec/search_object/base_spec.rb

@@ -282,6 +282,23 @@ module SearchObject
       end
     end
 
+    describe '#params=' do
+      it 'resets search' do
+        search = new_search [1, 2, 3], value: 1 do
+          option :value do |scope, value|
+            scope.select { |v| v > value }
+          end
+        end
+
+        expect(search.results).to eq [2, 3]
+        expect(search.count).to eq 2
+
+        search.params = { value: 2 }
+        expect(search.results).to eq [3]
+        expect(search.count).to eq 1
+      end
+    end
+
     describe '#params' do
       it 'exports options as params' do
         search = new_search [], value: 1

data/spec/search_object/helper_spec.rb

@@ -41,24 +41,6 @@ module SearchObject
       end
     end
 
-    describe '.normalize_filters' do
-      it 'combines defaults and filters' do
-        expect(described_class.normalize_params({ 'a' => 1, 'b' => 2 }, { a: 2 }, %w[a b])).to eq 'a' => 2, 'b' => 2
-      end
-
-      it 'excludes non specified keys' do
-        expect(described_class.normalize_params({ 'a' => 1 }, { b: 2 }, %w[a])).to eq 'a' => 1
-      end
-
-      it 'handles missing defaults' do
-        expect(described_class.normalize_params(nil, { a: 1 }, %w[a])).to eq 'a' => 1
-      end
-
-      it 'handles missing filters' do
-        expect(described_class.normalize_params(nil, nil, ['a'])).to eq({})
-      end
-    end
-
     describe 'deep_copy' do
       it 'returns a deep copy on the given object' do
         original = {

data/spec/search_object/plugin/enum_spec.rb

@@ -10,6 +10,7 @@ module SearchObject
         scope { [1, 2, 3, 4, 5] }
 
         option :filter, enum: %w[odd even]
+        option :camelCase, enum: %w[someValue]
 
         private
 
@@ -21,6 +22,10 @@ module SearchObject
           scope.select(&:even?)
         end
 
+        def apply_camel_case_with_some_value(_scope)
+          [1]
+        end
+
         def handle_invalid_filter(_scope, value)
           "invalid filter - #{value}"
         end
@@ -40,6 +45,10 @@ module SearchObject
         expect(TestSearch.results(filters: { filter: 'foo' })).to eq 'invalid filter - foo'
       end
 
+      it 'underscores method and enum values' do
+        expect(TestSearch.results(filters: { camelCase: 'someValue' })).to eq [1]
+      end
+
       it 'raises when block is passed with enum option' do
         expect do
           Class.new do

data/spec/search_object/search_spec.rb

@@ -4,67 +4,84 @@ require 'ostruct'
 module SearchObject
   describe Search do
     describe '.params' do
-      it 'returns the passed params' do
-        search = Search.new('scope', 'params', {})
-        expect(search.params).to eq 'params'
+      it 'stringify param keys' do
+        search = described_class.new(scope: 'scope', params: { name: 'value' }, options: { 'name' => nil })
+        expect(search.params).to eq 'name' => 'value'
+      end
+
+      it 'filters invalid params' do
+        search = described_class.new(scope: 'scope', params: { name: 'value' })
+        expect(search.params).to eq({})
+      end
+
+      it 'supports default values' do
+        search = described_class.new(scope: 'scope', params: {}, defaults: { 'name' => 'value' })
+        expect(search.params).to eq 'name' => 'value'
+      end
+
+      it 'can be updated' do
+        search = described_class.new(scope: 'scope', params: { name: 'value' }, options: { 'name' => nil })
+        search.params = { name: 'updated', fake: 'value' }
+
+        expect(search.params).to eq 'name' => 'updated'
       end
     end
 
     describe '.param' do
       it 'returns the param value' do
-        search = Search.new('scope', { name: 'value' }, {})
+        search = described_class.new(scope: 'scope', params: { name: 'value' }, options: { 'name' => nil })
         expect(search.param(:name)).to eq 'value'
       end
     end
 
     describe '.query' do
       it 'returns filtered result' do
-        actions = {
-          min: ->(scope, min) { scope.select { |v| v > min } }
+        options = {
+          'min' => ->(scope, min) { scope.select { |v| v > min } }
         }
 
-        search = Search.new [1, 2, 3], { min: 2 }, actions
+        search = described_class.new(scope: [1, 2, 3], params: { min: 2 }, options: options)
         expect(search.query(Object.new)).to eq [3]
       end
 
-      it 'applies actions to params' do
-        actions = {
-          min: ->(scope, min) { scope.select { |v| v > min } },
-          max: ->(scope, max) { scope.select { |v| v < max } }
+      it 'applies options to params' do
+        options = {
+          'min' => ->(scope, min) { scope.select { |v| v > min } },
+          'max' => ->(scope, max) { scope.select { |v| v < max } }
         }
 
-        search = Search.new [1, 2, 3, 4, 5], { min: 2, max: 5 }, actions
+        search = described_class.new(scope: [1, 2, 3, 4, 5], params: { min: 2, max: 5 }, options: options)
         expect(search.query(Object.new)).to eq [3, 4]
       end
 
       it 'handles nil returned from action' do
-        actions = {
-          odd: ->(scope, odd) { scope.select(&:odd?) if odd }
+        options = {
+          'odd' => ->(scope, odd) { scope.select(&:odd?) if odd }
         }
 
-        search = Search.new [1, 2, 3, 4, 5], { odd: false }, actions
+        search = described_class.new(scope: [1, 2, 3, 4, 5], params: { odd: false }, options: options)
         expect(search.query(Object.new)).to eq [1, 2, 3, 4, 5]
       end
 
       it 'executes action in the passed context' do
-        actions = {
-          search: ->(scope, _) { scope.select { |v| v == target_value } }
+        options = {
+          'search' => ->(scope, _) { scope.select { |v| v == target_value } }
         }
 
         context = OpenStruct.new target_value: 2
 
-        search = Search.new [1, 2, 3, 4, 5], { search: true }, actions
+        search = described_class.new(scope: [1, 2, 3, 4, 5], params: { search: true }, options: options)
         expect(search.query(context)).to eq [2]
       end
     end
 
     describe '.count' do
       it 'counts the results of the query' do
-        actions = {
-          value: ->(scope, value) { scope.select { |v| v == value } }
+        options = {
+          'value' => ->(scope, value) { scope.select { |v| v == value } }
         }
 
-        search = Search.new [1, 2, 3], { value: 2 }, actions
+        search = described_class.new(scope: [1, 2, 3], params: { value: 2 }, options: options)
         expect(search.count(Object.new)).to eq 1
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -293,8 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides DSL for creating search objects