search_object 1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4102172d9cbe97e6fe2e066614a3136ac194a481
-  data.tar.gz: a01b6a7ebfa07a71a310ff32711147f378aaa337
+  metadata.gz: 24b14c3e7ec2492dc899f0a81a022089073be982
+  data.tar.gz: 8bee82cac11549acebcc9d35cc9cbb2aac25f456
 SHA512:
-  metadata.gz: 28e608b9331e641f3d421293b7161697da27567d8f852453b629ddd476c6a1bb2da382677c46e579beaea92d9aca96b1ee3802cad1b81231b54ae041f4481aca
-  data.tar.gz: 13d7e9ac89f8d9085cadf97a60ed102425a9ed877f5ecf2819c324b4003634d45584d068e52e161fafe61b5d48454452fc3fcc7926fd1a1d9ddd4a18a2c1a27b
+  metadata.gz: ba172f5b05a65e43bbbb3c3ab28e4b62c397757a6e9e1cb2bbe9e1b78a1fd94bba980d7d86ed1c286471adefe2bc99bacbb82c37f085f541ce2f407ecb2aa410
+  data.tar.gz: e5dc94ed98f6f947dc7a2f44b854ebc1a4bfe98000d00d6451200855860ce0ccc51a4b844e6d09638137038f3f3786c12d6a46a0d8d29bc80ef01558ed2ebb1d

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require: rubocop-rspec
+
+AllCops:
+  RunRailsCops: true
+  Exclude:
+    - example/db/**/*
+    - example/config/**/*
+    - search_object.gemspec
+
+# Disables "Line is too long"
+LineLength:
+  Enabled: false
+
+# Disables "Missing top-level class documentation comment"
+Documentation:
+  Enabled: false
+
+# Disables "Use each_with_object instead of inject"
+Style/EachWithObject:
+  Enabled: false
+
+# Disables "Prefer reduce over inject."
+Style/CollectionMethods:
+  Enabled: false

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0
   - 2.1
-script: bundle exec rspec spec
+  - 2.2
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## Version 1.1
+
+* Search objects now can be inherited
+
+ ```ruby
+ class BaseSearch
+   include SearchObject.module
+
+   # ... options and configuration
+ end
+
+ class ProductSearch < BaseSearch
+   scope { Product }
+ end
+ ```
+
+* Using instance method for straight dispatch
+
+  ```ruby
+  class ProductSearch
+    include SearchObject.module
+
+    scope { Product.all }
+
+    option :name
+    option :category_name
+
+    attr_reader :page
+
+    def initialize(filters = {}, page = 0)
+      super filters
+      @page = page.to_i.abc
+    end
+
+    def fetch_results
+      super.paginate page: @page
+    end
+  end
+  ```
+
 ## Version 1.0
 
 * Added min_per_page and max_per_page to paging plugin

data/README.md

@@ -232,6 +232,24 @@ class ProductSearch
 end
 ```
 
+### Using instance method for straight dispatch
+
+```ruby
+class ProductSearch
+  include SearchObject.module
+
+  scope { Product.all }
+
+  option :date, with: :parse_dates
+
+  private
+
+  def parse_dates(scope, value)
+    # some "magic" method to parse dates
+  end
+end
+```
+
 ### Active Record is not required at all
 
 ```ruby
