mongo_persist 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Harris
+
+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.rdoc

@@ -0,0 +1,63 @@
+= mongo_persist
+
+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 }
+  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
+
+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!
+
+# 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 
+
+# 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
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Mike Harris. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_persist"
+    gem.summary = %Q{Library to add MongoDB Persistance to normal Ruby objects}
+    gem.description = %Q{Library to add MongoDB Persistance to normal Ruby objects}
+    gem.email = "mharris717@gmail.com"
+    gem.homepage = "http://github.com/mharris717/mongo_persist"
+    gem.authors = ["Mike Harris"]
+    gem.add_development_dependency "rspec"
+    gem.add_dependency 'fattr'
+    gem.add_dependency 'activesupport'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongo_persist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/mongo_persist.rb

@@ -0,0 +1,119 @@
+require 'rubygems'
+require 'mongo'
+require 'activesupport'
+require 'fattr'
+require File.dirname(__FILE__) + "/mongo_persist/util"
+
+class Object
+  def safe_to_mongo_hash
+    sos(:to_mongo_hash)
+  end
+  def safe_to_mongo_object
+    sos(:to_mongo_object)
+  end
+end
+
+class Array
+  def to_mongo_hash
+    map { |x| x.safe_to_mongo_hash }
+  end
+  def to_mongo_object
+    map { |x| x.safe_to_mongo_object }
+  end
+end
+
+class Hash
+  def get_mongo_id
+    ['_id','mongo_id'].each { |x| return self[x] if self[x] }
+    nil
+  end
+  def naked_reference?
+    (keys - ['_id','_mongo_class','mongo_id']).empty? && !!get_mongo_id
+  end
+  def mongo_class
+    self['_mongo_class'] ? eval(self['_mongo_class']) : nil
+  end
+  def to_mongo_hash_for_obj
+    h = reject { |k,v| k == '_mongo_class' }
+    h['mongo_id'] = h['_id'] if h['_id']
+    h.reject { |k,v| k == '_id' }
+  end
+  def to_mongo_object
+    return self 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
+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] }
+  end
+  def mongo_child_attributes
+    mongo_attributes - self.class.mongo_reference_attributes
+  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}
+    end
+    res
+  end
+  def from_mongo_hash(h)
+    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
+  
+  module ClassMethods
+    dsl_method(:mongo_reference_attributes) { [] }
+    def default_collection_name
+      to_s.downcase.pluralize
+    end
+    fattr(:collection) { db.collection(default_collection_name) }
+    def from_mongo_hash(h)
+      new.tap { |x| x.from_mongo_hash(h) }
+    end
+    def mongo_connection(ops)
+      ops.each { |k,v| send("#{k}=",v) }
+    end
+  end
+  def self.included(mod)
+    super(mod)
+    mod.send(:include,FromHash)
+    mod.send(:extend,ClassMethods)
+  end
+end
+
+class ObjCursor
+  attr_accessor :cursor
+  include FromHash
+  def each
+    cursor.each { |x| yield(x.to_mongo_object) }
+  end
+  def count
+    cursor.count
+  end
+end
+
+class Mongo::Collection
+  def find_objects(*args)
+    ObjCursor.new(:cursor => find(*args))
+  end
+  def find_one_object(*args)
+    find_one(*args).to_mongo_object
+  end
+end

data/lib/mongo_persist/util.rb

@@ -0,0 +1,56 @@
+class Object
+  def dsl_method(name,&b)
+    define_method(name) do |*args|
+      if args.empty?
+        res = instance_variable_get("@#{name}")
+        if res.nil? && block_given?
+          res = b.call
+          instance_variable_set("@#{name}",res) 
+        end
+        res
+      else
+        instance_variable_set("@#{name}",args.first)
+      end
+    end
+  end
+  def dsl_class_method(name,&b)
+    self.class.dsl_method(name,&b)
+  end
+end
+
+class OrderedHash
+  def reject(&b)
+    res = OrderedHash.new
+    each { |k,v| res[k] = v unless yield(k,v) }
+    res
+  end
+end
+
+class Object
+  def sos(m)
+    respond_to?(m) ? send(m) : self
+  end
+  def klass
+    self.class
+  end
+end
+
+module FromHash
+  def from_hash(ops)
+    ops.each do |k,v|
+      send("#{k}=",v)
+    end
+    self
+  end
+  def initialize(ops={})
+    from_hash(ops)
+  end
+end
+
+class Hash
+  def map_value
+    res = {}
+    each { |k,v| res[k] = yield(v) }
+    res
+  end
+end

data/spec/mongo_persist_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+def db
+  Mongo::Connection.new.db('test-db')
+end
+
+class Order
+  include MongoPersist
+  attr_accessor :po_number
+  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
+
+# 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
+    [Order,Product].each { |x| x.collection.remove }
+    @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!
+  end
+  it 'should have id' do
+    @orders.first.mongo_id.should be
+  end
+  it 'product should have name' do
+    Order.collection.find_one_object.order_products.first.product.name.should be
+  end
+  it 'naked reference' do
+    h = {'mongo_id' => @products.first.mongo_id}
+    h.should be_naked_reference
+    h['name'] = 'abc'
+    h.should_not be_naked_reference
+  end
+  it 'to_mongo_object ref' do
+    h = {'_id' => @products.first.mongo_id, '_mongo_class' => 'Product'}
+    h.to_mongo_object.name.should == 'Leather Couch'
+    h['name'] = 'Leather Couch'
+    h.to_mongo_object.name.should == 'Leather Couch'
+  end
+  it 'updates' do
+    @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!
+    Order.collection.find_one_object(:po_number => 1234).products.first.name.should == 'White Leather Couch'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongo_persist'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_persist
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fattr
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Library to add MongoDB Persistance to normal Ruby objects
+email: mharris717@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo_persist.rb
+- lib/mongo_persist/util.rb
+- spec/mongo_persist_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mharris717/mongo_persist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library to add MongoDB Persistance to normal Ruby objects
+test_files: 
+- spec/mongo_persist_spec.rb
+- spec/spec_helper.rb