mongo_persist 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,50 +1,60 @@
-= mongo_persist
+= MongoPersist
 
 Library to add MongoDB Persistance to normal Ruby objects
 
 = Example
 
-class Order
-  include MongoPersist
-  attr_accessor :po_number
-  fattr(:order_products) { [] }
-  def products
-    order_products.map { |x| x.product }
+  require 'rubygems'
+  require 'mongo'
+  require 'mongo_persist'
+
+  class Order
+    include MongoPersist
+    attr_accessor :po_number
+    fattr(:order_products) { [] }
+    def products
+      order_products.map { |x| x.product }
+    end
   end
-end
 
-class OrderProduct
-  include MongoPersist
-  attr_accessor :unit_price, :quantity, :product
-  mongo_reference_attributes ['product']
-end
+  class OrderProduct
+    include MongoPersist
+    attr_accessor :unit_price, :quantity, :product
+    
+    # Store a reference to objects for this attribute, not the entire object.
+    mongo_reference_attributes ['product']
+  end
 
-class Product
-  include MongoPersist
-  attr_accessor :name
-end
+  class Product
+    include MongoPersist
+    attr_accessor :name
+  end
 
-products = [Product.new(:name => 'Leather Couch'),Product.new(:name => 'Maroon Chair')].each { |x| x.mongo_save! }
+  products = [Product.new(:name => 'Leather Couch'),Product.new(:name => 'Maroon Chair')].each { |x| x.mongo_save! }
 
-orders = []
-orders << Order.new(:po_number => 1234, :order_products => [OrderProduct.new(:unit_price => 1000, :quantity => 1, :product => products[0])]).mongo_save!
-orders << Order.new(:po_number => 1235, :order_products => [OrderProduct.new(:unit_price => 200, :quantity => 2, :product => products[1])]).mongo_save!
+  orders = []
+  orders << Order.new(:po_number => 1234, :order_products => [OrderProduct.new(:unit_price => 1000, :quantity => 1, :product => products[0])]).mongo_save!
+  orders << Order.new(:po_number => 1235, :order_products => [OrderProduct.new(:unit_price => 200, :quantity => 2, :product => products[1])]).mongo_save!
 
-# objects are saved to MongoDB as JSON objects
+  # objects are saved to MongoDB as JSON objects
 
-# get all order objects back from Mongo
-# you get back the ruby objects you put in, not raw JSON objects
-Order.collection.find_objects 
+  # get all order objects back from Mongo
+  # you get back the ruby objects you put in, not raw JSON objects
+  Order.collection.find_objects 
 
-# Since on OrderProduct, the product attribute was marked as a reference attribute, the product is stored in MongoDB only as a reference to the product obj
-# When you read the Order/OrderProduct back out, MongoPersist takes care of fetching the Product object again.  You don't have to do anything.
-Order.collection.find_one_object.products.first # An object of class Product
-Order.collection.find_one_object.products.first.name  # Leather Couch
+  # Since on OrderProduct, the product attribute was marked as a reference attribute, 
+  # the product is stored in MongoDB only as a reference to the product obj
+  #
+  # When you read the Order/OrderProduct back out, MongoPersist takes care of 
+  # fetching the Product object again.  You don't have to do anything.
+  Order.collection.find_one_object.products.first # An object of class Product
+  Order.collection.find_one_object.products.first.name  # Leather Couch
 
