nanoc3 3.1.3 → 3.1.4

data/NEWS.md

@@ -1,6 +1,16 @@
 # nanoc news
 
-## 3.1.3 (???)
+## 3.1.4 (2010-07-25)
+
+* Made INT and TERM signals always quit the CLI
+* Allowed relative imports in LESS
+* Made sure modification times are unchanged for identical recompiled items
+* Improved link validator error handling
+* Made pygmentize not output extra divs and pres
+* Allowed colorizers to be specified using symbols instead of strings
+* Added scss to the default list of text extensions
+
+## 3.1.3 (2010-04-25)
 
 * Removed annoying win32console warning [Eric Sunshine]
 * Removed color codes when not writing to a terminal, or when writing to

data/README.md

@@ -52,10 +52,17 @@ you want to explore nanoc from a technical perspective.
 
 ## Dependencies
 
-nanoc itself can be used without installing any dependencies. Some
-components, however, do have dependencies:
+nanoc has few dependencies. It is possible to use nanoc programmatically
+without any dependencies at all, but if you want to use nanoc in a proper way,
+you’ll likely need some dependencies:
 
+* The **commandline frontend** depends on `cli`.
 * The **autocompiler** depends on `mime-types` and `rack`.
+* Filters and helpers likely have dependencies on their own too.
+
+If you’re developing for nanoc, such as writing custom filters or helpers, you
+may be interested in the development dependencies:
+
 * For **documentation generation** you’ll need `yard`.
 * For **packaging** you’ll need `rubygems` (1.3 or newer).
 * For **testing** you’ll need `mocha` and `minitest`.

data/lib/nanoc3/base/item.rb

@@ -13,6 +13,16 @@ module Nanoc3
     # @return [Hash] This item's attributes
     attr_accessor :attributes
 
+    # A string that uniquely identifies an item in a site.
+    #
+    # Identifiers start and end with a slash. They are comparable to paths on
+    # the filesystem, with the difference that file system paths usually do
+    # not have a trailing slash. The item hierarchy (parent and children of
+    # items) is determined by the item identifier.
+    #
+    # The root page (the home page) has the identifier “/”, which means
+    # that it is the ancestor of all other items.
+    #
     # @return [String] This item's identifier
     attr_accessor :identifier
 

data/lib/nanoc3/base/item_rep.rb

@@ -357,15 +357,17 @@ module Nanoc3
           hash_old = hash_for_file(self.raw_path)
           size_old = File.size(self.raw_path)
         end
-
-        # Copy
-        FileUtils.cp(@filenames[:last], self.raw_path)
-        @written = true
+        size_new = File.size(@filenames[:last])
+        hash_new = hash_for_file(@filenames[:last]) if size_old == size_new
 
         # Check if file was modified
-        size_new = File.size(self.raw_path)
-        hash_new = hash_for_file(self.raw_path) if size_old == size_new
         @modified = (size_old != size_new || hash_old != hash_new)
+
+        # Copy
+        if @modified
+          FileUtils.cp(@filenames[:last], self.raw_path)
+        end
+        @written = true
       else
         # Remember old content
         if File.file?(self.raw_path)
@@ -373,7 +375,10 @@ module Nanoc3
         end
 
         # Write
-        File.open(self.raw_path, 'w') { |io| io.write(@content[:last]) }
+        new_content = @content[:last]
+        if @old_content != new_content
+          File.open(self.raw_path, 'w') { |io| io.write(new_content) }
+        end
         @written = true
 
         # Generate diff

data/lib/nanoc3/base/rule_context.rb

@@ -14,7 +14,7 @@ module Nanoc3
   # * `layouts` ({Array}<{Nanoc3::Layout}>) - A list of all layouts
   class RuleContext < Context
 
-    # Creates a new rule context for the given iterm representation.
+    # Creates a new rule context for the given item representation.
     #
     # @param [Nanoc3::ItemRep] rep The item representation for which to create
     # a new rule context.

data/lib/nanoc3/base/site.rb

@@ -39,7 +39,7 @@ module Nanoc3
     # that lacks some options, the default value will be taken from
     # `DEFAULT_CONFIG`.
     DEFAULT_CONFIG = {
-      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass txt xhtml xml ),
+      :text_extensions    => %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml ),
       :output_dir         => 'output',
       :data_sources       => [ {} ],
       :index_filenames    => [ 'index.html' ],

data/lib/nanoc3/cli/base.rb

@@ -54,6 +54,14 @@ module Nanoc3::CLI
 
     # Inherited from ::Cri::Base
     def run(args)
+      # Set exit handler
+      [ 'INT', 'TERM' ].each do |signal|
+        Signal.trap(signal) do
+          puts
+          exit!(0)
+        end
+      end
+
       super(args)
     rescue Interrupt => e
       exit(1)

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

@@ -106,6 +106,7 @@ 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

@@ -48,6 +48,36 @@ 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 = {}
 
