nanoc-core 4.14.6 → 4.14.8

data/lib/nanoc/core/contracts_support.rb

@@ -46,6 +46,8 @@ module Nanoc
 
         class Named < AbstractContract
           def initialize(name)
+            super()
+
             @name = name
           end
 
@@ -60,11 +62,14 @@ module Nanoc
 
         class IterOf < AbstractContract
           def initialize(contract)
+            super()
+
             @contract = contract
           end
 
           def valid?(val)
-            val.respond_to?(:each) && val.all? { |v| Contract.valid?(v, @contract) }
+            val.respond_to?(:each) &&
+              val.all? { |v| Contract.valid?(v, @contract) }
           end
 
           def inspect
@@ -97,13 +102,20 @@ module Nanoc
             false
           end
 
-        @_contracts_support__should_enable = contracts_loadable && !ENV.key?('DISABLE_CONTRACTS')
+        @_contracts_support__should_enable =
+          contracts_loadable && !ENV.key?('DISABLE_CONTRACTS')
 
         if @_contracts_support__should_enable
           # FIXME: ugly
-          ::Contracts.const_set('Named', EnabledContracts::Named)
-          ::Contracts.const_set('IterOf', EnabledContracts::IterOf)
-          ::Contracts.const_set('AbsolutePathString', EnabledContracts::AbsolutePathString)
+          ::Contracts.const_set(
+            'Named', EnabledContracts::Named
+          )
+          ::Contracts.const_set(
+            'IterOf', EnabledContracts::IterOf
+          )
+          ::Contracts.const_set(
+            'AbsolutePathString', EnabledContracts::AbsolutePathString
+          )
 
           warn_about_performance
         end
@@ -136,13 +148,19 @@ module Nanoc
 
         puts '-' * 78
         puts 'A NOTE ABOUT PERFORMANCE:'
-        puts 'The `contracts` gem is loaded, which enables extra run-time checks, but can drastically reduce Nanoc’s performance. The `contracts` gem is intended for development purposes, and is not recommended for day-to-day Nanoc usage.'
+        puts 'The `contracts` gem is loaded, which enables extra run-time ' \
+             'checks, but can drastically reduce Nanoc’s performance. The ' \
+             '`contracts` gem is intended for development purposes, and is ' \
+             'not recommended for day-to-day Nanoc usage.'
         puts
 
         if defined?(Bundler)
-          puts 'To speed up compilation, remove `contracts` from the Gemfile and run `bundle install`.'
+          puts 'To speed up compilation, remove `contracts` from the Gemfile ' \
+               'and run `bundle install`.'
         else
-          puts 'To speed up compilation, either uninstall the `contracts` gem, or use Bundler (https://bundler.io/) with a Gemfile that doesn’t include `contracts`.'
+          puts 'To speed up compilation, either uninstall the `contracts` ' \
+               'gem, or use Bundler (https://bundler.io/) with a Gemfile ' \
+               'that doesn’t include `contracts`.'
         end
 
         puts '-' * 78

data/lib/nanoc/core/core_ext/hash.rb

@@ -13,7 +13,12 @@ module Nanoc
           hash = {}
           each_pair do |key, value|
             new_key   = key.respond_to?(:to_sym) ? key.to_sym : key
-            new_value = value.respond_to?(:__nanoc_symbolize_keys_recursively) ? value.__nanoc_symbolize_keys_recursively : value
+            new_value =
+              if value.respond_to?(:__nanoc_symbolize_keys_recursively)
+                value.__nanoc_symbolize_keys_recursively
+              else
+                value
+              end
             hash[new_key] = new_value
           end
           hash
@@ -23,7 +28,12 @@ module Nanoc
           hash = {}
           each_pair do |key, value|
             new_key   = key.is_a?(Symbol) ? key.to_s : key
-            new_value = value.respond_to?(:__nanoc_stringify_keys_recursively) ? value.__nanoc_stringify_keys_recursively : value
+            new_value =
+              if value.respond_to?(:__nanoc_stringify_keys_recursively)
+                value.__nanoc_stringify_keys_recursively
+              else
+                value
+              end
             hash[new_key] = new_value
           end
           hash

