mongoid_query_string_interface 0.3.0 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid_query_string_interface (0.3.0)
+    mongoid_query_string_interface (0.4.0)
       json (>= 1.4.6)
       mongoid (~> 2.0.0.rc)
 

data/lib/mongoid/helpers.rb

@@ -0,0 +1,14 @@
+module Mongoid
+  module QueryStringInterface
+    module Helpers
+      def hash_with_indifferent_access(params)
+        params.is_a?(HashWithIndifferentAccess) ? params : params.with_indifferent_access
+      end
+
+      def replace_attribute(attribute, hash_with_attributes_to_replace)
+        hash = hash_with_indifferent_access(hash_with_attributes_to_replace)
+        hash.has_key?(attribute) ? hash[attribute] : attribute
+      end
+    end
+  end
+end

data/lib/mongoid/parsers/filter_parser.rb

@@ -10,6 +10,8 @@ module Mongoid
   module QueryStringInterface
     module Parsers
       class FilterParser
+        include Mongoid::QueryStringInterface::Helpers
+
         attr_reader :raw_attribute, :raw_value
 
         PARSERS = [
@@ -20,13 +22,14 @@ module Mongoid
           Mongoid::QueryStringInterface::Parsers::BooleanAndNilParser.new
         ]
 
-        def initialize(raw_attribute, raw_value)
+        def initialize(raw_attribute, raw_value, attributes_to_replace={})
           @raw_attribute = raw_attribute
           @raw_value = raw_value
+          @attributes_to_replace = attributes_to_replace
         end
 
         def attribute
-          @attribute ||= parsed_attribute
+          @attribute ||= replace_attribute(parsed_attribute, @attributes_to_replace).to_s
         end
 
         def value
@@ -120,7 +123,7 @@ module Mongoid
             raise "$or query filters must be given as an array of hashes" unless valid_or_filters?(raw_or_data)
 
             raw_or_data.map do |filters|
-              FiltersParser.new(filters)
+              FiltersParser.new(filters, {}, @attributes_to_replace)
             end
           end
 
@@ -146,4 +149,4 @@ module Mongoid
       end
     end
   end
-end
+end

data/lib/mongoid/parsers/filters_parser.rb

@@ -4,9 +4,10 @@ module Mongoid
       class FiltersParser
         attr_reader :filters, :default_filters
 
-        def initialize(filters, default_filters={})
+        def initialize(filters, default_filters={}, attributes_to_replace={})
           @filters = filters.with_indifferent_access
           @default_filters = default_filters.with_indifferent_access
+          @attributes_to_replace = attributes_to_replace.with_indifferent_access
         end
 
         def parse
@@ -15,7 +16,7 @@ module Mongoid
 
         def filter_parsers
           @filter_parsers ||= filters.map do |raw_attribute, raw_value|
-            FilterParser.new(raw_attribute, raw_value)
+            FilterParser.new(raw_attribute, raw_value, @attributes_to_replace)
           end
         end
 
@@ -65,4 +66,4 @@ module Mongoid
       end
     end
   end
-end
+end

data/lib/mongoid/query_string_interface.rb

@@ -1,8 +1,11 @@
+require File.expand_path(File.join('helpers'), File.dirname(__FILE__))
 require File.expand_path(File.join('parsers', 'filter_parser'), File.dirname(__FILE__))
 require File.expand_path(File.join('parsers', 'filters_parser'), File.dirname(__FILE__))
 
 module Mongoid
   module QueryStringInterface
+    include Mongoid::QueryStringInterface::Helpers
+
     NORMAL_CONDITIONAL_OPERATORS = [:exists, :gte, :gt, :lte, :lt, :ne, :size, :near, :within]
     ARRAY_CONDITIONAL_OPERATORS = [:all, :in, :nin]
     CONDITIONAL_OPERATORS = ARRAY_CONDITIONAL_OPERATORS + NORMAL_CONDITIONAL_OPERATORS
