nanoc3 3.0.6 → 3.0.7

data/NEWS.rdoc

@@ -1,5 +1,9 @@
 = nanoc News
 
+== 3.0.7
+
+* Fixed bug which could cause layout rules not be matched in order
+
 == 3.0.6
 
 * Error checking in `filesystem_combined` has been improved [Brian Candler]

data/lib/nanoc3/base/compiler.rb

@@ -30,7 +30,7 @@ module Nanoc3
 
       @item_compilation_rules  = []
       @item_routing_rules      = []
-      @layout_filter_mapping   = {}
+      @layout_filter_mapping   = OrderedHash.new
     end
 
     # Compiles (part of) the site and writes out the compiled item

data/lib/nanoc3/base/ordered_hash.rb

@@ -0,0 +1,200 @@
+
+# AUTHOR
+#    jan molic /mig/at/1984/dot/cz/
+#
+# DESCRIPTION
+#    Hash with preserved order and some array-like extensions
+#    Public domain. 
+#
+# THANKS
+#    Andrew Johnson for his suggestions and fixes of Hash[],
+#    merge, to_a, inspect and shift
+class OrderedHash < ::Hash
+    attr_accessor :order
+
+    class << self
+        def [] *args
+          hsh = OrderedHash.new
+          if Hash === args[0]
+            hsh.replace args[0]
+          elsif (args.size % 2) != 0
+            raise ArgumentError, "odd number of elements for Hash"
+          else
+            0.step(args.size - 1, 2) do |a|
+              b = a + 1
+              hsh[args[a]] = args[b]
+            end
+          end
+          hsh
+        end
+    end
+    def initialize(*a, &b)
+      super
+      @order = []
+    end
+    def store_only a,b
+        store a,b
+    end
+    alias orig_store store    
+    def store a,b
+        @order.push a unless has_key? a
+        super a,b
+    end
+    alias []= store
+    def == hsh2
+        return false if @order != hsh2.order
+        super hsh2
+    end
+    def clear
+        @order = []
+        super
+    end
+    def delete key
+        @order.delete key
+        super
+    end
+    def each_key
+        @order.each { |k| yield k }
+        self
+    end
+    def each_value
+        @order.each { |k| yield self[k] }
+        self
+    end
+    def each
+        @order.each { |k| yield k,self[k] }
+        self
+    end
+    alias each_pair each    
+    def delete_if
+        @order.clone.each { |k| 
+            delete k if yield(k)
+        }
+        self
+    end
+    def values
+        ary = []
+        @order.each { |k| ary.push self[k] }
+        ary
+    end
+    def keys
+        @order
+    end
+    def first
+      {@order.first => self[@order.first]}
+    end
+    def last
+      {@order.last => self[@order.last]}
+    end
+    def invert
+        hsh2 = Hash.new    
+        @order.each { |k| hsh2[self[k]] = k }
+        hsh2
+    end
+    def reject &block
+        self.dup.delete_if &block
+    end
+    def reject! &block
+        hsh2 = reject &block
+        self == hsh2 ? nil : hsh2
+    end
+    def replace hsh2
+        @order = hsh2.keys 
+        super hsh2
+    end
+    def shift
+        key = @order.first
+        key ? [key,delete(key)] : super
+    end
+    def unshift k,v
+        unless self.include? k
+            @order.unshift k
+            orig_store(k,v)
+            true
+        else
+            false
+        end
+    end
+    def push k,v
+        unless self.include? k
+            @order.push k
+            orig_store(k,v)
+            true
+        else
+            false
+        end
+    end
+    def pop
+        key = @order.last
+        key ? [key,delete(key)] : nil
+    end
+    def to_a
+        ary = []
+        each { |k,v| ary << [k,v] }
+        ary
+    end
+    def to_s
+        self.to_a.to_s
+    end
+    def inspect
+        ary = []
+        each {|k,v| ary << k.inspect + "=>" + v.inspect}
+        '{' + ary.join(", ") + '}'
+    end
+    def update hsh2
+        hsh2.each { |k,v| self[k] = v }
+        self
+    end
+    alias :merge! update
+    def merge hsh2
+        self.dup update(hsh2)
+    end
+    def select
+        ary = []
+        each { |k,v| ary << [k,v] if yield k,v }
+        ary
+    end
+    def class
+      Hash
+    end
+    def __class__
+      OrderedHash
+    end
+
+    attr_accessor "to_yaml_style"
+    def yaml_inline= bool
+      if respond_to?("to_yaml_style")
+        self.to_yaml_style = :inline
+      else
+        unless defined? @__yaml_inline_meth
+          @__yaml_inline_meth =
+            lambda {|opts|
+              YAML::quick_emit(object_id, opts) {|emitter|
+                emitter << '{ ' << map{|kv| kv.join ': '}.join(', ') << ' }'
+              }
+            }
+          class << self
+            def to_yaml opts = {}
+              begin
+                @__yaml_inline ? @__yaml_inline_meth[ opts ] : super
+              rescue
+                @to_yaml_style = :inline
+                super
+              end
+            end
+          end
+        end
+      end
+      @__yaml_inline = bool
+    end
+    def yaml_inline!() self.yaml_inline = true end
+
+    def each_with_index
+      @order.each_with_index { |k, index| yield k, self[k], index }
+      self
+    end
+end # class OrderedHash
+
+def OrderedHash(*a, &b)
+  OrderedHash.new(*a, &b)
+end

