nanoc 3.5.0 → 3.6.0

data/lib/nanoc/cli/cleaning_stream.rb

@@ -99,6 +99,16 @@ module Nanoc::CLI
       @stream.exists?
     end
 
+    # @see IO.winsize
+    def winsize
+      @stream.winsize
+    end
+
+    # @see IO.winsize=
+    def winsize=(arg)
+      @stream.winsize=(arg)
+    end
+
   protected
 
     def clean(s)

data/lib/nanoc/cli/command_runner.rb

@@ -22,7 +22,7 @@ module Nanoc::CLI
     def site
       # Load site if possible
       @site ||= nil
-      if File.file?('config.yaml') && @site.nil?
+      if self.is_in_site_dir? && @site.nil?
         @site = Nanoc::Site.new('.')
       end
 
@@ -36,13 +36,10 @@ module Nanoc::CLI
       self.new(opts, args, cmd).call
     end
 
-  protected
-
-    # @return [Boolean] true if debug output is enabled, false if not
-    #
-    # @see Nanoc::CLI.debug?
-    def debug?
-      Nanoc::CLI.debug?
+    # @return [Boolean] true if the current working directory is a nanoc site
+    #   directory, false otherwise
+    def is_in_site_dir?
+      Nanoc::Site.cwd_is_nanoc_site?
     end
 
     # Asserts that the current working directory contains a site
@@ -51,15 +48,31 @@ module Nanoc::CLI
     #
     # @return [void]
     def require_site
-      print "Loading site data… "
       if site.nil?
-        puts "error"
         raise ::Nanoc::Errors::GenericTrivial, "The current working directory does not seem to be a nanoc site."
-      else
-        puts "done"
       end
     end
 
+    # Asserts that the current workign directory contains a site (just like
+    # {#require_site}) and loads the site into memory.
+    #
+    # @return [void]
+    def load_site
+      self.require_site
+      print "Loading site data… "
+      self.site.load
+      puts "done"
+    end
+
+  protected
+
+    # @return [Boolean] true if debug output is enabled, false if not
+    #
+    # @see Nanoc::CLI.debug?
+    def debug?
+      Nanoc::CLI.debug?
+    end
+
     # Sets the data source's VCS to the VCS with the given name. Does nothing
     # when the site's data source does not support VCSes (i.e. does not
     # implement #vcs=).

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

@@ -8,12 +8,13 @@ Start the autocompiler web server. Unless overridden with commandline options
 or configuration entries, the web server will run on port 3000 and listen on all
 IP addresses. Running the autocompiler requires the `mime/types` and `rack` gems.
 
-To specify the host and/or port options in config.yaml, you can add either (or
-both) of the following:
+To specify the host, port, and/or handler options in config.yaml, you can add
+any of the following:
 
     autocompile:
       host: '10.0.2.0'  # override the default host
       port: 4000        # override the default port
+      handler: thin     # override the default handler
 
 EOS
 
@@ -39,7 +40,8 @@ module Nanoc::CLI::Commands
       }
 
       # Guess which handler we should use
-      unless handler = Rack::Handler.get(options[:handler])
+      handler_option = options[:handler] || autocompile_config[:handler]
+      unless handler = Rack::Handler.get(handler_option)
         begin
           handler = Rack::Handler::Mongrel
         rescue LoadError => e

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

@@ -19,15 +19,23 @@ module Nanoc::CLI::Commands
       self.require_site
 
       runner = Nanoc::Extra::Checking::Runner.new(site)
+
       if options[:list]
         runner.list_checks
-      elsif options[:all]
+        return
+      end
+
+      success = if options[:all]
         runner.run_all
       elsif options[:deploy]
         runner.run_for_deploy
       else
         runner.run_specific(arguments)
       end
+
+      unless success
+        raise Nanoc::Errors::GenericTrivial, 'One or more checks failed'
+      end
     end
 
   protected

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

@@ -316,7 +316,7 @@ module Nanoc::CLI::Commands
     end
 
     def run
-      self.require_site
+      self.load_site
       self.check_for_deprecated_usage
       self.setup_listeners
 

data/lib/nanoc/cli/commands/create-site.rb

@@ -285,14 +285,14 @@ EOS
     <div id="sidebar">
       <h2>Documentation</h2>
       <ul>
-        <li><a href="http://nanoc.stoneship.org/docs/">Documentation</a></li>
-        <li><a href="http://nanoc.stoneship.org/docs/3-getting-started/">Getting Started</a></li>
+        <li><a href="http://nanoc.ws/docs/">Documentation</a></li>
+        <li><a href="http://nanoc.ws/docs/tutorial/">Getting Started</a></li>
       </ul>
       <h2>Community</h2>
       <ul>
         <li><a href="http://groups.google.com/group/nanoc/">Discussion Group</a></li>
         <li><a href="irc://chat.freenode.net/#nanoc">IRC Channel</a></li>
