nanoc 3.8.0 → 4.0.0a1

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

@@ -19,7 +19,7 @@ module Nanoc::CLI::Commands
 
       # List deployers
       if options[:'list-deployers']
-        deployers      = Nanoc::PluginRegistry.instance.find_all(Nanoc::Extra::Deployer)
+        deployers      = Nanoc::Int::PluginRegistry.instance.find_all(Nanoc::Extra::Deployer)
         deployer_names = deployers.keys.sort_by(&:to_s)
         puts 'Available deployers:'
         deployer_names.each do |name|
@@ -45,13 +45,13 @@ module Nanoc::CLI::Commands
 
       # Can't proceed further without a deploy config
       if deploy_configs.empty?
-        raise Nanoc::Errors::GenericTrivial, 'The site has no deployment configurations.'
+        raise Nanoc::Int::Errors::GenericTrivial, 'The site has no deployment configurations.'
       end
 
       # Get target
       target = options.fetch(:target, :default).to_sym
       config = deploy_configs.fetch(target) do
-        raise Nanoc::Errors::GenericTrivial, "The site has no deployment configuration for #{target}."
+        raise Nanoc::Int::Errors::GenericTrivial, "The site has no deployment configuration for #{target}."
       end
 
       # Get deployer
@@ -62,7 +62,7 @@ module Nanoc::CLI::Commands
       end
       deployer_class = Nanoc::Extra::Deployer.named(name)
       if deployer_class.nil?
-        raise Nanoc::Errors::GenericTrivial, "The specified deploy target has an unrecognised kind “#{name}” (expected one of #{names.join(', ')})."
+        raise Nanoc::Int::Errors::GenericTrivial, "The specified deploy target has an unrecognised kind “#{name}” (expected one of #{names.join(', ')})."
       end
 
       # Check

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

@@ -14,7 +14,7 @@ module Nanoc::CLI::Commands
 
       require_site
 
-      Nanoc::Context.new(env).pry
+      Nanoc::Int::Context.new(env).pry
     end
 
     protected

data/lib/nanoc/cli/commands/show-plugins.rb

@@ -4,7 +4,7 @@ summary 'show all available plugins'
 aliases :info
 usage 'show-plugins [options]'
 description <<-EOS
-Show a list of available plugins, including filters, data sources and VCSes.
+Show a list of available plugins, including filters and data sources.
 If the current directory contains a nanoc web site, the plugins defined in this site will be shown as well.
 EOS
 
@@ -13,13 +13,13 @@ module Nanoc::CLI::Commands
     def run
       # Check arguments
       if arguments.size != 0
-        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
+        raise Nanoc::Int::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Get list of plugins (before and after)
-      plugins_before = Nanoc::Plugin.all
+      plugins_before = Nanoc::Int::PluginRegistry.instance.all
       site.code_snippets if site
-      plugins_after  = Nanoc::Plugin.all
+      plugins_after  = Nanoc::Int::PluginRegistry.instance.all
 
       # Divide list of plugins into builtin and custom
       plugins_builtin = plugins_before
@@ -73,7 +73,6 @@ module Nanoc::CLI::Commands
 
     PLUGIN_CLASS_ORDER = [
       Nanoc::Filter,
-      Nanoc::Extra::VCS,
       Nanoc::DataSource,
       Nanoc::Extra::Deployer
     ] unless defined? PLUGIN_CLASS_ORDER
@@ -81,7 +80,6 @@ module Nanoc::CLI::Commands
     PLUGIN_CLASSES = {
       Nanoc::Filter          => 'Filters',
       Nanoc::DataSource      => 'Data Sources',
-      Nanoc::Extra::VCS      => 'VCSes',
       Nanoc::Extra::Deployer => 'Deployers'
     } unless defined? PLUGIN_CLASSES
 

data/lib/nanoc/cli/error_handler.rb

@@ -27,8 +27,6 @@ module Nanoc::CLI
 
     # Disables error handling. This is used by the test cases to prevent error
     # from being handled by the CLI while tests are running.
-    #
-    # @api private
     def self.disable
       @disabled = true
     end
@@ -36,8 +34,6 @@ module Nanoc::CLI
     # Re-enables error handling after it was disabled. This is used by the test
     # cases to prevent error from being handled by the CLI while tests are
     # running.
-    #
-    # @api private
     def self.enable
       @disabled = false
     end
@@ -46,8 +42,6 @@ module Nanoc::CLI
     # called directly; use {Nanoc::CLI::ErrorHandler.handle_while} instead.
     #
     # @return [void]
-    #
-    # @api private
     def handle_while(&_block)
       # Set exit handler
       %w( INT TERM ).each do |signal|
