mongo_db 0.1.4 → 0.1.5

data/lib/mongo_db/driver/core/collection.rb

@@ -11,6 +11,9 @@ module Mongo::Ext::Collection
   end
   
   def update_with_ext selector, document, opts = {}
+    selector = convert_underscore_to_dollar_in_selector selector
+    document = convert_underscore_to_dollar_in_update document
+    
     # because :multi works only with $ operators, we need to check it
     opts = if document.keys.any?{|k| k =~ /^\$/}      
       reverse_merge_defaults(opts, :safe, :multi)
@@ -22,6 +25,7 @@ module Mongo::Ext::Collection
   end
 
   def remove_with_ext selector = {}, opts = {}
+    selector = convert_underscore_to_dollar_in_selector selector
     remove_without_ext selector, reverse_merge_defaults(opts, :safe, :multi)
   end
 
@@ -32,9 +36,12 @@ module Mongo::Ext::Collection
   # 
   # Querying
   # 
-  def first *args
-    o = find_one *args
-    ::Mongo::Ext::HashHelper.unmarshal o
+  def first spec_or_object_id = nil, opts = {}
+    spec_or_object_id = convert_underscore_to_dollar_in_selector spec_or_object_id if spec_or_object_id.is_a? Hash
+        
+    o = find_one spec_or_object_id, opts
+    o = ::Mongo::Ext::HashHelper.symbolize o if Mongo.defaults[:symbolize]
+    o
   end
   
   def all *args, &block
@@ -48,11 +55,13 @@ module Mongo::Ext::Collection
   end
   
   def each selector = {}, opts = {}, &block
+    selector = convert_underscore_to_dollar_in_selector selector
+    
     cursor = nil
     begin
       cursor = find selector, reverse_merge_defaults(opts, :batch_size)
       cursor.each do |o|
-        o = ::Mongo::Ext::HashHelper.unmarshal o
+        o = ::Mongo::Ext::HashHelper.symbolize o if Mongo.defaults[:symbolize]
         block.call o
       end
       nil
@@ -62,6 +71,20 @@ module Mongo::Ext::Collection
   end
   
   protected
+    def convert_underscore_to_dollar_in_selector selector
+      if Mongo.defaults[:convert_underscore_to_dollar]
+        selector = ::Mongo::Ext::HashHelper.convert_underscore_to_dollar_in_selector selector
+      end
+      selector
+    end
+    
+    def convert_underscore_to_dollar_in_update update
+      if Mongo.defaults[:convert_underscore_to_dollar]
+        update = ::Mongo::Ext::HashHelper.convert_underscore_to_dollar_in_selector update
+      end
+      update
+    end
+  
     def reverse_merge_defaults opts, *keys
       h = opts.clone
       keys.each do |k|

data/lib/mongo_db/driver/core/hash_helper.rb

@@ -11,21 +11,54 @@ class Mongo::Ext::HashHelper
   #   Date, DateTime,
   #   BSON::ObjectId
   # ].to_set
+  
+  QUERY_KEYWORDS = [
+    :_lt, :_lte, :_gt, :_gte, 
+    :_all, :_exists, :_mod, :_ne, :_in, :_nin,
+    :_nor, :_or, :_and, 
+    :_size, :_type
+  ].to_set
+  
+  UPDATE_KEYWORDS = [
+    :_inc, :_set, :_unset, :_push, :_pushAll, :_addToSet, :_pop, :_pull, :_pullAll, :_rename, :_bit
+  ].to_set
 
   class << self
     # symbolizing hashes
-    def unmarshal o
-      return o unless Mongo.defaults[:symbolize]
-      
+    def symbolize o
+      convert o do |k, v, result|
+        k = k.to_sym if k.is_a? String
+        result[k] = v
+      end
+    end
+    
+    # replaces :_lt to :$lt in query    
+    def convert_underscore_to_dollar_in_selector selector
+      convert selector do |k, v, result|
+        k = "$#{k.to_s[1..-1]}".to_sym if QUERY_KEYWORDS.include?(k)
+        result[k] = v
+      end
+    end
+    
+    # replaces :_set to :$set in query    
+    def convert_underscore_to_dollar_in_update update
+      convert update do |k, v, result|
+        k = "$#{k.to_s[1..-1]}".to_sym if UPDATE_KEYWORDS.include?(k)
+        result[k] = v
+      end
+    end
+
+    # converts hashes (also works with nested & arrays)
+    def convert o, &block
       if o.is_a? Hash
-        h = {}
+        result = {}
         o.each do |k, v|
-          k = k.to_sym if k.is_a?(String)
-          h[k] = unmarshal v
+          v = convert v, &block
+          block.call k, v, result
         end
-        h
+        result
       elsif o.is_a? Array
