mongo-parser-rb 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo-parser-rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben McRedmond
+
+MIT License
+
+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.md

@@ -0,0 +1,56 @@
+# MongoParserRB
+
+Parse and evaluate MongoDB queries in Ruby. MongoParserRB is useful for checking if already loaded documents match a query, without the overhead of making requests to the database.
+
+Parse a query:
+
+```ruby
+q = MongoParserRB::Query.parse({:comment_count => 5})
+```
+
+Once a query has been parsed you can check if individual documents match a query:
+
+```ruby
+q.matches_document?({:comment_count => 4}) => false
+q.matches_document?({:comment_count => 5}) => true
+```
+
+You can use MongoDB's conditional operators, specify them as symbols:
+
+```ruby
+q = MongoParserRB::Query.parse({:comment_count => {:$gt => 5, :$lt => 10}})
+q.matches_document?({:comment_count => 11}) => false
+q.matches_document?({:comment_count => 6}) => true
+```
+
+The following operators are currently supported: `$and`, `$or`, `$in`, `$nin`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`.
+
+Regexps are also supported:
+
+```ruby
+q = MongoParserRB::Query.parse({:"email" => /gmail/})
+q.matches_document?({:email => "ben@intercom.io"}) => false
+q.matches_document?({:email => "ciaran@gmail.com"}) => true
+```
+
+MongoDB's dot field syntax can be used:
+
+```ruby
+q = MongoParserRB::Query.parse({:"author.name" => "Ben"})
+q.matches_document?({:author => {:name => "Ciaran"}}) => false
+q.matches_document?({:author => {:name => "Ben"}}) => true
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongo-parser-rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo-parser-rb

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new("test") do |test|
+  test.libs << 'lib'
+  test.libs << 'test'
+
+  test.test_files = FileList['test/**/*_test.rb']
+  test.warning = false
+  test.verbose = true
+end

data/lib/mongo-parser-rb/exceptions.rb

@@ -0,0 +1,5 @@
+module MongoParserRB
+
+  class NotParsedError < StandardError; end
+
+end

data/lib/mongo-parser-rb/field.rb

@@ -0,0 +1,39 @@
+module MongoParserRB
+  class Field
+
+    def initialize(field)
+      @field = field
+      @field_parts = field.to_s.split('.')
+    end
+
+    def value_in_document(document)
+      document = stringify_keys(document)
+      @field_parts.reduce(document) do |value, field|
+        value[field]
+      end
+    rescue NoMethodError
+      nil
+    end
+
+    def in_document?(document)
+      document = stringify_keys(document)
+
+      @field_parts.reduce(document) do |value, field|
+        return false unless value.has_key?(field)
+        value[field]
+      end
+
+      true
+    end
+
+    private
+
+    def stringify_keys(document)
+      document.reduce({}) do |new_document, (k,v)|
+        new_document[k.to_s] = v.kind_of?(Hash) ? stringify_keys(v) : v
+        new_document
+      end
+    end
+
+  end
+end

data/lib/mongo-parser-rb/query/expression.rb

