mongoid_collection_snapshot 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Next Release (0.2.0)
+====================
+
+* 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
+=============
+
+* Initial public release - [@aaw](https://github.com/aaw).

data/Gemfile

@@ -1,14 +1,10 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem "mongoid_slug", ">= 0.8.2"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem "mongoid", "~> 3.0"
+gem "mongoid_slug"
+
 group :development do
-  gem "mongoid", "~> 2.0.0"
-  gem "bson_ext", "~> 1.3.0"
-  gem "rspec", "~> 2.5.0"
-  gem "jeweler", "~> 1.5.2"
+  gem "mongoid", "~> 3.0"
+  gem "rspec", "~> 2.11.0"
+  gem "jeweler", "~> 1.8.4"
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Art.sy
+Copyright (c) 2011-2012 Art.sy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 Mongoid Collection Snapshot
 ===========================
 
-Easy maintenance of collections of processed data in MongoDB with the Mongoid ODM.
+Easy maintenance of collections of processed data in MongoDB with the Mongoid 3.x ODM.
 
 Quick example:
 --------------
@@ -10,13 +10,13 @@ Suppose that you have a Mongoid model called `Artwork`, stored
 in a MongoDB collection called `artworks` and the underlying documents 
 look something like:
 
-  { name: 'Flowers', artist: 'Andy Warhol', price: 3000000 }
+    { name: 'Flowers', artist: 'Andy Warhol', price: 3000000 }
 
 From time to time, your system runs a map/reduce job to compute the
 average price of each artist's works, resulting in a collection called
 `artist_average_price` that contains documents that look like:
 
-  { _id: { artist: 'Andy Warhol'}, value: { price: 1500000 } }
+    { _id: { artist: 'Andy Warhol'}, value: { price: 1500000 } }
 
 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
@@ -33,43 +33,51 @@ of Mongoid.
 
 In the example above, we'd set up our average artist price collection like:
 
-    class AverageArtistPrice
-      include Mongoid::CollectionSnapshot
-
-      def build
-        map = <<-EOS
-          function() {
-            emit({artist: this['artist']}, {count: 1, sum: this['price']})
-          }
-        EOS
-
-        reduce = <<-EOS
-          function(key, values) {
-            var sum = 0;
-            var count = 0;
-            values.forEach(function(value) {
-              sum += value['price'];
-              count += value['count'];
-            });
-            return({count: count, sum: sum});
-          }
-        EOS
-
-        Artwork.collection.map_reduce(map, reduce, :out => collection_snapshot.name)
-      end
-
-      def average_price(artist)
-        doc = collection_snapshot.findOne({'_id.artist': artist})
-        doc['value']['sum']/doc['value']['count']
-      end
-    end
+``` ruby
+class AverageArtistPrice
+  include Mongoid::CollectionSnapshot
+
+  def build
+    map = <<-EOS
+      function() {
+        emit({artist: this['artist']}, {count: 1, sum: this['price']})
+      }
+    EOS
+
+    reduce = <<-EOS
+      function(key, values) {
+        var sum = 0;
+        var count = 0;
+        values.forEach(function(value) {
+          sum += value['price'];
+          count += value['count'];
+        });
+        return({count: count, sum: sum});
+      }
+    EOS
+
+    Mongoid.default_session.command(
+      "mapreduce" => "artworks",
+      map: map,
+      reduce: reduce,
+      out: collection_snapshot.name)
+  end
+
+  def average_price(artist)
+    doc = collection_snapshot.find({'_id.artist': artist}).first
+    doc['value']['sum']/doc['value']['count']
+  end
+end
+```
 
 Now, if you want
 to schedule a recomputation, just call `AverageArtistPrice.create`. The latest
 snapshot is always available as `AverageArtistPrice.latest`, so you can write
 code like:
 
-    warhol_expected_price = AverageArtistPrice.latest.average_price('Andy Warhol')
+``` ruby
+warhol_expected_price = AverageArtistPrice.latest.average_price('Andy Warhol')
+```
 
 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
@@ -85,24 +93,31 @@ You can maintain multiple collections atomically within the same snapshot by
 passing unique collection identifiers to ``collection_snaphot`` when you call it 
 in your build or query methods:
 
-    class ArtistStats
-      include Mongoid::CollectionSnapshot
-
-      def build
-        # ...
-        # define map/reduce for average and max aggregations
-	# ...
-	Artwork.collection.map_reduce(map_avg, reduce_avg, :out => collection_snapshot('average'))
-	Artwork.collection.map_reduce(map_max, reduce_max, :out => collection_snapshot('max'))
-      end
-
-      def average_price(artist)
-        doc = collection_snapshot('average').findOne({'_id.artist': artist})
-        doc['value']['sum']/doc['value']['count']
-      end
-
-      def max_price(artist)
-        doc = collection_snapshot('max').findOne({'_id.artist': artist})
-        doc['value']['max']
-      end
-    end	
+``` ruby
+class ArtistStats
+  include Mongoid::CollectionSnapshot
+
+  def build
+    # ...
+    # define map/reduce for average and max aggregations
+    # ...
+    Mongoid.default_session.command("mapreduce" => "artworks", map: map_avg, reduce: reduce_avg, out: collection_snapshot('average'))
+    Mongoid.default_session.command("mapreduce" => "artworks", map: map_max, reduce: reduce_max, out: collection_snapshot('max'))
+  end
+
+  def average_price(artist)
+    doc = collection_snapshot('average').find({'_id.artist': artist}).first
+    doc['value']['sum']/doc['value']['count']
+  end
+
+  def max_price(artist)
+    doc = collection_snapshot('max').find({'_id.artist': artist}).first
+    doc['value']['max']
+  end
+end
+```
+
+License
+=======
+
+MIT License, see [LICENSE.txt](https://github.com/aaw/mongoid_collection_snapshot/blob/master/LICENSE.txt) for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/mongoid_collection_snapshot.rb

@@ -9,7 +9,7 @@ module Mongoid::CollectionSnapshot
     include Mongoid::Slug
 
     field :workspace_basename, default: 'snapshot'
-    slug :workspace_basename, as: :workspace_slug
+    slug :workspace_basename
     
     field :max_collection_snapshot_instances, default: 2
 
@@ -26,15 +26,15 @@ module Mongoid::CollectionSnapshot
 
   def collection_snapshot(name=nil)
     if name
-      Mongoid.master.collection("#{self.collection.name}.#{name}.#{workspace_slug}")
+      Mongoid.default_session["#{self.collection.name}.#{name}.#{slug}"]
     else
-      Mongoid.master.collection("#{self.collection.name}.#{workspace_slug}")
+      Mongoid.default_session["#{self.collection.name}.#{slug}"]
     end
   end
 
   def drop_snapshot_collections
-    Mongoid.master.collections.each do |collection|
-      collection.drop if collection.name =~ /^#{self.collection.name}\.([^\.]+\.)?#{workspace_slug}$/
+    Mongoid.default_session.collections.each do |collection|
+      collection.drop if collection.name =~ /^#{self.collection.name}\.([^\.]+\.)?#{slug}$/
     end
   end
 

data/mongoid_collection_snapshot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_collection_snapshot"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Windsor"]
-  s.date = "2012-01-24"
+  s.date = "2012-11-04"
   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 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
@@ -33,38 +34,31 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/aaw/mongoid_collection_snapshot"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM"
-  s.test_files = [
-    "spec/models/artwork.rb",
-    "spec/models/average_artist_price.rb",
-    "spec/models/multi_collection_snapshot.rb",
-    "spec/mongoid/collection_snapshot_spec.rb",
-    "spec/spec_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongoid_slug>, [">= 0.8.2"])
-      s.add_development_dependency(%q<mongoid>, ["~> 2.0.0"])
-      s.add_development_dependency(%q<bson_ext>, ["~> 1.3.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 3.0"])
+      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_slug>, [">= 0.8.2"])
-      s.add_dependency(%q<mongoid>, ["~> 2.0.0"])
-      s.add_dependency(%q<bson_ext>, ["~> 1.3.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<mongoid>, ["~> 3.0"])
+      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_slug>, [">= 0.8.2"])
-    s.add_dependency(%q<mongoid>, ["~> 2.0.0"])
-    s.add_dependency(%q<bson_ext>, ["~> 1.3.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<mongoid>, ["~> 3.0"])
+    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
 end
 

data/spec/models/average_artist_price.rb

@@ -20,11 +20,15 @@ class AverageArtistPrice
       }
     EOS
 
-    Artwork.collection.map_reduce(map, reduce, :out => collection_snapshot.name)
+    Mongoid.default_session.command(
+      "mapreduce" => "artworks",
+      map: map,
+      reduce: reduce,
+      out: collection_snapshot.name)
   end
 
   def average_price(artist)
-    doc = collection_snapshot.find_one({'_id.artist' => artist})
+    doc = collection_snapshot.where({'_id.artist' => artist}).first
     doc['value']['sum']/doc['value']['count']
   end
 

data/spec/models/multi_collection_snapshot.rb

@@ -8,7 +8,7 @@ class MultiCollectionSnapshot
   end
 
   def get_names
-    ['foo', 'bar', 'baz'].map{ |x| collection_snapshot(x).find_one['name'] }.join('')
+    ['foo', 'bar', 'baz'].map{ |x| collection_snapshot(x).find.first['name'] }.join('')
   end
 
 end

data/spec/mongoid/collection_snapshot_spec.rb

@@ -54,22 +54,22 @@ module Mongoid
 
       it "safely cleans up all collections used by the snapshot" do
         # Create some collections with names close to the snapshots we'll create
-        Mongoid.master["#{MultiCollectionSnapshot.collection.name}.do.not_delete"].insert({'a' => 1})
-        Mongoid.master["#{MultiCollectionSnapshot.collection.name}.snapshorty"].insert({'a' => 1})
-        Mongoid.master["#{MultiCollectionSnapshot.collection.name}.hello.1"].insert({'a' => 1})
+        Mongoid.default_session["#{MultiCollectionSnapshot.collection.name}.do.not_delete"].insert({'a' => 1})
+        Mongoid.default_session["#{MultiCollectionSnapshot.collection.name}.snapshorty"].insert({'a' => 1})
+        Mongoid.default_session["#{MultiCollectionSnapshot.collection.name}.hello.1"].insert({'a' => 1})
 
         MultiCollectionSnapshot.create
-        before_create = Mongoid.master.collections.map{ |c| c.name }
+        before_create = Mongoid.default_session.collections.map{ |c| c.name }
         before_create.length.should > 0
 
         sleep(1)
         MultiCollectionSnapshot.create
-        after_create = Mongoid.master.collections.map{ |c| c.name }
+        after_create = Mongoid.default_session.collections.map{ |c| c.name }
         collections_created = (after_create - before_create).sort
         collections_created.length.should == 3
 
         MultiCollectionSnapshot.latest.destroy
-        after_destroy = Mongoid.master.collections.map{ |c| c.name }
+        after_destroy = Mongoid.default_session.collections.map{ |c| c.name }
         collections_destroyed = (after_create - after_destroy).sort
         collections_created.should == collections_destroyed
       end

data/spec/spec_helper.rb

@@ -5,20 +5,18 @@ require 'rspec'
 require 'mongoid'
 
 Mongoid.configure do |config|
-  name = "mongoid_collection_snapshot_test"
-  config.master = Mongo::Connection.new.db(name)
-  config.logger = Logger.new('/dev/null')
+  config.connect_to("mongoid_collection_snapshot_test")
 end
 
 require File.expand_path("../../lib/mongoid_collection_snapshot", __FILE__)
 Dir["#{File.dirname(__FILE__)}/models/**/*.rb"].each { |f| require f }
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.before(:each) do
-    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+    Mongoid.purge!
   end
-  c.after(:all) do 
-    Mongoid.master.command({'dropDatabase' => 1})
+  c.after(:all) do
+    Mongoid.default_session.drop
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_collection_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,63 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-24 00:00:00.000000000Z
+date: 2012-11-04 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mongoid_slug
-  requirement: &2156103400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156103400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2156101560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2156101560
-- !ruby/object:Gem::Dependency
-  name: bson_ext
-  requirement: &2156099780 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: *2156099780
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156095320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *2156095320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156093080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *2156093080
+  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
   Mongoid ODM
 email: aaron.windsor@gmail.com
@@ -75,6 +100,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -102,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1729910918776026621
+      hash: -1957011938527181136
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -111,14 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Easy maintenence of collections of processed data in MongoDB with the Mongoid
   ODM
-test_files:
-- spec/models/artwork.rb
-- spec/models/average_artist_price.rb
-- spec/models/multi_collection_snapshot.rb
-- spec/mongoid/collection_snapshot_spec.rb
-- spec/spec_helper.rb
+test_files: []