nanoc3 3.1.0a3 → 3.1.0b1

data/NEWS.md

@@ -2,17 +2,17 @@
 
 ## 3.1
 
-* An `Item#rep(name)` function for quickly getting a certain rep
+* An `Item#rep_named(name)` function for quickly getting a certain rep
 * An `Item#compiled_content` function for quickly getting compiled content
 * An `Item#path` function for quickly getting the path of an item rep
 * A new “+” wildcard in rule patterns that matches one or more characters
 * A `view` command that starts a web server in the output directory
 * A `debug` command that shows information about the items, reps and layouts
 * A `kramdown` filter ([kramdown site](http://kramdown.rubyforge.org/))
-* A plugin-loading system
 * A diff between the previously compiled content and the last compiled content
   is now written to `output.diff`
 * Assigns, such as `@items`, `@layouts`, `@item`, … are accessible without `@`
+* Support for binary items
 
 Changed:
 

data/lib/nanoc3.rb

@@ -3,27 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  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.
-  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
+  VERSION = '3.1.0b1'
 
 end
 
@@ -37,6 +17,3 @@ require 'nanoc3/extra'
 require 'nanoc3/data_sources'
 require 'nanoc3/filters'
 require 'nanoc3/helpers'
-
-# Load plugins
-Nanoc3.load_plugins

data/lib/nanoc3/base/compiler.rb

@@ -74,7 +74,7 @@ module Nanoc3
       if params.has_key?(:force) && params[:force]
         reps.each { |r| r.force_outdated = true }
       else
-        dependency_tracker.mark_outdated_items
+        dependency_tracker.propagate_outdatedness
       end
       forget_dependencies_if_outdated(items)
 

data/lib/nanoc3/base/dependency_tracker.rb

@@ -202,7 +202,7 @@ module Nanoc3
     # indirectly) depend on an outdated item as outdated.
     #
     # @return [void]
-    def mark_outdated_items
+    def propagate_outdatedness
       # Unmark everything
       @items.each { |i| i.outdated_due_to_dependencies = false }
 
@@ -215,11 +215,19 @@ module Nanoc3
         i.outdated_due_to_dependencies = true
       end
 
-      # For each outdated item...
-      @items.select { |i| i.outdated? }.each do |outdated_item|
-        # ... mark all its successors as outdated
-        self.successors_of(outdated_item).each do |i|
-          i.outdated_due_to_dependencies = true
+      # Mark successors of outdated items as outdated
+      require 'set'
+      processed   = Set.new
+      unprocessed = @items.select { |i| i.outdated? }
+      until unprocessed.empty?
+        item = unprocessed.shift
+        processed << item
+
+        self.direct_successors_of(item).each do |successor|
+          next if successor.outdated? || processed.include?(successor)
+
+          successor.outdated_due_to_dependencies = true
+          unprocessed << successor
         end
       end
     end
@@ -254,6 +262,11 @@ module Nanoc3
       end
     end
 
+    # @deprecated Use {#propagate_outdatedness} instead.
+    def mark_outdated_items
+      propagate_outdatedness
+    end
+
   private
 
     # Returns the item with the given identifier, or nil if no item is found.

data/lib/nanoc3/base/directed_graph.rb

@@ -35,6 +35,10 @@ module Nanoc3
 
     # A square matrix that contains boolean values. It is used as an adjacency
     # matrix by the {Nanoc3::DirectedGraph} class.
+    #
+    # 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 SquareBooleanMatrix
 
       # Creates a new matrix with the given number of rows/columns.
@@ -113,6 +117,8 @@ module Nanoc3
     # Creates a new directed graph with the given vertices.
     def initialize(vertices)
       @vertices = vertices
+      generate_indices
+      invalidate_successor_predecessor_cache
 
       @matrix = SquareBooleanMatrix.new(@vertices.size)
     end
@@ -126,6 +132,7 @@ module Nanoc3
     def add_edge(from, to)
       from_index, to_index = indices_of(from, to)
       @matrix[from_index, to_index] = true
+      invalidate_successor_predecessor_cache
     end
 
     # Removes the edge from the first vertex to the second vertex. If the
@@ -138,6 +145,7 @@ module Nanoc3
     def remove_edge(from, to)
       from_index, to_index = indices_of(from, to)
       @matrix[from_index, to_index] = false
+      invalidate_successor_predecessor_cache
     end
 
     # Returns the direct predecessors of the given vertex, i.e. the vertices
@@ -147,9 +155,11 @@ module Nanoc3
     #
     # @return [Array] Direct predecessors of the given vertex
     def direct_predecessors_of(to)
-      @vertices.select do |from|
-        from_index, to_index = indices_of(from, to)
-        @matrix[from_index, to_index] == true
+      @direct_predecessors[to] ||= begin
+        @vertices.select do |from|
+          from_index, to_index = indices_of(from, to)
+          @matrix[from_index, to_index] == true
+        end
       end
     end
 
@@ -160,9 +170,11 @@ module Nanoc3
     #
     # @return [Array] Direct successors of the given vertex
     def direct_successors_of(from)
-      @vertices.select do |to|
-        from_index, to_index = indices_of(from, to)
-        @matrix[from_index, to_index] == true
+      @direct_successors[from] ||= begin
+        @vertices.select do |to|
+          from_index, to_index = indices_of(from, to)
+          @matrix[from_index, to_index] == true
+        end
       end
     end
 
@@ -173,7 +185,7 @@ module Nanoc3
     #
     # @return [Array] Predecessors of the given vertex
     def predecessors_of(to)
-      recursively_find_vertices(to, :direct_predecessors_of)
+      @predecessors[to] ||= recursively_find_vertices(to, :direct_predecessors_of)
     end
 
     # Returns the successors of the given vertex, i.e. the vertices y for
@@ -183,7 +195,7 @@ module Nanoc3
     #
     # @return [Array] Successors of the given vertex
     def successors_of(from)
-      recursively_find_vertices(from, :direct_successors_of)
+      @successors[from] ||= recursively_find_vertices(from, :direct_successors_of)
     end
 
     # Returns an array of tuples representing the edges. The result of this
@@ -215,10 +227,27 @@ module Nanoc3
 
   private
 
+    # Generates vertex-to-index mapping
+    def generate_indices
+      @indices = {}
+      @vertices.each_with_index do |v, i|
+        @indices[v] = i
+      end
+    end
+
+    # Invalidates the cache that contains successors and predecessors (both
+    # direct and indirect).
+    def invalidate_successor_predecessor_cache
+      @successors          = {}
+      @direct_successors   = {}
+      @predecessors        = {}
+      @direct_predecessors = {}
+    end
+
     # Returns an array of indices for the given vertices. Raises an error if
     # one or more given objects are not vertices.
     def indices_of(*vertices)
-      vertices.map { |v| @vertices.index(v) or raise RuntimeError, "#{v.inspect} not a vertex" }
+      vertices.map { |v| @indices[v] or raise RuntimeError, "#{v.inspect} not a vertex" }
     end
 
     # Recursively finds vertices, starting at the vertex start, using the

data/lib/nanoc3/base/errors.rb

@@ -149,6 +149,8 @@ module Nanoc3
 
     end
 
+    # Error that is raised when a textual filter is attempted to be applied to
+    # a binary item representation.
     class CannotUseTextualFilter < Generic
 
       # @param [Nanoc3::ItemRep] rep The item representation that was
@@ -161,6 +163,8 @@ module Nanoc3
 
     end
 
+    # Error that is raised when a binary filter is attempted to be applied to
+    # a textual item representation.
     class CannotUseBinaryFilter < Generic
 
       # @param [Nanoc3::ItemRep] rep The item representation that was

data/lib/nanoc3/base/filter.rb

@@ -41,18 +41,40 @@ module Nanoc3
 
     class << self
 
-      # Sets the new type for the filter (`:binary` or `:text`).
+      # Sets the new type for the filter. The type can be `:binary` (default)
+      # or `:text`. The given argument can either be a symbol indicating both
+      # “from” and “to” types, or a hash where the only key is the “from” type
+      # and the only value is the “to” type.
       #
-      # @param [Symbol] arg The new type of this filter
+      # @example Specifying a text-to-text filter
+      #
+      #     type :text
+      #
+      # @example Specifying a text-to-binary filter
+      #
+      #     type :text => :binary
+      #
+      # @param [Symbol, Hash] arg The new type of this filter
       #
       # @return [void]
       def type(arg)
-        @type = arg
+        if arg.is_a?(Hash)
+          @from, @to = arg.keys[0], arg.values[0]
+        else
+          @from, @to = arg, arg
+        end
+      end
+
+      # @return [Boolean] True if this filter can be applied to binary item
+      # representations, false otherwise
+      def from_binary?
+        (@from || :text) == :binary
       end
 
-      # @return [Boolean] True if this is a binary filter, false otherwise
-      def binary?
-        (@type || :text) == :binary
+      # @return [Boolean] True if this filter results in a binary item
+      # representation, false otherwise
+      def to_binary?
+        (@to || :text) == :binary
       end
 
     end

data/lib/nanoc3/base/item.rb

@@ -77,7 +77,7 @@ module Nanoc3
       end
 
       # Get type and raw content or raw filename
-      @is_binary = params.has_key?(:binary) ? params[:binary] : true
+      @is_binary = params.has_key?(:binary) ? params[:binary] : false
       if @is_binary
         @raw_filename = raw_content_or_raw_filename
       else

data/lib/nanoc3/base/item_rep.rb

@@ -30,6 +30,10 @@ module Nanoc3
     # of the `--force` commandline option); false otherwise
     attr_accessor :force_outdated
 
+    # @return [Boolean] true if this rep is currently binary; false otherwise
+    attr_reader :binary
+    alias_method :binary?, :binary
+
     # @return [Boolean] true if this rep’s output file has changed since the
     # last time it was compiled; false otherwise
     attr_accessor :modified
@@ -70,21 +74,26 @@ module Nanoc3
     # @param [Symbol] name The unique name for the new item representation.
     def initialize(item, name)
       # Set primary attributes
-      @item = item
-      @name = name
+      @item   = item
+      @name   = name
+
+      # Set binary
+      @binary = @item.binary?
 
       # Initialize content and filenames
-      if @item.binary?
+      if self.binary?
         @filenames = {
           :raw  => @item.raw_filename,
           :last => @item.raw_filename
         }
+        @content = {}
       else
         @content = {
           :raw  => @item.raw_content,
           :last => @item.raw_content,
           :pre  => @item.raw_content
         }
+        @filenames = {}
       end
       @old_content = nil
 
@@ -139,7 +148,7 @@ module Nanoc3
     # @return [Hash] The assignments that should be available when compiling
     # the content.
     def assigns
-      if item.binary?
+      if self.binary?
         content_or_filename_assigns = { :filename => @filenames[:last] }
       else
         content_or_filename_assigns = { :content => @content[:last] }
@@ -165,12 +174,6 @@ module Nanoc3
     # @return [String] The compiled content at the given snapshot (or the
     # default snapshot if no snapshot is specified)
     def compiled_content(params={})
-      # Check whether content can be fetched
-      # TODO get proper exception
-      if @item.binary?
-        raise RuntimeError, "attempted to fetch compiled content from a binary item"
-      end
-
       # Notify
       Nanoc3::NotificationCenter.post(:visit_started, self.item)
       Nanoc3::NotificationCenter.post(:visit_ended,   self.item)
@@ -213,30 +216,40 @@ module Nanoc3
     #
     # @return [void]
     def filter(filter_name, filter_args={})
-      # Create filter
-      klass = Nanoc3::Filter.named(filter_name)
+      # Get filter class
+      klass = filter_named(filter_name)
       raise Nanoc3::Errors::UnknownFilter.new(filter_name) if klass.nil?
-      filter = klass.new(assigns)
 
       # Check whether filter can be applied
-      if klass.binary? && !item.binary?
+      if klass.from_binary? && !self.binary?
         raise Nanoc3::Errors::CannotUseBinaryFilter.new(self, klass)
-      elsif !klass.binary? && item.binary?
+      elsif !klass.from_binary? && self.binary?
         raise Nanoc3::Errors::CannotUseTextualFilter.new(self, klass)
       end
 
+      # Create filter
+      filter = klass.new(assigns)
+
       # Run filter
       Nanoc3::NotificationCenter.post(:filtering_started, self, filter_name)
-      if item.binary?
-        filter.run(@filenames[:last], filter_args)
+      source = self.binary? ? @filenames[:last] : @content[:last]
+      result = filter.run(source, filter_args)
+      if klass.to_binary?
         @filenames[:last] = filter.output_filename
       else
-        @content[:last] = filter.run(@content[:last], filter_args)
+        @content[:last] = result
       end
+      @binary = klass.to_binary?
       Nanoc3::NotificationCenter.post(:filtering_ended, self, filter_name)
 
+      # Check whether file was written
+      if self.binary? && !File.file?(filter.output_filename)
+        raise RuntimeError,
+          "The #{filter_name.inspect} filter did not write anything to the required output file, #{filter.output_filename}."
+      end
+
       # Create snapshot
-      snapshot(@content[:post] ? :post : :pre) unless item.binary?
+      snapshot(@content[:post] ? :post : :pre) unless self.binary?
     end
 
     # Lays out the item using the given layout. This method will replace the
@@ -252,7 +265,7 @@ module Nanoc3
     # @return [void]
     def layout(layout_identifier)
       # Check whether item can be laid out
-      raise Nanoc3::Errors::CannotLayoutBinaryItem.new(self) if item.binary?
+      raise Nanoc3::Errors::CannotLayoutBinaryItem.new(self) if self.binary?
 
       # Create "pre" snapshot
       snapshot(:pre) unless @content[:pre]
@@ -278,7 +291,7 @@ module Nanoc3
     #
     # @return [void]
     def snapshot(snapshot_name)
-      target = @item.binary? ? @filenames : @content
+      target = self.binary? ? @filenames : @content
       target[snapshot_name] = target[:last]
     end
 
@@ -295,7 +308,7 @@ module Nanoc3
       # Check if file will be created
       @created = !File.file?(self.raw_path)
 
-      if @item.binary?
+      if self.binary?
         # Calculate hash of old content
         if File.file?(self.raw_path)
           hash_old = hash(self.raw_path)
@@ -335,7 +348,7 @@ module Nanoc3
     def diff
       # Check if content can be diffed
       # TODO allow binary diffs
-      return nil if @item.binary?
+      return nil if self.binary?
 
       # Check if old content exists
       if @old_content.nil? or self.raw_path.nil?
@@ -346,11 +359,15 @@ module Nanoc3
     end
 
     def inspect
-      "<#{self.class}:0x#{self.object_id.to_s(16)} name=#{self.name} item.identifier=#{self.item.identifier} item.binary?=#{@item.binary?}>"
+      "<#{self.class}:0x#{self.object_id.to_s(16)} name=#{self.name} binary=#{self.binary?} item.identifier=#{self.item.identifier}>"
     end
 
   private
 
+    def filter_named(name)
+      Nanoc3::Filter.named(name)
+    end
+
     def layout_with_identifier(layout_identifier)
       layout ||= @item.site.layouts.find { |l| l.identifier == layout_identifier.cleaned_identifier }
       raise Nanoc3::Errors::UnknownLayout.new(layout_identifier) if layout.nil?
@@ -382,17 +399,18 @@ module Nanoc3
       require 'open3'
 
       # Create files
-      old_file = Tempfile.new('old')
-      new_file = Tempfile.new('new')
-
-      # Write files
-      old_file.write(a)
-      new_file.write(b)
-
-      # Diff
-      stdin, stdout, stderr = Open3.popen3('diff', '-u', old_file.path, new_file.path)
-      result = stdout.read
-      result == '' ? nil : result
+      Tempfile.open('old') do |old_file|
+        Tempfile.open('new') do |new_file|
+          # Write files
+          old_file.write(a)
+          new_file.write(b)
+
+          # Diff
+          stdin, stdout, stderr = Open3.popen3('diff', '-u', old_file.path, new_file.path)
+          result = stdout.read
+          result == '' ? nil : result
+        end
+      end
     rescue Errno::ENOENT
       warn 'Failed to run `diff`, so no diff with the previously compiled ' \
            'content will be available.'

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 less markdown md sass txt ),
+      :text_extensions => %w( css erb haml htm html js less markdown md php rb sass txt ),
       :output_dir      => 'output',
       :data_sources    => [ {} ],
       :index_filenames => [ 'index.html' ]

data/lib/nanoc3/extra/validators/links.rb

@@ -153,6 +153,9 @@ 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)

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -16,11 +16,15 @@ module Nanoc3::Filters
 
       # Colorize
       doc = Nokogiri::HTML.fragment(content)