@@ -0,0 +1,126 @@
+module MongoParserRB
+  class Query
+    class Expression
+
+      class << self
+
+        def conjunction_operators
+          @conjunction_operators ||= [
+            :$and, 
+            :$or
+          ]
+        end
+
+        def conjunction_operator?(operator)
+          conjunction_operators.include?(operator) 
+        end
+
+        def negative_equality_operators
+          @negative_equality_operators ||= [
+            :$nin,
+            :$ne
+          ]
+        end
+
+        def equality_operators
+          @equality_operators ||= [
+            :$eq,
+            :$gt,
+            :$lt,
+            :$gte,
+            :$lte,
+            :$in
+          ] | negative_equality_operators
+        end
+
+        def equality_operator?(operator)
+          equality_operators.include?(operator)
+        end
+
+        def operator?(operator)
+          equality_operator?(operator) || conjunction_operator?(operator)
+        end
+
+      end
+
+      def initialize(operator, *args)
+        @operator = operator
+
+        if Expression.conjunction_operator? @operator
+          @arguments = args[0] 
+        else
+          @field = Field.new(args[0])
+          @arguments = args[1]
+        end
+      end
+
+      def evaluate(document)
+        case @operator
+        when *Expression.conjunction_operators
+          evaluate_conjunction(document)
+        when *Expression.negative_equality_operators
+          evaluate_negative_equality(document)
+        when *Expression.equality_operators
+          evaluate_equality(document)
+        end
+      rescue NoMethodError
+        false
+      end
+
+      private
+
+      def evaluate_conjunction(document)
+        case @operator
+        when :$and
+          @arguments.all? do |arg|
+            arg.evaluate(document)
+          end
+        when :$or
+          @arguments.any? do |arg|
+            arg.evaluate(document)
+          end
+        end
+      end
+
+      def evaluate_negative_equality(document)
+        value_for_field = @field.value_in_document(document)
+
+        # Mongo negative equality operators return true when
+        # the specified field does not exist on a document.
+        return true if !value_for_field && !@field.in_document?(document)
+
+        case @operator
+        when :$ne
+          value_for_field != @arguments
+        when :$nin
+          (value_for_field & @arguments).length.zero?
+        end
+      end
+
+      def evaluate_equality(document)
+        value_for_field = @field.value_in_document(document)
+        return false if !value_for_field && !@field.in_document?(document)
+
+        case @operator
+        when :$eq
+          if @arguments.kind_of?(Regexp)
+            !!(value_for_field =~ @arguments)
+          else
+            value_for_field == @arguments
+          end
+        when :$gt
+          value_for_field > @arguments
+        when :$gte
+          value_for_field >= @arguments
+        when :$lt
+          value_for_field < @arguments
+        when :$lte
+          value_for_field <= @arguments
+        when :$in
+          (value_for_field & @arguments).length > 0
+        end
+      end
+
+    end
+  end
+end

data/lib/mongo-parser-rb/query.rb

@@ -0,0 +1,46 @@
+module MongoParserRB
+  class Query
+
+    def self.parse(raw_query)
+      new(raw_query).parse!
+    end
+
+    def initialize(raw_query)
+      @raw_query = raw_query
+    end
+
+    def parse!
+      @expression_tree = parse_root_expression(@raw_query)
+      self
+    end
+
+    def matches_document?(document)
+      raise NotParsedError, "Query not parsed (run parse!)" if @expression_tree.nil?
+      @expression_tree.evaluate(document)
+    end
+    
+    private
+
+    def parse_root_expression(query, field = nil)
+      Expression.new(:$and, query.to_a.map do |(key, value)|
+        parse_sub_expression(key, value, field)
+      end)
+    end
+    
+    def parse_sub_expression(key, value, field = nil)
+      if Expression.operator?(key)
+        case key 
+        when *Expression.conjunction_operators
+          Expression.new(key, value.map { |v| parse_root_expression(v) })
+        else
+          Expression.new(key, field, value)
+        end
+      elsif value.kind_of?(Hash)
+        parse_root_expression(value, key)
+      else
+        Expression.new(:$eq, key, value)
+      end
+    end
+
+  end
+end

data/lib/mongo-parser-rb/version.rb

@@ -0,0 +1,3 @@
+module MongoParserRB
+  VERSION = "0.0.1"
+end

data/lib/mongo-parser-rb.rb

@@ -0,0 +1,8 @@
+require "mongo-parser-rb/version"
+require "mongo-parser-rb/exceptions"
+require "mongo-parser-rb/field"
+require "mongo-parser-rb/query/expression"
+require "mongo-parser-rb/query"
+
+module MongoParserRB
+end

