nanoc 3.4.3 → 3.5.0b1

data/lib/nanoc/extra/validators/w3c.rb

@@ -2,92 +2,24 @@
 
 module Nanoc::Extra::Validators
 
-  # A validator that uses the W3C web service to validate HTML and CSS files.
+  # @deprecated Use the Checking API or the `check` command instead
   class W3C
 
-    # @param [String] dir The directory that will be searched for HTML and/or
-    #   CSS files to validate
-    #
-    # @param [Array<Symbol>] types A list of types to check. Allowed types are
-    #   `:html` and `:css`.
     def initialize(dir, types)
       @dir   = dir
       @types = types
     end
 
-    # Starts the validator. The results will be printed to stdout.
-    #
-    # @return [void]
     def run
-      # Load validator
-      require 'w3c_validators'
-
-      # Find all files
-      filenames = []
-      extensions = types_to_extensions(@types)
-      extensions.each { |extension| filenames.concat(Dir[@dir + '/**/*.' + extension]) }
-
-      # Validate each file
-      filenames.each do |filename|
-        validation_started(filename)
-
-        extension = File.extname(filename)[1..-1]
-        results = validator_for(extension).validate_file(filename)
-
-        validation_ended(filename, results.errors)
-      end
-    end
-
-  private
-
-    # Returns all extensions for the given types
-    def types_to_extensions(types)
-      extensions = []
-      types.each { |type| extensions.concat(type_to_extensions(type)) }
-      extensions
-    end
-
-    # Returns all extensions for the given type
-    def type_to_extensions(type)
-      case type
-        when :html
-          [ 'html', 'htm' ]
-        when :css
-          [ 'css' ]
-        else
-          raise RuntimeError, "unknown type: #{type}"
+      args = []
+      types = @types.dup
+      args << 'html' if types.delete(:html)
+      args << 'css'  if types.delete(:css)
+      unless types.empty?
+        raise Nanoc::Errors::GenericTrivial, "unknown type(s) specified: #{types.join(', ')}"
       end
-    end
-
-    # Returns the validator class for the given extension
-    def validator_class_for(extension)
-      case extension
-      when 'html', 'htm'
-        ::W3CValidators::MarkupValidator
-      when 'css'
-        ::W3CValidators::CSSValidator
-      else
-        raise RuntimeError, "unknown extension: #{extension}"
-      end
-    end
-
-    # Returns the validator for the given extension
-    def validator_for(extension)
-      @validators ||= {}
-      @validators[extension] ||= validator_class_for(extension).new
-    end
-
-    def validation_started(file)
-      $stdout.print "Validating #{file}... "
-      $stdout.flush
-    end
 
-    def validation_ended(file, errors)
-      $stdout.puts(errors.empty? ? "valid" : "INVALID")
-
-      errors.each do |err|
-        puts "    #{err}"
-      end
+      Nanoc::CLI.run([ 'check', args ].flatten)
     end
 
   end

data/lib/nanoc/filters/colorize_syntax.rb

@@ -117,7 +117,7 @@ module Nanoc::Filters
           has_class = true if language
         else
           # Get language from comment line
