nanoc3 3.1.0b2 → 3.1.0rc1

data/lib/nanoc3/base/errors.rb

@@ -144,7 +144,7 @@ module Nanoc3
       # @param [Nanoc3::ItemRep] The item representation that was attempted to
       # be laid out
       def initialize(rep)
-        super("The “{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item.".make_compatible_with_env)
+        super("The “{rep.item.identifier}” item (rep “#{rep.name}”) cannot be laid out because it is a binary item. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.".make_compatible_with_env)
       end
 
     end
@@ -172,7 +172,7 @@ module Nanoc3
       #
       # @param [Class] filter_class The filter class that was used
       def initialize(rep, filter_class)
-        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items.".make_compatible_with_env)
+        super("The “#{filter_class.inspect}” filter cannot be used to filter the “#{rep.item.identifier}” item (rep “#{rep.name}”), because binary filters cannot be used on textual items. If you are getting this error for an item that should be textual instead of binary, make sure that its extension is included in the text_extensions array in the site configuration.".make_compatible_with_env)
       end
 
     end

data/lib/nanoc3/base/item_rep.rb

@@ -20,6 +20,20 @@ module Nanoc3
   # representation, and a symbol containing the filter class name).
   class ItemRep
 
+    # The descriptive strings for each outdatedness reason. This hash is used
+    # by the {#outdatedness_reason} method.
+    OUTDATEDNESS_REASON_DESCRIPTIONS = {
+      :no_mtime => 'No file modification time is available.',
+      :forced => 'All pages are recompiled because of a `--force` flag given to the compilation command.',
+      :no_raw_path => 'The routing rules do not specify a path where this item should be written to, i.e. the item representation will never be written to the output directory.',
+      :not_written => 'This item representation has not yet been written to the output directory (but it does have a path).',
+      :source_modified => 'The source file of this item has been modified since the last time this item representation was compiled.',
+      :layouts_outdated => 'The source of one or more layouts has been modified since the last time this item representation was compiled.',
+      :code_outdated => 'The code snippets in the `lib/` directory have been modified since the last time this item representation was compiled.',
+      :config_outdated => 'The site configuration has been modified since the last time this item representation was compiled.',
+      :rules_outdated => 'The rules file has been modified since the last time this item representation was compiled.',
+    }
+
     # @return [Nanoc3::Item] The item to which this rep belongs
     attr_reader   :item
 
@@ -105,44 +119,72 @@ module Nanoc3
       @force_outdated = false
     end
 
-    # @return [Boolean] true if this item rep's output file is outdated and
-    # must be regenerated, false otherwise
-    def outdated?
-      # Outdated if we don't know
-      return true if @item.mtime.nil?
-
-      # Outdated if the dependency tracker says so
-      return true if @force_outdated
+    # Calculates the reason why this item representation is outdated. The
+    # output will be a hash with a `:type` key, containing the reason why the
+    # item is outdated in the form of a symbol, and a `:description` key,
+    # containing a descriptive string that can be printed if necessary.
+    #
+    # For documentation on the types that this method can return, check the
+    # {OUTDATEDNESS_REASON_DESCRIPTIONS} hash in this class.
+    #
+    # @return [Hash, nil] A hash containing the reason why this item rep is
+    #   outdated, both in the form of a symbol and as a descriptive string, or
+    #   nil if the item representation is not outdated.
+    def outdatedness_reason
+      # Get reason symbol
+      reason = lambda do
+        # Outdated if we don't know
+        return :no_mtime if @item.mtime.nil?
+
+        # Outdated if the dependency tracker says so
+        return :forced if @force_outdated
+
+        # Outdated if compiled file doesn't exist (yet)
+        return :no_raw_path if self.raw_path.nil?
+        return :not_written if !File.file?(self.raw_path)
+
+        # Get compiled mtime
+        compiled_mtime = File.stat(self.raw_path).mtime
+
+        # Outdated if file too old
+        return :source_modified if @item.mtime > compiled_mtime
+
+        # Outdated if layouts outdated
+        return :layouts_outdated if @item.site.layouts.any? do |l|
+          l.mtime.nil? || l.mtime > compiled_mtime
+        end
 
-      # Outdated if compiled file doesn't exist
-      return true if self.raw_path.nil?
-      return true if !File.file?(self.raw_path)
+        # Outdated if code outdated
+        return :code_outdated if @item.site.code_snippets.any? do |cs|
+          cs.mtime.nil? || cs.mtime > compiled_mtime
+        end
 
