nanoc 3.8.0 → 4.0.0a1

data/lib/nanoc/base/source_data/identifier.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+module Nanoc
+  class Identifier
+    include Comparable
+
+    def initialize(string)
+      @string = "/#{string}/".gsub(/^\/+|\/+$/, '/').freeze
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+    alias_method :eql?, :==
+
+    def hash
+      self.class.hash ^ to_s.hash
+    end
+
+    def =~(pat)
+      to_s =~ pat
+    end
+
+    def <=>(other)
+      to_s <=> other.to_s
+    end
+
+    # @return [String]
+    def chop
+      to_s.chop
+    end
+
+    # @return [String]
+    def +(string)
+      to_s + string
+    end
+
+    def to_s
+      @string
+    end
+
+    def to_str
+      @string
+    end
+
+    def inspect
+      "<Nanoc::Identifier #{to_s.inspect}>"
+    end
+  end
+end

data/lib/nanoc/base/source_data/item.rb

@@ -1,29 +1,21 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Represents a compileable item in a site. It has content and attributes, as
   # well as an identifier (which starts and ends with a slash). It can also
   # store the modification time to speed up compilation.
+  #
+  # @api private
   class Item
-    extend Nanoc::Memoization
+    extend Nanoc::Int::Memoization
 
     # @return [Hash] This item's attributes
     attr_accessor :attributes
 
-    # A string that uniquely identifies an item in a site.
-    #
-    # Identifiers start and end with a slash. They are comparable to paths on
-    # the filesystem, with the difference that file system paths usually do
-    # not have a trailing slash. The item hierarchy (parent and children of
-    # items) is determined by the item identifier.
-    #
-    # The root page (the home page) has the identifier “/”, which means
-    # that it is the ancestor of all other items.
-    #
-    # @return [String] This item's identifier
+    # @return [Nanoc::Identifier] This item's identifier
     attr_accessor :identifier
 
-    # @return [Array<Nanoc::ItemRep>] This item’s list of item reps
+    # @return [Array<Nanoc::Int::ItemRep>] This item’s list of item reps
     attr_reader :reps
 
     # @return [String] This item's raw, uncompiled content of this item (only
@@ -34,14 +26,14 @@ module Nanoc
     #   item’s content
     attr_reader :raw_filename
 
-    # @return [Nanoc::Site] The site this item belongs to
+    # @return [Nanoc::Int::Site] The site this item belongs to
     attr_accessor :site
 
-    # @return [Nanoc::Item, nil] The parent item of this item. This can be
+    # @return [Nanoc::Int::Item, nil] The parent item of this item. This can be
     #   nil even for non-root items.
     attr_accessor :parent
 
-    # @return [Array<Nanoc::Item>] The child items of this item
+    # @return [Array<Nanoc::Int::Item>] The child items of this item
     attr_accessor :children
 
     # Creates a new item with the given content or filename, attributes and
@@ -55,21 +47,13 @@ module Nanoc
     #
     # @param [String] identifier This item's identifier.
     #
-    # @param [Time, Hash] params Extra parameters. For backwards
-    #   compatibility, this can be a Time instance indicating the time when
-    #   this item was last modified (mtime).
-    #
-    # @option params [Time, nil] :mtime (nil) The time when this item was last
-    #   modified. Deprecated; pass the modification time as the `:mtime`
-    #   attribute instead.
+    # @param [Hash] params Extra parameters.
     #
     # @option params [Symbol, nil] :binary (true) Whether or not this item is
     #   binary
-    def initialize(raw_content_or_raw_filename, attributes, identifier, params = nil)
+    def initialize(raw_content_or_raw_filename, attributes, identifier, params = {})
       # Parse params
-      params ||= {}
-      params = { mtime: params } if params.is_a?(Time)
-      params[:binary] = false unless params.key?(:binary)
+      params = params.merge(binary: false) unless params.key?(:binary)
 
       if raw_content_or_raw_filename.nil?
         raise "attempted to create an item with no content/filename (identifier #{identifier})"
