nanoc 3.8.0 → 4.0.0a1

data/lib/nanoc/filters/kramdown.rb

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

data/lib/nanoc/filters/less.rb

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

data/lib/nanoc/filters/markaby.rb

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

data/lib/nanoc/filters/maruku.rb

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

data/lib/nanoc/filters/mustache.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.2.0
+  #
+  # @api private
   class Mustache < Nanoc::Filter
     requires 'mustache'
 

data/lib/nanoc/filters/pandoc.rb

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

data/lib/nanoc/filters/rainpress.rb

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

data/lib/nanoc/filters/rdiscount.rb

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

data/lib/nanoc/filters/rdoc.rb

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

data/lib/nanoc/filters/redcarpet.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.2.0
+  #
+  # @api private
   class Redcarpet < Nanoc::Filter
     requires 'redcarpet'
 

data/lib/nanoc/filters/redcloth.rb

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

data/lib/nanoc/filters/relativize_paths.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class RelativizePaths < Nanoc::Filter
     require 'nanoc/helpers/link_to'
     include Nanoc::Helpers::LinkTo

data/lib/nanoc/filters/rubypants.rb

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

data/lib/nanoc/filters/sass.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Filters
+  # @api private
   class Sass < Nanoc::Filter
     requires 'sass', 'nanoc/filters/sass/sass_filesystem_importer'
 

data/lib/nanoc/filters/sass/sass_filesystem_importer.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+# @api private
 class ::Sass::Importers::Filesystem
   alias_method :_orig_find, :_find
 
@@ -12,6 +13,7 @@ class ::Sass::Importers::Filesystem
     filter = options[:nanoc_current_filter]
     if filter
       item = filter.imported_filename_to_item(full_filename)
+      item = item.unwrap if item.respond_to?(:unwrap)
       filter.depend_on([item]) unless item.nil?
     end
 

data/lib/nanoc/filters/slim.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.2.0
+  #
+  # @api private
   class Slim < Nanoc::Filter
     requires 'slim'
 
@@ -18,7 +20,7 @@ module Nanoc::Filters
       }.merge params
 
       # Create context
-      context = ::Nanoc::Context.new(assigns)
+      context = ::Nanoc::Int::Context.new(assigns)
 
       ::Slim::Template.new(params) { content }.render(context) { assigns[:content] }
     end

data/lib/nanoc/filters/typogruby.rb

@@ -2,6 +2,8 @@
 
 module Nanoc::Filters
   # @since 3.2.0
+  #
+  # @api private
   class Typogruby < Nanoc::Filter
     requires 'typogruby'
 

data/lib/nanoc/filters/uglify_js.rb

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

data/lib/nanoc/filters/xsl.rb

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

data/lib/nanoc/filters/yui_compressor.rb

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

data/lib/nanoc/helpers/blogging.rb

@@ -52,7 +52,7 @@ module Nanoc::Helpers
     class AtomFeedBuilder
       include Nanoc::Helpers::Blogging
 
-      attr_accessor :site
+      attr_accessor :config
 
       attr_accessor :limit
       attr_accessor :relevant_articles
@@ -65,8 +65,8 @@ module Nanoc::Helpers
       attr_accessor :icon
       attr_accessor :logo
 
-      def initialize(site, item)
-        @site = site
+      def initialize(config, item)
+        @config = config
         @item = item
       end
 
@@ -100,43 +100,43 @@ module Nanoc::Helpers
       end
 
       def validate_config
-        if @site.config[:base_url].nil?
-          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
+        if @config[:base_url].nil?
+          raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
         end
       end
 
       def validate_feed_item
         if title.nil?
-          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no title in params, item or site config')
+          raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: no title in params, item or site config')
         end
         if author_name.nil?
-          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no author_name in params, item or site config')
+          raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: no author_name in params, item or site config')
         end
         if author_uri.nil?
-          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no author_uri in params, item or site config')
+          raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: no author_uri in params, item or site config')
         end
       end
 
       def validate_articles
         if relevant_articles.empty?
-          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no articles')
+          raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: no articles')
         end
         if relevant_articles.any? { |a| a[:created_at].nil? }
-          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: one or more articles lack created_at')
+          raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: one or more articles lack created_at')
         end
       end
 
       def build_for_feed(xml)
         xml.instruct!
         xml.feed(xmlns: 'http://www.w3.org/2005/Atom') do
-          root_url = @site.config[:base_url] + '/'
+          root_url = @config[:base_url] + '/'
 
           # Add primary attributes
           xml.id root_url
           xml.title title
 
           # Add date