data/lib/nanoc3/base.rb

@@ -3,6 +3,7 @@
 module Nanoc3
 
   require 'nanoc3/base/core_ext'
+  require 'nanoc3/base/ordered_hash'
 
   autoload 'CodeSnippet',         'nanoc3/base/code_snippet'
   autoload 'Compiler',            'nanoc3/base/compiler'

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.0.6'
+  VERSION = '3.0.7'
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
-  version: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 +01:00
+date: 2010-01-30 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -35,7 +35,6 @@ files:
 - bin/nanoc3
 - lib/nanoc3/base/code_snippet.rb
 - lib/nanoc3/base/compiler.rb
-- lib/nanoc3/base/compiler.rb.orig
 - lib/nanoc3/base/compiler_dsl.rb
 - lib/nanoc3/base/core_ext/array.rb
 - lib/nanoc3/base/core_ext/hash.rb
@@ -49,6 +48,7 @@ files:
 - lib/nanoc3/base/item_rep.rb
 - 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/rule.rb
@@ -73,7 +73,6 @@ files:
 - 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/last_fm.rb.orig
 - lib/nanoc3/data_sources/twitter.rb
 - lib/nanoc3/data_sources.rb
 - lib/nanoc3/extra/auto_compiler.rb

data/lib/nanoc3/base/compiler.rb.orig

