mongoid-versioning 0.2.0 → 1.0.0.beta1

data/lib/mongoid/versioning.rb

@@ -1,217 +1,20 @@
-# encoding: utf-8
-module Mongoid
+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")
 
-  # 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.
+module Mongoid
   module Versioning
-    extend ActiveSupport::Concern
-
-    included do
-      field :version, type: Integer, default: 1
-
-      embeds_many \
-        :versions,
-        class_name: self.name,
-        validate: false,
-        cyclic: true,
-        inverse_of: nil,
-        versioned: true
-
-      set_callback :save, :before, :revise, if: :revisable?
-
-      class_attribute :version_max
-      self.cyclic = true
-    end
-
-    # Create a new version of the +Document+. This will load the previous
-    # document from the database and set it as the next version before saving
-    # the current document. It then increments the version number. If a #max_versions
-    # limit is set in the model and it's exceeded, the oldest version gets discarded.
-    #
-    # @example Revise the document.
-    #   person.revise
-    #
-    # @since 1.0.0
-    def revise
-      previous = previous_revision
-      if previous && versioned_attributes_changed?
-        new_version = versions.build(
-          previous.versioned_attributes, without_protection: true
-        )
-        new_version._id = nil
-        if version_max.present? && versions.length > version_max
-          deleted = versions.first
-          if deleted.paranoid?
-            versions.delete_one(deleted)
-            collection.find(atomic_selector).
-              update({ "$pull" => { "versions" => { "version" => deleted.version }}})
-          else
-            versions.delete(deleted)
-          end
-        end
-        self.version = (version || 1 ) + 1
-      end
-    end
-
-    # Forces the creation of a new version of the +Document+, regardless of
-    # whether a change was actually made.
-    #
-    # @example Revise the document.
-    #   person.revise!
-    #
-    # @since 2.2.1
-    def revise!
-      versions.build(
-        (previous_revision || self).versioned_attributes, without_protection: true
-      )
-      versions.shift if version_max.present? && versions.length > version_max
-      self.version = (version || 1 ) + 1
-      save
-    end
-
-    # Filters the results of +changes+ by removing any fields that should
-    # not be versioned.
-    #
-    # @return [ Hash ] A hash of versioned changed attributes.
-    #
-    # @since 2.1.0
-    def versioned_changes
-      only_versioned_attributes(changes.except("updated_at"))
-    end
-
-    # Filters the results of +attributes+ by removing any fields that should
-    # not be versioned.
-    #
-    # @return [ Hash ] A hash of versioned attributes.
-    #
-    # @since 2.1.0
-    def versioned_attributes
-      only_versioned_attributes(attributes)
-    end
-
-    # Check if any versioned fields have been modified. This is similar
-    # to +changed?+, except this method also ignores fields set to be
-    # ignored by versioning.
-    #
-    # @return [ Boolean ] Whether fields that will be versioned have changed.
-    #
-    # @since 2.1.0
-    def versioned_attributes_changed?
-      !versioned_changes.empty?
-    end
-
-    # Executes a block that temporarily disables versioning. This is for cases
-    # where you do not want to version on every save.
-    #
-    # @example Execute a save without versioning.
-    #   person.versionless(&:save)
-    #
-    # @return [ Object ] The document or result of the block execution.
-    #
-    # @since 2.0.0
-    def versionless
-      @versionless = true
-      result = yield(self) if block_given?
-      @versionless = false
-      result || self
-    end
-
-    private
-
-    # Find the previous version of this document in the database, or if the
-    # document had been saved without versioning return the persisted one.
-    #
-    # @example Find the last version.
-    #   document.find_last_version
-    #
-    # @return [ Document, nil ] The previously saved document.
-    #
-    # @since 2.0.0
-    def previous_revision
-      _loading_revision do
-        self.class.unscoped.
-          where(_id: id).
-          any_of({ version: version }, { version: nil }).first
-      end
-    end
-
-    # Is the document able to be revised? This is true if the document has
-    # changed and we have not explicitly told it not to version.
-    #
-    # @example Is the document revisable?
-    #   document.revisable?
-    #
-    # @return [ true, false ] If the document is revisable.
-    #
-    # @since 2.0.0
-    def revisable?
-      versioned_attributes_changed? && !versionless?
-    end
-
-    # Are we in versionless mode? This is true if in a versionless block on the
-    # document.
-    #
-    # @example Is the document in versionless mode?
-    #   document.versionless?
-    #
-    # @return [ true, false ] Is the document not currently versioning.
-    #
-    # @since 2.0.0
-    def versionless?
-      @versionless ||= false
-    end
-
-    # Filters fields that should not be versioned out of an attributes hash.
-    # Dynamic attributes are always versioned.
-    #
-    # @param [ Hash ] A hash with field names as keys.
-    #
-    # @return [ Hash ] The hash without non-versioned columns.
-    #
-    # @since 2.1.0
-    def only_versioned_attributes(hash)
-      versioned = {}
-      hash.except("versions").each_pair do |name, value|
-        add_versioned_attribute(versioned, name, value)
-      end
-      versioned
-    end
-
-    # Add the versioned attribute. Will work now for localized fields.
-    #
-    # @api private
-    #
-    # @example Add the versioned attribute.
-    #   model.add_versioned_attribute({}, "name", "test")
-    #
-    # @param [ Hash ] versioned The versioned attributes.
-    # @param [ String ] name The name of the field.
-    # @param [ Object ] value The value for the field.
-    #
-    # @since 3.0.10
-    def add_versioned_attribute(versioned, name, value)
-      field = fields[name]
-      if field && field.localized?
-        versioned["#{name}_translations"] = value
-      else
-        versioned[name] = value if !field || field.versioned?
-      end
-    end
-
-    module ClassMethods
-
-      # Sets the maximum number of versions to store.
-      #
-      # @example Set the maximum.
-      #   Person.max_versions(5)
-      #
-      # @param [ Integer ] number The maximum number to store.
-      #
-      # @return [ Integer ] The max number of versions.
-      def max_versions(number)
-        self.version_max = number.to_i
-      end
-    end
   end
 end

