ransack_abbreviator 0.0.6 → 0.0.7

data/CHANGELOG.md

@@ -8,4 +8,9 @@
 
 ## v0.0.6
 
-* First stable release
+* First stable release
+
+## v0.0.7
+
+* Added ability to reference abbreviations in a form by adding a 'abbr_' prefix on each form element.
+* Created an 'abbr_attribute_select' form helper that does the same as Ransack's attribute_select, but with abbreviations.

data/README.md

@@ -16,7 +16,7 @@ gem 'ransack_abbreviator'
 The abbreviator should cause absolutely no problems if you decide to not use abbreviations. It only kicks in when an abbreviation is detected in the params. That said, here's how to use it:
 
 #### Define Abbreviations
-First, define some abbreviations for columns and associations that can be queried in your search form. You can create a ransack_abbreviator.yml file in your config directory in a structure like this:
+First, define some abbreviations for columns and associations. One way to do that is to create a ransack_abbreviator.yml file in your config directory in a structure like this:
 
     ransack_abbreviations:
       columns:
@@ -36,27 +36,30 @@ RansackAbbreviator.configure do |config|
 end
 ```
 #### Use the Abbreviated Attribute in your Form
-In your form, pass the Ransack language you would normally use (along with the search object) to a helper called ransack_abbreviation_for:
+In your form, simply add an 'abbr_' prefix to each form element:
 
     <%= search_form_for @q do |f| %>
-      <%= f.text_field ransack_abbreviation_for(@q, :name_cont) %>
-      <%= f.text_field ransack_abbreviation_for(@q, :articles_title_start) %>
+      <%= f.abbr_label :name_cont, "Name Contains" %>
+      <%= f.abbr_text_field :name_cont %>
+      <%= f.abbr_label :articles_title_start, "Title of article starts with" %>
+      <%= f.abbr_text_field :articles_title_start %>
       <%= f.submit %>
     <% end %>
 
-When the above form is submitted, what would have normally been a URL param of 'name_cont' is now 'nm_cont'. 'articles_title_start' is now 'ars.tl_start'.
+When the above form is submitted, what would have normally been a URL param of 'name_cont' is now 'nm_cont'. 'articles_title_start' is now 'ars.tl_start'. View the source of the generated form to see for yourself!
 
-See the [Ransack](https://github.com/ernie/ransack) documentation on how to reference associations, columns, and predicates.
+If you're using Ransack's 'attribute_select', simply change it to 'abbr_attribute_select' to utilize abbreviations over the full attribute name.
+
+See the [Ransack](https://github.com/ernie/ransack) documentation for more info on the language Ransack uses and how to reference associations, columns, and predicates.
 
 #### Remove those POST hacks!
 Hopefully, the URL is now at least half the size it could have been before and you can remove all the POST hacks you did to get pagination and whatnot to work correctly!
 
 ### Some Notes
-* ransack_abbreviation_for abbreviates what it can, and returns the full name for what it cannot. For example, if you forgot to abbreviate 'articles', then ransack_abbreviation_for(@q, :articles_title_start) would return 'articles.tl_start'
+* The code works by abbreviating what it can and leaving what it cannot alone. For example, if you forgot to abbreviate 'articles', then <%= f.abbr_text_field :articles_title_start %> would return 'articles.tl_start' as the ID and param of the text field.
 
 ### To Do
 * Support abbreviation of 'ransacker' attributes
-* Extend the 'attribute_select' form helper to support returning attributes as their abbreviations
 
 ### License and Copyright
 MIT License. Copyright &copy; 2013 [Jamie Davidson](http://jamie-davidson.com)

data/lib/ransack_abbreviator.rb

@@ -23,4 +23,5 @@ require "ransack_abbreviator/ransack_extensions/nodes/condition"
 require "ransack_abbreviator/ransack_extensions/context"
 require "ransack_abbreviator/ransack_extensions/search"
 require 'ransack_abbreviator/adapters/active_record'
-require "ransack_abbreviator/view_helpers"
+require "ransack_abbreviator/view_helpers"
+require "ransack_abbreviator/ransack_extensions/helpers/form_builder"

data/lib/ransack_abbreviator/adapters/active_record/base.rb

@@ -14,8 +14,12 @@ module RansackAbbreviator
         end
         
         def ransack_abbreviate_column!(column_name, column_abbr)
-          raise ActiveModel::MissingAttributeError, "missing attribute: #{column_name}" unless column_names.include?(column_name) 
-          raise "column #{self.ransackable_column_abbreviations.key(column_abbr)} has abbreviaiton #{column_abbr}" if self.ransackable_column_abbreviations.has_value?(column_abbr)
+          unless column_names.include?(column_name) 
+            raise ActiveModel::MissingAttributeError, "missing attribute: #{column_name}" 
+          end
+          if self.ransackable_column_abbreviations.has_value?(column_abbr)
+            raise "Column #{self.ransackable_column_abbreviations.key(column_abbr)} already has abbreviaiton #{column_abbr}. Column abbreviations need to be unique" 
+          end
           self._ransack_column_abbreviations[column_name] = column_abbr
         end
         
@@ -24,19 +28,33 @@ module RansackAbbreviator
         end
         
         def ransack_abbreviate_assoc!(assoc_name, assoc_abbr)
-          raise ActiveModel::MissingAttributeError, "missing association: #{assoc_name}" unless reflect_on_all_associations.map{|a| a.name.to_s}.include?(assoc_name) 
-          raise "association #{self.ransackable_assoc_abbreviations.key(assoc_abbr)} has abbreviaiton #{assoc_abbr}" if self.ransackable_assoc_abbreviations.has_value?(assoc_abbr)
+          unless reflect_on_all_associations.map{|a| a.name.to_s}.include?(assoc_name) 
+            raise ActiveModel::MissingAttributeError, "missing association: #{assoc_name}" 
+          end
+          if self.ransackable_assoc_abbreviations.has_value?(assoc_abbr)
+            raise "Association #{self.ransackable_assoc_abbreviations.key(assoc_abbr)} already has abbreviaiton #{assoc_abbr} Association abbreviations need to be unique" 
+          end
           self._ransack_assoc_abbreviations[assoc_name] = assoc_abbr
         end
         
         def ransackable_column_abbreviations
-          self._ransack_column_abbreviations ||= RansackAbbreviator.column_abbreviations.select{ |key, val| column_names.include?(key) }
+          self._ransack_column_abbreviations ||= begin
+            self._ransack_column_abbreviations = {}
+            RansackAbbreviator.column_abbreviations.select{ |key, val| column_names.include?(key) }.each do |col, abbr|
+              raise "Column #{self._ransack_column_abbreviations.key(abbr)} already has abbreviaiton #{abbr}" if self._ransack_column_abbreviations.has_value?(abbr)
+              self._ransack_column_abbreviations[col] = abbr
+            end
+          end
         end
         
         def ransackable_assoc_abbreviations
           self._ransack_assoc_abbreviations ||= begin 
+            self._ransack_assoc_abbreviations = {}
             associations = reflect_on_all_associations.map{|a| a.name.to_s}
-            RansackAbbreviator.assoc_abbreviations.select{ |key, val| associations.include?(key) }
+            RansackAbbreviator.assoc_abbreviations.select{ |key, val| associations.include?(key) }.each do |assoc, abbr|
+              raise "Association #{self._ransack_assoc_abbreviations.key(abbr)} already has abbreviaiton #{abbr}" if self._ransack_assoc_abbreviations.has_value?(abbr)
+              self._ransack_assoc_abbreviations[assoc] = abbr
+            end
           end
         end
         

data/lib/ransack_abbreviator/configuration.rb

@@ -11,8 +11,9 @@ module RansackAbbreviator
     
     def column_abbreviations=(abbreviations)
       if abbreviations
+        raise ArgumentError, "abbreviates must be a Hash" unless abbreviations.is_a?(Hash)
         if !(abbreviations.values & RansackAbbreviator::Constants::RESERVED_KEYWORDS).blank?
-          fail "You used a reserved keyword as a column abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
+          raise ArgumentError, "You used a reserved keyword as a column abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
         end
         
         @@column_abbreviations = abbreviations
@@ -21,8 +22,9 @@ module RansackAbbreviator
     
     def assoc_abbreviations=(abbreviations)
       if abbreviations
+        raise ArgumentError, "abbreviates must be a Hash" unless abbreviations.is_a?(Hash)
         if !(abbreviations.values & RansackAbbreviator::Constants::RESERVED_KEYWORDS).blank?
-          fail "You used a reserved keyword as an association abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
+          raise ArgumentError, "You used a reserved keyword as an association abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
         end
         
         @@assoc_abbreviations = abbreviations

data/lib/ransack_abbreviator/ransack_extensions/helpers/form_builder.rb

@@ -0,0 +1,65 @@
+require 'action_view'
+
+module Ransack
+  module Helpers
+    class FormBuilder < ::ActionView::Helpers::FormBuilder
+      def method_missing(method_id, *args, &block)
+        method_name = method_id.to_s
+        if method_name.starts_with?('abbr_')
+          raise ArgumentError, "abbreviated form helpers must be called inside a search FormBuilder!" unless object.respond_to?(:context)
+          ransack_name = args.shift
+          actual_method = method_name.sub('abbr_', '')
+          abbreviated_ransack_name = object.context.encode_parameter(ransack_name)
+          self.send(actual_method, abbreviated_ransack_name, *args, &block)
+        else
+          super
+        end
+      end
+      
+      def abbr_attribute_select(options = {}, html_options = {})
+        raise ArgumentError, "abbr_attribute_select must be called inside a search FormBuilder!" unless object.respond_to?(:context)
+        options[:include_blank] = true unless options.has_key?(:include_blank)
+        associations = association_array(options[:associations])
+        if associations.size > 0
+          bases = [''] + associations
+          grouped_collection = encoded_attribute_collection_for_bases(bases)
+          @template.grouped_collection_select(
+            @object_name, :name, grouped_collection, :last, :first, :first, :last,
+            objectify_options(options), @default_options.merge(html_options)
+          )
+        else
+          collection = encoded_attribute_collection_for_base
+          @template.collection_select(
+            @object_name, :name, collection, :first, :last,
+            objectify_options(options), @default_options.merge(html_options)
+          )
+        end
+      end
+      
+      private
+      
+      def encoded_attribute_collection_for_base(base=nil)
+        prefix = base.blank? ?  "" : "#{base}_"
+        object.context.searchable_attributes(base).map do |attr|
+          [
+            object.context.encode_parameter(prefix + attr),
+            Translate.attribute(prefix + attr, :context => object.context)
+          ]
+        end
+      end
+      
+      def encoded_attribute_collection_for_bases(bases)
+        bases.map do |base|
+          begin
+          [
+            Translate.association(base, :context => object.context),
+            encoded_attribute_collection_for_base(base)
+          ]
+          rescue UntraversableAssociationError => e
+            nil
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/ransack_abbreviator/ransack_extensions/nodes/condition.rb

@@ -4,11 +4,19 @@ module Ransack
       alias_method :ransack_condition_build, :build
       
       def build(params)
-        decoded_attr_names = []
-        params[:a].each do |possible_abbr|
-          decoded_attr_names << @context.decode_parameter(possible_abbr)
+        attrs = params[:a]
+        unless attrs.blank?
+          case attrs
+          when Array
+            attrs.each_with_index do |attr, i|
+              params[:a][i] = @context.decode_parameter(attr)
+            end
+          when Hash
+            attrs.each do |index, attr|
+              params[:a][index][:name] = @context.decode_parameter(attr[:name])
+            end
+          end
         end
-        params[:a] = decoded_attr_names
         ransack_condition_build(params)
       end
     end

data/lib/ransack_abbreviator/version.rb

@@ -1,3 +1,3 @@
 module RansackAbbreviator
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/ransack_abbreviator/helpers/form_builder_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module Ransack
+  module Helpers
+    describe FormBuilder do
+      # Below setup copied from Ransack 0.7.2 form_builder_spec
+      router = ActionDispatch::Routing::RouteSet.new
+      router.draw do
+        resources :people
+        match ':controller(/:action(/:id(.:format)))'
+      end
+
+      include router.url_helpers
+
+      # FIXME: figure out a cleaner way to get this behavior
+      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
+
+        @s = Person.search
+        @controller.view_context.search_form_for @s do |f|
+          @f = f
+        end
+      end
+      
+      describe 'form helpers with abbreviations' do
+        it 'shortens the method to defined Ransack abbreviations' do
+          html = @f.abbr_label :name_eq
+          html.should match /for="q_nm_eq"/
+          
+          html = @f.abbr_select :children_name_eq, "<option value=\"Ernie\">Ernie</option><option value=\"Bob\">Bob</option>"
+          html.should match /id="q_ch.nm_eq"/
+        end
+        
+        it 'uses the full name for undefined abbreviations' do
+          html = @f.abbr_text_area :articles_body_cont
+          html.should match /id="q_articles.body_cont"/
+        end
+        
+        it 'selects previously-entered values' do
+          @s.name_eq = 'Ernie'
+          html = @f.abbr_text_field :name_eq
+          html.should match /value="Ernie"/
+          
+          @s.children_name_eq = 'Ernie'
+          html = @f.abbr_text_field :children_name_eq
+          html.should match /value="Ernie"/
+        end
+      end
+      
+      describe '#abbr_attribute_select' do
+        it 'returns ransackable attributes as abbreviations' do
+          html = @f.abbr_attribute_select
+          html.split(/\n/).should have(Person.ransackable_attributes.size + 1).lines
+          Person.ransackable_attributes.each do |attribute|
+            html.should match /<option value="#{@s.context.encode_parameter(attribute)}">/
+          end
+        end
+        
+        it 'returns ransackable attributes as abbreviations for associations' do
+          attributes = Person.ransackable_attributes + Comment.ransackable_attributes.map {|a| "authored_article_comments_#{a}"}
+          html = @f.abbr_attribute_select :associations => ['authored_article_comments']
+          html.split(/\n/).should have(attributes.size).lines
+          attributes.each do |attribute|
+            html.should match /<option value="#{@s.context.encode_parameter(attribute)}">/
+          end
+        end
+      end
+    end
+  end
+end

data/spec/ransack_abbreviator/search_spec.rb

@@ -123,6 +123,7 @@ module Ransack # We're testing Ransack's Search wih abbreviations
     end
     
     context "without abbreviations" do
+      # Below specs copied from Ransack 0.7.2 search_spec. I'm ensuring I didn't break any existing Ransack functionality
       it 'creates Conditions for top-level attributes' do
         search = Search.new(Person, :name_eq => 'Ernie')
         condition = search.base[:name_eq]

metadata

@@ -2,7 +2,7 @@
 name: ransack_abbreviator
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jamie Davidson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-05 00:00:00 Z
+date: 2013-02-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ransack
@@ -104,6 +104,7 @@ files:
 - lib/ransack_abbreviator/constants.rb
 - lib/ransack_abbreviator/engine.rb
 - lib/ransack_abbreviator/ransack_extensions/context.rb
+- lib/ransack_abbreviator/ransack_extensions/helpers/form_builder.rb
 - lib/ransack_abbreviator/ransack_extensions/nodes/condition.rb
 - lib/ransack_abbreviator/ransack_extensions/search.rb
 - lib/ransack_abbreviator/version.rb
@@ -117,6 +118,7 @@ files:
 - spec/ransack_abbreviator/adapters/active_record/base_spec.rb
 - spec/ransack_abbreviator/configuration_spec.rb
 - spec/ransack_abbreviator/helper_spec.rb
+- spec/ransack_abbreviator/helpers/form_builder_spec.rb
 - spec/ransack_abbreviator/search_spec.rb
 - spec/spec_helper.rb
 - spec/support/schema.rb
@@ -156,6 +158,7 @@ test_files:
 - spec/ransack_abbreviator/adapters/active_record/base_spec.rb
 - spec/ransack_abbreviator/configuration_spec.rb
 - spec/ransack_abbreviator/helper_spec.rb
+- spec/ransack_abbreviator/helpers/form_builder_spec.rb
 - spec/ransack_abbreviator/search_spec.rb
 - spec/spec_helper.rb
 - spec/support/schema.rb