ransack 1.4.1 → 1.5.0

data/lib/ransack/nodes/grouping.rb

@@ -69,7 +69,7 @@ module Ransack
       def respond_to?(method_id)
         super or begin
           method_name = method_id.to_s
-          writer = method_name.sub!(/\=$/, '')
+          writer = method_name.sub!(/\=$/, Ransack::Constants::EMPTY)
           attribute_method?(method_name) ? true : false
         end
       end
@@ -115,7 +115,7 @@ module Ransack
 
       def method_missing(method_id, *args)
         method_name = method_id.to_s
-        writer = method_name.sub!(/\=$/, '')
+        writer = method_name.sub!(/\=$/, Ransack::Constants::EMPTY)
         if attribute_method?(method_name)
           writer ?
             write_attribute(method_name, *args) :
@@ -126,12 +126,15 @@ module Ransack
       end
 
       def attribute_method?(name)
-        name = strip_predicate_and_index(name)
-        case name
+        stripped_name = strip_predicate_and_index(name)
+        return true if @context.attribute_method?(stripped_name) ||
+                       @context.attribute_method?(name)
+        case stripped_name
         when /^(g|c|m|groupings|conditions|combinator)=?$/
           true
         else
-          name.split(/_and_|_or_/)
+          stripped_name
+          .split(/_and_|_or_/)
           .select { |n| !@context.attribute_method?(n) }
           .empty?
         end
@@ -161,10 +164,13 @@ module Ransack
       end
 
       def inspect
-        data = [['conditions', conditions], ['combinator', combinator]]
-               .reject { |e| e[1].blank? }
-               .map { |v| "#{v[0]}: #{v[1]}" }
-               .join(', ')
+        data = [
+          ['conditions'.freeze, conditions],
+          [Ransack::Constants::COMBINATOR, combinator]
+        ]
+        .reject { |e| e[1].blank? }
+        .map { |v| "#{v[0]}: #{v[1]}" }
+        .join(Ransack::Constants::COMMA_SPACE)
         "Grouping <#{data}>"
       end
 

data/lib/ransack/nodes/sort.rb

@@ -25,8 +25,8 @@ module Ransack
 
       def valid?
         bound? && attr &&
-          context.klassify(parent).ransortable_attributes(context.auth_object)
-          .include?(attr_name)
+        context.klassify(parent).ransortable_attributes(context.auth_object)
+        .include?(attr_name)
       end
 
       def name=(name)
@@ -35,8 +35,13 @@ module Ransack
       end
 
       def dir=(dir)
-        dir = dir.try(:downcase)
-        @dir = %w(asc desc).include?(dir) ? dir : 'asc'
+        dir = dir.downcase if dir
+        @dir =
+          if Ransack::Constants::ASC_DESC.include?(dir)
+            dir
+          else
+            Ransack::Constants::ASC
+          end
       end
 
     end

data/lib/ransack/predicate.rb

@@ -19,7 +19,7 @@ module Ransack
 
       def detect_and_strip_from_string!(str)
         if p = detect_from_string(str)
-          str.sub! /_#{p}$/, ''
+          str.sub! /_#{p}$/, Ransack::Constants::EMPTY
           p
         end
       end
@@ -28,15 +28,15 @@ module Ransack
         names_by_decreasing_length.detect { |p| str.end_with?("_#{p}") }
       end
 