@@ -70,7 +64,7 @@ module Nanoc::CLI
 
       # Run
       yield
-    rescue Nanoc::Errors::GenericTrivial => e
+    rescue Nanoc::Int::Errors::GenericTrivial => e
       $stderr.puts "Error: #{e.message}"
       exit(1)
     rescue Interrupt
@@ -113,8 +107,6 @@ module Nanoc::CLI
     #
     # @param [IO] stream The stream to write the description too
     #
-    # @api private
-    #
     # @return [void]
     def write_compact_error(error, stream)
       # Header
@@ -136,8 +128,6 @@ module Nanoc::CLI
     #
     # @param [IO] stream The stream to write the description too
     #
-    # @api private
-    #
     # @return [void]
     def write_verbose_error(error, stream)
       # Header
@@ -164,12 +154,12 @@ module Nanoc::CLI
       Nanoc::CLI.debug?
     end
 
-    # @return [Nanoc::Site] The site that is currently being processed
+    # @return [Nanoc::Int::Site] The site that is currently being processed
     def site
       @command && @command.site
     end
 
-    # @return [Nanoc::Compiler] The compiler for the current site
+    # @return [Nanoc::Int::Compiler] The compiler for the current site
     def compiler
       site && site.compiler
     end
@@ -284,7 +274,7 @@ module Nanoc::CLI
         stream.puts '  (empty)'
       else
         stack.reverse_each do |obj|
-          if obj.is_a?(Nanoc::ItemRep)
+          if obj.is_a?(Nanoc::Int::ItemRep)
             stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
           else # layout
             stream.puts "  - [layout] #{obj.identifier}"

data/lib/nanoc/cli/logger.rb

@@ -5,6 +5,8 @@ require 'singleton'
 module Nanoc::CLI
   # Nanoc::CLI::Logger is a singleton class responsible for generating
   # feedback in the terminal.
+  #
+  # @api private
   class Logger
     # Maps actions (`:create`, `:update`, `:identical`, `:skip` and `:delete`)
     # onto their ANSI color codes.

data/lib/nanoc/cli/stream_cleaners.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::CLI
+  # @api private
   module StreamCleaners
     autoload 'Abstract',   'nanoc/cli/stream_cleaners/abstract'
     autoload 'ANSIColors', 'nanoc/cli/stream_cleaners/ansi_colors'

data/lib/nanoc/cli/stream_cleaners/abstract.rb

@@ -6,6 +6,8 @@ module Nanoc::CLI::StreamCleaners
   # can have state, so they can act as a FSM.
   #
   # @abstract Subclasses must implement {#clean}
+  #
+  # @api private
   class Abstract
     # Returns a cleaned version of the given string.
     #

data/lib/nanoc/cli/stream_cleaners/ansi_colors.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::CLI::StreamCleaners
   # Removes ANSI color escape sequences.
+  #
+  # @api private
   class ANSIColors < Abstract
     # @see Nanoc::CLI::StreamCleaners::Abstract#clean
     def clean(s)

data/lib/nanoc/cli/stream_cleaners/utf8.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::CLI::StreamCleaners
   # Simplifies output by replacing UTF-8 characters with their ASCII decompositions.
+  #
+  # @api private
   class UTF8 < Abstract
     # @see Nanoc::CLI::StreamCleaners::Abstract#clean
     def clean(s)

data/lib/nanoc/data_sources.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::DataSources
   autoload 'Filesystem',         'nanoc/data_sources/filesystem'
   autoload 'FilesystemUnified',  'nanoc/data_sources/filesystem_unified'
@@ -9,21 +10,4 @@ module Nanoc::DataSources
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemVerbose',  :filesystem_verbose
   Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemUnified',  :filesystem_unified
   Nanoc::DataSource.register '::Nanoc::DataSources::Static',             :static
-
-  # Deprecated; fetch data from online data sources manually instead
-  # TODO: [in nanoc 4.0] remove me
-  autoload 'Delicious', 'nanoc/data_sources/deprecated/delicious'
-  autoload 'LastFM',    'nanoc/data_sources/deprecated/last_fm'
-  autoload 'Twitter',   'nanoc/data_sources/deprecated/twitter'
-  Nanoc::DataSource.register '::Nanoc::DataSources::Delicious',          :delicious
-  Nanoc::DataSource.register '::Nanoc::DataSources::LastFM',             :last_fm
-  Nanoc::DataSource.register '::Nanoc::DataSources::Twitter',            :twitter
-
-  # Deprecated; use `filesystem_verbose` or `filesystem_unified` instead
-  # TODO: [in nanoc 4.0] remove me
-  Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemVerbose',  :filesystem
-  Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemUnified',  :filesystem_combined
-  Nanoc::DataSource.register '::Nanoc::DataSources::FilesystemUnified',  :filesystem_compact
-  FilesystemCombined = FilesystemUnified
-  FilesystemCompact  = FilesystemUnified
 end