-          xml.updated(attribute_to_time(last_article[:created_at]).to_iso8601_time)
+          xml.updated(attribute_to_time(last_article[:created_at]).__nanoc_to_iso8601_time)
 
           # Add links
           xml.link(rel: 'alternate', href: root_url)
@@ -170,8 +170,8 @@ module Nanoc::Helpers
           xml.title a[:title], type: 'html'
 
           # Add dates
-          xml.published attribute_to_time(a[:created_at]).to_iso8601_time
-          xml.updated attribute_to_time(a[:updated_at] || a[:created_at]).to_iso8601_time
+          xml.published attribute_to_time(a[:created_at]).__nanoc_to_iso8601_time
+          xml.updated attribute_to_time(a[:updated_at] || a[:created_at]).__nanoc_to_iso8601_time
 
           # Add specific author information
           if a[:author_name] || a[:author_uri]
@@ -308,7 +308,7 @@ module Nanoc::Helpers
       require 'builder'
 
       # Create builder
-      builder = AtomFeedBuilder.new(@site, @item)
+      builder = AtomFeedBuilder.new(@config, @item)
 
       # Fill builder
       builder.limit             = params[:limit] || 5
@@ -316,9 +316,9 @@ module Nanoc::Helpers
       builder.preserve_order    = params.fetch(:preserve_order, false)
       builder.content_proc      = params[:content_proc] || ->(a) { a.compiled_content(snapshot: :pre) }
       builder.excerpt_proc      = params[:excerpt_proc] || ->(a) { a[:excerpt] }
-      builder.title             = params[:title] || @item[:title] || @site.config[:title]
-      builder.author_name       = params[:author_name] || @item[:author_name] || @site.config[:author_name]
-      builder.author_uri        = params[:author_uri] || @item[:author_uri] || @site.config[:author_uri]
+      builder.title             = params[:title] || @item[:title] || @config[:title]
+      builder.author_name       = params[:author_name] || @item[:author_name] || @config[:author_name]
+      builder.author_uri        = params[:author_uri] || @item[:author_uri] || @config[:author_uri]
       builder.icon              = params[:icon]
       builder.logo              = params[:logo]
 
@@ -330,22 +330,22 @@ module Nanoc::Helpers
     # Returns the URL for the given item. It will return the URL containing
     # the custom path in the feed if possible, otherwise the normal path.
     #
-    # @param [Nanoc::Item] item The item for which to fetch the URL.
+    # @param [Nanoc::Int::Item] item The item for which to fetch the URL.
     #
     # @return [String] The URL of the given item
     def url_for(item)
       # Check attributes
-      if @site.config[:base_url].nil?
-        raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
+      if @config[:base_url].nil?
+        raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
       end
 
       # Build URL
       if item[:custom_url_in_feed]
         item[:custom_url_in_feed]
       elsif item[:custom_path_in_feed]
-        @site.config[:base_url] + item[:custom_path_in_feed]
+        @config[:base_url] + item[:custom_path_in_feed]
       elsif item.path
-        @site.config[:base_url] + item.path
+        @config[:base_url] + item.path
       end
     end
 
@@ -355,11 +355,11 @@ module Nanoc::Helpers
     # @return [String] The URL of the feed
     def feed_url
       # Check attributes
-      if @site.config[:base_url].nil?
-        raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
+      if @config[:base_url].nil?
+        raise Nanoc::Int::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
       end
 
-      @item[:feed_url] || @site.config[:base_url] + @item.path
+      @item[:feed_url] || @config[:base_url] + @item.path
     end
 
     # Returns an URI containing an unique ID for the given item. This will be
@@ -368,15 +368,15 @@ module Nanoc::Helpers
     # ["How to make a good ID in Atom" blog post]
     # (http://web.archive.org/web/20110915110202/http://diveintomark.org/archives/2004/05/28/howto-atom-id).
     #
-    # @param [Nanoc::Item] item The item for which to create an atom tag
+    # @param [Nanoc::Int::Item] item The item for which to create an atom tag
     #
     # @return [String] The atom tag for the given item
     def atom_tag_for(item)
