nanoc 3.8.0 → 4.0.0a1

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

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Nanoc
+  class SiteView
+    # @api private
+    def initialize(site)
+      @site = site
+    end
+
+    # @api private
+    def unwrap
+      @site
+    end
+
+    # @api private
+    def layouts
+      @site.layouts.map { |l| Nanoc::LayoutView.new(l) }
+    end
+
+    # @api private
+    def captures_store
+      @site.captures_store
+    end
+
+    # @api private
+    def captures_store_compiled_items
+      @site.captures_store_compiled_items
+    end
+
+    # @api private
+    def compiler
+      @site.compiler
+    end
+  end
+end

data/lib/nanoc/cli.rb

@@ -15,6 +15,7 @@ if Nanoc.on_windows?
   end
 end
 
+# @api private
 module Nanoc::CLI
   module Commands
   end
@@ -26,10 +27,6 @@ module Nanoc::CLI
   autoload 'StreamCleaners',      'nanoc/cli/stream_cleaners'
   autoload 'ErrorHandler',        'nanoc/cli/error_handler'
 
-  # Deprecated; use CommandRunner instead
-  # TODO: [in nanoc 4.0] remove me
-  autoload 'Command',             'nanoc/cli/command_runner'
-
   # @return [Boolean] true if debug output is enabled, false if not
   #
   # @since 3.2.0
@@ -121,8 +118,8 @@ module Nanoc::CLI
   #
   # @return [void]
   def self.load_custom_commands
-    if Nanoc::Site.cwd_is_nanoc_site?
-      site = Nanoc::Site.new('.')
+    if Nanoc::Int::Site.cwd_is_nanoc_site?
+      site = Nanoc::Int::Site.new('.')
       site.config[:commands_dirs].each do |path|
         load_commands_at(path)
       end

data/lib/nanoc/cli/ansi_string_colorizer.rb

@@ -3,6 +3,8 @@
 module Nanoc::CLI
   # A simple ANSI colorizer for strings. When given a string and a list of
   # attributes, it returns a colorized string.
