mongoid_collection_snapshot 0.2.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 918809b176c7a1430e76767c00aa8e3f59114a68
+  data.tar.gz: 7cfdc2500575d070f4f525ff84b17f37065477c9
+SHA512:
+  metadata.gz: f13bc196f4e0e6544cd9dab28715cd3d1fd3fa8a4017daf82488212653a6827869784dbbefd3df4c5307bdabce4349e2fe9b99c9a71df105517e06a73220052b
+  data.tar.gz: abfbdd42a184eb2e2bc8482b3efd9b8aeff462bfe487b1e5fbc1a797d37b2c9ac5f6f8b809467431828eb4684a84bebeec0a633a6b2d5beaeda2710ffc344fcb

data/.travis.yml

@@ -0,0 +1,15 @@
+services:
+  - mongodb
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+env:
+  - MONGOID_VERSION=3
+  - MONGOID_VERSION=4
+
+language: ruby
+
+cache: bundler

data/CHANGELOG.md

@@ -1,11 +1,24 @@
-Next Release (0.2.0)
-====================
+Next Release
+------------
+
+* Expose `snapshot_session` for custom snapshot storage - [@joeyAghion](https://github.com/joeyAghion)
+* Compatibility with Mongoid 4.x - [@dblock](https://github.com/dblock).
+
+0.2.0
+-----
+
+Important note for those upgrading from 0.1.0 (pre-Mongoid 3.0) to 0.2.0 (Mongoid 3.x): you'll need to upgrade any
+existing snapshots created by mongoid_collection_snapshot 0.1.0 in your database before they're usable. You can
+do this by renaming the 'workspace_slug' attribute to 'slug' in MongoDB after upgrading. For example,
+to upgrade the snapshot class "MySnapshot", you'd enter the following at the mongo shell:
+
+    db.my_snapshot.rename({'workspace_slug': {'$exists': true}}, {'$rename': {'workspace_slug': 'slug'}})
 
 * Added ability to maintain a snapshot of multiple collections atomically - [@aaw](https://github.com/aaw).
 * Added support for [Mongoid 3.0](https://github.com/mongoid/mongoid) - [@dblock](https://github.com/dblock).
 * Relaxed version limitations of [mongoid_slug](https://github.com/digitalplaywright/mongoid-slug) - [@dblock](https://github.com/dblock).
 
-Version 0.1.0
-=============
+0.1.0
+-----
 
 * Initial public release - [@aaw](https://github.com/aaw).

data/Gemfile

@@ -1,10 +1,18 @@
 source "http://rubygems.org"
 
-gem "mongoid", "~> 3.0"
+case version = ENV['MONGOID_VERSION'] || '~> 3.1'
+when /4/
+  gem 'mongoid', github: 'mongoid/mongoid'
+when /3/
+  gem 'mongoid', '~> 3.1'
+else
+  gem 'mongoid', version
+end
+
 gem "mongoid_slug"
 
 group :development do
-  gem "mongoid", "~> 3.0"
   gem "rspec", "~> 2.11.0"
   gem "jeweler", "~> 1.8.4"
 end
+

data/README.md

@@ -3,11 +3,13 @@ Mongoid Collection Snapshot
 
 Easy maintenance of collections of processed data in MongoDB with the Mongoid 3.x ODM.
 
+[![Build Status](https://travis-ci.org/aaw/mongoid_collection_snapshot.svg)](https://travis-ci.org/aaw/mongoid_collection_snapshot)
+
 Quick example:
 --------------
 
 Suppose that you have a Mongoid model called `Artwork`, stored
-in a MongoDB collection called `artworks` and the underlying documents 
+in a MongoDB collection called `artworks` and the underlying documents
 look something like:
 
     { name: 'Flowers', artist: 'Andy Warhol', price: 3000000 }
@@ -18,10 +20,10 @@ average price of each artist's works, resulting in a collection called
 
     { _id: { artist: 'Andy Warhol'}, value: { price: 1500000 } }
 
-If your system wants to maintain and use this average price data, it has 
+If your system wants to maintain and use this average price data, it has
 to do so at the level of raw MongoDB operations, since
 map/reduce result documents don't map well to models in Mongoid.
-Furthermore, even though map/reduce jobs can take some time to run, you probably 
+Furthermore, even though map/reduce jobs can take some time to run, you probably
 want the entire `artist_average_price` collection populated atomically
 from the point of view of your system, since otherwise you don't ever
 know the state of the data in the collection - you could access it in
@@ -29,7 +31,7 @@ the middle of a map/reduce and get partial, incorrect results.
 
 mongoid_collection_snapshot solves this problem by providing an atomic
 view of collections of data like map/reduce results that live outside
-of Mongoid. 
+of Mongoid.
 
 In the example above, we'd set up our average artist price collection like:
 
@@ -83,14 +85,14 @@ And always be sure that you'll never be looking at partial results. The only
 thing you need to do to hook into mongoid_collection_snapshot is implement the
 method `build`, which populates the collection snapshot and any indexes you need.
 
-By default, mongoid_collection_snapshot maintains the most recent two snapshots 
+By default, mongoid_collection_snapshot maintains the most recent two snapshots
 computed any given time.
 
-Other features
---------------
+Multi-collection snapshots
+--------------------------
 
 You can maintain multiple collections atomically within the same snapshot by
-passing unique collection identifiers to ``collection_snaphot`` when you call it 
+passing unique collection identifiers to ``collection_snaphot`` when you call it
 in your build or query methods:
 
 ``` ruby
@@ -117,6 +119,48 @@ class ArtistStats
 end
 ```
 
+Custom database connections
+---------------------------
+
+Your class can specify a custom database for storage of collection snapshots by overriding the `snapshot_session` instance method. In this example, we memoize the connection at the class level to avoid creating many separate connection instances.
+
+```ruby
+class ArtistStats
+  include Mongoid::CollectionSnapshot
+
+  def build
+    # ...
+  end
+
+  def snapshot_session
+    self.class.snapshot_session
+  end
+
+  def self.snapshot_session
+    @@snapshot_session ||= Moped::Session.new(['127.0.0.1:27017']).tap do |s|
+      s.use :alternate_db
+    end
+  end
+end
+```
+
+Another common way of configuring this is through mongoid.yml.
+
+```yaml
+development:
+  sessions:
+    default:
+      database: dev_data
+    imports:
+      database: dev_imports
+```
+
+```ruby
+  def snapshot_session
+    Mongoid.session('imports')
+  end
+```
+
 License
 =======
 

data/Rakefile

@@ -25,11 +25,11 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = "--color --format progress"
 end
 
-task :default => :test
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/mongoid_collection_snapshot.rb

@@ -13,8 +13,8 @@ module Mongoid::CollectionSnapshot
     
     field :max_collection_snapshot_instances, default: 2
 
-    before_save :build
-    after_save :ensure_at_most_two_instances_exist
+    before_create :build
+    after_create :ensure_at_most_two_instances_exist
     before_destroy :drop_snapshot_collections
   end
 
@@ -26,14 +26,14 @@ module Mongoid::CollectionSnapshot
 
   def collection_snapshot(name=nil)
     if name
-      Mongoid.default_session["#{self.collection.name}.#{name}.#{slug}"]
+      snapshot_session["#{self.collection.name}.#{name}.#{slug}"]
     else
-      Mongoid.default_session["#{self.collection.name}.#{slug}"]
+      snapshot_session["#{self.collection.name}.#{slug}"]
     end
   end
 
   def drop_snapshot_collections
-    Mongoid.default_session.collections.each do |collection|
+    snapshot_session.collections.each do |collection|
       collection.drop if collection.name =~ /^#{self.collection.name}\.([^\.]+\.)?#{slug}$/
     end
   end
@@ -48,5 +48,10 @@ module Mongoid::CollectionSnapshot
       all_instances[self.max_collection_snapshot_instances..-1].each { |instance| instance.destroy }
     end
   end
+
+  # Override to supply custom database connection for snapshots
+  def snapshot_session
+    Mongoid.default_session
+  end
   
 end

data/mongoid_collection_snapshot.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: mongoid_collection_snapshot 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mongoid_collection_snapshot"
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Aaron Windsor"]
-  s.date = "2012-11-04"
+  s.date = "2014-06-07"
   s.description = "Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM"
   s.email = "aaron.windsor@gmail.com"
   s.extra_rdoc_files = [
@@ -17,6 +19,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".travis.yml",
     "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
@@ -27,36 +30,33 @@ Gem::Specification.new do |s|
     "mongoid_collection_snapshot.gemspec",
     "spec/models/artwork.rb",
     "spec/models/average_artist_price.rb",
+    "spec/models/custom_connection_snapshot.rb",
     "spec/models/multi_collection_snapshot.rb",
     "spec/mongoid/collection_snapshot_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/aaw/mongoid_collection_snapshot"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.2.2"
   s.summary = "Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongoid>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 3.1"])
       s.add_runtime_dependency(%q<mongoid_slug>, [">= 0"])
-      s.add_development_dependency(%q<mongoid>, ["~> 3.0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
     else
-      s.add_dependency(%q<mongoid>, ["~> 3.0"])
+      s.add_dependency(%q<mongoid>, ["~> 3.1"])
       s.add_dependency(%q<mongoid_slug>, [">= 0"])
-      s.add_dependency(%q<mongoid>, ["~> 3.0"])
       s.add_dependency(%q<rspec>, ["~> 2.11.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
   else
-    s.add_dependency(%q<mongoid>, ["~> 3.0"])
+    s.add_dependency(%q<mongoid>, ["~> 3.1"])
     s.add_dependency(%q<mongoid_slug>, [">= 0"])
-    s.add_dependency(%q<mongoid>, ["~> 3.0"])
     s.add_dependency(%q<rspec>, ["~> 2.11.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
   end

data/spec/models/custom_connection_snapshot.rb

@@ -0,0 +1,18 @@
+class CustomConnectionSnapshot
+  include Mongoid::CollectionSnapshot
+
+  def self.snapshot_session
+    @@snapshot_session ||= Moped::Session.new(['127.0.0.1:27017']).tap do |session|
+      session.use :snapshot_test
+    end
+  end
+
+  def snapshot_session
+    self.class.snapshot_session
+  end
+
+  def build
+    collection_snapshot.insert('name' => 'foo')
+    collection_snapshot('foo').insert({'name' => 'bar'})
+  end
+end

data/spec/mongoid/collection_snapshot_spec.rb

@@ -4,7 +4,7 @@ module Mongoid
   describe CollectionSnapshot do
 
     context "creating a basic snapshot" do
-      
+
       let!(:flowers)     { Artwork.create(:name => 'Flowers', :artist => 'Andy Warhol', :price => 3000000) }
       let!(:guns)        { Artwork.create(:name => 'Guns', :artist => 'Andy Warhol', :price => 1000000) }
       let!(:vinblastine) { Artwork.create(:name => 'Vinblastine', :artist => 'Damien Hirst', :price => 1500000) }
@@ -31,7 +31,7 @@ module Mongoid
         AverageArtistPrice.latest.should == second
         sleep(1)
         third = AverageArtistPrice.create
-        AverageArtistPrice.latest.should == third        
+        AverageArtistPrice.latest.should == third
       end
 
       it "should only maintain at most two of the latest snapshots to support its calculations" do
@@ -45,7 +45,7 @@ module Mongoid
     end
 
     context "creating a snapshot containing multiple collections" do
-      
+
       it "populates several collections and allows them to be queried" do
         MultiCollectionSnapshot.latest.should be_nil
         10.times { MultiCollectionSnapshot.create }
@@ -76,5 +76,26 @@ module Mongoid
 
     end
 
+    context "with a custom snapshot connection" do
+
+      around(:each) do |example|
+        CustomConnectionSnapshot.snapshot_session.drop
+        example.run
+        CustomConnectionSnapshot.snapshot_session.drop
+      end
+
+      it "builds snapshot in custom database" do
+        snapshot = CustomConnectionSnapshot.create
+        [
+          "#{CustomConnectionSnapshot.collection.name}.foo.#{snapshot.slug}",
+          "#{CustomConnectionSnapshot.collection.name}.#{snapshot.slug}"
+        ].each do |collection_name|
+          Mongoid.default_session[collection_name].find.count.should == 0
+          CustomConnectionSnapshot.snapshot_session[collection_name].find.count.should == 1
+        end
+      end
+
+    end
+
   end
 end

metadata

@@ -1,94 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_collection_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Aaron Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: mongoid_slug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mongoid
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
 description: Easy maintenence of collections of processed data in MongoDB with the
@@ -100,6 +75,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -110,36 +86,33 @@ files:
 - mongoid_collection_snapshot.gemspec
 - spec/models/artwork.rb
 - spec/models/average_artist_price.rb
+- spec/models/custom_connection_snapshot.rb
 - spec/models/multi_collection_snapshot.rb
 - spec/mongoid/collection_snapshot_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/aaw/mongoid_collection_snapshot
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1957011938527181136
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Easy maintenence of collections of processed data in MongoDB with the Mongoid
   ODM
 test_files: []