mongoid_ruby_or 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Ary Djmal
+
+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,93 @@
+# mongoid_ruby_or
+
+This gem hijacks the $or operator, doing one query per $or clause, merging the results with plain ruby.
+
+## Background
+
+**WARNING:** understand what this code does before using (it's only ~20 LOC!)
+
+MongoDB is not the smartest when using indexes for the $or operator.
+
+This is my case:
+
+```ruby
+class Brand
+  include Mongoid::Document
+
+  field :name, type: String
+
+  has_many :resources
+end
+
+class Resource
+  include Mongoid::Document
+
+  field :name,       type: String
+  field :content_id, type: String
+
+  index({ brand_id: 1, name: 1 })
+  index({ brand_id: 1, content_id: 1 })
+
+  belongs_to :brand
+end
+
+```
+
+Given the above indexes, I do queries like:
+
+```ruby
+brand.resources                           # will use index
+brand.resources.where(name: 'test')       # will use index
+brand.resources.where(content_id: 'test') # will use index
+
+```
+
+The problem comes when using the $or operator:
+
+```ruby
+brand.resources.or({name: 'test'}, {content_id: 'test'}) # will do a full scan
+```
+
+Unfortunately, it will not use an index unless it starts with the field from the $or's. In order to have indexes that satisfies that query and the ones from above we will need something like:
+
+```ruby
+index({ brand_id: 1 })
+index({ name: 1, brand_id: 1 })
+index({ content_id: 1, brand_id: 1 })
+
+```
+
+So in this simpliefied case, we will need to add an extra index.
+
+Sometimes is not worth it, maybe that query is not use very often to justify the necessity to maintain the index, or you are trying to cut back on indexes for that collection.
+
+This gem will add a #ruby_or method to the Mongoid::Criteria class, and do a query for each $or clause and then merge in ruby.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem :mongoid_ruby_or
+```
+
+## Usage
+
+Using the same example from above:
+
+```ruby
+# problematic query, will be slow as it will do a full scan
+brand.resources.or({name: /^test/}, {content_id: /^test/}).limit(10)
+```
+
+```ruby
+# this will do two fast queries and patch them together
+brand.resources.or({name: /^test/}, {content_id: /^test/}).limit(10).ruby_or
+```
+
+## Some observations
+
+ * **built for a system running ruby 1.9.3, rails 3.2, mongo 2.6.3, and mongoid 3.1.6**, may not be an issue in the future
+ * tested for simple $or clauses
+ * can't do count for obvious reasons
+ * ruby_or will cut the criteria chain and get results as soon as invoked, so use at the end

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mongoid_ruby_or gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/mongoid_ruby_or.rb

@@ -0,0 +1,37 @@
+module Mongoid
+  class Criteria
+    def ruby_or
+      selector   = self.selector
+      or_clauses = selector.delete('$or')
+      limit      = options[:limit]
+      sort       = options[:sort]
+      criteria   = klass.where(selector).limit(limit)
+      results    = []
+
+      or_clauses.each do |or_clause|
+        results += criteria.where(or_clause).sort(sort).to_a
+      end
+
+      results.uniq!
+
+      if sort
+        field, direction = sort.first
+        if direction == 1
+          results.sort! { |x,y| x[field] <=> y[field] }
+        else
+          results.sort! { |x,y| y[field] <=> x[field] }
+        end
+      end
+
+      limit ? results[0...limit] : results
+    end
+  end
+
+  module Contextual
+    class Mongo
+      def ruby_or
+        criteria.ruby_or
+      end
+    end
+  end
+end

data/mongoid_ruby_or.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'mongoid_ruby_or'
+  s.version     = '0.1.0'
+  s.authors     = ['Ary Djmal']
+  s.email       = ['arydjmal@gmail.com']
+  s.summary     = 'This gem hijacks the $or operator, doing one query per $or clause, merging the results with plain ruby.'
+  s.homepage    = 'http://github.com/arydjmal/mongoid_ruby_or'
+
+  s.add_dependency 'mongoid', '~> 3.1.6'
+
+  s.add_development_dependency 'rake'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/test/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid_ruby_or_test
+      hosts:
+        - localhost:27017

data/test/mongoid_ruby_or_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class MongoidRubyOrTest < Minitest::Test
+  def setup
+    Mongoid.purge!
+    User.create!(name: 'ary',    email: 'arydjmal@gmail.com', account_id: '1')
+    User.create!(name: 'aron',   email: 'xaron@gmail.com',    account_id: '1')
+    User.create!(name: 'xariel', email: 'arielx@gmail.com',   account_id: '1')
+    User.create!(name: 'djmal',  email: 'djmal@gmail.com',    account_id: '1')
+  end
+
+  def test_ruby_or
+    assert_criteria User.or({name: /^ar/},  {email: /^ar/})
+    assert_criteria User.or({name: /^ary/}, {email: /^ary/})
+    assert_criteria User.or({name: /^xxx/}, {email: /^xxx/})
+  end
+
+  def test_limit
+    assert_criteria User.or({name: /^ar/}, {email: /^ar/}).limit(2)
+  end
+
+  def test_sort
+    assert_criteria User.or({name: /^ar/}, {email: /^ar/}).asc(:name)
+  end
+
+  def test_limit_and_sort
+    assert_criteria User.or({name: /^ar/}, {email: /^ar/}).limit(2).asc(:name)
+  end
+
+  def test_scoped_selector
+    assert_criteria User.where(account_id: '1').or({name: /^ar/}, {email: /^ar/}).limit(2).asc(:name)
+  end
+
+  def test_when_on_contextual
+    assert_criteria User.or({name: /^ar/}, {email: /^ar/}).sort(name: 1)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'minitest'
+require 'minitest/autorun'
+require 'mongoid'
+require 'mongoid_ruby_or'
+
+Mongoid.load!('test/mongoid.yml', :test)
+
+class User
+  include Mongoid::Document
+
+  field :name,       type: String
+  field :email,      type: String
+  field :account_id, type: String
+end
+
+def assert_criteria(criteria)
+  assert_equal criteria.to_a, criteria.ruby_or
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_ruby_or
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ary Djmal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- arydjmal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/mongoid_ruby_or.rb
+- ./MIT-LICENSE
+- ./mongoid_ruby_or.gemspec
+- ./Rakefile
+- ./README.md
+- ./test/mongoid.yml
+- ./test/mongoid_ruby_or_test.rb
+- ./test/test_helper.rb
+homepage: http://github.com/arydjmal/mongoid_ruby_or
+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.23
+signing_key: 
+specification_version: 3
+summary: This gem hijacks the $or operator, doing one query per $or clause, merging
+  the results with plain ruby.
+test_files: []
+has_rdoc: