search_object 1.2.1 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19b1b27bb979fcee5671d55ef380f628fb8ba624c274166ad40aa8970d8ad2f
-  data.tar.gz: 4dc53dd30f010996cea99732d647d44d6d2d3eb07b8a39920b590dabdad5caa1
+  metadata.gz: c01187c2852ea65c1c340bc37e62527c9d4133691ded6a9db4ac5dea78441b1d
+  data.tar.gz: 177bf4f66eccf02f9195a9aa2b8563f8d1de4465be812157f9eeec1ac90121a6
 SHA512:
-  metadata.gz: 702e7451fa287d3e98c75dc00fe0977ed4bc901fd72b4bd26fd18089c6abc200f0a03b78be6312b3217a3ecbb193b9a0346cf14834000aecd517968d41b5384b
-  data.tar.gz: 3b2cdb6312c1ac99afcbb1ea498339c6f732ab38bd45359af4ee84fc7543b5966bc6e5b797fb2525975c478fca4e10d5719487f8da9a87884de13cbcc9509bb5
+  metadata.gz: 3cd78261ad83342fec752d1e54714afe7971841ae5afa90270bd90a8a1713cbb2aa06fdbad3489be78127195666015918f9f356ec1f4c9809b201f5631fc0795
+  data.tar.gz: 575474f4d79ff650bccb1cb9e9d33cb540d4b85dfc18a23487e1239e6a6833bf4da7dc52193829d2c116a51c9089736720eb6ac5db5868b814558fe15675fc34

data/.rubocop.yml

@@ -7,15 +7,15 @@ AllCops:
     - search_object.gemspec
 
 # Disables "Line is too long"
-LineLength:
+Layout/LineLength:
   Enabled: false
 
 # Disables Module has too many lines
-ModuleLength:
+Metrics/ModuleLength:
   Enabled: false
 
 # Disables "Missing top-level class documentation comment"
-Documentation:
+Style/Documentation:
   Enabled: false
 
 # Disables "Use each_with_object instead of inject"
@@ -37,3 +37,18 @@ RSpec/ExampleLength:
 # Disables "Too many expectations."
 RSpec/MultipleExpectations:
   Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
+  - 2.4
+  - 2.6
+  - 2.7
+  - 3.0
 script:
   - bundle exec rubocop
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,8 +1,25 @@
 # Changelog
 
+## Version 1.2.5
+
+* __[feature]__ Added `param?` method to `Search::Base` (@rstankov)
+
+## Version 1.2.4
+
+* __[feature]__ Added `:with` and block support to enum (@hschne)
+
+## Version 1.2.3
+
+* __[fix]__ convert enum values to strings (@Postmodum37)
+
+## 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 +33,7 @@ end
 
 ## Version 1.2.0
 