data/lib/nanoc/data_sources/filesystem.rb

@@ -2,17 +2,9 @@
 
 module Nanoc::DataSources
   # Provides functionality common across all filesystem data sources.
+  #
+  # @api private
   module Filesystem
-    # The VCS that will be called when adding, deleting and moving files. If
-    # no VCS has been set, or if the VCS has been set to `nil`, a dummy VCS
-    # will be returned.
-    #
-    # @return [Nanoc::Extra::VCS, nil] The VCS that will be used.
-    def vcs
-      @vcs ||= Nanoc::Extra::VCSes::Dummy.new
-    end
-    attr_writer :vcs
-
     # See {Nanoc::DataSource#up}.
     def up
     end
@@ -29,33 +21,14 @@ module Nanoc::DataSources
       config.fetch(:layouts_dir, 'layouts')
     end
 
-    # See {Nanoc::DataSource#setup}.
-    def setup
-      # Create directories
-      [content_dir_name, layouts_dir_name].each do |dir|
-        FileUtils.mkdir_p(dir)
-        vcs.add(dir)
-      end
-    end
-
     # See {Nanoc::DataSource#items}.
     def items
-      load_objects(content_dir_name, 'item', Nanoc::Item)
+      load_objects(content_dir_name, 'item', Nanoc::Int::Item)
     end
 
     # See {Nanoc::DataSource#layouts}.
     def layouts
-      load_objects(layouts_dir_name, 'layout', Nanoc::Layout)
-    end
-
-    # See {Nanoc::DataSource#create_item}.
-    def create_item(content, attributes, identifier, params = {})
-      create_object(content_dir_name, content, attributes, identifier, params)
-    end
-
-    # See {Nanoc::DataSource#create_layout}.
-    def create_layout(content, attributes, identifier, params = {})
-      create_object(layouts_dir_name, content, attributes, identifier, params)
+      load_objects(layouts_dir_name, 'layout', Nanoc::Int::Layout)
     end
 
     protected
@@ -88,10 +61,10 @@ module Nanoc::DataSources
 
         # Read content and metadata
         is_binary = content_filename && !@site.config[:text_extensions].include?(File.extname(content_filename)[1..-1])
-        if is_binary && klass == Nanoc::Item
+        if is_binary && klass == Nanoc::Int::Item
           meta                = (meta_filename && YAML.load_file(meta_filename)) || {}
           content_or_filename = content_filename
-        elsif is_binary && klass == Nanoc::Layout
+        elsif is_binary && klass == Nanoc::Int::Layout
           raise "The layout file '#{content_filename}' is a binary file, but layouts can only be textual"
         else
           meta, content_or_filename = parse(content_filename, meta_filename, kind)
@@ -103,10 +76,6 @@ module Nanoc::DataSources
           content_filename: content_filename,
           meta_filename: meta_filename,
           extension: content_filename ? ext_of(content_filename)[1..-1] : nil,
-          # WARNING :file is deprecated; please create a File object manually
-          # using the :content_filename or :meta_filename attributes.
-          # TODO: [in nanoc 4.0] remove me
-          file: content_filename ? Nanoc::Extra::FileProxy.new(content_filename) : nil
         }.merge(meta)
 
         # Get identifier

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -66,6 +66,8 @@ module Nanoc::DataSources
   # files. In the data source configuration, set `encoding` to an encoding
   # understood by Ruby’s `Encoding`. If no encoding is set in the configuration,
   # one will be inferred from the environment.
+  #
+  # @api private
   class FilesystemUnified < Nanoc::DataSource
     include Nanoc::DataSources::Filesystem
 
@@ -84,12 +86,12 @@ module Nanoc::DataSources
       parent_path = File.dirname(path)
 
       # Notify
-      Nanoc::NotificationCenter.post(:file_created, path)
+      Nanoc::Int::NotificationCenter.post(:file_created, path)
 
       # Write item
       FileUtils.mkdir_p(parent_path)
       File.open(path, 'w') do |io|
-        meta = attributes.stringify_keys_recursively
+        meta = attributes.__nanoc_stringify_keys_recursively
         unless meta == {}
           io.write(YAML.dump(meta).strip + "\n")
           io.write("---\n")
