nanoc 3.6.1 → 3.6.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzAwNTU0YThiMWVmNzIyNDQyY2VkMDVmNTAxY2U3NGI3NDFlODE4Yg==
+  data.tar.gz: !binary |-
+    ODNmZjI4ZjM2YzBhMGVhMTMyYWViMDM3OGI4NGQ5ZTI2ZjUwNzNmMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YmRkMzY0ZGE4YzY5ZmU2ODdhMTZmYTFiNjQ2MTQ2MWI3MzQ4MGNiOTZkZDhh
+    OTIzYTRiYWIwMjYzNTE3NmI0MzFiYzdlNmRlZTljOWMyNWE2NjQ4ZDA2YzNh
+    NWExYzkzNDcwNTk1OTM2YmU0ZTQ2NDY0OWU5YmE0NmUwNGM2NGU=
+  data.tar.gz: !binary |-
+    ZTRiYTAzYTA2OWZjZjNkYTlmMTY4ZGQxZmM2NzNlMGVmYWU3N2M3MGUxZDE5
+    YmNkYmUyMDE4MmY4NWU1MmJhYWU3MTUyOWM2MzJhMmNjMjNlYTlmOGNiNGU3
+    YjBmOGUxZDg5YjkyYzNmYjQxNTA1YmIwYmNmMWIwMmJiNGFkZjA=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (3.6.1)
+    nanoc (3.6.2)
       cri (~> 2.3)
 
 GEM
@@ -75,7 +75,7 @@ GEM
     rack (1.5.2)
     rainpress (1.0)
     rake (10.0.3)
-    rdiscount (2.0.7)
+    rdiscount (2.0.7.1)
     rdoc (4.0.0)
       json (~> 1.4)
     redcarpet (2.2.2)
@@ -90,7 +90,7 @@ GEM
     syntax (1.0.0)
     systemu (2.5.2)
     temple (0.5.5)
-    therubyracer (0.11.3)
+    therubyracer (0.11.4)
       libv8 (~> 3.11.8.12)
       ref
     tilt (1.3.3)
@@ -103,7 +103,7 @@ GEM
       json
       nokogiri
     yajl-ruby (1.1.0)
-    yard (0.8.5)
+    yard (0.8.5.2)
     yuicompressor (1.2.0)
 
 PLATFORMS

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2012 Denis Defreyne and contributors
+Copyright (c) 2007-2013 Denis Defreyne and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -1,5 +1,22 @@
 # nanoc news
 
+## 3.6.2 (2013-03-23)
+
+Fixes:
+
+* Removed the list of available deployers from the `deploy` help text and moved
+  them into a new `--list-deployers` option [Damien Pollet]
+* Fixed warning about `__send__ `and `object_id` being redefined on Ruby
+  1.8.x [Justin Hileman]
+
+Enhancements:
+
+* Added possible alternative names for the `Checks` file for consistency with
+  the `Rules` file: `Checks.rb`, `checks`, `checks.rb` [Damien Pollet]
+* Made sure unchanged files never have their mtime updated [Justin Hileman]
+* Made link checker retry 405 Method Not Allowed results with GET instead of
+  HEAD [Daniel Hofstetter]
+
 ## 3.6.1 (2013-02-25)
 
 Fixes:

data/lib/nanoc.rb

@@ -3,7 +3,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '3.6.1'
+  VERSION = '3.6.2'
 
   # @return [String] A string containing information about this nanoc version
   #   and its environment (Ruby engine and version, Rubygems version if any).

data/lib/nanoc/base/result_data/item_rep.rb

@@ -133,25 +133,33 @@ module Nanoc
         Nanoc::NotificationCenter.post(:will_write_rep, self, snapshot)
 
         if self.binary?
-          # Check whether content was modified
-          is_modified = !File.file?(raw_path) || !FileUtils.identical?(raw_path, temporary_filenames[:last])
-
-          # Always copy (time spent checking modification is not useful)
-          FileUtils.cp(temporary_filenames[:last], raw_path)
+          temp_path = temporary_filenames[:last]
         else
-          # Check whether content was modified
-          is_modified = (!File.file?(raw_path) || File.read(raw_path) != @content[:last])
-
-          # Write
-          if is_modified
-            File.open(raw_path, 'w') { |io| io.write(@content[:last]) }
-          end
+          temp_path = self.temp_filename
+          File.open(temp_path, 'w') { |io| io.write(@content[:last]) }
         end
 
