nanoc3 3.0.9 → 3.1.0a1

data/lib/nanoc3/helpers/rendering.rb

@@ -2,29 +2,36 @@
 
 module Nanoc3::Helpers
 
-  # Nanoc3::Helpers::Rendering provides functionality for rendering layouts as
-  # partials.
+  # Provides functionality for rendering layouts as partials.
   module Rendering
 
     include Nanoc3::Helpers::Capturing
 
     # Returns a string containing the rendered given layout.
     #
-    # +identifier+:: the identifier of the layout that should be rendered.
+    # @param [String] identifier The identifier of the layout that should be
+    #   rendered
     #
-    # +other_assigns+:: a hash containing assigns that will be made available
-    #                   as instance variables.
+    # @param [Hash] other_assigns A hash containing assigns that will be made
+    #   available as instance variables in the partial
     #
-    # Example 1: a layout 'head' with content "HEAD" and a layout 'foot' with
-    # content "FOOT":
+    # @example Rendering a head and a foot partial around some text
     #
     #   <%= render 'head' %> - MIDDLE - <%= render 'foot' %>
     #   # => "HEAD - MIDDLE - FOOT" 
     #
-    # Example 2: a layout named 'head' with content "<h1><%= @title %></h1>":
+    # @example Rendering a head partial with a custom title
     #
+    #   # The 'head' layout
+    #   <h1><%= @title %></h1>
+    #
+    #   # The item/layout where the partial is rendered
     #   <%= render 'head', :title => 'Foo' %>
     #   # => "<h1>Foo</h1>"
+    #
+    # @raise [Nanoc3::Errors::UnknownLayout] if the given layout does not exist
+    #
+    # @return [String] The rendered partial
     def render(identifier, other_assigns={}, &block)
       # Find layout
       layout = @site.layouts.find { |l| l.identifier == identifier.cleaned_identifier }

data/lib/nanoc3/helpers/tagging.rb

@@ -2,33 +2,33 @@
 
 module Nanoc3::Helpers
 
-  # Nanoc3::Helpers::Tagging provides some support for managing tags added to
-  # items. To add tags to items, set the +tags+ attribute to an array of
-  # tags that should be applied to the item. For example:
+  # Provides support for managing tags added to items.
   #
-  #   tags: [ 'foo', 'bar', 'baz' ]
-  #
-  # To activate this helper, +include+ it, like this:
+  # To add tags to items, set the `tags` attribute to an array of tags that
+  # should be applied to the item.
   #
-  #   include Nanoc3::Helpers::Tagging
+  # @example Adding tags to an item
+  #   tags: [ 'foo', 'bar', 'baz' ]
   module Tagging
 
     require 'nanoc3/helpers/html_escape'
     include Nanoc3::Helpers::HTMLEscape
 
     # 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:
+    # tags will be linked using the {#link_for_tag} function; the
+    # HTML-escaping rules for {#link_for_tag} apply here as well.
+    #
+    # @option params [String] base_url ("http://technorati.com/tag/") The URL
+    #   to which the tag will be appended to construct the link URL. This URL
+    #   must have a trailing slash.
     #
-    # :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
-    #             "http://technorati.com/tag/".
+    # @option params [String] none_text ("(none)") The text to display when
+    #   the item has no tags
     #
-    # :none_text:: The text to display when the item has no tags. Defaults to
-    #              "(none)".
+    # @option params [String] separator (", ") The separator to put between
+    #   tags
     #
-    # :separator:: The separator to put between tags. Defaults to ", ".
+    # @return [String] A hyperlinked list of tags for the given item
     def tags_for(item, params={})
       base_url  = params[:base_url]  || 'http://technorati.com/tag/'
       none_text = params[:none_text] || '(none)'
@@ -41,7 +41,11 @@ module Nanoc3::Helpers
       end
     end
 
-    # Returns all items with the given tag.
+    # Find all items with the given tag.
+    #
+    # @param [String] tag The tag for which to find all items
+    #
+    # @return [Array] All items with the given tag
     def items_with_tag(tag)
       @items.select { |i| (i[:tags] || []).include?(tag) }
     end
@@ -50,11 +54,13 @@ module Nanoc3::Helpers
     # 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).
+    # @param [String] tag The name of the tag, which should consist of letters
+    #   and numbers (no spaces, slashes, or other special characters).
+    #
+    # @param [String] base_url The URL to which the tag will be appended to
+    #   construct the link URL. This URL must have a trailing slash.
     #