@@ -85,8 +69,8 @@ module Nanoc
       end
 
       # Get rest of params
-      @attributes   = attributes.symbolize_keys_recursively
-      @identifier   = identifier.cleaned_identifier.freeze
+      @attributes   = attributes.__nanoc_symbolize_keys_recursively
+      @identifier   = Nanoc::Identifier.new(identifier)
 
       # Set mtime
       @attributes.merge!(mtime: params[:mtime]) if params[:mtime]
@@ -101,7 +85,7 @@ module Nanoc
     #
     # @param [Symbol] rep_name The name of the representation to return
     #
-    # @return [Nanoc::ItemRep] The representation with the given name
+    # @return [Nanoc::Int::ItemRep] The representation with the given name
     def rep_named(rep_name)
       @reps.find { |r| r.name == rep_name }
     end
@@ -129,7 +113,7 @@ module Nanoc
       rep_name = params[:rep] || :default
       rep = reps.find { |r| r.name == rep_name }
       if rep.nil?
-        raise Nanoc::Errors::Generic,
+        raise Nanoc::Int::Errors::Generic,
           "No rep named #{rep_name.inspect} was found."
       end
 
@@ -152,7 +136,7 @@ module Nanoc
       # Get rep
       rep = reps.find { |r| r.name == rep_name }
       if rep.nil?
-        raise Nanoc::Errors::Generic,
+        raise Nanoc::Int::Errors::Generic,
           "No rep named #{rep_name.inspect} was found."
       end
 
@@ -166,30 +150,8 @@ module Nanoc
     #
     # @return [Object] The value of the requested attribute
     def [](key)
-      Nanoc::NotificationCenter.post(:visit_started, self)
-      Nanoc::NotificationCenter.post(:visit_ended,   self)
-
-      # Get captured content (hax)
-      # TODO: [in nanoc 4.0] remove me
-      if key.to_s =~ /^content_for_(.*)$/
-        @@_content_for_warning_issued ||= false
-        @@_capturing_helper_included ||= false
-
-        # Warn
-        unless @@_content_for_warning_issued
-          warn 'WARNING: Accessing captured content should happen using the #content_for method defined in the Capturing helper instead of using item[:content_for_something]. The latter way of accessing captured content will be removed in nanoc 4.0.'
-          @@_content_for_warning_issued = true
-        end
-
-        # Include capturing helper if necessary
-        unless @@_capturing_helper_included
-          self.class.send(:include, ::Nanoc::Helpers::Capturing)
-          @@_capturing_helper_included = true
-        end
-
-        # Get content
-        return content_for(self, $1.to_sym)
-      end
+      Nanoc::Int::NotificationCenter.post(:visit_started, self)
+      Nanoc::Int::NotificationCenter.post(:visit_ended,   self)
 
       @attributes[key]
     end
@@ -224,14 +186,14 @@ module Nanoc
     #
     # @return [Object] An unique reference to this object
     def reference
-      [type, identifier]
+      [type, identifier.to_s]
     end
 
     # Prevents all further modifications to its attributes.
     #
     # @return [void]
     def freeze
-      attributes.freeze_recursively
+      attributes.__nanoc_freeze_recursively
       children.freeze
       identifier.freeze
       raw_filename.freeze if raw_filename
@@ -244,10 +206,10 @@ module Nanoc
 
     # @return [String] The checksum for this object. If its contents change,
     #   the checksum will change as well.
-    def checksum
-      Nanoc::Checksummer.calc(self)
+    def __nanoc_checksum
+      Nanoc::Int::Checksummer.calc(self)
     end
-    memoize :checksum
+    memoize :__nanoc_checksum
 
     def hash
       self.class.hash ^ identifier.hash
@@ -288,10 +250,5 @@ module Nanoc
     def forced_outdated?
       @forced_outdated || false
     end