@@ -286,6 +304,26 @@ class ProductSearch
 end
 ```
 
+### Extracting basic module
+
+You can extarct a basic search class for your application.
+
+```ruby
+ class BaseSearch
+   include SearchObject.module
+
+   # ... options and configuration
+ end
+ ```
+
+ Then use it like:
+
+ ```ruby
+ class ProductSearch < BaseSearch
+   scope { Product }
+ end
+```
+
 ## Contributing
 
 1. Fork it

data/example/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'rails', '4.0.0'
+gem 'rails', '4.2.0'
 gem 'sqlite3'
-gem 'sass-rails', '~> 4.0.0'
+gem 'sass-rails', '~> 5.0.0'
 gem 'slim'
 gem 'jquery-rails'
 gem 'bootstrap-sass'

data/example/app/views/layouts/application.html.slim

@@ -4,6 +4,7 @@ html
     title SearchObject example
 
     = stylesheet_link_tag 'application', media: 'all'
+    = favicon_link_tag 'favicon.png'
     = csrf_meta_tags
 
   body

data/example/config/environments/test.rb

@@ -13,7 +13,7 @@ Example::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files  = true
   config.static_cache_control = "public, max-age=3600"
 
   # Show full error reports and disable caching.

data/example/spec/models/post_search_spec.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Lint/UselessAssignment:%s
+
 require 'spec_helper'
 
 describe PostSearch do
@@ -13,7 +15,7 @@ describe PostSearch do
       title:          'Title',
       body:           'Body',
       category_name:  'Tech',
-      published:      true,
+      published:      true
     )
   end
 
@@ -21,35 +23,35 @@ describe PostSearch do
     expect(PostSearch.new(filters: options, page: 0).results)
   end
 
-  it "can search by category name" do
+  it 'can search by category name' do
     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
+  it 'can search by user_id' do
     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
+  it 'can search by title' do
     post  = create title: 'Title'
     other = create title: 'Other'
 
     expect_search(title: 'itl').to eq [post]
   end
 
-  it "can search by published" do
+  it 'can search by published' do
     post  = create published: true
     other = create published: false
 
     expect_search(published: true).to eq [post]
   end
 
-  it "can search by term" do
+  it 'can search by term' do
     post_with_body  = create body: 'pattern'
     post_with_title = create title: 'pattern'
     other           = create
@@ -57,21 +59,21 @@ describe PostSearch do
     expect_search(term: 'pattern').to eq [post_with_title, post_with_body]
   end
 
-  it "can search by created after" do
+  it 'can search by created after' do
     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
+  it 'can search by created before' do
     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
 
-  it "can sort by views count" do
+  it 'can sort by views count' do
     post_3 = create views_count: 3
     post_2 = create views_count: 2
     post_1 = create views_count: 1

data/example/spec/spec_helper.rb

@@ -1,9 +1,8 @@
 # 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', __FILE__)
 require 'rspec/rails'
-require 'rspec/autorun'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/lib/search_object/base.rb

@@ -3,14 +3,16 @@ module SearchObject
     def self.included(base)
       base.extend ClassMethods
       base.instance_eval do
-        @defaults = {}
-        @actions  = {}
-        @scope    = nil
+        @config = {
+          defaults:  {},
+          actions:   {},
+          scope:     nil
+        }
       end
     end
 
     def initialize(options = {})
-      @search = self.class.build_internal_search options
+      @search = Search.build_for self.class.config, options
     end
 
     def results
@@ -40,23 +42,29 @@ module SearchObject
     end
 
     module ClassMethods
-      # :api: private
-      def build_internal_search(options)
-        scope  = options.fetch(:scope) { @scope && @scope.call } or raise MissingScopeError
-        params = @defaults.merge Helper.select_keys(Helper.stringify_keys(options.fetch(:filters, {})), @actions.keys)
+      attr_reader :config
 
-        Search.new scope, params, @actions
+      def inherited(base)
+        new_config = config.dup
+
+        base.instance_eval do
+          @config = new_config
+        end
       end
 
       def scope(&block)
-        @scope = block
+        config[:scope] = block
       end
 
-      def option(name, default = nil, &block)
-        name = name.to_s
+      def option(name, options = nil, &block)
+        options = { default: options } unless options.is_a?(Hash)
+
+        name    = name.to_s
+        default = options[:default]
+        handler = options[:with] || block
 
-        @defaults[name] = default unless default.nil?
-        @actions[name]  = block || ->(scope, value) { scope.where name => value unless value.blank? }
+        config[:defaults][name] = default unless default.nil?
+        config[:actions][name]  = Helper.normalize_search_handler(handler, name)
 
         define_method(name) { @search.param name }
       end

data/lib/search_object/helper.rb

@@ -2,18 +2,18 @@ module SearchObject
   module Helper
     class << self
       def stringify_keys(hash)
-        Hash[(hash || {}).map { |k, v| [k.to_s, v]}]
+        Hash[(hash || {}).map { |k, v| [k.to_s, v] }]
       end
 
       def select_keys(hash, keys)
         keys.inject({}) do |memo, key|
-          memo[key] = hash[key] if hash.has_key? key
+          memo[key] = hash[key] if hash.key? key
           memo
         end
       end
 
       def camelize(text)
-        text.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+        text.to_s.gsub(/(?:^|_)(.)/) { Regexp.last_match[1].upcase }
       end
 
       def ensure_included(item, collection)
@@ -27,10 +27,18 @@ module SearchObject
       def define_module(&block)
         Module.new do
           define_singleton_method :included do |base|
-            base.class_eval &block
+            base.class_eval(&block)
           end
         end
       end
+
+      def normalize_search_handler(handler, name)
+        case handler
+        when Symbol then ->(scope, value) { method(handler).call scope, value }
+        when Proc then handler
+        else ->(scope, value) { scope.where name => value unless value.blank? }
+        end
+      end
     end
   end
 end

data/lib/search_object/plugin/kaminari.rb

@@ -15,4 +15,3 @@ module SearchObject
     end
   end
 end
-

data/lib/search_object/plugin/paging.rb

@@ -21,30 +21,30 @@ module SearchObject
       end
 
       def apply_paging(scope)
-        scope.limit(per_page).offset ([page, 1].max - 1) * per_page
+        scope.limit(per_page).offset(([page, 1].max - 1) * per_page)
       end
 
       module ClassMethods
         def per_page(number)
-          raise InvalidNumberError.new('Per page', number) unless number > 0
-          @per_page = number
+          fail InvalidNumberError.new('Per page', number) unless number > 0
+          config[:per_page] = number
         end
 
         def min_per_page(number)
-          raise InvalidNumberError.new('Min per page', number) unless number > 0
-          @min_per_page = number
+          fail InvalidNumberError.new('Min per page', number) unless number > 0
+          config[:min_per_page] = number
         end
 
         def max_per_page(number)
-          raise InvalidNumberError.new('Max per page', number) unless number > 0
-          @max_per_page = number
+          fail InvalidNumberError.new('Max per page', number) unless number > 0
+          config[:max_per_page] = number
         end
 
         # :api: private
         def calculate_per_page(given)
-          per_page = (given || @per_page || 25).to_i.abs
-          per_page = [per_page, @max_per_page].min if @max_per_page
-          per_page = [per_page, @min_per_page].max if @min_per_page
+          per_page = (given || config[:per_page] || 25).to_i.abs
+          per_page = [per_page, config[:max_per_page]].min if config[:max_per_page]
+          per_page = [per_page, config[:min_per_page]].max if config[:min_per_page]
           per_page
         end
       end

data/lib/search_object/plugin/sorting.rb

@@ -4,7 +4,7 @@ module SearchObject
       def self.included(base)
         base.extend ClassMethods
         base.instance_eval do
-          option :sort do |scope, value|
+          option :sort do |scope, _|
             scope.order "#{sort_attribute} #{sort_direction}"
           end
         end
@@ -41,12 +41,12 @@ module SearchObject
 
       module ClassMethods
         def sort_by(*attributes)
-          @sort_attributes = attributes.map(&:to_s)
-          @defaults['sort'] = "#{@sort_attributes.first} desc"
+          config[:sort_attributes]  = attributes.map(&:to_s)
+          config[:defaults]['sort'] = "#{config[:sort_attributes].first} desc"
         end
 
         def sort_attributes
-          @sort_attributes ||= []
+          config[:sort_attributes] ||= []
         end
       end
     end

data/lib/search_object/search.rb

@@ -2,6 +2,18 @@ module SearchObject
   class Search
     attr_reader :params
 
+    class << self
+      def build_for(config, options)
+        scope   = options.fetch(:scope) { config[:scope] && config[:scope].call }
+        filters = Helper.stringify_keys(options.fetch(:filters, {}))
+        params  = config[:defaults].merge Helper.select_keys(filters, config[:actions].keys)
+
+        fail 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.0'
+  VERSION = '1.1.0'
 end

data/search_object.gemspec

@@ -27,4 +27,6 @@ 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 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
 end