data/lib/nanoc/core/data_source.rb

@@ -101,13 +101,15 @@ module Nanoc
 
       # @api private
       def item_changes
-        warn "Caution: Data source #{self.class.identifier.inspect} does not implement #item_changes; live compilation will not pick up changes in this data source."
+        warn "Caution: Data source #{self.class.identifier.inspect} does not " \
+             'implement #item_changes; live compilation will not pick up changes in this data source.'
         Enumerator.new { |_y| sleep }
       end
 
       # @api private
       def layout_changes
-        warn "Caution: Data source #{self.class.identifier.inspect} does not implement #layout_changes; live compilation will not pick up changes in this data source."
+        warn "Caution: Data source #{self.class.identifier.inspect} does not " \
+             'implement #layout_changes; live compilation will not pick up changes in this data source.'
         Enumerator.new { |_y| sleep }
       end
 
@@ -143,9 +145,16 @@ module Nanoc
       # @param [String, nil] content_checksum_data
       #
       # @param [String, nil] attributes_checksum_data
-      def new_item(content, attributes, identifier, binary: false, checksum_data: nil, content_checksum_data: nil, attributes_checksum_data: nil)
+      def new_item(
+        content, attributes, identifier,
+        binary: false, checksum_data: nil, content_checksum_data: nil,
+        attributes_checksum_data: nil
+      )
         content = Nanoc::Core::Content.create(content, binary:)
-        Nanoc::Core::Item.new(content, attributes, identifier, checksum_data:, content_checksum_data:, attributes_checksum_data:)
+        Nanoc::Core::Item.new(
+          content, attributes, identifier,
+          checksum_data:, content_checksum_data:, attributes_checksum_data:
+        )
       end
 
       # Creates a new in-memory layout instance. This is intended for use within
@@ -162,8 +171,15 @@ module Nanoc
       # @param [String, nil] content_checksum_data
       #
       # @param [String, nil] attributes_checksum_data
-      def new_layout(raw_content, attributes, identifier, checksum_data: nil, content_checksum_data: nil, attributes_checksum_data: nil)
-        Nanoc::Core::Layout.new(raw_content, attributes, identifier, checksum_data:, content_checksum_data:, attributes_checksum_data:)
+      def new_layout(
+        raw_content, attributes, identifier,
+        checksum_data: nil, content_checksum_data: nil,
+        attributes_checksum_data: nil
+      )
+        Nanoc::Core::Layout.new(
+          raw_content, attributes, identifier,
+          checksum_data:, content_checksum_data:, attributes_checksum_data:
+        )
       end
     end
   end

data/lib/nanoc/core/dependency.rb

@@ -7,7 +7,11 @@ module Nanoc
     class Dependency
       include Nanoc::Core::ContractsSupport
 
-      C_OBJ_FROM = C::Or[Nanoc::Core::Item, Nanoc::Core::Layout, Nanoc::Core::Configuration, Nanoc::Core::IdentifiableCollection]
+      C_OBJ_FROM = C::Or[
+        Nanoc::Core::Item,
+        Nanoc::Core::Layout,
+        Nanoc::Core::Configuration,
+        Nanoc::Core::IdentifiableCollection]
       C_OBJ_TO   = Nanoc::Core::Item
 
       contract C::None => C::Maybe[C_OBJ_FROM]
@@ -19,7 +23,9 @@ module Nanoc
       contract C::None => Nanoc::Core::DependencyProps
       attr_reader :props
 
-      contract C::Maybe[C_OBJ_FROM], C::Maybe[C_OBJ_TO], Nanoc::Core::DependencyProps => C::Any
+      contract C::Maybe[C_OBJ_FROM],
+               C::Maybe[C_OBJ_TO],
+               Nanoc::Core::DependencyProps => C::Any
       def initialize(from, to, props)
         @from  = from
         @to    = to