-
-    # @deprecated Access the modification time using `item[:mtime]` instead.
-    def mtime
-      self[:mtime]
-    end
   end
 end

data/lib/nanoc/base/source_data/item_array.rb

@@ -1,7 +1,9 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Acts as an array, but allows fetching items using identifiers, e.g. `@items['/blah/']`.
+  #
+  # @api private
   class ItemArray
     include Enumerable
 
@@ -33,7 +35,7 @@ module Nanoc
       if 1 == args.size && args.first.is_a?(String)
         item_with_identifier(args.first)
       elsif 1 == args.size && args.first.is_a?(Regexp)
-        @items.select { |i| i.identifier =~ args.first }
+        @items.select { |i| i.identifier.to_s =~ args.first }
       else
         @items[*args]
       end
@@ -52,7 +54,7 @@ module Nanoc
 
     def item_with_identifier(identifier)
       if self.frozen?
-        @mapping[identifier]
+        @mapping[identifier.to_s]
       else
         @items.find { |i| i.identifier == identifier }
       end
@@ -61,7 +63,7 @@ module Nanoc
     def build_mapping
       @mapping = {}
       @items.each do |item|
-        @mapping[item.identifier] = item
+        @mapping[item.identifier.to_s] = item
       end
       @mapping.freeze
     end

data/lib/nanoc/base/source_data/layout.rb

@@ -1,10 +1,12 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # Represents a layout in a nanoc site. It has content, attributes, an
   # identifier and a modification time (to speed up compilation).
+  #
+  # @api private
   class Layout
-    extend Nanoc::Memoization
+    extend Nanoc::Int::Memoization
 
     # @return [String] The raw content of this layout
     attr_reader :raw_content
@@ -12,8 +14,7 @@ module Nanoc
     # @return [Hash] This layout's attributes
     attr_reader :attributes
 
-    # @return [String] This layout's identifier, starting and ending with a
-    #   slash
+    # @return [Nanoc::Identifier] This layout's identifier
     attr_accessor :identifier
 
     # Creates a new layout.
@@ -24,22 +25,11 @@ module Nanoc
     #
     # @param [String] identifier This layout's identifier.
     #
-    # @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 [Time, nil] :mtime (nil) The time when this layout was
-    #   last modified. Deprecated; pass the modification time as the `:mtime`
-    #   attribute instead.
-    def initialize(raw_content, attributes, identifier, params = nil)
+    # @param [Hash] params Extra parameters. Unused.
+    def initialize(raw_content, attributes, identifier, params = {})
       @raw_content  = raw_content
-      @attributes   = attributes.symbolize_keys_recursively
-      @identifier   = identifier.cleaned_identifier.freeze
-
-      # Set mtime
-      params ||= {}
-      params = { mtime: params } if params.is_a?(Time)
-      @attributes.merge(mtime: params[:mtime]) if params[:mtime]
+      @attributes   = attributes.__nanoc_symbolize_keys_recursively
+      @identifier   = Nanoc::Identifier.new(identifier)
     end
 
     # Requests the attribute with the given key.
@@ -51,6 +41,10 @@ module Nanoc
       @attributes[key]
     end
 
+    def []=(key, value)
+      @attributes[key] = value
+    end
+
     # Returns the type of this object. Will always return `:layout`, because
     # this is a layout. For items, this method returns `:item`.
     #
@@ -65,7 +59,7 @@ module Nanoc
     #
     # @return [void]
     def freeze
-      attributes.freeze_recursively
+      attributes.__nanoc_freeze_recursively
       identifier.freeze
       raw_content.freeze
     end
@@ -85,10 +79,10 @@ module Nanoc
 
     # @return [String] The checksum for this object. If its contents change,
     #   the checksum will change as well.
-    def checksum
-      Nanoc::Checksummer.calc(self)
+    def __nanoc_checksum
+      Nanoc::Int::Checksummer.calc(self)
     end