@@ -127,17 +157,23 @@ module Nanoc3::Extra::Validators
       require 'uri'
 
       # Parse
-      uri = URI.parse(href)
+      uri = nil
+      begin
+        uri = URI.parse(href)
+      rescue URI::InvalidURIError
+        @delegate && @delegate.send(:external_href_validated, href, false)
+        return false
+      end
 
       # Skip non-HTTP URLs
       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.send(:external_href_validated, href, is_valid)
+      @delegate && @delegate.send(:external_href_validated, href, is_valid)
 
       # Done
       is_valid
@@ -153,30 +189,10 @@ 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 = EachPairEnumerator.new(hrefs)
+      enum = ThreadsafeHashEnumerator.new(hrefs)
 
       threads = []
       10.times do
@@ -202,7 +218,10 @@ module Nanoc3::Extra::Validators
     def fetch_http_status_for(url, params={})
       5.times do |i|
         begin
-          res = request_url_once(url)
+          res = nil
+          Timeout::timeout(10) do
+            res = request_url_once(url)
+          end
 
           if res.code =~ /^3..$/
             url = URI.parse(res['location'])
@@ -211,7 +230,7 @@ module Nanoc3::Extra::Validators
             return res.code.to_i
           end
         rescue
-          nil
+          return nil
         end
       end
     end

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -71,7 +71,7 @@ module Nanoc3::Filters
     KNOWN_COLORIZERS = [ :coderay, :dummy, :pygmentize ]
 
     def highlight(code, language, params={})
-      colorizer = @colorizers[language]
+      colorizer = @colorizers[language.to_sym]
       if KNOWN_COLORIZERS.include?(colorizer)
         send(colorizer, code, language, params[colorizer] || {})
       else
@@ -93,7 +93,10 @@ module Nanoc3::Filters
       IO.popen("pygmentize -l #{language} -f html", "r+") do |io|
         io.write(code)
         io.close_write
-        return io.read
+        highlighted_code = io.read
+
+        doc = Nokogiri::HTML.fragment(highlighted_code)
+        return doc.xpath('./div[@class="highlight"]/pre').inner_html
       end
     end
 

data/lib/nanoc3/filters/less.rb

@@ -12,7 +12,13 @@ module Nanoc3::Filters
     def run(content, params={})
       require 'less'
 
+      # Add filename to load path
+      $LESS_LOAD_PATH << File.dirname(@item[:content_filename])
+
       ::Less::Engine.new(content).to_css
+    ensure
+      # Restore load path
+      $LESS_LOAD_PATH.delete_at(-1)
     end
 
   end

data/lib/nanoc3/helpers/link_to.rb

@@ -47,7 +47,12 @@ module Nanoc3::Helpers
     #   # => '<a title="My super cool blog" href="/blog/">Blog</a>'
     def link_to(text, target, attributes={})
       # Find path
-      path = target.is_a?(String) ? target : target.path
+      if target.is_a?(String)
+        path = target
+      else
+        path = target.path
+        raise RuntimeError, "Cannot create a link to #{target.inspect} because this target is not outputted (its routing rule returns nil)" if path.nil?
+      end
 
       # Join attributes
       attributes = attributes.inject('') do |memo, (key, value)|
@@ -112,14 +117,20 @@ module Nanoc3::Helpers
       require 'pathname'
 
       # Find path
-      path = target.is_a?(String) ? target : target.path
+      if target.is_a?(String)
+        path = target
+      else
+        path = target.path
+        raise RuntimeError, "Cannot get the relative path to #{target.inspect} because this target is not outputted (its routing rule returns nil)" if path.nil?
+      end
 
       # Get source and destination paths
       dst_path   = Pathname.new(path)
+      raise RuntimeError, "Cannot get the relative path to #{path} because the current item representation, #{@item_rep.inspect}, is not outputted (its routing rule returns nil)" if @item_rep.path.nil?
       src_path   = Pathname.new(@item_rep.path)
 
-      # Calculate elative path (method depends on whether destination is a
-      # directory or not).
+      # Calculate the relative path (method depends on whether destination is
+      # a directory or not).
       if src_path.to_s[-1,1] != '/'
         relative_path = dst_path.relative_path_from(src_path.dirname).to_s
       else

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.1.3'
+  VERSION = '3.1.4'
 
 end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 3
   - 1
-  - 3
-  version: 3.1.3
+  - 4
+  version: 3.1.4
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 +02:00
+date: 2010-07-25 00:00:00 +02:00
 default_executable: nanoc3
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
@@ -147,6 +150,7 @@ files:
 - lib/nanoc3/tasks/validate.rake
 - lib/nanoc3/tasks.rb
 - lib/nanoc3.rb
+- bin/nanoc3
 has_rdoc: yard
 homepage: http://nanoc.stoneship.org/
 licenses: []
@@ -172,23 +176,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: a web publishing system written in Ruby for building small to medium-sized websites.