mongoid-versioning 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49bb27c097cf3fdb0f285754a0a2e76a2bf6a109
-  data.tar.gz: 77215e96a879e24f61444baf4c756afd6b22f7ab
+  metadata.gz: ba0af3d7de417dd975815741af4b9ca7d9a481f1
+  data.tar.gz: 12a26c18dc271d597d6416218b6ef5895e3d8aa7
 SHA512:
-  metadata.gz: a75794032f6a722cde9d5b4f162d9bcd781df2b918de7a051ebf1350d31e23a928741873f277a434459de694cbc343486480caf1ea03674947d8c58c4772cf27
-  data.tar.gz: 6c481710e94d7507418aba52b3319c66e3d65e294dfef91bf29315a871ec5b1c0343536b88ba6d9f3e545947602d4bd59a7367968d7226cd9a0b3e3c88e3589a
+  metadata.gz: 43b1158de271a86a3a9de372c35c86e99443dc4f3e29c26f0097f16ffb45cee1a82664967743b6729030f36d896ae2db9144387e6a9f61c2e56628e1d61bb355
+  data.tar.gz: 9f6ee04088d25cd74a1b5caa3893ae1e8a16fa80d1abc6f62c916fa51896f9370701120e1b2d9bc153f18a60e518e6d419b51a1f110a5001e2a98fdf812720bf

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Documentation:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented

data/.travis.yml

@@ -1,11 +1,14 @@
 language: ruby
 services: mongodb
 
+before_install:
+  - gem install bundler
+
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
 
 gemfile:
   - Gemfile

data/README.md

@@ -1,9 +1,9 @@
 # mongoid-versioning [![Build Status](https://travis-ci.org/haihappen/mongoid-versioning.png)](https://travis-ci.org/haihappen/mongoid-versioning)
 
-**Important:** This gem is an extraction of [Mongoid::Versioning](http://mongoid.org/en/mongoid/v3/extras.html#versioning) from the official [mongoid](http://mongoid.org) gem.
+**Important:** This gem is an extraction of [Mongoid::Versioning](http://mongoid.github.io/en/mongoid/docs/extras.html#versioning) from the official [mongoid](http://mongoid.org) gem.
 Since Mongoid::Versioning was removed in the `4.0.0` release of Mongoid, this gem re-enables the functionality of versioned documents.
 
-**Please submit only bug and security fixes**. Neighter I will accept new features nor changes to existing APIs. Please consider forking the project if you want new features to appear! :)
+**Please submit only bug and security fixes**. Neither I will accept new features nor changes to existing APIs. Please consider forking the project if you want new features to appear! :)
 
 ---
 
@@ -58,7 +58,7 @@ end
 
 (The MIT license)
 
-Copyright (c) 2013-2015 Mario Uher
+Copyright (c) 2009-2013 Durran Jordan, 2013-2015 Mario Uher
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/mongoid/core_ext/errors/versioning_not_on_root.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 module Mongoid
   module Errors
-
     # This error is raised when attempting to version an embedded document.
     class VersioningNotOnRoot < MongoidError
-
       # Create the new error.
       #
       # @example Create the new error.
@@ -15,7 +13,7 @@ module Mongoid
       # @since 3.0.0
       def initialize(klass)
         super(
-          compose_message("versioning_not_on_root", { klass: klass })
+          compose_message('versioning_not_on_root', klass: klass)
         )
       end
     end

data/lib/mongoid/core_ext/relations/cascading.rb

@@ -10,11 +10,10 @@ module Mongoid
       # @since 2.0.0.rc.1
       def cascade!
         cascades.each do |name|
-          if !relation_metadata || !relation_metadata.versioned?
-            if meta = relations[name]
-              strategy = meta.cascade_strategy
-              strategy.new(self, meta).cascade if strategy
-            end
+          next unless !relation_metadata || !relation_metadata.versioned?
+          if meta = relations[name]
+            strategy = meta.cascade_strategy
+            strategy.new(self, meta).cascade if strategy
           end
         end
       end

data/lib/mongoid/core_ext/relations/metadata.rb

@@ -12,22 +12,22 @@ module Mongoid
       #
       # @since 2.0.0.rc.1
       def inspect