@@ -117,7 +119,7 @@ module Nanoc::DataSources
       else
         regex = @config && @config[:allow_periods_in_identifiers] ? /\.[^\/\.]+$/ : /\.[^\/]+$/
       end
-      filename.sub(regex, '').cleaned_identifier
+      filename.sub(regex, '').__nanoc_cleaned_identifier
     end
   end
 end

data/lib/nanoc/data_sources/filesystem_verbose.rb

@@ -38,6 +38,8 @@ module Nanoc::DataSources
   # files. In the data source configuration, set `encoding` to an encoding
   # understood by Ruby’s `Encoding`. If no encoding is set in the configuration,
   # one will be inferred from the environment.
+  #
+  # @api private
   class FilesystemVerbose < Nanoc::DataSource
     include Nanoc::DataSources::Filesystem
 
@@ -55,12 +57,12 @@ module Nanoc::DataSources
       content_filename = dir_name + identifier + last_component + ext
 
       # Notify
-      Nanoc::NotificationCenter.post(:file_created, meta_filename)
-      Nanoc::NotificationCenter.post(:file_created, content_filename)
+      Nanoc::Int::NotificationCenter.post(:file_created, meta_filename)
+      Nanoc::Int::NotificationCenter.post(:file_created, content_filename)
 
       # Create files
       FileUtils.mkdir_p(dir_path)
-      File.open(meta_filename,    'w') { |io| io.write(YAML.dump(attributes.stringify_keys_recursively)) }
+      File.open(meta_filename,    'w') { |io| io.write(YAML.dump(attributes.__nanoc_stringify_keys_recursively)) }
       File.open(content_filename, 'w') { |io| io.write(content) }
     end
 

data/lib/nanoc/data_sources/static.rb

@@ -24,6 +24,8 @@ module Nanoc::DataSources
   # data sources will have the :is_hidden attribute set by default, which will
   # exclude them from the Blogging helper's atom feed generator, among other
   # things.
+  #
+  # @api private
   class Static < Nanoc::DataSource
     identifier :static
 
@@ -40,9 +42,9 @@ module Nanoc::DataSources
         attributes[:is_hidden] = true unless config[:hide_items] == false
         identifier = filename[(prefix.length + 1)..-1] + '/'
         mtime      = File.mtime(filename)
-        checksum   = Pathname.new(filename).checksum
+        checksum   = Pathname.new(filename).__nanoc_checksum
 
-        Nanoc::Item.new(
+        Nanoc::Int::Item.new(
           filename,
           attributes,
           identifier,

data/lib/nanoc/extra.rb

@@ -1,27 +1,15 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::Extra
-  autoload 'AutoCompiler',        'nanoc/extra/auto_compiler'
   autoload 'Checking',            'nanoc/extra/checking'
-  autoload 'CHiCk',               'nanoc/extra/chick'
   autoload 'FilesystemTools',     'nanoc/extra/filesystem_tools'
   autoload 'LinkCollector',       'nanoc/extra/link_collector.rb'
   autoload 'Pruner',              'nanoc/extra/pruner'
-  autoload 'Validators',          'nanoc/extra/validators'
   autoload 'Piper',               'nanoc/extra/piper'
   autoload 'JRubyNokogiriWarner', 'nanoc/extra/jruby_nokogiri_warner'
-
-  # Deprecated; use {Nanoc::Context} instead
-  # TODO: [in nanoc 4.0] remove me
-  Context = ::Nanoc::Context
-
-  # Deprecated
-  # TODO: [in nanoc 4.0] remove me
-  autoload 'FileProxy',         'nanoc/extra/file_proxy'
 end
 
 require 'nanoc/extra/core_ext'
 require 'nanoc/extra/deployer'
 require 'nanoc/extra/deployers'
-require 'nanoc/extra/vcs'
-require 'nanoc/extra/vcses'

data/lib/nanoc/extra/checking.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra
+  # @api private
   module Checking
     autoload 'Check',  'nanoc/extra/checking/check'
     autoload 'DSL',    'nanoc/extra/checking/dsl'

data/lib/nanoc/extra/checking/check.rb

@@ -1,14 +1,16 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
-  class OutputDirNotFoundError < Nanoc::Errors::Generic
+  # @api private
+  class OutputDirNotFoundError < Nanoc::Int::Errors::Generic
     def initialize(directory_path)
       super("Unable to run check against output directory at “#{directory_path}”: directory does not exist.")
     end
   end
 
+  # @api private
   class Check
-    extend Nanoc::PluginRegistry::PluginMethods
+    extend Nanoc::Int::PluginRegistry::PluginMethods
 
     attr_reader :site
     attr_reader :issues