data/mongo-parser-rb.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo-parser-rb/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongo-parser-rb"
+  gem.version       = MongoParserRB::VERSION
+  gem.authors       = ["Ben McRedmond"]
+  gem.email         = ["ben@intercom.io"]
+  gem.description   = %q{Parse and evaluate mongo queries in Ruby}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/test/mongo-parser-rb/field_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class FieldTest < MiniTest::Unit::TestCase
+
+  def test_returns_value_when_key_present
+    field = MongoParserRB::Field.new(:"custom_data.tracked_users")
+    assert_equal 10, field.value_in_document(:custom_data => {:tracked_users => 10})
+  end
+
+  def test_returns_nil_when_key_not_present
+    field = MongoParserRB::Field.new(:"custom_data.tracked_users")
+    assert_nil field.value_in_document(:custom_data => {:something_else => 10})
+    assert_nil field.value_in_document(:name => "Ben")
+  end
+
+  def test_document_has_a_field
+    field = MongoParserRB::Field.new(:"custom_data.tracked_users")
+    assert field.in_document?(:custom_data => {:tracked_users => 10})
+    refute field.in_document?(:not_custom_data => {:tracked_users => 10})
+
+    field = MongoParserRB::Field.new(:"session_count")
+    assert field.in_document?(:custom_data => {:tracked_users => 10}, :session_count => 5)
+    refute field.in_document?(:custom_data => {:tracked_users => 10})
+  end
+
+end

data/test/mongo-parser-rb/query_test.rb