-      hostname, base_dir = %r{^.+?://([^/]+)(.*)$}.match(@site.config[:base_url])[1..2]
+      hostname, base_dir = %r{^.+?://([^/]+)(.*)$}.match(@config[:base_url])[1..2]
 
-      formatted_date = attribute_to_time(item[:created_at]).to_iso8601_date
+      formatted_date = attribute_to_time(item[:created_at]).__nanoc_to_iso8601_date
 
-      'tag:' + hostname + ',' + formatted_date + ':' + base_dir + (item.path || item.identifier)
+      'tag:' + hostname + ',' + formatted_date + ':' + base_dir + (item.path || item.identifier.to_s)
     end
 
     # Converts the given attribute (which can be a string, a Time or a Date)

data/lib/nanoc/helpers/breadcrumbs.rb

@@ -17,11 +17,11 @@ module Nanoc::Helpers
       idx_start  = 0
 
       loop do
-        idx = @item.identifier.index('/', idx_start)
+        idx = @item.identifier.to_s.index('/', idx_start)
         break if idx.nil?
 
         idx_start = idx + 1
-        identifier = @item.identifier[0..idx]
+        identifier = @item.identifier.to_s[0..idx]
         trail << @items[identifier]
       end
 

data/lib/nanoc/helpers/capturing.rb

@@ -26,13 +26,6 @@ module Nanoc::Helpers
   #     <h3>Summary</h3>
   #     <%= content_for(@item, :summary) || '(no summary)' %>
   #   </div>
-  #
-  # @example Showing captured content in a sidebar the old, deprecated way (do not use or I will become very angry)
-  #
-  #   <div id="sidebar">
-  #     <h3>Summary</h3>
-  #     <%= @item[:content_for_summary] || '(no summary)' %>
-  #   </div>
   module Capturing
     # @api private
     class CapturesStore
@@ -51,7 +44,7 @@ module Nanoc::Helpers
       end
     end
 
-    class ::Nanoc::Site
+    class ::Nanoc::Int::Site
       # @api private
       def captures_store
         @captures_store ||= CapturesStore.new
@@ -71,11 +64,6 @@ module Nanoc::Helpers
     #   getting the captured content as well as setting it. When capturing,
     #   the content of the block itself will not be outputted.
     #
-    #   For backwards compatibility, it is also possible to fetch the captured
-    #   content by getting the contents of the attribute named `content_for_`
-    #   followed by the given name. This way of accessing captures is
-    #   deprecated.
-    #
     #   @param [Symbol, String] name The base name of the attribute into which
     #     the content should be stored
     #
@@ -86,7 +74,7 @@ module Nanoc::Helpers
     #   Fetches the capture with the given name from the given item and
     #   returns it.
     #
-    #   @param [Nanoc::Item] item The item for which to get the capture
+    #   @param [Nanoc::Int::Item] item The item for which to get the capture
     #
     #   @param [Symbol, String] name The name of the capture to fetch
     #
@@ -110,13 +98,14 @@ module Nanoc::Helpers
             "and the name of the capture) but got #{args.size} instead"
         end
         item = args[0]
+        item = item.unwrap if item.respond_to?(:unwrap)
         name = args[1]
 
         # Create dependency
         current_item = @site.compiler.dependency_tracker.top
         if item != current_item
-          Nanoc::NotificationCenter.post(:visit_started, item)
-          Nanoc::NotificationCenter.post(:visit_ended,   item)
+          Nanoc::Int::NotificationCenter.post(:visit_started, item)
+          Nanoc::Int::NotificationCenter.post(:visit_ended,   item)
 
           # This is an extremely ugly hack to get the compiler to recompile the
           # item from which we use content. For this, we need to manually edit
@@ -128,7 +117,7 @@ module Nanoc::Helpers
             item.reps.each do |r|
               raw_content = item.raw_content
               r.content = { raw: raw_content, last: raw_content }
-              raise Nanoc::Errors::UnmetDependency.new(r)
+              raise Nanoc::Int::Errors::UnmetDependency.new(r)
             end
           end
         end

data/lib/nanoc/helpers/filtering.rb

@@ -32,13 +32,13 @@ module Nanoc::Helpers
 
       # Find filter
       klass = Nanoc::Filter.named(filter_name)
-      raise Nanoc::Errors::UnknownFilter.new(filter_name) if klass.nil?
+      raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
       filter = klass.new(@item_rep.assigns)
 
       # Filter captured data
-      Nanoc::NotificationCenter.post(:filtering_started, @item_rep, filter_name)
+      Nanoc::Int::NotificationCenter.post(:filtering_started, @item_rep, filter_name)
       filtered_data = filter.setup_and_run(data, arguments)
-      Nanoc::NotificationCenter.post(:filtering_ended, @item_rep, filter_name)
+      Nanoc::Int::NotificationCenter.post(:filtering_ended, @item_rep, filter_name)
 
       # Append filtered data to buffer
       buffer = eval('_erbout', block.binding)