-%Q{#<Mongoid::Relations::Metadata
-  autobuild:    #{autobuilding?}
-  class_name:   #{class_name}
-  cyclic:       #{cyclic.inspect}
-  counter_cache:#{counter_cached?}
-  dependent:    #{dependent.inspect}
-  inverse_of:   #{inverse_of.inspect}
-  key:          #{key}
-  macro:        #{macro}
-  name:         #{name}
-  order:        #{order.inspect}
-  polymorphic:  #{polymorphic?}
-  relation:     #{relation}
-  setter:       #{setter}
-  versioned:    #{versioned?}>
-}
+        %(#<Mongoid::Relations::Metadata
+          autobuild:    #{autobuilding?}
+          class_name:   #{class_name}
+          cyclic:       #{cyclic.inspect}
+          counter_cache:#{counter_cached?}
+          dependent:    #{dependent.inspect}
+          inverse_of:   #{inverse_of.inspect}
+          key:          #{key}
+          macro:        #{macro}
+          name:         #{name}
+          order:        #{order.inspect}
+          polymorphic:  #{polymorphic?}
+          relation:     #{relation}
+          setter:       #{setter}
+          versioned:    #{versioned?}>
+        )
       end
 
       # Is this relation using Mongoid's internal versioning system?

data/lib/mongoid/core_ext/threaded/lifecycle.rb

@@ -2,6 +2,7 @@ module Mongoid
   module Threaded
     module Lifecycle
       private
+
       # Execute a block in loading revision mode.
       #
       # @example Execute in loading revision mode.
@@ -13,10 +14,10 @@ module Mongoid
       #
       # @since 2.3.4
       def _loading_revision
-        Threaded.begin_execution("load_revision")
+        Threaded.begin_execution('load_revision')
         yield
       ensure
-        Threaded.exit_execution("load_revision")
+        Threaded.exit_execution('load_revision')
       end
 
       module ClassMethods
@@ -29,7 +30,7 @@ module Mongoid
         #
         # @since 2.3.4
         def _loading_revision?
-          Threaded.executing?("load_revision")
+          Threaded.executing?('load_revision')
         end
       end
     end

data/lib/mongoid/core_ext/versioning.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 module Mongoid
-
   # Include this module to get automatic versioning of root level documents.
   # This will add a version field to the +Document+ and a has_many association
   # with all the versions contained in it.
@@ -12,7 +11,7 @@ module Mongoid
 
       embeds_many \
         :versions,
-        class_name: self.name,
+        class_name: name,
         validate: false,
         cyclic: true,
         inverse_of: nil,
@@ -42,19 +41,20 @@ module Mongoid
         )
         new_version._id = nil
         if version_max.present? && versions.length > version_max
-          deleted = versions.first
-          if deleted.respond_to?(:paranoid?) && deleted.paranoid?
-            versions.delete_one(deleted)
+          to_delete = versions.first
+          version_to_delete = to_delete.version
+          if to_delete.respond_to?(:paranoid?) && to_delete.paranoid?
+            versions.delete_one(to_delete)
 
             query = collection.find(atomic_selector)
             query.respond_to?(:update_one) ?
-              query.update_one({ "$pull" => { "versions" => { "version" => deleted.version }}}) :
-              query.update({ "$pull" => { "versions" => { "version" => deleted.version }}})
+              query.update_one('$pull' => { 'versions' => { 'version' => version_to_delete } }) :
+              query.update('$pull' => { 'versions' => { 'version' => version_to_delete } })
           else
-            versions.delete(deleted)
+            versions.where(version: version_to_delete).delete_all
           end
         end
-        self.version = (version || 1 ) + 1
+        self.version = (version || 1) + 1
       end
     end
 
@@ -70,7 +70,7 @@ module Mongoid
         (previous_revision || self).versioned_attributes
       )
       versions.shift if version_max.present? && versions.length > version_max
-      self.version = (version || 1 ) + 1
+      self.version = (version || 1) + 1
       save
     end
 
@@ -81,7 +81,7 @@ module Mongoid
     #
     # @since 2.1.0
     def versioned_changes
-      only_versioned_attributes(changes.except("updated_at"))
+      only_versioned_attributes(changes.except('updated_at'))
     end
 
     # Filters the results of +attributes+ by removing any fields that should
