mongo_delegate 0.1.1 → 0.1.2

data/README

@@ -0,0 +1,30 @@
+<p>= MongoDelegate</p>
+<p>A DelegateCollection wraps a local collection and remote collection in one object that implements the Collection interface.</p>
+<ul>
+	<li>All reads are first done on the local collection, then supplemented by a read on the remote collection, if necessary.</li>
+	<li>All write occur in the local collection.  The remote collection is treated as read-only.</li>
+</ul>
+<p>This was inspired by things I&#8217;ve been told about Goldman Sachs&#8217; proprietary object database.  You can point one database at another remote database, and it will function in this manner.</p>
+<p>The classic use case is debugging a production problem, or developing while using production data.</p>
+<ul>
+	<li>The annoying way: Generate data that mimics production, get a production dump and load it locally, or &#8220;test&#8221; in production while walking on eggshells to make sure not to break anything</li>
+	<li>The easy way: Have your local app use a delegating collection that points at the production db.  Your app will be using live production data, but all writes occur locally.  As writes occur, the app will get your newly written data for those documents.  Your app can be oblivious to the delegation and function normally, and you can modify data without fear.</li>
+</ul>
+<p>Just create a DelegatingDatabase and pass to your application, wherever you would normally supply a database<br />
+  db = Mongo::DelegatingDatabase.new(:local =&gt; Mongo::Connection.new.db(&#8216;db-name&#8217;), :remote =&gt; Mongo::Connection.new(&#8216;remote ip&#8217;).db(&#8216;db-name&#8217;))<br />
+  <br />
+Later, anywhere collections are retrieved in your app<br />
+  coll = db.collection(&#8216;some-collection-name&#8217;) # This returns an instance of Mongo::DelegatingCollection</p>
+<p>== Note on Patches/Pull Requests</p>
+<ul>
+	<li>Fork the project.</li>
+	<li>Make your feature addition or bug fix.</li>
+	<li>Add tests for it. This is important so I don&#8217;t break it in a<br />
+  future version unintentionally.</li>
+	<li>Commit, do not mess with rakefile, version, or history.<br />
+  (if you want to have your own version, that is fine but<br />
+   bump version in a commit by itself I can ignore when I pull)</li>
+	<li>Send me a pull request. Bonus points for topic branches.</li>
+</ul>
+<p>== Copyright</p>
+<p>Copyright &#169; 2010 Mike Harris. See <span class="caps">LICENSE</span> for details.</p>

data/README.html

@@ -0,0 +1,30 @@
+<p>= MongoDelegate</p>
+<p>A DelegateCollection wraps a local collection and remote collection in one object that implements the Collection interface.</p>
+<ul>
+	<li>All reads are first done on the local collection, then supplemented by a read on the remote collection, if necessary.</li>
+	<li>All write occur in the local collection.  The remote collection is treated as read-only.</li>
+</ul>
+<p>This was inspired by things I&#8217;ve been told about Goldman Sachs&#8217; proprietary object database.  You can point one database at another remote database, and it will function in this manner.</p>
+<p>The classic use case is debugging a production problem, or developing while using production data.</p>
+<ul>
+	<li>The annoying way: Generate data that mimics production, get a production dump and load it locally, or &#8220;test&#8221; in production while walking on eggshells to make sure not to break anything</li>
+	<li>The easy way: Have your local app use a delegating collection that points at the production db.  Your app will be using live production data, but all writes occur locally.  As writes occur, the app will get your newly written data for those documents.  Your app can be oblivious to the delegation and function normally, and you can modify data without fear.</li>
+</ul>
+<p>Just create a DelegatingDatabase and pass to your application, wherever you would normally supply a database<br />
+  db = Mongo::DelegatingDatabase.new(:local =&gt; Mongo::Connection.new.db(&#8216;db-name&#8217;), :remote =&gt; Mongo::Connection.new(&#8216;remote ip&#8217;).db(&#8216;db-name&#8217;))<br />
+  <br />
+Later, anywhere collections are retrieved in your app<br />
+  coll = db.collection(&#8216;some-collection-name&#8217;) # This returns an instance of Mongo::DelegatingCollection</p>
+<p>== Note on Patches/Pull Requests</p>
+<ul>
+	<li>Fork the project.</li>
+	<li>Make your feature addition or bug fix.</li>
+	<li>Add tests for it. This is important so I don&#8217;t break it in a<br />
+  future version unintentionally.</li>
+	<li>Commit, do not mess with rakefile, version, or history.<br />
+  (if you want to have your own version, that is fine but<br />
+   bump version in a commit by itself I can ignore when I pull)</li>
+	<li>Send me a pull request. Bonus points for topic branches.</li>
+</ul>
+<p>== Copyright</p>
+<p>Copyright &#169; 2010 Mike Harris. See <span class="caps">LICENSE</span> for details.</p>

data/README.rdoc

@@ -1,6 +1,31 @@
-= mongo_delegate
+= MongoDelegate
 
-A DelegateCollection wraps 
+A DelegateCollection wraps a local collection and remote collection in one object that implements the Collection interface.
+* All reads are first done on the local collection, then supplemented by a read on the remote collection, if necessary.
+* All writes occur in the local collection.  The remote collection is treated as read-only.
+
+This was inspired by things I've been told about Goldman Sachs' proprietary object database.  You can point one database at another remote database, and it will function in this manner. 
+
+The classic use case is debugging a production problem, or developing while using production data.  
+
+The annoying ways
+* Generate data that mimics production
+* get a production dump and load it locally
+* "Test" in production while walking on eggshells to make sure not to break anything
+
+The easy way
+* Have your local app use a delegating collection that points at the production db.  
+* Your app will be using live production data, but all writes occur locally.  
+* As writes occur, the app will get your newly written data for those documents.  
+* Your app can be oblivious to the delegation and function normally, and you can modify data without fear.  
+
+Just create a DelegatingDatabase and pass to your application, wherever you would normally supply a database
+  db = Mongo::DelegatingDatabase.new(:local => Mongo::Connection.new.db('db-name'), 
+                                     :remote => Mongo::Connection.new('remote ip').db('db-name'))
+  
+Later, anywhere collections are retrieved in your app
+  # This returns an instance of Mongo::DelegatingCollection
+  coll = db.collection('some-collection-name') 
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/mongo_delegate.rb

@@ -1 +1,2 @@
-require File.join(File.dirname(__FILE__),"mongo_delegate","delegating_collection")
+require File.join(File.dirname(__FILE__),"mongo_delegate","delegating_collection")
+require File.join(File.dirname(__FILE__),"mongo_delegate","delegating_database")

data/lib/mongo_delegate/delegating_database.rb

@@ -0,0 +1,9 @@
+module Mongo
+  class DelegatingDatabase
+    attr_accessor :local, :remote
+    include FromHash
+    def collection(name)
+      DelegatingCollection.new(:local => local.collection(name), :remote => remote.collection(name))
+    end
+  end
+end

data/spec/delegating_collection_spec.rb

@@ -1,9 +1,61 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+class Array
+  def num_from_bytes
+    return 0 if empty?
+    self[-1] + 256 * self[0..-2].num_from_bytes
+  end
+  def time_from_bytes
+    Time.at(num_from_bytes)
+  end
+end
+
+class Numeric
+  def to_bytes
+    return [] if self == 0
+    (self/256).to_bytes + [self%256]
+  end
+  def to_bytes4
+    res = to_bytes
+    while res.length < 4
+      res = [0] + res
+    end
+    res
+  end
+end
+
+class Time
+  def to_small_mongo_id
+    res = Mongo::ObjectID.new
+    res.data = to_i.to_bytes4 + (0...8).map { |x| 0 }
+    res
+  end
+  def to_big_mongo_id
+    res = Mongo::ObjectID.new
+    res.data = to_i.to_bytes4 + (0...8).map { |x| 255 }
+    res
+  end
+end
+
+class Mongo::ObjectID
+  attr_accessor :data
+  def time
+    data[0...4].time_from_bytes
+  end
+end
+
+class Hash
+  def created_at
+    self['_id'].time
+  end
+end
+
 context Mongo::DelegatingCollection do
   def setup_coll
+    @start_time = Time.now 
     @conn = Mongo::Connection.new
-    @d = Mongo::DelegatingCollection.new(:remote => @conn.db('dc-remote').collection('abc'), :local => @conn.db('dc-local').collection('abc'))
+    @db = Mongo::DelegatingDatabase.new(:remote => @conn.db('dc-remote'), :local => @conn.db('dc-local'))
+    @d = @db.collection('abc')
     @d.remove
     @remotes = %w(Ellen Randy Barbara).each { |x| @d.remote.save(:name => x) }
     @locals = %w(Mike Lou Lowell).each { |x| @d.local.save(:name => x) }
@@ -56,6 +108,9 @@ context Mongo::DelegatingCollection do
       mock.instance_of(Mongo::Cursor).to_a.times(0)
       @d.count.should == 6
     end
+    it 'abc' do
+      @d.local.scope_gte('_id' => @start_time.to_small_mongo_id).count.should == 3
+    end
     # it 'count honors remote deletes' do
     #   @d.remote.find.each { |x| @d.save(x) }
     #   @d.remote.remove

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_delegate
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Mike Harris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 -05:00
+date: 2010-01-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,6 +100,8 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README
+- README.html
 - README.rdoc
 files: 
 - .document
@@ -111,11 +113,14 @@ files:
 - lib/mongo_delegate.rb
 - lib/mongo_delegate/composite_cursor.rb
 - lib/mongo_delegate/delegating_collection.rb
+- lib/mongo_delegate/delegating_database.rb
 - lib/mongo_delegate/ext.rb
 - spec/delegating_collection_spec.rb
 - spec/mongo_delegate_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- README
+- README.html
 has_rdoc: true
 homepage: http://github.com/mharris717/mongo_delegate
 licenses: []