@@ -17,8 +20,9 @@ module Mongoid
     ORDER_BY_PARAMETER = :order_by
     PAGINATION_PARAMTERS = [:per_page, :page]
     FRAMEWORK_PARAMETERS = [:controller, :action, :format]
-    RESERVED_PARAMETERS = FRAMEWORK_PARAMETERS + PAGINATION_PARAMTERS + [ORDER_BY_PARAMETER]
-    
+    CONTROL_PARAMETERS = [:disable_default_filters]
+    RESERVED_PARAMETERS = FRAMEWORK_PARAMETERS + PAGINATION_PARAMTERS + [ORDER_BY_PARAMETER] + CONTROL_PARAMETERS
+
     def filter_by(params={})
       params = hash_with_indifferent_access(params)
       filter_only_and_order_by(params).paginate(pagination_options(params))
@@ -55,10 +59,10 @@ module Mongoid
 
     def paginated_collection_with_filter_by(params={})
       params = hash_with_indifferent_access(params)
-  
+
       pagination = pagination_options(params)
       pager = WillPaginate::Collection.new pagination[:page], pagination[:per_page], where(filtering_options(params)).count
-  
+
       PAGER_ATTRIBUTES.inject({}) do |result, attr|
         result[attr] = pager.send(attr)
         result
@@ -68,31 +72,30 @@ module Mongoid
     def default_filtering_options; {}; end
     def default_sorting_options; []; end
     def default_pagination_options; { :per_page => 12, :page => 1 }; end
+    def sorting_attributes_to_replace; {} end
+    def filtering_attributes_to_replace; {} end
 
     protected
       def pagination_options(options)
         hash_with_indifferent_access(default_pagination_options).merge(options)
       end
-  
+
       def filtering_options(options)
         Mongoid::QueryStringInterface::Parsers::FiltersParser.new(
           only_filtering(options),
-          default_filtering_options
+          options.has_key?(:disable_default_filters) ? {} : default_filtering_options,
+          filtering_attributes_to_replace
         ).parse
       end
-  
+
       def sorting_options(options)
         parse_order_by(options) || default_sorting_options
       end
-  
-      def hash_with_indifferent_access(params)
-        params.is_a?(HashWithIndifferentAccess) ? params : params.with_indifferent_access
-      end
-  
+
       def only_filtering(options)
         options.except(*RESERVED_PARAMETERS)
       end
-  
+
       def parse_order_by(options)
         if options.has_key?('order_by')
           options['order_by'].split('|').map do |field|
@@ -103,9 +106,9 @@ module Mongoid
 
       def sorting_operator_for(field)
         if match = field.match(/(.*)\.(#{SORTING_OPERATORS.join('|')})/)
-          match[1].to_sym.send(match[2])
+          replace_attribute(match[1], sorting_attributes_to_replace).to_sym.send(match[2])
         else
-          field.to_sym.asc
+          replace_attribute(field, sorting_attributes_to_replace).to_sym.asc
         end
       end
   end

data/lib/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid #:nodoc
   module QueryStringInterface #:nodoc
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
-end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Vicente Mundim
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 -03:00
+date: 2011-06-04 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,16 +88,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/version.rb
+- lib/mongoid_query_string_interface.rb
 - lib/mongoid/parsers/array_parser.rb
-- lib/mongoid/parsers/boolean_and_nil_parser.rb
 - lib/mongoid/parsers/date_time_parser.rb
-- lib/mongoid/parsers/filter_parser.rb
 - lib/mongoid/parsers/filters_parser.rb
 - lib/mongoid/parsers/number_parser.rb
+- lib/mongoid/parsers/filter_parser.rb
+- lib/mongoid/parsers/boolean_and_nil_parser.rb
 - lib/mongoid/parsers/regex_parser.rb
 - lib/mongoid/query_string_interface.rb
-- lib/mongoid_query_string_interface.rb
-- lib/version.rb
+- lib/mongoid/helpers.rb
 - MIT_LICENSE
 - README.rdoc
 - Gemfile