@@ -0,0 +1,152 @@
+require 'test_helper'
+
+class QueryTest < MiniTest::Unit::TestCase
+
+  def test_raises_if_not_parsed
+    assert_raises(MongoParserRB::NotParsedError) do
+      query = MongoParserRB::Query.new(:integer_key => 10)
+      query.matches_document?({})
+    end
+  end
+
+  def test_integer_eq
+    query = MongoParserRB::Query.parse(:integer_key => 10)
+    assert query.matches_document?(:integer_key => 10)
+    refute query.matches_document?(:integer_key => 9)
+  end
+
+  def test_integer_ne
+    query = MongoParserRB::Query.parse(:integer_key => {:$ne => 10})
+    assert query.matches_document?(:integer_key => 9)
+    refute query.matches_document?(:integer_key => 10)
+  end
+
+  def test_integer_gt
+    query = MongoParserRB::Query.parse(:integer_key => {:$gt => 10})
+    assert query.matches_document?(:integer_key => 11)
+    refute query.matches_document?(:integer_key => 10)
+    refute query.matches_document?(:integer_key => 9)
+  end
+
+  def test_integer_lt
+    query = MongoParserRB::Query.parse(:integer_key => {:$lt => 10})
+    query.matches_document?(:integer_key => 9)
+    query.matches_document?(:integer_key => 10)
+    query.matches_document?(:integer_key => 11)
+  end
+
+  def test_integer_lte
+    query = MongoParserRB::Query.parse(:integer_key => {:$lte => 10})
+    assert query.matches_document?(:integer_key => 9)
+    assert query.matches_document?(:integer_key => 10)
+    refute query.matches_document?(:integer_key => 11)
+  end
+
+ def test_integer_gte
+    query = MongoParserRB::Query.parse(:integer_key => {:$lte => 10})
+    assert query.matches_document?(:integer_key => 9)
+    assert query.matches_document?(:integer_key => 10)
+    refute query.matches_document?(:integer_key => 11)
+  end
+
+  def test_integer_lte_and_integer_gt
+    query = MongoParserRB::Query.parse(:integer_key => {:$lte => 10}, :integer_key_2 => {:$gt => 5})
+    assert query.matches_document?(:integer_key => 9, :integer_key_2 => 6)
+    refute query.matches_document?(:integer_key => 9, :integer_key_2 => 4)
+    refute query.matches_document?(:integer_key => 11, :integer_key_2 => 4)
+  end
+
+  def test_string_eq
+    query = MongoParserRB::Query.parse(:string_key => "hello world")
+    assert query.matches_document?(:string_key => "hello world")
+    refute query.matches_document?(:string_key => 1)
+    refute query.matches_document?(:string_key => "bye world")
+  end
+
+  def test_string_gt
+    query = MongoParserRB::Query.parse(:string_key => {:$gt => 'abc'})
+    assert query.matches_document?(:string_key => "abcd")
+    assert query.matches_document?(:string_key => "e")
+    refute query.matches_document?(:string_key => "abc")
+  end
+
+  def test_string_lt
+    query = MongoParserRB::Query.parse(:string_key => {:$lt => 'm'})
+    assert query.matches_document?(:string_key => "abc")
+    refute query.matches_document?(:string_key => "xyz")
+  end
+
+  def test_string_and_integer_equality
+    query = MongoParserRB::Query.parse(:string_key => {:$lt => 'm'}, :integer_key => {:$gt => 4})
+    assert query.matches_document?(:string_key => "abc", :integer_key => 5)
+    refute query.matches_document?(:string_key => "xyz", :integer_key => 5)
+    refute query.matches_document?(:string_key => "abc", :integer_key => 4)
+  end
+
+
+  def test_or
+    query = MongoParserRB::Query.parse(:$or => [ 
+      {:string_key => "abc"},
+      {:integer_key => {:$gt => 5}}
+    ])
+
+    assert query.matches_document?(:string_key => "abc")
+    refute query.matches_document?(:string_key => "cde")
+    assert query.matches_document?(:string_key => "cde", :integer_key => 6)
+    assert query.matches_document?(:string_key => "abc", :integer_key => 6)
+    assert query.matches_document?(:integer_key => 6)
+    refute query.matches_document?(:integer_key => 5)
+  end
+
+  def test_boolean_eq
+    query = MongoParserRB::Query.parse(:boolean_key => false)
+    assert query.matches_document?(:boolean_key => false)
+    refute query.matches_document?(:boolean_key => true)
+  end
+
+  def test_query_field_integration
+    query = MongoParserRB::Query.parse(:"custom_data.tracked_users" => {:$gt => 3})
+    assert query.matches_document?(:custom_data => {:tracked_users => 10})
+    refute query.matches_document?(:custom_data => {:tracked_users => 1})
+  end
+
+  def test_array_in
+    query = MongoParserRB::Query.parse(:array_key => {:$in => [1]})
+    assert query.matches_document?(:array_key => [1,2])
+    refute query.matches_document?(:array_key => [2,3])
+  end
+
+  def test_array_nin
+    query = MongoParserRB::Query.parse(:array_key => {:$nin => [1,2]})
+    assert query.matches_document?(:array_key => [3,4,5])
+    refute query.matches_document?(:array_key => [1,4,5])
+  end
+
+  def test_eq_nil
+    query = MongoParserRB::Query.parse(:string_key => nil)
+    assert query.matches_document?(:string_key => nil)
+    refute query.matches_document?(:string_key => 'hey')
+  end
+
+  def test_regex_eq
+    query = MongoParserRB::Query.parse(:string_key => /hello/)
+    assert query.matches_document?(:string_key => 'hello world')
+    refute query.matches_document?(:string_key => 'world')
+  end
+
+  def test_operator_data_type_mismatch
+    query = MongoParserRB::Query.parse(:array_key => {:$in => [1]})
+    refute query.matches_document?(:array_key => "hey")
+  end
+
+  def test_date_range
+    query = MongoParserRB::Query.parse(:date_key => {:$gt => Time.new(1993,2,13,0,0,0)})
+    assert query.matches_document?(:date_key => Time.new(1994,2,13,0,0,0))
+    refute query.matches_document?(:date_key => Time.new(1992,2,13,0,0,0))
+
+    query = MongoParserRB::Query.parse(:date_key => {:$gt => Time.new(1993,2,13,0,0,0), :$lt => Time.new(1995,2,13,0,0,0)})
+    assert query.matches_document?(:date_key => Time.new(1994,2,13,0,0,0))
+    refute query.matches_document?(:date_key => Time.new(1996,2,13,0,0,0))
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'mongo-parser-rb'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: mongo-parser-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben McRedmond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-27 00:00:00.000000000 Z
+dependencies: []
+description: Parse and evaluate mongo queries in Ruby
+email:
+- ben@intercom.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongo-parser-rb.rb
+- lib/mongo-parser-rb/exceptions.rb
+- lib/mongo-parser-rb/field.rb
+- lib/mongo-parser-rb/query.rb
+- lib/mongo-parser-rb/query/expression.rb
+- lib/mongo-parser-rb/version.rb
+- mongo-parser-rb.gemspec
+- test/mongo-parser-rb/field_test.rb
+- test/mongo-parser-rb/query_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Parse and evaluate mongo queries in Ruby
+test_files:
+- test/mongo-parser-rb/field_test.rb
+- test/mongo-parser-rb/query_test.rb
+- test/test_helper.rb
+has_rdoc: