nanoc3 3.1.9 → 3.2.0a1

data/lib/nanoc3/cli/logger.rb

@@ -8,8 +8,6 @@ module Nanoc3::CLI
   # feedback in the terminal.
   class Logger
 
-    # Maps actions (`:create`, `:update`, `:identical` and `:skip`) onto their
-    # ANSI color codes.
     ACTION_COLORS = {
       :create         => "\e[1m" + "\e[32m", # bold + green
       :update         => "\e[1m" + "\e[33m", # bold + yellow
@@ -19,38 +17,35 @@ module Nanoc3::CLI
 
     include Singleton
 
-    # Returns the log level, which can be :high, :low or :off (which will log
-    # all messages, only high-priority messages, or no messages at all,
+    # The log level, which can be :high, :low or :off (which will log all
+    # messages, only high-priority messages, or no messages at all,
     # respectively).
-    #
-    # @return [Symbol] The log level
     attr_accessor :level
 
-    # @return [Boolean] True if color should be used, false otherwise
+    # Whether to use color in log messages or not
     attr_accessor :color
     alias_method :color?, :color
 
     def initialize
       @level = :high
-      @color = $stdout.tty?
+      @color = true
 
       # Try enabling color support on Windows
       begin
         require 'Win32/Console/ANSI' if RUBY_PLATFORM =~/mswin|mingw/
       rescue LoadError
-        @color = false
+        warn 'The win32console gem is not available. Install it to enable color support on Windows.'
       end
     end
 
     # Logs a file-related action.
     #
-    # @param [:high, :low] level The importance of this action
-    #
-    # @param [:create, :update, :identical] action The kind of file action
+    # +level+:: The importance of this action. Can be :high or :low.
     #
-    # @param [String] name The name of the file the action was performed on
+    # +action+:: The kind of file action. Can be :create, :update or
+    #            :identical.
     #
-    # @return [void]
+    # +identifier+:: The identifier of the item the action was performed on.
     def file(level, action, identifier, duration=nil)
       log(
         level,
@@ -66,19 +61,18 @@ module Nanoc3::CLI
 
     # Logs a message.
     #
-    # @param [:high, :low] level The importance of this message
-    #
-    # @param [String] message The message to be logged
+    # +level+:: The importance of this message. Can be :high or :low.
     #
-    # @param [#puts] io The stream to which the message should be written
+    # +s+:: The message to be logged.
     #
-    # @return [void]
-    def log(level, message, io=$stdout)
+    # +io+:: The IO instance to which the message will be written. Defaults to
+    #        standard output.
+    def log(level, s, io=$stdout)
       # Don't log when logging is disabled
       return if @level == :off
 
       # Log when level permits it
-      io.puts(message) if (@level == :low or @level == level)
+      io.puts(s) if (@level == :low or @level == level)
     end
 
   end

data/lib/nanoc3/data_sources/deprecated/twitter.rb

@@ -25,7 +25,6 @@ module Nanoc3::DataSources
           attributes = {
             :created_at  => raw_item['created_at'],
             :source      => raw_item['source']
-            # TODO add more
           }
           identifier = "/#{raw_item['id']}/"
           mtime = Time.parse(raw_item['created_at'])

data/lib/nanoc3/data_sources/filesystem.rb

@@ -86,8 +86,7 @@ module Nanoc3::DataSources
           meta                = (meta_filename && YAML.load_file(meta_filename)) || {}
           content_or_filename = content_filename
         else
-          meta, content_or_filename = parse(
-            content_filename, meta_filename, kind)
+          meta, content_or_filename = parse(content_filename, meta_filename, kind)
         end
 
         # Get attributes
@@ -124,10 +123,15 @@ module Nanoc3::DataSources
           raise RuntimeError, "meta_mtime and content_mtime are both nil"
         end
 
+        # Get checksum
+        meta_checksum    = meta_filename    ? Nanoc3::Checksummer.checksum_for(meta_filename)    : nil
+        content_checksum = content_filename ? Nanoc3::Checksummer.checksum_for(content_filename) : nil
+        checksum = [ meta_checksum, content_checksum ].compact.join('-')
+
         # Create layout object
         klass.new(
           content_or_filename, attributes, identifier,
-          :binary => is_binary, :mtime => mtime
+          :binary => is_binary, :mtime => mtime, :checksum => checksum
         )
       end
     end
@@ -229,17 +233,17 @@ module Nanoc3::DataSources
     def parse(content_filename, meta_filename, kind)
       # Read content and metadata from separate files
       if meta_filename
-        content = content_filename ? read(content_filename) : ''
-        meta    = YAML.load(read(meta_filename)) || {}
+        content = content_filename ? File.read(content_filename) : ''
+        meta    = YAML.load_file(meta_filename) || {}
 
         return [ meta, content ]
       end
 
       # Read data
-      data = read(content_filename)
+      data = File.read(content_filename)
 
       # Check presence of metadata section
-      if data !~ /\A-{3,5}\s*$/
+      if data[0, 3] != '-'*3 && data[0, 5] != '-'*5
         return [ {}, data ]
       end
 
@@ -259,39 +263,6 @@ module Nanoc3::DataSources
       [ meta, content ]
     end
 
-    # Reads the content of the file with the given name and returns a string
-    # in UTF-8 encoding. The original encoding of the string is derived from
-    # the default external encoding, but this can be overridden by the
-    # “encoding” configuration attribute in the data source configuration.
-    def read(filename)
-      # Read
-      begin
-        data = File.read(filename)
-      rescue => e
-        raise RuntimeError.new("Could not read #{filename}: #{e.inspect}")
-      end
-
-      # Fix
-      if data.respond_to?(:encode!)
-        if @config && @config[:encoding]
-          original_encoding = Encoding.find(@config[:encoding])
-          data.force_encoding(@config[:encoding])
-        else
-          original_encoding = data.encoding
-        end
-
-        data.encode!('UTF-8') rescue raise_encoding_error(filename, original_encoding)
-        raise_encoding_error(filename, original_encoding) if !data.valid_encoding?
-      end
-
-      data
-    end
-
-    # Raises an invalid encoding error for the given filename and encoding.
-    def raise_encoding_error(filename, encoding)
-      raise RuntimeError.new("Could not read #{filename} because the file is not valid #{encoding}.")
-    end
-
   end
 
 end

data/lib/nanoc3/data_sources/filesystem_unified.rb

@@ -14,10 +14,10 @@ module Nanoc3::DataSources
   # itself can start with a metadata section: it can be stored at the top of
   # the file, between `---` (three dashes) separators. For example:
   #
-  #     ---
-  #     title: "Moo!"
-  #     ---
-  #     h1. Hello!
+  #   ---
+  #   title: "Moo!"
+  #   ---
+  #   h1. Hello!
   #
   # The metadata section can be omitted. If the file does not start with
   # three or five dashes, the entire file will be considered as content.
@@ -26,7 +26,7 @@ module Nanoc3::DataSources
   # an `index.*` filename, such as `index.txt`, will have the filesystem path
   # with the `index.*` part stripped as a identifier. For example:
   #
-  #     foo/bar/index.html → /foo/bar/
+  #   foo/bar/index.html → /foo/bar/
   #
   # In other cases, the identifier is calculated by stripping the extension.
   # If the `allow_periods_in_identifiers` attribute in the configuration is
@@ -34,24 +34,24 @@ module Nanoc3::DataSources
   # extensions; if it is false or unset, all extensions will be stripped.
   # For example:
   #
-  #     (`allow_periods_in_identifiers` set to true)
-  #     foo.entry.html → /foo.entry/
-  #     
-  #     (`allow_periods_in_identifiers` set to false)
-  #     foo.html.erb → /foo/
+  #   (`allow_periods_in_identifiers` set to true)
+  #   foo.entry.html → /foo.entry/
+  #   
+  #   (`allow_periods_in_identifiers` set to false)
+  #   foo.html.erb → /foo/
   #
-  # Note that each item must have an unique identifier. nanoc will display an
-  # error if two items with the same identifier are found.
+  # Note that it is possible for two different, separate files to have the
+  # same identifier. It is recommended to avoid such situations.
   #
   # Some more examples:
   #
-  #     content/index.html          → /
-  #     content/foo.html            → /foo/
-  #     content/foo/index.html      → /foo/
-  #     content/foo/bar.html        → /foo/bar/
-  #     content/foo/bar.baz.html    → /foo/bar/ OR /foo/bar.baz/
-  #     content/foo/bar/index.html  → /foo/bar/
-  #     content/foo.bar/index.html  → /foo.bar/
+  #   content/index.html          → /
+  #   content/foo.html            → /foo/
+  #   content/foo/index.html      → /foo/
+  #   content/foo/bar.html        → /foo/bar/
+  #   content/foo/bar.baz.html    → /foo/bar/ OR /foo/bar.baz/
+  #   content/foo/bar/index.html  → /foo/bar/
+  #   content/foo.bar/index.html  → /foo.bar/
   #
   # The file extension does not determine the filters to run on items; the
   # Rules file is used to specify processing instructors for each item.
@@ -103,10 +103,10 @@ module Nanoc3::DataSources
     # Returns the identifier derived from the given filename, first stripping
     # the given directory name off the filename.
     def identifier_for_filename(filename)
-      if filename =~ /(^|\/)index\.[^\/]+$/
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\/?index\.[^\/\.]+$/ : /\/?index\.[^\/]+$/)
+      if filename =~ /index\.[^\/]+$/
+        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /index\.[^\/\.]+$/ : /index\.[^\/]+$/)
       else
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/         : /\.[^\/]+$/)
+        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/      : /\.[^\/]+$/)
       end
       filename.sub(regex, '').cleaned_identifier
     end

data/lib/nanoc3/extra/auto_compiler.rb

@@ -29,7 +29,7 @@ module Nanoc3::Extra
     # @param [Hash] env The environment, as defined by the Rack specification
     #
     # @return [Array] An array containing the status, the headers, and the
-    # body, as defined by the Rack specification
+    #   body, as defined by the Rack specification
     def call(env)
       @mutex.synchronize do
         # Start with a new site

data/lib/nanoc3/extra/chick.rb

@@ -5,13 +5,13 @@ require 'rack/cache'
 module Nanoc3::Extra
 
   # @deprecated Use a HTTP library such as
-  # [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-  # [Curb](http://curb.rubyforge.org/) instead.
+  #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
+  #   [Curb](http://curb.rubyforge.org/) instead.
   module CHiCk
 
     # @deprecated Use a HTTP library such as
-    # [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-    # [Curb](http://curb.rubyforge.org/) instead.
+    #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
+    #   [Curb](http://curb.rubyforge.org/) instead.
     class Client
 
       DEFAULT_OPTIONS = {
@@ -59,8 +59,8 @@ module Nanoc3::Extra
     end
 
     # @deprecated Use a HTTP library such as
-    # [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-    # [Curb](http://curb.rubyforge.org/) instead.
+    #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
+    #   [Curb](http://curb.rubyforge.org/) instead.
     class CacheController
 
       def initialize(app, options={})
@@ -79,8 +79,8 @@ module Nanoc3::Extra
     end
 
     # @deprecated Use a HTTP library such as
-    # [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-    # [Curb](http://curb.rubyforge.org/) instead.
+    #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
+    #   [Curb](http://curb.rubyforge.org/) instead.
     class RackClient
 
       METHOD_TO_CLASS_MAPPING = {

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

@@ -63,10 +63,10 @@ module Nanoc3::Extra::Deployers
     # Runs the task. Possible params:
     #
     # @option params [Boolean] :dry_run (false) True if the action itself
-    # should not be executed, but still printed; false otherwise.
+    #   should not be executed, but still printed; false otherwise.
     #
     # @option params [String] :config_name (:default) The name of the
-    # deployment configuration to use.
+    #   deployment configuration to use.
     #
     # @return [void]
     def run(params={})
@@ -106,7 +106,6 @@ module Nanoc3::Extra::Deployers
     # Runs the given shell command. This is a simple wrapper around Kernel#system.
     def run_shell_cmd(args)
       system(*args)
-      raise "command exited with a nonzero status code #{$?.exitstatus} (command: #{args.join(' ')})" if !$?.success?
     end
 
   end

data/lib/nanoc3/extra/validators/links.rb

@@ -7,17 +7,17 @@ module Nanoc3::Extra::Validators
   class Links
 
     # @param [String] dir The directory that will be searched for HTML files
-    # to validate
+    #   to validate
     #
     # @param [Array<String>] index_filenames An array of index filenames that
-    # will be appended to URLs by web servers if a directory is requested
-    # instead of a file
+    #   will be appended to URLs by web servers if a directory is requested
+    #   instead of a file
     #
     # @option params [Boolean] :internal (false) True if internal links should
-    # be checked; false if they should not
+    #   be checked; false if they should not
     #
     # @option params [Boolean] :external (false) True if external links should
-    # be checked; false if they should not
+    #   be checked; false if they should not
     def initialize(dir, index_filenames, params={})
       @dir              = dir
       @index_filenames  = index_filenames
@@ -48,36 +48,6 @@ module Nanoc3::Extra::Validators
 
   private
 
-    # Enumerates all key-value pairs of a given hash in a thread-safe way.
-    #
-    # This class is a helper class, which means that it is not used directly
-    # by nanoc. Future versions of nanoc may no longer contain this class. Do
-    # not depend on this class to be available.
-    class ThreadsafeHashEnumerator
-
-      # Creates a new enumerator for the given hash.
-      #
-      # @param [Hash] hash The hash for which the enumerator should return
-      #   key-value pairs
-      def initialize(hash)
-        @hash             = hash
-        @unprocessed_keys = @hash.keys.dup
-        @mutex            = Mutex.new
-      end
-
-      # Returns the next key-value pair in the hash.
-      #
-      # @return [Array] An array containing the key and the corresponding
-      #   value of teh next key-value pair
-      def next_pair
-        @mutex.synchronize do
-          key = @unprocessed_keys.shift
-          return (key ? [ key, @hash[key] ] : nil)
-        end
-      end
-
-    end
-
     def all_broken_hrefs
       broken_hrefs = {}
 
@@ -157,23 +127,17 @@ module Nanoc3::Extra::Validators
       require 'uri'
 
       # Parse
-      uri = nil
-      begin
-        uri = URI.parse(href)
-      rescue URI::InvalidURIError
-        @delegate && @delegate.send(:external_href_validated, href, false)
-        return false
-      end
+      uri = URI.parse(href)
 
       # Skip non-HTTP URLs
-      return true if uri.scheme !~ /^https?$/
+      return true if uri.scheme != 'http'
 
       # Get status
       status = fetch_http_status_for(uri)
-      is_valid = !!(status && status >= 200 && status <= 299)
+      is_valid = (status && status >= 200 && status <= 299)
 
       # Notify
-      @delegate && @delegate.send(:external_href_validated, href, is_valid)
+      @delegate.send(:external_href_validated, href, is_valid)
 
       # Done
       is_valid
@@ -189,10 +153,30 @@ module Nanoc3::Extra::Validators
       end
     end
 
+    # This class is a helper class, which means that it is not used directly
+    # by nanoc. Future versions of nanoc may no longer contain this class. Do
+    # not depend on this class to be available.
+    class EachPairEnumerator
+
+      def initialize(hash)
+        @hash             = hash
+        @unprocessed_keys = @hash.keys.dup
+        @mutex            = Mutex.new
+      end
+
+      def next_pair
+        @mutex.synchronize do
+          key = @unprocessed_keys.shift
+          return (key ? [ key, @hash[key] ] : nil)
+        end
+      end
+
+    end
+
     def validate_external_hrefs(hrefs, broken_hrefs)
       @mutex = Mutex.new
 
-      enum = ThreadsafeHashEnumerator.new(hrefs)
+      enum = EachPairEnumerator.new(hrefs)
 
       threads = []
       10.times do
@@ -218,10 +202,7 @@ module Nanoc3::Extra::Validators
     def fetch_http_status_for(url, params={})
       5.times do |i|
         begin
-          res = nil
-          Timeout::timeout(10) do
-            res = request_url_once(url)
-          end
+          res = request_url_once(url)
 
           if res.code =~ /^3..$/
             url = URI.parse(res['location'])
@@ -230,7 +211,7 @@ module Nanoc3::Extra::Validators
             return res.code.to_i
           end
         rescue
-          return nil
+          nil
         end
       end
     end

data/lib/nanoc3/extra/validators/w3c.rb

@@ -6,10 +6,10 @@ module Nanoc3::Extra::Validators
   class W3C
 
     # @param [String] dir The directory that will be searched for HTML and/or
-    # CSS files to validate
+    #   CSS files to validate
     #
     # @param [Array<Symbol>] types A list of types to check. Allowed types are
-    # `:html` and `:css`.
+    #   `:html` and `:css`.
     def initialize(dir, types)
       @dir   = dir
       @types = types

data/lib/nanoc3/extra/vcs.rb

@@ -8,7 +8,7 @@ module Nanoc3::Extra
   # the disk.
   #
   # @abstract Subclass and override {#add}, {#remove} and {#move} to implement
-  # a custom VCS.
+  #   a custom VCS.
   class VCS
 
     extend Nanoc3::PluginRegistry::PluginMethods

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'open3'
-
 module Nanoc3::Filters
   class ColorizeSyntax < Nanoc3::Filter
 
@@ -38,9 +36,6 @@ module Nanoc3::Filters
     #
     # @param [String] content The content to filter
     #
-    # @option params [Symbol] :syntax (:html) The syntax to use, which can be
-    #   `:html`, `:xml` or `:xhtml`, the latter two being the same.
-    #
     # @option params [Hash] :colorizers (DEFAULT_COLORIZER) A hash containing
     #   a mapping of programming languages (symbols, not strings) onto
     #   colorizers (symbols).
@@ -55,8 +50,19 @@ module Nanoc3::Filters
         @colorizers[language] = colorizer
       end
 
+      # Determine syntax (HTML or XML)
+      syntax = params[:syntax] || :html
+      case syntax
+      when :html
+        klass = Nokogiri::HTML
+      when :xml
+        klass = Nokogiri::XML
+      else
+        raise RuntimeError, "unknown syntax: #{syntax.inspect} (expected :html or :xml)"
+      end
+
       # Colorize
-      doc = Nokogiri::HTML.fragment(content)
+      doc = klass.fragment(content)
       doc.css('pre > code[class*="language-"]').each do |element|
         # Get language
         match = element['class'].match(/(^| )language-([^ ]+)/)
@@ -68,7 +74,7 @@ module Nanoc3::Filters
         element.inner_html = highlighted_code
       end
 
-      doc.to_html(:encoding => 'UTF-8')
+      doc.to_s
     end
 
   private
@@ -76,7 +82,7 @@ module Nanoc3::Filters
     KNOWN_COLORIZERS = [ :coderay, :dummy, :pygmentize ]
 
     def highlight(code, language, params={})
-      colorizer = @colorizers[language.to_sym]
+      colorizer = @colorizers[language]
       if KNOWN_COLORIZERS.include?(colorizer)
         send(colorizer, code, language, params[colorizer] || {})
       else
@@ -95,22 +101,12 @@ module Nanoc3::Filters
     end
 
     def pygmentize(code, language, params={})
-      check_availability('pygmentize --V')
-
       IO.popen("pygmentize -l #{language} -f html", "r+") do |io|
         io.write(code)
         io.close_write
-        highlighted_code = io.read
-
-        doc = Nokogiri::HTML.fragment(highlighted_code)
-        return doc.xpath('./div[@class="highlight"]/pre').inner_html
+        return io.read
       end
     end
 
-    def check_availability(cmd)
-      # Will raise on error
-      Open3.popen3('highlight --version') { |stdin, stdout, stderr| }
-    end
-
   end
 end

data/lib/nanoc3/filters/erb.rb

@@ -15,14 +15,10 @@ module Nanoc3::Filters
       # Create context
       context = ::Nanoc3::Context.new(assigns)
 
-      # Get binding
-      proc = assigns[:content] ? lambda { assigns[:content] } : nil
-      assigns_binding = context.get_binding(&proc)
-
       # Get result
       erb = ::ERB.new(content)
       erb.filename = filename
-      erb.result(assigns_binding)
+      erb.result(context.get_binding { assigns[:content] })
     end
 
   end

data/lib/nanoc3/filters/erubis.rb

@@ -15,12 +15,8 @@ module Nanoc3::Filters
       # Create context
       context = ::Nanoc3::Context.new(assigns)
 
-      # Get binding
-      proc = assigns[:content] ? lambda { assigns[:content] } : nil
-      assigns_binding = context.get_binding(&proc)
-
       # Get result
-      ::Erubis::Eruby.new(content, :filename => filename).result(assigns_binding)
+      ::Erubis::Eruby.new(content, :filename => filename).result(context.get_binding { assigns[:content] })
     end
 
   end

data/lib/nanoc3/filters/haml.rb

@@ -19,8 +19,7 @@ module Nanoc3::Filters
       context = ::Nanoc3::Context.new(assigns)
 
       # Get result
-      proc = assigns[:content] ? lambda { assigns[:content] } : nil
-      ::Haml::Engine.new(content, options).render(context, assigns, &proc)
+      ::Haml::Engine.new(content, options).render(context, assigns) { assigns[:content] }
     end
 
   end