-* __[feature]__ `enum` plugin added (@rstankov)
+* __[feature]__ Added `enum` plugin (@rstankov)
 
 ```ruby
 class ProductSearch

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in search_object.gemspec

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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/example/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'rails', '5.0.1'
+gem 'rails', '6.0.2.1'
 
 gem 'bootstrap-sass'
 gem 'jquery-rails'

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/example/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Example::Application.load_tasks

data/example/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
 end

data/example/app/controllers/posts_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PostsController < ApplicationController
   def index
     @search = PostSearch.new filters: params[:f], page: params[:page], per_page: params[:per_page]

data/example/app/models/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Post < ActiveRecord::Base
   belongs_to :user
 

data/example/app/models/post_search.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class PostSearch
   include SearchObject.module(:model, :sorting, :will_paginate, :enum)
 
-  scope { Post.all }
+  scope { Post.includes(:user).all }
 
   sort_by :id, :created_at, :views_count, :likes_count, :comments_count
 
@@ -18,11 +20,11 @@ class PostSearch
   option :rating, enum: %i[low high]
 
   option :title do |scope, value|
-    scope.where 'title LIKE ?', escape_search_term(value)
+    scope.where 'title LIKE ?', escape_search_term(value) if value.present?
   end
 
   option :published do |scope, value|
-    scope.where published: true if value.present?
+    scope.where published: true if value.present? && value != '0'
   end
 
   option :created_after do |scope, value|
@@ -38,7 +40,7 @@ class PostSearch
   private
 
   def apply_term(scope, value)
-    scope.where 'title LIKE :term OR body LIKE :term', term: escape_search_term(value)
+    scope.where 'title LIKE :term OR body LIKE :term', term: escape_search_term(value) if value.present?
   end
 
   def apply_rating_with_low(scope)

data/example/app/models/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class User < ActiveRecord::Base
   has_many :posts
 

data/example/app/views/posts/index.html.slim

@@ -32,7 +32,7 @@
         th
         th = form.text_field :title
         th = form.select :user_id, User.all.map { |u| [u.name, u.id] }, include_blank: true
-        th = form.select :category_name, Post.pluck('DISTINCT category_name'), include_blank: true
+        th = form.select :category_name, Post.pluck(Arel.sql('DISTINCT category_name')), include_blank: true
         th
         th
         th

data/example/bin/bundle

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/example/bin/rails

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

data/example/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/example/config.ru

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

data/example/db/migrate/20131102130117_create_users.rb

@@ -1,4 +1,4 @@
-class CreateUsers < ActiveRecord::Migration
+class CreateUsers < ActiveRecord::Migration[4.2]
   def change
     create_table :users do |t|
       t.string :name, null: false

data/example/db/migrate/20131102130413_create_posts.rb

@@ -1,4 +1,4 @@
-class CreatePosts < ActiveRecord::Migration
+class CreatePosts < ActiveRecord::Migration[4.2]
   def change
     create_table :posts do |t|
       t.integer :user_id, null: false
@@ -9,7 +9,6 @@ class CreatePosts < ActiveRecord::Migration
       t.integer :likes_count, null: false, default: 0
       t.integer :comments_count, null: false, default: 0
       t.boolean :published, null: false, default: false
-      t.datetime :published_at
       t.timestamps
     end
 

data/example/db/schema.rb

@@ -1,40 +1,36 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
+# This file is the source Rails uses to define your schema when running `rails
+# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20131102130413) do
+ActiveRecord::Schema.define(version: 2013_11_02_130413) do
 
-  create_table "posts", force: true do |t|
-    t.integer  "user_id",                        null: false
-    t.string   "title",                          null: false
-    t.string   "body",                           null: false
-    t.string   "category_name",                  null: false
-    t.integer  "views_count",    default: 0,     null: false
-    t.integer  "likes_count",    default: 0,     null: false
-    t.integer  "comments_count", default: 0,     null: false
-    t.boolean  "published",      default: false, null: false
-    t.datetime "published_at"
+  create_table "posts", force: :cascade do |t|
+    t.integer "user_id", null: false
+    t.string "title", null: false
+    t.string "body", null: false
+    t.string "category_name", null: false
+    t.integer "views_count", default: 0, null: false
+    t.integer "likes_count", default: 0, null: false
+    t.integer "comments_count", default: 0, null: false
+    t.boolean "published", default: false, null: false
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.index ["user_id"], name: "index_posts_on_user_id"
   end
 
-  add_index "posts", ["user_id"], name: "index_posts_on_user_id"
-
-  create_table "users", force: true do |t|
-    t.string   "name",       null: false
+  create_table "users", force: :cascade do |t|
+    t.string "name", limit: 255, null: false
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.index ["name"], name: "index_users_on_name", unique: true
   end
 
-  add_index "users", ["name"], name: "index_users_on_name", unique: true
-
 end

data/example/spec/models/post_search_spec.rb

@@ -1,4 +1,4 @@
-# rubocop:disable Lint/UselessAssignment:%s
+# frozen_string_literal: true
 
 require 'spec_helper'
 
@@ -11,11 +11,11 @@ describe PostSearch do
 
   def create(attributes = {})
     Post.create! attributes.reverse_merge(
-      user:           user,
-      title:          'Title',
-      body:           'Body',
-      category_name:  'Tech',
-      published:      true
+      user: user,
+      title: 'Title',
+      body: 'Body',
+      category_name: 'Tech',
+      published: true
     )
   end
 