+  #
+  # @api private
   module ANSIStringColorizer
     # TODO: complete mapping
     MAPPING = {

data/lib/nanoc/cli/cleaning_stream.rb

@@ -3,6 +3,8 @@
 module Nanoc::CLI
   # An output stream that passes output through stream cleaners. This can be
   # used to strip ANSI color sequences, for instance.
+  #
+  # @api private
   class CleaningStream
     # @param [IO, StringIO] stream The stream to wrap
     def initialize(stream)

data/lib/nanoc/cli/command_runner.rb

@@ -3,6 +3,8 @@
 module Nanoc::CLI
   # A command runner subclass for nanoc commands that adds nanoc-specific
   # convenience methods and error handling.
+  #
+  # @api private
   class CommandRunner < ::Cri::CommandRunner
     # @see http://rubydoc.info/gems/cri/Cri/CommandRunner#call-instance_method
     #
@@ -13,42 +15,35 @@ module Nanoc::CLI
       end
     end
 
-    # Gets the site ({Nanoc::Site} instance) in the current directory and
+    # Gets the site ({Nanoc::Int::Site} instance) in the current directory and
     # loads its data.
     #
-    # @return [Nanoc::Site] The site in the current working directory
+    # @return [Nanoc::Int::Site] The site in the current working directory
     def site
       # Load site if possible
       @site ||= nil
       if self.is_in_site_dir? && @site.nil?
-        @site = Nanoc::Site.new('.')
+        @site = Nanoc::Int::Site.new('.')
       end
 
       @site
     end
 
-    # @deprecated use `Cri::CommandDSL#runner`
-    #
-    # @see http://rubydoc.info/gems/cri/Cri/CommandDSL#runner-instance_method
-    def self.call(opts, args, cmd)
-      new(opts, args, cmd).call
-    end
-
     # @return [Boolean] true if the current working directory is a nanoc site
     #   directory, false otherwise
     def in_site_dir?
-      Nanoc::Site.cwd_is_nanoc_site?
+      Nanoc::Int::Site.cwd_is_nanoc_site?
     end
     alias_method :is_in_site_dir?, :in_site_dir?
 
     # Asserts that the current working directory contains a site
-    # ({Nanoc::Site} instance). If no site is present, prints an error
+    # ({Nanoc::Int::Site} instance). If no site is present, prints an error
     # message and exits.
     #
     # @return [void]
     def require_site
       if site.nil?
-        raise ::Nanoc::Errors::GenericTrivial, 'The current working directory does not seem to be a nanoc site.'
+        raise ::Nanoc::Int::Errors::GenericTrivial, 'The current working directory does not seem to be a nanoc site.'
       end
     end
 
@@ -72,38 +67,9 @@ module Nanoc::CLI
 
     protected
 
-    # Sets the data source's VCS to the VCS with the given name. Does nothing
-    # when the site's data source does not support VCSes (i.e. does not
-    # implement #vcs=).
-    #
-    # @param [String] vcs_name The name of the VCS that should be used
-    #
-    # @return [void]
-    def set_vcs(vcs_name)
-      # Skip if not possible
-      return if vcs_name.nil? || site.nil?
-
-      # Find VCS
-      vcs_class = Nanoc::Extra::VCS.named(vcs_name.to_sym)
-      if vcs_class.nil?
-        raise Nanoc::Errors::GenericTrivial, "A VCS named #{vcs_name} was not found"
-      end
-
-      site.data_sources.each do |data_source|
-        # Skip if not possible
-        next unless data_source.respond_to?(:vcs=)
-
-        # Set VCS
-        data_source.vcs = vcs_class.new
-      end
-    end
-
     # @return [Array] The compilation stack.
     def stack
       (site && site.compiler.stack) || []
     end
   end
-
-  # @deprecated Use {Nanoc::CLI::CommandRunner} instead
-  Command = CommandRunner
 end

data/lib/nanoc/cli/commands/check.rb

@@ -33,7 +33,7 @@ module Nanoc::CLI::Commands
         end
 
       unless success
-        raise Nanoc::Errors::GenericTrivial, 'One or more checks failed'
+        raise Nanoc::Int::Errors::GenericTrivial, 'One or more checks failed'
       end
     end
 
@@ -41,7 +41,7 @@ module Nanoc::CLI::Commands
 
     def validate_options_and_arguments
       if arguments.empty? && !options[:all] && !options[:deploy] && !options[:list]
-        raise Nanoc::Errors::GenericTrivial,
+        raise Nanoc::Int::Errors::GenericTrivial,
           'nothing to do (pass either --all, --deploy or --list or a list of checks)'
       end
     end

data/lib/nanoc/cli/commands/compile.rb

@@ -22,7 +22,7 @@ option :f, :force, '(ignored)'
 
 module Nanoc::CLI::Commands
   class Compile < ::Nanoc::CLI::CommandRunner
-    extend Nanoc::Memoization
+    extend Nanoc::Int::Memoization
 
     # Listens to compilation events and reacts to them. This abstract class
     # does not have a real implementation; subclasses should override {#start}
@@ -70,11 +70,11 @@ module Nanoc::CLI::Commands
         require 'tempfile'
         setup_diffs
         old_contents = {}
-        Nanoc::NotificationCenter.on(:will_write_rep) do |rep, snapshot|
+        Nanoc::Int::NotificationCenter.on(:will_write_rep) do |rep, snapshot|
           path = rep.raw_path(snapshot: snapshot)
           old_contents[rep] = File.file?(path) ? File.read(path) : nil
         end
-        Nanoc::NotificationCenter.on(:rep_written) do |rep, path, _is_created, _is_modified|
+        Nanoc::Int::NotificationCenter.on(:rep_written) do |rep, path, _is_created, _is_modified|
           unless rep.binary?
             new_contents = File.file?(path) ? File.read(path) : nil
             if old_contents[rep] && new_contents
@@ -153,7 +153,7 @@ module Nanoc::CLI::Commands
         command_runner.options.fetch(:verbose, false)
       end
 
-      # @option params [Array<Nanoc::ItemRep>] :reps The list of item representations in the site
+      # @option params [Array<Nanoc::Int::ItemRep>] :reps The list of item representations in the site
       def initialize(params = {})
         @times = {}
 
@@ -162,11 +162,11 @@ module Nanoc::CLI::Commands
 
       # @see Listener#start
       def start
-        Nanoc::NotificationCenter.on(:filtering_started) do |_rep, filter_name|
+        Nanoc::Int::NotificationCenter.on(:filtering_started) do |_rep, filter_name|
           @times[filter_name] ||= []
           @times[filter_name] << { start: Time.now }
         end
-        Nanoc::NotificationCenter.on(:filtering_ended) do |_rep, filter_name|
+        Nanoc::Int::NotificationCenter.on(:filtering_ended) do |_rep, filter_name|
           @times[filter_name].last[:stop] = Time.now
         end
       end
@@ -261,7 +261,7 @@ module Nanoc::CLI::Commands
 
       # @see Listener#start
       def start
-        Nanoc::NotificationCenter.on(:compilation_started) do |_rep|
+        Nanoc::Int::NotificationCenter.on(:compilation_started) do |_rep|
           if @gc_count % 20 == 0
             GC.enable
             GC.start
@@ -287,32 +287,32 @@ module Nanoc::CLI::Commands
 
       # @see Listener#start
       def start
-        Nanoc::NotificationCenter.on(:compilation_started) do |rep|
+        Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
           puts "*** Started compilation of #{rep.inspect}"
         end
-        Nanoc::NotificationCenter.on(:compilation_ended) do |rep|
+        Nanoc::Int::NotificationCenter.on(:compilation_ended) do |rep|
           puts "*** Ended compilation of #{rep.inspect}"
           puts
         end
-        Nanoc::NotificationCenter.on(:compilation_failed) do |rep, e|
+        Nanoc::Int::NotificationCenter.on(:compilation_failed) do |rep, e|
           puts "*** Suspended compilation of #{rep.inspect}: #{e.message}"
         end
-        Nanoc::NotificationCenter.on(:cached_content_used) do |rep|
+        Nanoc::Int::NotificationCenter.on(:cached_content_used) do |rep|
           puts "*** Used cached compiled content for #{rep.inspect} instead of recompiling"
         end
-        Nanoc::NotificationCenter.on(:filtering_started) do |rep, filter_name|
+        Nanoc::Int::NotificationCenter.on(:filtering_started) do |rep, filter_name|
           puts "*** Started filtering #{rep.inspect} with #{filter_name}"
         end
-        Nanoc::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
+        Nanoc::Int::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
           puts "*** Ended filtering #{rep.inspect} with #{filter_name}"
         end
-        Nanoc::NotificationCenter.on(:visit_started) do |item|
+        Nanoc::Int::NotificationCenter.on(:visit_started) do |item|
           puts "*** Started visiting #{item.inspect}"
         end
-        Nanoc::NotificationCenter.on(:visit_ended) do |item|
+        Nanoc::Int::NotificationCenter.on(:visit_ended) do |item|
           puts "*** Ended visiting #{item.inspect}"
         end
-        Nanoc::NotificationCenter.on(:dependency_created) do |src, dst|
+        Nanoc::Int::NotificationCenter.on(:dependency_created) do |src, dst|
           puts "*** Dependency created from #{src.inspect} onto #{dst.inspect}"
         end
       end
@@ -320,7 +320,7 @@ module Nanoc::CLI::Commands
 
     # Prints file actions (created, updated, deleted, identical, skipped)
     class FileActionPrinter < Listener
-      # @option params [Array<Nanoc::ItemRep>] :reps The list of item representations in the site
+      # @option params [Array<Nanoc::Int::ItemRep>] :reps The list of item representations in the site
       def initialize(params = {})
         @start_times = {}
 
@@ -329,10 +329,10 @@ module Nanoc::CLI::Commands
 
       # @see Listener#start
       def start
-        Nanoc::NotificationCenter.on(:compilation_started) do |rep|
+        Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
           @start_times[rep.raw_path] = Time.now
         end
-        Nanoc::NotificationCenter.on(:rep_written) do |_rep, path, is_created, is_modified|
+        Nanoc::Int::NotificationCenter.on(:rep_written) do |_rep, path, is_created, is_modified|
           duration = path && @start_times[path] ? Time.now - @start_times[path] : nil
           action =
             case
@@ -376,7 +376,6 @@ module Nanoc::CLI::Commands
       time_before = Time.now
 
       load_site
-      check_for_deprecated_usage
 
       puts 'Compiling site…'
       run_listeners_while do
@@ -436,20 +435,6 @@ module Nanoc::CLI::Commands
     end
     memoize :reps
 
-    def check_for_deprecated_usage
-      # Check presence of --all option
-      if options.key?(:all) || options.key?(:force)
-        $stderr.puts 'Warning: the --force option (and its deprecated --all alias) are, as of nanoc 3.2, no longer supported and have no effect.'
-      end
-
-      # Warn if trying to compile a single item
-      if arguments.size == 1
-        $stderr.puts '-' * 80
-        $stderr.puts 'Note: As of nanoc 3.2, it is no longer possible to compile a single item. When invoking the “compile” command, all items in the site will be compiled.'
-        $stderr.puts '-' * 80
-      end
-    end
-
     def prune_config
       site.config[:prune] || {}
     end

data/lib/nanoc/cli/commands/create-site.rb

@@ -7,8 +7,6 @@ description "
 Create a new site at the given path. The site will use the `filesystem_unified` data source by default, but this can be changed using the `--datasource` command-line option.
 "
 
-required :d, :datasource, 'specify the data source for the new site'
-
 module Nanoc::CLI::Commands
   class CreateSite < ::Nanoc::CLI::CommandRunner
     class << self
@@ -24,18 +22,18 @@ module Nanoc::CLI::Commands
 # A list of file extensions that nanoc will consider to be textual rather than
 # binary. If an item with an extension not in this list is found,  the file
 # will be considered as binary.
-text_extensions: #{array_to_yaml(Nanoc::Site::DEFAULT_CONFIG[:text_extensions])}
+text_extensions: #{array_to_yaml(Nanoc::Int::Site::DEFAULT_CONFIG[:text_extensions])}
 
 # The path to the directory where all generated files will be written to. This
 # can be an absolute path starting with a slash, but it can also be path
 # relative to the site directory.
-output_dir: #{Nanoc::Site::DEFAULT_CONFIG[:output_dir]}
+output_dir: #{Nanoc::Int::Site::DEFAULT_CONFIG[:output_dir]}
 
 # A list of index filenames, i.e. names of files that will be served by a web
 # server when a directory is requested. Usually, index files are named
 # “index.html”, but depending on the web server, this may be something else,
 # such as “default.htm”. This list is used by nanoc to generate pretty URLs.
-index_filenames: #{array_to_yaml(Nanoc::Site::DEFAULT_CONFIG[:index_filenames])}
+index_filenames: #{array_to_yaml(Nanoc::Int::Site::DEFAULT_CONFIG[:index_filenames])}
 
 # Whether or not to generate a diff of the compiled content when compiling a
 # site. The diff will contain the differences between the compiled content
@@ -60,18 +58,18 @@ data_sources:
   -
     # The type is the identifier of the data source. By default, this will be
     # `filesystem_unified`.
-    type: #{Nanoc::Site::DEFAULT_DATA_SOURCE_CONFIG[:type]}
+    type: #{Nanoc::Int::Site::DEFAULT_DATA_SOURCE_CONFIG[:type]}
 
     # The path where items should be mounted (comparable to mount points in
     # Unix-like systems). This is “/” by default, meaning that items will have
     # “/” prefixed to their identifiers. If the items root were “/en/”
     # instead, an item at content/about.html would have an identifier of
     # “/en/about/” instead of just “/about/”.
-    items_root: #{Nanoc::Site::DEFAULT_DATA_SOURCE_CONFIG[:items_root]}
+    items_root: #{Nanoc::Int::Site::DEFAULT_DATA_SOURCE_CONFIG[:items_root]}
 
     # The path where layouts should be mounted. The layouts root behaves the
     # same as the items root, but applies to layouts rather than items.
-    layouts_root: #{Nanoc::Site::DEFAULT_DATA_SOURCE_CONFIG[:layouts_root]}
+    layouts_root: #{Nanoc::Int::Site::DEFAULT_DATA_SOURCE_CONFIG[:layouts_root]}
 
     # Whether to allow periods in identifiers. When turned off, everything
     # past the first period is considered to be the extension, and when
@@ -292,7 +290,7 @@ EOS
     def run
       # Check arguments
       if arguments.length != 1
-        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
+        raise Nanoc::Int::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Extract arguments and options
@@ -301,97 +299,62 @@ EOS
 
       # Check whether site exists
       if File.exist?(path)
-        raise Nanoc::Errors::GenericTrivial, "A site at '#{path}' already exists."
+        raise Nanoc::Int::Errors::GenericTrivial, "A site at '#{path}' already exists."
       end
 
       # Check whether data source exists
       if Nanoc::DataSource.named(data_source).nil?
-        raise Nanoc::Errors::GenericTrivial, "Unrecognised data source: #{data_source}"
+        raise Nanoc::Int::Errors::GenericTrivial, "Unrecognised data source: #{data_source}"
       end
 
       # Setup notifications
-      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+      Nanoc::Int::NotificationCenter.on(:file_created) do |file_path|
         Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
       end
 
       # Build entire site
       FileUtils.mkdir_p(path)
       FileUtils.cd(File.join(path)) do
-        site_create_minimal(data_source)
-        site_setup
-        site_populate
+        FileUtils.mkdir_p('content')
+        FileUtils.mkdir_p('layouts')
+        FileUtils.mkdir_p('lib')
+        FileUtils.mkdir_p('output')
+
+        # Config
+        File.open('nanoc.yaml', 'w') { |io| io.write(DEFAULT_CONFIG) }
+        Nanoc::Int::NotificationCenter.post(:file_created, 'nanoc.yaml')
+
+        # Rules
+        File.open('Rules', 'w') do |io|
+          io.write DEFAULT_RULES
+        end
+        Nanoc::Int::NotificationCenter.post(:file_created, 'Rules')
+
+        # Home page
+        File.open('content/index.html', 'w') do |io|
+          io << '---' << "\n"
+          io << 'title: Home' << "\n"
+          io << '---' << "\n"
+          io << "\n"
+          io << DEFAULT_ITEM
+        end
+        Nanoc::Int::NotificationCenter.post(:file_created, 'content/index.html')
+
+        # Style sheet
+        File.open('content/stylesheet.css', 'w') do |io|
+          io << DEFAULT_STYLESHEET
+        end
+        Nanoc::Int::NotificationCenter.post(:file_created, 'content/stylesheet.css')
+
+        # Layout
+        File.open('layouts/default.html', 'w') do |io|
+          io << DEFAULT_LAYOUT
+        end
+        Nanoc::Int::NotificationCenter.post(:file_created, 'layouts/default.html')
       end
 
       puts "Created a blank nanoc site at '#{path}'. Enjoy!"
     end
-
-    protected
-
-    # Creates a configuration file and a output directory for this site, as
-    # well as a rakefile that loads the standard nanoc tasks.
-    def site_create_minimal(_data_source)
-      # Create output
-      FileUtils.mkdir_p('output')
-
-      # Create config
-      File.open('nanoc.yaml', 'w') { |io| io.write(DEFAULT_CONFIG) }
-      Nanoc::NotificationCenter.post(:file_created, 'nanoc.yaml')
-
-      # Create rules
-      File.open('Rules', 'w') do |io|
-        io.write DEFAULT_RULES
-      end
-      Nanoc::NotificationCenter.post(:file_created, 'Rules')
-    end
-
-    # Sets up the site's data source, i.e. creates the bare essentials for
-    # this data source to work.
-    def site_setup
-      # Get site
-      site = Nanoc::Site.new('.')
-
-      # Set up data sources
-      site.data_sources.each do |data_source|
-        data_source.loading { data_source.setup }
-      end
-    end
-
-    # Populates the site with some initial data, such as a root item, a
-    # default layout, and so on.
-    def site_populate
-      # Get site
-      site = Nanoc::Site.new('.')
-      data_source = site.data_sources[0]
-
-      # Create home page
-      data_source.create_item(
-        DEFAULT_ITEM,
-        { title: 'Home' },
-        '/'
-      )
-
-      # Create stylesheet
-      data_source.create_item(
-        DEFAULT_STYLESHEET,
-        {},
-        '/stylesheet/',
-        extension: '.css'
-      )
-
-      # Create layout
-      data_source.create_layout(
-        DEFAULT_LAYOUT,
-        {},
-        '/default/'
-      )
-
-      # Create code
-      FileUtils.mkdir_p('lib')
-      File.open('lib/default.rb', 'w') do |io|
-        io.write "\# All files in the 'lib' directory will be loaded\n"
-        io.write "\# before nanoc starts compiling.\n"
-      end
-    end
   end
 end