mongoid_collection_snapshot 0.0.1

data/Gemfile

@@ -0,0 +1,14 @@
+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.
+group :development do
+  gem "mongoid", "~> 2.0.0"
+  gem "bson_ext", "~> 1.3.0"
+  gem "rspec", "~> 2.5.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Art.sy
+
+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.md

@@ -0,0 +1,80 @@
+Mongoid Collection Snapshot
+===========================
+
+Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM.
+
+Example:
+--------
+
+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 }
+
+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 } }
+
+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 
+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
+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. 
+
+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
+
+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')
+
+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 
+computed any given time.
+

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongoid_collection_snapshot"
+  gem.homepage = "http://github.com/aaw/mongoid_collection_snapshot"
+  gem.license = "MIT"
+  gem.summary = %Q{Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM}
+  gem.description = %Q{Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM}
+  gem.email = "aaron.windsor@gmail.com"
+  gem.authors = ["Aaron Windsor"]
+  # dependencies defined in Gemfile
+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
+end
+
+task :default => :test

data/VERSION

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

data/lib/mongoid_collection_snapshot.rb

@@ -0,0 +1,46 @@
+module Mongoid::CollectionSnapshot
+  extend ActiveSupport::Concern
+
+  included do
+    require 'mongoid_slug'
+    
+    include Mongoid::Document
+    include Mongoid::Timestamps::Created
+    include Mongoid::Slug
+
+    field :workspace_basename, default: 'snapshot'
+    slug :workspace_basename, as: :workspace_slug
+    
+    field :max_collection_snapshot_instances, default: 2
+
+    before_save :build
+    after_save :ensure_at_most_two_instances_exist
+    before_destroy :drop_snapshot_collection
+  end
+
+  module ClassMethods
+    def latest
+      order_by([[:created_at, :desc]]).first
+    end
+  end
+
+  def collection_snapshot
+    Mongoid.master.collection("#{self.collection.name}.#{workspace_slug}")
+  end
+
+  def drop_snapshot_collection
+    collection_snapshot.drop
+  end
+
+  # Since we should always be using the latest instance of this class, this method is
+  # called after each save - making sure only at most two instances exists should be
+  # sufficient to ensure that this data can be rebuilt live without corrupting any
+  # existing computations that might have a handle to the previous "latest" instance.
+  def ensure_at_most_two_instances_exist
+    all_instances = self.class.order_by([[:created_at, :desc]]).to_a
+    if all_instances.length > self.max_collection_snapshot_instances
+      all_instances[self.max_collection_snapshot_instances..-1].each { |instance| instance.destroy }
+    end
+  end
+  
+end

data/mongoid_collection_snapshot.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_collection_snapshot}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Windsor"]
+  s.date = %q{2011-09-02}
+  s.description = %q{Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM}
+  s.email = %q{aaron.windsor@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/mongoid_collection_snapshot.rb",
+    "mongoid_collection_snapshot.gemspec",
+    "spec/models/artwork.rb",
+    "spec/models/average_artist_price.rb",
+    "spec/mongoid/collection_snapshot_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/aaw/mongoid_collection_snapshot}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{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/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"])
+    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"])
+    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"])
+  end
+end
+

data/spec/models/artwork.rb

@@ -0,0 +1,7 @@
+class Artwork
+  include Mongoid::Document
+
+  field :name
+  field :artist
+  field :price
+end

data/spec/models/average_artist_price.rb

@@ -0,0 +1,31 @@
+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['sum'];
+          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.find_one({'_id.artist' => artist})
+    doc['value']['sum']/doc['value']['count']
+  end
+
+end

data/spec/mongoid/collection_snapshot_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Mongoid
+  describe CollectionSnapshot do
+
+    context "creating a 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) }
+
+      it "returns nil if no snapshot has been created" do
+        AverageArtistPrice.latest.should be_nil
+      end
+      it "runs the build method on creation" do
+        snapshot = AverageArtistPrice.create
+        snapshot.average_price('Andy Warhol').should == 2000000
+        snapshot.average_price('Damien Hirst').should == 1500000
+      end
+      it "returns the most recent snapshot through the latest methods" do
+        first = AverageArtistPrice.create
+        first.should == AverageArtistPrice.latest
+        # "latest" only works up to a resolution of 1 second since it relies on Mongoid::Timestamp. But this
+        # module is meant to snapshot long-running collection creation, so if you need a resolution of less
+        # than a second for "latest" then you're probably using the wrong gem. In tests, sleeping for a second
+        # makes sure we get what we expect.
+        sleep(1)
+        second = AverageArtistPrice.create
+        AverageArtistPrice.latest.should == second
+        sleep(1)
+        third = AverageArtistPrice.create
+        AverageArtistPrice.latest.should == third        
+      end
+      it "should only maintain at most two of the latest snapshots to support its calculations" do
+        10.times do
+          AverageArtistPrice.create
+          AverageArtistPrice.count.should <= 2
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler/setup'
+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')
+end
+
+require File.expand_path("../../lib/mongoid_collection_snapshot", __FILE__)
+Dir["#{File.dirname(__FILE__)}/models/**/*.rb"].each { |f| require f }
+
+Rspec.configure do |c|
+  c.before(:each) do
+    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+  end
+  c.after(:all) do 
+    Mongoid.master.command({'dropDatabase' => 1})
+  end
+end
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_collection_snapshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-02 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid_slug
+  requirement: &75871620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *75871620
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &75871010 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *75871010
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &75870610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *75870610
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &75796300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *75796300
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &75795230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *75795230
+description: Easy maintenence of collections of processed data in MongoDB with the
+  Mongoid ODM
+email: aaron.windsor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/mongoid_collection_snapshot.rb
+- mongoid_collection_snapshot.gemspec
+- spec/models/artwork.rb
+- spec/models/average_artist_price.rb
+- spec/mongoid/collection_snapshot_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/aaw/mongoid_collection_snapshot
+licenses:
+- MIT
+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: 522934671
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+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/mongoid/collection_snapshot_spec.rb
+- spec/spec_helper.rb