-        o.collect{|v| unmarshal v}
+        o.collect{|v| convert v, &block}
       else        
         o
       end

data/lib/mongo_db/driver/more/collection.rb

@@ -12,6 +12,10 @@ module Mongo::Ext::Collection
   end
   alias_method :by_id!, :first_by_id!
   
+  def where &block
+    Mongo::Ext::Query.new self, &block
+  end
+  
   protected
     # 
     # first_by_field, all_by_field

data/lib/mongo_db/driver/more.rb

@@ -4,10 +4,4 @@ class Mongo::NotFound < StandardError; end
 
 %w(
   collection
-).each{|f| require "mongo_db/driver/more/#{f}"}
-
-Mongo.defaults.merge! \
-  symbolize:   true,
-  batch_size:  50,
-  multi:       true,
-  safe:        true
+).each{|f| require "mongo_db/driver/more/#{f}"}

data/lib/old/query.rb

@@ -0,0 +1,91 @@
+class Mongo::Ext::Query  
+  class Dsl < BasicObject
+    class Statement < ::Array      
+      def add_to hash
+        operator, value = self[-2, -1]
+        path = self[0..-3]
+                
+        current = hash
+        path.each_with_index do |key, index|
+          if index == path.size - 1
+            raise "dupliate key :#{key}!" if current.include? key
+            current[key] = value
+          else
+            raise "dupliate key :#{key}!" if current.include?(key) and !current[key].is_a?(Hash)
+            current[key] ||= {}
+            current = current[key]
+          end
+        end
+        nil
+      end
+    end
+    
+    def initialize &block
+      @statements = [Statement.new]
+      block.call self
+      statements.pop if statements.last.empty?
+    end
+    
+    {
+      :== => :==,
+      :!= => :$ne,
+      :<  => :$lt,
+      :<= => :$lte,
+      :>  => :$gt,
+      :>= => :$gte,
+    }.each do |ruby, mongo|
+      define_method ruby do |arg|
+        emit mongo
+        emit arg, true
+      end
+    end
+    
+    def to_hash
+      h = {}
+      statements.each{|s| h.add_to h}
+      h
+    end
+      
+    protected
+      attr_reader :statements
+    
+      def emit statement = nil, terminate = false
+        statements.last << statement if statement
+        statements << Statement.new if terminate
+        nil
+      end
+      
+      def method_missing m, *args, &block
+        raise "invalid usage, there can be only one argument (#{args})!" if args.size > 1
+                
+        if args.empty?
+          emit m
+          self
+        else
+          emit m
+          emit args.first, true
+        end
+      end
+      
+      def p *args
+        ::Kernel.p *args
+      end
+  end
+  
+  def initialize collection, &block
+    @collection = collection
+    @hash_query = Dsl.new(&block).to_hash
+  end
+  
+  def first
+    collection.first to_hash
+  end
+  
+  def all &block
+    collection.first to_hash, &block
+  end
+  alias_method :each, :all
+  
+  protected
+    attr_reader :collection, :hash_query
+end

data/lib/old/query_spec.rb

@@ -0,0 +1,77 @@
+require 'driver/spec_helper'
+
+describe "Query" do  
+  dsl_class = Mongo::Ext::Query::Dsl
+  dsl_class.class_eval do
+    public :statements
+  end
+  
+  it "operators" do
+    value = :value
+    dsl_class.new do |o|
+      o.key ==     value
+      o.key !=     value
+      o.key <      value
+      o.key <=     value
+      o.key >      value
+      o.key >=     value      
+      o.key.all    value
+      o.key.exists true
+      o.key.mod    value
+      o.key.in     value
+      o.key.nin    value
+      o.key.size   value
+      o.key.type   value
+    end.statements.should == [
+      [:key, :==,     :value],
+      [:key, :$ne,    :value],
+      [:key, :$lt,    :value],
+      [:key, :$lte,   :value],
+      [:key, :$gt,    :value],
+      [:key, :$gte,   :value],
+      [:key, :all,    :value],
+      [:key, :exists, true],
+      [:key, :mod,    :value],
+      [:key, :in,     :value],
+      [:key, :nin,    :value],
+      [:key, :size,   :value],
+      [:key, :type,   :value]
+    ]
+  end
+  
+  it ":nor, :or, :and"
+  
+  describe "statement" do
+    def process_statement *args
+      s = Mongo::Ext::Query::Dsl::Statement.new
+      s.push *args
+      result = {}
+      s.add_to result
+      result
+    end
+    
+    it "basics", focus: true do
+      p process_statement(:age, :$gt, 34)
+    end
+  end
+  
+  # it "to_hash" do
+  #   dsl.new do |o|
+  #     # o.name == 'Jim'
+  #     o.age  >  34
+  #   end.to_hash.should == {
+  #     # name: 'Jim',
+  #     :$gt => {age:  34}
+  #   }
+  # end
+  # 
+  # it do
+  #   dsl.new do |unit|
+  #     unit.name == 'Zeratul'
+  #     unit.stats.life > 100
+  #     unit.stats.attack != 0
+  #   end.statement.should == {
+  #     name: 1
+  #   }
+  # end
+end