@@ -134,15 +134,15 @@ module Mongoid
     # @todo Remove Mongoid 4 support.
     # @since 2.0.0
     def previous_revision
-      options = self.respond_to?(:mongo_client) ?
-        self.mongo_client.options.symbolize_keys :
-        self.mongo_session.options
+      options = respond_to?(:mongo_client) ?
+        mongo_client.options.symbolize_keys :
+        mongo_session.options
 
       _loading_revision do
-        self.class.unscoped.
-          with(options).
-          where(_id: id).
-          any_of({ version: version }, { version: nil }).first
+        self.class.unscoped
+          .with(options)
+          .where(_id: id)
+          .any_of({ version: version }, version: nil).first
       end
     end
 
@@ -182,7 +182,7 @@ module Mongoid
     # @since 2.1.0
     def only_versioned_attributes(hash)
       versioned = {}
-      hash.except("versions").each_pair do |name, value|
+      hash.except('versions').each_pair do |name, value|
         add_versioned_attribute(versioned, name, value)
       end
       versioned
@@ -210,7 +210,6 @@ module Mongoid
     end
 
     module ClassMethods
-
       # Sets the maximum number of versions to store.
       #
       # @example Set the maximum.

data/lib/mongoid/versioning.rb

@@ -1,18 +1,18 @@
-require "mongoid/core_ext/errors/versioning_not_on_root.rb"
-require "mongoid/core_ext/fields/standard.rb"
-require "mongoid/core_ext/fields/validators/macro.rb"
-require "mongoid/core_ext/hierarchy.rb"
-require "mongoid/core_ext/relations/bindings/embedded/many.rb"
-require "mongoid/core_ext/relations/cascading.rb"
-require "mongoid/core_ext/relations/embedded/batchable.rb"
-require "mongoid/core_ext/relations/embedded/many.rb"
-require "mongoid/core_ext/relations/macros.rb"
-require "mongoid/core_ext/relations/metadata.rb"
-require "mongoid/core_ext/relations/options.rb"
-require "mongoid/core_ext/threaded/lifecycle.rb"
-require "mongoid/core_ext/versioning.rb"
+require 'mongoid/core_ext/errors/versioning_not_on_root.rb'
+require 'mongoid/core_ext/fields/standard.rb'
+require 'mongoid/core_ext/fields/validators/macro.rb'
+require 'mongoid/core_ext/hierarchy.rb'
+require 'mongoid/core_ext/relations/bindings/embedded/many.rb'
+require 'mongoid/core_ext/relations/cascading.rb'
+require 'mongoid/core_ext/relations/embedded/batchable.rb'
+require 'mongoid/core_ext/relations/embedded/many.rb'
+require 'mongoid/core_ext/relations/macros.rb'
+require 'mongoid/core_ext/relations/metadata.rb'
+require 'mongoid/core_ext/relations/options.rb'
+require 'mongoid/core_ext/threaded/lifecycle.rb'
+require 'mongoid/core_ext/versioning.rb'
 
-I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
+I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
 
 module Mongoid
   module Versioning

data/lib/mongoid/versioning/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Versioning
-    VERSION = '1.2.0'
+    VERSION = '2.0.0'.freeze
   end
 end

data/mongoid-versioning.gemspec