-      def name_from_attribute_name(attribute_name)
-        names_by_decreasing_length.detect {
-          |p| attribute_name.to_s.match(/_#{p}$/)
-        }
-      end
+#      def name_from_attribute_name(attribute_name)
+#        names_by_decreasing_length.detect {
+#          |p| attribute_name.to_s.match(/_#{p}$/)
+#        }
+#      end
 
-      def for_attribute_name(attribute_name)
-        self.named(detect_from_string(attribute_name.to_s))
-      end
+#      def for_attribute_name(attribute_name)
+#        self.named(detect_from_string(attribute_name.to_s))
+#      end
 
     end
 
@@ -49,7 +49,7 @@ module Ransack
         lambda { |v| v.respond_to?(:empty?) ? !v.empty? : !v.nil? }
       @compound = opts[:compound]
       @wants_array = opts[:wants_array] == true || @compound ||
-        ['in', 'not_in'].include?(@arel_predicate)
+        Ransack::Constants::IN_NOT_IN.include?(@arel_predicate)
     end
 
     def eql?(other)

data/lib/ransack/search.rb

@@ -22,7 +22,10 @@ module Ransack
       end
       @context = options[:context] || Context.for(object, options)
       @context.auth_object = options[:auth_object]
-      @base = Nodes::Grouping.new(@context, options[:grouping] || 'and')
+      @base = Nodes::Grouping.new(
+        @context,
+        options[:grouping] || Ransack::Constants::AND
+        )
       @scope_args = {}
       build(params.with_indifferent_access)
     end
@@ -33,7 +36,7 @@ module Ransack
 
     def build(params)
       collapse_multiparameter_attributes!(params).each do |key, value|
-        if ['s', 'sorts'].include?(key)
+        if Ransack::Constants::S_SORTS.include?(key)
           send("#{key}=", value)
         elsif base.attribute_method?(key)
           base.send("#{key}=", value)
@@ -88,7 +91,7 @@ module Ransack
 
     def method_missing(method_id, *args)
       method_name = method_id.to_s
-      getter_name = method_name.sub(/=$/, '')
+      getter_name = method_name.sub(/=$/, Ransack::Constants::EMPTY)
       if base.attribute_method?(getter_name)
         base.send(method_id, *args)
       elsif @context.ransackable_scope?(getter_name, @context.object)
@@ -107,7 +110,10 @@ module Ransack
         [:class, klass.name],
         ([:scope, @scope_args] if @scope_args.present?),
         [:base, base.inspect]
-      ].compact.map { |d| d.join(': ') }.join(', ')
+      ]
+      .compact.map { |d| d.join(': '.freeze) }
+      .join(Ransack::Constants::COMMA_SPACE)
+
       "Ransack::Search<#{details}>"
     end
 
@@ -124,14 +130,15 @@ module Ransack
 
     def collapse_multiparameter_attributes!(attrs)
       attrs.keys.each do |k|
-        if k.include?("(")
+        if k.include?('('.freeze)
           real_attribute, position = k.split(/\(|\)/)
-          cast = %w(a s i).include?(position.last) ? position.last : nil
+          cast = %w(a s i).freeze.include?(position.last) ? position.last : nil
           position = position.to_i - 1
           value = attrs.delete(k)
           attrs[real_attribute] ||= []
-          attrs[real_attribute][position] = if cast
-            (value.blank? && cast == 'i') ? nil : value.send("to_#{cast}")
+          attrs[real_attribute][position] =
+          if cast
+            value.blank? && cast == 'i'.freeze ? nil : value.send("to_#{cast}")
           else
             value
           end

data/lib/ransack/translate.rb

@@ -1,6 +1,8 @@
 require 'i18n'
 
-I18n.load_path += Dir[File.join(File.dirname(__FILE__), 'locale', '*.yml')]
+I18n.load_path += Dir[
+  File.join(File.dirname(__FILE__), 'locale'.freeze, '*.yml'.freeze)
+]
 
 module Ransack
   module Translate
@@ -23,7 +25,8 @@ module Ransack
         |x| x.respond_to?(:model_name)
       }
       predicate = Predicate.detect_from_string(original_name)
