ransack_wrap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6908a42e14d663ae9e5a54fbc96455d9943095ba
+  data.tar.gz: 57b0916cabb45e9355c7030e183c9aa032e38960
+SHA512:
+  metadata.gz: 20d1537599c512c796603f8a436dc7c3a4a099af2214dc565c84e059d39a950bbf6e9174f7f452ce68ff5a9b71da1c5ec89c587a4d8b6e7331c29955752f6779
+  data.tar.gz: 1696c0151a1345f5d85cff230e3a99204496246ef95a93001f6742a4c6a1a13833b43f3270a1fd0579c4b26e50866d094d9878d6e84fb785ea626526d6d6e89c

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 ransack_wrap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tõnis Simo
+
+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,29 @@
+# RansackWrap
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ransack_wrap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ransack_wrap
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/generators/rails/searcher_generator.rb

@@ -0,0 +1,19 @@
+module Rails
+  module Generators
+    class SearcherGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      check_class_collision suffix: "Searcher"
+      
+      def create_searcher_file
+        template 'searcher.rb', File.join('app/searchers', class_path, "#{file_name}_searcher.rb")
+      end
+      
+      # hook_for :test_framework
+      unless methods.include?(:module_namespacing)
+        def module_namespacing
+          yield if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/searcher.rb

@@ -0,0 +1,28 @@
+<%- module_namespacing do -%>
+class <%= class_name %>Searcher < RansackWrap::Search
+  class Scopes < RansackWrap::Scopes
+    # Custom searchable keys
+    # attribute :only_sale, type: ActiveAttr::Typecasting::Boolean
+    # attribute :opt_in
+    # attribute :cat_in
+    
+    # Custom searchable method for key :only_sale with scope
+    # def scope_only_sale(value)
+    #   @object.joins_discount
+    # end
+    
+    # Custom searchable method for key :opt_in with values for complex scope
+    # def scope_opt_in(values)
+    #   @object.with_options_intersect(values.values)
+    # end
+    
+    # Custom searchable method for key :cat_in with simple conditions
+    # def scope_cat_in(value)
+    #  @object.where(category_id: value)
+    # end
+  end
+  
+  # Delegation to searchers
+  # delegate :only_sale, :opt_in, :cat_in, to: :base
+end
+<% end -%>

data/lib/ransack_wrap.rb

@@ -0,0 +1,12 @@
+require "ransack_wrap/version"
+require "ransack_wrap/search"
+require "ransack_wrap/scopes"
+require 'ransack_wrap/adapters/active_record'
+require 'ransack_wrap/helpers'
+require 'ransack_wrap/railtie' if defined?(Rails)
+
+module RansackWrap
+  # Your code goes here...
+end
+
+ActionController::Base.helper RansackWrap::Helpers::FormHelper

data/lib/ransack_wrap/adapters/active_record.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+
+module RansackWrap
+  module Adapters
+    module ActiveRecord
+      module Base
+        def wrap_searcher_as(name, params = {})
+          send(:searcher_class_for, name).new(self, params)
+        end
+        
+        def wrap_searcher(params = {})
+          send :wrap_searcher_as, nil, params
+        end
+        
+        private        
+        def searcher_class_for(name)
+          name = name.to_s.camelize unless name.nil?
+          name ||= self.scoped.klass.name
+          name.concat("Searcher").constantize
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend RansackWrap::Adapters::ActiveRecord::Base

data/lib/ransack_wrap/helpers.rb

@@ -0,0 +1,2 @@
+require 'ransack/helpers/form_builder'
+require 'ransack_wrap/helpers/form_helper'

data/lib/ransack_wrap/helpers/form_helper.rb

@@ -0,0 +1,30 @@
+module RansackWrap
+  module Helpers
+    module FormHelper
+      def search_form_for(record, options = {}, &proc)
+        if record.is_a?(Ransack::Search) || record.is_a?(RansackWrap::Search)
+          search = record
+          options[:url] ||= polymorphic_path(search.klass)
+        elsif record.is_a?(Array) && (search = record.detect {|o| o.is_a?(Ransack::Search) || o.is_a?(RansackWrap::Search)})
+          options[:url] ||= polymorphic_path(record.map {|o| 
+            o.is_a?(Ransack::Search) || record.is_a?(RansackWrap::Search) ? o.klass : o
+          })
+        else
+          raise ArgumentError, "No Ransack::Search or RansackWrap::Search object was provided to search_form_for!"
+        end
+        options[:html] ||= {}
+        html_options = {
+          :class  => options[:class].present? ? "#{options[:class]}" : "#{search.klass.to_s.underscore}_search",
+          :id => options[:id].present? ? "#{options[:id]}" : "#{search.klass.to_s.underscore}_search",
+          :method => :get
+        }
+        options[:as] ||= 'q'
+        options[:html].reverse_merge!(html_options)
+        options[:builder] ||= Ransack::Helpers::FormBuilder
+        
+        form_for(record, options, &proc)
+      end
+      
+    end
+  end
+end

