ransack_abbreviator 0.0.3 → 0.0.4

data/README.md

@@ -1,4 +1,4 @@
-## Ransack Abbreviator [![Build Status](https://secure.travis-ci.org/jhdavids8/ransack-abbreviator.png)](http://travis-ci.org/jhdavids8/ransack-abbreviator)
+## Ransack Abbreviator [![Build Status](https://travis-ci.org/jhdavids8/ransack-abbreviator.png?branch=master)](http://travis-ci.org/jhdavids8/ransack-abbreviator)
 ===================
 
 

data/lib/ransack_abbreviator/abbreviators/decoder.rb

@@ -8,7 +8,7 @@ module RansackAbbreviator
       end
       
       def decode_parameter(param)
-        str = param.dup
+        str = param.is_a?(Symbol) ? param.to_s : param.dup
         pred = Ransack::Predicate.detect_and_strip_from_string!(str)
         decoded_param = nil
         case str
@@ -18,7 +18,7 @@ module RansackAbbreviator
           conjunctions = str.split("_").select{|s| s == "and" || s == "or" }
           decoded_param = ""
           str.split(/_and_|_or_/).each do |possible_abbr|
-            decoded_str = self.context.decode_possible_abbr(possible_abbr)
+            decoded_str = self.context.decode_association_and_column(possible_abbr)
             decoded_param << (!decoded_str.blank? ? decoded_str : possible_abbr)
             decoded_param << "_#{conjunctions.shift}_" if !conjunctions.blank?
           end
@@ -28,15 +28,15 @@ module RansackAbbreviator
         decoded_param
       end
       
-      def decode_possible_abbr(possible_abbr)
+      def decode_association_and_column(possible_abbr)
         possible_assoc_abbr, possible_attr_abbr = extract_possible_assoc_and_attribute_abbr(possible_abbr)
         parent_of_attribute = @context.klass
         decoded_str = ""
         if possible_assoc_abbr 
-          decoded_str, parent_of_attribute = decode_assoc_abbr(possible_assoc_abbr)
+          decoded_str, parent_of_attribute = decode_association(possible_assoc_abbr)
         end
 
-        if attr_name = decode_column_abbr(possible_attr_abbr, parent_of_attribute)
+        if attr_name = decode_attribute(possible_attr_abbr, parent_of_attribute)
           decoded_str << attr_name
         else
           decoded_str << possible_attr_abbr
@@ -45,7 +45,7 @@ module RansackAbbreviator
         decoded_str
       end
     
-      def decode_assoc_abbr(possible_assoc_abbr)
+      def decode_association(possible_assoc_abbr)
         # possible_assoc_abbr can be a chain of abbreviated associations, so decode them all and reconstruct into
         # the format expected by Ransack
         decoded_str = ""
@@ -75,7 +75,7 @@ module RansackAbbreviator
         [decoded_str, klass]
       end
     
-      def decode_column_abbr(possible_attr_abbr, klass=@context.klass)
+      def decode_attribute(possible_attr_abbr, klass=@context.klass)
         klass.ransackable_column_name_for(possible_attr_abbr)
       end
       

data/lib/ransack_abbreviator/abbreviators/encoder.rb

@@ -7,7 +7,21 @@ module RansackAbbreviator
         @context = context
       end
       
-      def encode_ransack_str(str)
+      def encode_parameter(param)
+        str = param.is_a?(Symbol) ? param.to_s : param.dup
+        pred = Ransack::Predicate.detect_and_strip_from_string!(str)
+        encoded_param = ""
+        conjunctions = str.split("_").select{|s| s == "and" || s == "or" }
+        str.split(/_and_|_or_/).each do |s|
+          encoded_param << self.context.encode_association_and_column(s)
+          encoded_param << "_#{conjunctions.shift}_" if !conjunctions.blank?
+        end
+        
+        encoded_param << "_#{pred}" if pred
+        encoded_param
+      end
+      
+      def encode_association_and_column(str)
         encoded_str = ""
         associations, attr_name = @context.get_associations_and_attribute(str)
         parent_of_attribute = @context.klass

