nanoc 3.8.0 → 4.0.0a1

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

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::Extra::Checking::Checks
   autoload 'CSS',           'nanoc/extra/checking/checks/css'
   autoload 'ExternalLinks', 'nanoc/extra/checking/checks/external_links'

data/lib/nanoc/extra/checking/checks/css.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module ::Nanoc::Extra::Checking::Checks
+  # @api private
   class CSS < ::Nanoc::Extra::Checking::Check
     identifier :css
 

data/lib/nanoc/extra/checking/checks/external_links.rb

@@ -8,6 +8,8 @@ require 'uri'
 
 module ::Nanoc::Extra::Checking::Checks
   # A validator that verifies that all external links point to a location that exists.
+  #
+  # @api private
   class ExternalLinks < ::Nanoc::Extra::Checking::Check
     identifiers :external_links, :elinks
 

data/lib/nanoc/extra/checking/checks/html.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module ::Nanoc::Extra::Checking::Checks
+  # @api private
   class HTML < ::Nanoc::Extra::Checking::Check
     identifier :html
 

data/lib/nanoc/extra/checking/checks/internal_links.rb

@@ -4,6 +4,8 @@ require 'uri'
 
 module Nanoc::Extra::Checking::Checks
   # A check that verifies that all internal links point to a location that exists.
+  #
+  # @api private
   class InternalLinks < ::Nanoc::Extra::Checking::Check
     # Starts the validator. The results will be printed to stdout.
     #

data/lib/nanoc/extra/checking/checks/mixed_content.rb

@@ -3,6 +3,8 @@
 module Nanoc::Extra::Checking::Checks
   # A check that verifies HTML files do not reference external resources with
   # URLs that would trigger "mixed content" warnings.
+  #
+  # @api private
   class MixedContent < ::Nanoc::Extra::Checking::Check
     PROTOCOL_PATTERN = /^(\w+):\/\//
 

data/lib/nanoc/extra/checking/checks/stale.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking::Checks
+  # @api private
   class Stale < ::Nanoc::Extra::Checking::Check
     def run
       require 'set'

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

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
+  # @api private
   class DSL
     attr_reader :deploy_checks
 

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

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra::Checking
+  # @api private
   class Issue
     attr_reader :description
     attr_reader :subject

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

@@ -7,7 +7,7 @@ module Nanoc::Extra::Checking
   class Runner
     CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb']
 
-    # @param [Nanoc::Site] site The nanoc site this runner is for
+    # @param [Nanoc::Int::Site] site The nanoc site this runner is for
     def initialize(site)
       @site = site
     end
@@ -81,7 +81,7 @@ module Nanoc::Extra::Checking
     def require_dsl
       load_dsl_if_available
       if dsl.nil?
-        raise Nanoc::Errors::GenericTrivial, "No checks defined (no #{CHECKS_FILENAMES.first} file present)"
+        raise Nanoc::Int::Errors::GenericTrivial, "No checks defined (no #{CHECKS_FILENAMES.first} file present)"
       end
     end
 
@@ -102,7 +102,7 @@ module Nanoc::Extra::Checking
     def check_classes_named(n)
       n.map do |a|
         klass = Nanoc::Extra::Checking::Check.named(a)
-        raise Nanoc::Errors::GenericTrivial, "Unknown check: #{a}" if klass.nil?
+        raise Nanoc::Int::Errors::GenericTrivial, "Unknown check: #{a}" if klass.nil?
         klass
       end
     end

data/lib/nanoc/extra/core_ext/pathname.rb

@@ -1,8 +1,9 @@
 # encoding: utf-8
 
 module Nanoc::Extra
+  # @api private
   module PathnameExtensions
-    def components
+    def __nanoc_components
       components = []
       tmp = self
       loop do
@@ -14,12 +15,13 @@ module Nanoc::Extra
       components.reverse
     end
 
-    def include_component?(component)
-      components.include?(component)
+    def __nanoc_include_component?(component)
+      __nanoc_components.include?(component)
     end
   end
 end
 
+# @api private
 class ::Pathname
   include ::Nanoc::Extra::PathnameExtensions
 end

data/lib/nanoc/extra/core_ext/time.rb

@@ -1,17 +1,19 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::Extra::TimeExtensions
   # @return [String] The time in an ISO-8601 date format.
-  def to_iso8601_date
+  def __nanoc_to_iso8601_date
     strftime('%Y-%m-%d')
   end
 
   # @return [String] The time in an ISO-8601 time format.
-  def to_iso8601_time
+  def __nanoc_to_iso8601_time
     getutc.strftime('%Y-%m-%dT%H:%M:%SZ')
   end
 end
 
+# @api private
 class Time
   include Nanoc::Extra::TimeExtensions
 end

data/lib/nanoc/extra/deployer.rb

@@ -5,8 +5,10 @@ module Nanoc::Extra
   # to a specific (remote) location.
   #
   # @abstract Subclass and override {#run} to implement a custom filter.
