nanoc3 3.0.3 → 3.0.4

data/NEWS.rdoc

@@ -1,5 +1,11 @@
 = nanoc News
 
+== 3.0.4
+
+* Fixed a bug which would cause the filesystem_compact data source to
+  incorrectly determine the content filename, leading to weird “Expected 1
+  content file but found 3” errors [Eric Sunshine]
+
 == 3.0.3
 
 * The Blogging helper now properly handles item reps without paths

data/README.rdoc

@@ -67,9 +67,9 @@ You may need to manually install the rdoc gem and update the rubygems installati
 
 (In alphabetical order)
 
-* Christian Plessl
 * Colin Barrett
 * Dmitry Bilunov
+* Christian Plessl
 * Šime Ramov
 * "Soryu"
 * Dennis Sutch

data/lib/nanoc3/data_sources/filesystem.rb

@@ -31,6 +31,10 @@ module Nanoc3::DataSources
   # can have an 'index.txt' content file and a 'meta.yaml' meta file. This is
   # to preserve backward compatibility.
   #
+  # The identifier is calculated by stripping the extension; if there is more
+  # than one extension, only the last extension is stripped and the previous
+  # extensions will be part of the identifier.
+  #
   # = Layouts
   #
   # Layouts are stored as directories in the 'layouts' directory. Each layout
@@ -42,6 +46,9 @@ module Nanoc3::DataSources
   # 'layouts' directory. Such a layout cannot have any metadata; the filter
   # used for this layout is determined from the file extension.
   #
+  # The identifier for layouts is generated the same way as identifiers for
+  # items (see above for details).
+  #
   # = Code Snippets
   #
   # Code snippets are stored in '.rb' files in the 'lib' directory. Code

data/lib/nanoc3/data_sources/filesystem_combined.rb

@@ -19,7 +19,10 @@ module Nanoc3::DataSources
   # The identifier of a item is determined as follows. A file with an
   # 'index.*' filename, such as 'index.txt', will have the filesystem path
   # with the 'index.*' part stripped as a identifier. For example,
-  # 'foo/bar/index.html' will have '/foo/bar/' as identifier.
+  # 'foo/bar/index.html' will have '/foo/bar/' as identifier. In other cases,
+  # the identifier is calculated by stripping the extension; if there is more
+  # than one extension, only the last extension is stripped and the previous
+  # extensions will be part of the identifier.
   #
   # A file with a filename not starting with 'index.', such as 'foo.html',
   # will have an identifier ending in 'foo/'. For example, 'foo/bar.html' will
@@ -46,6 +49,9 @@ module Nanoc3::DataSources
   # each layout consists of a metadata part and a content part, separated by
   # '---' (three dashes).
   #
+  # The identifier for layouts is generated the same way as identifiers for
+  # items (see above for details).
+  #
   # = Code Snippets
   #
   # Code snippets are stored in '.rb' files in the 'lib' directory. Code

data/lib/nanoc3/data_sources/filesystem_compact.rb

@@ -25,6 +25,10 @@ module Nanoc3::DataSources
   # nested in directories and named "index" such as the home page item, or
   # they can simply be given a non-"index" name.
   #
+  # The identifier is calculated by stripping the extension; if there is more
+  # than one extension, only the last extension is stripped and the previous
+  # extensions will be part of the identifier.
+  #
   # For example, this directory structure:
   #
   #   content/
@@ -42,6 +46,8 @@ module Nanoc3::DataSources
   #         a-very-old-post.yaml
   #         another-very-old-post.html
   #         another-very-old-post.yaml
+  #         foo.entry.html
+  #         foo.entry.yaml
   #     myst/
   #       index.html
   #       index.yaml
@@ -54,6 +60,7 @@ module Nanoc3::DataSources
   #   /journal/2005/
   #   /journal/2005/a-very-old-post/
   #   /journal/2005/another-very-old-post/
+  #   /journal/2005/foo.entry/
   #   /myst/
   #
   # = Layouts
@@ -61,6 +68,9 @@ module Nanoc3::DataSources
   # Layouts are stored the same way as items, except that they are stored in
   # the "layouts" directory instead of the "content" directory.
   #
+  # The identifier for layouts is generated the same way as identifiers for
+  # items (see above for details).
+  #
   # = Code Snippets
   #
   # Code snippets are stored in '.rb' files in the 'lib' directory. Code