data/mongoid-versioning.gemspec

@@ -13,6 +13,6 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split("\n")
   gem.require_path  = 'lib'
 
-  gem.add_dependency 'activesupport', '>= 3.0'
-  gem.add_dependency 'mongoid', '~> 3.0'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'mongoid', '4.0.0.beta1'
 end

data/spec/app/models/account.rb

@@ -18,10 +18,6 @@ class Account
   has_and_belongs_to_many :agents
   has_one :comment, validate: false
 
-  attr_accessible :nickname, as: [ :default, :admin ]
-  attr_accessible :name, as: [ :default, :admin ]
-  attr_accessible :balance, as: :default
-
   validates_presence_of :name
   validates_presence_of :nickname, on: :upsert
   validates_length_of :name, maximum: 10, on: :create

data/spec/app/models/acolyte.rb

@@ -6,7 +6,7 @@ class Acolyte
   embeds_many :versions, as: :memorable
   belongs_to :church
 
-  default_scope asc(:name)
+  default_scope ->{ asc(:name) }
   scope :active, ->{ where(status: "active") }
   scope :named, ->{ where(:name.exists => true) }
 

data/spec/app/models/address.rb

@@ -38,8 +38,8 @@ 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" }
     end

data/spec/app/models/appointment.rb

@@ -3,5 +3,5 @@ class Appointment
   field :active, type: Boolean, default: true
   field :timed, type: Boolean, default: true
   embedded_in :person
-  default_scope where(active: true)
+  default_scope ->{ where(active: true) }
 end

data/spec/app/models/article.rb

@@ -5,9 +5,6 @@ class Article
   field :is_rss, type: Boolean, default: false
   field :user_login, type: String
 
-  attr_accessible :title, as: [:default, :parser]
-  attr_accessible :is_rss, as: :parser
-  attr_accessible :user_login
   has_and_belongs_to_many :tags, validate: false
   has_and_belongs_to_many :preferences, inverse_of: nil, validate: false
 end

data/spec/app/models/building.rb

@@ -1,7 +1,5 @@
 class Building
   include Mongoid::Document
-  attr_accessible
-  attr_accessible :building_address, :contractors, as: :admin
   embeds_one :building_address
   embeds_many :contractors
 end

data/spec/app/models/building_address.rb

@@ -1,7 +1,5 @@
 class BuildingAddress
   include Mongoid::Document
-  attr_accessible
-  attr_accessible :city, as: :admin
   embedded_in :building
   field :city, type: String
 end

data/spec/app/models/contractor.rb

@@ -1,7 +1,5 @@
 class Contractor
   include Mongoid::Document
-  attr_accessible
-  attr_accessible :name, as: :admin
   embedded_in :building
   field :name, type: String
 end

data/spec/app/models/dog.rb

@@ -2,5 +2,5 @@ class Dog
   include Mongoid::Document
   field :name, type: String
   has_and_belongs_to_many :breeds
-  default_scope asc(:name)
+  default_scope ->{ asc(:name) }
 end

data/spec/app/models/drug.rb

@@ -3,6 +3,4 @@ class Drug
   field :name, type: String
   field :generic, type: Boolean
   belongs_to :person, counter_cache: true
-  attr_accessible :name, as: [ :default, :admin ]
-  attr_accessible :person_id
 end