@@ -24,29 +24,29 @@ describe PostSearch do
   end
 
   it 'can search by category name' do
-    post  = create category_name: 'Personal'
-    other = create category_name: 'Other'
+    post = create category_name: 'Personal'
+    _other = create category_name: 'Other'
 
     expect_search(category_name: 'Personal').to eq [post]
   end
 
   it 'can search by user_id' do
-    post  = create user: create_user
-    other = create user: create_user
+    post = create user: create_user
+    _other = create user: create_user
 
     expect_search(user_id: post.user_id).to eq [post]
   end
 
   it 'can search by title' do
-    post  = create title: 'Title'
-    other = create title: 'Other'
+    post = create title: 'Title'
+    _other = create title: 'Other'
 
     expect_search(title: 'itl').to eq [post]
   end
 
   it 'can search by published' do
-    post  = create published: true
-    other = create published: false
+    post = create published: true
+    _other = create published: false
 
     expect_search(published: true).to eq [post]
   end
@@ -54,21 +54,21 @@ describe PostSearch do
   it 'can search by term' do
     post_with_body  = create body: 'pattern'
     post_with_title = create title: 'pattern'
-    other           = create
+    _other = create
 
     expect_search(term: 'pattern').to eq [post_with_title, post_with_body]
   end
 
   it 'can search by created after' do
-    post  = create created_at: 1.month.ago
-    other = create created_at: 3.month.ago
+    post = create created_at: 1.month.ago
+    _other = create created_at: 3.month.ago
 
     expect_search(created_after: 2.month.ago.strftime('%Y-%m-%d')).to eq [post]
   end
 
   it 'can search by created before' do
-    post  = create created_at: 3.month.ago
-    other = create created_at: 1.month.ago
+    post = create created_at: 3.month.ago
+    _other = create created_at: 1.month.ago
 
     expect_search(created_before: 2.month.ago.strftime('%Y-%m-%d')).to eq [post]
   end

data/example/spec/spec_helper.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 ENV['RAILS_ENV'] ||= 'test'
 
-require File.expand_path('../../config/environment', __FILE__)
+require File.expand_path('../config/environment', __dir__)
 require 'rspec/rails'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+Dir[Rails.root.join('spec/support/**/*.rb')].sort.each { |f| require f }
 
 # Checks for pending migrations before tests are run.
 # If you are not using ActiveRecord, you can remove this line.

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
@@ -42,6 +52,16 @@ module SearchObject
       end
     end
 
+    def param?(*args)
+      if args.size == 1
+        params.key?(args[0].to_s)
+      elsif args.size == 2
+        params[args[0].to_s] == args[1]
+      else
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 1 or 2)"
+      end
+    end
+
     private
 
     def fetch_results
@@ -67,7 +87,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
@@ -9,10 +11,7 @@ module SearchObject
         def option(name, options = nil, &block)
           return super unless options.is_a?(Hash) && options[:enum]
 
-          raise BlockIgnoredError if block
-          raise WithIgnoredError if options[:with]
-
-          handler = Handler.build(name, options[:enum])
+          handler = options[:with] || block || Handler.build(name, options[:enum])
 
           super(name, options, &handler)
         end
@@ -30,19 +29,16 @@ module SearchObject
         def apply_filter(object:, option:, enums:, scope:, value:)
           return if value.nil? || value == ''
 
-          unless enums.include? value
-            return handle_invalid_value(object: object, option: option, enums: enums, scope: scope, value: value)
-          end
+          return handle_invalid_value(object: object, option: option, enums: enums, scope: scope, value: value) unless enums.include? value.to_s
 
-          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:)
           specific = "handle_invalid_#{option}"
           return object.send(specific, scope, value) if object.respond_to? specific, true
 