@@ -1,14 +1,14 @@
-$: << File.expand_path('../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
 require 'mongoid/versioning/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'mongoid-versioning'
   gem.version       = Mongoid::Versioning::VERSION
-  gem.authors       = 'Mario Uher'
-  gem.email         = 'uher.mario@gmail.com'
+  gem.authors       = ['Durran Jordan', 'Mario Uher']
+  gem.email         = ['durran@gmail.com', 'uher.mario@gmail.com']
   gem.homepage      = 'https://github.com/haihappen/mongoid-versioning'
   gem.summary       = 'Extraction of mongoid-versioning into its own gem.'
-  gem.description   = "Mongoid supports simple versioning through inclusion of the Mongoid::Versioning module."
+  gem.description   = 'Mongoid supports simple versioning through inclusion of the Mongoid::Versioning module.'
   gem.licenses      = ['MIT']
 
   gem.files         = `git ls-files`.split("\n")

data/spec/app/models/address.rb

@@ -1,7 +1,7 @@
 class Address
   include Mongoid::Document
 
-  field :_id, type: String, default: ->{ street.try(:parameterize) }
+  field :_id, type: String, default: -> { street.try(:parameterize) }
 
   attr_accessor :mode
 
@@ -25,10 +25,11 @@ class Address
 
   embedded_in :addressable, polymorphic: true do
     def extension
-      "Testing"
+      'Testing'
     end
+
     def doctor?
-      title == "Dr"
+      title == 'Dr'
     end
   end
 
@@ -38,10 +39,10 @@ class Address
   belongs_to :account
   belongs_to :band
 
-  scope :without_postcode, ->{ where(postcode: nil) }
-  scope :rodeo, ->{ where(street: "Rodeo Dr") } do
+  scope :without_postcode, -> { where(postcode: nil) }
+  scope :rodeo, -> { where(street: 'Rodeo Dr') } do
     def mansion?
-      all? { |address| address.street == "Rodeo Dr" }
+      all? { |address| address.street == 'Rodeo Dr' }
     end
   end
 
@@ -58,11 +59,11 @@ class Address
 
   class << self
     def california
-      where(state: "CA")
+      where(state: 'CA')
     end
 
     def homes
-      where(address_type: "Home")
+      where(address_type: 'Home')
     end
 
     def streets

data/spec/app/models/paranoid_post.rb

@@ -17,7 +17,7 @@ class ParanoidPost
   has_many :authors, dependent: :delete
   has_many :titles, dependent: :restrict
 
-  scope :recent, ->{ where(created_at: { "$lt" => Time.now, "$gt" => 30.days.ago }) }
+  scope :recent, -> { where(created_at: { '$lt' => Time.now, '$gt' => 30.days.ago }) }
 
   before_destroy :before_destroy_stub
   after_destroy :after_destroy_stub
@@ -32,7 +32,7 @@ class ParanoidPost
 
   class << self
     def old
-      where(created_at: { "$lt" => 30.days.ago })
+      where(created_at: { '$lt' => 30.days.ago })
     end
   end
 end

data/spec/app/models/tag.rb

@@ -4,5 +4,5 @@ class Tag
   has_and_belongs_to_many :actors
   has_and_belongs_to_many :articles
   has_and_belongs_to_many :posts
-  has_and_belongs_to_many :related, class_name: "Tag", inverse_of: :related
+  has_and_belongs_to_many :related, class_name: 'Tag', inverse_of: :related
 end

data/spec/app/models/wiki_page.rb

@@ -10,6 +10,6 @@ class WikiPage
   max_versions 5
 
   has_many :comments, dependent: :destroy, validate: false
-  has_many :child_pages, class_name: "WikiPage", dependent: :delete, inverse_of: :parent_pages
-  belongs_to :parent_pages, class_name: "WikiPage", inverse_of: :child_pages
+  has_many :child_pages, class_name: 'WikiPage', dependent: :delete, inverse_of: :parent_pages
+  belongs_to :parent_pages, class_name: 'WikiPage', inverse_of: :child_pages
 end

data/spec/mongoid/errors/versioning_not_on_root_spec.rb

@@ -1,28 +1,26 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Mongoid::Errors::VersioningNotOnRoot do
-
-  describe "#message" do
-
+  describe '#message' do
     let(:error) do
       described_class.new(Address)
     end
 
-    it "contains the problem in the message" do
+    it 'contains the problem in the message' do
       expect(error.message).to include(
-        "Versioning not allowed on embedded document: Address."
+        'Versioning not allowed on embedded document: Address.'
       )
     end
 
-    it "contains the summary in the message" do
+    it 'contains the summary in the message' do
       expect(error.message).to include(
-        "Mongoid::Versioning behaviour is only allowed on documents"
+        'Mongoid::Versioning behaviour is only allowed on documents'
       )
     end
 
-    it "contains the resolution in the message" do
+    it 'contains the resolution in the message' do
       expect(error.message).to include(
-        "Remove the versioning from the embedded Address"
+        'Remove the versioning from the embedded Address'
       )
     end
   end