data/spec/app/models/event.rb

@@ -17,6 +17,6 @@ class Event
     end
   end
 
-  scope :best, where(:kind.in => [ "party", "concert" ])
+  scope :best, ->{ where(:kind.in => [ "party", "concert" ]) }
   scope :by_kind, ->(kind){ where(:kind.in => [kind]) }
 end

data/spec/app/models/game.rb

@@ -13,8 +13,6 @@ class Game
 
   validates_format_of :name, without: /\$\$\$/
 
-  attr_protected :_id
-
   set_callback(:initialize, :after) do |document|
     write_attribute("name", "Testing") unless name
   end

data/spec/app/models/house.rb

@@ -2,7 +2,6 @@ class House
   include Mongoid::Document
   field :name, type: String
   field :model, type: String
-  attr_accessible :name, as: [ :default, :admin ]
 
-  default_scope asc(:name)
+  default_scope ->{ asc(:name) }
 end

data/spec/app/models/item.rb

@@ -3,10 +3,6 @@ class Item
   field :title, type: String
   field :is_rss, type: Boolean, default: false
   field :user_login, type: String
-
-  attr_protected :title, as: [:default, :parser]
-  attr_protected :is_rss, as: :parser
-  attr_protected :user_login
 end
 
 require "app/models/sub_item"

data/spec/app/models/name.rb

@@ -15,8 +15,6 @@ class Name
 
   accepts_nested_attributes_for :language
 
-  attr_protected :_id, :id
-
   def set_parent=(set = false)
     self.parent_title = namable.title if set
   end

data/spec/app/models/paranoid_phone.rb

@@ -1,3 +1,5 @@
+require 'mongoid/paranoia'
+
 class ParanoidPhone
   include Mongoid::Document
   include Mongoid::Paranoia

data/spec/app/models/paranoid_post.rb

@@ -1,3 +1,5 @@
+require 'mongoid/paranoia'
+
 class ParanoidPost
   include Mongoid::Document
   include Mongoid::Versioning
@@ -15,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

data/spec/app/models/person.rb

@@ -23,7 +23,7 @@ class Person
   field :owner_id, type: Integer
   field :security_code
   field :reading, type: Object
-  field :bson_id, type: Moped::BSON::ObjectId
+  field :bson_id, type: BSON::ObjectId
   field :pattern, type: Regexp
   field :override_me, type: Integer
   field :t, as: :test, type: String
@@ -41,8 +41,6 @@ class Person
 
   attr_reader :rescored
 
-  attr_protected :security_code, :owner_id, :appointments
-
   embeds_many :favorites, order: :title.desc, inverse_of: :perp, validate: false
   embeds_many :videos, order: [[ :title, :asc ]], validate: false
   embeds_many :phone_numbers, class_name: "Phone", validate: false
@@ -123,8 +121,8 @@ class Person
   accepts_nested_attributes_for :quiz
   accepts_nested_attributes_for :services, allow_destroy: true
 
-  scope :minor, where(:age.lt => 18)
-  scope :without_ssn, without(:ssn)
+  scope :minor, ->{ where(:age.lt => 18) }
+  scope :without_ssn, ->{ without(:ssn) }
   scope :search, ->(query){ any_of({ title: query }) }
 
   def score_with_rescoring=(score)

data/spec/app/models/player.rb

@@ -6,13 +6,13 @@ class Player
   field :impressions, type: Integer, default: 0
   field :status
 
-  scope :active, where(active: true) do
+  scope :active, ->{ where(active: true) } do
     def extension
       "extension"
     end
   end
 
-  scope :inactive, where(active: false)
+  scope :inactive, ->{ where(active: false) }
   scope :frags_over, ->(count) { where(:frags.gt => count) }
   scope :deaths_under, ->(count) { where(:deaths.lt => count) }
   scope :deaths_over, ->(count) { where(:deaths.gt => count) }

data/spec/app/models/post.rb

@@ -13,8 +13,8 @@ class Post
   has_and_belongs_to_many :tags, before_add: :before_add_tag, after_add: :after_add_tag, before_remove: :before_remove_tag, after_remove: :after_remove_tag
   has_many :videos, validate: false
 
-  scope :recent, where(created_at: { "$lt" => Time.now, "$gt" => 30.days.ago })
-  scope :posting, where(:content.in => [ "Posting" ])
+  scope :recent, ->{ where(created_at: { "$lt" => Time.now, "$gt" => 30.days.ago }) }
+  scope :posting, ->{ where(:content.in => [ "Posting" ]) }
 
   validates_format_of :title, without: /\$\$\$/
 

data/spec/app/models/preference.rb