data/lib/nanoc/core/dependency_props.rb

@@ -6,6 +6,11 @@ module Nanoc
     class DependencyProps
       include Nanoc::Core::ContractsSupport
 
+      BIT_PATTERN_RAW_CONTENT      = 0x01
+      BIT_PATTERN_ATTRIBUTES       = 0x02
+      BIT_PATTERN_COMPILED_CONTENT = 0x04
+      BIT_PATTERN_PATH             = 0x08
+
       attr_reader :attributes
       attr_reader :raw_content
 
@@ -42,8 +47,20 @@ module Nanoc
           path: C::Optional[C::Bool],
         ]
 
+      def self.format_bit_pattern(pat)
+        (+'').tap do |s|
+          s << (pat.nobits?(BIT_PATTERN_RAW_CONTENT) ? '_' : 'r')
+          s << (pat.nobits?(BIT_PATTERN_ATTRIBUTES) ? '_' : 'a')
+          s << (pat.nobits?(BIT_PATTERN_COMPILED_CONTENT) ? '_' : 'c')
+          s << (pat.nobits?(BIT_PATTERN_PATH) ? '_' : 'p')
+        end
+      end
+
       contract C_ARGS => C::Any
-      def initialize(raw_content: false, attributes: false, compiled_content: false, path: false)
+      def initialize(
+        raw_content: false, attributes: false,
+        compiled_content: false, path: false
+      )
         @raw_content = raw_content
         @attributes = attributes
         @compiled_content = compiled_content
@@ -155,14 +172,16 @@ module Nanoc
         end
       end
 
-      contract C::None => Set
+      contract C::None => C::Num
       def active
-        Set.new.tap do |pr|
-          pr << :raw_content if raw_content?
-          pr << :attributes if attributes?
-          pr << :compiled_content if compiled_content?
-          pr << :path if path?
-        end
+        res = 0x00
+
+        res |= BIT_PATTERN_RAW_CONTENT if raw_content?
+        res |= BIT_PATTERN_ATTRIBUTES if attributes?
+        res |= BIT_PATTERN_COMPILED_CONTENT if compiled_content?
+        res |= BIT_PATTERN_PATH if path?
+
+        res
       end
 
       def attribute_keys

data/lib/nanoc/core/dependency_store.rb

@@ -27,22 +27,28 @@ module Nanoc
           path: C::Optional[C::Bool],
         ]
 
-      C_OBJ_SRC = Nanoc::Core::Item
-
-      C_OBJ_DST =
+      C_OBJ_SRC =
         C::Or[
+          nil,
           Nanoc::Core::Item,
           Nanoc::Core::Layout,
           Nanoc::Core::Configuration,
           Nanoc::Core::IdentifiableCollection,
         ]
 
+      C_OBJ_DST = Nanoc::Core::Item
+
       attr_reader :items
       attr_reader :layouts
 
-      contract Nanoc::Core::ItemCollection, Nanoc::Core::LayoutCollection, Nanoc::Core::Configuration => C::Any
+      contract Nanoc::Core::ItemCollection,
+               Nanoc::Core::LayoutCollection,
+               Nanoc::Core::Configuration => C::Any
       def initialize(items, layouts, config)
-        super(Nanoc::Core::Store.tmp_path_for(config:, store_name: 'dependencies'), 6)
+        super(
+          self.class.tmp_path_for(config:, store_name: 'dependencies'),
+          6,
+        )
 
         @config = config
         @items = items
@@ -51,7 +57,9 @@ module Nanoc
         rebuild_refs2objs
 
         @new_objects = []
-        @graph = Nanoc::Core::DirectedGraph.new([nil] + objs2refs(@items) + objs2refs(@layouts))
+        @graph = Nanoc::Core::DirectedGraph.new(
+          [nil] + objs2refs(@items) + objs2refs(@layouts),
+        )
       end
 
       def rebuild_refs2objs
@@ -63,7 +71,7 @@ module Nanoc
         add_vertex_for(@layouts)
       end
 