-    memoize :checksum
+    memoize :__nanoc_checksum
 
     def hash
       self.class.hash ^ identifier.hash
@@ -115,10 +109,5 @@ module Nanoc
       @attributes,
       @identifier = *source
     end
-
-    # @deprecated Access the modification time using `layout[:mtime]` instead.
-    def mtime
-      self[:mtime]
-    end
   end
 end

data/lib/nanoc/base/source_data/site.rb

@@ -1,20 +1,22 @@
 # encoding: utf-8
 
-module Nanoc
+module Nanoc::Int
   # The in-memory representation of a nanoc site. It holds references to the
   # following site data:
   #
-  # * {#items}         — the list of items         ({Nanoc::Item})
-  # * {#layouts}       — the list of layouts       ({Nanoc::Layout})
-  # * {#code_snippets} — the list of code snippets ({Nanoc::CodeSnippet})
+  # * {#items}         — the list of items         ({Nanoc::Int::Item})
+  # * {#layouts}       — the list of layouts       ({Nanoc::Int::Layout})
+  # * {#code_snippets} — the list of code snippets ({Nanoc::Int::CodeSnippet})
   # * {#data_sources}  — the list of data sources  ({Nanoc::DataSource})
   #
   # In addition, each site has a {#config} hash which stores the site
   # configuration.
   #
-  # The physical representation of a {Nanoc::Site} is usually a directory
+  # The physical representation of a {Nanoc::Int::Site} is usually a directory
   # that contains a configuration file, site data, a rakefile, a rules file,
   # etc. The way site data is stored depends on the data source.
+  #
+  # @api private
   class Site
     # The default configuration for a data source. A data source's
     # configuration overrides these options.
@@ -26,7 +28,7 @@ module Nanoc
     }
 
     # The default configuration for a site. A site's configuration overrides
