search_object 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4cce323b42516f0df8bff1b13275f60dcf0439cf
-  data.tar.gz: 35c0d32d6011eae2946e2758ebcf4222b3392f32
+SHA256:
+  metadata.gz: c19b1b27bb979fcee5671d55ef380f628fb8ba624c274166ad40aa8970d8ad2f
+  data.tar.gz: 4dc53dd30f010996cea99732d647d44d6d2d3eb07b8a39920b590dabdad5caa1
 SHA512:
-  metadata.gz: 6df95c9bff5882b28585bf3de86623d2015bdb633fabc8eac0b82e330ce11671ef09f581e7bc25a81e1157db828d0334e513a859bed0971dcfe36e1b906bbace
-  data.tar.gz: 9ef427a40467a42bfde8499f6066de5a98481c66d92c7830b021c992386adf0172bca7df56795ab11c442659103d2902fffcf858f00e8e0608463b47460443b7
+  metadata.gz: 702e7451fa287d3e98c75dc00fe0977ed4bc901fd72b4bd26fd18089c6abc200f0a03b78be6312b3217a3ecbb193b9a0346cf14834000aecd517968d41b5384b
+  data.tar.gz: 3b2cdb6312c1ac99afcbb1ea498339c6f732ab38bd45359af4ee84fc7543b5966bc6e5b797fb2525975c478fca4e10d5719487f8da9a87884de13cbcc9509bb5

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 
-## Version 1.2.0 (unreleased)
+## Version 1.2.1
+
+* __[feature]__ Add `default:` option to `sort_by` plugin (@rstankov)
+
+```ruby
+class ProductSearch
+  include SearchObject.module(:sorting)
+
+  scope { Product.all }
+
+  sort_by :name, :price, :created_at, default: 'price asc'
+end
+```
+
+## Version 1.2.0
 
 * __[feature]__ `enum` plugin added (@rstankov)
 

data/README.md

@@ -5,7 +5,40 @@
 
 # SearchObject
 