-      # Get compiled mtime
-      compiled_mtime = File.stat(self.raw_path).mtime
+        # Outdated if config outdated
+        return :config_outdated if @item.site.config_mtime.nil?
+        return :config_outdated if @item.site.config_mtime > compiled_mtime
 
-      # Outdated if file too old
-      return true if @item.mtime > compiled_mtime
+        # Outdated if rules outdated
+        return :rules_outdated if @item.site.rules_mtime.nil?
+        return :rules_outdated if @item.site.rules_mtime > compiled_mtime
 
-      # Outdated if layouts outdated
-      return true if @item.site.layouts.any? do |l|
-        l.mtime.nil? || l.mtime > compiled_mtime
-      end
+        return nil
+      end[]
 
-      # Outdated if code outdated
-      return true if @item.site.code_snippets.any? do |cs|
-        cs.mtime.nil? || cs.mtime > compiled_mtime
+      # Build reason symbol and description
+      if reason.nil?
+        nil
+      else
+        {
+          :type        => reason,
+          :description => OUTDATEDNESS_REASON_DESCRIPTIONS[reason]
+        }
       end
+    end
 
-      # Outdated if config outdated
-      return true if @item.site.config_mtime.nil?
-      return true if @item.site.config_mtime > compiled_mtime
-
-      # Outdated if rules outdated
-      return true if @item.site.rules_mtime.nil?
-      return true if @item.site.rules_mtime > compiled_mtime
-
-      return false
+    # @return [Boolean] true if this item rep's output file is outdated and
+    # must be regenerated, false otherwise
+    def outdated?
+      !outdatedness_reason.nil?
     end
 
     # @return [Hash] The assignments that should be available when compiling
@@ -354,7 +396,7 @@ module Nanoc3
     # content in `diff(1)` format, or nil if there is no previous compiled
     # content
     def diff
-      # TODO allow binary diffs
+      return nil if !@item.site.config[:enable_output_diff]
 
       if self.binary?
         nil
@@ -409,10 +451,6 @@ module Nanoc3
     end
 
     def diff_strings(a, b)
-      # TODO Rewrite this string-diffing method in pure Ruby. It should not
-      # use the "diff" executable, because this will most likely not work on
-      # operating systems without it, such as Windows.
-
       require 'tempfile'
       require 'open3'
 

data/lib/nanoc3/base/site.rb

@@ -39,14 +39,20 @@ 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 js less markdown md php rb sass txt ),
-      :output_dir      => 'output',
-      :data_sources    => [ {} ],
-      :index_filenames => [ 'index.html' ]
+      :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' ],
+      :enable_output_diff => false
     }
 
     # The site configuration. The configuration has the following keys:
     #
+    # * `text_extensions` ({Array<String>}) - A list of file extensions that
+    #   will cause nanoc to threat the file as textual instead of binary. When
+    #   the data source finds a content file with an extension that is
+    #   included in this list, it will be marked as textual.
+    #
     # * `output_dir` ({String}) - The directory to which compiled items will
     #   be written. This path is relative to the current working directory,
     #   but can also be an absolute path.
@@ -60,6 +66,9 @@ module Nanoc3
     #   `/about/` will be used instead of `/about/index.html`). The default
     #   value should be okay in most cases.
     #
+    # * `enable_output_diff` ({Boolean}) - True when diffs should be generated
+    #   for the compiled content of this site; false otherwise.
+    #
     # The list of data sources consists of hashes with the following keys:
     #
     # * `:type` ({String}) - The type of data source, i.e. its identifier.

data/lib/nanoc3/cli/commands/create_site.rb

@@ -32,6 +32,11 @@ output_dir: #{Nanoc3::Site::DEFAULT_CONFIG[:output_dir]}
 # such as “default.htm”. This list is used by nanoc to generate pretty URLs.
 index_filenames: #{array_to_yaml(Nanoc3::Site::DEFAULT_CONFIG[:index_filenames])}
 
+# Whether or not to generate a diff of the compiled content when compiling a
+# site. The diff will contain the differences between the compiled content
+# before and after the last site compilation.
+enable_output_diff: false
+
 # The data sources where nanoc loads its data from. This is an array of
 # hashes; each array element represents a single data source. By default,
 # there is only a single data source that reads data from the “content/” and

data/lib/nanoc3/cli/commands/debug.rb

