nanoc3 3.1.0a2 → 3.1.0a3

data/lib/nanoc3/helpers/link_to.rb

@@ -17,28 +17,32 @@ module Nanoc3::Helpers
     # @param [String] text The visible link text
     #
     # @param [String, Nanoc3::Item, Nanoc3::ItemRep] target The path/URL,
-    #   item or item representation that should be linked to
+    # item or item representation that should be linked to
     #
     # @param [Hash] attributes A hash containing HTML attributes (e.g.
-    #   `rel`, `title`, …) that will be added to the link.
+    # `rel`, `title`, …) that will be added to the link.
     #
     # @return [String] The link text
     #
     # @example Linking to a path
+    #
     #   link_to('Blog', '/blog/')
     #   # => '<a href="/blog/">Blog</a>'
     #
     # @example Linking to an item
+    #
     #   about = @items.find { |i| i.identifier == '/about/' }
     #   link_to('About Me', about)
     #   # => '<a href="/about.html">About Me</a>'
     #
     # @example Linking to an item representation
+    #
     #   about = @items.find { |i| i.identifier == '/about/' }
     #   link_to('My vCard', about.rep(:vcard))
     #   # => '<a href="/about.vcf">My vCard</a>'
     #
     # @example Linking with custom attributes
+    #
     #   link_to('Blog', '/blog/', :title => 'My super cool blog')
     #   # => '<a title="My super cool blog" href="/blog/">Blog</a>'
     def link_to(text, target, attributes={})
@@ -62,18 +66,20 @@ module Nanoc3::Helpers
     # @param [String] text The visible link text
     #
     # @param [String, Nanoc3::Item, Nanoc3::ItemRep] target The path/URL,
-    #   item or item representation that should be linked to
+    # item or item representation that should be linked to
     #
     # @param [Hash] attributes A hash containing HTML attributes (e.g.
-    #   `rel`, `title`, …) that will be added to the link.
+    # `rel`, `title`, …) that will be added to the link.
     #
     # @return [String] The link text
     #
     # @example Linking to a different page
+    #
     #   link_to_unless_current('Blog', '/blog/')
     #   # => '<a href="/blog/">Blog</a>'
     #
     # @example Linking to the same page
+    #
     #   link_to_unless_current('This Item', @item)
     #   # => '<span class="active" title="You\'re here.">This Item</span>'
     def link_to_unless_current(text, target, attributes={})
@@ -92,12 +98,13 @@ module Nanoc3::Helpers
     # item representation. The returned path will not be HTML-escaped.
     #
     # @param [String, Nanoc3::Item, Nanoc3::ItemRep] target The path/URL,
-    #   item or item representation to which the relative path should be
-    #   generated
+    # item or item representation to which the relative path should be
+    # generated
     #
     # @return [String] The relative path to the target
     #
     # @example
+    #
     #   # if the current item's path is /foo/bar/
     #   relative_path_to('/foo/qux/')
     #   # => '../qux/'

data/lib/nanoc3/helpers/rendering.rb

@@ -10,10 +10,10 @@ module Nanoc3::Helpers
     # Returns a string containing the rendered given layout.
     #
     # @param [String] identifier The identifier of the layout that should be
-    #   rendered
+    # rendered
     #
     # @param [Hash] other_assigns A hash containing assigns that will be made
-    #   available as instance variables in the partial
+    # available as instance variables in the partial
     #
     # @example Rendering a head and a foot partial around some text
     #
@@ -29,7 +29,8 @@ module Nanoc3::Helpers
     #   <%= render 'head', :title => 'Foo' %>
     #   # => "<h1>Foo</h1>"
     #
-    # @raise [Nanoc3::Errors::UnknownLayout] if the given layout does not exist
+    # @raise [Nanoc3::Errors::UnknownLayout] if the given layout does not
+    # exist
     #
     # @return [String] The rendered partial
     def render(identifier, other_assigns={}, &block)

data/lib/nanoc3/helpers/tagging.rb

@@ -8,6 +8,7 @@ module Nanoc3::Helpers
   # should be applied to the item.
   #
   # @example Adding tags to an item
+  #
   #   tags: [ 'foo', 'bar', 'baz' ]
   module Tagging
 
@@ -19,14 +20,14 @@ module Nanoc3::Helpers
     # 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.
+    # to which the tag will be appended to construct the link URL. This URL
+    # must have a trailing slash.
     #
     # @option params [String] none_text ("(none)") The text to display when
-    #   the item has no tags
+    # the item has no tags
     #
     # @option params [String] separator (", ") The separator to put between
-    #   tags
+    # tags
     #
     # @return [String] A hyperlinked list of tags for the given item
     def tags_for(item, params={})
@@ -55,10 +56,10 @@ module Nanoc3::Helpers
     # escaped, as will the content of the `a` element.
     #
     # @param [String] tag The name of the tag, which should consist of letters
-    #   and numbers (no spaces, slashes, or other special characters).
+    # 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.
+    # 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)

data/lib/nanoc3/helpers/text.rb

@@ -12,10 +12,10 @@ module Nanoc3::Helpers
     # @param [String] string The string for which to build an excerpt
     #
     # @option params [Number] length (25) The maximum number of characters
-    #   this excerpt can contain, including the omission.
+    # this excerpt can contain, including the omission.
     #
     # @option params [String] omission ("...") The string to append to the
-    #   excerpt when the excerpt is shorter than the original string
+    # excerpt when the excerpt is shorter than the original string
     #
     # @return [String] The excerpt of the given string
     def excerptize(string, params={})

data/lib/nanoc3/tasks/validate.rake