data/lib/ransack_abbreviator/configuration.rb

@@ -9,6 +9,26 @@ module RansackAbbreviator
       yield self
     end
     
+    def column_abbreviations=(abbreviations)
+      if abbreviations
+        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(", ")}"
+        end
+        
+        self.column_abbreviations = abbreviations
+      end
+    end
+    
+    def assoc_abbreviations=(abbreviations)
+      if abbreviations
+        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(", ")}"
+        end
+        
+        self.assoc_abbreviations = abbreviations
+      end
+    end
+    
     def add_column_abbreviation(column, abbr)
       self.column_abbreviations[column.to_s] = abbr.to_s
     end

data/lib/ransack_abbreviator/ransack_extensions/context.rb

@@ -4,11 +4,9 @@ require 'ransack_abbreviator/abbreviators/encoder'
 module Ransack
   class Context
     attr_reader :decoder, :encoder
-    alias_method :full_ransackable_attribute?, :ransackable_attribute?
-    alias_method :full_ransackable_association?, :ransackable_association?
     
-    delegate :encode_ransack_str, to: :encoder
-    delegate :decode_parameter, :decode_possible_abbr, to: :decoder
+    delegate :encode_parameter, :encode_association_and_column, to: :encoder
+    delegate :decode_parameter, :decode_association_and_column, to: :decoder
     
     def get_associations_and_attribute(str, klass = @klass, associations = [])
       attr_name = nil
@@ -37,22 +35,6 @@ module Ransack
       @encoder ||= RansackAbbreviator::Abbreviators::Encoder.new(self)
     end
     
-    def ransackable_attribute?(str, klass)
-      full_ransackable_attribute?(str, klass) || ransackable_attribute_abbreviation?(str, klass)
-    end
-    
-    def ransackable_association?(str, klass)
-      full_ransackable_association?(str, klass) || ransackable_assoc_abbreviation?(str, klass)
-    end
-    
-    def ransackable_attribute_abbreviation?(str, klass)
-      klass.ransackable_column_abbreviations.has_value?(str)
-    end
-    
-    def ransackable_assoc_abbreviation?(str, klass)
-      klass.ransackable_assoc_abbreviations.has_value?(str)
-    end
-    
     def self.polymorphic_association_specified?(str)
       str && str.match(/_of_([^_]+?)_type$/)
     end

data/lib/ransack_abbreviator/version.rb

@@ -1,3 +1,3 @@
 module RansackAbbreviator
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/ransack_abbreviator/view_helpers.rb

@@ -1,16 +1,7 @@
 module RansackAbbreviator
   module ViewHelpers
-    def ransack_abbreviation_for(ransack_search_object, ransack_name)
-      str = ransack_name.is_a?(Symbol) ? ransack_name.to_s : ransack_name.dup
-      pred = Ransack::Predicate.detect_and_strip_from_string!(str)
-      conjunctions = str.split("_").select{|s| s == "and" || s == "or" }
-      abbr_str = ""
-      str.split(/_and_|_or_/).each do |s|
-        abbr_str << ransack_search_object.context.encode_ransack_str(s)
-        abbr_str << "_#{conjunctions.shift}_" if !conjunctions.blank?
-      end
-      
-      pred ? "#{abbr_str}_#{pred}" : abbr_str
+    def ransack_abbreviation_for(ransack_search_object, param)
+      ransack_search_object.context.encode_parameter(param)
     end
     
     def ransack_abbreviations_for(ransack_search_object, params)

data/lib/ransack_abbreviator.rb

@@ -11,10 +11,6 @@ RansackAbbreviator.configure do |config|
   if File.exist?(config.config_dir.join("ransack_abbreviator.yml"))
     parsed_config = OpenStruct.new(YAML.load_file(config.config_dir.join("ransack_abbreviator.yml")))
     ransack_abbreviations = parsed_config.ransack_abbreviations