-          catch_all = 'handle_invalid_enum'
-          return object.send(catch_all, option, scope, value) if object.respond_to? catch_all, true
+          return object.handle_invalid_enum(option, scope, value) if object.respond_to? :handle_invalid_enum, true
 
           raise InvalidEnumValueError.new(option, enums, value)
         end

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
@@ -26,17 +28,20 @@ module SearchObject
 
       module ClassMethods
         def per_page(number)
-          raise InvalidNumberError.new('Per page', number) unless number > 0
+          raise InvalidNumberError.new('Per page', number) unless number.positive?
+
           config[:per_page] = number
         end
 
         def min_per_page(number)
-          raise InvalidNumberError.new('Min per page', number) unless number > 0
+          raise InvalidNumberError.new('Min per page', number) unless number.positive?
+
           config[:min_per_page] = number
         end
 
         def max_per_page(number)
-          raise InvalidNumberError.new('Max per page', number) unless number > 0
+          raise InvalidNumberError.new('Max per page', number) unless number.positive?
+
           config[:max_per_page] = number
         end
 

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.5'
 end

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/search_object.gemspec

@@ -18,7 +18,7 @@ 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.13"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'rspec-mocks', '~> 3.5'
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'will_paginate'
   spec.add_development_dependency 'kaminari'
   spec.add_development_dependency 'kaminari-activerecord'
-  spec.add_development_dependency 'rubocop', '0.51.0'
-  spec.add_development_dependency 'rubocop-rspec', '1.20.1'
+  spec.add_development_dependency 'rubocop', '0.81.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.38.1'
 end

data/spec/search_object/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'active_support/core_ext/object/blank'
 
@@ -282,6 +284,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
@@ -310,5 +329,44 @@ module SearchObject
         expect(search.params).to eq 'value' => 1
       end
     end
+
+    describe '#param?' do
+      context 'one argument' do
+        it 'returns true when params is set' do
+          search = new_search([], value: 2) do
+            option :value
+          end
+
+          expect(search.param?(:value)).to eq true
+        end
+
+        it 'returns false when params isnt set' do
+          search = new_search do
+            option :value
+          end
+
+          expect(search.param?(:value)).to eq false
+        end
+      end
+
+      context 'two arguments' do
+        it 'returns true when param matches value' do
+          search = new_search([], value: 2) do
+            option :value
+          end
+
+          expect(search.param?(:value, 2)).to eq true
+        end
+
+        it 'returns false when param matches value' do
+          search = new_search([], value: 2) do
+            option :value
+          end
+
+          expect(search.param?(:value, 3)).to eq false
+          expect(search.param?(:other, 3)).to eq false
+        end
+      end
+    end
   end
 end

data/spec/search_object/helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'action_controller'
 
@@ -41,24 +43,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

@@ -1,63 +1,89 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'ostruct'
 
 module SearchObject
   module Plugin
     describe Enum do
-      class TestSearch
-        include SearchObject.module(:enum)
+      let(:test_search) do
+        Class.new do
+          include SearchObject.module(:enum)
 
-        scope { [1, 2, 3, 4, 5] }
+          scope { [1, 2, 3, 4, 5] }
 
-        option :filter, enum: %w[odd even]
+          option :filter, enum: %w[odd even]
+          option :camelCase, enum: %w[someValue]
 
-        private
+          private
 
-        def apply_filter_with_odd(scope)
-          scope.select(&:odd?)
-        end
+          def apply_filter_with_odd(scope)
+            scope.select(&:odd?)
+          end
 
-        def apply_filter_with_even(scope)
-          scope.select(&:even?)
-        end
+          def apply_filter_with_even(scope)
+            scope.select(&:even?)
+          end
 
-        def handle_invalid_filter(_scope, value)
-          "invalid filter - #{value}"
+          def apply_camel_case_with_some_value(_scope)
+            [1]
+          end
+
+          def handle_invalid_filter(_scope, value)
+            "invalid filter - #{value}"
+          end
         end
       end
 
       it 'can filter by enum values' do
