ransack 0.7.0 → 0.7.1

data/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+Ransack is an open source project and we encourage contributions.
+
+## Filing an issue
+
+When filing an issue on the Ransack project, please provide these details:
+
+* A comprehensive list of steps to reproduce the issue.
+* The version of Ransack *and* the version of Rails.
+* Any relevant stack traces ("Full trace" preferred)
+
+In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.
+
+Any issue that is open for 14 days without actionable information or activity will be marked as "stalled" and then closed. Stalled issues can be re-opened if the information requested is provided.
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new features to Ransack.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate:
+
+        $ bundle install
+        $ bundle exec rake test_app
+        $ bundle exec rake
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or my_method my_arg.
+* `a = b` and not `a=b`.
+* `a_method { |block| ... }` and not `a_method { | block | ... }`
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/README.md

@@ -34,7 +34,7 @@ If you're coming from MetaSearch, things to note:
 
   1. The default param key for search params is now `:q`, instead of `:search`. This is
      primarily to shorten query strings, though advanced queries (below) will still
-     run afoul of URL length limits in most browsers and require a switch to HTTP 
+     run afoul of URL length limits in most browsers and require a switch to HTTP
      POST requests. This key is
 [configurable](https://github.com/ernie/ransack/wiki/Configuration)
   2. `form_for` is now `search_form_for`, and validates that a Ransack::Search object
@@ -69,7 +69,7 @@ In your view:
     <% end %>
 
 `cont` (contains) and `start` (starts with) are just two of the available search predicates.
-See Constants for a full list.
+See [Constants](https://github.com/ernie/ransack/blob/master/lib/ransack/constants.rb) for a full list and the [wiki](https://github.com/ernie/ransack/wiki/Basic-Searching) for more description.
 
 ### Advanced Mode
 
@@ -103,6 +103,56 @@ Once you've done so, you can make use of the helpers in Ransack::Helpers::FormBu
 construct much more complex search forms, such as the one on the
 [demo page](http://ransack-demo.heroku.com).
 
+### has_many and belongs_to associations
+
+You can easily use Ransack to search in associated objects.
+
+Given you have these associations ...
+
+    class Employee < ActiveRecord::Base
+      belongs_to :supervisor
+
+      # has attribute last_name:string
+    end
+
+    class Department < ActiveRecord::Base
+      has_many :supervisors
+
+      # has attribute title:string
+    end
+
+    class Supervisor < ActiveRecord::Base
+      belongs_to :department
+      has_many :employees
+
+      # has attribute last_name:string
+    end
+
+... and a controller ...
+
+    class SupervisorsController < ApplicationController
+      def index
+        @search = Supervisor.search(params[:q])
+        @supervisors = @search.result(:distinct => true)
+      end
+    end
+
+... you might set up your form like this ...
+
+    <%= search_form_for @search do |f| %>
+      <%= f.label :last_name_cont %>
+      <%= f.text_field :last_name_cont %>
+
+      <%= f.label :department_title_cont %>
+      <%= f.text_field :department_title_cont %>
+
+      <%= f.label :employees_last_name_cont %>
+      <%= f.text_field :employees_last_name_cont %>
+
+      <%= f.submit "search" %>
+    <% end %>
+
+
 ## Contributions
 
 To support the project:

data/lib/ransack/adapters/active_record/compat.rb

@@ -0,0 +1,14 @@
+module Arel
+
+  module Visitors
+
+    class DepthFirst < Visitor
+
+      unless method_defined?(:visit_Arel_Nodes_InfixOperation)
+        alias :visit_Arel_Nodes_InfixOperation :binary
+      end
+
+    end
+
+  end
+end

data/lib/ransack/adapters/active_record/context.rb

@@ -1,31 +1,30 @@
 require 'ransack/context'
 require 'ransack/adapters/active_record/3.1/context'
+require 'ransack/adapters/active_record/compat'
 require 'polyamorous'
 
 module Ransack
   module Adapters
     module ActiveRecord
       class Context < ::Ransack::Context
-        
+
         # Redefine a few things that have changed with 3.2.
-        
+
         def initialize(object, options = {})
           super
           @arel_visitor = @engine.connection.visitor
         end
-        
+
         def type_for(attr)
           return nil unless attr && attr.valid?
           name    = attr.arel_attribute.name.to_s
           table   = attr.arel_attribute.relation.table_name
 
-          unless @engine.connection.table_exists?(table)
-            raise "No table named #{table} exists"
-          end
-
-          @engine.connection.schema_cache.columns_hash[table][name].type
+          schema_cache = @engine.connection.schema_cache    
+          raise "No table named #{table} exists" unless schema_cache.table_exists?(table)  
+          schema_cache.columns_hash[table][name].type
         end
-        
+
         def evaluate(search, opts = {})
           viz = Visitor.new
           relation = @object.where(viz.accept(search.base))
@@ -34,7 +33,7 @@ module Ransack
           end
           opts[:distinct] ? relation.uniq : relation
         end
-        
+
       end
     end
   end

data/lib/ransack/constants.rb

@@ -6,12 +6,12 @@ module Ransack
     AREL_PREDICATES = %w(eq not_eq matches does_not_match lt lteq gt gteq in not_in)
 
     DERIVED_PREDICATES = [
-      ['cont', {:arel_predicate => 'matches', :formatter => proc {|v| "%#{v}%"}}],
-      ['not_cont', {:arel_predicate => 'does_not_match', :formatter => proc {|v| "%#{v}%"}}],
-      ['start', {:arel_predicate => 'matches', :formatter => proc {|v| "#{v}%"}}],
-      ['not_start', {:arel_predicate => 'does_not_match', :formatter => proc {|v| "#{v}%"}}],
-      ['end', {:arel_predicate => 'matches', :formatter => proc {|v| "%#{v}"}}],
-      ['not_end', {:arel_predicate => 'does_not_match', :formatter => proc {|v| "%#{v}"}}],
+      ['cont', {:arel_predicate => 'matches', :formatter => proc {|v| "%#{escape_wildcards(v)}%"}}],
+      ['not_cont', {:arel_predicate => 'does_not_match', :formatter => proc {|v| "%#{escape_wildcards(v)}%"}}],
+      ['start', {:arel_predicate => 'matches', :formatter => proc {|v| "#{escape_wildcards(v)}%"}}],
+      ['not_start', {:arel_predicate => 'does_not_match', :formatter => proc {|v| "#{escape_wildcards(v)}%"}}],
+      ['end', {:arel_predicate => 'matches', :formatter => proc {|v| "%#{escape_wildcards(v)}"}}],
+      ['not_end', {:arel_predicate => 'does_not_match', :formatter => proc {|v| "%#{escape_wildcards(v)}"}}],
       ['true', {:arel_predicate => 'eq', :compounds => false, :type => :boolean, :validator => proc {|v| TRUE_VALUES.include?(v)}}],
       ['false', {:arel_predicate => 'eq', :compounds => false, :type => :boolean, :validator => proc {|v| TRUE_VALUES.include?(v)}, :formatter => proc {|v| !v}}],
       ['present', {:arel_predicate => 'not_eq_all', :compounds => false, :type => :boolean, :validator => proc {|v| TRUE_VALUES.include?(v)}, :formatter => proc {|v| [nil, '']}}],
@@ -19,5 +19,11 @@ module Ransack
       ['null', {:arel_predicate => 'eq', :compounds => false, :type => :boolean, :validator => proc {|v| TRUE_VALUES.include?(v)}, :formatter => proc {|v| nil}}],
       ['not_null', {:arel_predicate => 'not_eq', :compounds => false, :type => :boolean, :validator => proc {|v| TRUE_VALUES.include?(v)}, :formatter => proc {|v| nil}}]
     ]
+
+    module_function
+    # replace % _  \ to \% \_ \\
+    def escape_wildcards(unescaped)
+      unescaped.gsub(/\\/){ "\\\\" }.gsub(/%/, "\\%").gsub(/_/, "\\_")
+    end
   end
 end

data/lib/ransack/helpers/form_helper.rb

@@ -13,8 +13,8 @@ module Ransack
         end
         options[:html] ||= {}
         html_options = {
-          :class  => options[:as] ? "#{options[:as]}_search" : "#{search.klass.to_s.underscore}_search",
-          :id => options[:as] ? "#{options[:as]}_search" : "#{search.klass.to_s.underscore}_search",
+          :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'

data/lib/ransack/locale/cs.yml

@@ -0,0 +1,70 @@
+cs:
+  ransack:
+    search: "vyhledávání"
+    predicate: "predikát"
+    and: "a"
+    or: "nebo"
+    any: "kteroukoliv"
+    all: "každou"
+    combinator: "kombinátor"
+    attribute: "atribut"
+    value: "hodnota"
+    condition: "podmínka"
+    sort: "řazení"
+    asc: "vzestupné"
+    desc: "sestupné"
+    predicates:
+      eq: "rovno"
+      eq_any: "rovno kterékoliv"
+      eq_all: "rovno všem"
+      not_eq: "nerovno"
+      not_eq_any: "nerovno kterékoliv"
+      not_eq_all: "nerovno všem"
+      matches: "odpovídá"
+      matches_any: "odpovídá kterékoliv"
+      matches_all: "odpovídá všem"
+      does_not_match: "neodpovídá"
+      does_not_match_any: "neodpovídá kterékoliv"
+      does_not_match_all: "neodpovídá všem"
+      lt: "menší než"
+      lt_any: "menší než kterákoliv"
+      lt_all: "menší než všechny"
+      lteq: "menší nebo rovno než"
+      lteq_any: "menší nebo rovno než kterákoliv"
+      lteq_all: "menší nebo rovno než všechny"
+      gt: "větší než"
+      gt_any: "větší než kterákoliv"
+      gt_all: "větší než všechny"
+      gteq: "větší nebo rovno než"
+      gteq_any: "větší nebo rovno než kterákoliv"
+      gteq_all: "větší nebo rovno než všechny"
+      in: "v"
+      in_any: "v kterékoliv"
+      in_all: "ve všech"
+      not_in: "není v"
+      not_in_any: "není v kterékoliv"
+      not_in_all: "není ve všech"
+      cont: "obsahuje"
+      cont_any: "obsahuje kterékoliv"
+      cont_all: "obsahuje všechny"
+      not_cont: "neobsahuje"
+      not_cont_any: "neobsahuje kteroukoliv"
+      not_cont_all: "neobsahuje všechny"
+      start: "začíná s"
+      start_any: "začíná s kteroukoliv"
+      start_all: "začíná se všemi"
+      not_start: "nezačíná s"
+      not_start_any: "nezačíná s kteroukoliv"
+      not_start_all: "nezačíná se všemi"
+      end: "končí s"
+      end_any: "končí s kteroukoliv"
+      end_all: "končí se všemi"
+      not_end: "nekončí s"
+      not_end_any: "nekončí s kteroukoliv"
+      not_end_all: "nekončí se všemi"
+      'true': "je pravdivé"
+      'false': "není pravdivé"
+      present: "je vyplněné"
+      blank: "je prázdné"
+      'null': "je null"
+      not_null: "není null"

data/lib/ransack/locale/en.yml

@@ -21,7 +21,7 @@ en:
       not_eq_any: "not equal to any"
       not_eq_all: "not equal to all"
       matches: "matches"
-      matches_any: "matches_any"
+      matches_any: "matches any"
       matches_all: "matches all"
       does_not_match: "doesn't match"
       does_not_match_any: "doesn't match any"

data/lib/ransack/locale/es.yml

@@ -0,0 +1,70 @@
+es:
+  ransack:
+    search: "buscar"
+    predicate: "predicado"
+    and: "y"
+    or: "o"
+    any: "cualquier"
+    all: "todos"
+    combinator: "combinado"
+    attribute: "atributo"
+    value: "valor"
+    condition: "condición"
+    sort: "ordernar"
+    asc: "ascendente"
+    desc: "descendente"
+    predicates:
+      eq: "es igual a"
+      eq_any: "es igual a cualquier"
+      eq_all: "es igual a todos"
+      not_eq: "no es igual a"
+      not_eq_any: "no es igual a cualquier"
+      not_eq_all: "no es iguala todos"
+      matches: "coincidir"
+      matches_any: "coincidir a cualquier"
+      matches_all: "coincidir a todos"
+      does_not_match: "no coincide"
+      does_not_match_any: "no coincide con ninguna"
+      does_not_match_all: "no coincide con todos"
+      lt: "menor que"
+      lt_any: "menor que cualquier"
+      lt_all: "menor o igual a"
+      lteq: "less than or equal to"
+      lteq_any: "menor o igual a cualquier"
+      lteq_all: "menor o igual a todos"
+      gt: "mayor que"
+      gt_any: "mayor que cualquier"
+      gt_all: "mayor que todos"
+      gteq: "mayor que o igual a"
+      gteq_any: "mayor que o igual a cualquier"
+      gteq_all: "mayor que o igual a todos"
+      in: "en"
+      in_any: "en cualquier"
+      in_all: "en todos"
+      not_in: "no en"
+      not_in_any: "no en cualquier"
+      not_in_all: "no en todos"
+      cont: "contiene"
+      cont_any: "contiene cualquier"
+      cont_all: "contiene todos"
+      not_cont: "no contiene"
+      not_cont_any: "no contiene ninguna"
+      not_cont_all: "no contiene toda"
+      start: "comienza con"
+      start_any: "comienza con cualquier"
+      start_all: "comienza con toda"
+      not_start: "no inicia con"
+      not_start_any: "no comienza con cualquier"
+      not_start_all: "no inicia con toda"
+      end: "termina con"
+      end_any: "termina con cualquier"
+      end_all: "termina con todo"
+      not_end: "no termina con"
+      not_end_any: "no termina con cualquier"
+      not_end_all: "no termina con todo"
+      'true': "es verdadero"
+      'false': "es falso"
+      present: "es presente"
+      blank: "está en blanco"
+      'null': "es nula"
+      not_null: "no es nula"

data/lib/ransack/nodes/attribute.rb

@@ -44,6 +44,10 @@ module Ransack
         false
       end
 
+      def inspect
+        "Attribute <#{name}>"
+      end
+
     end
   end
 end

data/lib/ransack/nodes/condition.rb

@@ -200,6 +200,13 @@ module Ransack
         predicate.type || (attributes.first && attributes.first.type)
       end
 
+      def inspect
+        data =[['attributes', a.try(:map, &:name)], ['predicate', p], ['combinator', m], ['values', v.try(:map, &:value)]].reject { |e|
+          e[1].blank?
+        }.map { |v| "#{v[0]}: #{v[1]}" }.join(', ')
+        "Condition <#{data}>"
+      end
+
       private
 
       def valid_combinator?

data/lib/ransack/nodes/grouping.rb

@@ -154,6 +154,13 @@ module Ransack
         self
       end
 
+      def inspect
+        data =[['conditions', conditions], ['combinator', combinator]].reject { |e|
+          e[1].blank?
+        }.map { |v| "#{v[0]}: #{v[1]}" }.join(', ')
+        "Grouping <#{data}>"
+      end
+
       private
 
       def write_attribute(name, val)

data/lib/ransack/nodes/value.rb

@@ -98,6 +98,10 @@ module Ransack
          end
        end
 
+      def inspect
+        "Value <#{value}>"
+      end
+
        def array_of_arrays?(val)
          Array === val && Array === val.first
        end

data/lib/ransack/search.rb

@@ -72,7 +72,7 @@ module Ransack
       Nodes::Sort.new(@context).build(opts)
     end
 
-    def respond_to?(method_id)
+    def respond_to?(method_id, include_private = false)
       super or begin
         method_name = method_id.to_s
         writer = method_name.sub!(/\=$/, '')
@@ -90,6 +90,10 @@ module Ransack
       end
     end
 
+    def inspect
+      "Ransack::Search<class: #{klass.name}, base: #{base.inspect}>"
+    end
+
     private
 
     def collapse_multiparameter_attributes!(attrs)
@@ -114,4 +118,4 @@ module Ransack
     end
 
   end
-end
+end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/spec/ransack/adapters/active_record/base_spec.rb

@@ -43,6 +43,11 @@ module Ransack
             s = Person.search(:doubled_name_eq => 'Aric SmithAric Smith')
             s.result.first.should eq Person.find_by_name('Aric Smith')
           end if defined?(Arel::Nodes::InfixOperation)
+
+          it "doesn't break #count if using InfixOperations" do
+            s = Person.search(:doubled_name_eq => 'Aric SmithAric Smith')
+            s.result.count.should eq 1
+          end if defined?(Arel::Nodes::InfixOperation)
         end
 
         describe '#ransackable_attributes' do

data/spec/ransack/predicate_spec.rb

@@ -29,6 +29,10 @@ module Ransack
         @s.name_cont = 'ric'
         @s.result.to_sql.should match /"people"."name" LIKE '%ric%'/
       end
+      it 'escapes %, _ and \\ in value' do
+        @s.name_cont = '%_\\'
+        @s.result.to_sql.should match /"people"."name" LIKE '%\\%\\_\\\\%'/
+      end
     end
 
     describe 'not_cont' do

data/spec/ransack/search_spec.rb

@@ -104,6 +104,11 @@ module Ransack
         condition.attributes.first.name.should eq 'name'
         condition.value.should eq ['Ernie', 'Bert']
       end
+
+      it 'does not evaluate the query on #inspect' do
+        search = Search.new(Person, :children_id_in => [1, 2, 3])
+        search.inspect.should_not match /ActiveRecord/
+      end
     end
 
     describe '#result' do
@@ -235,5 +240,11 @@ module Ransack
       end
     end
 
+    describe '#respond_to' do
+      it 'is aware of second argument' do
+        Search.new(Person).respond_to?(:name_eq, true).should be_true
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-29 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -135,6 +135,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -145,6 +146,7 @@ files:
 - lib/ransack/adapters/active_record/3.0/context.rb
 - lib/ransack/adapters/active_record/3.1/context.rb
 - lib/ransack/adapters/active_record/base.rb
+- lib/ransack/adapters/active_record/compat.rb
 - lib/ransack/adapters/active_record/context.rb
 - lib/ransack/configuration.rb
 - lib/ransack/constants.rb
@@ -152,7 +154,9 @@ files:
 - lib/ransack/helpers.rb
 - lib/ransack/helpers/form_builder.rb
 - lib/ransack/helpers/form_helper.rb
+- lib/ransack/locale/cs.yml
 - lib/ransack/locale/en.yml
+- lib/ransack/locale/es.yml
 - lib/ransack/naming.rb
 - lib/ransack/nodes.rb
 - lib/ransack/nodes/attribute.rb
@@ -200,21 +204,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4077471372512744125
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4077471372512744125
 requirements: []
 rubyforge_project: ransack
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Object-based searching for ActiveRecord (currently).