-In many of my projects I needed an object that performs several fairly complicated queries. Or, just some multi-field search forms. Most times I hand-coded them, but they would get complicated over time when other concerns were added like sorting, pagination and so on. So I decided to abstract this away and created ```SearchObject```, a DSL for creating such objects.
+In many of my projects I needed an object that performs several fairly complicated queries. Most times I hand-coded them, but they would get complicated over time when other concerns like sorting, pagination and so are being added. So I decided to abstract this away and created ```SearchObject```, a DSL for creating such objects.
+
+It is useful for:
+
+- complicated search forms
+- api endpoints with multiple filter conditions
+- [GraphQL](https://rmosolgo.github.io/graphql-ruby/) resolvers
+- ... search objects 😀
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Dependencies](#dependencies)
+* [Usage](#usage)
+  * [Example](#example)
+* [Plugins](#plugins)
+  * [Paginate Plugin](#paginate-plugin)
+  * [Enum Plugin](#enum-plugin)
+  * [Model Plugin](#model-plugin)
+  * [GraphQL Plugin](#graphql-plugin)
+  * [Sorting Plugin](#sorting-plugin)
+* [Tips & Tricks](#tips--tricks)
+    * [Results Shortcut](#results-shortcut)
+    * [Passing Scope as Argument](#passing-scope-as-argument)
+    * [Handling Nil Options](#handling-nil-options)
+    * [Default Option Block](#default-option-block)
+    * [Using Instance Method in Option Blocks](#using-instance-method-in-option-blocks)
+    * [Using Instance Method for Straight Dispatch](#using-instance-method-for-straight-dispatch)
+    * [Active Record Is Not Required](#active-record-is-not-required)
+    * [Overwriting Methods](#overwriting-methods)
+    * [Extracting Basic Module](#extracting-basic-module#)
+* [Contributing](#contributing)
+* [License](#license)
+
 
 ## Installation
 
@@ -59,7 +92,7 @@ search.params                      # => option values
 search.params opened: false        # => overwrites the 'opened' option
 ```
 
-## Example
+### Example
 
 You can find example of most important features and plugins - [here](https://github.com/RStankov/SearchObject/tree/master/example).
 
@@ -69,7 +102,7 @@ You can find example of most important features and plugins - [here](https://git
 
 Plugins are just plain Ruby modules, which are included with ```SearchObject.module```. They are located under ```SearchObject::Plugin``` module.
 
-### Paginate plugin
+### Paginate Plugin
 
 Really simple paginate plugin, which uses the plain ```.limit``` and ```.offset``` methods.
 
@@ -104,7 +137,7 @@ include SearchObject.module(:will_paginate)
 include SearchObject.module(:kaminari)
 ```
 
-### Enum plugin
+### Enum Plugin
 
 Gives you filter with pre-defined options.
 
@@ -135,7 +168,7 @@ class ProductSearch
 end
 ```
 
-### Model plugin
+### Model Plugin
 
 Extends your search object with ```ActiveModel```, so you can use it in Rails forms.
 
@@ -161,7 +194,28 @@ end
 <% end %>
 ```
 
-### Sorting plugin
+### GraphQL Plugin
+
+Installed as separate [gem](https://github.com/RStankov/SearchObjectGraphQL), it is designed to work with GraphQL:
+
+```
+gem 'search_object_graphql'
+```
+
+```ruby
+class PostResolver
+  include SearchObject.module(:graphql)
+
+  type PostType
+
+  scope { Post.all }
+
+  option(:name, type: types.String)       { |scope, value| scope.where name: value }
+  option(:published, type: types.Boolean) { |scope, value| value ? scope.published : scope.unpublished }
+end
+```
+
+### Sorting Plugin
 
 Fixing the pain of dealing with sorting attributes and directions.
 
@@ -197,7 +251,7 @@ search.sort_params_for('name')
 
 ## Tips & Tricks
 
-### Results shortcut
+### Results Shortcut
 
 Very often you will just need results of search:
 
@@ -205,7 +259,7 @@ Very often you will just need results of search:
 ProductSearch.new(params).results == ProductSearch.results(params)
 ```
 
-### Passing scope as argument
+### Passing Scope as Argument
 
 ``` ruby
 class ProductSearch
@@ -217,8 +271,7 @@ search = ProductSearch.new scope: Product.visible, filters: params[:f]
 search.results # => includes only visible products
 ```
 
-
-### Handling nil options
+### Handling Nil Options
 
 ```ruby
 class ProductSearch
@@ -231,7 +284,7 @@ class ProductSearch
 end
 ```
 
-### Default option block
+### Default Option Block
 
 ```ruby
 class ProductSearch
@@ -243,7 +296,7 @@ class ProductSearch
 end
 ```
 
-### Using instance method in option blocks
+### Using Instance Method in Option Blocks
 
 ```ruby
 class ProductSearch
@@ -261,7 +314,7 @@ class ProductSearch
 end
 ```
 
-### Using instance method for straight dispatch
+### Using Instance Method for Straight Dispatch
 
 ```ruby
 class ProductSearch
@@ -279,7 +332,7 @@ class ProductSearch
 end
 ```
 
-### Active Record is not required at all
+### Active Record Is Not Required
 
 ```ruby
 class ProductSearch
@@ -292,7 +345,7 @@ class ProductSearch
 end
 ```
 
-### Overwriting methods
+### Overwriting Methods
 
 You can have fine grained scope, by overwriting ```initialize``` method:
 
@@ -333,7 +386,7 @@ class ProductSearch
 end
 ```
 
-### Extracting basic module
+### Extracting Basic Module
 
 You can extarct a basic search class for your application.
 

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/example/README.md

@@ -1,11 +1,11 @@
-# SearchObject example Rails application
+# SearchObject Example Rails Application
 
 This is example application showing, one of the possible usages of ```SearchObject```. It showcases the following features:
 
   * Basic search object functionality
   * Default options
   * Using private method helpers in options
-  * Plugins: model, sorting, will_paginate
+  * Plugins: model, sorting, will_paginate, enum
 
 ## Interesting files:
 

data/example/app/models/post_search.rb

@@ -15,7 +15,7 @@ class PostSearch
 
   option :term, with: :apply_term
 
-  option :rating, enum: %i(low high)
+  option :rating, enum: %i[low high]
 
   option :title do |scope, value|
     scope.where 'title LIKE ?', escape_search_term(value)
@@ -51,7 +51,7 @@ class PostSearch
 
   def parse_date(value)
     Date.parse(value).strftime('%Y-%m-%d')
-  rescue
+  rescue ArgumentError
     nil
   end
 

data/lib/search_object/plugin/sorting.rb

@@ -19,7 +19,7 @@ module SearchObject
       end
 
       def sort_direction
-        @sort_direction ||= Helper.ensure_included sort.to_s.split(' ', 2).last, %w(desc asc)
+        @sort_direction ||= Helper.ensure_included sort.to_s.split(' ', 2).last, %w[desc asc]
       end
 
       def sort_direction_for(attribute)
@@ -40,9 +40,9 @@ module SearchObject
       end
 
       module ClassMethods
-        def sort_by(*attributes)
+        def sort_by(*attributes, default: nil)
           config[:sort_attributes]  = attributes.map(&:to_s)
-          config[:defaults]['sort'] = "#{config[:sort_attributes].first} desc"
+          config[:defaults]['sort'] = default || "#{config[:sort_attributes].first} desc"
         end
 
         def sort_attributes

data/lib/search_object/version.rb

@@ -1,3 +1,3 @@
 module SearchObject
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

data/search_object.gemspec

@@ -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.46.0'
-  spec.add_development_dependency 'rubocop-rspec', '1.8.0'
+  spec.add_development_dependency 'rubocop', '0.51.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.20.1'
 end

data/spec/search_object/base_spec.rb

@@ -77,7 +77,7 @@ module SearchObject
       expect(inequality_search.new(filters: { value: 1 }).results).to eq [2, 3]
     end
 
-    context 'scope' do
+    describe 'scope' do
       def search_class
         define_search_class do
           option :name do
@@ -258,11 +258,11 @@ module SearchObject
 
     describe '#results?' do
       it 'returns true if there are results' do
-        expect(new_search([1, 2, 3], value: 1).results?).to be_truthy
+        expect(new_search([1, 2, 3], value: 1)).to be_results
       end
 
       it 'returns false if there are no results' do
-        expect(new_search([1, 2, 3], value: 4).results?).to be_falsey
+        expect(new_search([1, 2, 3], value: 4)).not_to be_results
       end
     end
 

data/spec/search_object/helper_spec.rb

@@ -18,12 +18,12 @@ module SearchObject
 
     describe '.slice_keys' do
       it 'selects only given keys' do
-        hash = described_class.slice_keys({ a: 1, b: 2, c: 3 }, [:a, :b])
+        hash = described_class.slice_keys({ a: 1, b: 2, c: 3 }, %i[a b])
         expect(hash).to eq a: 1, b: 2
       end
 
       it 'ignores not existing keys' do
-        hash = described_class.slice_keys({}, [:a, :b])
+        hash = described_class.slice_keys({}, %i[a b])
         expect(hash).to eq({})
       end
     end
@@ -43,15 +43,15 @@ module SearchObject
 
     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
+        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
+        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
+        expect(described_class.normalize_params(nil, { a: 1 }, %w[a])).to eq 'a' => 1
       end
 
       it 'handles missing filters' do

data/spec/search_object/plugin/enum_spec.rb

@@ -9,7 +9,7 @@ module SearchObject
 
         scope { [1, 2, 3, 4, 5] }
 
-        option :filter, enum: %w(odd even)
+        option :filter, enum: %w[odd even]
 
         private
 
@@ -45,7 +45,7 @@ module SearchObject
           Class.new do
             include SearchObject.module(:enum)
 
-            option(:filter, enum: %w(a b)) { |_scope, _value| nil }
+            option(:filter, enum: %w[a b]) { |_scope, _value| nil }
           end
         end.to raise_error Enum::BlockIgnoredError
       end
@@ -55,7 +55,7 @@ module SearchObject
           Class.new do
             include SearchObject.module(:enum)
 
-            option :filter, enum: %w(a b), with: :method_name
+            option :filter, enum: %w[a b], with: :method_name
           end
         end.to raise_error Enum::WithIgnoredError
       end
@@ -91,10 +91,10 @@ module SearchObject
             end
           end
 
-          scope = %w(name age location)
+          scope = %w[name age location]
 
-          expect(call(object: object, option: 'select', scope: scope, value: 'name')).to eq %w(name)
-          expect(call(object: object, option: 'select', scope: scope, value: 'age')).to eq %w(age)
+          expect(call(object: object, option: 'select', scope: scope, value: 'name')).to eq %w[name]
+          expect(call(object: object, option: 'select', scope: scope, value: 'age')).to eq %w[age]
         end
 
         it 'raises NoMethodError when object can not handle enum method' do

data/spec/search_object/plugin/kaminari_spec.rb

@@ -7,7 +7,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).to be_respond_to :total_pages
         end
       end
     end

data/spec/search_object/plugin/model_spec.rb

@@ -39,6 +39,10 @@ module SearchObject
         expect(value).to eq(expected_value), message
       end
 
+      def assert_respond_to(object, method, message = nil)
+        expect(object).to respond_to(method), message
+      end
+
       ActiveModel::Lint::Tests.public_instance_methods.map(&:to_s).grep(/^test/).each do |method|
         example(method.tr('_', ' ')) { send method }
       end

data/spec/search_object/plugin/sorting_spec.rb

@@ -39,10 +39,24 @@ module SearchObject
         end
 
         it 'defaults to first sort by option' do
+          search_class = Class.new do
+            include SearchObject.module(:sorting)
+
+            scope { Product.all }
+
+            sort_by :name, :price, :created_at, default: :price
+          end
+
+          5.times { |i| Product.create! price: i }
+
+          expect(search_class.new.results.map(&:price)).to eq [4, 3, 2, 1, 0]
+        end
+
+        it 'accepts default sorting' do
           5.times { |i| Product.create! name: "Name#{i}" }
 
           search = search_with_sort
-          expect(search.results.map(&:name)).to eq %w(Name4 Name3 Name2 Name1 Name0)
+          expect(search.results.map(&:name)).to eq %w[Name4 Name3 Name2 Name1 Name0]
         end
 
         it 'ignores invalid sort values' do
@@ -67,22 +81,22 @@ module SearchObject
         it 'matches the sort option' do
           search = search_with_sort 'price desc'
 
-          expect(search.sort?(:price)).to be_truthy
-          expect(search.sort?(:name)).to be_falsey
+          expect(search).to be_sort :price
+          expect(search).not_to be_sort :name
         end
 
         it 'matches string also' do
           search = search_with_sort 'price desc'
 
-          expect(search.sort?('price')).to be_truthy
-          expect(search.sort?('name')).to be_falsey
+          expect(search).to be_sort 'price'
+          expect(search).not_to be_sort 'name'
         end
 
         it 'matches exact strings' do
           search = search_with_sort 'price desc'
 
-          expect(search.sort?('price desc')).to be_truthy
-          expect(search.sort?('price asc')).to be_falsey
+          expect(search).to be_sort 'price desc'
+          expect(search).not_to be_sort 'price asc'
         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).to be_respond_to :total_entries
         end
       end
     end

data/spec/support/paging_shared_example.rb

@@ -37,7 +37,7 @@ shared_examples_for 'a paging plugin' do
       6.times { |i| Product.create name: "product_#{i}" }
       search = search_with_page 2, 2
 
-      expect(search.results.map(&:name)).to eq %w(product_2 product_3)
+      expect(search.results.map(&:name)).to eq %w[product_2 product_3]
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,28 +170,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.51.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.20.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.20.1
 description: Search object DSL
 email:
 - rstankov@gmail.com
@@ -294,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Provides DSL for creating search objects