nanoc 4.8.9 → 4.8.10

data/lib/nanoc/base/views/post_compile_item_rep_view.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class PostCompileItemRepView < ::Nanoc::ItemRepView
+  class PostCompileItemRepView < ::Nanoc::BasicItemRepView
+    def item_view_class
+      Nanoc::PostCompileItemView
+    end
+
     def compiled_content(snapshot: nil)
-      snapshot_contents = @context.compilation_context.compiled_content_cache[unwrap]
+      compilation_context = @context.compilation_context
+      snapshot_contents = compilation_context.compiled_content_cache[unwrap]
 
       snapshot_name = snapshot || (snapshot_contents[:pre] ? :pre : :last)
 

data/lib/nanoc/base/views/post_compile_item_view.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc
-  class PostCompileItemView < Nanoc::ItemWithRepsView
+  class PostCompileItemView < Nanoc::CompilationItemView
     def reps
       Nanoc::PostCompileItemRepCollectionView.new(@context.reps[unwrap], @context)
     end

data/lib/nanoc/base/views/{view_context.rb → view_context_for_compilation.rb}

@@ -2,13 +2,22 @@
 
 module Nanoc
   # @api private
-  class ViewContext
+  class ViewContextForCompilation
+    include Nanoc::Int::ContractsSupport
+
     attr_reader :reps
     attr_reader :items
     attr_reader :dependency_tracker
     attr_reader :compilation_context
     attr_reader :snapshot_repo
 
+    contract C::KeywordArgs[
+      reps: Nanoc::Int::ItemRepRepo,
+      items: Nanoc::Int::IdentifiableCollection,
+      dependency_tracker: C::Any,
+      compilation_context: C::Any,
+      snapshot_repo: C::Any,
+    ] => C::Any
     def initialize(reps:, items:, dependency_tracker:, compilation_context:, snapshot_repo:)
       @reps = reps
       @items = items

data/lib/nanoc/base/views/view_context_for_pre_compilation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nanoc
+  # @api private
+  class ViewContextForPreCompilation
+    include Nanoc::Int::ContractsSupport
+
+    attr_reader :items
+    attr_reader :dependency_tracker
+
+    contract C::KeywordArgs[items: Nanoc::Int::IdentifiableCollection] => C::Any
+    def initialize(items:)
+      @items = items
+
+      @dependency_tracker = Nanoc::Int::DependencyTracker::Null.new
+    end
+  end
+end

data/lib/nanoc/base/views/view_context_for_shell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Nanoc
+  # @api private
+  class ViewContextForShell
+    include Nanoc::Int::ContractsSupport
+
+    attr_reader :items
+    attr_reader :reps
+    attr_reader :dependency_tracker
+
+    contract C::KeywordArgs[
+      items: Nanoc::Int::IdentifiableCollection,
+      reps: Nanoc::Int::ItemRepRepo,
+    ] => C::Any
+    def initialize(items:, reps:)
+      @items = items
+      @reps = reps
+
+      @dependency_tracker = Nanoc::Int::DependencyTracker::Null.new
+    end
+  end
+end

data/lib/nanoc/checking/check.rb

@@ -22,7 +22,11 @@ module Nanoc::Checking
       output_filenames = Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
 
       # FIXME: ugly