-        <li><a href="http://projects.stoneship.org/trac/nanoc/">Wiki</a></li>
+        <li><a href="http://github.com/nanoc/nanoc/wiki/">Wiki</a></li>
       </ul>
     </div>
   </body>
@@ -344,8 +344,8 @@ EOS
       FileUtils.mkdir_p('output')
 
       # Create config
-      File.open('config.yaml', 'w') { |io| io.write(DEFAULT_CONFIG) }
-      Nanoc::NotificationCenter.post(:file_created, 'config.yaml')
+      File.open('nanoc.yaml', 'w') { |io| io.write(DEFAULT_CONFIG) }
+      Nanoc::NotificationCenter.post(:file_created, 'nanoc.yaml')
 
       # Create rules
       File.open('Rules', 'w') do |io|

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

@@ -19,7 +19,7 @@ module Nanoc::CLI::Commands
   class Prune < ::Nanoc::CLI::CommandRunner
 
     def run
-      require_site
+      self.load_site
 
       if options.has_key?(:yes)
         Nanoc::Extra::Pruner.new(self.site, :exclude => self.prune_config_exclude).run

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

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+usage       'shell'
+summary     'open a shell on the nanoc environment'
+aliases     'console'
+description <<-EOS
+Open an IRB shell on a context that contains @items, @layouts, @config and @site.
+EOS
+
+module Nanoc::CLI::Commands
+
+  class Shell < ::Nanoc::CLI::CommandRunner
+
+    def run
+      require 'pry'
+
+      self.require_site
+
+      Nanoc::Context.new(env).pry
+    end
+
+  protected
+
+    def env
+      {
+        :site    => self.site,
+        :items   => self.site.items,
+        :layouts => self.site.layouts,
+        :config  => self.site.config
+      }
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Shell

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

@@ -13,7 +13,7 @@ module Nanoc::CLI::Commands
   class ShowData < ::Nanoc::CLI::CommandRunner
 
     def run
-      self.require_site
+      self.load_site
 
       # Get data
       items     = self.site.items

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

@@ -0,0 +1,34 @@
+usage   'sync'
+summary 'sync data sources'
+description <<-EOS
+Sync data source data. This command is useful for updating local item caches
+for data sources which rely on slow external APIs.
+EOS
+
+module Nanoc::CLI::Commands
+
+  class Sync < ::Nanoc::CLI::CommandRunner
+
+    def run
+      # Check arguments
+      if arguments.size != 0
+        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
+      end
+
+      # Make sure we are in a nanoc site directory
+      self.require_site
+
+      # Update all syncable data sources
+      self.site.data_sources.each do |data_source|
+        unless data_source.method(:sync).owner == Nanoc::DataSource
+          puts "Syncing #{data_source.config[:type]} data source: #{data_source.items_root}"
+          data_source.sync
+        end
+      end
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Sync

data/lib/nanoc/cli/error_handler.rb

@@ -208,6 +208,7 @@ module Nanoc::CLI
       'maruku'         => 'maruku',
       'mime/types'     => 'mime-types',
       'nokogiri'       => 'nokogiri',
+      'pry'            => 'pry',
       'rack'           => 'rack',
       'rack/cache'     => 'rack-cache',
       'rainpress'      => 'rainpress',
@@ -236,7 +237,11 @@ module Nanoc::CLI
 
         # Build message
         if gem_name
-          "Try installing the '#{gem_name}' gem (`gem install #{gem_name}`) and then re-running the command."
+          if self.using_bundler?
+            "Make sure the gem is added to Gemfile and run `bundle up`."
+          else
+            "Install the '#{gem_name}' gem using `gem install #{gem_name}`."
+          end
         end
       when RuntimeError
         if error.message =~ /^can't modify frozen/
@@ -249,6 +254,10 @@ module Nanoc::CLI
       end
     end
 
+    def using_bundler?
+      defined?(Bundler) && Bundler::SharedHelpers.in_bundle?
+    end
+
     def write_section_header(stream, title, params={})
       stream.puts
       if params[:verbose]
@@ -298,7 +307,7 @@ module Nanoc::CLI
     def write_issue_link(stream, params={})
       stream.puts
       stream.puts "If you believe this is a bug in nanoc, please do report it at"