@@ -47,31 +47,45 @@ module Nanoc3::CLI::Commands
       dependency_tracker = @base.site.compiler.send(:dependency_tracker)
       dependency_tracker.load_graph
 
-      # Print items
-      puts '=== Items'
+      # Print item dependencies
+      puts '=== Item dependencies ======================================================='
       puts
-      row = 0
       items.sort_by { |i| i.identifier }.each do |item|
-        puts "item #{item.identifier}:"
-
-        # Print item dependencies
-        puts "  dependencies:"
+        puts "item #{item.identifier} depends on:"
         predecessors = dependency_tracker.direct_predecessors_of(item).sort_by { |i| i.identifier }
         predecessors.each do |pred|
-          puts "    #{pred.identifier}"
+          puts "  #{pred.identifier}"
         end
-        puts "    (nothing)" if predecessors.empty?
+        puts "  (nothing)" if predecessors.empty?
+        puts
+      end
 
-        # Print item representations
-        puts "  representations:"
+      # Print representation paths
+      puts '=== Representation paths ===================================================='
+      puts
+      items.sort_by { |i| i.identifier }.each do |item|
         item.reps.sort_by { |r| r.name.to_s }.each do |rep|
-          puts "    #{rep.name} -> #{rep.raw_path || '(not written)'}"
+          puts "item #{item.identifier}, rep #{rep.name}:"
+          puts "  #{rep.raw_path || '(not written)'}"
         end
-
-        # Done
         puts
       end
+
+      # Print representation outdatedness
+      puts '=== Representation outdatedness ============================================='
       puts
+      items.sort_by { |i| i.identifier }.each do |item|
+        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
+          puts "item #{item.identifier}, rep #{rep.name}:"
+          outdatedness_reason = rep.outdatedness_reason
+          if outdatedness_reason
+            puts "  is outdated: #{outdatedness_reason[:type]} (#{outdatedness_reason[:description]})"
+          else
+            puts "  is not outdated"
+          end
+        end
+        puts
+      end
 
       # Print layouts
       puts '=== Layouts'

data/lib/nanoc3/filters/sass.rb

@@ -12,11 +12,58 @@ module Nanoc3::Filters
     def run(content, params={})
       require 'sass'
 
+      # Add imported_filename read accessor to ImportNode
+      # … but… but… nex3 said I could monkey patch it! :(
+      methods = ::Sass::Tree::ImportNode.instance_methods
+      if !methods.include?(:import_filename) && !methods.include?('import_filename')
+        ::Sass::Tree::ImportNode.send(:attr_reader, :imported_filename)
+      end
+
       # Get options
       options = params.merge(:filename => filename)
 
-      # Get result
-      ::Sass::Engine.new(content, options).render
+      # Build engine
+      engine = ::Sass::Engine.new(content, options)
+
+      # Get import nodes
+      require 'set'
+      imported_nodes = []
+      unprocessed_nodes = Set.new([ engine.to_tree ])
+      until unprocessed_nodes.empty?
+        # Get an unprocessed node
+        node = unprocessed_nodes.each { |n| break n }
+        unprocessed_nodes.delete(node)
+
+        # Add to list of import nodes if necessary
+        imported_nodes << node if node.is_a?(::Sass::Tree::ImportNode)
+
+        # Mark children of this node for processing
+        node.children.each { |c| unprocessed_nodes << c }
+      end
+
+      # Get import paths
+      import_paths = (options[:load_paths] || []).dup
+      import_paths.unshift(File.dirname(options[:filename])) if options[:filename]
+
+      # Get imported filenames
+      imported_filenames = imported_nodes.map do |node|
+        ::Sass::Files.find_file_to_import(node.imported_filename, import_paths)
+      end
+
+      # Convert to items
+      imported_items = imported_filenames.map do |filename|
+        normalized_filename = Pathname.new(filename).realpath
+        @items.find { |i| Pathname.new(i[:filename]).realpath == normalized_filename }
+      end
+
+      # Require compilation of each item
+      imported_items.each do |item|
+        any_uncompiled_rep = item.reps.find { |r| !r.compiled? }
+        raise Nanoc3::Errors::UnmetDependency.new(any_uncompiled_rep) if any_uncompiled_rep
+      end
+
+      # Done
+      engine.render
     end
 
   end

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.1.0b2'
+  VERSION = '3.1.0rc1'
 
 end
 

metadata

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