-# Because the product is stored as a reference, if you update that product elsewhere and save to Mongo, later reads of Orders with that product will be correctly updated
-products[0].name = 'White Leather Couch'
-products[0].mongo_save!
-Order.collection.find_one_object.products.first.name  # White Leather Couch
+  # Because the product is stored as a reference, if you update that product 
+  # elsewhere and save to Mongo, later reads of Orders with that product will be correctly updated
+  products[0].name = 'White Leather Couch'
+  products[0].mongo_save!
+  Order.collection.find_one_object.products.first.name  # White Leather Couch
 
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/mongo_persist/sandbox.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + "/../mongo_persist"
+
+def db
+  Mongo::Connection.new.db('test-db')
+end
+
+class Order
+  include MongoPersist
+  attr_accessor :po_number, :customers
+  mongo_reference_attributes ['customers']
+  fattr(:order_products) { [] }
+  def products
+    order_products.map { |x| x.product }
+  end
+end
+
+class OrderProduct
+  include MongoPersist
+  attr_accessor :unit_price, :quantity, :product
+  mongo_reference_attributes ['product']
+end
+
+class Product
+  include MongoPersist
+  attr_accessor :name
+end
+
+class Customer
+  include MongoPersist
+  attr_accessor :email
+end
+
+  [Order,Product].each { |x| x.collection.remove }
+  @products = [Product.new(:name => 'Leather Couch'),Product.new(:name => 'Maroon Chair')].each { |x| x.mongo.save! }
+  @customers = [Customer.new(:email => 'a'),Customer.new(:email => 'b')].each { |x| x.mongo.save! }
+
+  @orders = []
+  @orders << Order.new(:customers => @customers, :po_number => 1234, :order_products => [OrderProduct.new(:unit_price => 1000, :quantity => 1, :product => @products[0])]).mongo.save!
+  @orders << Order.new(:customers => @customers, :po_number => 1235, :order_products => [OrderProduct.new(:unit_price => 200, :quantity => 2, :product => @products[1])]).mongo.save!
+  
+  $orders = @orders

data/lib/mongo_persist.rb

@@ -3,6 +3,7 @@ require 'mongo'
 require 'activesupport'
 require 'fattr'
 require File.dirname(__FILE__) + "/mongo_persist/util"
+require 'andand'
 
 class Object
   def safe_to_mongo_hash
@@ -20,6 +21,9 @@ class Array
   def to_mongo_object
     map { |x| x.safe_to_mongo_object }
   end
+  def to_mongo_ref_hash
+    map { |x| x.to_mongo_ref_hash }
+  end
 end
 
 class Hash
@@ -39,29 +43,50 @@ class Hash
     h.reject { |k,v| k == '_id' }
   end
   def to_mongo_object
-    return self unless mongo_class
+    return map_value { |v| v.safe_to_mongo_object } unless mongo_class
     if naked_reference?
       mongo_class.collection.find_one_object('_id' => get_mongo_id)
     else
       mongo_class.from_mongo_hash(to_mongo_hash_for_obj)
     end
   end
+  def to_mongo_hash
+    res = {}
+    each { |k,v| res[k.safe_to_mongo_hash] = v.safe_to_mongo_hash }
+    res
+  end
+end
+
+class MongoWrapper
+  attr_accessor :obj
+  include FromHash
+  def save!
+    if obj.mongo_id
+      obj.klass.collection.update({'_id' => obj.mongo_id},obj.to_mongo_hash)
+    else
+      obj.mongo_id = obj.class.collection.save(obj.to_mongo_hash)
+    end
+    obj
+  end
 end
 
 module MongoPersist
   attr_accessor :mongo_id
   #can be overriden by class.  If not, assumes that all instance variables should be saved.
   def mongo_attributes
-    instance_variables.map { |x| x[1..-1] }
+    instance_variables.map { |x| x[1..-1] } - ['mongo']
   end
   def mongo_child_attributes
     mongo_attributes - self.class.mongo_reference_attributes
   end
+  def to_mongo_ref_hash
+    {'_mongo_class' => klass.to_s, '_id' => mongo_id}
+  end
   def to_mongo_hash
     res = mongo_child_attributes.inject({}) { |h,attr| h.merge(attr => send(attr).safe_to_mongo_hash) }.merge("_mongo_class" => self.class.to_s)
     klass.mongo_reference_attributes.each do |attr|
-      obj = send(attr)
-      res[attr] = {'_mongo_class' => obj.class.to_s, '_id' => send(attr).mongo_id}
+      val = send(attr)
+      res[attr] = val.to_mongo_ref_hash if val
     end
     res
   end
@@ -69,14 +94,7 @@ module MongoPersist
     h = h.map_value { |v| v.safe_to_mongo_object }
     from_hash(h)
   end
-  def mongo_save!
-    if mongo_id
-      klass.collection.update({'_id' => mongo_id},to_mongo_hash)
-    else
-      self.mongo_id = self.class.collection.save(to_mongo_hash)
-    end
-    self
-  end
+  fattr(:mongo) { MongoWrapper.new(:obj => self) }
   
   module ClassMethods
     dsl_method(:mongo_reference_attributes) { [] }

