nanoc 4.7.7 → 4.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d25ba882d1c709e130d1da34de63b5bee85ffaa2
-  data.tar.gz: 6e3c673ec2c5b30a25edb775f42197813899cabf
+  metadata.gz: bd1bb8411c769f4fece915bf9569b5af2a1a1424
+  data.tar.gz: 23b8e4dfd52b52fc012c2ea22d528d294c3971bd
 SHA512:
-  metadata.gz: 914fde5a0e842055cabfa804950d3b355f3b03b33b3a72cddbd1654aa4e9233163848386b728e2ce08238de98311d2af31305e874bc421549ac858acb310b73b
-  data.tar.gz: 2727ef6a9f49eedec58419971d324ce73a50dad71776ff1e303d7a50567b7a47881e4acb8be100cb095bbea68a4a6540da768aedfaaa29f7c05e63fd8732347f
+  metadata.gz: 862cb54cefa14a2312bfd417f3d3d744afe2b27740ed57bfb1c2b51c5eaabbe66cdb3130b5b10ea758dea3045a2ac7a6d3fa6caff10c358a76e9af2c1189a8aa
+  data.tar.gz: d33204921451b9e6cffa130bbc30fe02e6f1ea88d01854d8c6910d4e07e85fddea6a25448ff84c05bbd6b6407cae2eb7c4a8adbac3c7e4b19a1490a795c12e69

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/bbatsov/rubocop.git
-  revision: dcb3f160a2e23218a7826aadd0e64baefd6d7521
+  revision: 9168e82c449bf275b4ce587ac01efff25bf80cc2
   specs:
     rubocop (0.48.1)
       parallel (~> 1.10)
@@ -28,7 +28,7 @@ GEM
       public_suffix (~> 2.0, >= 2.0.2)
     adsf (1.2.1)
       rack (>= 1.0.0)
-    appraisal (2.1.0)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
@@ -163,7 +163,7 @@ GEM
     fog-profitbricks (3.0.0)
       fog-core (~> 1.42)
       fog-json (~> 1.0)
-    fog-rackspace (0.1.4)
+    fog-rackspace (0.1.5)
       fog-core (>= 1.35)
       fog-json (>= 1.0)
       fog-xml (>= 0.1)
@@ -233,7 +233,7 @@ GEM
     hashdiff (0.3.2)
     inflecto (0.0.2)
     ipaddress (0.8.3)
-    json (2.0.4)
+    json (2.1.0)
     kramdown (1.13.2)
     less (2.6.0)
       commonjs (~> 0.2.7)
@@ -281,7 +281,8 @@ GEM
     pygments.rb (1.1.2)
       multi_json (>= 1.0.0)
     rack (2.0.1)
-    rainbow (2.2.1)
+    rainbow (2.2.2)
+      rake
     rainpress (1.0.1)
     rake (12.0.0)
     rb-fsevent (0.9.8)

data/NEWS.md

@@ -1,5 +1,17 @@
 # Nanoc news
 