-    # +base_url+:: The URL to which the tag will be appended to construct the
-    #              link URL. This URL must have a trailing slash.
+    # @return [String] A link for the given tag and the given base URL
     def link_for_tag(tag, base_url)
       %[<a href="#{h base_url}#{h tag}" rel="tag">#{h tag}</a>]
     end

data/lib/nanoc3/helpers/text.rb

@@ -2,22 +2,22 @@
 
 module Nanoc3::Helpers
 
-  # Nanoc3::Helpers::Text contains several useful text-related helper functions.
+  # Contains several useful text-related helper functions.
   module Text
 
     # Returns an excerpt for the given string. HTML tags are ignored, so if
     # you don't want them to turn up, they should be stripped from the string
     # before passing it to the excerpt function.
     #
-    # +params+ is a hash where the following keys can be set:
+    # @param [String] string The string for which to build an excerpt
     #
-    # +length+:: The maximum number of characters this excerpt can contain,
-    #            including the omission. Defaults to 25.
+    # @option params [Number] length (25) The maximum number of characters
+    #   this excerpt can contain, including the omission.
     #
-    # +omission+:: The string to append to the excerpt when the excerpt is
-    #              shorter than the original string. Defaults to '...' (but in
-    #              HTML, you may want to use something more fancy, like
-    #              '…').
+    # @option params [String] omission ("...") The string to append to the
+    #   excerpt when the excerpt is shorter than the original string
+    #
+    # @return [String] The excerpt of the given string
     def excerptize(string, params={})
       # Initialize params
       params[:length]   ||= 25
@@ -30,6 +30,10 @@ module Nanoc3::Helpers
     end
 
     # Strips all HTML tags out of the given string.
+    #
+    # @param [String] string The string from which to strip all HTML
+    #
+    # @return [String] The given string with all HTML stripped
     def strip_html(string)
       # FIXME will need something more sophisticated than this, because it sucks
       string.gsub(/<[^>]*(>+|\s*\z)/m, '').strip

data/lib/nanoc3/helpers/xml_sitemap.rb

@@ -2,25 +2,21 @@
 
 module Nanoc3::Helpers
 
-  # Nanoc3::Helpers::XMLSitemap contains functionality for building XML
-  # sitemaps that will be crawled by search engines. See the Sitemaps protocol
-  # web site, http://www.sitemaps.org, for details.
-  #
-  # To activate this helper, +include+ it, like this:
-  #
-  #   include Nanoc3::Helpers::XMLSitemap
+  # Contains functionality for building XML sitemaps that will be crawled by
+  # search engines. See the [Sitemaps protocol site](http://www.sitemaps.org)
+  # for details.
   module XMLSitemap
 
-    # Returns the XML sitemap as a string.
+    # Builds an XML sitemap and returns it.
     #
     # The following attributes can optionally be set on items to change the
     # behaviour of the sitemap:
     #
-    # * 'changefreq', containing the estimated change frequency as defined by
-    #   the Sitemaps protocol.
+    # * `changefreq` — The estimated change frequency as defined by the
+    #   Sitemaps protocol
     #
-    # * 'priority', containing the item's priority, ranging from 0.0 to 1.0,
-    #   as defined by the Sitemaps protocol.
+    # * `priority` — The item's priority, ranging from 0.0 to 1.0, as defined
+    #   by the Sitemaps protocol
     #
     # The sitemap will also include dates on which the items were updated.
     # These are generated automatically; the way this happens depends on the
@@ -29,9 +25,11 @@ module Nanoc3::Helpers
     #
     # The site configuration will need to have the following attributes:
     #
-    # * 'base_url', containing the URL to the site, without trailing slash.
-    #   For example, if the site is at "http://example.com/", the base_url
-    #   would be "http://example.com".
+    # * `base_url` — The URL to the site, without trailing slash. For example,
+    #   if the site is at "http://example.com/", the `base_url` would be
+    #   "http://example.com".
+    #
+    # @return [String] The XML sitemap
     def xml_sitemap
       require 'builder'
 

data/lib/nanoc3/tasks/deploy/rsync.rake

@@ -4,8 +4,11 @@ namespace :deploy do
 
   desc 'Upload the compiled site using rsync'
   task :rsync do
+    dry_run     = !!ENV['dry_run']
+    config_name = ENV['config'] || :default
+
     deployer = Nanoc3::Extra::Deployers::Rsync.new
-    deployer.run :dry_run => !!ENV['DRY_RUN']
+    deployer.run(:config_name => config_name, :dry_run => dry_run)
   end
 
 end

data/lib/nanoc3/tasks.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
 
 require 'nanoc3'
+require 'rake'
 
 module Nanoc3::Tasks
 end
 
 Dir[File.dirname(__FILE__) + '/tasks/**/*.rb'].each   { |f| load f }
-Dir[File.dirname(__FILE__) + '/tasks/**/*.rake'].each { |f| load f }
+Dir[File.dirname(__FILE__) + '/tasks/**/*.rake'].each { |f| Rake.application.add_import(f) }

data/lib/nanoc3.rb

@@ -3,7 +3,27 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.0.9'
+  VERSION = '3.1.0a1'
+
+  # Loads all nanoc3 plugins, i.e. requires all ruby gems whose name start
+  # with `nanoc3-`.
+  #
+  # @return [Boolean] true if all plugins were loaded successfully, false if
+  #   rubygems isn’t loaded.
+  def self.load_plugins
+    # Don’t load if there’s no rubygems
+    return false if !defined?(Gem)
+
+    Gem.source_index.find_name('').each do |gem|
+      # Skip irrelevant ones
+      next if gem.name !~ /^nanoc3-/
+
+      # Load plugin
+      require gem.name
+    end
+
+    true
+  end
 
 end
 
@@ -17,3 +37,6 @@ require 'nanoc3/extra'
 require 'nanoc3/data_sources'
 require 'nanoc3/filters'
 require 'nanoc3/helpers'
+
+# Load plugins
+Nanoc3.load_plugins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
-  version: 3.0.9
+  version: 3.1.0a1
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,11 +9,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-24 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
-description: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
+date: 2010-02-15 00:00:00 +01:00
+default_executable: nanoc3
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: 
 email: denis.defreyne@stoneship.org
 executables: 
 - nanoc3
@@ -22,26 +31,25 @@ extensions: []
 extra_rdoc_files: 
 - ChangeLog
 - LICENSE
-- NEWS.rdoc
-- Rakefile
-- README.rdoc
-- bin/nanoc3
+- README.md
+- NEWS.md
 files: 
 - ChangeLog
 - LICENSE
-- NEWS.rdoc
+- NEWS.md
 - Rakefile
-- README.rdoc
-- bin/nanoc3
+- README.md
 - lib/nanoc3/base/code_snippet.rb
 - lib/nanoc3/base/compiler.rb
 - lib/nanoc3/base/compiler_dsl.rb
+- lib/nanoc3/base/context.rb
 - lib/nanoc3/base/core_ext/array.rb
 - lib/nanoc3/base/core_ext/hash.rb
 - lib/nanoc3/base/core_ext/string.rb
 - lib/nanoc3/base/core_ext.rb
 - lib/nanoc3/base/data_source.rb
 - lib/nanoc3/base/dependency_tracker.rb
+- lib/nanoc3/base/directed_graph.rb
 - lib/nanoc3/base/errors.rb
 - lib/nanoc3/base/filter.rb
 - lib/nanoc3/base/item.rb
@@ -49,8 +57,7 @@ files:
 - lib/nanoc3/base/layout.rb
 - lib/nanoc3/base/notification_center.rb
 - lib/nanoc3/base/ordered_hash.rb
-- lib/nanoc3/base/plugin.rb
-- lib/nanoc3/base/preprocessor_context.rb
+- lib/nanoc3/base/plugin_registry.rb
 - lib/nanoc3/base/rule.rb
 - lib/nanoc3/base/rule_context.rb
 - lib/nanoc3/base/site.rb
@@ -61,23 +68,24 @@ files:
 - lib/nanoc3/cli/commands/create_item.rb
 - lib/nanoc3/cli/commands/create_layout.rb
 - lib/nanoc3/cli/commands/create_site.rb
+- lib/nanoc3/cli/commands/debug.rb
 - lib/nanoc3/cli/commands/help.rb
 - lib/nanoc3/cli/commands/info.rb
 - lib/nanoc3/cli/commands/update.rb
+- lib/nanoc3/cli/commands/view.rb
 - lib/nanoc3/cli/commands.rb
 - lib/nanoc3/cli/logger.rb
 - lib/nanoc3/cli.rb
-- lib/nanoc3/data_sources/delicious.rb
+- lib/nanoc3/data_sources/deprecated/delicious.rb
+- lib/nanoc3/data_sources/deprecated/last_fm.rb
+- lib/nanoc3/data_sources/deprecated/twitter.rb
 - lib/nanoc3/data_sources/filesystem.rb
-- lib/nanoc3/data_sources/filesystem_combined.rb
-- lib/nanoc3/data_sources/filesystem_common.rb
-- lib/nanoc3/data_sources/filesystem_compact.rb
-- lib/nanoc3/data_sources/last_fm.rb
-- lib/nanoc3/data_sources/twitter.rb
+- lib/nanoc3/data_sources/filesystem_unified.rb
+- lib/nanoc3/data_sources/filesystem_verbose.rb
 - lib/nanoc3/data_sources.rb
 - lib/nanoc3/extra/auto_compiler.rb
 - lib/nanoc3/extra/chick.rb
-- lib/nanoc3/extra/context.rb
+- lib/nanoc3/extra/core_ext/enumerable.rb
 - lib/nanoc3/extra/core_ext/time.rb
 - lib/nanoc3/extra/core_ext.rb
 - lib/nanoc3/extra/deployers/rsync.rb
@@ -99,6 +107,7 @@ files:
 - lib/nanoc3/filters/erb.rb
 - lib/nanoc3/filters/erubis.rb
 - lib/nanoc3/filters/haml.rb
+- lib/nanoc3/filters/kramdown.rb
 - lib/nanoc3/filters/less.rb
 - lib/nanoc3/filters/markaby.rb
 - lib/nanoc3/filters/maruku.rb
@@ -121,107 +130,54 @@ files:
 - lib/nanoc3/helpers/text.rb
 - lib/nanoc3/helpers/xml_sitemap.rb
 - lib/nanoc3/helpers.rb
-- lib/nanoc3/package.rb
 - lib/nanoc3/tasks/clean.rake
 - lib/nanoc3/tasks/clean.rb
 - lib/nanoc3/tasks/deploy/rsync.rake
 - lib/nanoc3/tasks/validate.rake
 - lib/nanoc3/tasks.rb
 - lib/nanoc3.rb
-- vendor/cri/ChangeLog
-- vendor/cri/lib/cri/base.rb
-- vendor/cri/lib/cri/command.rb
-- vendor/cri/lib/cri/core_ext/string.rb
-- vendor/cri/lib/cri/core_ext.rb
-- vendor/cri/lib/cri/option_parser.rb
-- vendor/cri/lib/cri.rb
-- vendor/cri/LICENSE
-- vendor/cri/NEWS
-- vendor/cri/Rakefile
-- vendor/cri/README
-- vendor/cri/test/test_base.rb
-- vendor/cri/test/test_command.rb
-- vendor/cri/test/test_core_ext.rb
-- vendor/cri/test/test_option_parser.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: http://nanoc.stoneship.org/
 licenses: []
 
 post_install_message: |
   ------------------------------------------------------------------------------
-  Thanks for installing nanoc 3.0! Here are some resources to help you get started:
+  Thanks for installing nanoc 3.1! Here are some resources to help you get
+  started:
   
   * The tutorial at <http://nanoc.stoneship.org/tutorial/>
   * The manual at <http://nanoc.stoneship.org/manual/>
   * The discussion group at <http://groups.google.com/group/nanoc>
-  * The IRC channel #nanoc on Freenode
   
-  Because nanoc 3.0 has a lot of new features, be sure to check out the nanoc blog at <http://nanoc.stoneship.org/blog/> for details about this release.
+  Because nanoc 3.1 has quite a few new features, be sure to check out the nanoc
+  blog at <http://nanoc.stoneship.org/blog/> for details about this release.
   
   Enjoy!
   ------------------------------------------------------------------------------
 
 rdoc_options: 
-- --title
-- nanoc3
-- --main
-- README.rdoc
-- --exclude
-- lib/nanoc3/tasks/clean.rake
-- --exclude
-- lib/nanoc3/tasks/deploy/rsync.rake
-- --exclude
-- lib/nanoc3/tasks/validate.rake
-- --exclude
-- vendor/cri/ChangeLog
-- --exclude
-- vendor/cri/lib/cri/base.rb
-- --exclude
-- vendor/cri/lib/cri/command.rb
-- --exclude
-- vendor/cri/lib/cri/core_ext/string.rb
-- --exclude
-- vendor/cri/lib/cri/core_ext.rb
-- --exclude
-- vendor/cri/lib/cri/option_parser.rb
-- --exclude
-- vendor/cri/lib/cri.rb
-- --exclude
-- vendor/cri/LICENSE
-- --exclude
-- vendor/cri/NEWS
-- --exclude
-- vendor/cri/Rakefile
-- --exclude
-- vendor/cri/README
-- --exclude
-- vendor/cri/test/test_base.rb
-- --exclude
-- vendor/cri/test/test_command.rb
-- --exclude
-- vendor/cri/test/test_core_ext.rb
-- --exclude
-- vendor/cri/test/test_option_parser.rb
+- --readme
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.8.5
+      version: "0"
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
   version: 
 requirements: []
 
-rubyforge_project: nanoc
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: a tool that runs on your local computer and compiles Markdown, Textile, Haml, ... documents into static web pages
+summary: a web publishing system written in Ruby for building small to medium-sized websites.
 test_files: []