nanoc 3.3.7 → 3.4.0

data/lib/nanoc/cli/ansi_string_colorizer.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Nanoc::CLI
+
+  # A simple ANSI colorizer for strings. When given a string and a list of
+  # attributes, it returns a colorized string.
+  module ANSIStringColorizer
+
+    # TODO complete mapping
+    MAPPING = {
+      :bold   => "\e[1m",
+      :red    => "\e[31m",
+      :green  => "\e[32m",
+      :yellow => "\e[33m",
+      :blue   => "\e[34m"
+    }
+
+    # @param [String] s The string to colorize
+    #
+    # @param [Array] as An array of attributes from `MAPPING` to colorize the
+    #   string with
+    #
+    # @return [String] A string colorized using the given attributes
+    def self.c(s, *as)
+      as.map { |a| MAPPING[a] }.join('') + s + "\e[0m"
+    end
+
+  end
+
+end

data/lib/nanoc/cli/cleaning_stream.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+module Nanoc::CLI
+
+  # An output stream that passes output through stream cleaners. This can be
+  # used to strip ANSI color sequences, for instance.
+  class CleaningStream
+
+    # @param [IO, StringIO] stream The stream to wrap
+    def initialize(stream)
+      @stream = stream
+      @stream_cleaners = []
+    end
+
+    # Adds a stream cleaner for the given class to this cleaning stream. If the
+    # cleaning stream already has the given stream cleaner, nothing happens.
+    #
+    # @param [Nanoc::CLI::StreamCleaners::Abstract] klass The class of the
+    #   stream cleaner to add
+    #
+    # @return [void]
+    def add_stream_cleaner(klass)
+      unless @stream_cleaners.map { |c| c.class }.include?(klass)
+        @stream_cleaners << klass.new
+      end
+    end
+
+    # Removes the stream cleaner for the given class from this cleaning stream.
+    # If the cleaning stream does not have the given stream cleaner, nothing
+    # happens.
+    #
+    # @param [Nanoc::CLI::StreamCleaners::Abstract] klass The class of the
+    #   stream cleaner to add
+    #
+    # @return [void]
+    def remove_stream_cleaner(klass)
+      @stream_cleaners.delete_if { |c| c.class == klass }
+    end
+
+    # @group IO proxy methods
+
+    # @see IO#write
+    def write(s)
+      @stream.write(self.clean(s))
+    end
+
+    # @see IO#<<
+    def <<(s)
+      @stream.<<(self.clean(s))
+    end
+
+    # @see IO#tty?
+    def tty?
+      @stream.tty?
+    end
+
+    # @see IO#flush
+    def flush
+      @stream.flush
+    end
+
+    # @see IO#tell
+    def tell
+      @stream.tell
+    end
+
+    # @see IO#print
+    def print(s)
+      @stream.print(self.clean(s))
+    end
+
+    # @see IO#puts
+    def puts(*s)
+      @stream.puts(*s.map { |ss| self.clean(ss) })
+    end
+
+    # @see StringIO#string
+    def string
+      @stream.string
+    end
+
+  protected
+
+    def clean(s)
+      @stream_cleaners.inject(s) { |m,c| c.clean(m) }
+    end
+
+  end
+
+end
+

data/lib/nanoc/cli/command_runner.rb

@@ -23,12 +23,7 @@ module Nanoc::CLI
       # Load site if possible
       @site ||= nil
       if File.file?('config.yaml') && @site.nil?
-        begin
-          @site = Nanoc::Site.new('.')
-        rescue Nanoc::Errors::UnknownDataSource => e
-          $stderr.puts "Unknown data source: #{e}"
-          exit 1
-        end
+        @site = Nanoc::Site.new('.')
       end
 
       @site
@@ -57,9 +52,7 @@ module Nanoc::CLI
     # @return [void]
     def require_site
       if site.nil?
-        $stderr.puts 'The current working directory does not seem to be a ' +
-                     'valid/complete nanoc site directory; aborting.'
-        exit 1
+        raise ::Nanoc::Errors::GenericTrivial, "The current working directory does not seem to be a nanoc site."
       end
     end
 
@@ -77,8 +70,7 @@ module Nanoc::CLI
       # Find VCS
       vcs_class = Nanoc::Extra::VCS.named(vcs_name.to_sym)
       if vcs_class.nil?
-        $stderr.puts "A VCS named #{vcs_name} was not found; aborting."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "A VCS named #{vcs_name} was not found"
       end
 
       site.data_sources.each do |data_source|

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

@@ -37,7 +37,7 @@ module Nanoc::CLI::Commands
       # 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.'.make_compatible_with_env
