nanoc 3.6.7 → 3.6.8

data/lib/nanoc/base/ordered_hash.rb

@@ -1,200 +1,228 @@
+# encoding: utf-8
 
 # AUTHOR
 #    jan molic /mig/at/1984/dot/cz/
 #
 # DESCRIPTION
 #    Hash with preserved order and some array-like extensions
-#    Public domain. 
+#    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
+  attr_accessor :order
+
+  class << self
+    def [](*args)
+      hsh = OrderedHash.new
+      if args[0].is_a?(Hash)
+        hsh.replace args[0]
+      elsif args.size.odd?
+        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
-    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
+
+  def initialize(*a, &b)
+    super
+    @order = []
+  end
+
+  def store_only(a, b)
+    store a, b
+  end
+  alias_method :orig_store, :store
+
+  def store(a, b)
+    @order.push a unless key? a
+    super a, b
+  end
+  alias_method :[]=, :store
+
+  def ==(other)
+    return false if @order != other.order
+    super other
+  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_method :each_pair, :each
+
+  def delete_if
+    @order.clone.each do |k|
+      delete k if yield(k)
     end
+    self
+  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
+  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 = {}
+    @order.each { |k| hsh2[self[k]] = k }
+    hsh2
+  end
+
+  def reject(&block)
+    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)
+    if self.include? k
+      false
+    else
+      @order.unshift k
+      orig_store(k, v)
+      true
+    end
+  end
+
+  def push(k, v)
+    if self.include? k
+      false
+    else
+      @order.push k
+      orig_store(k, v)
+      true
+    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
+    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_method :merge!, :update
+
+  def merge(hsh2)
+    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 do |opts|
+          YAML.quick_emit(object_id, opts) do |emitter|
+            emitter << '{ ' << map { |kv| kv.join ': ' }.join(', ') << ' }'
+          end
+        end
+        class << self
+          def to_yaml(opts = {})
+            @__yaml_inline ? @__yaml_inline_meth[ opts ] : super
+          rescue
+            @to_yaml_style = :inline
+            super
           end
         end
       end
-      @__yaml_inline = bool
     end
-    def yaml_inline!() self.yaml_inline = true end
+    @__yaml_inline = bool
+  end
 
-    def each_with_index
-      @order.each_with_index { |k, index| yield k, self[k], index }
-      self
-    end
-end # class OrderedHash
+  def yaml_inline!
+    self.yaml_inline = true
+  end
 
-def OrderedHash(*a, &b)
-  OrderedHash.new(*a, &b)
-end
+  def each_with_index
+    @order.each_with_index { |k, index| yield k, self[k], index }
+    self
+  end
+end # class OrderedHash

data/lib/nanoc/base/plugin_registry.rb

@@ -28,7 +28,7 @@ module Nanoc
       #   @return [Array<Symbol>] The identifiers for this plugin
       def identifiers(*identifiers)
         if identifiers.empty?
-          Nanoc::PluginRegistry.instance.identifiers_of(self.superclass, self)
+          Nanoc::PluginRegistry.instance.identifiers_of(superclass, self)
         else
           register(self, *identifiers)
         end
@@ -45,11 +45,11 @@ module Nanoc
       # @overload identifier
       #
       #   @return [Symbol] The first identifier for this plugin
-      def identifier(identifier=nil)
+      def identifier(identifier = nil)
         if identifier
-          self.identifiers(identifier)
+          identifiers(identifier)
         else
-          Nanoc::PluginRegistry.instance.identifiers_of(self.superclass, self).first
+          Nanoc::PluginRegistry.instance.identifiers_of(superclass, self).first
         end
       end
 
@@ -94,7 +94,7 @@ module Nanoc
     #
     # @return [Nanoc::PluginRegistry] The shared plugin registry
     def self.instance
-      @instance ||= self.new
+      @instance ||= new
     end
 
     # Creates a new plugin registry. This should usually not be necessary; it
@@ -160,7 +160,7 @@ module Nanoc
     def find_all(klass)
       @identifiers_to_classes[klass] ||= {}
       res = {}