@@ -4,31 +4,88 @@ namespace :validate do
 
   desc 'Validate the site\'s HTML files'
   task :html do
-    # Load site
+    # Get output directory
     site = Nanoc3::Site.new('.')
     if site.nil?
       $stderr.puts 'The current working directory does not seem to be a ' +
                    'valid/complete nanoc site directory; aborting.'
       exit 1
     end
+    dir = site.config[:output_dir]
 
     # Validate
-    validator = ::Nanoc3::Extra::Validators::W3C.new(site, :html)
+    validator = ::Nanoc3::Extra::Validators::W3C.new(dir, [ :html ])
     validator.run
   end
 
   desc 'Validate the site\'s CSS files'
   task :css do
-    # Load site
-    site = Nanoc3::Site.new(YAML.load_file(File.join(Dir.getwd, 'config.yaml')))
+    # Get output directory
+    site = Nanoc3::Site.new('.')
+    if site.nil?
+      $stderr.puts 'The current working directory does not seem to be a ' +
+                   'valid/complete nanoc site directory; aborting.'
+      exit 1
+    end
+    dir = site.config[:output_dir]
+
+    # Validate
+    validator = ::Nanoc3::Extra::Validators::W3C.new(dir, [ :css ])
+    validator.run
+  end
+
+  namespace :links do
+
+    desc 'Validate the site’s internal links'
+    task :internal do
+      # Get output directory
+      site = Nanoc3::Site.new('.')
+      if site.nil?
+        $stderr.puts 'The current working directory does not seem to be a ' +
+                     'valid/complete nanoc site directory; aborting.'
+        exit 1
+      end
+      dir             = site.config[:output_dir]
+      index_filenames = site.config[:index_filenames]
+
+      # Validate
+      validator = ::Nanoc3::Extra::Validators::Links.new(dir, index_filenames, :internal => true)
+      validator.run
+    end
+
+    desc 'Validate the site’s internal links'
+    task :external do
+      # Get output directory
+      site = Nanoc3::Site.new('.')
+      if site.nil?
+        $stderr.puts 'The current working directory does not seem to be a ' +
+                     'valid/complete nanoc site directory; aborting.'
+        exit 1
+      end
+      dir             = site.config[:output_dir]
+      index_filenames = site.config[:index_filenames]
+
+      # Validate
+      validator = ::Nanoc3::Extra::Validators::Links.new(dir, index_filenames, :external => true)
+      validator.run
+    end
+
+  end
+
+  desc 'Validate the site’s internal and external links'
+  task :links do
+    # Get output directory
+    site = Nanoc3::Site.new('.')
     if site.nil?
       $stderr.puts 'The current working directory does not seem to be a ' +
                    'valid/complete nanoc site directory; aborting.'
       exit 1
     end
+    dir             = site.config[:output_dir]
+    index_filenames = site.config[:index_filenames]
 
     # Validate
-    validator = ::Nanoc3::Extra::Validators::W3C.new(site, :css)
+    validator = ::Nanoc3::Extra::Validators::Links.new(dir, index_filenames, :internal => true, :external => true)
     validator.run
   end
 

data/lib/nanoc3.rb

@@ -3,13 +3,13 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.1.0a2'
+  VERSION = '3.1.0a3'
 
   # 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.
+  # rubygems isn’t loaded.
   def self.load_plugins
     # Don’t load if there’s no rubygems
     return false if !defined?(Gem)

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
-  version: 3.1.0a2
+  prerelease: true
+  segments: 
+  - 3
+  - 1
+  - 0a3
+  version: 3.1.0a3
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,19 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-20 00:00:00 +01:00
+date: 2010-02-28 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 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: denis.defreyne@stoneship.org
 executables: 
@@ -44,7 +53,6 @@ files:
 - lib/nanoc3/base/compiler_dsl.rb
 - lib/nanoc3/base/context.rb
 - lib/nanoc3/base/core_ext/array.rb
-- lib/nanoc3/base/core_ext/enumerable.rb
 - lib/nanoc3/base/core_ext/hash.rb
 - lib/nanoc3/base/core_ext/string.rb
 - lib/nanoc3/base/core_ext.rb
@@ -158,7 +166,7 @@ post_install_message: |
   ------------------------------------------------------------------------------
 
 rdoc_options: 
-- --readme
+- --main
 - README.md
 require_paths: 
 - lib
@@ -166,18 +174,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
       version: 1.3.1
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: a web publishing system written in Ruby for building small to medium-sized websites.

data/lib/nanoc3/base/core_ext/enumerable.rb

@@ -1,41 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::EnumerableExtensions
-
-  module GroupBy
-
-    # Returns a hash, which keys are evaluated result from the block, and
-    # values are arrays of elements in enum corresponding to the key. This
-    # method is provided for backward compatibility with Ruby 1.8.6 and lower,
-    # since {#group_by} is only available in 1.8.7 and higher.
-    #
-    # @yieldparam [Object] obj The object to classify
-    #
-    # @return [Hash]
-    #
-    # @example Grouping integers by rest by division through 3
-    #
-    #   (1..6).group_by { |i| i % 3 }
-    #   # => { 0 => [3, 6], 1 => [1, 4], 2 => [2, 5] }
-    def group_by
-      groups = {}
-      each do |item|
-        key = yield(item)
-
-        groups[key] ||= []
-        groups[key] << item
-      end
-      groups
-    end
-
-  end
-
-end
-
-module Enumerable
-
-  if !Enumerable.instance_methods.include?('group_by')
-    include Nanoc3::EnumerableExtensions::GroupBy
-  end
-
-end