nanoc 4.0.0b4 → 4.0.0rc1

data/lib/nanoc/base/repos/site_loader.rb

@@ -0,0 +1,118 @@
+module Nanoc::Int
+  class SiteLoader
+    def new_empty
+      site_from_config(Nanoc::Int::Configuration.new.with_defaults)
+    end
+
+    def new_with_config(hash)
+      site_from_config(Nanoc::Int::Configuration.new(hash).with_defaults)
+    end
+
+    def new_from_cwd
+      site_from_config(Nanoc::Int::ConfigLoader.new.new_from_cwd)
+    end
+
+    # @api private
+    def setup_child_parent_links(items)
+      items.each do |item|
+        item.parent = nil
+        item.children = []
+      end
+
+      item_map = {}
+      items.each do |item|
+        next if item.identifier !~ /\/\z/
+        item_map[item.identifier.to_s] = item
+      end
+
+      items.each do |item|
+        parent_id_end = item.identifier.to_s.rindex('/', -2)
+        next unless parent_id_end
+
+        parent_id = item.identifier.to_s[0..parent_id_end]
+        parent = item_map[parent_id]
+        next unless parent
+
+        item.parent = parent
+        parent.children << item
+      end
+    end
+
+    private
+
+    def site_from_config(config)
+      code_snippets = code_snippets_from_config(config)
+      code_snippets.each(&:load)
+
+      items = Nanoc::Int::IdentifiableCollection.new(config)
+      layouts = Nanoc::Int::IdentifiableCollection.new(config)
+
+      with_data_sources(config) do |data_sources|
+        data_sources.each do |ds|
+          items_in_ds = ds.items
+          layouts_in_ds = ds.layouts
+
+          items_in_ds.each { |i| i.identifier = i.identifier.prefix(ds.items_root) }
+          layouts_in_ds.each { |l| l.identifier = l.identifier.prefix(ds.layouts_root) }
+
+          items.concat(items_in_ds)
+          layouts.concat(layouts_in_ds)
+        end
+      end
+
+      setup_child_parent_links(items)
+
+      Nanoc::Int::Site.new(
+        config: config,
+        code_snippets: code_snippets,
+        items: items,
+        layouts: layouts,
+      )
+    end
+
+    # @return [Boolean]
+    def self.cwd_is_nanoc_site?
+      Nanoc::Int::ConfigLoader.cwd_is_nanoc_site?
+    end
+
+    def with_data_sources(config, &_block)
+      data_sources = create_data_sources(config)
+
+      begin
+        data_sources.each(&:use)
+        yield(data_sources)
+      ensure
+        data_sources.each(&:unuse)
+      end
+    end
+
+    def create_data_sources(config)
+      config[:data_sources].map do |data_source_hash|
+        # Get data source class
+        data_source_class = Nanoc::DataSource.named(data_source_hash[:type])
+        if data_source_class.nil?
+          raise Nanoc::Int::Errors::UnknownDataSource.new(data_source_hash[:type])
+        end
+
+        # Create data source
+        data_source_class.new(
+          config,
+          data_source_hash[:items_root],
+          data_source_hash[:layouts_root],
+          data_source_hash.merge(data_source_hash[:config] || {}),
+        )
+      end
+    end
+
+    def code_snippets_from_config(config)
+      config[:lib_dirs].flat_map do |lib|
+        Dir["#{lib}/**/*.rb"].sort.map do |filename|
+          Nanoc::Int::CodeSnippet.new(
+            File.read(filename),
+            filename,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/base/repos.rb

@@ -0,0 +1,7 @@
+require_relative 'repos/store'
+
+require_relative 'repos/checksum_store'
+require_relative 'repos/compiled_content_cache'
+require_relative 'repos/config_loader'
+require_relative 'repos/rule_memory_store'
+require_relative 'repos/site_loader'

data/lib/nanoc/base/result_data/item_rep.rb

@@ -1,70 +1,31 @@
 module Nanoc::Int
-  # A single representation (rep) of an item ({Nanoc::Int::Item}). An item can
-  # have multiple representations. A representation has its own output file.
-  # A single item can therefore have multiple output files, each run through
-  # a different set of filters with a different layout.
-  #
   # @api private
   class ItemRep
-    # Contains all private methods. Mixed into {Nanoc::Int::ItemRep}.
-    #
-    # @api private
-    module Private
-      attr_accessor :content_snapshots
-
-      # @return [Boolean] true if this representation has already been
-      #   compiled during the current or last compilation session; false
-      #   otherwise
-      #
-      # @api private
-      attr_accessor :compiled
-      alias_method :compiled?, :compiled
-
-      # @return [Hash<Symbol,String>] A hash containing the raw paths (paths
-      #   including the path to the output directory and the filename) for all
-      #   snapshots. The keys correspond with the snapshot names, and the
-      #   values with the path.
-      #
-      # @api private
-      attr_accessor :raw_paths
-
-      # @return [Hash<Symbol,String>] A hash containing the paths for all
-      #   snapshots. The keys correspond with the snapshot names, and the
-      #   values with the path.
-      #
-      # @api private
-      attr_accessor :paths
-
-      # Resets the compilation progress for this item representation. This is
-      # necessary when an unmet dependency is detected during compilation.
-      #
-      # @api private
-      #
-      # @return [void]
-      def forget_progress
-        initialize_content
-      end
-    end
+    # @return [Hash<Symbol,Nanoc::Int::Content]
+    attr_accessor :snapshot_contents
 
-    include Private
+    # @return [Boolean]
+    attr_accessor :compiled
+    alias_method :compiled?, :compiled
 
-    # @return [Nanoc::Int::Item] The item to which this rep belongs
+    # @return [Hash<Symbol,String>]
+    attr_accessor :raw_paths
+
+    # @return [Hash<Symbol,String>]
+    attr_accessor :paths
+
+    # @return [Nanoc::Int::Item]
     attr_reader :item
 
-    # @return [Symbol] The representation's unique name
+    # @return [Symbol]
     attr_reader :name
 
-    # @return [Array] A list of snapshots, represented as arrays where the
-    #   first element is the snapshot name (a Symbol) and the last element is
-    #   a Boolean indicating whether the snapshot is final or not
-    attr_accessor :snapshots
+    # @return [Enumerable<Nanoc::Int:SnapshotDef]
+    attr_accessor :snapshot_defs
 
-    # Creates a new item representation for the given item.
-    #
-    # @param [Nanoc::Int::Item] item The item to which the new representation will
-    #   belong.
+    # @param [Nanoc::Int::Item] item
     #
-    # @param [Symbol] name The unique name for the new item representation.
+    # @param [Symbol] name
     def initialize(item, name)
       # Set primary attributes
       @item   = item
@@ -73,7 +34,7 @@ module Nanoc::Int
       # Set default attributes
       @raw_paths  = {}
       @paths      = {}
-      @snapshots  = []
+      @snapshot_defs = []
       initialize_content
 
       # Reset flags
@@ -81,7 +42,7 @@ module Nanoc::Int
     end
 
     def binary?
-      @content_snapshots[:last].binary?
+      @snapshot_contents[:last].binary?
     end
 
     # Returns the compiled content from a given snapshot.
@@ -100,12 +61,12 @@ module Nanoc::Int
       end
 
       # Get name of last pre-layout snapshot
-      snapshot_name = params.fetch(:snapshot) { @content_snapshots[:pre] ? :pre : :last }
+      snapshot_name = params.fetch(:snapshot) { @snapshot_contents[:pre] ? :pre : :last }
       is_moving = [:pre, :post, :last].include?(snapshot_name)
 
       # Check existance of snapshot
-      snapshot = snapshots.find { |s| s.first == snapshot_name }
-      if !is_moving && (snapshot.nil? || snapshot[-1] == false)
+      snapshot_def = snapshot_defs.find { |sd| sd.name == snapshot_name }
+      if !is_moving && (snapshot_def.nil? || !snapshot_def.final?)
         raise Nanoc::Int::Errors::NoSuchSnapshot.new(self, snapshot_name)
       end
 
@@ -115,14 +76,14 @@ module Nanoc::Int
         when :post, :last
           true
         when :pre
-          snapshot.nil? || !snapshot[-1]
+          snapshot_def.nil? || !snapshot_def.final?
         end
-      is_usable_snapshot = @content_snapshots[snapshot_name] && (self.compiled? || !is_still_moving)
+      is_usable_snapshot = @snapshot_contents[snapshot_name] && (self.compiled? || !is_still_moving)
       unless is_usable_snapshot
         raise Nanoc::Int::Errors::UnmetDependency.new(self)
       end
 
-      @content_snapshots[snapshot_name].string
+      @snapshot_contents[snapshot_name].string
     end
 
     # Checks whether content exists at a given snapshot.
@@ -132,7 +93,7 @@ module Nanoc::Int
     #
     # @since 3.2.0
     def snapshot?(snapshot_name)
-      !@content_snapshots[snapshot_name].nil?
+      !@snapshot_contents[snapshot_name].nil?
     end
     alias_method :has_snapshot?, :snapshot?
 
@@ -162,6 +123,16 @@ module Nanoc::Int
       @paths[snapshot_name]
     end
 
+    # Resets the compilation progress for this item representation. This is
+    # necessary when an unmet dependency is detected during compilation.
+    #
+    # @api private
+    #
+    # @return [void]
+    def forget_progress
+      initialize_content
+    end
+
     # Returns an object that can be used for uniquely identifying objects.
     #
     # @api private
@@ -179,7 +150,7 @@ module Nanoc::Int
 
     def initialize_content
       # FIXME: Where is :raw?
-      @content_snapshots = { last: @item.content }
+      @snapshot_contents = { last: @item.content }
     end
   end
 end

data/lib/nanoc/base/services/executor.rb

@@ -1,6 +1,12 @@
 module Nanoc
   module Int
     class Executor
+      class OutputNotWrittenError < ::Nanoc::Error
+        def initialize(filter_name, output_filename)
+          super("The #{filter_name.inspect} filter did not write anything to the required output file, #{output_filename}.")
+        end
+      end
+
       def initialize(compiler)
         @compiler = compiler
       end
@@ -25,22 +31,22 @@ module Nanoc
           filter = klass.new(assigns_for(rep))
 
           # Run filter
-          last = rep.content_snapshots[:last]
+          last = rep.snapshot_contents[:last]
           source = rep.binary? ? last.filename : last.string
           result = filter.setup_and_run(source, filter_args)
           if klass.to_binary?
-            rep.content_snapshots[:last] = Nanoc::Int::BinaryContent.new(filter.output_filename).tap(&:freeze)
+            rep.snapshot_contents[:last] = Nanoc::Int::BinaryContent.new(filter.output_filename).tap(&:freeze)
           else
-            rep.content_snapshots[:last] = Nanoc::Int::TextualContent.new(result).tap(&:freeze)
+            rep.snapshot_contents[:last] = Nanoc::Int::TextualContent.new(result).tap(&:freeze)
           end
 
           # Check whether file was written
           if klass.to_binary? && !File.file?(filter.output_filename)
-            raise "The #{filter_name.inspect} filter did not write anything to the required output file, #{filter.output_filename}."
+            raise OutputNotWrittenError.new(filter_name, filter.output_filename)
           end
 
           # Create snapshot
-          snapshot(rep, rep.content_snapshots[:post] ? :post : :pre, final: false) unless rep.binary?
+          snapshot(rep, rep.snapshot_contents[:post] ? :post : :pre, final: false) unless rep.binary?
         ensure
           # Notify end
           Nanoc::Int::NotificationCenter.post(:filtering_ended, rep, filter_name)
@@ -59,7 +65,7 @@ module Nanoc
         raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(rep) if rep.binary?
 
         # Create "pre" snapshot
-        if rep.content_snapshots[:post].nil?
+        if rep.snapshot_contents[:post].nil?
           snapshot(rep, :pre, final: true)
         end
 
@@ -81,7 +87,7 @@ module Nanoc
           content = layout.content
           arg = content.binary? ? content.filename : content.string
           res = filter.setup_and_run(arg, filter_args)
-          rep.content_snapshots[:last] = Nanoc::Int::TextualContent.new(res).tap(&:freeze)
+          rep.snapshot_contents[:last] = Nanoc::Int::TextualContent.new(res).tap(&:freeze)
 
           # Create "post" snapshot
           snapshot(rep, :post, final: false)
@@ -96,11 +102,11 @@ module Nanoc
         is_final = params.fetch(:final, true)
 
         unless rep.binary?
-          rep.content_snapshots[snapshot_name] = rep.content_snapshots[:last]
+          rep.snapshot_contents[snapshot_name] = rep.snapshot_contents[:last]
         end
 
         if snapshot_name == :pre && is_final
-          rep.snapshots << [:pre, true]
+          rep.snapshot_defs << Nanoc::Int::SnapshotDef.new(:pre, true)
         end
 
         if is_final

data/lib/nanoc/base/services/item_rep_writer.rb

@@ -14,7 +14,7 @@ module Nanoc::Int
       Nanoc::Int::NotificationCenter.post(
         :will_write_rep, item_rep, raw_path)
 
-      content = item_rep.content_snapshots[:last]
+      content = item_rep.snapshot_contents[:last]
       if content.binary?
         temp_path = content.filename
       else

data/lib/nanoc/base/services/recording_executor.rb

@@ -7,11 +7,11 @@ module Nanoc
         @rule_memory = []
       end
 
-      def filter(rep, filter_name, filter_args = {})
+      def filter(_rep, filter_name, filter_args = {})
         @rule_memory << [:filter, filter_name, filter_args]
       end
 
-      def layout(rep, layout_identifier, extra_filter_args = nil)
+      def layout(_rep, layout_identifier, extra_filter_args = nil)
         if extra_filter_args
           @rule_memory << [:layout, layout_identifier, extra_filter_args]
         else
@@ -19,7 +19,7 @@ module Nanoc
         end
       end
 
-      def snapshot(rep, snapshot_name, params = {})
+      def snapshot(_rep, snapshot_name, params = {})
         @rule_memory << [:snapshot, snapshot_name, params]
 
         # Count
@@ -33,7 +33,7 @@ module Nanoc
         end
       end
 
-      def record_write(rep, path)
+      def record_write(_rep, path)
         @rule_memory << [:write, path]
       end
     end

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

@@ -2,12 +2,94 @@ module Nanoc::Int
   # Represents the site configuration.
   #
   # @api private
-  class Configuration < ::Hash
+  class Configuration
+    NONE = Object.new
+
+    # The default configuration for a data source. A data source's
+    # configuration overrides these options.
+    DEFAULT_DATA_SOURCE_CONFIG = {
+      type: 'filesystem',
+      items_root: '/',
+      layouts_root: '/',
+      config: {},
+      identifier_type: 'full',
+    }
+
+    # The default configuration for a site. A site's configuration overrides
+    # 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 = {
+      text_extensions: %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim rdoc ).sort,
+      lib_dirs: %w( lib ),
+      commands_dirs: %w( commands ),
+      output_dir: 'output',
+      data_sources: [{}],
+      index_filenames: ['index.html'],
+      enable_output_diff: false,
+      prune: { auto_prune: false, exclude: ['.git', '.hg', '.svn', 'CVS'] },
+      string_pattern_type: 'glob',
+    }
+
     # Creates a new configuration with the given hash.
     #
     # @param [Hash] hash The actual configuration hash
