mongo_db 0.1.5 → 0.1.6

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

@@ -1,27 +1,33 @@
+require 'set'
+require 'date'
+
 module Mongo::Ext::Collection
-  # 
+  #
   # CRUD
-  #   
+  #
   def save_with_ext doc, opts = {}
     save_without_ext doc, reverse_merge_defaults(opts, :safe)
   end
-  
-  def insert_with_ext doc_or_docs, opts = {}
-    insert_without_ext doc_or_docs, reverse_merge_defaults(opts, :safe)
+
+  def insert_with_ext args, opts = {}
+    result = insert_without_ext args, reverse_merge_defaults(opts, :safe)
+
+    # fix for mongodriver, it will return single result if we supply [doc] as args
+    (args.is_a?(Array) and !result.is_a?(Array)) ? [result] : result
   end
-  
-  def update_with_ext selector, document, opts = {}
+
+  def update_with_ext selector, doc, 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 =~ /^\$/}      
+    doc      = convert_underscore_to_dollar_in_update doc
+
+    # because :multi works only with $ operators, we need to check if it's applicable
+    opts = if doc.keys.any?{|k| k =~ /^\$/}
       reverse_merge_defaults(opts, :safe, :multi)
     else
       reverse_merge_defaults(opts, :safe)
     end
-    
-    update_without_ext selector, document, opts
+
+    update_without_ext selector, doc, opts
   end
 
   def remove_with_ext selector = {}, opts = {}
@@ -32,64 +38,107 @@ module Mongo::Ext::Collection
   def destroy *args
     remove *args
   end
-  
-  # 
+
+  #
   # Querying
-  # 
-  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
+  #
+  def first selector = nil, opts = {}
+    selector = convert_underscore_to_dollar_in_selector selector if selector.is_a? Hash
+
+    h = find_one selector, opts
+    symbolize_doc h
   end
-  
+
   def all *args, &block
     if block
       each *args, &block
     else
       list = []
-      each(*args){|o| list << o}
+      each(*args){|doc| list << doc}
       list
     end
   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.symbolize o if Mongo.defaults[:symbolize]
-        block.call o
+      cursor.each do |doc|
+        doc = symbolize_doc doc
+        block.call doc
       end
       nil
     ensure
       cursor.close if cursor
     end
+    nil
   end
-  
+
   protected
+    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
+
+    def reverse_merge_defaults opts, *keys
+      h = opts.clone
+      keys.each do |k|
+        h[k] = Mongo.defaults[k] if Mongo.defaults.include?(k) and !h.include?(k)
+      end
+      h
+    end
+
+    # symbolizing hashes
+    def symbolize_doc doc
+      return doc unless Mongo.defaults[:symbolize]
+
+      Mongo::Ext::Collection.convert_doc doc 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
-      if Mongo.defaults[:convert_underscore_to_dollar]
-        selector = ::Mongo::Ext::HashHelper.convert_underscore_to_dollar_in_selector selector
+      return selector unless Mongo.defaults[:convert_underscore_to_dollar]
+
+      Mongo::Ext::Collection.convert_doc selector do |k, v, result|
+        k = "$#{k.to_s[1..-1]}".to_sym if QUERY_KEYWORDS.include?(k)
+        result[k] = v
       end
-      selector
     end
-    
+
+    # replaces :_set to :$set in query
     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
+      return update unless Mongo.defaults[:convert_underscore_to_dollar]
+
+      Mongo::Ext::Collection.convert_doc update do |k, v, result|
+        k = "$#{k.to_s[1..-1]}".to_sym if UPDATE_KEYWORDS.include?(k)
+        result[k] = v
       end
-      update
     end
-  
-    def reverse_merge_defaults opts, *keys
-      h = opts.clone
-      keys.each do |k|
-        h[k] = Mongo.defaults[k] if Mongo.defaults.include?(k) and !h.include?(k)
+
+    # walks on hash and creates another (also works with nested & arrays)
+    def self.convert_doc doc, &block
+      if doc.is_a? Hash
+        result = {}
+        doc.each do |k, v|
+          v = convert_doc v, &block
+          block.call k, v, result
+        end
+        result
+      elsif doc.is_a? Array
+        doc.collect{|v| convert_doc v, &block}
+      else
+        doc
       end
-      h
     end
 end

data/lib/mongo_db/driver/core.rb

@@ -7,8 +7,7 @@ class Mongo::Ext; end
 
 %w(
   database
-  collection  
-  hash_helper
+  collection
 ).each{|f| require "mongo_db/driver/core/#{f}"}
 
 # defaults