data/mongo_persist.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongo_persist}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Harris"]
+  s.date = %q{2009-11-19}
+  s.description = %q{Library to add MongoDB Persistance to normal Ruby objects}
+  s.email = %q{mharris717@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mongo_persist.rb",
+     "lib/mongo_persist/sandbox.rb",
+     "lib/mongo_persist/util.rb",
+     "mongo_persist.gemspec",
+     "spec/mongo_persist_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mharris717/mongo_persist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Library to add MongoDB Persistance to normal Ruby objects}
+  s.test_files = [
+    "spec/mongo_persist_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<fattr>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fattr>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fattr>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/spec/mongo_persist_spec.rb

@@ -6,17 +6,24 @@ end
 
 class Order
   include MongoPersist
-  attr_accessor :po_number
+  attr_accessor :po_number, :customers, :some_hash
+  mongo_reference_attributes ['customers']
   fattr(:order_products) { [] }
   def products
     order_products.map { |x| x.product }
   end
+  def subtotal
+    order_products.map { |x| x.subtotal }.sum
+  end
 end
 
 class OrderProduct
   include MongoPersist
   attr_accessor :unit_price, :quantity, :product
   mongo_reference_attributes ['product']
+  def subtotal
+    quantity.to_f * unit_price
+  end
 end
 
 class Product
@@ -24,15 +31,22 @@ class Product
   attr_accessor :name
 end
 
+class Customer
+  include MongoPersist
+  attr_accessor :email
+end
+
 # too many assertions per test, too many "this is how things should be before i check the point of this test" assertions
 describe MongoPersist do
   before do
+    $abc = false
     [Order,Product].each { |x| x.collection.remove }
-    @products = [Product.new(:name => 'Leather Couch'),Product.new(:name => 'Maroon Chair')].each { |x| x.mongo_save! }
+    @products = [Product.new(:name => 'Leather Couch'),Product.new(:name => 'Maroon Chair')].each { |x| x.mongo.save! }
+    @customers = [Customer.new(:email => 'a'),Customer.new(:email => 'b')].each { |x| x.mongo.save! }
 
     @orders = []
-    @orders << Order.new(:po_number => 1234, :order_products => [OrderProduct.new(:unit_price => 1000, :quantity => 1, :product => @products[0])]).mongo_save!
-    @orders << Order.new(:po_number => 1235, :order_products => [OrderProduct.new(:unit_price => 200, :quantity => 2, :product => @products[1])]).mongo_save!
+    @orders << Order.new(:customers => @customers, :po_number => 1234, :order_products => [OrderProduct.new(:unit_price => 1000, :quantity => 1, :product => @products[0])]).mongo.save!
+    @orders << Order.new(:customers => @customers, :po_number => 1235, :order_products => [OrderProduct.new(:unit_price => 200, :quantity => 2, :product => @products[1])]).mongo.save!
   end
   it 'should have id' do
     @orders.first.mongo_id.should be
@@ -53,13 +67,23 @@ describe MongoPersist do
     h.to_mongo_object.name.should == 'Leather Couch'
   end
   it 'updates' do
-    @products.first.from_hash(:name => 'White Leather Couch').mongo_save!
+    @products.first.from_hash(:name => 'White Leather Couch').mongo.save!
     Product.collection.find.count.should == 2
     Product.collection.find_objects(:name => /Leather/).count.should == 1
     Product.collection.find_one_object(:name => /Leather/).name.should == 'White Leather Couch'
   end
   it 'reference loading' do
-    @products.first.from_hash(:name => 'White Leather Couch').mongo_save!
+    @products.first.from_hash(:name => 'White Leather Couch').mongo.save!
     Order.collection.find_one_object(:po_number => 1234).products.first.name.should == 'White Leather Couch'
   end
+  it 'customers' do
+    @customers.first.from_hash(:email => 'z').mongo.save!
+    Order.collection.find_one_object.customers.first.email.should == 'z'
+  end
+  it 'saving hashes' do
+    o = Order.new(:po_number => 1, :some_hash => {'1' => Product.new(:name => 'Chair')})
+    o.mongo.save!
+    Order.collection.find_one_object(:po_number => 1).some_hash['1'].name.should == 'Chair'
+    Order.collection.find_one_object.subtotal.should == 1000
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_persist
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mike Harris
@@ -59,7 +59,9 @@ files:
 - Rakefile
 - VERSION
 - lib/mongo_persist.rb
+- lib/mongo_persist/sandbox.rb
 - lib/mongo_persist/util.rb
+- mongo_persist.gemspec
 - spec/mongo_persist_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true