mongoid-collection-snapshot 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdda543f7183d461cf4b7068b97c7c9bba6523b9
-  data.tar.gz: a83c53f21498ad03d49089382dd9e519a9451d79
+  metadata.gz: a83bba2b3b5308ff4015fb6b1160946e9ce76acc
+  data.tar.gz: 74c2c24fcee8b86d53cd090cddcb3dd9b59ce117
 SHA512:
-  metadata.gz: de91fdde1b8c8b6457cdcecb4e91eec67f4eb3fddf0f96702092ef3a8df9e4747401571d1475478e1f82e28b33133287df422fce178ac245c238c6474de2be93
-  data.tar.gz: c9682df34fa35b1e444f6f10ccbf28a15517ca141c397d689493aca9de664c0c524cebb11c1a58f7a3abafd15fca855ac233fa3c1d538e408c3fc494392558c4
+  metadata.gz: b4d4d635979850c86c773192dea47a00497a48a5d1220fce28e80cae6e002960ffa3a9f7db48ac5be62c6c22043120dbf4bb117971705561f831fb617b033ad3
+  data.tar.gz: ac843dacc50abd245f56487ddaa49542d2aed4cc70d4a82ab9e84d359b0bc2306217471db489db6a70ff7798babd7736c6fdd042ab230958204507be1e3853fa

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-01-20 11:17:06 -0500 using RuboCop version 0.47.1.
+# on 2017-01-20 15:27:40 -0500 using RuboCop version 0.47.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -37,13 +37,13 @@ Metrics/BlockLength:
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 42
+# Offense count: 43
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 192
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 31
@@ -57,11 +57,15 @@ Metrics/ModuleLength:
 Metrics/PerceivedComplexity:
   Max: 10
 
-# Offense count: 2
+# Offense count: 6
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
+    - 'example/artist.rb'
+    - 'example/artist_artwork_price.rb'
+    - 'example/artist_artwork_price_mr.rb'
+    - 'example/artwork.rb'
     - 'lib/mongoid-collection-snapshot.rb'
 
 # Offense count: 1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 1.3.2 (Next)