@@ -25,7 +24,7 @@ Mongo::DB.send :include, Mongo::Ext::DB
 # collection
 Mongo::Collection.class_eval do
   include Mongo::Ext::Collection
-  
+
   %w(insert update remove save).each do |method|
     alias_method "#{method}_without_ext", method
     alias_method method, "#{method}_with_ext"

data/lib/mongo_db/driver/more/{collection.rb → collection_finders.rb}

@@ -1,7 +1,7 @@
-module Mongo::Ext::Collection
-  # 
+module Mongo::Ext::CollectionFinders
+  #
   # first_by_id, special case
-  # 
+  #
   def first_by_id id
     first _id: id
   end
@@ -11,31 +11,27 @@ module Mongo::Ext::Collection
     first_by_id(id) || raise(Mongo::NotFound, "document with id #{id} not found!")
   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
-    # 
+    #
     def method_missing clause, *a, &b
-      if clause =~ /^([a-z]_by_[a-z_])|(by_[a-z_])/ 
-        clause = clause.to_s      
-      
+      if clause =~ /^([a-z]_by_[a-z_])|(by_[a-z_])/
+        clause = clause.to_s
+
         bang = clause =~ /!$/
         clause = clause[0..-2] if bang
-      
-        finder, field = if clause =~ /^by_/  
+
+        finder, field = if clause =~ /^by_/
           ['first', clause.sub(/by_/, '')]
-        else        
-          clause.split(/_by_/, 2)          
-        end                
+        else
+          clause.split(/_by_/, 2)
+        end
         finder = 'first' if finder == 'find'
-      
+
         raise "You can't use bang version with :#{finder}!" if bang and finder != 'first'
-      
+
         raise "invalid arguments for finder (#{a})!" unless a.size == 1
         field_value = a.first
 

data/lib/mongo_db/driver/more.rb

@@ -3,5 +3,8 @@ require 'mongo_db/driver/core'
 class Mongo::NotFound < StandardError; end
 
 %w(
-  collection
-).each{|f| require "mongo_db/driver/more/#{f}"}
+  collection_finders
+).each{|f| require "mongo_db/driver/more/#{f}"}
+
+Mongo::Collection.send :include, Mongo::Ext::CollectionFinders
+

data/lib/mongo_db/driver/spec.rb

@@ -1,31 +1,31 @@
 MONGO_TEST_DATABASE_NAME = 'default_test'
 
-rspec do    
+rspec do
   def mongo
     $mongo || raise('Mongo not defined (use :with_mongo helper)!')
   end
-  
+
   def clear_mongo name = MONGO_TEST_DATABASE_NAME
     mongo.db.collection_names.each do |name|
       next if name =~ /^system\./
       mongo.db.collection(name).drop
     end
   end
-  
+
   class << self
     def with_mongo
       before :all do
         require 'ostruct'
-        
+
         $mongo = OpenStruct.new.tap do |m|
           m.connection = Mongo::Connection.new
           m.db = m.connection.db MONGO_TEST_DATABASE_NAME
         end
-      end      
+      end
       after(:all){$mongo = nil}
-    
-      before do        
-        clear_mongo        
+
+      before do
+        clear_mongo
       end
     end
   end

data/lib/mongo_db/model/model_helper.rb