-    if !(ransack_abbreviations["columns"].values & RansackAbbreviator::Constants::RESERVED_KEYWORDS).blank? ||
-      !(ransack_abbreviations["associations"].values & RansackAbbreviator::Constants::RESERVED_KEYWORDS).blank?
-      fail "You used a reserved keyword as an abbreviation. Reserverd keywords: #{RansackAbbreviator::Constants::RESERVED_KEYWORDS.join(", ")}"
-    end
     config.column_abbreviations = ransack_abbreviations["columns"] if ransack_abbreviations["columns"]
     config.assoc_abbreviations = ransack_abbreviations["associations"] if ransack_abbreviations["associations"]
   end

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

@@ -58,7 +58,13 @@ module RansackAbbreviator
             end
           end
           
-          context 'when an undefined abbreviation' do
+          context 'when a defined association' do
+            it "returns the full association name" do
+              Person.ransackable_assoc_name_for("articles").should eq "articles"
+            end
+          end
+          
+          context 'when an undefined abbreviation and association' do
             it "returns nil" do
               Person.ransackable_assoc_name_for("you_fake").should be_nil
             end

data/spec/ransack_abbreviator/search_spec.rb

@@ -254,6 +254,11 @@ module Ransack # We're testing Ransack's Search wih abbreviations
           search.result.should be_an ActiveRecord::Relation
           where = search.result.where_values.first
           where.to_sql.should match /"people"."name" = 'Ernie'/
+          
+          search.build(ransack_abbreviation_for(search, :notable_of_Article_type_title_eq) => 'Test')
+          search.result.should be_an ActiveRecord::Relation
+          where = search.result.where_values.first
+          where.to_sql.should match /"articles"."title" = 'Test'/
         end
 
         it 'evaluates nested conditions' do
@@ -377,23 +382,35 @@ module Ransack # We're testing Ransack's Search wih abbreviations
     end
     
     describe '#method_missing' do
-      before do
-        @search = Search.new(Person)
-      end
-      
-      it 'support abbreviations' do
-        abbr_search = ransack_abbreviation_for(@search, :middle_name_eq)
-        @search.send "#{abbr_search}=", 'Ernie'
-        @search.middle_name_eq.should eq 'Ernie'
+      context "when sent valid abbreviations" do
+        before do
+          @search = Search.new(Person)
+        end
+        
+        it 'sets condition attributes' do
+          abbr_search = ransack_abbreviation_for(@search, :middle_name_eq)
+          @search.send "#{abbr_search}=", 'Ernie'
+          @search.middle_name_eq.should eq 'Ernie'
         
-        abbr_search = ransack_abbreviation_for(@search, :authored_article_comments_vote_count_lteq)
-        @search.send "#{abbr_search}=", 10
-        @search.authored_article_comments_vote_count_lteq.should eq 10
+          abbr_search = ransack_abbreviation_for(@search, :authored_article_comments_vote_count_lteq)
+          @search.send "#{abbr_search}=", 10
+          @search.authored_article_comments_vote_count_lteq.should eq 10
         
-        note_search = Search.new(Note)
-        abbr_search = ransack_abbreviation_for(note_search, :notable_of_Person_type_name_eq)
-        note_search.send "#{abbr_search}=", 'Ernie'
-        note_search.notable_of_Person_type_name_eq.should eq 'Ernie'
+          note_search = Search.new(Note)
+          abbr_search = ransack_abbreviation_for(note_search, :notable_of_Person_type_name_eq)
+          note_search.send "#{abbr_search}=", 'Ernie'
+          note_search.notable_of_Person_type_name_eq.should eq 'Ernie'
+        end
+      end
+      context 'when sent valid attributes' do
+        before do
+          @search = Search.new(Person)
+        end
+      
+        it 'sets condition attributes' do
+          @search.name_eq = 'Ernie'
+          @search.name_eq.should eq 'Ernie'
+        end
       end
       
       it 'raises NoMethodError when sent an invalid attribute/abreviation' do

metadata

@@ -2,7 +2,7 @@
 name: ransack_abbreviator
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jamie Davidson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-03 00:00:00 Z
+date: 2013-02-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ransack