+        # Check whether content was modified
+        is_modified = is_created || !FileUtils.identical?(raw_path, temp_path)
+
+        # Write
+        FileUtils.cp(temp_path, raw_path) if is_modified
+
         # Notify
         Nanoc::NotificationCenter.post(:rep_written, self, raw_path, is_created, is_modified)
       end
 
+      TMP_TEXT_ITEMS_DIR = 'tmp/text_items'
+
+      def temp_filename
+        FileUtils.mkdir_p(TMP_TEXT_ITEMS_DIR)
+        tempfile = Tempfile.new('', TMP_TEXT_ITEMS_DIR)
+        new_filename = tempfile.path
+        tempfile.close!
+
+        File.expand_path(new_filename)
+      end
+
       # Resets the compilation progress for this item representation. This is
       # necessary when an unmet dependency is detected during compilation.
       #

data/lib/nanoc/base/source_data/item_array.rb

@@ -18,7 +18,7 @@ module Nanoc
       :instance_eval, :instance_exec, :__send__, :__id__
     ]
 
-    DELEGATED_METHODS = Array.instance_methods + Enumerable.instance_methods - EXCLUDED_METHODS
+    DELEGATED_METHODS = (Array.instance_methods + Enumerable.instance_methods).map { |m| m.to_sym } - EXCLUDED_METHODS
     def_delegators :@items, *DELEGATED_METHODS
 
     def initialize

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

@@ -3,7 +3,7 @@
 usage       'check [options] [names]'
 summary     'run issue checks'
 description <<-EOS
-Run issue checks on the current site. If the `--all` option is passed, all available issue checks will be run. If the `--deploy` option is passed, the issue checks marked for deployment will be fun.
+Run issue checks on the current site. If the `--all` option is passed, all available issue checks will be run. If the `--deploy` option is passed, the issue checks marked for deployment will be run.
 EOS
 
 flag :a, :all,    'run all checks'

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

@@ -1,50 +1,59 @@
 # encoding: utf-8
 
-# Find all
-registry       = Nanoc::PluginRegistry.instance
-deployer_class = Nanoc::Extra::Deployer
-deployers      = registry.find_all(deployer_class)
-deployer_names = deployers.keys.sort_by { |k| k.to_s }
-
 usage       'deploy [options]'
 summary     'deploy the compiled site'
 description <<-EOS
 Deploys the compiled site. The compiled site contents in the output directory will be uploaded to the destination, which is specified using the `--target` option.
-
-Available deployers: #{deployer_names.join(', ')}
-
 EOS
 
-option :t, :target,     'specify the location to deploy to (default: `default`)', :argument => :required
-flag   :C, :'no-check', 'do not run the issue checks marked for deployment'
-flag   :L, :list,       'list available locations to deploy to'
-option :n, :'dry-run',  'show what would be deployed'
+option :t, :target,           'specify the location to deploy to (default: `default`)', :argument => :required
+flag   :C, :'no-check',       'do not run the issue checks marked for deployment'
+flag   :L, :list,             'list available locations to deploy to'
+flag   :D, :'list-deployers', 'list available deployers'
+option :n, :'dry-run',        'show what would be deployed'
 
 module Nanoc::CLI::Commands
 
   class Deploy < ::Nanoc::CLI::CommandRunner
 
     def run
-      require_site
-
-      # Get config
-      deploy_configs = site.config.fetch(:deploy) do
-        raise Nanoc::Errors::GenericTrivial, "The site configuration has no deploy configuration."
+      self.load_site
+
+      # List deployers
+      if options[:'list-deployers']
+        deployers      = Nanoc::PluginRegistry.instance.find_all(Nanoc::Extra::Deployer)
+        deployer_names = deployers.keys.sort_by { |k| k.to_s }
+        puts "Available deployers:"
+        deployer_names.each do |name|
+          puts "  #{name}"
+        end
+        return
       end
 
-      # List
+      # Get & list configs
+      deploy_configs = site.config.fetch(:deploy, {})
+
       if options[:list]
-        puts "Available deployment configurations:"
-        deploy_configs.keys.each do |name|
-          puts "  #{name}"
+        if deploy_configs.empty?
+          puts  "No deployment configurations."
+        else
+          puts "Available deployment configurations:"
+          deploy_configs.keys.each do |name|
+            puts "  #{name}"
+          end
         end
         return
       end
 