-          match = element.inner_text.match(/^#!([^\/][^\n]*)$/)
+          match = element.inner_text.strip.split[0].match(/^#!([^\/][^\n]*)$/)
           language = match[1] if match
           element.content = element.content.sub(/^#!([^\/][^\n]*)$\n/, '') if language
         end

data/lib/nanoc/filters/handlebars.rb

@@ -9,8 +9,8 @@ module Nanoc::Filters
 
     # Runs the content through
     # [Handlebars](http://handlebarsjs.com/) using
-	  # [Handlebars.rb](https://github.com/cowboyd/handlebars.rb).
-	  # This method takes no options.
+    # [Handlebars.rb](https://github.com/cowboyd/handlebars.rb).
+    # This method takes no options.
     #
     # @param [String] content The content to filter
     #

data/lib/nanoc/filters/less.rb

@@ -46,7 +46,7 @@ module Nanoc::Filters
       # Add filename to load path
       paths = [ File.dirname(@item[:content_filename]) ]
       parser = ::Less::Parser.new(:paths => paths)
-      parser.parse(content).to_css
+      parser.parse(content).to_css params
     end
 
   end

data/lib/nanoc/filters/redcarpet.rb

@@ -7,7 +7,7 @@ module Nanoc::Filters
   # @since 3.2.0
   class Redcarpet < Nanoc::Filter
 
-    # Runs the content through [Redcarpet](https://github.com/tanoku/redcarpet/).
+    # Runs the content through [Redcarpet](https://github.com/vmg/redcarpet).
     # This method optionally takes processing options to pass on to Redcarpet.
     #
     # @overload run(content, params={})

data/lib/nanoc/filters/rubypants.rb

@@ -5,7 +5,7 @@ require 'rubypants'
 module Nanoc::Filters
   class RubyPants < Nanoc::Filter
 
-    # Runs the content through [RubyPants](http://chneukirchen.org/blog/static/projects/rubypants.html).
+    # Runs the content through [RubyPants](http://rubydoc.info/gems/rubypants/).
     # This method takes no options.
     #
     # @param [String] content The content to filter

data/lib/nanoc/filters/slim.rb

@@ -7,7 +7,7 @@ module Nanoc::Filters
   # @since 3.2.0
   class Slim < Nanoc::Filter
 
-    # Runs the content through [Slim](http://slim-lang.com/)
+    # Runs the content through [Slim](http://slim-lang.com/).
     # This method takes no options.
     #
     # @param [String] content The content to filter

data/lib/nanoc/helpers/blogging.rb

@@ -42,6 +42,146 @@ module Nanoc::Helpers
       end.reverse
     end
 
+    class AtomFeedBuilder
+
+      include Nanoc::Helpers::Blogging
+
+      attr_accessor :site
+
+      attr_accessor :limit
+      attr_accessor :relevant_articles
+      attr_accessor :content_proc
+      attr_accessor :excerpt_proc
+      attr_accessor :title
+      attr_accessor :author_name
+      attr_accessor :author_uri
+      attr_accessor :icon
+      attr_accessor :logo
+
+      def initialize(site, item)
+        @site = site
+        @item = item
+      end
+
+      def validate
+        self.validate_config
+        self.validate_feed_item
+        self.validate_articles
+      end
+
+      def build
+        buffer = ''
+        xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
+        self.build_for_feed(xml)
+        buffer
+      end
+
+    protected
+
+      def sorted_relevant_articles
+        relevant_articles.sort_by do |a|
+          attribute_to_time(a[:created_at])
+        end.reverse.first(limit)
+      end
+
+      def last_article
+        sorted_relevant_articles.first
+      end
+
+      def validate_config
+        if @site.config[:base_url].nil?
+          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
+        end
+      end
+
+      def validate_feed_item
+        if title.nil?
+          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no title in params, item or site config')
+        end
+        if author_name.nil?
+          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no author_name in params, item or site config')
+        end
+        if author_uri.nil?
+          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no author_uri in params, item or site config')
+        end
+      end
+
+      def validate_articles
+        if relevant_articles.empty?
+          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: no articles')
+        end
+        if relevant_articles.any? { |a| a[:created_at].nil? }
+          raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: one or more articles lack created_at')
+        end
+      end
+
+      def build_for_feed(xml)
+        xml.instruct!
+        xml.feed(:xmlns => 'http://www.w3.org/2005/Atom') do
+          root_url = @site.config[:base_url] + '/'
+
+          # Add primary attributes
+          xml.id      root_url
+          xml.title   title
+
+          # Add date
+          xml.updated(attribute_to_time(last_article[:created_at]).to_iso8601_time)
+
+          # Add links
+          xml.link(:rel => 'alternate', :href => root_url)
+          xml.link(:rel => 'self',      :href => feed_url)
+
+          # Add author information
+          xml.author do
+            xml.name  author_name
+            xml.uri   author_uri
+          end
+
+          # Add icon and logo
+          xml.icon icon if icon
+          xml.logo logo if logo
+
+          # Add articles
+          sorted_relevant_articles.each do |a|
+            self.build_for_article(a, xml)
+          end
+        end
+      end
+
+      def build_for_article(a, xml)
+        # Get URL
+        url = url_for(a)
+        return if url.nil?
+
+        xml.entry do
+          # Add primary attributes
+          xml.id        atom_tag_for(a)
+          xml.title     a[:title], :type => 'html'
+
+          # Add dates
+          xml.published attribute_to_time(a[:created_at]).to_iso8601_time
+          xml.updated   attribute_to_time(a[:updated_at] || a[:created_at]).to_iso8601_time
+
+          # Add specific author information
+          if a[:author_name] || a[:author_uri]
+            xml.author do
+              xml.name  a[:author_name] || author_name
+              xml.uri   a[:author_uri]  || author_uri
+            end
+          end
+
+          # Add link
+          xml.link(:rel => 'alternate', :href => url)
+
+          # Add content
+          summary = excerpt_proc.call(a)
+          xml.content   content_proc.call(a), :type => 'html'
+          xml.summary   summary, :type => 'html' unless summary.nil?
+        end
+      end
+
+    end
+
     # Returns a string representing the atom feed containing recent articles,
     # sorted by descending creation date.
     #
@@ -83,7 +223,7 @@ module Nanoc::Helpers
     # The feed item will need to know about the feed title, the feed author
     # name, and the URI corresponding to the author. These can be specified
     # using parameters, as attributes in the feed item, or in the site
-    # configuration.   
+    # configuration.
     #
     # * `title` - The title of the feed, which is usually also the title of
     #   the blog.
@@ -144,112 +284,31 @@ module Nanoc::Helpers
     # @option params [String] :author_uri The URI of the feed's author, if it
     #   is not given in the item attributes.
     #
+    # @option params [String] :icon The URI of the feed's icon.
+    #
+    # @option params [String] :logo The URI of the feed's logo.
+    #
     # @return [String] The generated feed content
     def atom_feed(params={})
       require 'builder'
 
-      # Extract parameters
-      limit             = params[:limit] || 5
-      relevant_articles = params[:articles] || articles || []
-      content_proc      = params[:content_proc] || lambda { |a| a.compiled_content(:snapshot => :pre) }
-      excerpt_proc      = params[:excerpt_proc] || lambda { |a| a[:excerpt] }
-
-      # Check config attributes
-      if @site.config[:base_url].nil?
-        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
-      end
-
-      # Check feed item attributes
-      title = params[:title] || @item[:title] || @site.config[:title]
-      if title.nil?
-        raise RuntimeError.new('Cannot build Atom feed: no title in params, item or site config')
-      end
-      author_name = params[:author_name] || @item[:author_name] || @site.config[:author_name]
-      if author_name.nil?
-        raise RuntimeError.new('Cannot build Atom feed: no author_name in params, item or site config')
-      end
-      author_uri = params[:author_uri] || @item[:author_uri] || @site.config[:author_uri]
-      if author_uri.nil?
-        raise RuntimeError.new('Cannot build Atom feed: no author_uri in params, item or site config')
-      end
-
-      # Check article attributes
-      if relevant_articles.empty?
-        raise RuntimeError.new('Cannot build Atom feed: no articles')
-      end
-      if relevant_articles.any? { |a| a[:created_at].nil? }
-        raise RuntimeError.new('Cannot build Atom feed: one or more articles lack created_at')
-      end
-
-      # Get sorted relevant articles
-      sorted_relevant_articles = relevant_articles.sort_by do |a|
-        attribute_to_time(a[:created_at])
-      end.reverse.first(limit)
-
-      # Get most recent article
-      last_article = sorted_relevant_articles.first
-
       # Create builder
-      buffer = ''
-      xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
-
-      # Build feed
-      xml.instruct!
-      xml.feed(:xmlns => 'http://www.w3.org/2005/Atom') do
-        root_url = @site.config[:base_url] + '/'
-
-        # Add primary attributes
-        xml.id      root_url
-        xml.title   title
-
-        # Add date
-        xml.updated(attribute_to_time(last_article[:created_at]).to_iso8601_time)
-
-        # Add links
-        xml.link(:rel => 'alternate', :href => root_url)
-        xml.link(:rel => 'self',      :href => feed_url)
-
-        # Add author information
-        xml.author do
-          xml.name  author_name
-          xml.uri   author_uri
-        end
-
-        # Add articles
-        sorted_relevant_articles.each do |a|
-          # Get URL
-          url = url_for(a)
-          next if url.nil?
-
-          xml.entry do
-            # Add primary attributes
-            xml.id        atom_tag_for(a)
-            xml.title     a[:title], :type => 'html'
-
-            # Add dates
-            xml.published attribute_to_time(a[:created_at]).to_iso8601_time
-            xml.updated   attribute_to_time(a[:updated_at] || a[:created_at]).to_iso8601_time
-        
-            # Add specific author information
-            if a[:author_name] || a[:author_uri]
-              xml.author do
-                xml.name  a[:author_name] || author_name
-                xml.uri   a[:author_uri]  || author_uri
-              end
-            end
-
-            # Add link
-            xml.link(:rel => 'alternate', :href => url)
-
-            # Add content
-            summary = excerpt_proc.call(a)
-            xml.content   content_proc.call(a), :type => 'html'
-            xml.summary   summary, :type => 'html' unless summary.nil?
-          end
-        end
-      end
-
-      buffer
+      builder = AtomFeedBuilder.new(@site, @item)
+
+      # Fill builder
+      builder.limit             = params[:limit] || 5
+      builder.relevant_articles = params[:articles] || articles || []
+      builder.content_proc      = params[:content_proc] || lambda { |a| a.compiled_content(:snapshot => :pre) }
+      builder.excerpt_proc      = params[:excerpt_proc] || lambda { |a| a[:excerpt] }
+      builder.title             = params[:title] || @item[:title] || @site.config[:title]
+      builder.author_name       = params[:author_name] || @item[:author_name] || @site.config[:author_name]
+      builder.author_uri        = params[:author_uri] || @item[:author_uri] || @site.config[:author_uri]
+      builder.icon              = params[:icon]
+      builder.logo              = params[:logo]
+
+      # Run
+      builder.validate
+      builder.build
     end
 
     # Returns the URL for the given item. It will return the URL containing
@@ -261,7 +320,7 @@ module Nanoc::Helpers
     def url_for(item)
       # Check attributes
       if @site.config[:base_url].nil?
-        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
+        raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
       end
 
       # Build URL
@@ -281,7 +340,7 @@ module Nanoc::Helpers
     def feed_url
       # Check attributes
       if @site.config[:base_url].nil?
-        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
+        raise Nanoc::Errors::GenericTrivial.new('Cannot build Atom feed: site configuration has no base_url')
       end
 
       @item[:feed_url] || @site.config[:base_url] + @item.path