mongoid_query_string_interface 0.1.0

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Vicente Mundim
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,83 @@
+= Overview
+
+== About Mongoid::QueryStringInterace
+
+Gives a method that can parse query string parameters into a set of criterias
+that Mongoid can use to perform actual queries in MongoDB databases for a given
+model.
+
+== Repository
+
+http://github.com/vicentemundim/mongoid-query-string-interface
+
+= Installing
+
+This is a gem, so you can install it by:
+
+  sudo gem install mongoid_query_string_interface
+
+Or, if you are using rails, put this in your Gemfile:
+
+  gem 'mongoid_query_string_interface'
+
+= Usage
+
+To use it, just extend Mongoid::QueryStringInterface in your document model:
+
+  class Document
+		include Mongoid::Document
+		extend Mongoid::QueryInterfaceString
+		
+		# ... add fields here
+	end
+	
+Then, in your controllers put:
+
+  def index
+  	@documents = Document.filter_by(params)
+  	# ... do something like render a HTML template or a XML/JSON view of documents
+	end
+
+That's it! Now you can do something like this:
+
+	http://myhost.com/documents?tags.all=ruby|rails|mongodb&tags.nin=sql|java&updated_at.gt=2010-01-01&created_at.desc&per_page=10&page=3
+	
+This would get all documents which have the tags 'ruby', 'rails' and 'mongo',
+and that don't have both 'sql' and 'java' tags, and that were updated after
+2010-01-01, ordered by descending created_at. It will return 10 elements per
+page, and the 3rd page of results.
+
+You could even query for embedded documents, and use any of the Mongodb
+conditional operators:
+
+	http://myhost.com/documents?comments.author=Shrek
+	
+Which would get all documents that have been commented by 'Shrek'. Basically,
+any valid path that you can use in a Mongoid::Criteria can be used here, and
+you can also append any of the Mongodb conditional operators.
+
+You can sort results like this:
+
+  http://myhost.com/documents?order_by=created_at.desc
+
+or
+
+  http://myhost.com/documents?order_by=created_at
+
+Which is the same as:
+
+  http://myhost.com/documents?order_by=created_at.asc
+
+To order by more than one field:
+
+  http://myhost.com/documents?created_at.desc&updated_at.desc
+
+Or even:
+
+  http://myhost.com/documents?created_at=desc&updated_at=desc
+
+Check the specs for more use cases.
+
+= Credits
+
+Vicente Mundim: vicente.mundim at gmail dot com

data/lib/mongoid_query_string_interface.rb