@@ -5,5 +5,5 @@ class Preference
   field :ranking, type: Integer
   has_and_belongs_to_many :people, validate: false
   validates_length_of :name, minimum: 2, allow_nil: true
-  scope :posting, where(:value.in => [ "Posting" ])
+  scope :posting, ->{ where(:value.in => [ "Posting" ]) }
 end

data/spec/app/models/quiz.rb

@@ -4,7 +4,4 @@ class Quiz
   field :name, type: String
   field :topic, type: String
   embeds_many :pages
-
-  attr_accessible :topic, as: [ :default, :admin ]
-  attr_accessible :name, as: :default
 end

data/spec/app/models/registry.rb

@@ -1,4 +1,4 @@
 class Registry
   include Mongoid::Document
-  field :data, type: Moped::BSON::Binary
+  field :data, type: BSON::Binary
 end

data/spec/app/models/symptom.rb

@@ -2,5 +2,5 @@ class Symptom
   include Mongoid::Document
   field :name, type: String
   embedded_in :person
-  default_scope asc(:name)
+  default_scope ->{ asc(:name) }
 end

data/spec/app/models/tree.rb

@@ -5,5 +5,5 @@ class Tree
   field :evergreen, type: Boolean
 
   scope :verdant, where(evergreen: true)
-  default_scope asc(:name)
+  default_scope ->{ asc(:name) }
 end

data/spec/app/models/video.rb

@@ -9,9 +9,5 @@ class Video
   belongs_to :post
   belongs_to :game
 
-  default_scope asc(:title)
-
-  attr_accessible :title, as: [ :default, :admin ]
-  attr_accessible :year, as: [ :default ]
-  attr_accessible :person_attributes, as: [ :default ]
+  default_scope ->{ asc(:title) }
 end

data/spec/app/models/wiki_page.rb

@@ -9,8 +9,6 @@ class WikiPage
   field :description, type: String, localize: true
   max_versions 5
 
-  attr_protected :author
-
   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

data/spec/config/mongoid.yml

@@ -4,8 +4,6 @@ test:
       database: mongoid_test
       hosts:
         - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
-      options:
-        consistency: :strong
     mongohq_single:
       database: <%=ENV["MONGOHQ_SINGLE_NAME"]%>
       username: <%=ENV["MONGOHQ_SINGLE_USER"]%>
@@ -14,7 +12,6 @@ test:
         - <%=ENV["MONGOHQ_SINGLE_URL"]%>
       options:
         safe: true
-        consistency: :strong
     mongohq_repl:
       database: <%=ENV["MONGOHQ_REPL_NAME"]%>
       username: <%=ENV["MONGOHQ_REPL_USER"]%>
@@ -23,13 +20,11 @@ test:
         - <%=ENV["MONGOHQ_REPL_1_URL"]%>
         - <%=ENV["MONGOHQ_REPL_2_URL"]%>
       options:
-        consistency: :strong
         safe: true
     mongohq_repl_uri:
       uri: <%= ENV["MONGOHQ_REPL_URI"]%>
   options:
     allow_dynamic_fields: true
-    identity_map_enabled: false
     include_root_in_json: false
     include_type_for_serialization: false
     preload_models: false

data/spec/mongoid/errors/versioning_not_on_root_spec.rb

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

data/spec/mongoid/relations/macros_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Mongoid::Relations::Macros do
+  describe ".embedded_in" do
+    context "when the document is versioned" do
+      it "raises an error" do
+        expect {
+          Class.new do
+            include Mongoid::Document
+            include Mongoid::Versioning
+            embedded_in :parent_class
+          end
+        }.to raise_error(Mongoid::Errors::VersioningNotOnRoot)
+      end
+    end
+  end
+end

data/spec/mongoid/relations/metadata_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Mongoid::Relations::Metadata do
+  describe "#versioned?" do
+
+    context "when versioned is true" do
+
+      let(:metadata) do
+        described_class.new(
+          name: :versions,
+          relation: Mongoid::Relations::Embedded::Many,
+          versioned: true
+        )
+      end
+
+      it "returns true" do
+        metadata.should be_versioned
+      end
+    end
+
+    context "when versioned is false" do
+
+      let(:metadata) do
+        described_class.new(
+          name: :versions,
+          relation: Mongoid::Relations::Embedded::Many,
+          versioned: false
+        )
+      end
+
+      it "returns false" do
+        metadata.should_not be_versioned
+      end
+    end
+
+    context "when versioned is nil" do
+
+      let(:metadata) do
+        described_class.new(
+          name: :versions,
+          relation: Mongoid::Relations::Embedded::Many
+        )
+      end
+
+      it "returns false" do
+        metadata.should_not be_versioned
+      end
+    end
+  end
+end