-      stream.puts "-> https://github.com/ddfreyne/nanoc/issues/new <-"
+      stream.puts "-> https://github.com/nanoc/nanoc/issues/new <-"
       stream.puts
       stream.puts "A detailed crash log has been written to ./crash.log."
     end

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

@@ -6,8 +6,11 @@ module Nanoc::Extra::Checking::Checks
 
     def run
       require 'set'
+
       item_rep_paths = Set.new(@site.items.collect { |i| i.reps }.flatten.collect { |r| r.raw_path })
+
       self.output_filenames.each do |f|
+        next if self.pruner.filename_excluded?(f)
         if !item_rep_paths.include?(f)
           self.add_issue(
             "file without matching item",
@@ -16,8 +19,13 @@ module Nanoc::Extra::Checking::Checks
       end
     end
 
-  end
+    protected
 
-end
+    def pruner
+      exclude_config = @site.config.fetch(:prune, {}).fetch(:exclude, [])
+      @pruner ||= Nanoc::Extra::Pruner.new(@site, :exclude => exclude_config)
+    end
 
+  end
 
+end

data/lib/nanoc/extra/pruner.rb

@@ -6,7 +6,7 @@ module Nanoc::Extra
   # that are not managed by nanoc.
   class Pruner
 
-    # @return [Nanoc::Site] The site this pruner belongs to  
+    # @return [Nanoc::Site] The site this pruner belongs to
     attr_reader :site
 
     # @param [Nanoc::Site] site The site for which a pruner is created
@@ -34,12 +34,12 @@ module Nanoc::Extra
       end.flatten.compact.select { |f| File.file?(f) }
 
       # Get present files and dirs
-      present_files_and_dirs = Set.new
+      present_files = []
+      present_dirs = []
       Find.find(self.site.config[:output_dir] + '/') do |f|
-        present_files_and_dirs << f
+        present_files << f if File.file?(f)
+        present_dirs  << f if File.directory?(f)
       end
-      present_files = present_files_and_dirs.select { |f| File.file?(f) }
-      present_dirs  = present_files_and_dirs.select { |f| File.directory?(f) }
 
       # Remove stray files
       stray_files = (present_files - compiled_files)
@@ -49,20 +49,23 @@ module Nanoc::Extra
       end
 
       # Remove empty directories
-      present_dirs.each do |dir|
+      present_dirs.reverse_each do |dir|
         next if Dir.foreach(dir) { |n| break true if n !~ /\A\.\.?\z/ }
         next if filename_excluded?(dir)
         self.delete_dir(dir)
       end
     end
 
-  protected
-
-    def filename_excluded?(f)
-      pathname = Pathname.new(f)
-      @exclude.any? { |e| pathname.include_component?(e) } 
+    # @param [String] filename The filename to check
+    #
+    # @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) }
     end
 
+  protected
+
     def delete_file(file)
       if @dry_run
         puts file

data/lib/nanoc/filters/asciidoc.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 
-require 'systemu'
-
 module Nanoc::Filters
 
   # @since 3.2.0
   class AsciiDoc < Nanoc::Filter
 
+    requires 'systemu'
+
     # Runs the content through [AsciiDoc](http://www.methods.co.nz/asciidoc/).
     # This method takes no options.
     #

data/lib/nanoc/filters/bluecloth.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
-require 'bluecloth'
-
 module Nanoc::Filters
   class BlueCloth < Nanoc::Filter
 
+    requires 'bluecloth'
+
     # Runs the content through [BlueCloth](http://deveiate.org/projects/BlueCloth).
     # This method takes no options.
     #

data/lib/nanoc/filters/coderay.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
-require 'coderay'
-
 module Nanoc::Filters
   class CodeRay < Nanoc::Filter
 
+    requires 'coderay'
+
     # @deprecated Use the `:colorize_syntax` filter instead.
     def run(content, params={})
       # Warn

data/lib/nanoc/filters/coffeescript.rb

@@ -1,10 +1,10 @@
-require 'coffee-script'
-
 module Nanoc::Filters
 
   # @since 3.3.0
   class CoffeeScript < Nanoc::Filter
 
+    require 'coffee-script'
+
     # Runs the content through [CoffeeScript](http://coffeescript.org/).
     # This method takes no options.
     #

data/lib/nanoc/filters/colorize_syntax.rb

@@ -1,12 +1,10 @@
 # encoding: utf-8
 
-require 'nokogiri'
-require 'stringio'
-require 'open3'
-
 module Nanoc::Filters
   class ColorizeSyntax < Nanoc::Filter
 
+    requires 'nokogiri', 'stringio', 'open3'
+
     # The default colorizer to use for a language if the colorizer for that
     # language is not overridden.
     DEFAULT_COLORIZER = :coderay