nanoc 3.3.7 → 3.4.0

data/lib/nanoc/cli/stream_cleaners.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Nanoc::CLI
+
+  module StreamCleaners
+
+    autoload 'Abstract',   'nanoc/cli/stream_cleaners/abstract'
+    autoload 'ANSIColors', 'nanoc/cli/stream_cleaners/ansi_colors'
+    autoload 'UTF8',       'nanoc/cli/stream_cleaners/utf8'
+
+  end
+
+end
+

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

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Nanoc::CLI::StreamCleaners
+
+  # Superclass for all stream cleaners. Stream cleaners have a single method,
+  # {#clean}, that takes a string and returns a cleaned string. Stream cleaners
+  # can have state, so they can act as a FSM.
+  #
+  # @abstract Subclasses must implement {#clean}
+  class Abstract
+
+    # Returns a cleaned version of the given string.
+    #
+    # @param [String] s The string to clean
+    #
+    # @return [String] The cleaned string
+    def clean(s)
+      raise NotImplementedError, "Subclasses of Nanoc::CLI::StreamCleaners::Abstract must implement #clean"
+    end
+
+  end
+
+end

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

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Nanoc::CLI::StreamCleaners
+
+  # Removes ANSI color escape sequences.
+  class ANSIColors < Abstract
+
+    # @see Nanoc::CLI::StreamCleaners::Abstract#clean
+    def clean(s)
+      s.gsub(/\e\[.+?m/, '')
+    end
+
+  end
+
+end

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

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module Nanoc::CLI::StreamCleaners
+
+  # Simplifies output by replacing UTF-8 characters with their ASCII decompositions.
+  class UTF8 < Abstract
+
+    # @see Nanoc::CLI::StreamCleaners::Abstract#clean
+    def clean(s)
+      # FIXME this decomposition is not generally usable
+      s.gsub(/“|”/, '"').gsub(/‘|’/, '\'').gsub('…', '...').gsub('©', '(c)')
+    end
+
+  end
+
+end

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

@@ -39,8 +39,8 @@ module Nanoc::Extra::Deployers
       options = self.config[:options] || DEFAULT_OPTIONS
 
       # Validate
-      error 'No dst found in deployment configuration' if dst.nil?
-      error 'dst requires no trailing slash' if dst[-1,1] == '/'
+      raise 'No dst found in deployment configuration' if dst.nil?
+      raise 'dst requires no trailing slash' if dst[-1,1] == '/'
 
       # Run
       if dry_run
@@ -53,11 +53,6 @@ module Nanoc::Extra::Deployers
 
   private
 
-    # Prints the given message on stderr and exits.
-    def error(msg)
-      raise RuntimeError.new(msg)
-    end
-
     # Runs the given shell command. It will raise an error if execution fails 
     # (results in a nonzero exit code).
     def run_shell_cmd(args)

data/lib/nanoc/extra/pruner.rb

@@ -9,11 +9,11 @@ module Nanoc::Extra
     # @return [Nanoc::Site] The site this pruner belongs to  
     attr_reader :site
 
-    # @param [Nanoc::Site] The site for which a pruner is created
+    # @param [Nanoc::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
-    # should actually be deleted.
+    #   should only be printed instead of actually deleted, false if the files
+    #   should actually be deleted.
     def initialize(site, params={})
       @site    = site
       @dry_run = params.fetch(:dry_run) { false }

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

@@ -168,7 +168,7 @@ module Nanoc::Extra::Validators
 
       # Get status
       status = fetch_http_status_for(uri)
-      is_valid = !!(status && status >= 200 && status <= 299)
+      is_valid = !status.nil? && status == 200
 
       # Notify
       @delegate && @delegate.send(:external_href_validated, href, is_valid)
@@ -222,8 +222,19 @@ module Nanoc::Extra::Validators
           end
 
           if res.code =~ /^3..$/
-            url = URI.parse(res['location'])
             return nil if i == 5
+
+            # Find proper location
+            location = res['Location']
+            if location !~ /^https?:\/\//
+              base_url = url.dup
+              base_url.path = (location =~ /^\// ? '' : '/')
+              base_url.query = nil
+              base_url.fragment = nil
+              location = base_url.to_s + location
+            end
+
+            url = URI.parse(location)
           else
             return res.code.to_i
           end
@@ -238,7 +249,7 @@ module Nanoc::Extra::Validators
 
       path = (url.path.nil? || url.path.empty? ? '/' : url.path)
       req = Net::HTTP::Head.new(path)
-      http=Net::HTTP.new(url.host, url.port)
+      http = Net::HTTP.new(url.host, url.port)
       if url.instance_of? URI::HTTPS
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/lib/nanoc/filters.rb

@@ -10,11 +10,13 @@ module Nanoc::Filters
   autoload 'ERB',             'nanoc/filters/erb'
   autoload 'Erubis',          'nanoc/filters/erubis'
   autoload 'Haml',            'nanoc/filters/haml'
+  autoload 'Handlebars',      'nanoc/filters/handlebars'
   autoload 'Kramdown',        'nanoc/filters/kramdown'
   autoload 'Less',            'nanoc/filters/less'
   autoload 'Markaby',         'nanoc/filters/markaby'
   autoload 'Maruku',          'nanoc/filters/maruku'
   autoload 'Mustache',        'nanoc/filters/mustache'
+  autoload 'Pandoc',          'nanoc/filters/pandoc'
   autoload 'Rainpress',       'nanoc/filters/rainpress'
   autoload 'RDiscount',       'nanoc/filters/rdiscount'
   autoload 'RDoc',            'nanoc/filters/rdoc'
@@ -37,11 +39,13 @@ module Nanoc::Filters
   Nanoc::Filter.register '::Nanoc::Filters::ERB',             :erb
   Nanoc::Filter.register '::Nanoc::Filters::Erubis',          :erubis
   Nanoc::Filter.register '::Nanoc::Filters::Haml',            :haml
+  Nanoc::Filter.register '::Nanoc::Filters::Handlebars',      :handlebars
   Nanoc::Filter.register '::Nanoc::Filters::Kramdown',        :kramdown
   Nanoc::Filter.register '::Nanoc::Filters::Less',            :less
   Nanoc::Filter.register '::Nanoc::Filters::Markaby',         :markaby
   Nanoc::Filter.register '::Nanoc::Filters::Maruku',          :maruku
   Nanoc::Filter.register '::Nanoc::Filters::Mustache',        :mustache
+  Nanoc::Filter.register '::Nanoc::Filters::Pandoc',          :pandoc
   Nanoc::Filter.register '::Nanoc::Filters::Rainpress',       :rainpress
   Nanoc::Filter.register '::Nanoc::Filters::RDiscount',       :rdiscount
   Nanoc::Filter.register '::Nanoc::Filters::RDoc',            :rdoc

data/lib/nanoc/filters/handlebars.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'handlebars'
+
+module Nanoc::Filters
+
+  # @since 3.4.0
+  class Handlebars < Nanoc::Filter
+
+    # Runs the content through
+    # [Handlebars](http://handlebarsjs.com/) using
+	  # [Handlebars.rb](https://github.com/cowboyd/handlebars.rb).
+	  # This method takes no options.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      context = item.attributes.dup
+      context[:item]   = assigns[:item].attributes
+      context[:layout] = assigns[:layout].attributes
+      context[:config] = assigns[:config]
+      context[:yield]  = assigns[:content]
+
+      ::Handlebars.compile(content).call(context)
+    end
+
+  end
+
+end

data/lib/nanoc/filters/mustache.rb

@@ -15,8 +15,8 @@ module Nanoc::Filters
     #
     # @return [String] The filtered content
     def run(content, params={})
-      # Get result
-      ::Mustache.render(content, item.attributes)
+      context = item.attributes.merge({ :yield => assigns[:content] })
+      ::Mustache.render(content, context)
     end
 
   end

data/lib/nanoc/filters/pandoc.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'pandoc-ruby'
+
+module Nanoc::Filters
+  class Pandoc < Nanoc::Filter
+
+    # Runs the content through [Pandoc](http://johnmacfarlane.net/pandoc/)
+    # using [PandocRuby](https://github.com/alphabetum/pandoc-ruby). Options
+    # are passed on to PandocRuby.
+    #
+    # @param [String] content The content to filter
+    #
+    # @return [String] The filtered content
+    def run(content, params={})
+      PandocRuby.convert(content, params)
+    end
+
+  end
+end

data/lib/nanoc/helpers/filtering.rb

@@ -25,7 +25,7 @@ module Nanoc::Helpers
     # @param [Symbol] filter_name The name of the filter to run on the
     #   contents of the block
     #
-    # @param [Hash] argument Arguments to pass to the filter
+    # @param [Hash] arguments Arguments to pass to the filter
     #
     # @return [void]
     def filter(filter_name, arguments={}, &block)

data/lib/nanoc/tasks/validate.rake

@@ -2,91 +2,33 @@
 
 namespace :validate do
 
-  desc 'Validate the site’s HTML files'.make_compatible_with_env
+  desc 'Validate the site’s HTML files'
   task :html do
-    # Get output directory
-    site = Nanoc::Site.new('.')
-    if site.nil?
-      $stderr.puts 'The current working directory does not seem to be a ' +
-                   'valid/complete nanoc site directory; aborting.'
-      exit 1
-    end
-    dir = site.config[:output_dir]
-
-    # Validate
-    validator = ::Nanoc::Extra::Validators::W3C.new(dir, [ :html ])
-    validator.run
+    Nanoc::CLI.run %w( validate_html )
   end
 
-  desc 'Validate the site’s CSS files'.make_compatible_with_env
+  desc 'Validate the site’s CSS files'
   task :css do
-    # Get output directory
-    site = Nanoc::Site.new('.')
-    if site.nil?
-      $stderr.puts 'The current working directory does not seem to be a ' +
-                   'valid/complete nanoc site directory; aborting.'
-      exit 1
-    end
-    dir = site.config[:output_dir]
-
-    # Validate
-    validator = ::Nanoc::Extra::Validators::W3C.new(dir, [ :css ])
-    validator.run
+    Nanoc::CLI.run %w( validate_css )
   end
 
   namespace :links do
 
-    desc 'Validate the site’s internal links'.make_compatible_with_env
+    desc 'Validate the site’s internal links'
     task :internal do
-      # Get output directory
-      site = Nanoc::Site.new('.')
-      if site.nil?
-        $stderr.puts 'The current working directory does not seem to be a ' +
-                     'valid/complete nanoc site directory; aborting.'
-        exit 1
-      end
-      dir             = site.config[:output_dir]
-      index_filenames = site.config[:index_filenames]
-
-      # Validate
-      validator = ::Nanoc::Extra::Validators::Links.new(dir, index_filenames, :internal => true)
-      validator.run
+      Nanoc::CLI.run %w( validate_links --internal )
     end
 
-    desc 'Validate the site’s internal links'.make_compatible_with_env
+    desc 'Validate the site’s external links'
     task :external do
-      # Get output directory
-      site = Nanoc::Site.new('.')
-      if site.nil?
-        $stderr.puts 'The current working directory does not seem to be a ' +
-                     'valid/complete nanoc site directory; aborting.'
-        exit 1
-      end
-      dir             = site.config[:output_dir]
-      index_filenames = site.config[:index_filenames]
-
-      # Validate
-      validator = ::Nanoc::Extra::Validators::Links.new(dir, index_filenames, :external => true)
-      validator.run
+      Nanoc::CLI.run %w( validate_links --external )
     end
 
   end
 
-  desc 'Validate the site’s internal and external links'.make_compatible_with_env
+  desc 'Validate the site’s internal and external links'
   task :links do
-    # Get output directory
-    site = Nanoc::Site.new('.')
-    if site.nil?
-      $stderr.puts 'The current working directory does not seem to be a ' +
-                   'valid/complete nanoc site directory; aborting.'
-      exit 1
-    end
-    dir             = site.config[:output_dir]
-    index_filenames = site.config[:index_filenames]
-
-    # Validate
-    validator = ::Nanoc::Extra::Validators::Links.new(dir, index_filenames, :internal => true, :external => true)
-    validator.run
+    Nanoc::CLI.run %w( validate_links )
   end
 
 end

data/nanoc.gemspec

@@ -30,20 +30,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake')
   s.add_development_dependency('rdiscount')
   s.add_development_dependency('yard')
-
-  s.post_install_message = %q{------------------------------------------------------------------------------
-Thanks for installing nanoc 3.3! Here are some resources to help you get
-started:
-
-* The web site at <http://nanoc.stoneship.org/>
-* The tutorial at <http://nanoc.stoneship.org/docs/3-getting-started/>
-* The manual at <http://nanoc.stoneship.org/docs/4-basic-concepts/>
-
-If you have questions, issues or simply want to share ideas, join the
-discussion at <http://groups.google.com/group/nanoc> or stop by in the IRC
-channel on irc.freenode.net, channel #nanoc. See you there!
-
-Enjoy!
-------------------------------------------------------------------------------
-}
 end

data/test/cli/commands/test_create_site.rb

@@ -6,7 +6,7 @@ class Nanoc::CLI::Commands::CreateSiteTest < MiniTest::Unit::TestCase
 
   def test_create_site_with_existing_name
     Nanoc::CLI.run %w( create_site foo )
-    assert_raises(SystemExit) do
+    assert_raises(::Nanoc::Errors::GenericTrivial) do
       Nanoc::CLI.run %w( create_site foo )
     end
   end

data/test/cli/commands/test_deploy.rb

@@ -95,4 +95,49 @@ class Nanoc::CLI::Commands::DeployTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_deploy_without_target_without_default
+    if_have 'systemu' do
+      with_site do |site|
+        File.open('config.yaml', 'w') do |io|
+          io.write "deploy:\n"
+          io.write "  public:\n"
+          io.write "    dst: mydestination"
+        end
+
+        FileUtils.mkdir_p('output')
+        File.open('output/blah.html', 'w') { |io| io.write 'moo' }
+
+        ios = capturing_stdio do
+          assert_raises SystemExit do
+            Nanoc::CLI.run %w( deploy )
+          end
+        end
+
+        assert ios[:stderr].include?('The site configuration has no deploy configuration for default.')
+      end
+    end
+  end
+
+  def test_deploy_without_target_without_default
+    if_have 'systemu' do
+      with_site do |site|
+        File.open('config.yaml', 'w') do |io|
+          io.write "deploy:\n"
+          io.write "  default:\n"
+          io.write "    dst: mydestination"
+        end
+
+        FileUtils.mkdir_p('output')
+        File.open('output/blah.html', 'w') { |io| io.write 'moo' }
+
+        ios = capturing_stdio do
+          Nanoc::CLI.run %w( deploy )
+        end
+
+        assert File.directory?('mydestination')
+        assert File.file?('mydestination/blah.html')
+      end
+    end
+  end
+
 end

data/test/cli/test_cli.rb

@@ -99,7 +99,7 @@ EOS
 
       # Check error output
       stderr_addition = $stderr.string[position_before, position_after]
-      assert_match(/=== BACKTRACE:/, stderr_addition)
+      assert_match(/Stack trace:/, stderr_addition)
       assert_match(/commands\/_test.rb/, stderr_addition)
     end
   end