data/lib/ransack_wrap/railtie.rb

@@ -0,0 +1,19 @@
+require 'rails/railtie'
+
+module ActiveModel
+  class Railtie < Rails::Railtie
+    generators do |app|
+      app ||= Rails.application # Rails 3.0.x does not yield `app`
+      
+      Rails::Generators.configure! app.config.generators
+    end
+  end
+end
+
+module RansackWrap
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      app.config.paths.add 'app/searchers', eager_load: true
+    end
+  end
+end

data/lib/ransack_wrap/scopes.rb

@@ -0,0 +1,23 @@
+module RansackWrap
+  class Scopes
+    include ActiveAttr::TypecastedAttributes
+    attr_reader :object
+    
+    def initialize(object)
+      @object = object
+    end
+    
+    def scoped
+      object.scoped
+    end
+    
+    def attribute_method?(attr_name)
+      respond_to_without_attributes?(:attributes) && attr_name.in?(attributes)
+    end
+    
+    def try_scope(name, args)
+      return unless args.present?
+      self.try "scope_#{name}", args
+    end
+  end
+end

data/lib/ransack_wrap/search.rb

@@ -0,0 +1,63 @@
+module RansackWrap
+  class Search
+    include Ransack::Naming
+    
+    attr_reader :base
+    
+    def initialize(object, params = {})
+      @base = scope_class.new(object)
+      
+      params ||= {}
+      ransack_params = params.slice! *base.attributes.keys.map(&:to_sym)
+      ransack_params ||= {}
+      
+      build params.with_indifferent_access 
+      ransack.build ransack_params.with_indifferent_access
+    end
+    
+    def ransack
+      @ransack ||= build_for_ransack.ransack
+    end
+  
+    def result
+      ransack.result
+    end
+    
+    def build(params = {})
+      params.each {|key, value| base.send "#{key}=", value }
+    end
+    
+    def build_for_ransack
+      base.attributes
+        .collect             {|name, args|  base.try_scope name, args }.compact
+        .inject(base.scoped) {|scope, subq| scope.merge subq }
+    end
+  
+    def method_missing(method, *args)
+      name = method.to_s
+      writer = name.sub! /\=$/, ''
+      
+      if base.attribute_method? name
+        base.send method, *args
+      elsif ransack.respond_to? name
+        ransack.send method, *args
+      else
+        super
+      end
+    end
+  
+    def respond_to?(method, include_private = false)
+      super or begin
+        name = method.to_s
+        writer = name.sub!(/\=$/, '')
+        base.attribute_method?(name) || ransack.respond_to?(name) || false
+      end
+    end
+    
+    private
+    def scope_class
+      raise NameError unless self.class.const_defined?(:Scopes)
+      self.class.const_get(:Scopes)
+    end
+  end
+end

data/lib/ransack_wrap/version.rb

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

data/ransack_wrap.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ransack_wrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ransack_wrap"
+  spec.version       = RansackWrap::VERSION
+  spec.authors       = ["Tõnis Simo"]
+  spec.email         = ["anton.estum@gmail.com"]
+  spec.description   = %q{Model-wrappers to customize ransack search}
+  spec.summary       = %q{Ransack Wrap helps to customize Ransack searching for each models, it allows to easy overwrite and add search keys, scopes and queries}
+  spec.homepage      = "http://github.com/estum/ransack_wrap"
+  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_dependency 'ransack', '>= 1.0.0'
+  spec.add_dependency 'active_attr', '>= 0.8.2'
+  spec.add_dependency 'activerecord', '>= 3.0.2', "< 4.0"
+  spec.add_dependency 'actionpack',   '>= 3.0.2', "< 4.0"
+  spec.add_runtime_dependency "activemodel",   ">= 3.0.2", "< 4.0"
+  spec.add_runtime_dependency "activesupport", ">= 3.0.2", "< 4.0"
+  spec.add_dependency 'polyamorous', '~> 0.6.0'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: ransack_wrap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tõnis Simo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: polyamorous
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !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: Model-wrappers to customize ransack search
+email:
+- anton.estum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails/searcher_generator.rb
+- lib/generators/rails/templates/searcher.rb
+- lib/ransack_wrap.rb
+- lib/ransack_wrap/adapters/active_record.rb
+- lib/ransack_wrap/helpers.rb
+- lib/ransack_wrap/helpers/form_helper.rb
+- lib/ransack_wrap/railtie.rb
+- lib/ransack_wrap/scopes.rb
+- lib/ransack_wrap/search.rb
+- lib/ransack_wrap/version.rb
+- ransack_wrap.gemspec
+homepage: http://github.com/estum/ransack_wrap
+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.5
+signing_key: 
+specification_version: 4
+summary: Ransack Wrap helps to customize Ransack searching for each models, it allows
+  to easy overwrite and add search keys, scopes and queries
+test_files: []
+has_rdoc: