search_object 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dcf24c846042501f789fdc3da39a47b15b33874
-  data.tar.gz: 80448932ff7fc522f8a20890ba8ef7ecda8f4eb3
+  metadata.gz: 4cce323b42516f0df8bff1b13275f60dcf0439cf
+  data.tar.gz: 35c0d32d6011eae2946e2758ebcf4222b3392f32
 SHA512:
-  metadata.gz: 3d4139961ee6295d3abe3a987d0d224a2197b6040a30b1da252989654a1d3892c215022132ef0407a75c9d4a7c37a4cfd62447f9f345acc8702a72e5f5d7a5b9
-  data.tar.gz: decde34bdf851ff385715e646107091fd6c3ac4debf860268f513e1b1105c8aaa6a904ca6eee64794572f1a8956f295525276f545879f560588ebe4c0d81e8bc
+  metadata.gz: 6df95c9bff5882b28585bf3de86623d2015bdb633fabc8eac0b82e330ce11671ef09f581e7bc25a81e1157db828d0334e513a859bed0971dcfe36e1b906bbace
+  data.tar.gz: 9ef427a40467a42bfde8499f6066de5a98481c66d92c7830b021c992386adf0172bca7df56795ab11c442659103d2902fffcf858f00e8e0608463b47460443b7

data/.projections.json

@@ -0,0 +1,8 @@
+{
+  "lib/*.rb": {
+    "alternate": "spec/{}_spec.rb"
+  },
+  "spec/*_spec.rb": {
+    "alternate": "lib/{}.rb"
+  },
+}

data/CHANGELOG.md

@@ -1,6 +1,52 @@
 # Changelog
 
-## Version 1.1.3 (unreleased)
+## Version 1.2.0 (unreleased)
+
+* __[feature]__ `enum` plugin added (@rstankov)
+
+```ruby
+class ProductSearch
+  include SearchObject.module(:enum)
+
+  scope { Product.all }
+
+  option :order, enum: %w(popular date)
+
+  private
+
+  # Gets called when order with 'popular' is given
+  def apply_order_with_popular(scope)
+    scope.by_popularity
+  end
+
+  # Gets called when order with 'date' is given
+  def apply_order_with_date(scope)
+    scope.by_date
+  end
+
+  # Gets called when invalid enum is given
+  def handle_invalid_order(scope, invalid_value)
+    scope
+  end
+end
+```
+
+* __[feature]__ Scope is executed  in context of SearchObject::Base context (@rstankov)
+
+ ```ruby
+class ProductSearch
+  include SearchObject.module
+
+  scope { @shop.products }
+
+  def initialize(shop)
+    @shop = shop
+    super
+  end
+end
+```
+
+## Version 1.1.3
 
 * __[feature]__ Passing nil as `scope` in constructor, falls back to default scope (@rstankov)
 

data/README.md

@@ -104,9 +104,40 @@ include SearchObject.module(:will_paginate)
 include SearchObject.module(:kaminari)
 ```
 
+### Enum plugin
+
+Gives you filter with pre-defined options.
+
+```ruby
+class ProductSearch
+  include SearchObject.module(:enum)
+
+  scope { Product.all }
+
+  option :order, enum: %w(popular date)
+
+  private
+
+  # Gets called when order with 'popular' is given
+  def apply_order_with_popular(scope)
+    scope.by_popularity
+  end
+
+  # Gets called when order with 'date' is given
+  def apply_order_with_date(scope)
+    scope.by_date
+  end
+
+  # (optional) Gets called when invalid enum is given
+  def handle_invalid_order(scope, invalid_value)
+    scope
+  end
+end
+```
+
 ### Model plugin
 
-Extends your search object with ```ActiveModel```, so you can use it in rails forms.
+Extends your search object with ```ActiveModel```, so you can use it in Rails forms.
 
 ```ruby
 class ProductSearch

data/example/app/assets/stylesheets/application.css.scss