-      contract C_OBJ_SRC => C::ArrayOf[Nanoc::Core::Dependency]
+      contract C_OBJ_DST => C::ArrayOf[Nanoc::Core::Dependency]
       def dependencies_causing_outdatedness_of(object)
         objects_causing_outdatedness_of(object).map do |other_object|
           props = props_for(other_object, object)
@@ -76,6 +84,19 @@ module Nanoc
         end
       end
 
+      contract C_OBJ_SRC => C::ArrayOf[Nanoc::Core::Dependency]
+      def dependencies_outdated_because_of(object)
+        objects_outdated_because_of(object).map do |other_object|
+          props = props_for(object, other_object)
+
+          Nanoc::Core::Dependency.new(
+            object,
+            other_object,
+            props,
+          )
+        end
+      end
+
       def items=(items)
         @items = items
         rebuild_refs2objs
@@ -87,11 +108,11 @@ module Nanoc
       end
 
       def new_items
-        @new_objects.select { |o| o.is_a?(Nanoc::Core::Item) }
+        @new_objects.grep(Nanoc::Core::Item)
       end
 
       def new_layouts
-        @new_objects.select { |o| o.is_a?(Nanoc::Core::Layout) }
+        @new_objects.grep(Nanoc::Core::Layout)
       end
 
       # Returns the direct dependencies for the given object.
@@ -115,19 +136,29 @@ module Nanoc
         refs2objs(@graph.direct_predecessors_of(obj2ref(object)))
       end
 
-      contract C::Maybe[C_OBJ_SRC], C::Maybe[C_OBJ_DST], C_KEYWORD_PROPS => C::Any
+      def objects_outdated_because_of(object)
+        refs2objs(@graph.direct_successors_of(obj2ref(object)))
+      end
+
+      contract C::Maybe[C_OBJ_SRC],
+               C::Maybe[C_OBJ_DST],
+               C_KEYWORD_PROPS => C::Any
       # Records a dependency from `src` to `dst` in the dependency graph. When
-      # `dst` is oudated, `src` will also become outdated.
+      # `src` is oudated, `dst` will also become outdated.
       #
-      # @param [Nanoc::Core::Item, Nanoc::Core::Layout] src The source of the dependency,
-      #   i.e. the object that will become outdated if dst is outdated
+      # @param [Nanoc::Core::Item, Nanoc::Core::Layout] src The source of the
+      #   dependency, i.e. the object that will cause dst to become
+      #   outdated
       #
-      # @param [Nanoc::Core::Item, Nanoc::Core::Layout] dst The destination of the
-      #   dependency, i.e. the object that will cause the source to become
-      #   outdated if the destination is outdated
+      # @param [Nanoc::Core::Item, Nanoc::Core::Layout] dst The destination of
+      #   the dependency, i.e. the object that will become outdated if src is
+      #   outdated
       #
       # @return [void]
-      def record_dependency(src, dst, raw_content: false, attributes: false, compiled_content: false, path: false)
+      def record_dependency(
+        src, dst, raw_content: false, attributes: false,
+        compiled_content: false, path: false
+      )
         return if src == dst
 
         add_vertex_for(src)
@@ -141,11 +172,13 @@ module Nanoc
           attributes = attributes.to_a
         end
 
-        existing_props = @graph.props_for(dst_ref, src_ref)
-        new_props = Nanoc::Core::DependencyProps.new(raw_content:, attributes:, compiled_content:, path:)
+        existing_props = @graph.props_for(src_ref, dst_ref)
+        new_props = Nanoc::Core::DependencyProps.new(
+          raw_content:, attributes:, compiled_content:, path:,
+        )
         props = existing_props ? existing_props.merge(new_props) : new_props
 
-        @graph.add_edge(dst_ref, src_ref, props:)
+        @graph.add_edge(src_ref, dst_ref, props:)
       end
 
       def add_vertex_for(obj)
@@ -157,8 +190,8 @@ module Nanoc
       # will stick around and new dependencies will appear twice. This function
       # removes all incoming edges for the given vertex.
       #