-    # these options: when a {Nanoc::Site} is created with a configuration
+    # these options: when a {Nanoc::Int::Site} is created with a configuration
     # that lacks some options, the default value will be taken from
     # `DEFAULT_CONFIG`.
     DEFAULT_CONFIG = {
@@ -61,9 +63,9 @@ module Nanoc
     # Returns the compiler for this site. Will create a new compiler if none
     # exists yet.
     #
-    # @return [Nanoc::Compiler] The compiler for this site
+    # @return [Nanoc::Int::Compiler] The compiler for this site
     def compiler
-      @compiler ||= Compiler.new(self)
+      @compiler ||= Nanoc::Int::Compiler.new(self)
     end
 
     # Returns the data sources for this site. Will create a new data source if
@@ -72,7 +74,7 @@ module Nanoc
     # @return [Array<Nanoc::DataSource>] The list of data sources for this
     #   site
     #
-    # @raise [Nanoc::Errors::UnknownDataSource] if the site configuration
+    # @raise [Nanoc::Int::Errors::UnknownDataSource] if the site configuration
     #   specifies an unknown data source
     def data_sources
       load_code_snippets
@@ -81,16 +83,7 @@ module Nanoc
         @config[:data_sources].map do |data_source_hash|
           # Get data source class
           data_source_class = Nanoc::DataSource.named(data_source_hash[:type])
-          raise Nanoc::Errors::UnknownDataSource.new(data_source_hash[:type]) if data_source_class.nil?
-
-          # Warn about deprecated data sources
-          # TODO: [in nanoc 4.0] remove me
-          case data_source_hash[:type]
-          when 'filesystem'
-            warn "Warning: the 'filesystem' data source has been renamed to 'filesystem_verbose'. Using 'filesystem' will work in nanoc 3.1.x, but it will likely not work anymore in a future release of nanoc. Please update your data source configuration and replace 'filesystem' with 'filesystem_verbose'."
-          when 'filesystem_combined', 'filesystem_compact'
-            warn "Warning: the 'filesystem_combined' and 'filesystem_compact' data source has been merged into the new 'filesystem_unified' data source. Using 'filesystem_combined' and 'filesystem_compact' will work in nanoc 3.1.x, but it will likely not work anymore in a future release of nanoc. Please update your data source configuration and replace 'filesystem_combined' and 'filesystem_compact with 'filesystem_unified'."
-          end
+          raise Nanoc::Int::Errors::UnknownDataSource.new(data_source_hash[:type]) if data_source_class.nil?
 
           # Create data source
           data_source_class.new(
@@ -105,7 +98,7 @@ module Nanoc
 
     # Returns this site’s code snippets.
     #
-    # @return [Array<Nanoc::CodeSnippet>] The list of code snippets in this
+    # @return [Array<Nanoc::Int::CodeSnippet>] The list of code snippets in this
     #   site
     def code_snippets
       load
@@ -114,7 +107,7 @@ module Nanoc
 
     # Returns this site’s items.
     #
-    # @return [Array<Nanoc::Item>] The list of items in this site
+    # @return [Array<Nanoc::Int::Item>] The list of items in this site
     def items
       load
       @items
@@ -122,7 +115,7 @@ module Nanoc
 
     # Returns this site’s layouts.
     #
-    # @return [Array<Nanoc::Layouts>] The list of layout in this site
+    # @return [Array<Nanoc::Int::Layouts>] The list of layout in this site
     def layouts
       load
       @layouts
@@ -183,14 +176,14 @@ module Nanoc
 
       item_map = {}
       @items.each do |item|
-        item_map[item.identifier] = item
+        item_map[item.identifier.to_s] = item
       end
 
       @items.each do |item|
-        parent_id_end = item.identifier.rindex('/', -2)
+        parent_id_end = item.identifier.to_s.rindex('/', -2)
         next unless parent_id_end
 
-        parent_id = item.identifier[0..parent_id_end]
+        parent_id = item.identifier.to_s[0..parent_id_end]
         parent = item_map[parent_id]
         next unless parent
 
@@ -215,18 +208,12 @@ module Nanoc
     #
     # @return [void]
     def freeze
-      config.freeze_recursively
+      config.__nanoc_freeze_recursively
       items.each(&:freeze)
       layouts.each(&:freeze)
       code_snippets.each(&:freeze)
     end
 
-    # @deprecated It is no longer necessary to explicitly load site data. It
-    #   is safe to remove all {#load_data} calls.
-    def load_data(_force = false)
-      warn 'It is no longer necessary to call Nanoc::Site#load_data. This method no longer has any effect. All calls to this method can be safely removed.'
-    end
-
     # Loads the site data. It is not necessary to call this method explicitly;
     # it will be called when it is necessary.
     #
@@ -317,7 +304,7 @@ module Nanoc
       @code_snippets = []
       config[:lib_dirs].each do |lib|
         code_snippets = Dir["#{lib}/**/*.rb"].sort.map do |filename|
-          Nanoc::CodeSnippet.new(
+          Nanoc::Int::CodeSnippet.new(
             File.read(filename),
             filename
           )
@@ -337,11 +324,11 @@ module Nanoc
       @items_loaded = true
 
       # Get items
-      @items = Nanoc::ItemArray.new
+      @items = Nanoc::Int::ItemArray.new
       data_sources.each do |ds|
         items_in_ds = ds.items
         items_in_ds.each do |i|
-          i.identifier = File.join(ds.items_root, i.identifier)
+          i.identifier = Nanoc::Identifier.new(File.join(ds.items_root, i.identifier.to_s))
           i.site = self
         end
         @items.concat(items_in_ds)
@@ -358,14 +345,16 @@ module Nanoc
       @layouts = []
       data_sources.each do |ds|
         layouts_in_ds = ds.layouts
-        layouts_in_ds.each { |i| i.identifier = File.join(ds.layouts_root, i.identifier) }
+        layouts_in_ds.each do |l|
+          l.identifier = Nanoc::Identifier.new(File.join(ds.layouts_root, l.identifier.to_s))
+        end
         @layouts.concat(layouts_in_ds)
       end
     end
 
     # Loads a configuration file.
     def load_config(config_path)
-      YAML.load_file(config_path).symbolize_keys_recursively
+      YAML.load_file(config_path).__nanoc_symbolize_keys_recursively
     end
 
     def apply_parent_config(config, config_paths = [])
@@ -374,10 +363,10 @@ module Nanoc
         config.delete(:parent_config_file)
         config_path = File.absolute_path(parent_config_file, File.dirname(config_paths.last))
         unless File.file?(config_path)
-          raise Nanoc::Errors::GenericTrivial, "Could not find parent configuration file '#{parent_config_file}'"
+          raise Nanoc::Int::Errors::GenericTrivial, "Could not find parent configuration file '#{parent_config_file}'"
         end
         if config_paths.include?(config_path)
-          raise Nanoc::Errors::GenericTrivial, "Cycle detected. Could not use parent configuration file '#{parent_config_file}'"
+          raise Nanoc::Int::Errors::GenericTrivial, "Cycle detected. Could not use parent configuration file '#{parent_config_file}'"
         end
         parent_config = load_config(config_path)
         apply_parent_config(parent_config, config_paths + [config_path]).merge(config)
@@ -390,7 +379,7 @@ module Nanoc
       seen = Set.new
       objects.each do |obj|
         if seen.include?(obj.identifier)
-          raise Nanoc::Errors::DuplicateIdentifier.new(obj.identifier, type)
+          raise Nanoc::Int::Errors::DuplicateIdentifier.new(obj.identifier, type)
         end
         seen << obj.identifier
       end
@@ -402,14 +391,14 @@ module Nanoc
       if dir_or_config_hash.is_a? String
         # Check whether it is supported
         if dir_or_config_hash != '.'
-          warn 'WARNING: Calling Nanoc::Site.new with a directory that is not the current working directory is not supported. It is recommended to change the directory before calling Nanoc::Site.new. For example, instead of Nanoc::Site.new(\'abc\'), use Dir.chdir(\'abc\') { Nanoc::Site.new(\'.\') }.'
+          warn 'WARNING: Calling Nanoc::Int::Site.new with a directory that is not the current working directory is not supported. It is recommended to change the directory before calling Nanoc::Int::Site.new. For example, instead of Nanoc::Int::Site.new(\'abc\'), use Dir.chdir(\'abc\') { Nanoc::Int::Site.new(\'.\') }.'
         end
 
         # Read config from nanoc.yaml/config.yaml in given dir
         config_path = Dir.chdir(dir_or_config_hash) do
           filename = self.class.config_filename_for_cwd
           if filename.nil?
-            raise Nanoc::Errors::GenericTrivial, 'Could not find nanoc.yaml or config.yaml in the current working directory'
+            raise Nanoc::Int::Errors::GenericTrivial, 'Could not find nanoc.yaml or config.yaml in the current working directory'
           end
           File.absolute_path(filename, dir_or_config_hash)
         end
@@ -417,7 +406,7 @@ module Nanoc
         @config = apply_parent_config(load_config(config_path), [config_path])
       else
         # Use passed config hash
-        @config = apply_parent_config(dir_or_config_hash.symbolize_keys_recursively)
+        @config = apply_parent_config(dir_or_config_hash.__nanoc_symbolize_keys_recursively)
       end
 
       # Merge config with default config
@@ -427,7 +416,7 @@ module Nanoc
       @config[:data_sources] = @config[:data_sources].map { |ds| DEFAULT_DATA_SOURCE_CONFIG.merge(ds) }
 
       # Convert to proper configuration
-      @config = Nanoc::Configuration.new(@config)
+      @config = Nanoc::Int::Configuration.new(@config)
     end
   end
 end