@@ -0,0 +1,175 @@
+module Mongoid
+  module QueryStringInterface
+    CONDITIONAL_OPERATORS = [:all, :exists, :gte, :gt, :in, :lte, :lt, :ne, :nin, :size, :near, :within]
+    ARRAY_CONDITIONAL_OPERATORS = [:all, :in, :nin]
+    SORTING_OPERATORS = [:asc, :desc]
+
+    def filter_by(params={})
+      params = hash_with_indifferent_access(params)
+      where(filtering_options(params)).order_by(*sorting_options(params)).paginate(pagination_options(params))
+    end
+
+    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
+  
+      [:total_entries, :total_pages, :per_page, :offset, :previous_page, :current_page, :next_page].inject({}) do |result, attr|
+        result[attr] = pager.send(attr)
+        result
+      end
+    end
+
+    def default_filtering_options
+      {}
+    end
+
+    def default_sorting_options
+      []
+    end
+
+    private
+      def pagination_options(options)
+        options.reverse_merge :per_page => 12, :page => 1
+      end
+  
+      def filtering_options(options)
+        default_filtering_options.merge(parse_operators(only_filtering(options)))
+      end
+  
+      def sorting_options(options)
+        options = only_sorting(options)
+
+        sorting_options = []
+        sorting_options.concat(parse_order_by(options))
+        sorting_options.concat(parse_sorting(options))      
+    
+        sorting_options.empty? ? default_sorting_options : sorting_options
+      end
+  
+      def parse_operators(options)
+        options.inject({}) do |result, item|
+          key, value = item
+      
+          attribute = attribute_from(key)
+          operator = operator_from(key)
+          value = parse_value(value, operator)
+
+          if operator
+            filter = { operator => value }
+
+            if result.has_key?(attribute)
+              result[attribute].merge!(filter)
+            else
+              result[attribute] = filter
+            end
+          else
+            result[attribute] = value
+          end
+      
+          result
+        end
+      end
+  
+      def attribute_from(key)
+        if match = key.match(/(.*)\.(#{(CONDITIONAL_OPERATORS + SORTING_OPERATORS).join('|')})/)
+          match[1].to_sym
+        else
+          key.to_sym
+        end
+      end
+  
+      def operator_from(key)
+        if match = key.match(/.*\.(#{CONDITIONAL_OPERATORS.join('|')})/)
+          "$#{match[1]}".to_sym
+        end
+      end
+  
+      def parse_value(value, operator)
+        parse_date(value) or parse_integer(value) or parse_array(value, operator) or value
+      end
+  
+      def parse_date(date)
+        date.to_time and Time.parse(date)
+      rescue Exception
+        nil
+      end
+  
+      def parse_integer(integer)
+        if match = integer.match(/\d+/)
+          match[0].to_i
+        end
+      end
+  
+      def parse_float(float)
+        if match = float.match(/^(\d+)(\.?\d*)$/)
+          match[0].to_f
+        end
+      end
+  
+      def parse_array(value, operator)
+        split_and_strip(value) if array_operator?(operator)
+      end
+  
+      def array_operator?(operator)
+        ARRAY_CONDITIONAL_OPERATORS.map { |op| "$#{op}" }.include?(operator.to_s)
+      end
+  
+      def split_and_strip(values)
+        values.split('|').map(&:strip)
+      end
+  
+      def hash_with_indifferent_access(params)
+        params.is_a?(HashWithIndifferentAccess) ? params : HashWithIndifferentAccess.new(params)
+      end
+  
+      def only_filtering(options)
+        options.except(*only_sorting(options).keys).except(:per_page, :page, :action, :controller, :format, :order_by)
+      end
+  
+      def only_sorting(options)
+        options.inject({}) do |result, item|
+          key, value = item
+          result[key] = value if sorting_parameter?(key, value)
+          result
+        end
+      end
+  
+      def sorting_parameter?(key, value)
+        key.to_s == 'order_by' or key.match(/(.*)\.(#{SORTING_OPERATORS.join('|')})/) or SORTING_OPERATORS.include?(value.to_sym) 
+      end
+  
+      def parse_order_by(options)
+        sorting_options = []
+    
+        if order_by = options.delete('order_by')
+          if match = order_by.match(/(.*)\.(#{SORTING_OPERATORS.join('|')})/)
+            sorting_options << match[1].to_sym.send(match[2])
+          else
+            sorting_options << order_by.to_sym.asc
+          end
+        end
+    
+        sorting_options
+      end
+  
+      def parse_sorting(options)
+        options.inject([]) do |result, item|
+          key, value = item
+      
+          attribute = attribute_from(key)
+          sorting_operator = sorting_operator_from(key)
+
+          result << attribute.send(sorting_operator || value)        
+          result
+        end
+      end
+  
+      def sorting_operator_from(key)
+        if match = key.match(/.*\.(#{SORTING_OPERATORS.join('|')})/)
+          match[1].to_sym
+        end
+      end
+  end
+end

data/lib/version.rb

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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_query_string_interface
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Vicente Mundim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-22 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31098209
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        version: 2.0.0.beta
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31098209
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        version: 2.0.0.beta
+  type: :development
+  version_requirements: *id002
+description: Gives a method that can parse query string parameters into a set of criterias that Mongoid can use to perform actual queries in MongoDB databases for a given model.
+email: 
+- vicente.mundim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongoid_query_string_interface.rb
+- lib/version.rb
+- MIT_LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/vicentemundim/mongoid_query_string_interface
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: mongoid_query_string_interface
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An interface for performing queries in MongoDB using query string parameters.
+test_files: []
+