@@ -1,250 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3
-
-  # Nanoc3::Compiler is responsible for compiling a site's item
-  # representations.
-  class Compiler
-
-    # The compilation stack. When the compiler begins compiling a rep or a
-    # layout, it will be placed on the stack; when it is done compiling the
-    # rep or layout, it will be removed from the stack.
-    attr_reader :stack
-
-    # The list of compilation rules that will be used to compile items. This
-    # array will be filled by Nanoc3::Site#load_data.
-    attr_reader :item_compilation_rules
-
-    # The list of routing rules that will be used to give all items a path.
-    # This array will be filled by Nanoc3::Site#load_data.
-    attr_reader :item_routing_rules
-
-    # The hash containing layout-to-filter mapping rules.
-    attr_reader :layout_filter_mapping
-
-    # Creates a new compiler for the given site.
-    def initialize(site)
-      @site = site
-
-      @stack = []
-
-      @item_compilation_rules  = []
-      @item_routing_rules      = []
-      @layout_filter_mapping   = {}
-    end
-
-    # Compiles (part of) the site and writes out the compiled item
-    # representations.
-    #
-    # +items+:: The items that should be compiled, along with their
-    #           dependencies. Pass +nil+ if the entire site should be
-    #           compiled.
-    #
-    # This method also accepts a few optional parameters:
-    #
-    # +:force+:: true if the rep should be compiled even if it is not
-    #            outdated, false if not. Defaults to false.
-    def run(item=nil, params={})
-      # Create output directory if necessary
-      FileUtils.mkdir_p(@site.config[:output_dir])
-
-      # Load dependencies
-      dependency_tracker.load_graph
-      print_dependency_graph if $DEBUG
-
-      # Get items and reps to compile
-      if item
-        items = [ item ] + dependency_tracker.all_inverse_dependencies_for(item)
-        items.uniq!
-      else
-        items = @site.items
-      end
-      reps = items.map { |i| i.reps }.flatten
-
-      # Prepare dependencies
-      remember_old_dependencies
-      @old_dep_graph = dependency_tracker.instance_eval { @graph }.dup
-      mark_outdated_items(reps, params.has_key?(:force) && params[:force])
-      forget_dependencies_if_outdated(items)
-
-      # Compile reps
-      dependency_tracker.start
-      compile_reps(reps)
-      dependency_tracker.stop
-
-      # Store dependencies
-      dependency_tracker.store_graph
-    end
-
-    # Returns the first matching compilation rule for the given rep.
-    def compilation_rule_for(rep)
-      @item_compilation_rules.find do |rule|
-        rule.applicable_to?(rep.item) && rule.rep_name == rep.name
-      end
-    end
-
-    # Returns the first matching routing rule for the given rep.
-    def routing_rule_for(rep)
-      @item_routing_rules.find do |rule|
-        rule.applicable_to?(rep.item) && rule.rep_name == rep.name
-      end
-    end
-
-    # Returns a tuple containing the filter name and the filter arguments for
-    # the given layout.
-    def filter_for_layout(layout)
-      @layout_filter_mapping.each_pair do |layout_identifier, filter_name_and_args|
-        return filter_name_and_args if layout.identifier =~ layout_identifier
-      end
-      nil
-    end
-
-  private
-
-    # Compiles all item representations in the site.
-    def compile_reps(reps)
-      active_reps, skipped_reps = reps.partition { |rep| rep.outdated? || rep.item.dependencies_outdated? }
-      inactive_reps = []
-      compiled_reps = []
-
-      # Repeat as long as something is successfully compiled...
-      changed = true
-      until !changed
-        changed = false
-
-        # Sort by increasing number of inverse dependencies to speed up compilation
-        #active_reps = active_reps.sort_by { |r| dependency_tracker.all_dependencies_for(r.item).size }
-        # 10.times { puts '=' * 80 }
-        # active_reps.each do |r|
-        #   puts r.item.identifier + ' => ' + dependency_tracker.all_dependencies_for(r.item).size.to_s
-        # end
-        # 10.times { puts '=' * 80 }
-
-        # Attempt to compile all active reps
-        until active_reps.empty?
-          @stack.clear
-          begin
-            rep = active_reps.shift
-            puts "*** Attempting to compile #{rep.inspect}" if $DEBUG
-
-            @stack.push(rep)
-            compile_rep(rep)
-          rescue Nanoc3::Errors::UnmetDependency => e
-            puts "*** Attempt failed due to unmet dependency on #{e.rep.inspect}" if $DEBUG
-
-            # Save rep to compile it later
-            inactive_reps << rep
-
-            # Add dependency to list of items to compile
-            unless active_reps.include?(e.rep) || inactive_reps.include?(e.rep)
-              changed = true
-              skipped_reps.delete(e.rep)
-              inactive_reps.unshift(e.rep)
-            end
-
-            # Assume that this page has more dependencies and add those
-            @old_dependencies[rep.item].each do |i|
-              i.reps.each do |r|
-                next if active_reps.include?(r)
-                next if compiled_reps.include?(r)
-                next if inactive_reps.include?(r)
-
-                inactive_reps.unshift(r)
-              end
-            end
-          else
-            puts "*** Attempt succeeded" if $DEBUG
-
-            changed = true
-            compiled_reps << rep
-          end
-          puts if $DEBUG
-        end
-
-        # Retry
-        puts "*** No active reps left; activating all (#{inactive_reps.size}) inactive reps" if $DEBUG
-        puts if $DEBUG
-        active_reps   = inactive_reps
-        inactive_reps = []
-      end
-
-      # Notify skipped reps
-      skipped_reps.each do |rep|
-        Nanoc3::NotificationCenter.post(:compilation_started, rep)
-        Nanoc3::NotificationCenter.post(:compilation_ended,   rep)
-      end
-
-      # Raise error if some active but non-compileable reps are left
-      if !active_reps.empty?
-        raise Nanoc3::Errors::RecursiveCompilation.new(active_reps)
-      end
-    end
-
-    # Compiles the given item representation.
-    #
-    # This method should not be called directly; please use
-    # Nanoc3::Compiler#run instead, and pass this item representation's item as
-    # its first argument.
-    #
-    # +rep+:: The rep that is to be compiled.
-    def compile_rep(rep)
-      # Start
-      Nanoc3::NotificationCenter.post(:compilation_started, rep)
-      Nanoc3::NotificationCenter.post(:visit_started,       rep.item)
-
-      # Apply matching rule
-      compilation_rule_for(rep).apply_to(rep)
-      rep.compiled = true
-
-      # Write if rep is routed
-      rep.write unless rep.raw_path.nil?
-
-      # Stop
-      Nanoc3::NotificationCenter.post(:visit_ended,       rep.item)
-      Nanoc3::NotificationCenter.post(:compilation_ended, rep)
-    end
-
-    # Returns the dependency tracker for this site.
-    def dependency_tracker
-      @dependency_tracker ||= Nanoc3::DependencyTracker.new(@site.items)
-    end
-
-    # Marks the necessary items as outdated.
-    def mark_outdated_items(reps, force)
-      if force
-        reps.each { |r| r.force_outdated = true }
-      else
-        dependency_tracker.mark_outdated_items
-      end
-    end
-
-    # Clears the list of dependencies for items that will be recompiled.
-    def forget_dependencies_if_outdated(items)
-      items.each do |i|
-        if i.outdated? || i.dependencies_outdated?
-          dependency_tracker.forget_dependencies_for(i)
-        end
-      end
-    end
-
-    def remember_old_dependencies
-      @old_dependencies = dependency_tracker.instance_eval { @graph }.dup
-    end
-
-    # Prints the dependency graph.
-    def print_dependency_graph
-      graph = dependency_tracker.instance_eval { @graph }
-      puts "DEPENDENCY GRAPH:"
-      graph.each_pair do |key, values|
-        puts "#{key.inspect} depends on:"
-        values.each do |value|
-          puts "    #{value.inspect}"
-        end
-        puts "    (nothing!)" if values.empty?
-        puts
-      end
-    end
-
-  end
-
-end