-        expect(TestSearch.results(filters: { filter: 'odd' })).to eq [1, 3, 5]
-        expect(TestSearch.results(filters: { filter: 'even' })).to eq [2, 4]
+        expect(test_search.results(filters: { filter: 'odd' })).to eq [1, 3, 5]
+        expect(test_search.results(filters: { filter: 'even' })).to eq [2, 4]
+      end
+
+      it 'converts input to string' do
+        expect(test_search.results(filters: { filter: :odd })).to eq [1, 3, 5]
+        expect(test_search.results(filters: { filter: :even })).to eq [2, 4]
       end
 
       it 'ignores blank values' do
-        expect(TestSearch.results(filters: { filter: nil })).to eq [1, 2, 3, 4, 5]
-        expect(TestSearch.results(filters: { filter: '' })).to eq [1, 2, 3, 4, 5]
+        expect(test_search.results(filters: { filter: nil })).to eq [1, 2, 3, 4, 5]
+        expect(test_search.results(filters: { filter: '' })).to eq [1, 2, 3, 4, 5]
       end
 
       it 'handles wrong enum values' do
-        expect(TestSearch.results(filters: { filter: 'foo' })).to eq 'invalid filter - foo'
+        expect(test_search.results(filters: { filter: 'foo' })).to eq 'invalid filter - foo'
       end
 
-      it 'raises when block is passed with enum option' do
-        expect do
-          Class.new do
-            include SearchObject.module(:enum)
+      it 'underscores method and enum values' do
+        expect(test_search.results(filters: { camelCase: 'someValue' })).to eq [1]
+      end
 
-            option(:filter, enum: %w[a b]) { |_scope, _value| nil }
-          end
-        end.to raise_error Enum::BlockIgnoredError
+      it 'can filter by passed block' do
+        block_search = Class.new do
+          include SearchObject.module(:enum)
+
+          scope { [1, 2, 3, 4, 5] }
+
+          option(:filter, enum: %w[odd even]) { |scope, value| scope.select(&:"#{value}?".to_sym) }
+        end
+        expect(block_search.results(filters: { filter: :odd })).to eq [1, 3, 5]
+        expect(block_search.results(filters: { filter: :even })).to eq [2, 4]
       end
 
-      it 'raises when :with is passed with enum option' do
-        expect do
-          Class.new do
-            include SearchObject.module(:enum)
+      it 'can filter by with option' do
+        with_search = Class.new do
+          include SearchObject.module(:enum)
+
+          scope { [1, 2, 3, 4, 5] }
 
-            option :filter, enum: %w[a b], with: :method_name
+          option(:filter, enum: %w[odd even], with: :filter)
+
+          def filter(scope, value)
+            scope.select(&:"#{value}?".to_sym)
           end
-        end.to raise_error Enum::WithIgnoredError
+        end
+        expect(with_search.results(filters: { filter: :odd })).to eq [1, 3, 5]
+        expect(with_search.results(filters: { filter: :even })).to eq [2, 4]
       end
     end
 

data/spec/search_object/plugin/kaminari_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper_active_record'
 require 'kaminari'
 

data/spec/search_object/plugin/model_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 require 'active_support/core_ext/object/blank'

data/spec/search_object/plugin/paging_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper_active_record'
 
 module SearchObject

data/spec/search_object/plugin/sorting_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper_active_record'
 
 module SearchObject

data/spec/search_object/plugin/will_paginate_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper_active_record'
 
 require 'will_paginate'

data/spec/search_object/search_spec.rb

@@ -1,70 +1,89 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 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

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 if ENV['TRAVIS']

data/spec/spec_helper_active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'spec_helper'
 require_relative 'support/paging_shared_example'
 require 'active_record'

data/spec/support/paging_shared_example.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples_for 'a paging plugin' do
   after do
     Product.delete_all

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.5
 platform: ruby
 authors:
 - Radoslav Stankov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2021-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,28 +170,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: 1.38.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: 1.38.1
 description: Search object DSL
 email:
 - rstankov@gmail.com
@@ -278,7 +278,7 @@ homepage: https://github.com/RStankov/SearchObject
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -293,9 +293,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Provides DSL for creating search objects
 test_files: