nanoc 4.8.10 → 4.8.11

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

@@ -20,7 +20,7 @@ module Nanoc::CLI::Commands
       load_adsf
       require 'rack'
 
-      @site = load_site
+      config = Nanoc::Int::ConfigLoader.new.new_from_cwd
 
       # Set options
       options_for_rack = {
@@ -40,16 +40,15 @@ module Nanoc::CLI::Commands
       end
 
       # Build app
-      site = @site
       app = Rack::Builder.new do
         use Rack::CommonLogger
         use Rack::ShowExceptions
         use Rack::Lint
         use Rack::Head
         use Adsf::Rack::IndexFileFinder,
-            root: site.config[:output_dir],
-            index_filenames: site.config[:index_filenames]
-        run Rack::File.new(site.config[:output_dir])
+            root: config[:output_dir],
+            index_filenames: config[:index_filenames]
+        run Rack::File.new(config[:output_dir])
       end.to_app
 
       # Print a link

data/lib/nanoc/cli/error_handler.rb

@@ -64,13 +64,16 @@ module Nanoc::CLI
 
       # Run
       yield
-    rescue Nanoc::Int::Errors::GenericTrivial => e
-      $stderr.puts "Error: #{e.message}"
-      exit(1)
     rescue Interrupt
       exit(1)
     rescue StandardError, ScriptError => e
-      print_error(e)
+      if trivial?(e)
+        $stderr.puts "Error: #{e.message}"
+        resolution = resolution_for(e)
+        $stderr.puts resolution if resolution
+      else
+        print_error(e)
+      end
       exit(1)
     end
 
@@ -109,17 +112,21 @@ module Nanoc::CLI
     #
     # @return [void]
     def write_compact_error(error, stream)
-      # Header
       stream.puts
       stream.puts 'Captain! We’ve been hit!'
 
-      # Sections
-      write_error_message(stream, error)
-      write_item_rep(stream, error)
-      write_stack_trace(stream, error)
+      if forwards_stack_trace?
+        write_stack_trace(stream, error)
+        write_error_message(stream, error)
+        write_item_rep(stream, error)
+      else
+        write_error_message(stream, error)
+        write_item_rep(stream, error)
+        write_stack_trace(stream, error)
+      end
 
-      # Issue link
-      write_issue_link(stream)
+      stream.puts
+      stream.puts 'A detailed crash log has been written to ./crash.log.'
     end
 
     # Writes a verbose representation of the error on the given stream.
@@ -130,10 +137,8 @@ module Nanoc::CLI
     #
     # @return [void]
     def write_verbose_error(error, stream)
-      # Header
       stream.puts "Crashlog created at #{Time.now}"
 
-      # Sections
       write_error_message(stream, error, verbose: true)
       write_item_rep(stream, error, verbose: true)
       write_stack_trace(stream, error, verbose: true)
@@ -144,6 +149,14 @@ module Nanoc::CLI
       write_load_paths(stream, verbose: true)
     end
 
+    # @api private
+    def forwards_stack_trace?
+      feature_enabled = Nanoc::Feature.enabled?(Nanoc::Feature::SENSIBLE_STACK_TRACES)
+      ruby_2_5_used = ruby_version.start_with?('2.5')
+
+      feature_enabled || ruby_2_5_used
+    end
+
     protected
 
     # @return [Hash<String, Array>] A hash containing the gem names as keys and gem versions as value
@@ -191,6 +204,15 @@ module Nanoc::CLI
       'w3c_validators' => 'w3c_validators',
     }.freeze
 
+    def trivial?(error)
+      case error
+      when Nanoc::Int::Errors::GenericTrivial, Errno::EADDRINUSE
+        true
+      else
+        false
+      end
+    end
+
     # Attempts to find a resolution for the given error, or nil if no
     # resolution can be automatically obtained.
     #
@@ -221,6 +243,9 @@ module Nanoc::CLI
           'be modified once compilation has started. Such data includes ' \
           'content and attributes of items and layouts, and filter arguments.'
         end
+      when Errno::EADDRINUSE
+        'There already is a server running. Either shut down that one, or ' \
+        'specify a different port to run this server on.'
       end
     end
 
@@ -228,14 +253,17 @@ module Nanoc::CLI
       defined?(Bundler) && Bundler::SharedHelpers.in_bundle?
     end
 
+    def ruby_version
+      RUBY_VERSION
+    end
+
     def write_section_header(stream, title, verbose: false)
       stream.puts
+
       if verbose
         stream.puts '===== ' + title.upcase + ':'
-      else
-        stream.puts "\e[1m\e[31m" + title + ':' + "\e[0m"
+        stream.puts
       end
-      stream.puts
     end
 
     def write_error_message(stream, error, verbose: false)
@@ -243,7 +271,11 @@ module Nanoc::CLI
 
       error = unwrap_error(error)
 
-      stream.puts "#{error.class}: #{error.message}"
+      message = "#{error.class}: #{error.message}"
+      unless verbose
+        message = "\e[1m\e[31m" + message + "\e[0m"
+      end
+      stream.puts message
       resolution = resolution_for(error)
       stream.puts resolution.to_s if resolution
     end
@@ -254,30 +286,14 @@ module Nanoc::CLI
       write_section_header(stream, 'Item being compiled', verbose: verbose)
 
       item_rep = error.item_rep
-      stream.puts "Item identifier: #{item_rep.item.identifier}"
-      stream.puts "Item rep name:   #{item_rep.name.inspect}"
+      stream.puts "Current item: #{item_rep.item.identifier} (#{item_rep.name.inspect} representation)"
     end
 
     def write_stack_trace(stream, error, verbose: false)
       write_section_header(stream, 'Stack trace', verbose: verbose)
 
-      error = unwrap_error(error)
-
-      count = verbose ? -1 : 10
-      error.backtrace[0...count].each_with_index do |item, index|
-        stream.puts "  #{index}. #{item}"
-      end
-      if !verbose && error.backtrace.size > count
-        stream.puts "  ... #{error.backtrace.size - count} more lines omitted. See full crash log for details."
-      end
-    end
-
-    def write_issue_link(stream, _params = {})
-      stream.puts
-      stream.puts 'If you believe this is a bug in Nanoc, please do report it at'
-      stream.puts '-> https://github.com/nanoc/nanoc/issues/new <-'
-      stream.puts
-      stream.puts 'A detailed crash log has been written to ./crash.log.'
+      writer = StackTraceWriter.new(stream, forwards: forwards_stack_trace?)
+      writer.write(unwrap_error(error), verbose: verbose)
     end
 
     def write_version_information(stream, verbose: false)

data/lib/nanoc/cli/logger.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'singleton'
-
 module Nanoc::CLI
   # Nanoc::CLI::Logger is a singleton class responsible for generating
   # feedback in the terminal.

data/lib/nanoc/cli/stack_trace_writer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Nanoc::CLI
+  # @api private
+  class StackTraceWriter
+    def initialize(stream, forwards:)
+      @stream = stream
+      @forwards = forwards
+    end
+
+    def write(error, verbose:)
+      if @forwards
+        write_forwards(error, verbose: verbose)
+      else
+        write_backwards(error, verbose: verbose)
+      end
+    end
+
+    private
+
+    def write_backwards(error, verbose:)
+      count = verbose ? -1 : 10
+
+      error.backtrace[0...count].each_with_index do |item, index|
+        @stream.puts "  #{index}. #{item}"
+      end
+
+      if !verbose && error.backtrace.size > count
+        @stream.puts "  ... #{error.backtrace.size - count} lines omitted (see crash.log for details)"
+      end
+    end
+
+    def write_forwards(error, verbose:)
+      count = 10
+      backtrace = verbose ? error.backtrace : error.backtrace.take(count)
+
+      if !verbose && error.backtrace.size > count
+        @stream.puts "  ... #{error.backtrace.size - count} lines omitted (see crash.log for details)"
+      end
+
+      backtrace.each_with_index.to_a.reverse.each do |(item, index)|
+        if index.zero?
+          @stream.puts "  #{item}"
+        else
+          @stream.puts "  #{index}. from #{item}"
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/data_sources/filesystem.rb

@@ -74,6 +74,31 @@ module Nanoc::DataSources
       load_objects(layouts_dir_name, Nanoc::Int::Layout)
     end
 
+    def item_changes
+      changes_for_dir(content_dir_name)
+    end
+
+    def layout_changes
+      changes_for_dir(layouts_dir_name)
+    end
+
+    def changes_for_dir(dir)
+      require 'listen'
+
+      Nanoc::ChangesStream.new do |cl|
+        listener =
+          Listen.to(dir, latency: 0.0, wait_for_delay: 0.0) do |_modifieds, _addeds, _deleteds|
+            cl.unknown
+          end
+
+        listener.start
+
+        cl.to_stop { listener.stop }
+
+        sleep
+      end
+    end
+
     protected
 
     class ProtoDocument

data/lib/nanoc/extra.rb

@@ -16,6 +16,7 @@ module Nanoc::Extra
 end
 
 require_relative 'extra/link_collector.rb'
+require_relative 'extra/live_recompiler'
 require_relative 'extra/piper'
 require_relative 'extra/jruby_nokogiri_warner'
 require_relative 'extra/core_ext'

data/lib/nanoc/extra/jruby_nokogiri_warner.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'singleton'
-
 module Nanoc::Extra
   # @api private
   class JRubyNokogiriWarner

data/lib/nanoc/extra/link_collector.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module ::Nanoc::Extra
   # @api private
   class LinkCollector

data/lib/nanoc/extra/live_recompiler.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Nanoc::Extra
+  class LiveRecompiler
+    def initialize(command_runner:)
+      @command_runner = command_runner
+    end
+
+    def run
+      run_parent do |site|
+        handle_changes(site, @command_runner)
+      end
+    end
+
+    private
+
+    def gen_changes_for_child(site)
+      changes = [
+        site.data_source.item_changes,
+        site.data_source.layout_changes,
+        gen_config_and_rules_changes,
+      ]
+
+      SlowEnumeratorTools.batch(SlowEnumeratorTools.merge(changes))
+    end
+
+    def run_child(pipe_write, pipe_read)
+      pipe_write.close
+
+      site = Nanoc::Int::SiteLoader.new.new_from_cwd
+      changes_enum = gen_changes_for_child(site)
+      yield(site)
+
+      quit = Object.new
+      parent_enum = Enumerator.new do |y|
+        pipe_read.read
+        y << quit
+      end
+
+      SlowEnumeratorTools.merge([parent_enum, changes_enum]).each do |e|
+        break if quit.equal?(e)
+
+        $stderr.print 'Reloading site… '
+        $stderr.flush
+        site_loader = Nanoc::Int::SiteLoader.new
+        site = Nanoc::Int::Site.new(
+          config: Nanoc::Int::ConfigLoader.new.new_from_cwd,
+          data_source: site_loader.gen_data_source_for_config(site.config),
+          code_snippets: site.code_snippets,
+        )
+        $stderr.puts 'done'
+
+        yield(site)
+      end
+
+      exit 0
+    rescue Interrupt
+      exit 0
+    end
+
+    def run_parent
+      # create initial child
+      pipe_read, pipe_write = IO.pipe
+      fork { run_child(pipe_write, pipe_read) { |s| yield(s) } }
+      pipe_read.close
+
+      gen_lib_changes.each do |_e|
+        # stop child
+        pipe_write.write('q')
+        pipe_write.close
+        Process.wait
+
+        # create new child
+        pipe_read, pipe_write = IO.pipe
+        fork { run_child(pipe_write, pipe_read) { |s| yield(s) } }
+        pipe_read.close
+      end
+    rescue Interrupt
+    end
+
+    def handle_changes(site, command_runner)
+      time_before = Time.now
+
+      puts 'Compiling site…'
+      compiler = Nanoc::Int::Compiler.new_for(site)
+      listener = Nanoc::CLI::Commands::CompileListeners::Aggregate.new(
+        command_runner: command_runner,
+        site: site,
+        compiler: compiler,
+      )
+      listener.run_while do
+        compiler.run_until_end
+      end
+
+      time_after = Time.now
+      puts "Site compiled in #{format('%.2f', time_after - time_before)}s."
+      puts
+    end
+
+    def gen_lib_changes
+      require 'listen'
+
+      Nanoc::ChangesStream.new do |cl|
+        opts = {
+          latency: 0.0,
+          wait_for_delay: 0.0,
+        }
+
+        listener = Listen.to('lib', opts) { |*| cl.lib }
+        listener.start
+        sleep
+      end
+    end
+
+    def gen_config_and_rules_changes
+      require 'listen'
+
+      Nanoc::ChangesStream.new do |cl|
+        opts = {
+          only: /(\/|\A)(nanoc\.yaml|config\.yaml|rules|Rules|rules\.rb|Rules\.rb)\z/,
+          latency: 0.0,
+          wait_for_delay: 0.0,
+        }
+
+        listener = Listen.to('.', opts) { |*| cl.unknown }
+        listener.start
+        sleep
+      end
+    end
+  end
+end