@@ -31,7 +31,9 @@ body { font-family: "Helvetica Neue", Helvetica, Arial, sans-serif !important; f
   fieldset { margin-bottom: 20px; padding: 10px; border: 1px solid #e7e7e7; border-radius: 4px; background-color: #f8f8f8; }
   fieldset input[type="submit"] { @extend .btn; @extend .btn-default; }
   fieldset input[type="search"],
+  fieldset select,
   fieldset input[type="date"] { vertical-align: middle; height: 34px; padding: 6px 12px; margin-right: 10px; }
+  fieldset select { width: 100px; }
 
   table thead label { color: #428bca; }
   table thead .active { font-weight: bold; color: black; }

data/example/app/models/post_search.rb

@@ -1,5 +1,5 @@
 class PostSearch
-  include SearchObject.module(:model, :sorting, :will_paginate)
+  include SearchObject.module(:model, :sorting, :will_paginate, :enum)
 
   scope { Post.all }
 
@@ -13,6 +13,10 @@ class PostSearch
   option :user_id
   option :category_name
 
+  option :term, with: :apply_term
+
+  option :rating, enum: %i(low high)
+
   option :title do |scope, value|
     scope.where 'title LIKE ?', escape_search_term(value)
   end
@@ -21,10 +25,6 @@ class PostSearch
     scope.where published: true if value.present?
   end
 
-  option :term do |scope, value|
-    scope.where 'title LIKE :term OR body LIKE :term', term: escape_search_term(value)
-  end
-
   option :created_after do |scope, value|
     date = parse_date value
     scope.where('DATE(created_at) >= ?', date) if date.present?
@@ -37,6 +37,18 @@ class PostSearch
 
   private
 
+  def apply_term(scope, value)
+    scope.where 'title LIKE :term OR body LIKE :term', term: escape_search_term(value)
+  end
+
+  def apply_rating_with_low(scope)
+    scope.where 'views_count < 100'
+  end
+
+  def apply_rating_with_high(scope)
+    scope.where 'views_count > 500'
+  end
+
   def parse_date(value)
     Date.parse(value).strftime('%Y-%m-%d')
   rescue

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

@@ -7,6 +7,7 @@
     = form.search_field :term, placeholder: 'Search term'
     = date_field_tag 'f[created_after]', @search.created_after
     = date_field_tag 'f[created_before]', @search.created_before
+    = select_tag 'f[rating]', options_for_select([['All', ''], ['Popular', 'high'], ['Unpopular', 'low']], @search.rating)
     = form.submit 'Search'
 
     div.pull-right

data/lib/search_object.rb

@@ -8,6 +8,7 @@ require 'search_object/plugin/paging'
 require 'search_object/plugin/will_paginate'
 require 'search_object/plugin/kaminari'
 require 'search_object/plugin/sorting'
+require 'search_object/plugin/enum'
 
 module SearchObject
   def self.module(*plugins)

data/lib/search_object/base.rb

@@ -12,7 +12,14 @@ module SearchObject
     end
 
     def initialize(options = {})
-      @search = Search.build_for self.class.config, 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)
     end
 
     def results

data/lib/search_object/helper.rb

@@ -21,6 +21,15 @@ module SearchObject
       text.to_s.gsub(/(?:^|_)(.)/) { Regexp.last_match[1].upcase }
     end
 
+    def underscore(text)
+      text.to_s
+          .tr('::', '_')
+          .gsub(/([A-Z]+)([A-Z][a-z])/) { "#{Regexp.last_match[1]}_#{Regexp.last_match[2]}" }
+          .gsub(/([a-z\d])([A-Z])/) { "#{Regexp.last_match[1]}_#{Regexp.last_match[2]}" }
+          .tr('-', '_')
+          .downcase
+    end
+
     def ensure_included(item, collection)
       if collection.include? item
         item
@@ -45,6 +54,10 @@ 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

@@ -0,0 +1,70 @@
+module SearchObject
+  module Plugin
+    module Enum
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        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])
+
+          super(name, options, &handler)
+        end
+      end
+
+      module Handler
+        module_function
+
+        def build(name, enums)
+          enums = enums.map(&:to_s)
+          handler = self
+          ->(scope, value) { handler.apply_filter(object: self, option: name, enums: enums, scope: scope, value: value) }
+        end
+
+        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
+
+          object.send("apply_#{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
+
+          raise InvalidEnumValueError.new(option, enums, value)
+        end
+      end
+
+      class InvalidEnumValueError < ArgumentError
+        def initialize(option, enums, value)
+          super "Wrong value '#{value}' used for enum #{option} (expected one of #{enums.join(', ')})"
+        end
+      end
+
+      class BlockIgnoredError < ArgumentError
+        def initialize(message = "Enum options don't accept blocks")
+          super message
+        end
+      end
+
+      class WithIgnoredError < ArgumentError
+        def initialize(message = "Enum options don't accept :with")
+          super message
+        end
+      end
+    end
+  end
+end

data/lib/search_object/search.rb

@@ -1,19 +1,8 @@
 module SearchObject
+  # :api: private
   class Search
     attr_reader :params
 
-    class << self
-      def build_for(config, options)
-        scope   = options[:scope] || (config[:scope] && config[:scope].call)
-        filters = Helper.stringify_keys(options.fetch(:filters, {}))
-        params  = config[:defaults].merge Helper.slice_keys(filters, config[:actions].keys)
-
-        raise MissingScopeError unless scope
-
-        new scope, params, config[:actions]
-      end
-    end
-
     def initialize(scope, params, actions)
       @scope    = scope
       @actions  = actions

data/lib/search_object/version.rb

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

data/search_object.gemspec

@@ -28,6 +28,7 @@ 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 'kaminari-activerecord'
   spec.add_development_dependency 'rubocop', '0.46.0'
   spec.add_development_dependency 'rubocop-rspec', '1.8.0'
 end

data/spec/search_object/base_spec.rb

@@ -101,6 +101,21 @@ module SearchObject
         expect(search_class.new(scope: 'other scope').results).to eq 'other scope'
       end
 
+      it 'scope block is exectued in context of search object' do
+        search_class = define_search_class do
+          scope { inner_scope }
+
+          attr_reader :inner_scope
+
+          def initialize
+            @inner_scope = 'scope'
+            super
+          end
+        end
+
+        expect(search_class.new.results).to eq 'scope'
+      end
+
       it 'passing nil as scope in constructor, falls back to default scope' do
         search_class = define_search_class do
           scope { 'scope' }

data/spec/search_object/helper_spec.rb

@@ -5,32 +5,57 @@ module SearchObject
   describe Helper do
     describe '.stringify_keys' do
       it 'converts hash keys to strings' do
-        hash = Helper.stringify_keys a: 1, b: nil, c: false
+        hash = described_class.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
+        hash = described_class.stringify_keys params
         expect(hash).to eq 'a' => 1, 'b' => nil, 'c' => false
       end
     end
 
     describe '.slice_keys' do
       it 'selects only given keys' do
-        hash = Helper.slice_keys({ a: 1, b: 2, c: 3 }, [:a, :b])
+        hash = described_class.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.slice_keys({}, [:a, :b])
+        hash = described_class.slice_keys({}, [:a, :b])
         expect(hash).to eq({})
       end
     end
 
     describe 'camelize' do
       it "transforms :paging to 'Paging'" do
-        expect(Helper.camelize(:paging)).to eq 'Paging'
+        expect(described_class.camelize(:paging)).to eq 'Paging'
+      end
+    end
+
+    describe 'underscore' do
+      it "transforms 'veryPopular' to 'very_popular'" do
+        expect(described_class.underscore(:veryPopular)).to eq 'very_popular'
+        expect(described_class.underscore('VERY_POPULAR')).to eq 'very_popular'
+      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
 
@@ -44,7 +69,7 @@ module SearchObject
           null: nil
         }
 