-      doc.css('pre > code[class^="lang"]').each do |element|
-        language = element['class'][/lang-([^ ]+)/].sub(/^lang-/, '')
-        element.parent.replace(
-          Nokogiri.make(highlight(element.inner_text, language, params))
-        )
+      doc.css('pre > code[class*="language-"]').each do |element|
+        # Get language
+        match = element['class'].match(/(^| )language-([^ ]+)/)
+        next if match.nil?
+        language = match[2]
+
+        # Highlight
+        highlighted_code = highlight(element.inner_text, language, params)
+        element.inner_html = highlighted_code
       end
 
       doc.to_s
@@ -33,7 +37,7 @@ module Nanoc3::Filters
     def highlight(code, language, params={})
       colorizer = @colorizers[language]
       if KNOWN_COLORIZERS.include?(colorizer)
-        send(colorizer, code, language, params[colorizer])
+        send(colorizer, code, language, params[colorizer] || {})
       else
         raise RuntimeError, "I don’t know how to highlight code using the “#{colorizer}” colorizer"
       end
@@ -42,7 +46,7 @@ module Nanoc3::Filters
     def coderay(code, language, params={})
       require 'coderay'
 
-      CodeRay.scan(code, language).div(params)
+      ::CodeRay.scan(code, language).html(params)
     end
 
     def dummy(code, language, params={})

data/lib/nanoc3/helpers/blogging.rb

@@ -226,8 +226,8 @@ module Nanoc3::Helpers
             # Add dates
             create_time = a[:created_at]
             update_time = a[:updated_at] || a[:created_at]
-            xml.published ((create_time.is_a?(String) ? Time.parse(create_time) : create_time).to_iso8601_time)
-            xml.updated   ((update_time.is_a?(String) ? Time.parse(update_time) : update_time).to_iso8601_time)
+            xml.published((create_time.is_a?(String) ? Time.parse(create_time) : create_time).to_iso8601_time)
+            xml.updated(  (update_time.is_a?(String) ? Time.parse(update_time) : update_time).to_iso8601_time)
 
             # Add link
             xml.link(:rel => 'alternate', :href => url)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 1
-  - 0a3
-  version: 3.1.0a3
+  - 0b1
+  version: 3.1.0b1
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 +01:00
+date: 2010-03-07 00:00:00 +01:00
 default_executable: nanoc3
 dependencies: 
 - !ruby/object:Gem::Dependency