-      @identifiers_to_classes[klass].each_pair { |k,v| res[k] = resolve(v, k) }
+      @identifiers_to_classes[klass].each_pair { |k, v| res[k] = resolve(v, k) }
       res
     end
 
@@ -206,7 +206,7 @@ module Nanoc
 
     def resolve(class_or_name, klass)
       if class_or_name.is_a?(String)
-        class_or_name.scan(/\w+/).inject(Kernel) do |memo, part|
+        class_or_name.scan(/\w+/).reduce(Kernel) do |memo, part|
           memo.const_get(part)
         end
       else

data/lib/nanoc/base/result_data/item_rep.rb

@@ -22,38 +22,38 @@ module Nanoc
       end
 
       # @deprecated Use {Nanoc::ItemRep#compiled_content} instead.
-      def content_at_snapshot(snapshot=:pre)
+      def content_at_snapshot(snapshot = :pre)
         compiled_content(:snapshot => snapshot)
       end
 
       # @deprecated
       def created
-        raise NotImplementedError, "Nanoc::ItemRep#created is no longer implemented"
+        raise NotImplementedError, 'Nanoc::ItemRep#created is no longer implemented'
       end
 
       # @deprecated
       def created?
-        raise NotImplementedError, "Nanoc::ItemRep#created? is no longer implemented"
+        raise NotImplementedError, 'Nanoc::ItemRep#created? is no longer implemented'
       end
 
       # @deprecated
       def modified
-        raise NotImplementedError, "Nanoc::ItemRep#modified is no longer implemented"
+        raise NotImplementedError, 'Nanoc::ItemRep#modified is no longer implemented'
       end
 
       # @deprecated
       def modified?
-        raise NotImplementedError, "Nanoc::ItemRep#modified? is no longer implemented"
+        raise NotImplementedError, 'Nanoc::ItemRep#modified? is no longer implemented'
       end
 
       # @deprecated
       def written
-        raise NotImplementedError, "Nanoc::ItemRep#written is no longer implemented"
+        raise NotImplementedError, 'Nanoc::ItemRep#written is no longer implemented'
       end
 
       # @deprecated
       def written?
-        raise NotImplementedError, "Nanoc::ItemRep#written? is no longer implemented"
+        raise NotImplementedError, 'Nanoc::ItemRep#written? is no longer implemented'
       end
 
     end
@@ -118,7 +118,7 @@ module Nanoc
       # @param [Symbol, nil] snapshot The name of the snapshot to write.
       #
       # @return [void]
-      def write(snapshot=:last)
+      def write(snapshot = :last)
         # Get raw path
         raw_path = self.raw_path(:snapshot => snapshot)
         return if raw_path.nil?
@@ -135,7 +135,7 @@ module Nanoc
         if self.binary?
           temp_path = temporary_filenames[:last]
         else
-          temp_path = self.temp_filename
+          temp_path = temp_filename
           File.open(temp_path, 'w') { |io| io.write(@content[:last]) }
         end
 
@@ -235,15 +235,15 @@ module Nanoc
     #
     # @return [String] The compiled content at the given snapshot (or the
     #   default snapshot if no snapshot is specified)
-    def compiled_content(params={})
+    def compiled_content(params = {})
       # Make sure we're not binary
-      if self.item.binary?
+      if item.binary?
         raise Nanoc::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
       end
 
       # Notify
-      Nanoc::NotificationCenter.post(:visit_started, self.item)
-      Nanoc::NotificationCenter.post(:visit_ended,   self.item)
+      Nanoc::NotificationCenter.post(:visit_started, item)
+      Nanoc::NotificationCenter.post(:visit_ended,   item)
 
       # Get name of last pre-layout snapshot
       snapshot = params.fetch(:snapshot) { @content[:pre] ? :pre : :last }
@@ -279,9 +279,9 @@ module Nanoc
     #   path should be returned
     #
     # @return [String] The item rep’s path