-        deep_copy = Helper.deep_copy(original)
+        deep_copy = described_class.deep_copy(original)
 
         original[:array][0] = 42
         original[:hash][:key] = 'other value'

data/spec/search_object/plugin/enum_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'ostruct'
+
+module SearchObject
+  module Plugin
+    describe Enum do
+      class TestSearch
+        include SearchObject.module(:enum)
+
+        scope { [1, 2, 3, 4, 5] }
+
+        option :filter, enum: %w(odd even)
+
+        private
+
+        def apply_filter_with_odd(scope)
+          scope.select(&:odd?)
+        end
+
+        def apply_filter_with_even(scope)
+          scope.select(&:even?)
+        end
+
+        def handle_invalid_filter(_scope, value)
+          "invalid filter - #{value}"
+        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]
+      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]
+      end
+
+      it 'handles wrong enum values' do
+        expect(TestSearch.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)
+
+            option(:filter, enum: %w(a b)) { |_scope, _value| nil }
+          end
+        end.to raise_error Enum::BlockIgnoredError
+      end
+
+      it 'raises when :with is passed with enum option' do
+        expect do
+          Class.new do
+            include SearchObject.module(:enum)
+
+            option :filter, enum: %w(a b), with: :method_name
+          end
+        end.to raise_error Enum::WithIgnoredError
+      end
+    end
+
+    describe Enum::Handler do
+      describe 'apply_filter' do
+        def new_object(&block)
+          klass = Class.new(&block)
+          klass.new
+        end
+
+        def call(object: nil, option: nil, enums: nil, scope: nil, value:)
+          described_class.apply_filter(
+            object: object || new_object,
+            option: option || 'option',
+            enums: enums || [value],
+            scope: scope || [],
+            value: value
+          )
+        end
+
+        it 'filters by methods based on the enum value' do
+          object = new_object do
+            private
+
+            def apply_select_with_name(scope)
+              scope.select { |value| value == 'name' }
+            end
+
+            def apply_select_with_age(scope)
+              scope.select { |value| value == 'age' }
+            end
+          end
+
+          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)
+        end
+
+        it 'raises NoMethodError when object can not handle enum method' do
+          expect { call(enums: ['a'], value: 'a') }.to raise_error NoMethodError
+        end
+
+        it 'raises error when value is not an enum' do
+          expect { call(enums: [], value: 'invalid') }.to raise_error Enum::InvalidEnumValueError
+        end
+
+        it 'can delegate missing enum value to object' do
+          object = new_object do
+            def handle_invalid_option(_scope, value)
+              "handles #{value} value"
+            end
+          end
+
+          expect(call(object: object, enums: [], value: 'invalid')).to eq 'handles invalid value'
+        end
+
+        it 'can delegate missing enum value to object (cath all)' do
+          object = new_object do
+            def handle_invalid_enum(option, _scope, value)
+              "handles #{value} value for #{option}"
+            end
+          end
+
+          expect(call(object: object, enums: [], value: 'invalid')).to eq 'handles invalid value for option'
+        end
+      end
+    end
+  end
+end