-      attributes_str = original_name.sub(/_#{predicate}$/, '')
+      attributes_str = original_name
+        .sub(/_#{predicate}$/, Ransack::Constants::EMPTY)
       attribute_names = attributes_str.split(/_and_|_or_/)
       combinator = attributes_str.match(/_and_/) ? :and : :or
       defaults = base_ancestors.map do |klass|
@@ -71,7 +74,7 @@ module Ransack
     def self.attribute_name(context, name, include_associations = nil)
       @context, @name = context, name
       @assoc_path = context.association_path(name)
-      @attr_name = @name.sub(/^#{@assoc_path}_/, '')
+      @attr_name = @name.sub(/^#{@assoc_path}_/, Ransack::Constants::EMPTY)
       associated_class = @context.traverse(@assoc_path) if @assoc_path.present?
       @include_associated = include_associations && associated_class
 
@@ -97,9 +100,9 @@ module Ransack
     def self.build_interpolations(associated_class)
       {
         :attr_fallback_name => attr_fallback_name(associated_class),
-        :association_name   => association_name 
+        :association_name   => association_name
       }
-      .reject! { |_, value| value.nil? }
+      .reject { |_, value| value.nil? }
     end
 
     def self.attr_fallback_name(associated_class)
@@ -148,7 +151,7 @@ module Ransack
 
     def self.i18n_key(klass)
       if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
-        klass.model_name.i18n_key.to_s.tr('.', '/')
+        klass.model_name.i18n_key.to_s.tr('.'.freeze, '/'.freeze)
       else
         klass.model_name.i18n_key.to_s
       end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/lib/ransack/visitor.rb

@@ -18,7 +18,11 @@ module Ransack
     end
 
     def visit_Ransack_Nodes_Grouping(object)
-      object.combinator == 'or' ? visit_or(object) : visit_and(object)
+      if object.combinator == Ransack::Constants::OR
+        visit_or(object)
+      else
+        visit_and(object)
+      end
     end
 
     def visit_and(object)
@@ -61,7 +65,9 @@ module Ransack
     end
 
     DISPATCH = Hash.new do |hash, klass|
-      hash[klass] = "visit_#{klass.name.gsub('::', '_')}"
+      hash[klass] = "visit_#{
+        klass.name.gsub('::'.freeze, Ransack::Constants::UNDERSCORE)
+        }"
     end
 
   end

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

@@ -24,12 +24,12 @@ module Ransack
             end
 
             it "applies true scopes" do
-              search =  Person.search('active' => true)
+              search = Person.search('active' => true)
               search.result.to_sql.should include "active = 1"
             end
 
             it "ignores unlisted scopes" do
-              search =  Person.search('restricted' => true)
+              search = Person.search('restricted' => true)
               search.result.to_sql.should_not include "restricted"
             end
 

data/spec/ransack/helpers/form_builder_spec.rb

@@ -6,8 +6,7 @@ module Ransack
 
       router = ActionDispatch::Routing::RouteSet.new
       router.draw do
-        resources :people
-        resources :notes
+        resources :people, :comments, :notes
         get ':controller(/:action(/:id(.:format)))'
       end
 
@@ -17,39 +16,57 @@ module Ransack
       before do
         @controller = ActionView::TestCase::TestController.new
         @controller.instance_variable_set(:@_routes, router)
-        @controller.class_eval do
-          include router.url_helpers
-        end
-
-        @controller.view_context_class.class_eval do
-          include router.url_helpers
-        end
-
+        @controller.class_eval { include router.url_helpers }
+        @controller.view_context_class.class_eval { include router.url_helpers }
         @s = Person.search
-        @controller.view_context.search_form_for @s do |f|
-          @f = f
-        end
+        @controller.view_context.search_form_for(@s) { |f| @f = f }
       end
 
       it 'selects previously-entered time values with datetime_select' do
-        @s.created_at_eq = [2011, 1, 2, 3, 4, 5]
+        date_values = %w(2011 1 2 03 04 05).freeze
+      # @s.created_at_eq = date_values # This works in Rails 4.x but not 3.x
+        @s.created_at_eq = [2011, 1, 2, 3, 4, 5] # so we have to do this
         html = @f.datetime_select(
-          :created_at_eq,
-          :use_month_numbers => true,
-          :include_seconds => true
+          :created_at_eq, :use_month_numbers => true, :include_seconds => true
           )
-        %w(2011 1 2 03 04 05).each do |val|
-          expect(html).to match /<option selected="selected" value="#{val}">#{val}<\/option>/
-        end
+        date_values.each { |val| expect(html).to include date_select_html(val) }
       end
 
       describe '#label' do
-
-        it 'localizes attribute names' do
-          html = @f.label :name_cont
-          expect(html).to match /Full Name contains/
+        context 'with direct model attributes' do
+          it 'localizes attribute names' do
+            test_label(@f, :name_cont, /Full Name contains/)
+            test_label(@f, :only_admin_start, /admin uSer Only starts with/)
+            test_label(@f, :salary_gt, /wages greater than/)
+            test_label(@f, :awesome_true, /ransack is really awesome is true/)
+          end
+          it 'falls back to `attribute_name.capitalize` when no translation' do
+            test_label(@f, :email_cont, /Email contains/)
+            test_label(@f, :only_sort_start, /Only sort starts with/)
+            test_label(@f, :only_search_eq, /Only search equals/)
+          end
+        end
+        context 'with `has_many` association attributes' do
+          it 'localizes :"#{pluralized model}_#{attribute name}_#{predicate}"' do
+            test_label(@f, :articles_body_start, /Article maiN BoDy starts with/)
+          end
+          it 'falls back to `model_name.capitalize + attribute_name.capitalize` when no translation' do
+            test_label(@f, :articles_title_cont, /Article Title contains/)
+            test_label(@f, :articles_subject_header_start, /Article Subject header starts with/)
+          end
+        end
+        context 'with `belongs_to` association attributes' do
+          before do
+            @controller.view_context.search_form_for(Comment.search) { |f| @f = f }
+          end
+          it 'localizes :"#{singularized model}_#{attribute name}_#{predicate}"' do
+            test_label(@f, :article_body_start, /Article maiN BoDy starts with/)
+          end
+          it 'falls back to `model_name.capitalize + attribute_name.capitalize` when no translation' do
+            test_label(@f, :article_title_eq, /Article Title equals/)
+            test_label(@f, :article_subject_header_end, /Article Subject header ends with/)
+          end
         end
-
       end
 
       describe '#sort_link' do
@@ -63,7 +80,6 @@ module Ransack
           expect(sort_link).to match /sort_link/
           expect(sort_link).to match /Full Name<\/a>/
         end
-
         it 'sort_link for common attribute' do
           sort_link = @f.sort_link :id, :controller => 'people'
           expect(sort_link).to match /id<\/a>/
@@ -71,67 +87,56 @@ module Ransack
       end
 
       describe '#submit' do
-
         it 'localizes :search when no default value given' do
           html = @f.submit
           expect(html).to match /"Search"/
         end
-
       end
 
       describe '#attribute_select' do
-
         it 'returns ransackable attributes' do
           html = @f.attribute_select
-          expect(html.split(/\n/).size).
-            to eq(Person.ransackable_attributes.size + 1)
+          expect(html.split(/\n/).size).to eq(Person.ransackable_attributes.size + 1)
           Person.ransackable_attributes.each do |attribute|
             expect(html).to match /<option value="#{attribute}">/
           end
         end
-
         it 'returns ransackable attributes for associations with :associations' do
-          attributes = Person.ransackable_attributes + Article.
-            ransackable_attributes.map { |a| "articles_#{a}" }
+          attributes = Person.ransackable_attributes +
+            Article.ransackable_attributes.map { |a| "articles_#{a}" }
           html = @f.attribute_select(:associations => ['articles'])
           expect(html.split(/\n/).size).to eq(attributes.size)
           attributes.each do |attribute|
             expect(html).to match /<option value="#{attribute}">/
           end
         end
-
         it 'returns option groups for base and associations with :associations' do
           html = @f.attribute_select(:associations => ['articles'])
           [Person, Article].each do |model|
             expect(html).to match /<optgroup label="#{model}">/
           end
         end
-
       end
 
       describe '#predicate_select' do
-
         it 'returns predicates with predicate_select' do
           html = @f.predicate_select
           Predicate.names.each do |key|
             expect(html).to match /<option value="#{key}">/
           end
         end
-
         it 'filters predicates with single-value :only' do
           html = @f.predicate_select :only => 'eq'
           Predicate.names.reject { |k| k =~ /^eq/ }.each do |key|
             expect(html).not_to match /<option value="#{key}">/
           end
         end
-
         it 'filters predicates with multi-value :only' do
           html = @f.predicate_select only: [:eq, :lt]
           Predicate.names.reject { |k| k =~ /^(eq|lt)/ }.each do |key|
             expect(html).not_to match /<option value="#{key}">/
           end
         end
-
         it 'excludes compounds when compounds: false' do
           html = @f.predicate_select :compounds => false
           Predicate.names.select { |k| k =~ /_(any|all)$/ }.each do |key|
@@ -142,9 +147,7 @@ module Ransack
 
       context 'fields used in polymorphic relations as search attributes in form' do
         before do
-          @controller.view_context.search_form_for Note.search do |f|
-            @f = f
-          end
+          @controller.view_context.search_form_for(Note.search) { |f| @f = f }
         end
         it 'accepts poly_id field' do
           html = @f.text_field(:notable_id_eq)
@@ -155,6 +158,23 @@ module Ransack
           expect(html).to match /id=\"q_notable_type_eq\"/
         end
       end
+
+      private
+
+        def test_label(f, query, expected)
+          expect(f.label query).to match expected
+        end
+
+        # Starting from Rails 4.2, the date_select html attributes are no longer
+        # `sort`ed (for a speed gain), so the tests have to be different:
+        def date_select_html(val)
+          if ::ActiveRecord::VERSION::STRING >= '4.2'.freeze
+            %(<option value="#{val}" selected="selected">#{val}</option>)
+          else
+            %(<option selected="selected" value="#{val}">#{val}</option>)
+          end
+        end
+
     end
   end
 end