@@ -177,14 +187,18 @@ module Nanoc3::DataSources
     ########## Custom functions ##########
 
     # Returns the identifier for the given meta filename. This method assumes
-    # that the base is already stripped.
+    # that the base is already stripped. The identifier is calculated by
+    # stripping the extension; if there is more than one extension, only the
+    # last extension is stripped and the previous extensions will be part of
+    # the identifier.
     #
     # For example:
     #
-    #   /foo.yaml       -> /foo/
-    #   /foo/index.yaml -> /foo/
-    #   /foo/foo.yaml   -> /foo/foo/
-    #   /foo/bar.yaml   -> /foo/bar/
+    #   /foo.yaml           -> /foo/
+    #   /foo/index.yaml     -> /foo/
+    #   /foo/foo.yaml       -> /foo/foo/
+    #   /foo/bar.yaml       -> /foo/bar/
+    #   /foo/bar.entry.yaml -> /foo/bar.entry/
     def identifier_for_meta_filename(meta_filename)
       # Split into components
       components = meta_filename.gsub(%r{(^/|/$)}, '').split('/')
@@ -210,7 +224,7 @@ module Nanoc3::DataSources
       # Find all files
     	base_filename = File.basename(meta_filename, '.yaml')
     	dirname       = File.dirname(meta_filename)
-    	filenames     = Dir.entries(dirname).select { |f| f =~ /#{base_filename}\.[^.]+$/ }.map { |f| "#{dirname}/#{f}" }
+    	filenames     = Dir.entries(dirname).select { |f| f =~ /^#{base_filename}\.[^.]+$/ }.map { |f| "#{dirname}/#{f}" }
 
       # Reject meta files
       filenames.reject! { |f| f =~ /\.yaml$/ }

data/lib/nanoc3/helpers/link_to.rb

@@ -13,7 +13,9 @@ module Nanoc3::Helpers
     include Nanoc3::Helpers::HTMLEscape
 
     # Creates a HTML link to the given path or item representation, and with
-    # the given text.
+    # the given text. All attributes of the `a` element, including the `href`
+    # attribute, will be HTML-escaped; the contents of the `a` element, which
+    # can contain markup, will not be HTML-escaped.
     #
     # +path_or_rep+:: the URL or path (a String) that should be linked to, or
     #                 the item representation that should be linked to.
@@ -49,7 +51,8 @@ module Nanoc3::Helpers
 
     # Creates a HTML link using link_to, except when the linked item is the
     # current one. In this case, a span element with class "active" and with
-    # the given text will be returned.
+    # the given text will be returned. The HTML-escaping rules for `link_to`
+    # apply here as well.
     #
     # Examples:
     #
@@ -71,7 +74,7 @@ module Nanoc3::Helpers
     end
 
     # Returns the relative path from the current item to the given path or
-    # item representation.
+    # item representation. The returned path will not be HTML-escaped.
     #
     # +path_or_rep+:: the URL or path (a String) to where the relative should
     #                 point, or the item representation to which the relative

data/lib/nanoc3/helpers/tagging.rb

@@ -16,8 +16,10 @@ module Nanoc3::Helpers
     require 'nanoc3/helpers/html_escape'
     include Nanoc3::Helpers::HTMLEscape
 
-    # Returns a formatted list of tags for the given item as a string. Several
-    # parameters allow customization:
+    # Returns a formatted list of tags for the given item as a string. The
+    # tags will be linked using the `link_for_tag` function; the HTML-escaping
+    # rules for this function apply here as well. Several parameters allow
+    # customization:
     #
     # :base_url:: The URL to which the tag will be appended to construct the
     #             link URL. This URL must have a trailing slash. Defaults to
@@ -45,7 +47,8 @@ module Nanoc3::Helpers
     end
 
     # Returns a link to to the specified tag. The link is marked up using the
-    # rel-tag microformat.
+    # rel-tag microformat. The `href` attribute of the link will be HTML-
+    # escaped, as will the content of the `a` element.
     #
     # +tag+:: The name of the tag, which should consist of letters and numbers
     #         (no spaces, slashes, or other special characters).

data/lib/nanoc3.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-07 00:00:00 +01:00
+date: 2010-01-08 00:00:00 +01:00
 default_executable: 
 dependencies: []