+      # Can't proceed further without a deploy config
+      if deploy_configs.empty?
+        raise Nanoc::Errors::GenericTrivial, "The site has no deployment configurations."
+      end
+
       # Get target
       target = options.fetch(:target, :default).to_sym
       config = deploy_configs.fetch(target) do
-        raise Nanoc::Errors::GenericTrivial, "The site configuration has no deploy configuration for #{target}."
+        raise Nanoc::Errors::GenericTrivial, "The site has no deployment configuration for #{target}."
       end
 
       # Get deployer

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

@@ -7,8 +7,8 @@ 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
 additional `--yes` flag is needed as confirmation.
 
-Also see the `auto_prune` site configuration option in `config.yamlz, which
-will automatically prune after compilation.
+Also see the `auto_prune` configuration option in `nanoc.yaml` (`config.yaml`
+for older nanoc sites), which will automatically prune after compilation.
 EOS
 
 flag :y, :yes,       'confirm deletion'

data/lib/nanoc/cli/commands/validate-css.rb

@@ -13,6 +13,7 @@ module Nanoc::CLI::Commands
   class ValidateCSS < ::Nanoc::CLI::CommandRunner
 
     def run
+      warn "The `validate-css` command is deprecated. Please use the new `check` command instead."
       Nanoc::CLI.run %w( check css )
     end
 

data/lib/nanoc/cli/commands/validate-html.rb

@@ -13,6 +13,7 @@ module Nanoc::CLI::Commands
   class ValidateHTML < ::Nanoc::CLI::CommandRunner
 
     def run
+      warn "The `validate-html` command is deprecated. Please use the new `check` command instead."
       Nanoc::CLI.run %w( check html )
     end
 

data/lib/nanoc/cli/commands/validate-links.rb

@@ -16,6 +16,8 @@ module Nanoc::CLI::Commands
   class ValidateLinks < ::Nanoc::CLI::CommandRunner
 
     def run
+      warn "The `validate-links` command is deprecated. Please use the new `check` command instead."
+
       checks = []
       checks << 'ilinks' if options[:internal]
       checks << 'elinks' if options[:external]

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

@@ -67,7 +67,7 @@ module Nanoc::CLI::Commands
 
       # Get directories to watch
       dirs_to_watch  = watcher_config[:dirs_to_watch]  || ['content', 'layouts', 'lib']
-      files_to_watch = watcher_config[:files_to_watch] || ['config.yaml', 'Rules', 'rules', 'Rules.rb', 'rules.rb']
+      files_to_watch = watcher_config[:files_to_watch] || ['nanoc.yaml', 'config.yaml', 'Rules', 'rules', 'Rules.rb', 'rules.rb']
       files_to_watch = Regexp.new(files_to_watch.map { |name| "#{Regexp.quote(name)}$"}.join("|"))
       ignore_dir = Regexp.new(Dir.glob("*").map{|dir| dir if File::ftype(dir) == "directory" }.compact.join("|"))
 

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

@@ -103,6 +103,9 @@ module ::Nanoc::Extra::Checking::Checks
         begin
           Timeout::timeout(10) do
             res = request_url_once(url)
+            if res.code == '405'
+              res = request_url_once(url, Net::HTTP::Get)
+            end
           end
         rescue => e
           return Result.new(href, e.message)
@@ -133,9 +136,9 @@ module ::Nanoc::Extra::Checking::Checks
       raise 'should not have gotten here'
     end
 
-    def request_url_once(url)
+    def request_url_once(url, req_method = Net::HTTP::Head)
       path = (url.path.nil? || url.path.empty? ? '/' : url.path)
-      req = Net::HTTP::Head.new(path)
+      req = req_method.new(path)
       http = Net::HTTP.new(url.host, url.port)
       if url.instance_of? URI::HTTPS
         http.use_ssl = true

data/lib/nanoc/extra/checking/runner.rb

@@ -7,16 +7,21 @@ module Nanoc::Extra::Checking
   # @api private
   class Runner
 
-    CHECKS_FILENAME = 'Checks'
+    CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb']
 
     # @param [Nanoc::Site] site The nanoc site this runner is for
     def initialize(site)
       @site = site
     end
 
+    # @param [String] The name of the Checks file
+    def checks_filename
+      @_checks_filename ||= CHECKS_FILENAMES.find { |f| File.file?(f) }
+    end
+
     # @return [Boolean] true if a Checks file exists, false otherwise
     def has_dsl?
-      File.exist?(CHECKS_FILENAME)
+      self.checks_filename && File.file?(self.checks_filename)
     end
 
     # Lists all available checks on stdout.
@@ -66,7 +71,7 @@ module Nanoc::Extra::Checking
       @dsl_loaded ||= false
       if !@dsl_loaded
         if self.has_dsl?
-          @dsl = Nanoc::Extra::Checking::DSL.from_file(CHECKS_FILENAME)
+          @dsl = Nanoc::Extra::Checking::DSL.from_file(self.checks_filename)
         else
           @dsl = nil
         end
@@ -77,7 +82,7 @@ module Nanoc::Extra::Checking
     def require_dsl
       self.load_dsl_if_available
       if self.dsl.nil?
-        raise Nanoc::Errors::GenericTrivial, "No checks defined (no #{CHECKS_FILENAME} file present)"
+        raise Nanoc::Errors::GenericTrivial, "No checks defined (no #{CHECKS_FILENAMES.first} file present)"
       end
     end
 

data/lib/nanoc/filters/rdoc.rb

@@ -3,7 +3,12 @@
 module Nanoc::Filters
   class RDoc < Nanoc::Filter
 
-    requires 'rdoc/markup', 'rdoc/markup/to_html'
+    requires 'rdoc'
+
+    def self.setup
+      gem 'rdoc', '~> 4.0'
+      super
+    end
 
     # Runs the content through [RDoc::Markup](http://rdoc.rubyforge.org/RDoc/Markup.html).
     # This method takes no options.
@@ -12,7 +17,9 @@ module Nanoc::Filters
     #
     # @return [String] The filtered content
     def run(content, params={})
-      ::RDoc::Markup.new.convert(content, ::RDoc::Markup::ToHtml.new)
+      options = ::RDoc::Options.new
+      to_html = ::RDoc::Markup::ToHtml.new(options)
+      ::RDoc::Markup.new.convert(content, to_html)
     end
 
   end

data/lib/nanoc/helpers/breadcrumbs.rb

@@ -15,24 +15,19 @@ module Nanoc::Helpers
     # @return [Array] The breadcrumbs, starting with the root item and ending
     #   with the item itself
     def breadcrumbs_trail
-      breadcrumbs_for_identifier(@item.identifier)
-    end
+      trail      = []
+      idx_start  = 0
 
-    def item_with_identifier(identifier)
-      @identifier_cache ||= {}
-      @identifier_cache[identifier] ||= begin
-        @items.find { |i| i.identifier == identifier }
-      end
-    end
+      loop do
+        idx = @item.identifier.index('/', idx_start)
+        break if idx.nil?
 
-    def breadcrumbs_for_identifier(identifier)
-      @breadcrumbs_cache ||= {}
-      @breadcrumbs_cache[identifier] ||= begin
-        head = (identifier == '/' ? [] :  breadcrumbs_for_identifier(identifier.sub(/[^\/]+\/$/, '')) )
-        tail = [ item_with_identifier(identifier) ]
-
-        head + tail
+        idx_start = idx+1
+        identifier = @item.identifier[0..idx]
+        trail << @items[identifier]
       end
+
+      trail
     end
 
   end

data/nanoc.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |s|
   s.summary     = 'a web publishing system written in Ruby for building small to medium-sized websites.'
   s.description = 'nanoc is a simple but very flexible static site generator written in Ruby. It operates on local files, and therefore does not run on the server. nanoc “compiles” the local source files into HTML (usually), by evaluating eRuby, Markdown, etc.'
 
-  s.author = 'Denis Defreyne'
-  s.email  = 'denis.defreyne@stoneship.org'
+  s.author  = 'Denis Defreyne'
+  s.email   = 'denis.defreyne@stoneship.org'
+  s.license = 'MIT'
 
   s.files              = Dir['[A-Z]*'] +
                          Dir['doc/yardoc_templates/**/*'] +

data/test/base/test_checksum_store.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
-class Nanoc::ChecksumStoreTest < MiniTest::Unit::TestCase
-
-  include Nanoc::TestHelpers
+class Nanoc::ChecksumStoreTest < Nanoc::TestCase
 
   def test_get_with_existing_object
     require 'pstore'

data/test/base/test_code_snippet.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
-class Nanoc::CodeSnippetTest < MiniTest::Unit::TestCase
-
-  include Nanoc::TestHelpers
+class Nanoc::CodeSnippetTest < Nanoc::TestCase
 
   def test_load
     # Initialize