data/readme.md

@@ -14,6 +14,9 @@ Note: By default it also adds a little magic and alters some default values of s
 ``` ruby
 require 'mongo_db/driver'
 
+# changing some defaults
+Mongo.defaults.merge! symbolize: true, multi: true, safe: true
+
 # connection & db
 connection = Mongo::Connection.new
 db = connection.db 'default_test'
@@ -41,9 +44,19 @@ Optionall stuff:
 
 ``` ruby
 # simple finders (bang versions also availiable)
-db.units.by_name 'Zeratul'                          # => zeratul
-db.units.first_by_name 'Zeratul'                    # => zeratul
-db.units.all_by_name 'Zeratul'                      # => [zeratul]
+db.units.by_name 'Zeratul'                         # => zeratul
+db.units.first_by_name 'Zeratul'                   # => zeratul
+db.units.all_by_name 'Zeratul'                     # => [zeratul]
+
+# query sugar, use {life: {_lt: 100}} instead of {life: {:$lt => 100}}
+# it will affect olny small set of keywords (:_lt, :_inc),
+# other underscored keys will be intact.
+Mongo.defaults.merge! convert_underscore_to_dollar: true    
+db.units.all life: {_lt: 100}                      # => [tassadar]
+
+# it's also trivial to add support for {:life.lt => 100} notion, but
+# it uses ugly '=>' hash notation instead of ':' and it differs from
+# how it looks in native MongoDB JSON query.
 ```
 
 More docs - there's no need for more docs, the whole point of this extension is to be small, intuitive, 100% compatible with official driver (at least should be), and require no extra knowledge.

data/spec/driver/core/hash_helper_spec.rb

@@ -0,0 +1,19 @@
+require 'driver/spec_helper'
+
+describe "HashHelper" do
+  it "symbolize" do
+    Mongo::Ext::HashHelper.symbolize({
+      'a' => 1,
+      'b' => {
+        'c' => 2,
+        'd' => [{'e' => 3}]
+      }
+    }).should == {
+      a: 1,
+      b: {
+        c: 2,
+        d: [{e: 3}]
+      }
+    }
+  end
+end

data/spec/driver/more/querying_spec.rb

@@ -0,0 +1,59 @@
+require 'driver/spec_helper'
+
+describe "Querying" do
+  with_mongo
+  
+  before do
+    @jim =  {name: 'Jim', age: 34}
+    @units = db.units
+  end
+    
+  describe "dynamic finders" do
+    it "find, first, by" do
+      @units.first_by_name('Jim').should be_nil    
+      -> {@units.first_by_name!('Jim')}.should raise_error(Mongo::NotFound)
+      @units.by_name('Jim').should be_nil    
+      -> {@units.by_name!('Jim')}.should raise_error(Mongo::NotFound)
+      @units.first_by_name('Jim').should be_nil    
+      -> {@units.first_by_name!('Jim')}.should raise_error(Mongo::NotFound)
+    
+      @units.save @jim
+    
+      @units.first_by_name('Jim').should == @jim
+      @units.first_by_name!('Jim').should == @jim
+      @units.by_name('Jim').should == @jim
+      @units.by_name!('Jim').should == @jim
+      @units.first_by_name('Jim').should == @jim
+      @units.first_by_name!('Jim').should == @jim
+    end
+  
+    it "all" do
+      @units.all_by_name('Jim').should == []    
+      @units.save @jim
+      @units.all_by_name('Jim').should == [@jim]
+    end
+  
+    it "should allow to use bang version only with :first" do
+      -> {@units.all_by_name!('Jim')}.should raise_error(/can't use bang/)
+    end
+  
+    it "by_id (special case)" do
+      @units.method(:by_id).should == @units.method(:first_by_id)
+      @units.method(:by_id!).should == @units.method(:first_by_id!)
+    
+      @units.by_id('4de81858cf26bde569000009').should be_nil    
+      -> {@units.by_id!('4de81858cf26bde569000009')}.should raise_error(Mongo::NotFound)
+    
+      @units.save @jim
+    
+      @units.by_id(@jim[:_id]).should == @jim
+      @units.by_id!(@jim[:_id]).should == @jim
+    end
+  end
+  
+  it "underscore to dollar" do
+    @units.save @jim
+    @units.save name: 'Zeratul', age: 600
+    @units.all(age: {_lt: 100}).should == [@jim]
+  end
+end

data/spec/driver/spec_helper.rb

@@ -1,5 +1,12 @@
 require 'mongo_db/driver'
 
+Mongo.defaults.merge! \
+  symbolize:                    true,
+  convert_underscore_to_dollar: true,
+  batch_size:                   50,
+  multi:                        true,
+  safe:                         true
+
 require 'ruby_ext'
 require 'rspec_ext'
 require 'mongo_db/driver/spec'

data/spec/driver_example_spec.rb

@@ -10,6 +10,9 @@ describe "Example" do
   it "core" do    
     require 'mongo_db/driver'  
     
+    # changing some defaults
+    Mongo.defaults.merge! symbolize: true, multi: true, safe: true
+    
     # connection & db
     connection = Mongo::Connection.new
     db = connection.db 'default_test'
@@ -36,10 +39,20 @@ describe "Example" do
     end
   end
   
-  it "optional" do
+  it "optional" do        
     # simple finders (bang versions also availiable)
     db.units.by_name 'Zeratul'                         # => zeratul
     db.units.first_by_name 'Zeratul'                   # => zeratul
     db.units.all_by_name 'Zeratul'                     # => [zeratul]
+    
+    # query sugar, use {life: {_lt: 100}} instead of {life: {:$lt => 100}}
+    # it will affect olny small set of keywords (:_lt, :_inc),
+    # other underscored keys will be intact.
+    Mongo.defaults.merge! convert_underscore_to_dollar: true    
+    db.units.all life: {_lt: 100}                      # => [tassadar]
+    
+    # it's also trivial to add support for {:life.lt => 100} notion, but
+    # it uses ugly '=>' hash notation instead of ':' and it differs from
+    # how it looks in native MongoDB JSON query.
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_db
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &2844700 !ruby/object:Gem::Requirement
+  requirement: &366240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2844700
+  version_requirements: *366240
 description: 
 email: 
 executables: []
@@ -41,11 +41,14 @@ files:
 - lib/mongo_db/gems.rb
 - lib/mongo_db/model.rb
 - lib/mongo_db/support.rb
+- lib/old/advanced_finders.rb
+- lib/old/query.rb
+- lib/old/query_spec.rb
 - spec/driver/core/collection_spec.rb
 - spec/driver/core/crud_spec.rb
 - spec/driver/core/database_spec.rb
-- spec/driver/more/advanced_finders.rb
-- spec/driver/more/simple_finders_spec.rb
+- spec/driver/core/hash_helper_spec.rb
+- spec/driver/more/querying_spec.rb
 - spec/driver/spec_helper.rb
 - spec/driver_example_spec.rb
 - spec/migration/migration_spec.rb

data/spec/driver/more/simple_finders_spec.rb

@@ -1,51 +0,0 @@
-require 'driver/spec_helper'
-
-describe "Querying" do
-  with_mongo
-  
-  before do
-    @jim =  {name: 'Jim'}
-    @units = db.units
-  end
-    
-  it "find, first, by" do
-    @units.first_by_name('Jim').should be_nil    
-    -> {@units.first_by_name!('Jim')}.should raise_error(Mongo::NotFound)
-    @units.by_name('Jim').should be_nil    
-    -> {@units.by_name!('Jim')}.should raise_error(Mongo::NotFound)
-    @units.first_by_name('Jim').should be_nil    
-    -> {@units.first_by_name!('Jim')}.should raise_error(Mongo::NotFound)
-    
-    @units.save @jim
-    
-    @units.first_by_name('Jim').should == @jim
-    @units.first_by_name!('Jim').should == @jim
-    @units.by_name('Jim').should == @jim
-    @units.by_name!('Jim').should == @jim
-    @units.first_by_name('Jim').should == @jim
-    @units.first_by_name!('Jim').should == @jim
-  end
-  
-  it "all" do
-    @units.all_by_name('Jim').should == []    
-    @units.save @jim
-    @units.all_by_name('Jim').should == [@jim]
-  end
-  
-  it "should allow to use bang version only with :first" do
-    -> {@units.all_by_name!('Jim')}.should raise_error(/can't use bang/)
-  end
-  
-  it "by_id (special case)" do
-    @units.method(:by_id).should == @units.method(:first_by_id)
-    @units.method(:by_id!).should == @units.method(:first_by_id!)
-    
-    @units.by_id('4de81858cf26bde569000009').should be_nil    
-    -> {@units.by_id!('4de81858cf26bde569000009')}.should raise_error(Mongo::NotFound)
-    
-    @units.save @jim
-    
-    @units.by_id(@jim[:_id]).should == @jim
-    @units.by_id!(@jim[:_id]).should == @jim
-  end
-end