data/spec/search_object/plugin/kaminari_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper_active_record'
-
-require_relative '../../support/kaminari_setup'
+require 'kaminari'
 
 module SearchObject
   module Plugin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-08 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari-activerecord
+  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
@@ -186,6 +200,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".projections.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -238,6 +253,7 @@ files:
 - lib/search_object/base.rb
 - lib/search_object/errors.rb
 - lib/search_object/helper.rb
+- lib/search_object/plugin/enum.rb
 - lib/search_object/plugin/kaminari.rb
 - lib/search_object/plugin/model.rb
 - lib/search_object/plugin/paging.rb
@@ -248,6 +264,7 @@ files:
 - search_object.gemspec
 - spec/search_object/base_spec.rb
 - spec/search_object/helper_spec.rb
+- spec/search_object/plugin/enum_spec.rb
 - spec/search_object/plugin/kaminari_spec.rb
 - spec/search_object/plugin/model_spec.rb
 - spec/search_object/plugin/paging_spec.rb
@@ -256,7 +273,6 @@ files:
 - spec/search_object/search_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_active_record.rb
-- spec/support/kaminari_setup.rb
 - spec/support/paging_shared_example.rb
 homepage: https://github.com/RStankov/SearchObject
 licenses:
@@ -285,6 +301,7 @@ summary: Provides DSL for creating search objects
 test_files:
 - spec/search_object/base_spec.rb
 - spec/search_object/helper_spec.rb
+- spec/search_object/plugin/enum_spec.rb
 - spec/search_object/plugin/kaminari_spec.rb
 - spec/search_object/plugin/model_spec.rb
 - spec/search_object/plugin/paging_spec.rb
@@ -293,5 +310,4 @@ test_files:
 - spec/search_object/search_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_active_record.rb
-- spec/support/kaminari_setup.rb
 - spec/support/paging_shared_example.rb

data/spec/support/kaminari_setup.rb

@@ -1,6 +0,0 @@
-module Grape
-end
-require 'kaminari'
-Kaminari::Hooks.init
-require 'kaminari/models/active_record_extension'
-::ActiveRecord::Base.send :include, Kaminari::ActiveRecordExtension