-    def raw_path(params={})
-      Nanoc3::NotificationCenter.post(:visit_started, self.item)
-      Nanoc3::NotificationCenter.post(:visit_ended,   self.item)
+    def raw_path(params = {})
+      Nanoc3::NotificationCenter.post(:visit_started, item)
+      Nanoc3::NotificationCenter.post(:visit_ended,   item)
 
       snapshot_name = params[:snapshot] || :last
       @raw_paths[snapshot_name]
@@ -296,9 +296,9 @@ module Nanoc
     #   path should be returned
     #
     # @return [String] The item rep’s path
-    def path(params={})
-      Nanoc3::NotificationCenter.post(:visit_started, self.item)
-      Nanoc3::NotificationCenter.post(:visit_ended,   self.item)
+    def path(params = {})
+      Nanoc3::NotificationCenter.post(:visit_started, item)
+      Nanoc3::NotificationCenter.post(:visit_ended,   item)
 
       snapshot_name = params[:snapshot] || :last
       @paths[snapshot_name]
@@ -320,7 +320,7 @@ module Nanoc
     #   the filter's #run method
     #
     # @return [void]
-    def filter(filter_name, filter_args={})
+    def filter(filter_name, filter_args = {})
       # Get filter class
       klass = filter_named(filter_name)
       raise Nanoc::Errors::UnknownFilter.new(filter_name) if klass.nil?
@@ -352,8 +352,7 @@ module Nanoc
 
         # 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}."
+          raise "The #{filter_name.inspect} filter did not write anything to the required output file, #{filter.output_filename}."
         end
 
         # Create snapshot
@@ -426,10 +425,10 @@ module Nanoc
     #   snapshot (such as `:pre`, `:post` or `:last`)
     #
     # @return [void]
-    def snapshot(snapshot_name, params={})
+    def snapshot(snapshot_name, params = {})
       is_final = params.fetch(:final) { true }
       @content[snapshot_name] = @content[:last] unless self.binary?
-      self.write(snapshot_name) if is_final
+      write(snapshot_name) if is_final
     end
 
     # Returns a recording proxy that is used for determining whether the
@@ -462,11 +461,11 @@ module Nanoc
     #
     # @return [Object] An unique reference to this object
     def reference
-      [ type, self.item.identifier, self.name ]
+      [ type, item.identifier, name ]
     end
 
     def inspect
-      "<#{self.class} name=\"#{self.name}\" binary=#{self.binary?} raw_path=\"#{self.raw_path}\" item.identifier=\"#{self.item.identifier}\">"
+      "<#{self.class} name=\"#{name}\" binary=#{self.binary?} raw_path=\"#{raw_path}\" item.identifier=\"#{item.identifier}\">"
     end
 
   private

data/lib/nanoc/base/source_data/code_snippet.rb

@@ -24,7 +24,7 @@ module Nanoc
     #
     # @param [Time, Hash] params Extra parameters. Ignored by nanoc; it is
     #   only included for backwards compatibility.
-    def initialize(data, filename, params=nil)
+    def initialize(data, filename, params = nil)
       @data     = data
       @filename = filename
     end
@@ -44,7 +44,7 @@ module Nanoc
     end
 
     def inspect
-      "<#{self.class} filename=\"#{self.filename}\">"
+      "<#{self.class} filename=\"#{filename}\">"
     end
 
     # @return [String] The checksum for this object. If its contents change,

data/lib/nanoc/base/source_data/configuration.rb

@@ -9,7 +9,7 @@ module Nanoc
     #
     # @param [Hash] hash The actual configuration hash
     def initialize(hash)
-      self.replace(hash)
+      replace(hash)
     end
 
     # Returns an object that can be used for uniquely identifying objects.

data/lib/nanoc/base/source_data/data_source.rb

@@ -207,7 +207,7 @@ module Nanoc
     #   files that should be generated.
     #
     # @return [void]
-    def create_item(content, attributes, identifier, params={})
+    def create_item(content, attributes, identifier, params = {})
       not_implemented('create_item')
     end
 
@@ -230,7 +230,7 @@ module Nanoc
     #   files that should be generated.
     #
     # @return [void]
-    def create_layout(content, attributes, identifier, params={})
+    def create_layout(content, attributes, identifier, params = {})
       not_implemented('create_layout')
     end