+  #
+  # @api private
   class Deployer
-    extend Nanoc::PluginRegistry::PluginMethods
+    extend Nanoc::Int::PluginRegistry::PluginMethods
 
     # @return [String] The path to the directory that contains the files to
     #   upload. It should not have a trailing slash.

data/lib/nanoc/extra/deployers.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Extra
+  # @api private
   module Deployers
     autoload 'Fog',   'nanoc/extra/deployers/fog'
     autoload 'Rsync', 'nanoc/extra/deployers/rsync'

data/lib/nanoc/extra/deployers/fog.rb

@@ -20,6 +20,8 @@ module Nanoc::Extra::Deployers
   #       provider:   local
   #       local_root: ~/myCloud
   #       bucket:     nanoc-site-staging
+  #
+  # @api private
   class Fog < ::Nanoc::Extra::Deployer
     # @see Nanoc::Extra::Deployer#run
     def run

data/lib/nanoc/extra/deployers/rsync.rb

@@ -18,6 +18,8 @@ module Nanoc::Extra::Deployers
   #       kind: rsync
   #       dst: "ectype:sites/stoneship-staging/public"
   #       options: [ "-glpPrtvz" ]
+  #
+  # @api private
   class Rsync < ::Nanoc::Extra::Deployer
     # Default rsync options
     DEFAULT_OPTIONS = [

data/lib/nanoc/extra/filesystem_tools.rb

@@ -6,9 +6,7 @@ module Nanoc::Extra
   # @api private
   module FilesystemTools
     # Error that is raised when too many symlink indirections are encountered.
-    #
-    # @api private
-    class MaxSymlinkDepthExceededError < ::Nanoc::Errors::GenericTrivial
+    class MaxSymlinkDepthExceededError < ::Nanoc::Int::Errors::GenericTrivial
       # @return [String] The last filename that was attempted to be
       #   resolved before giving up
       attr_reader :filename
@@ -23,9 +21,7 @@ module Nanoc::Extra
 
     # Error that is raised when a file of an unknown type is encountered
     # (something other than file, directory or link).
-    #
-    # @api private
-    class UnsupportedFileTypeError < ::Nanoc::Errors::GenericTrivial
+    class UnsupportedFileTypeError < ::Nanoc::Int::Errors::GenericTrivial
       # @return [String] The filename of the file whose type is not supported
       attr_reader :filename
 
@@ -106,7 +102,7 @@ module Nanoc::Extra
       when Array
         patterns.concat(extra_files.map { |extra_file| "#{dir_name}/#{extra_file}" })
       else
-        raise Nanoc::Errors::GenericTrivial,
+        raise Nanoc::Int::Errors::GenericTrivial,
           "Do not know how to handle extra_files: #{extra_files.inspect}"
       end
       Dir.glob(patterns)

data/lib/nanoc/extra/jruby_nokogiri_warner.rb

@@ -3,6 +3,7 @@
 require 'singleton'
 
 module Nanoc::Extra
+  # @api private
   class JRubyNokogiriWarner
     include Singleton
 

data/lib/nanoc/extra/link_collector.rb

@@ -3,6 +3,7 @@
 require 'set'
 
 module ::Nanoc::Extra
+  # @api private
   class LinkCollector
     URI_ATTRS = {
       'a' => :href,

data/lib/nanoc/extra/piper.rb

@@ -3,8 +3,9 @@
 require 'open3'
 
 module Nanoc::Extra
+  # @api private
   class Piper
-    class Error < ::Nanoc::Errors::Generic
+    class Error < ::Nanoc::Int::Errors::Generic
       def initialize(command, exit_code)
         @command   = command
         @exit_code = exit_code

data/lib/nanoc/extra/pruner.rb

@@ -3,11 +3,13 @@
 module Nanoc::Extra
   # Responsible for finding and deleting files in the site’s output directory
   # that are not managed by nanoc.
+  #
+  # @api private
   class Pruner
-    # @return [Nanoc::Site] The site this pruner belongs to
+    # @return [Nanoc::Int::Site] The site this pruner belongs to
     attr_reader :site
 
-    # @param [Nanoc::Site] site The site for which a pruner is created
+    # @param [Nanoc::Int::Site] site The site for which a pruner is created
     #
     # @option params [Boolean] :dry_run (false) true if the files to be deleted
     #   should only be printed instead of actually deleted, false if the files
@@ -58,7 +60,7 @@ module Nanoc::Extra
     # @return [Boolean] true if the given file is excluded, false otherwise
     def filename_excluded?(filename)
       pathname = Pathname.new(filename)
-      @exclude.any? { |e| pathname.include_component?(e) }
+      @exclude.any? { |e| pathname.__nanoc_include_component?(e) }
     end
 
     protected

data/lib/nanoc/filters.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
+# @api private
 module Nanoc::Filters
   autoload 'AsciiDoc',        'nanoc/filters/asciidoc'
   autoload 'BlueCloth',       'nanoc/filters/bluecloth'
-  autoload 'CodeRay',         'nanoc/filters/coderay'
   autoload 'ColorizeSyntax',  'nanoc/filters/colorize_syntax'
   autoload 'CoffeeScript',    'nanoc/filters/coffeescript'
   autoload 'ERB',             'nanoc/filters/erb'
@@ -32,7 +32,6 @@ module Nanoc::Filters
 
   Nanoc::Filter.register '::Nanoc::Filters::AsciiDoc',        :asciidoc
   Nanoc::Filter.register '::Nanoc::Filters::BlueCloth',       :bluecloth
-  Nanoc::Filter.register '::Nanoc::Filters::CodeRay',         :coderay
   Nanoc::Filter.register '::Nanoc::Filters::ColorizeSyntax',  :colorize_syntax
   Nanoc::Filter.register '::Nanoc::Filters::CoffeeScript',    :coffeescript
   Nanoc::Filter.register '::Nanoc::Filters::ERB',             :erb

data/lib/nanoc/filters/asciidoc.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.2.0
+  #
+  # @api private
   class AsciiDoc < Nanoc::Filter
     # Runs the content through [AsciiDoc](http://www.methods.co.nz/asciidoc/).
     # This method takes no options.

data/lib/nanoc/filters/bluecloth.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class BlueCloth < Nanoc::Filter
     requires 'bluecloth'
 

data/lib/nanoc/filters/coffeescript.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.3.0
+  #
+  # @api private
   class CoffeeScript < Nanoc::Filter
     requires 'coffee-script'
 

data/lib/nanoc/filters/colorize_syntax.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class ColorizeSyntax < Nanoc::Filter
     requires 'nokogiri', 'stringio', 'open3'
 
@@ -155,8 +156,6 @@ module Nanoc::Filters
     #
     # @param [Boolean] is_fullpage true if the given content is a full page,
     #   false if it is a fragment
-    #
-    # @api private
     def parse(content, klass, is_fullpage)
       if is_fullpage
         klass.parse(content, nil, 'UTF-8')
@@ -173,8 +172,6 @@ module Nanoc::Filters
 
     # Runs the code through [CodeRay](http://coderay.rubychan.de/).
     #
-    # @api private
-    #
     # @param [String] code The code to colorize
     #
     # @param [String] language The language the code is written in
@@ -203,8 +200,6 @@ module Nanoc::Filters
     # Runs the content through [pygmentize](http://pygments.org/docs/cmdline/),
     # the command-line frontend for [Pygments](http://pygments.org/).
     #
-    # @api private
-    #
     # @param [String] code The code to colorize
     #
     # @param [String] language The language the code is written in
@@ -232,8 +227,6 @@ module Nanoc::Filters
     # Runs the content through [Pygments](http://pygments.org/) via
     # [pygments.rb](https://github.com/tmm1/pygments.rb).
     #
-    # @api private
-    #
     # @param [String] code The code to colorize
     #
     # @param [String] language The language the code is written in
@@ -259,8 +252,6 @@ module Nanoc::Filters
 
     # Runs the content through [Highlight](http://www.andre-simon.de/doku/highlight/en/highlight.html).
     #
-    # @api private
-    #
     # @since 3.2.0
     #
     # @param [String] code The code to colorize
@@ -315,8 +306,6 @@ module Nanoc::Filters
 
     # Runs the content through [Rouge](https://github.com/jayferd/rouge/.
     #
-    # @api private
-    #
     # @param [String] code The code to colorize
     #
     # @param [String] language The language the code is written in

data/lib/nanoc/filters/erb.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class ERB < Nanoc::Filter
     requires 'erb'
 
@@ -19,7 +20,7 @@ module Nanoc::Filters
       assigns.merge!(params[:locals] || {})
 
       # Create context
-      context = ::Nanoc::Context.new(assigns)
+      context = ::Nanoc::Int::Context.new(assigns)
 
       # Get binding
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/erubis.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class Erubis < Nanoc::Filter
     requires 'erubis'
 
@@ -19,7 +20,7 @@ module Nanoc::Filters
     # @return [String] The filtered content
     def run(content, _params = {})
       # Create context
-      context = ::Nanoc::Context.new(assigns)
+      context = ::Nanoc::Int::Context.new(assigns)
 
       # Get binding
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/haml.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class Haml < Nanoc::Filter
     requires 'haml'
 
@@ -15,7 +16,7 @@ module Nanoc::Filters
       options = params.merge(filename: filename)
 
       # Create context
-      context = ::Nanoc::Context.new(assigns)
+      context = ::Nanoc::Int::Context.new(assigns)
 
       # Get result
       proc = assigns[:content] ? -> { assigns[:content] } : nil

data/lib/nanoc/filters/handlebars.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.4.0
+  #
+  # @api private
   class Handlebars < Nanoc::Filter
     requires 'handlebars'