+        $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
 
@@ -221,7 +221,7 @@ module Nanoc::CLI::Commands
         delay = 1.0
         step  = 0
 
-        text = "Running #{filter_name} filter… ".make_compatible_with_env
+        text = "Running #{filter_name} filter… "
 
         while !Thread.current[:stopped]
           sleep 0.1

data/lib/nanoc/cli/commands/{create_item.rb → create-item.rb}

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-usage       'create_item [options] identifier'
+usage       'create-item [options] identifier'
+aliases     :create_item, :ci
 summary     'create an item'
-aliases     :ci
 description <<-EOS
 Create a new item in the current site. The first data source in the site
 configuration will be used.
@@ -17,8 +17,7 @@ module Nanoc::CLI::Commands
     def run
       # Check arguments
       if arguments.length != 1
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Extract arguments and options
@@ -32,9 +31,9 @@ module Nanoc::CLI::Commands
 
       # Check whether item is unique
       if !self.site.items.find { |i| i.identifier == identifier }.nil?
-        $stderr.puts "An item already exists at #{identifier}. Please " +
-                     "pick a unique name for the item you are creating."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial,
+          "An item already exists at #{identifier}. Please " +
+          "pick a unique name for the item you are creating."
       end
 
       # Setup notifications

data/lib/nanoc/cli/commands/{create_layout.rb → create-layout.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'create_layout [options] identifier'
-aliases     'cl'
+usage       'create-layout [options] identifier'
+aliases     :create_layout, :cl
 summary     'create a layout'
 description <<-EOS
 Create a new layout in the current site. The first data source in the site
@@ -15,8 +15,7 @@ module Nanoc::CLI::Commands
     def run
       # Check arguments
       if arguments.length != 1
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Extract arguments
@@ -30,16 +29,16 @@ module Nanoc::CLI::Commands
 
       # Check whether layout is unique
       if !self.site.layouts.find { |l| l.identifier == identifier }.nil?
-        $stderr.puts "A layout already exists at #{identifier}. Please " +
-                     "pick a unique name for the layout you are creating."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial,
+          "A layout already exists at #{identifier}. Please " +
+          "pick a unique name for the layout you are creating."
       end
 
       # Check whether layout is not at /
       if identifier == '/'
-        $stderr.puts "There cannot be a layout with the identifier '/'; " +
-                     "please pick a different identifier for this layout."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial,
+          "There cannot be a layout with the identifier '/'; " +
+          "please pick a different identifier for this layout."
       end
 
       # Setup notifications

data/lib/nanoc/cli/commands/{create_site.rb → create-site.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-usage       'create_site [options] path'
-aliases     'cs'
+usage       'create-site [options] path'
+aliases     :create_site, :cs
 summary     'create a site'
 description <<-EOS
 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 commandline option.
@@ -274,7 +274,9 @@ EOS
     <meta charset="utf-8">
     <title>A Brand New nanoc Site - <%= @item[:title] %></title>
     <link rel="stylesheet" type="text/css" href="/style.css" media="screen">
-    <meta name="generator" content="nanoc #{Nanoc::VERSION}">
+
+    <!-- you don't need to keep this, but it's cool for stats! -->
+    <meta name="generator" content="nanoc <%= Nanoc::VERSION %>"> 
   </head>
   <body>
     <div id="main">
@@ -300,8 +302,7 @@ EOS
     def run
       # Check arguments
       if arguments.length != 1
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Extract arguments and options
@@ -310,14 +311,12 @@ EOS
 
       # Check whether site exists
       if File.exist?(path)
-        $stderr.puts "A site at '#{path}' already exists."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "A site at '#{path}' already exists."
       end
 
       # Check whether data source exists
       if Nanoc::DataSource.named(data_source).nil?
-        $stderr.puts "Unrecognised data source: #{data_source}"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "Unrecognised data source: #{data_source}"
       end
 
       # Setup notifications
@@ -345,12 +344,12 @@ EOS
       FileUtils.mkdir_p('output')
 
       # Create config
-      File.open('config.yaml', 'w') { |io| io.write(DEFAULT_CONFIG.make_compatible_with_env) }
+      File.open('config.yaml', 'w') { |io| io.write(DEFAULT_CONFIG) }
       Nanoc::NotificationCenter.post(:file_created, 'config.yaml')
 
       # Create rules
       File.open('Rules', 'w') do |io|
-        io.write DEFAULT_RULES.make_compatible_with_env
+        io.write DEFAULT_RULES
       end
       Nanoc::NotificationCenter.post(:file_created, 'Rules')
     end
@@ -376,14 +375,14 @@ EOS
 
       # Create home page
       data_source.create_item(
-        DEFAULT_ITEM.make_compatible_with_env,
+        DEFAULT_ITEM,
         { :title => "Home" },
         '/'
       )
 
       # Create stylesheet
       data_source.create_item(
-        DEFAULT_STYLESHEET.make_compatible_with_env,
+        DEFAULT_STYLESHEET,
         {},
         '/stylesheet/',
         :extension => '.css'
@@ -391,7 +390,7 @@ EOS
 
       # Create layout
       data_source.create_layout(
-        DEFAULT_LAYOUT.make_compatible_with_env,
+        DEFAULT_LAYOUT,
         {},
         '/default/'
       )

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

@@ -28,8 +28,7 @@ module Nanoc::CLI::Commands
 
       # Get config
       deploy_configs = site.config.fetch(:deploy) do
-        $stderr.puts "The site configuration has no deploy configuration."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "The site configuration has no deploy configuration."
       end
 
       # List
@@ -42,14 +41,9 @@ module Nanoc::CLI::Commands
       end
 
       # Get target
-      target = options.fetch(:target) do
-        $stderr.puts "The deploy command requires a --target option."
-        exit 1
-      end
-      target = target.to_sym
+      target = options.fetch(:target, :default).to_sym
       config = deploy_configs.fetch(target) do
-        $stderr.puts "The site configuration has no deploy configuration for #{target}."
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "The site configuration has no deploy configuration for #{target}."
       end
 
       # Get deployer
@@ -60,9 +54,7 @@ module Nanoc::CLI::Commands
       end
       deployer_class = Nanoc::Extra::Deployer.named(name)
       if deployer_class.nil?
-        $stderr.puts "The specified deploy target has an unrecognised kind (#{name})."
-        $stderr.puts "(expected one of #{names.join(', ')})"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "The specified deploy target has an unrecognised kind “#{name}” (expected one of #{names.join(', ')})."
       end
 
       # Run

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

@@ -4,7 +4,8 @@ usage   'nanoc command [options] [arguments]'
 summary 'nanoc, a static site compiler written in Ruby'
 
 opt :l, :color, 'enable color' do
-  Nanoc::CLI::Logger.instance.color = true
+  $stdout.remove_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+  $stderr.remove_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
 end
 
 opt :d, :debug, 'enable debugging' do
@@ -17,7 +18,8 @@ opt :h, :help, 'show the help message and quit' do |value, cmd|
 end
 
 opt :C, :'no-color', 'disable color' do
-  Nanoc::CLI::Logger.instance.color = false
+  $stdout.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+  $stderr.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
 end
 
 opt :V, :verbose, 'make nanoc output more detailed' do

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 usage       'prune'
-summary     'removes files not managed by nanoc from the output directory'
+summary     'remove files not managed by nanoc from the output directory'
 description <<-EOS
 Find all files in the output directory that do not correspond to an item
 managed by nanoc and remove them. Since this is a hazardous operation, an

data/lib/nanoc/cli/commands/{debug.rb → show-data.rb}

@@ -1,15 +1,16 @@
 # encoding: utf-8
 
-usage       'debug'
-summary     'show debug information for this site'
+usage       'show-data'
+aliases     :debug
+summary     'show data in this site'
 description <<-EOS
 Show information about all items, item representations and layouts in the
-current site.
+current site, along with dependency information.
 EOS
 
 module Nanoc::CLI::Commands
 
-  class Debug < ::Nanoc::CLI::CommandRunner
+  class ShowData < ::Nanoc::CLI::CommandRunner
 
     def run
       # Make sure we are in a nanoc site directory
@@ -114,4 +115,4 @@ module Nanoc::CLI::Commands
 
 end
 
-runner Nanoc::CLI::Commands::Debug
+runner Nanoc::CLI::Commands::ShowData

data/lib/nanoc/cli/commands/{info.rb → show-plugins.rb}

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
-summary     'show info about available plugins'
-usage       'info [options]'
+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.
 If the current directory contains a nanoc web site, the plugins defined in this site will be shown as well.
@@ -9,13 +10,12 @@ EOS
 
 module Nanoc::CLI::Commands
 
-  class Info < ::Nanoc::CLI::CommandRunner
+  class ShowPlugins < ::Nanoc::CLI::CommandRunner
 
     def run
       # Check arguments
       if arguments.size != 0
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
+        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
       end
 
       # Get list of plugins (before and after)
@@ -95,4 +95,4 @@ module Nanoc::CLI::Commands
 
 end
 
-runner Nanoc::CLI::Commands::Info
+runner Nanoc::CLI::Commands::ShowPlugins