-    def initialize(hash)
-      replace(hash)
+    def initialize(hash = {})
+      @wrapped = hash.__nanoc_symbolize_keys_recursively
+    end
+
+    def with_defaults
+      new_wrapped = DEFAULT_CONFIG.merge(@wrapped)
+      new_wrapped[:data_sources] = new_wrapped[:data_sources].map do |ds|
+        DEFAULT_DATA_SOURCE_CONFIG.merge(ds)
+      end
+
+      self.class.new(new_wrapped)
+    end
+
+    def to_h
+      @wrapped
+    end
+
+    def [](key)
+      @wrapped[key]
+    end
+
+    def fetch(key, fallback = NONE, &_block)
+      @wrapped.fetch(key) do
+        if !fallback.equal?(NONE)
+          fallback
+        elsif block_given?
+          yield(key)
+        else
+          raise KeyError, "key not found: #{key.inspect}"
+        end
+      end
+    end
+
+    def []=(key, value)
+      @wrapped[key] = value
+    end
+
+    def merge(hash)
+      self.class.new(@wrapped.merge(hash.to_h))
+    end
+
+    def without(key)
+      self.class.new(@wrapped.reject { |k, _v| k == key })
+    end
+
+    def update(hash)
+      @wrapped.update(hash)
+    end
+
+    def each
+      @wrapped.each { |k, v| yield(k, v) }
+      self
+    end
+
+    def __nanoc_freeze_recursively
+      @wrapped.__nanoc_freeze_recursively
     end
 
     # Returns an object that can be used for uniquely identifying objects.
@@ -16,5 +98,9 @@ module Nanoc::Int
     def reference
       :config
     end
+
+    def inspect
+      "<#{self.class}>"
+    end
   end
 end

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

@@ -29,21 +29,8 @@ module Nanoc
 
     extend Nanoc::Int::PluginRegistry::PluginMethods
 
-    # Creates a new data source for the given site.
-    #
-    # @param [Nanoc::Int::Site] site The site this data source belongs to.
-    #
-    # @param [String] items_root The prefix that should be given to all items
-    #   returned by the #items method (comparable to mount points for
-    #   filesystems in Unix-ish OSes).
-    #
-    # @param [String] layouts_root The prefix that should be given to all
-    #   layouts returned by the #layouts method (comparable to mount points
-    #   for filesystems in Unix-ish OSes).
-    #
-    # @param [Hash] config The configuration for this data source.
-    def initialize(site, items_root, layouts_root, config)
-      @site         = site
+    def initialize(site_config, items_root, layouts_root, config)
+      @site_config  = site_config
       @items_root   = items_root
       @layouts_root = layouts_root
       @config       = config || {}