seeker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e54247641dde163562c6f30672589e81ec77e60
+  data.tar.gz: ff0b0de84416467abeb06ff8319448cee81a2528
+SHA512:
+  metadata.gz: ec497af4007218b339a5f787299a0c652e3c5c830dd6b0907b5e1ad11168db5ff094ac5e9551795658784799c022876f83c47c74fe38f152bdac86e0ea6abdf1
+  data.tar.gz: 994fc23535869b905d5736ef16e94a2eeee670234ece7215be98d8b3b71fa9e3cca479463b4c34b9e9a53fde63c41f308512051cdc7c7fe5bab0c8d566dcac95

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seeker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Szymon Przybył
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Szymon Przybył
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Seeker
+
+This Ruby on Rails gem provides an elegant way to separate search logic out of models.
+
+Right now it supports only [sunspot](https://github.com/sunspot/sunspot).
+
+## Installation
+
+    gem 'seeker'
+
+## Usage
+
+Given you have Product model:
+
+    class Product < ActiveRecord::Base
+    end
+
+Create corresponding searcher:
+
+    # app/searchers/product_searcher.rb
+    class ProductSearcher < Seeker::Base
+      attr_accessor :name, :max_price
+
+      searchable do
+        text :name
+        integer :price
+      end
+
+      def search(query)
+        query.fulltext(:name, @name) if @name.present?
+        query.with(:price).less_than_or_equal_to(@max_price) if @max_price.present?
+      end
+    end
+
+Use it in your controller:
+
+    class ProductsController < ApplicationController
+      def index
+        @searcher = ProductSearcher.new params[:product]
+      end
+    end
+
+And use it in your view with form helper, just like model:
+
+    # app/views/products/index.html.slim
+    = form_for @searcher do |f|
+      = f.label :name
+      = f.text_field :name
+
+      = f.label :max_price
+      = f.number_field :max_price
+
+      = f.submit
+
+    h1 Search results
+    ul
+      = @searcher.results.each do |product|
+        li #{product.name} - #{product.price}
+
+
+## TODO
+
+* add tests
+* add support for ThinkingSphinx

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/seeker.rb

@@ -0,0 +1,6 @@
+require 'seeker/version'
+require 'seeker/railtie'
+require 'seeker/base'
+
+module Seeker
+end

data/lib/seeker/base.rb

@@ -0,0 +1,43 @@
+class Seeker::Base
+  def initialize(params={})
+    params.each do |attr, value|
+      self.public_send("#{attr}=", value)
+    end if params
+
+    super()
+  end
+
+  def self.model_name
+    @_model_name ||= begin
+      model = eval self.name.sub(/Searcher$/, '')
+      ActiveModel::Name.new(model)
+    end
+  end
+
+  def self.model
+    model_name.constantize
+  end
+
+  def self.searchable(&block)
+    self.model.searchable &block
+  end
+
+  # Searcher needs to implement it
+  def search(query, options = {}); end
+
+  def options
+    {}
+  end
+
+  def results
+    self.class.model.search(options, &method(:search)).results
+  end
+
+  def to_key
+    nil
+  end
+
+  def searcher?
+    true
+  end
+end

data/lib/seeker/form_helper.rb

@@ -0,0 +1,22 @@
+module Seeker::FormHelper
+  def apply_form_for_options!(object_or_array, options) #:nodoc:
+    object = object_or_array.is_a?(Array) ? object_or_array.last : object_or_array
+    object = convert_to_model(object)
+
+    as = options[:as]
+    # added searcher
+    action, method = if object.respond_to?(:searcher?)
+                       [:search, :get]
+                     else
+                       object.respond_to?(:persisted?) && object.persisted? ? [:edit, :put] : [:new, :post]
+                     end
+
+    options[:html].reverse_merge!(
+      :class  => as ? "#{action}_#{as}" : dom_class(object, action),
+      :id     => as ? "#{action}_#{as}" : [options[:namespace], dom_id(object, action)].compact.join("_").presence,
+      :method => method
+    )
+
+    options[:url] ||= polymorphic_path(object_or_array, :format => options.delete(:format))
+  end
+end

data/lib/seeker/railtie.rb

@@ -0,0 +1,10 @@
+require 'seeker/form_helper'
+require 'seeker/route_helper'
+
+module Seeker
+  class Railtie < Rails::Railtie
+    initializer 'seeker.form_helper' do
+      ActionView::Base.send :include, FormHelper
+    end
+  end
+end

data/lib/seeker/route_helper.rb

@@ -0,0 +1,44 @@
+module ActionDispatch::Routing::PolymorphicRoutes
+  def polymorphic_url(record_or_hash_or_array, options = {})
+    if record_or_hash_or_array.kind_of?(Array)
+      record_or_hash_or_array = record_or_hash_or_array.compact
+      if record_or_hash_or_array.first.is_a?(ActionDispatch::Routing::RoutesProxy)
+        proxy = record_or_hash_or_array.shift
+      end
+      record_or_hash_or_array = record_or_hash_or_array[0] if record_or_hash_or_array.size == 1
+    end
+
+    record = extract_record(record_or_hash_or_array)
+    record = convert_to_model(record)
+
+    args = Array === record_or_hash_or_array ?
+      record_or_hash_or_array.dup :
+      [ record_or_hash_or_array ]
+
+    inflection = if options[:action] && options[:action].to_s == "new"
+                   args.pop
+                   :singular
+                   # added searcher
+                 elsif (record.respond_to?(:persisted?) && !record.persisted? || record.respond_to?(:searcher?))
+                   args.pop
+                   :plural
+                 elsif record.is_a?(Class)
+                   args.pop
+                   :plural
+                 else
+                   :singular
+                 end
+
+    args.delete_if {|arg| arg.is_a?(Symbol) || arg.is_a?(String)}
+    named_route = build_named_route_call(record_or_hash_or_array, inflection, options)
+
+    url_options = options.except(:action, :routing_type)
+    unless url_options.empty?
+      args.last.kind_of?(Hash) ? args.last.merge!(url_options) : args << url_options
+    end
+
+    args.collect! { |a| convert_to_model(a) }
+
+    (proxy || self).send(named_route, *args)
+  end
+end

data/lib/seeker/version.rb

@@ -0,0 +1,3 @@
+module Seeker
+  VERSION = "0.0.1"
+end

data/seeker.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seeker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seeker"
+  spec.version       = Seeker::VERSION
+  spec.authors       = ["Szymon Przybył"]
+  spec.email         = ["szymon@estender.net"]
+  spec.description   = %q{This Ruby on Rails gem provides an elegant way to separate search logic out of models.}
+  spec.summary       = %q{It separates search indecies setup and search rules to searchers. They also may be used in form helpers just like models.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: seeker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Szymon Przybył
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: This Ruby on Rails gem provides an elegant way to separate search logic
+  out of models.
+email:
+- szymon@estender.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/seeker.rb
+- lib/seeker/base.rb
+- lib/seeker/form_helper.rb
+- lib/seeker/railtie.rb
+- lib/seeker/route_helper.rb
+- lib/seeker/version.rb
+- seeker.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: It separates search indecies setup and search rules to searchers. They also
+  may be used in form helpers just like models.
+test_files: []