-      # @param [Nanoc::Core::Item, Nanoc::Core::Layout] object The object for which to
-      #   forget all dependencies
+      # @param [Nanoc::Core::Item, Nanoc::Core::Layout] object The object for
+      #   which to forget all dependencies
       #
       # @return [void]
       def forget_dependencies_for(object)

data/lib/nanoc/core/dependency_tracker.rb

@@ -44,12 +44,18 @@ module Nanoc
       end
 
       contract C_OBJ, C_ARGS => C::Any
-      def bounce(obj, raw_content: false, attributes: false, compiled_content: false, path: false)
+      def bounce(
+        obj,
+        raw_content: false,
+        attributes: false,
+        compiled_content: false,
+        path: false
+      )
         Nanoc::Core::NotificationCenter.post(:dependency_created, @root, obj)
 
         @dependency_store.record_dependency(
-          @root,
           obj,
+          @root,
           raw_content:,
           attributes:,
           compiled_content:,
@@ -60,10 +66,20 @@ module Nanoc
       class Null < DependencyTracker
         include Nanoc::Core::ContractsSupport
 
-        def initialize; end
+        def initialize
+          super(nil, root: nil)
+        end
 
         contract C_OBJ, C_ARGS => C::Any
-        def bounce(_obj, raw_content: false, attributes: false, compiled_content: false, path: false); end
+        def bounce(
+          _obj,
+          raw_content: false,
+          attributes: false,
+          compiled_content: false,
+          path: false
+        )
+          # do nothing
+        end
       end
     end
   end

data/lib/nanoc/core/directed_graph.rb

@@ -21,8 +21,6 @@ module Nanoc
     #   # Get (direct) predecessors
     #   graph.direct_predecessors_of('b').sort
     #     # => %w( a )
-    #   graph.predecessors_of('e').sort
-    #     # => %w( a b c d )
     #
     #   # Modify edges
     #   graph.delete_edges_to('c')
@@ -30,8 +28,6 @@ module Nanoc
     #   # Get (direct) predecessors again
     #   graph.direct_predecessors_of('e').sort
     #     # => %w( d )
-    #   graph.predecessors_of('e').sort
-    #     # => %w( c d )
     class DirectedGraph
       EMPTY_SET = Set.new.freeze
 
@@ -39,30 +35,34 @@ module Nanoc
 
       # Creates a new directed graph with the given vertices.
       def initialize(vertices)
-        @vertices = {}
+        @vertex_to_idx_map = {}
+        @vertices = []
         @next_vertex_idx = 0
         vertices.each do |v|
-          @vertices[v] = @next_vertex_idx
+          @vertices << v
+          @vertex_to_idx_map[v] = @next_vertex_idx
           @next_vertex_idx += 1
         end
 
         @to_graph = {}
+        @from_graph = {}
 
         @edge_props = {}
-
-        invalidate_caches
       end
 
       def inspect
         s = []
 
-        @vertices.each_pair do |v2, _|
+        @vertices.each do |v2|
           direct_predecessors_of(v2).each do |v1|
-            s << [v1.inspect + ' -> ' + v2.inspect + ' props=' + @edge_props[[v1, v2]].inspect]
+            s << [
+              "#{v1.inspect} -> #{v2.inspect} " \
+              "props=#{@edge_props[[v1, v2]].inspect}",
+            ]
           end
         end
 
-        self.class.to_s + '(' + s.join(', ') + ')'
+        "#{self.class}(#{s.join(', ')})"
       end
 
       # @group Modifying the graph
@@ -81,11 +81,12 @@ module Nanoc
         @to_graph[to] ||= Set.new
         @to_graph[to] << from
 
+        @from_graph[from] ||= Set.new
+        @from_graph[from] << to
+
         if props
           @edge_props[[from, to]] = props
         end
-
-        invalidate_caches
       end
 
       # Adds the given vertex to the graph.
@@ -94,9 +95,10 @@ module Nanoc
       #
       # @return [void]
       def add_vertex(vertex)
-        return if @vertices.key?(vertex)
+        return if @vertex_to_idx_map.key?(vertex)
 
-        @vertices[vertex] = @next_vertex_idx
+        @vertices << vertex
+        @vertex_to_idx_map[vertex] = @next_vertex_idx
         @next_vertex_idx += 1
       end
 
@@ -110,10 +112,9 @@ module Nanoc
 
         @to_graph[to].each do |from|
           @edge_props.delete([from, to])
+          @from_graph.delete(from)
         end
         @to_graph.delete(to)
-
-        invalidate_caches
       end
 
       # @group Querying the graph
@@ -128,14 +129,8 @@ module Nanoc
         @to_graph.fetch(to, EMPTY_SET)
       end
 
-      # Returns the predecessors of the given vertex, i.e. the vertices x for
-      # which there is a path from x to the given vertex y.
-      #
-      # @param to The vertex of which the predecessors should be calculated
-      #
-      # @return [Array] Predecessors of the given vertex
-      def predecessors_of(to)
-        @predecessors[to] ||= recursively_find_vertices(to, :direct_predecessors_of)
+      def direct_successors_of(from)
+        @from_graph.fetch(from, EMPTY_SET)
       end
 
       def props_for(from, to)
@@ -144,7 +139,7 @@ module Nanoc
 
       # @return [Array] The list of all vertices in this graph.
       def vertices
-        @vertices.keys.sort_by { |v| @vertices[v] }
+        @vertices
       end
 
       # Returns an array of tuples representing the edges. The result of this
@@ -153,47 +148,15 @@ module Nanoc
       # @return [Array] The list of all edges in this graph.
       def edges
         result = []
-        @vertices.each_pair do |v2, i2|
-          direct_predecessors_of(v2).map { |v1| [@vertices[v1], v1] }.each do |i1, v1|
-            result << [i1, i2, @edge_props[[v1, v2]]]
-          end
+        @vertices.each_with_index do |v2, i2|
+          direct_predecessors_of(v2)
+            .map { |v1| [@vertex_to_idx_map[v1], v1] }
+            .each do |i1, v1|
+              result << [i1, i2, @edge_props[[v1, v2]]]
+            end
         end
         result
       end
-
-      private
-
-      # Invalidates cached data. This method should be called when the internal
-      # graph representation is changed.
-      def invalidate_caches
-        @predecessors = {}
-      end
-
-      # Recursively finds vertices, starting at the vertex start, using the
-      # given method, which should be a symbol to a method that takes a vertex
-      # and returns related vertices (e.g. predecessors, successors).
-      def recursively_find_vertices(start, method)
-        all_vertices = Set.new
-
-        processed_vertices   = Set.new
-        unprocessed_vertices = [start]
-
-        until unprocessed_vertices.empty?
-          # Get next unprocessed vertex
-          vertex = unprocessed_vertices.pop
-          next if processed_vertices.include?(vertex)
-
-          processed_vertices << vertex
-
-          # Add predecessors of this vertex
-          send(method, vertex).each do |v|
-            all_vertices << v unless all_vertices.include?(v)
-            unprocessed_vertices << v
-          end
-        end
-
-        all_vertices
-      end
     end
   end
 end

data/lib/nanoc/core/document.rb

@@ -41,7 +41,10 @@ module Nanoc
       # @param [String, nil] content_checksum_data
       #
       # @param [String, nil] attributes_checksum_data
-      def initialize(content, attributes, identifier, checksum_data: nil, content_checksum_data: nil, attributes_checksum_data: nil)
+      def initialize(
+        content, attributes, identifier,
+        checksum_data: nil, content_checksum_data: nil, attributes_checksum_data: nil
+      )
         @content = Nanoc::Core::Content.create(content)
         @attributes = Nanoc::Core::LazyValue.new(attributes).map(&:__nanoc_symbolize_keys_recursively)
         @identifier = Nanoc::Core::Identifier.from(identifier)