data/lib/nanoc3/data_sources/last_fm.rb.orig

@@ -1,104 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # Nanoc3::DataSources::LastFM provides data about recently played tracks
-  # from from a single Last.fm user as items (Nanoc3::Item instances).
-  #
-  # The configuration must have a "username" attribute containing the username
-  # of the account from which to fetch the data, and an "api_key" attribute
-  # containing the API key (which can be obtained from the Last.fm site).
-  #
-  # The items returned by this data source will be mounted at {root}/{id},
-  # where +id+ is a sequence number that is not necessarily unique for this
-  # bookmark (because delicious.com unfortunately does not provide unique IDs
-  # for each track).
-  #
-  # The items returned by this data source will have the following attributes:
-  #
-  # +:name+:: The name of the track.
-  #
-  # +played_at+:: The timestamp when the track was played (a Time instance).
-  #
-  # +url+:: The Last.fm URL corresponding to the track (a String instance).
-  #
-  # +artist+:: A hash containing information about the track's artist.
-  #
-  # The +artist+ hash consists of the following keys:
-  #
-  # +name+:: The name of the artist.
-  #
-  # +url+:: The Last.fm URL corresponding to the artist (a String instance).
-  class LastFM < Nanoc3::DataSource
-
-    def items
-      @items ||= begin
-        require 'json'
-        require 'time'
-        require 'uri'
-        require 'enumerator'
-
-        # Check configuration
-        if self.config[:username].nil?
-          raise RuntimeError, "LastFM data source requires a username in the configuration"
-        end
-        if self.config[:api_key].nil?
-          raise RuntimeError, "LastFM data source requires an API key in the configuration"
-        end
-
-        # Get data
-        @http_client ||= Nanoc3::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get(
-          'http://ws.audioscrobbler.com/2.0/' +
-            '?method=user.getRecentTracks' +
-            '&format=json' +
-            '&user=' + URI.escape(self.config[:username]) +
-            '&api_key=' + URI.escape(self.config[:api_key])
-        )
-
-        # Parse as JSON
-        parsed_data = JSON.parse(data)
-        raw_items = parsed_data['recenttracks']['track']
-
-        # Convert to items
-        raw_items.enum_with_index.map do |raw_item, i|
-          # Get artist data
-          artist_status, artist_headers, artist_data = *@http_client.get(
-            'http://ws.audioscrobbler.com/2.0/' +
-              '?method=artist.getInfo' +
-              '&format=json' +
-              (
-                raw_item['artist']['mbid'].empty? ?
-                '&artist=' + URI.escape(raw_item['artist']['#text']) :
-                '&mbid=' + URI.escape(raw_item['artist']['mbid'])
-              ) +
-              '&api_key=' + URI.escape(self.config[:api_key])
-          )
-
-          # Parse as JSON
-          parsed_artist_data = JSON.parse(artist_data)
-          raw_artist_info = parsed_artist_data['artist']
-
-          # Build data
-          content = ''
-          attributes = {
-            :name      => raw_item['name'],
-            :artist    => {
-              :name      => raw_artist_info['name'],
-              :url       => raw_artist_info['url']
-            },
-            :url       => raw_item['url'],
-            :played_at => Time.parse(raw_item['date']['#text'])
-          }
-          identifier = "/#{i}/"
-          mtime = nil
-
-          # Build item
-          Nanoc3::Item.new(content, attributes, identifier, mtime)
-        end
-      end
-    end
-
-  end
-
-end