lib/nanoc3/base/layout.rb in nanoc3-3.1.9 vs lib/nanoc3/base/layout.rb in nanoc3-3.2.0a1

@@ -14,51 +14,84 @@
 
     # @return [Hash] This layout's attributes
     attr_reader :attributes
 
     # @return [String] This layout's identifier, starting and ending with a
-    # slash
+    #   slash
     attr_accessor :identifier
 
-    # @return [Time] The time when this layout was last modified
-    attr_reader :mtime
+    # @return [Time] The time where this layout was last modified
+    attr_reader   :mtime
 
+    # @return [String] The checksum of this layout that was in effect during
+    #   the previous site compilation
+    attr_accessor :old_checksum
+
+    # @return [String] The current, up-to-date checksum of this layout
+    attr_reader   :new_checksum
+
+    # @return [Boolean] Whether or not this layout is outdated because of its
+    #   dependencies are outdated
+    attr_accessor :outdated_due_to_dependencies
+    alias_method :outdated_due_to_dependencies?, :outdated_due_to_dependencies
+
     # Creates a new layout.
     #
     # @param [String] raw_content The raw content of this layout.
     #
     # @param [Hash] attributes A hash containing this layout's attributes.
     #
     # @param [String] identifier This layout's identifier.
     #
-    # @param [Time, Hash, nil] params_or_mtime Extra parameters for the
-    # layout, or the time when this layout was last modified (deprecated).
+    # @param [Time, Hash] params Extra parameters. For backwards
+    #   compatibility, this can be a Time instance indicating the time when
+    #   this layout was last modified (mtime).
     #
-    # @option params_or_mtime [Time, nil] :mtime (nil) The time when this
-    # layout was last modified
-    def initialize(raw_content, attributes, identifier, params_or_mtime=nil)
-      # Get params and mtime
-      # TODO [in nanoc 4.0] clean this up
-      if params_or_mtime.nil? || params_or_mtime.is_a?(Time)
-        params = {}
-        @mtime = params_or_mtime
-      elsif params_or_mtime.is_a?(Hash)
-        params = params_or_mtime
-        @mtime = params[:mtime]
-      end
+    # @option params [Time, nil] :mtime (nil) The time when this layout was
+    #   last modified
+    #
+    # @option params [String, nil] :checksum (nil) The current, up-to-date
+    #   checksum of this layout
+    def initialize(raw_content, attributes, identifier, params=nil)
+      # Get mtime and checksum
+      params ||= {}
+      params = { :mtime => params } if params.is_a?(Time)
+      @new_checksum = params[:checksum]
+      @mtime        = params[:mtime]
 
       @raw_content  = raw_content
       @attributes   = attributes.symbolize_keys
-      @identifier   = identifier.cleaned_identifier.freeze
+      @identifier   = identifier.cleaned_identifier
     end
 
     # Requests the attribute with the given key.
     #
     # @param [Symbol] key The name of the attribute to fetch.
     #
     # @return [Object] The value of the requested attribute.
     def [](key)
       @attributes[key]
+    end
+
+    # @return [Boolean] true if the layout was modified since the site was
+    #   last compiled, false otherwise
+    def outdated?
+      !self.old_checksum || !self.new_checksum || self.new_checksum != self.old_checksum
+    end
+
+    # Returns the type of this object. Will always return `:layout`, because
+    # this is a layout. For items, this method returns `:item`.
+    #
+    # @return [Symbol] :layout
+    def type
+      :layout
+    end
+
+    # Returns an object that can be used for uniquely identifying objects.
+    #
+    # @return [Object] An unique reference to this object
+    def reference
+      [ type, self.identifier ]
     end
 
     def inspect
       "<#{self.class}:0x#{self.object_id.to_s(16)} identifier=#{self.identifier}>"
     end