@@ -0,0 +1,154 @@
+module Mongo::Ext::ModelHelper
+  #
+  # CRUD
+  #
+  def save_with_model doc, opts = {}
+    if doc.is_a? Hash
+      save_without_model doc, opts
+    else
+      if id = doc.instance_variable_get(:@_id)
+        update({:_id => id}, doc, opts.merge(upsert: true))
+      else
+        insert doc, opts
+      end
+    end
+  end
+
+  def insert_with_model args, opts = {}
+    docs = args.is_a?(Array) ? args : [args]
+    result = _insert_with_model docs, opts
+    args.is_a?(Array) ? result : result.first
+  end
+
+  def update_with_model selector, doc, opts = {}
+    doc = Mongo::Ext::ModelHelper.convert_object_to_doc doc unless doc.is_a?(Hash)
+    update_without_model selector, doc, opts
+  end
+
+  def remove_with_model arg = {}, opts = {}
+    if arg.is_a? Hash
+      remove_without_model arg, opts
+    else
+      id = arg.instance_variable_get(:@_id) || "can't remove object without _id (#{arg})!"
+      remove_without_model({_id: id}, opts)
+    end
+  end
+
+
+  #
+  # Querying
+  #
+  def first *args, &block
+    doc = super *args, &block
+    Mongo::Ext::ModelHelper.convert_doc_to_object doc
+  end
+
+  def each *args, &block
+    super *args do |doc|
+      doc = Mongo::Ext::ModelHelper.convert_doc_to_object(doc)
+      block.call doc
+    end
+    nil
+  end
+
+  protected
+    def _insert_with_model docs, opts
+      hashes = docs.collect do |doc|
+        doc.is_a?(Hash) ? doc : Mongo::Ext::ModelHelper.convert_object_to_doc(doc)
+      end
+      result = insert_without_model hashes, opts
+      hashes.each_with_index do |h, i|
+        Mongo::Ext::ModelHelper.update_object_after_insertion docs[i], h
+      end
+      result
+    end
+
+
+  SIMPLE_TYPES = [
+    Fixnum, Float,
+    TrueClass, FalseClass,
+    String, Symbol,
+    Array, Hash, Set,
+    Data, DateTime,
+    NilClass, Time,
+    BSON::ObjectId
+  ].to_set
+
+  class << self
+    def update_object_after_insertion doc, hash
+      return if doc.is_a? Hash
+      if id = hash[:_id] || hash['_id']
+        doc.instance_variable_set :@_id, id
+      end
+    end
+
+    # converts object to hash (also works with nested & arrays)
+    def convert_object_to_doc obj
+      return obj.to_mongo if obj.respond_to? :to_mongo
+
+      if obj.is_a? Hash
+        doc = {}
+        obj.each do |k, v|
+          doc[k] = convert_object_to_doc v
+        end
+        doc
+      elsif obj.is_a? Array
+        obj.collect{|v| convert_object_to_doc v}
+      elsif SIMPLE_TYPES.include? obj.class
+        obj
+      else
+        doc = {}
+
+        # copying instance variables to hash
+        obj.instance_variables.each do |iv_name|
+          # skipping variables starting with _xx, usually they
+          # have specific meaning and used for example for cache
+          next if iv_name =~ /^@_/ and iv_name != :@_id
+
+          k = iv_name.to_s[1..-1]
+          k = k.to_sym if Mongo.defaults[:symbolize]
+          v = obj.instance_variable_get iv_name
+          doc[k] = convert_object_to_doc v
+        end
+
+        # setting class
+        class_name = '_class'
+        class_name = class_name.to_sym if Mongo.defaults[:symbolize]
+        doc[class_name] = obj.class.name
+
+        doc
+      end
+    end
+
+    def convert_doc_to_object doc
+      if doc.is_a? Hash
+        if class_name = doc[:_class] || doc['_class']
+          klass = constantize class_name
+          obj = klass.new
+          doc.each do |k, v|
+            next if k.to_sym == :_class
+
+            v = convert_doc_to_object v
+            obj.instance_variable_set "@#{k}", v
+          end
+          obj
+        else
+          doc
+        end
+      elsif doc.is_a? Array
+        doc.collect{|v| convert_doc_to_object v}
+      else
+        doc
+      end
+    end
+
+    def constantize class_name
+      @constantize_cache ||= {}
+      unless klass = @constantize_cache[class_name]
+        klass = eval class_name, TOPLEVEL_BINDING, __FILE__, __LINE__
+        @constantize_cache[class_name] = klass
+      end
+      klass
+    end
+  end
+end

data/lib/mongo_db/model/model_serializer.rb

@@ -0,0 +1,3 @@
+class Mongo::Ext::ModelSerializer
+
+end

data/lib/mongo_db/model.rb

@@ -1,4 +1,16 @@
 require 'mongo_db/driver'
 
 %w(
-).each{|f| require "mongo_db/model/#{f}"}
+  model_serializer
+  model_helper
+).each{|f| require "mongo_db/model/#{f}"}
+
+# collection
+Mongo::Collection.class_eval do
+  include Mongo::Ext::ModelHelper
+
+  %w(insert update remove save).each do |method|
+    alias_method "#{method}_without_model", method
+    alias_method method, "#{method}_with_model"
+  end
+end

data/lib/mongo_db/support.rb

@@ -4,7 +4,7 @@
 #   unless defined_method? :subset
 #     def subset *keys, &block
 #       keys = keys.first if keys.first.is_a? Array
-#       h = {}    
+#       h = {}
 #       if keys
 #         self.each do |k, v|
 #           h[k] = v if keys.include? k
@@ -17,14 +17,14 @@
 #       h
 #     end
 #   end