+
+* Your contribution here.
+
+### 1.3.1 (5/22/2017)
+
+* [#11](https://github.com/mongoid/mongoid-collection-snapshot/pull/11): Fix: incorrect connection used with Mongoid 6 - [@dblock](https://github.com/dblock).
+* [#8](https://github.com/mongoid/mongoid-collection-snapshot/pull/8): Lock mongoid-compatibility at 0.4.0 or newer - [@dblock](https://github.com/dblock).
+
 ### 1.3.0 (1/20/2017)
 
 * [#2](https://github.com/mongoid/mongoid-collection-snapshot/pull/2): Support for Mongoid 6 - [@dblock](https://github.com/dblock).

data/LICENSE.txt

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

data/README.md

@@ -8,30 +8,27 @@ This is a forked, renamed, maintained and supported version of [mongoid_collecti
 [![Gem Version](https://badge.fury.io/rb/mongoid-collection-snapshot.svg)](https://badge.fury.io/rb/mongoid-collection-snapshot)
 [![Build Status](https://travis-ci.org/mongoid/mongoid-collection-snapshot.svg)](https://travis-ci.org/mongoid/mongoid-collection-snapshot)
 
-Quick example:
---------------
+### 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 }
+    { name: 'Flowers', artist_id: ..., 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:
+From time to time, your system runs a map/reduce job to compute the total price of all artist's works, resulting in a collection called `artist_artwork_price` that contains documents that look like:
 
-    { _id: { artist: 'Andy Warhol' }, value: { price: 1500000 } }
+    { _id: ..., artist_id: ..., sum: 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.
+If your system wants to maintain and use this 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_artwork_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.
 
 A 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:
+In the example below, we set up our artist price sum collection by including `Mongoid::CollectionSnapshot` and implementing a `build` method.
 
 ``` ruby
-class AverageArtistPrice
+class ArtistArtworkPrice
   include Mongoid::CollectionSnapshot
 
   def build
-
     map = <<-EOS
       function() {
         emit({ artist_id: this['artist_id']}, { count: 1, sum: this['price'] })
@@ -59,35 +56,27 @@ class AverageArtistPrice
     end
   end
 end
-
 ```
 
-Now, if you want to schedule a recomputation, just call `AverageArtistPrice.create`. You can define other methods on collection snapshots.
+Now, if you want to schedule a recomputation, just call `ArtistArtworkPrice.create`.
 
-```ruby
-class AverageArtistPrice
-  ...
+The latest snapshot is always available as `ArtistArtworkPrice.latest`.
 
-  def average_price(artist_name)
-    artist = Artist.where(name: artist_name).first
-    doc = collection_snapshot.where(artist_id: artist.id).first
-    doc['sum'] / doc['count']
-  end
-end
+```ruby
+andy_warhol = Artist.where(name: 'Andy Warhol').first
+andy_warhol_price = ArtistArtworkPrice.latest.collection_snapshot.where(artist_id: andy_warhol.id).first
+average_price = andy_warhol_price['sum'] / andy_warhol_price['count']
 ```
 
-The latest snapshot is always available as `AverageArtistPrice.latest`, so you can write code like:
+### Snapshot Cleanup
+
+By default, mongoid-collection-snapshot maintains the most recent two snapshots computed any given time. Set `max_collection_snapshot_instances` to change this.
 
 ```ruby
-warhol_expected_price = AverageArtistPrice.latest.average_price('Andy Warhol')
+ArtistArtworkPrice.max_collection_snapshot_instances = 3
 ```
 
-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.
-
-ery Snapshot Data with Mongoid
---------------------------------
+### Query Snapshot Data with Mongoid
 
 You can do better than the average price example above and define first-class models for your collection snapshot data, then access them as any other Mongoid collection via collection snapshot's `.documents` method.
 
@@ -107,7 +96,7 @@ class AverageArtistPrice
 end
 ```
 
-Another example iterates through all latest artist price averages.
+The following example iterates through all latest artist price averages.
 
 ```ruby
 AverageArtistPrice.latest.documents.each do |doc|
@@ -115,19 +104,18 @@ AverageArtistPrice.latest.documents.each do |doc|
 end
 ```
 
-Multi-collection snapshots
---------------------------
+This code can be found in the [example](example) folder.
+
+### 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 in your build or query methods:
 
 ``` ruby
-class ArtistStats
+class ArtistArtworkPrice
   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
@@ -147,7 +135,7 @@ end
 Specify the name of the collection to define first class Mongoid models.
 
 ```ruby
-class ArtistStats
+class ArtistArtworkPrice
   document('average') do
     field :value, type: Hash
   end
@@ -161,27 +149,26 @@ end
 Access these by name.
 
 ```ruby
-ArtistStats.latest.documents('average')
-ArtistStats.latest.documents('max')
+ArtistArtworkPrice.latest.documents('average')
+ArtistArtworkPrice.latest.documents('max')
 ```
 
 If fields across multiple collection snapshots are identical, a single default `document` is sufficient.
 
 ```ruby
-class ArtistStats
+class ArtistArtworkPrice
   document do
     field :value, type: Hash
   end
 end
 ```
 
-Custom database connections
----------------------------
+### 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
+class ArtistArtworkPrice
   include Mongoid::CollectionSnapshot
 
   def build
@@ -189,13 +176,7 @@ class ArtistStats
   end
 
   def snapshot_session
-    self.class.snapshot_session
-  end
-
-  def self.snapshot_session
-    @@snapshot_session ||= Mongo::Client.new('mongodb://localhost:27017').tap do |c|
-      c.use :alternate_db
-    end
+    @snapshot_session ||= Mongo::Client.new('mongodb://localhost:27017/artists_and_artworks')
   end
 end
 ```
@@ -212,12 +193,13 @@ development:
 ```
 
 ```ruby
-  def snapshot_session
-    Mongoid.session('imports')
-  end
+def snapshot_session
+  Mongoid.session('imports')
+end
 ```
 
-License
-=======
+### License
+
+Copyright (c) 2011-2017 Art.sy Inc. and Contributors
 
 MIT License, see [LICENSE.txt](LICENSE.txt) for details.

data/RELEASING.md

@@ -0,0 +1,68 @@
+Releasing Mongoid::CollectionSnapshot
+=====================================
+
+There're no particular rules about when to release mongoid-collection-snapshot. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/mongoid/mongoid-collection-snapshot) for all supported platforms.
+
+Increment the version, modify [lib/mongoid/collection-snapshot/version.rb](lib/mongoid/collection-snapshot/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.4.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.4.0 (2014-01-27)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid-collection-snapshot/version.rb
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+mongoid-collection-snapshot 0.4.0 built to pkg/mongoid-collection-snapshot-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed mongoid-collection-snapshot 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Increment the minor version, modify [lib/mongoid-collection-snapshot/version.rb](lib/mongoid-collection-snapshot/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid-collection-snapshot/version.rb
+git commit -m "Preparing for next release, 0.4.1."
+git push origin master
+```

data/example/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'faker'
+gem 'mongoid'
+gem 'mongoid-collection-snapshot', path: '../'

data/example/artist.rb

@@ -0,0 +1,6 @@
+class Artist
+  include Mongoid::Document
+
+  field :name, type: String
+  has_many :artworks
+end

data/example/artist_artwork_price.rb

@@ -0,0 +1,19 @@
+class ArtistArtworkPrice
+  include Mongoid::CollectionSnapshot
+
+  document do
+    field :count, type: Integer
+    field :sum, type: Integer
+    belongs_to :artist, inverse_of: nil
+  end
+
+  def build
+    Artist.all.each do |artist|
+      collection_snapshot.insert_one(
+        artist_id: artist.id,
+        count: artist.artworks.count,
+        sum: artist.artworks.sum(&:price)
+      )
+    end
+  end
+end

data/example/artist_artwork_price_mr.rb

@@ -0,0 +1,37 @@
+class AverageArtistPriceMR
+  include Mongoid::CollectionSnapshot
+
+  document do
+    field :count, type: Integer
+    field :sum, type: Integer
+    belongs_to :artist, inverse_of: nil
+  end
+
+  def build
+    map = <<-EOS
+      function() {
+        emit({ artist_id: this['artist_id']}, { 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.map_reduce(map, reduce).out(inline: 1).each do |doc|
+      collection_snapshot.insert_one(
+        artist_id: doc['_id']['artist_id'],
+        count: doc['value']['count'],
+        sum: doc['value']['sum']
+      )
+    end
+  end
+end

data/example/artwork.rb

@@ -0,0 +1,8 @@
+class Artwork
+  include Mongoid::Document
+
+  field :title, type: String
+  field :price, type: Integer
+
+  belongs_to :artist
+end

data/example/example.rb

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'bundler/setup'
+Bundler.require
+
+require 'artist'
+require 'artwork'
+
+require 'artist_artwork_price'
+require 'artist_artwork_price_mr'
+
+Mongoid.configure do |config|
+  config.connect_to('mongoid-collection-snapshot_example')
+end
+
+Mongoid.logger.level = Logger::INFO
+Mongo::Logger.logger.level = Logger::INFO
+
+Mongoid.purge!
+
+3.times do
+  Artist.create!(name: Faker::Name.name)
+end
+
+3.times do
+  puts 'Creating more artworks ...'
+  Artist.all.each do |artist|
+    rand(10).times do
+      Artwork.create!(
+        artist: artist,
+        title: Faker::Hipster.sentence,
+        price: Faker::Number.between(1, 1000)
+      )
+    end
+  end
+
+  snapshot = ArtistArtworkPrice.create # AverageArtistPriceMR.create
+
+  snapshot.documents.each do |row|
+    puts "  the total price of #{row.count} artwork(s) by #{row.artist.name} is $#{row.sum}"
+  end
+end
+
+Mongoid.purge!

data/lib/mongoid-collection-snapshot.rb

@@ -44,7 +44,8 @@ module Mongoid
             store_in collection: collection_name
           end
           if Mongoid::Compatibility::Version.mongoid6?
-            PersistenceContext.set(klass, database: snapshot_session.database.name)
+            ctx = PersistenceContext.set(klass, {})
+            ctx.instance_variable_set(:@client, snapshot_session)
           elsif Mongoid::Compatibility::Version.mongoid5?
             klass.mongo_client = snapshot_session
           else

data/lib/mongoid-collection-snapshot/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module CollectionSnapshot
-    VERSION = '1.3.0'.freeze
+    VERSION = '1.3.1'.freeze
   end
 end

data/mongoid-collection-snapshot.gemspec

@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
   s.summary = 'Easy maintenence of collections of processed data in MongoDB with the Mongoid ODM.'
   s.add_dependency 'mongoid', '>= 3.0'
-  s.add_dependency 'mongoid-compatibility'
+  s.add_dependency 'mongoid-compatibility', '>= 0.4.0'
   s.add_dependency 'mongoid-slug'
 end

data/spec/mongoid/collection_snapshot_spec.rb

@@ -154,9 +154,7 @@ module Mongoid
 
       context '#documents' do
         it 'uses the custom session' do
-          if Mongoid::Compatibility::Version.mongoid6?
-            expect(CustomConnectionSnapshot.new.documents.database_name).to eq :snapshot_test
-          elsif Mongoid::Compatibility::Version.mongoid5?
+          if Mongoid::Compatibility::Version.mongoid5? || Mongoid::Compatibility::Version.mongoid6?
             expect(CustomConnectionSnapshot.new.documents.mongo_client).to eq CustomConnectionSnapshot.snapshot_session
           else
             expect(CustomConnectionSnapshot.new.documents.mongo_session).to eq CustomConnectionSnapshot.snapshot_session

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-collection-snapshot
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Aaron Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: mongoid-slug
   requirement: !ruby/object:Gem::Requirement
@@ -68,8 +68,15 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - UPGRADING.md
+- example/Gemfile
+- example/artist.rb
+- example/artist_artwork_price.rb
+- example/artist_artwork_price_mr.rb
+- example/artwork.rb
+- example/example.rb
 - lib/mongoid-collection-snapshot.rb
 - lib/mongoid-collection-snapshot/version.rb
 - mongoid-collection-snapshot.gemspec
@@ -101,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Easy maintenence of collections of processed data in MongoDB with the Mongoid