-      view_context = site.compiler.compilation_context.create_view_context(Nanoc::Int::DependencyTracker::Null.new)
+      compiler = Nanoc::Int::Compiler.new_for(site)
+      res = compiler.run_until_reps_built
+      reps = res.fetch(:reps)
+      compilation_context = compiler.compilation_context(reps: reps)
+      view_context = compilation_context.create_view_context(Nanoc::Int::DependencyTracker::Null.new)
 
       context = {
         items: Nanoc::PostCompileItemCollectionView.new(site.items, view_context),

data/lib/nanoc/checking/runner.rb

@@ -111,7 +111,7 @@ module Nanoc::Checking
       return [] if classes.empty?
 
       # TODO: remove me
-      @site.compiler.build_reps
+      Nanoc::Int::Compiler.new_for(@site).run_until_reps_built
 
       checks = []
       issues = Set.new

data/lib/nanoc/cli.rb

@@ -26,6 +26,7 @@ require_relative 'cli/commands/compile_listeners/debug_printer'
 require_relative 'cli/commands/compile_listeners/diff_generator'
 require_relative 'cli/commands/compile_listeners/file_action_printer'
 require_relative 'cli/commands/compile_listeners/timing_recorder'
+require_relative 'cli/commands/compile_listeners/aggregate'
 
 # @api private
 module Nanoc::CLI

data/lib/nanoc/cli/command_runner.rb

@@ -50,20 +50,14 @@ module Nanoc::CLI
     # Asserts that the current working directory contains a site and loads the site into memory.
     #
     # @return [void]
-    def load_site(preprocess: false)
+    def load_site
       self.class.enter_site_dir
 
       $stderr.print 'Loading site… '
       $stderr.flush
-
       site = Nanoc::Int::SiteLoader.new.new_from_cwd
 
-      if preprocess
-        site.compiler.action_provider.preprocess(site)
-      end
-
       $stderr.puts 'done'
-
       site
     end
 

data/lib/nanoc/cli/commands/check.rb

@@ -14,9 +14,9 @@ module Nanoc::CLI::Commands
   class Check < ::Nanoc::CLI::CommandRunner
     def run
       validate_options_and_arguments
-      @site = load_site(preprocess: true)
+      site = load_site
 
-      runner = Nanoc::Checking::Runner.new(@site)
+      runner = Nanoc::Checking::Runner.new(site)
 
       if options[:list]
         runner.list_checks

data/lib/nanoc/cli/commands/compile.rb

@@ -11,65 +11,26 @@ module Nanoc::CLI::Commands
   class Compile < ::Nanoc::CLI::CommandRunner
     attr_accessor :listener_classes
 
-    def initialize(options, arguments, command)
-      super
-      @listener_classes = default_listener_classes
-    end
-
     def run
       time_before = Time.now
 
       @site = load_site
 
       puts 'Compiling site…'
-      run_listeners_while do
-        @site.compile
+      compiler = Nanoc::Int::Compiler.new_for(@site)
+      listener = Nanoc::CLI::Commands::CompileListeners::Aggregate.new(
+        command_runner: self,
+        site: @site,
+        compiler: compiler,
+      )
+      listener.run_while do
+        compiler.run_until_end
       end
 
       time_after = Time.now
       puts
       puts "Site compiled in #{format('%.2f', time_after - time_before)}s."
     end
-
-    protected
-
-    def default_listener_classes
-      [
-        Nanoc::CLI::Commands::CompileListeners::DiffGenerator,
-        Nanoc::CLI::Commands::CompileListeners::DebugPrinter,
-        Nanoc::CLI::Commands::CompileListeners::TimingRecorder,
-        Nanoc::CLI::Commands::CompileListeners::FileActionPrinter,
-      ]
-    end
-
-    def setup_listeners
-      @listeners =
-        @listener_classes
-        .select { |klass| klass.enable_for?(self, @site) }
-        .map    { |klass| klass.new(reps: reps) }
-
-      @listeners.each(&:start_safely)
-    end
-
-    def listeners
-      @listeners
-    end
-
-    def run_listeners_while
-      setup_listeners
-      yield
-    ensure
-      teardown_listeners
-    end
-
-    def teardown_listeners
-      return unless @listeners
-      @listeners.reverse_each(&:stop_safely)
-    end
-
-    def reps
-      @site.compiler.reps
-    end
   end
 end
 

data/lib/nanoc/cli/commands/compile_listeners/abstract.rb

@@ -8,12 +8,21 @@ module Nanoc::CLI::Commands::CompileListeners
       true
     end
 
+    # @abstract
     def start
       raise NotImplementedError, "Subclasses of #{self.class} must implement #start"
     end
 
+    # @abstract
     def stop; end
 
+    def run_while
+      start
+      yield
+    ensure
+      stop
+    end
+
     def start_safely
       start
       @_started = true

data/lib/nanoc/cli/commands/compile_listeners/aggregate.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Nanoc::CLI::Commands::CompileListeners
+  class Aggregate < Abstract
+    def initialize(command_runner:, site:, compiler:)
+      @site = site
+      @compiler = compiler
+      @command_runner = command_runner
+
+      @listener_classes = self.class.default_listener_classes
+    end
+
+    def start
+      setup_listeners
+    end
+
+    def stop
+      teardown_listeners
+    end
+
+    def self.default_listener_classes
+      [
+        Nanoc::CLI::Commands::CompileListeners::DiffGenerator,
+        Nanoc::CLI::Commands::CompileListeners::DebugPrinter,
+        Nanoc::CLI::Commands::CompileListeners::TimingRecorder,
+        Nanoc::CLI::Commands::CompileListeners::FileActionPrinter,
+      ]
+    end
+
+    protected
+
+    def setup_listeners
+      res = @compiler.run_until_reps_built
+      reps = res.fetch(:reps)
+
+      @listeners =
+        @listener_classes
+        .select { |klass| klass.enable_for?(@command_runner, @site) }
+        .map    { |klass| klass.new(reps: reps) }
+
+      @listeners.each(&:start_safely)
+    end
+
+    def teardown_listeners
+      return unless @listeners
+      @listeners.reverse_each(&:stop_safely)
+    end
+  end
+end

data/lib/nanoc/cli/commands/deploy.rb

@@ -15,7 +15,8 @@ option :n, :'dry-run',      'show what would be deployed'
 module Nanoc::CLI::Commands
   class Deploy < ::Nanoc::CLI::CommandRunner
     def run
-      @site = load_site(preprocess: true)
+      @site = load_site
+      Nanoc::Int::Compiler.new_for(@site).run_until_preprocessed
 
       if options[:'list-deployers']
         list_deployers

data/lib/nanoc/cli/commands/prune.rb

@@ -17,13 +17,14 @@ flag :n, :'dry-run', 'print files to be deleted instead of actually deleting the
 module Nanoc::CLI::Commands
   class Prune < ::Nanoc::CLI::CommandRunner
     def run
-      @site = load_site(preprocess: true)
-      @site.compiler.build_reps
+      @site = load_site
+      res = Nanoc::Int::Compiler.new_for(@site).run_until_reps_built
+      reps = res.fetch(:reps)
 
       if options.key?(:yes)
-        Nanoc::Pruner.new(@site.config, @site.compiler.reps, exclude: prune_config_exclude).run
+        Nanoc::Pruner.new(@site.config, reps, exclude: prune_config_exclude).run
       elsif options.key?(:'dry-run')
-        Nanoc::Pruner.new(@site.config, @site.compiler.reps, exclude: prune_config_exclude, dry_run: true).run
+        Nanoc::Pruner.new(@site.config, reps, exclude: prune_config_exclude, dry_run: true).run
       else
         $stderr.puts 'WARNING: Since the prune command is a destructive command, it requires an additional --yes flag in order to work.'
         $stderr.puts

data/lib/nanoc/cli/commands/shell.rb

@@ -13,7 +13,8 @@ module Nanoc::CLI::Commands
     def run
       require 'pry'
 
-      @site = load_site(preprocess: options[:preprocess])
+      @site = load_site
+      Nanoc::Int::Compiler.new_for(@site).run_until_preprocessed if options[:preprocess]
 
       Nanoc::Int::Context.new(env).pry
     end
@@ -31,12 +32,9 @@ module Nanoc::CLI::Commands
     end
 
     def self.view_context_for(site)
-      Nanoc::ViewContext.new(
-        reps: reps_for(site),
+      Nanoc::ViewContextForShell.new(
         items: site.items,
-        dependency_tracker: Nanoc::Int::DependencyTracker::Null.new,
-        compilation_context: nil,
-        snapshot_repo: nil,
+        reps: reps_for(site),
       )
     end
 

data/lib/nanoc/cli/commands/show-data.rb

@@ -11,25 +11,20 @@ EOS
 module Nanoc::CLI::Commands
   class ShowData < ::Nanoc::CLI::CommandRunner
     def run
-      @site = load_site(preprocess: true)
+      site = load_site
+      res = Nanoc::Int::Compiler.new_for(site).run_until_precompiled
 
-      # Get data
-      items   = @site.items
-      layouts = @site.layouts
-
-      # Get dependency tracker
-      compiler = @site.compiler
-      compiler.load_stores
-      dependency_store = compiler.dependency_store
-
-      # Build reps
-      compiler.build_reps
+      items                = site.items
+      layouts              = site.layouts
+      reps                 = res.fetch(:reps)
+      dependency_store     = res.fetch(:dependency_store)
+      outdatedness_checker = res.fetch(:outdatedness_checker)
 
       # Print data
       print_item_dependencies(items, dependency_store)
-      print_item_rep_paths(items)
-      print_item_rep_outdatedness(items, compiler)
-      print_layouts(layouts, compiler)
+      print_item_rep_paths(items, reps)
+      print_item_rep_outdatedness(items, outdatedness_checker, reps)
+      print_layouts(layouts, outdatedness_checker)
     end
 
     protected
@@ -42,10 +37,10 @@ module Nanoc::CLI::Commands
       end
     end
 
-    def sorted_reps_with_prev(items)
+    def sorted_reps_with_prev(items, reps)
       prev = nil
       items.sort_by(&:identifier).each do |item|
-        @site.compiler.reps[item].sort_by { |r| r.name.to_s }.each do |rep|
+        reps[item].sort_by { |r| r.name.to_s }.each do |rep|
           yield(rep, prev)
           prev = rep
         end
@@ -131,10 +126,10 @@ module Nanoc::CLI::Commands
       end
     end
 
-    def print_item_rep_paths(items)
+    def print_item_rep_paths(items, reps)
       print_header('Item representation paths')
 
-      sorted_reps_with_prev(items) do |rep, prev|
+      sorted_reps_with_prev(items, reps) do |rep, prev|
         puts if prev
         puts "item #{rep.item.identifier}, rep #{rep.name}:"
         if rep.raw_paths.empty?
@@ -149,29 +144,27 @@ module Nanoc::CLI::Commands
       end
     end
 
-    def print_item_rep_outdatedness(items, compiler)
+    def print_item_rep_outdatedness(items, outdatedness_checker, reps)
       print_header('Item representation outdatedness')
 
-      sorted_reps_with_prev(items) do |rep, prev|
+      sorted_reps_with_prev(items, reps) do |rep, prev|
         puts if prev
         puts "item #{rep.item.identifier}, rep #{rep.name}:"
-        print_outdatedness_reasons_for(rep, compiler)
+        print_outdatedness_reasons_for(rep, outdatedness_checker)
       end
     end
 
-    def print_layouts(layouts, compiler)
+    def print_layouts(layouts, outdatedness_checker)
       print_header('Layouts')
 
       sorted_with_prev(layouts) do |layout, prev|
         puts if prev
         puts "layout #{layout.identifier}:"
-        print_outdatedness_reasons_for(layout, compiler)
+        print_outdatedness_reasons_for(layout, outdatedness_checker)
       end
     end
 
-    def print_outdatedness_reasons_for(obj, compiler)
-      compiler.calculate_checksums
-      outdatedness_checker = compiler.create_outdatedness_checker
+    def print_outdatedness_reasons_for(obj, outdatedness_checker)
       reasons = outdatedness_checker.outdatedness_reasons_for(obj)
       if reasons.any?
         puts '  is outdated:'