+## 4.7.8 (2017-04-22)
+
+Fixes:
+
+* Fixed a crash when printing dependency cycle error messages (#1164, #1166)
+* Fixed incorrect ordering in dependency cycle error messages (#1167, #1168)
+* Fixed a crash when attempting to print malformed UTF-8 strings (#1163, #1165)
+
+Enhancements:
+
+* Added various speed improvements (#1158, #1159, #1160)
+
 ## 4.7.7 (2017-04-16)
 
 Enhancements:

data/lib/nanoc/base/entities.rb

@@ -20,6 +20,7 @@ require_relative 'entities/action_sequence'
 require_relative 'entities/site'
 require_relative 'entities/snapshot_def'
 
+require_relative 'entities/checksum_collection'
 require_relative 'entities/outdatedness_status'
 require_relative 'entities/outdatedness_reasons'
 require_relative 'entities/dependency'

data/lib/nanoc/base/entities/action_sequence.rb

@@ -2,6 +2,7 @@ module Nanoc::Int
   class ActionSequence
     include Nanoc::Int::ContractsSupport
     include Enumerable
+    extend Nanoc::Int::Memoization
 
     attr_reader :item_rep
     attr_reader :actions
@@ -11,6 +12,12 @@ module Nanoc::Int
       @actions = actions
     end
 
+    def self.build(rep)
+      builder = Nanoc::Int::ActionSequenceBuilder.new(rep)
+      yield(builder)
+      builder.action_sequence
+    end
+
     contract C::None => Numeric
     def size
       @actions.size
@@ -21,42 +28,18 @@ module Nanoc::Int
       @actions[idx]
     end
 
-    contract Symbol, Hash => self
-    def add_filter(filter_name, params)
-      @actions << Nanoc::Int::ProcessingActions::Filter.new(filter_name, params)
-      self
-    end
-
-    contract String, C::Maybe[Hash] => self
-    def add_layout(layout_identifier, params)
-      @actions << Nanoc::Int::ProcessingActions::Layout.new(layout_identifier, params)
-      self
-    end
-
-    contract Symbol, C::Maybe[String] => self
-    def add_snapshot(snapshot_name, path)
-      will_add_snapshot(snapshot_name)
-      @actions << Nanoc::Int::ProcessingActions::Snapshot.new([snapshot_name], path ? [path] : [])
-      self
-    end
-
     contract C::None => C::ArrayOf[Nanoc::Int::ProcessingAction]
     def snapshot_actions
       @actions.select { |a| a.is_a?(Nanoc::Int::ProcessingActions::Snapshot) }
     end
 
-    contract C::None => C::Bool
-    def any_layouts?
-      @actions.any? { |a| a.is_a?(Nanoc::Int::ProcessingActions::Layout) }
-    end
-
     contract C::None => Array
     def paths
       snapshot_actions.map { |a| [a.snapshot_names, a.paths] }
     end
 
     # TODO: Add contract
-    def serialize
+    memoized def serialize
       to_a.map(&:serialize)
     end
 
@@ -91,16 +74,5 @@ module Nanoc::Int
 
       snapshot_defs
     end
-
-    private
-
-    def will_add_snapshot(name)
-      @_snapshot_names ||= Set.new
-      if @_snapshot_names.include?(name)
-        raise Nanoc::Int::Errors::CannotCreateMultipleSnapshotsWithSameName.new(@item_rep, name)
-      else
-        @_snapshot_names << name
-      end
-    end
   end
 end

data/lib/nanoc/base/entities/checksum_collection.rb

@@ -0,0 +1,31 @@
+module Nanoc::Int
+  class ChecksumCollection
+    include Nanoc::Int::ContractsSupport
+    extend Nanoc::Int::Memoization
+
+    c_obj = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::CodeSnippet]
+
+    def initialize(checksums)
+      @checksums = checksums
+    end
+
+    contract c_obj => C::Maybe[String]
+    def checksum_for(obj)
+      @checksums[obj.reference]
+    end
+
+    contract c_obj => C::Maybe[String]
+    def content_checksum_for(obj)
+      @checksums[[obj.reference, :content]]
+    end
+
+    contract c_obj => C::Maybe[C::HashOf[Symbol, String]]
+    def attributes_checksum_for(obj)
+      @checksums[[obj.reference, :each_attribute]]
+    end
+
+    def to_h
+      @checksums
+    end
+  end
+end

data/lib/nanoc/base/entities/directed_graph.rb

@@ -158,18 +158,42 @@ module Nanoc::Int
 
     # @group Querying the graph
 
+    # Returns a cycle if there is any.
     def any_cycle
-      path = [@vertices.keys.first]
-
-      loop do
-        nexts = direct_successors_of(path.last)
-        cycle_start_index = path.find_index { |node| nexts.include?(node) }
-        if cycle_start_index
-          break path[cycle_start_index..-1]
-        elsif nexts.empty?
-          break nil
-        else
-          path << nexts.sample
+      all_paths.lazy.map { |path| cycle_in_path(path) }.find(&:itself)
+    end
+
+    # Given a potentially closed path, returns a cycle if there is any.
+    def cycle_in_path(path)
+      vertex = path.last
+      index = path.index(vertex)
+
+      if index < path.size - 1
+        path[index..-2]
+      end
+    end
+
+    # Yields all paths (including potentially closed ones).
+    def all_paths
+      Enumerator.new do |y|
+        @vertices.keys.each do |vertex|
+          dfs_from(vertex) do |path|
+            y << path
+          end
+        end
+      end
+    end
+
+    # Yields all paths (including potentially closed ones) starting from the given vertex.
+    def dfs_from(vertex, path_so_far = [])
+      new_path = path_so_far + [vertex]
+      yield(new_path)
+
+      unless path_so_far.include?(vertex)
+        direct_successors_of(vertex).each do |next_vertex|
+          dfs_from(next_vertex, new_path) do |path|
+            yield(path)
+          end
         end
       end
     end

data/lib/nanoc/base/errors.rb

@@ -75,7 +75,9 @@ module Nanoc::Int
         msg_bits = []
         msg_bits << 'The site cannot be compiled because there is a dependency cycle:'
         msg_bits << ''
-        cycle.each.with_index { |r, i| msg_bits << "    (#{i + 1}) item #{r.item.identifier}, rep #{r.name.inspect}, depends on" }
+        cycle.reverse_each.with_index do |r, i|
+          msg_bits << "    (#{i + 1}) item #{r.item.identifier}, rep #{r.name.inspect}, uses compiled content of"
+        end
         msg_bits.last << ' (1)'
 
         super(msg_bits.map { |x| x + "\n" }.join(''))

data/lib/nanoc/base/repos/checksum_store.rb

@@ -6,6 +6,7 @@ module Nanoc::Int
   class ChecksumStore < ::Nanoc::Int::Store
     include Nanoc::Int::ContractsSupport
 
+    attr_writer :checksums
     attr_accessor :objects
 
     c_obj = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::CodeSnippet]

data/lib/nanoc/base/services.rb

@@ -1,4 +1,5 @@
 require_relative 'services/action_provider'
+require_relative 'services/action_sequence_builder'
 require_relative 'services/checksummer'
 require_relative 'services/compilation_context'
 require_relative 'services/compiler'

data/lib/nanoc/base/services/action_sequence_builder.rb

@@ -0,0 +1,45 @@
+module Nanoc::Int
+  class ActionSequenceBuilder
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(item_rep)
+      @item_rep = item_rep
+      @actions = []
+    end
+
+    contract Symbol, Hash => self
+    def add_filter(filter_name, params)
+      @actions << Nanoc::Int::ProcessingActions::Filter.new(filter_name, params)
+      self
+    end
+
+    contract String, C::Maybe[Hash] => self
+    def add_layout(layout_identifier, params)
+      @actions << Nanoc::Int::ProcessingActions::Layout.new(layout_identifier, params)
+      self
+    end
+
+    contract Symbol, C::Maybe[String] => self
+    def add_snapshot(snapshot_name, path)
+      will_add_snapshot(snapshot_name)
+      @actions << Nanoc::Int::ProcessingActions::Snapshot.new([snapshot_name], path ? [path] : [])
+      self
+    end
+
+    contract C::None => Nanoc::Int::ActionSequence
+    def action_sequence
+      Nanoc::Int::ActionSequence.new(@item_rep, actions: @actions)
+    end
+
+    private
+
+    def will_add_snapshot(name)
+      @_snapshot_names ||= Set.new
+      if @_snapshot_names.include?(name)
+        raise Nanoc::Int::Errors::CannotCreateMultipleSnapshotsWithSameName.new(@item_rep, name)
+      else
+        @_snapshot_names << name
+      end
+    end
+  end
+end

data/lib/nanoc/base/services/compiler.rb

@@ -51,25 +51,34 @@ module Nanoc::Int
         dependency_store: @dependency_store,
         action_sequence_store: @action_sequence_store,
         action_sequences: @action_sequences,
+        checksums: @checksums,
         reps: reps,
       )
     end
 
     def run_all
-      run_stage(preprocess_stage)
-      @action_sequences = run_stage(build_reps_stage)
+      prepare
+
+      run_stage(forget_outdated_dependencies_stage, @outdated_items)
+      run_stage(store_pre_compilation_state_stage(@action_sequences), @checksums)
       run_stage(prune_stage)
-      run_stage(load_stores_stage)
-      outdated_items = run_stage(determine_outdatedness_stage)
-      run_stage(forget_outdated_dependencies_stage, outdated_items)
-      run_stage(store_pre_compilation_state_stage)
-      run_stage(compile_reps_stage)
+      run_stage(compile_reps_stage(@action_sequences))
       run_stage(store_post_compilation_state_stage)
       run_stage(postprocess_stage)
     ensure
       run_stage(cleanup_stage)
     end
 
+    def prepare
+      # FIXME: State is ugly
+
+      run_stage(preprocess_stage)
+      @action_sequences = run_stage(build_reps_stage)
+      run_stage(load_stores_stage)
+      @checksums = run_stage(calculate_checksums_stage)
+      @outdated_items = run_stage(determine_outdatedness_stage)
+    end
+
     def compilation_context
       @_compilation_context ||= Nanoc::Int::CompilationContext.new(
         action_provider: action_provider,
@@ -90,6 +99,11 @@ module Nanoc::Int
       @action_sequences = build_reps_stage.run
     end
 
+    # TODO: remove
+    def calculate_checksums
+      @checksums = run_stage(calculate_checksums_stage)
+    end
+
     private
 
     def run_stage(stage, *args)
@@ -133,6 +147,15 @@ module Nanoc::Int
       )
     end
 
+    def calculate_checksums_stage
+      @_calculate_checksums_stage ||= Stages::CalculateChecksums.new(
+        items: @site.items,
+        layouts: @site.layouts,
+        code_snippets: @site.code_snippets,
+        config: @site.config,
+      )
+    end
+
     def determine_outdatedness_stage
       @_determine_outdatedness_stage ||= Stages::DetermineOutdatedness.new(
         reps: reps,
@@ -141,24 +164,21 @@ module Nanoc::Int
       )
     end
 
-    def store_pre_compilation_state_stage
+    def store_pre_compilation_state_stage(action_sequences)
       @_store_pre_compilation_state_stage ||= Stages::StorePreCompilationState.new(
         reps: @reps,
         layouts: site.layouts,
-        items: site.items,
-        code_snippets: site.code_snippets,
-        config: site.config,
         checksum_store: checksum_store,
         action_sequence_store: action_sequence_store,
-        action_sequences: @action_sequences,
+        action_sequences: action_sequences,
       )
     end
 
-    def compile_reps_stage
+    def compile_reps_stage(action_sequences)
       @_compile_reps_stage ||= Stages::CompileReps.new(
         outdatedness_store: @outdatedness_store,
         dependency_store: @dependency_store,
-        action_sequences: @action_sequences,
+        action_sequences: action_sequences,
         compilation_context: compilation_context,
         compiled_content_cache: compiled_content_cache,
       )

data/lib/nanoc/base/services/compiler/stages.rb

@@ -1,6 +1,7 @@
 module Nanoc::Int::Compiler::Stages
 end
 
+require_relative 'stages/calculate_checksums'
 require_relative 'stages/cleanup'
 require_relative 'stages/compile_reps'
 require_relative 'stages/determine_outdatedness'

data/lib/nanoc/base/services/compiler/stages/calculate_checksums.rb

@@ -0,0 +1,31 @@
+module Nanoc::Int::Compiler::Stages
+  class CalculateChecksums
+    def initialize(items:, layouts:, code_snippets:, config:)
+      @items = items
+      @layouts = layouts
+      @code_snippets = code_snippets
+      @config = config
+    end
+
+    def run
+      checksums = {}
+
+      [@items, @layouts].each do |documents|
+        documents.each do |document|
+          checksums[[document.reference, :content]] =
+            Nanoc::Int::Checksummer.calc_for_content_of(document)
+          checksums[[document.reference, :each_attribute]] =
+            Nanoc::Int::Checksummer.calc_for_each_attribute_of(document)
+        end
+      end
+
+      [@items, @layouts, @code_snippets, [@config]].each do |objs|
+        objs.each do |obj|
+          checksums[obj.reference] = Nanoc::Int::Checksummer.calc(obj)
+        end
+      end
+
+      Nanoc::Int::ChecksumCollection.new(checksums)
+    end
+  end
+end