-#   
+#
 #   unless defined_method? :reverse_merge
 #     def reverse_merge(other_hash)
 #       other_hash.merge(self)
 #     end
-# 
+#
 #     def reverse_merge!(other_hash)
 #       merge!(other_hash){|k,o,n| o }
 #     end
-#   end  
+#   end
 # end

data/readme.md

@@ -1,18 +1,20 @@
 Object Model & Ruby driver enhancements for MongoDB.
 
+- Driver enchancements
+- Persistence for pure Ruby objects
+- Migrations (work in progress)
+- Object Model (callbacks, validations, mass-assignment, finders, ...) (work in progress)
+
 # MongoDB driver enhancements
 
-MongoDB itself is very powerful, flexible and simple tool, but it's Ruby driver hides it behind complicated API. 
-This enhancements alter the Ruby-driver's API to be more simple and intuitive.
+MongoDB itself is very powerful, flexible and simple tool, but it's Ruby driver has a little complicated API.
+This enhancements alter this API to be more simple and intuitive.
 
 - Makes API of mongo-ruby-driver friendly & handy.
 - No extra abstraction or complexities introduced, all things are exactly the same as in MongoDB.
-- Simple migrations support (work in progress).
-
-Note: By default it also adds a little magic and alters some default values of standard driver to be more useful, but You can omit it and require only the core stuff: use *requre 'mongo_db/driver/core'* instead of *requre 'mongo_db/driver'*
 
 ``` ruby
-require 'mongo_db/driver'
+require 'mongo_db/driver/core'
 
 # changing some defaults
 Mongo.defaults.merge! symbolize: true, multi: true, safe: true
@@ -35,33 +37,92 @@ db.units.save tassadar
 # querying - first & all, there's also :each, the same as :all
 db.units.first name: 'Zeratul'                      # => zeratul
 db.units.all name: 'Zeratul'                        # => [zeratul]
-db.units.all name: 'Zeratul' do |hero|
-  hero                                              # => zeratul
+db.units.all name: 'Zeratul' do |unit|
+  unit                                              # => zeratul
 end
 ```
 
 Optionall stuff:
 
+- Simple query enchancements
+
 ``` ruby
+require 'mongo_db/driver/more'
+
 # 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.
+Mongo.defaults.merge! convert_underscore_to_dollar: true
+db.units.all 'stats.life' => {_lt: 100}            # => [tassadar]
 ```
 
-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.
+More docs - there's no need for more docs, the whole point of this extension is to be small, intuitive, 100% compatible with the official driver (at least should be), and require no extra knowledge.
 So, please use standard Ruby driver documentation.
 
+# Persistence for pure Ruby objects
+
+Save any Ruby object to MongoDB, as if it's hash. Object can be any type, simple or composite with other objects / arrays / hashes inside.
+
+Note: the :initialize method should allow to create object without arguments.
+
+``` ruby
+# let's define the game unit
+class Unit
+  attr_reader :name, :stats
+
+  # don't forget to allow creating object with no arguments
+  def initialize name = nil, stats = nil
+    @name, @stats = name, stats
+  end
+
+  class Stats
+    attr_accessor :attack, :life, :shield
+
+    def initialize attack = nil, life = nil, shield = nil
+      @attack, @life, @shield = attack, life, shield
+    end
+  end
+end
+
+# connecting to MongoDB
+require 'mongo_db/model'
+Mongo.defaults.merge! symbolize: true, multi: true, safe: true
+connection = Mongo::Connection.new
+db = connection.db 'default_test'
+
+# create
+zeratul  = Unit.new('Zeratul',  Unit::Stats.new(85, 300, 100))
+tassadar = Unit.new('Tassadar', Unit::Stats.new(0,  80,  300))
+
+db.units.save zeratul
+db.units.save tassadar
+
+# udate (we made error - mistakenly set Tassadar's attack as zero, let's fix it)
+tassadar.stats.attack = 20
+db.units.save tassadar
+
+# querying first & all, there's also :each, the same as :all
+db.units.first name: 'Zeratul'                     # => zeratul
+db.units.all name: 'Zeratul'                       # => [zeratul]
+db.units.all name: 'Zeratul' do |unit|
+  unit                                             # => zeratul
+end
+
+# 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}}
+Mongo.defaults.merge! convert_underscore_to_dollar: true
+db.units.all('stats.life' => {_lt: 100})           # => [tassadar]
+```
+
+# Migrations (work in progress)
+
 # Object Model (work in progress)
 
 Model designed after the excellent "Domain-Driven Design" book by Eric Evans.