mongoid 2.5.2 → 2.6.0

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 For instructions on upgrading to newer versions, visit
 [mongoid.org](http://mongoid.org/docs/upgrading.html).
 
+## 2.6.0
+
+### New Features
+
+* \#2709 Backported the `touch` functionality from Mongoid 3.
+
 ## 2.5.2
 
 ### Resolved Issues

data/lib/mongoid/atomic.rb

@@ -281,5 +281,29 @@ module Mongoid #:nodoc:
       mods.add_to_set(doc.atomic_array_add_to_sets)
       mods.pull_all(doc.atomic_array_pulls)
     end
+
+
+    # Get the atomic updates for a touch operation. Should only include the
+    # updated_at field and the optional extra field.
+    #
+    # @api private
+    #
+    # @example Get the touch atomic updates.
+    #   document.touch_atomic_updates
+    #
+    # @param [ Symbol ] field The optional field.
+    #
+    # @return [ Hash ] The atomic updates.
+    #
+    # @since 2.6.0
+    def touch_atomic_updates(field = nil)
+      updates = atomic_updates
+      return {} unless atomic_updates.has_key?("$set")
+      touches = {}
+      updates["$set"].each_pair do |key, value|
+        touches.merge!({ key => value }) if key =~ /updated_at|#{field}/
+      end
+      { "$set" => touches }
+    end
   end
 end

data/lib/mongoid/persistence.rb

@@ -79,6 +79,39 @@ module Mongoid #:nodoc:
       return true
     end
 
+
+    # Touch the document, in effect updating its updated_at timestamp and
+    # optionally the provided field to the current time. If any belongs_to
+    # relations exist with a touch option, they will be updated as well.
+    #
+    # @example Update the updated_at timestamp.
+    #   document.touch
+    #
+    # @example Update the updated_at and provided timestamps.
+    #   document.touch(:audited)
+    #
+    # @note This will not autobuild relations if those options are set.
+    #
+    # @param [ Symbol ] field The name of an additional field to update.
+    #
+    # @return [ true/false ] false if record is new_record otherwise true.
+    #
+    # @since 2.6.0
+    def touch(field = nil)
+      return false if _root.new_record?
+      current = Time.now
+      write_attribute(:updated_at, current) if fields["updated_at"]
+      write_attribute(field, current) if field
+
+      touches = touch_atomic_updates(field)
+      unless touches.empty?
+        _root.collection.update(atomic_selector, touches)
+      end
+
+      touchables.each { |name| send(name).try(:touch) }
+      move_changes and true
+    end
+
     # Update the document in the datbase.
     #
     # @example Update an existing document.

data/lib/mongoid/relations.rb

@@ -24,6 +24,7 @@ require "mongoid/relations/referenced/many_to_many"
 require "mongoid/relations/referenced/one"
 require "mongoid/relations/reflections"
 require "mongoid/relations/synchronization"
+require "mongoid/relations/touchable"
 require "mongoid/relations/metadata"
 require "mongoid/relations/macros"
 
@@ -43,6 +44,7 @@ module Mongoid # :nodoc:
     include Polymorphic
     include Reflections
     include Synchronization
+    include Touchable
 
     attr_accessor :metadata
 

data/lib/mongoid/relations/macros.rb

@@ -134,6 +134,7 @@ module Mongoid # :nodoc:
             reference(meta)
             autosave(meta)
             validates_relation(meta)
+            touchable(meta)
           end
         end
         alias :belongs_to_related :belongs_to

data/lib/mongoid/relations/metadata.rb

@@ -754,6 +754,18 @@ module Mongoid # :nodoc:
         !!order
       end
 
+      # Is this relation touchable?
+      #
+      # @example Is the relation touchable?
+      #   metadata.touchable?
+      #
+      # @return [ true, false ] If the relation can be touched.
+      #
+      # @since 3.0.0
+      def touchable?
+        !!self[:touch]
+      end
+
       private
 
       # Returns the class name for the relation.

data/lib/mongoid/relations/referenced/in.rb

@@ -240,7 +240,7 @@ module Mongoid # :nodoc:
           #
           # @since 2.1.0
           def valid_options
-            [ :autosave, :foreign_key, :index, :polymorphic ]
+            [ :autosave, :foreign_key, :index, :polymorphic, :touch ]
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/touchable.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Touchable
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :touchables
+        self.touchables = []
+      end
+
+      module ClassMethods
+
+        # Add the metadata to the touchable relations if the touch option was
+        # provided.
+        #
+        # @example Add the touchable.
+        #   Model.touchable(meta)
+        #
+        # @param [ Metadata ] metadata The relation metadata.
+        #
+        # @return [ Class ] The model class.
+        #
+        # @since 3.0.0
+        def touchable(metadata)
+          self.touchables.push(metadata.name) if metadata.touchable?
+          self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Mongoid #:nodoc
-  VERSION = "2.5.2"
+  VERSION = "2.6.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 2
-  - 5
-  - 2
-  version: 2.5.2
+  - 6
+  - 0
+  version: 2.6.0
 platform: ruby
 authors: 
 - Durran Jordan
@@ -123,6 +123,22 @@ dependencies:
   type: :development
   name: guard-rspec
   requirement: *id007
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  prerelease: false
+  type: :development
+  name: rb-fsevent
+  requirement: *id008
 description: Mongoid is an ODM (Object Document Mapper) Framework for MongoDB, written in Ruby.
 email: 
 - durran@gmail.com
@@ -380,6 +396,7 @@ files:
 - lib/mongoid/relations/synchronization.rb
 - lib/mongoid/relations/targets/enumerable.rb
 - lib/mongoid/relations/targets.rb
+- lib/mongoid/relations/touchable.rb
 - lib/mongoid/relations.rb
 - lib/mongoid/reloading.rb
 - lib/mongoid/safety.rb