nanoc 4.8.10 → 4.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 651f15c4ee22daacf31bab68c3ec1a00a02238f0
-  data.tar.gz: 6a8a41fd4ecc345ebb70814cd9f7f89d0cd6decc
+  metadata.gz: 686e6a239ceae1d59678f267f4aa4c5dfc46b45e
+  data.tar.gz: e80de3bfc0c9475292ad4f9f4fa886f87bd272a8
 SHA512:
-  metadata.gz: 0f9576114f97906cf843f19dcff2e84a45d4612165162e267ef10ab441e910b82fbaac55d1cc71f68d7add44214269c003eca73c31118119b7f9d238f08e3391
-  data.tar.gz: 66be4b141524b69d045e636ecc01b33c69c9e7f4267eb8ff7a5a6978c2b7fbb9c1960bf6cd482458484a4477dfc1aeb1821a03d4ec3e358c2de3c2009b727792
+  metadata.gz: b476ce18ea4cdd880de849b64bc5c8bbe1287a1b3cbd67a7a54a0fa079812107d9448f839785b391ae192147f331facb47e89d828a65c896aae5dad8b40a5c08
+  data.tar.gz: 8ffcb7d57ea237b0fef6490828d960247fd618c814990e14f0f707a55831f8288b2666cc21693792452f3d9d1e475aa9c33cbebc6807405d7749cda3022fedc9

data/.rubocop.yml

@@ -45,6 +45,7 @@ Lint/NestedMethodDefinition:
 Style/GlobalVars:
   Exclude:
     - 'test/**/*.rb'
+    - 'spec/**/*.rb'
 
 
 
@@ -165,3 +166,8 @@ Style/GuardClause:
 # Used for “undo work, whatever error happens”
 Lint/RescueWithoutErrorClass:
   Enabled: false
+
+# For the sake of consistency, it makes the most sense to retain $stderr.puts
+# when used in situations where $stderr.flush, $stderr.print, … are also used.
+Style/StderrPuts:
+  Enabled: false

data/NEWS.md

@@ -1,5 +1,12 @@
 # Nanoc news
 
+## 4.8.11 (2017-10-28)
+
+Enhancements:
+
+* Added `:save_with` parameter to `relativize_paths` filter (#1237) [Gregory Pakosz]
+* Made error messages more compact and easier to read
+
 ## 4.8.10 (2017-10-08)
 
 Fixes:

data/lib/nanoc.rb

@@ -19,28 +19,33 @@ module Nanoc
 end
 
 # Load external dependencies
+require 'addressable'
+require 'ddplugin'
 require 'hamster'
 require 'ref'
-require 'ddplugin'
-require 'addressable'
+require 'slow_enumerator_tools'
 
 # Load general requirements
 require 'cgi'
 require 'digest'
-require 'enumerator'
+require 'English'
 require 'fiber'
 require 'fileutils'
+require 'find'
 require 'forwardable'
+require 'net/http'
+require 'net/https'
+require 'open3'
 require 'pathname'
 require 'pstore'
 require 'set'
 require 'singleton'
 require 'tempfile'
-require 'thread'
 require 'time'
-require 'yaml'
+require 'timeout'
+require 'tmpdir'
 require 'uri'
-require 'English'
+require 'yaml'
 
 # Load Nanoc
 require 'nanoc/version'

data/lib/nanoc/base.rb

@@ -9,6 +9,7 @@ require_relative 'base/contracts_support'
 require_relative 'base/memoization'
 require_relative 'base/error'
 require_relative 'base/errors'
+require_relative 'base/changes_stream'
 
 require_relative 'base/entities'
 require_relative 'base/feature'

data/lib/nanoc/base/changes_stream.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Nanoc
+  class ChangesStream
+    class ChangesListener
+      def initialize(y)
+        @y = y
+      end
+
+      def unknown
+        @y << :unknown
+      end
+
+      def lib
+        @y << :lib
+      end
+
+      def to_stop(&block)
+        if block_given?
+          @to_stop = block
+        else
+          @to_stop
+        end
+      end
+    end
+
+    def initialize(enum: nil)
+      @enum = enum
+      @enum ||=
+        Enumerator.new do |y|
+          @listener = ChangesListener.new(y)
+          yield(@listener)
+        end.lazy
+    end
+
+    def stop
+      @listener&.to_stop&.call
+    end
+
+    def map
+      self.class.new(enum: @enum.map { |e| yield(e) })
+    end
+
+    def to_enum
+      @enum
+    end
+
+    def each
+      @enum.each { |e| yield(e) }
+      nil
+    end
+  end
+end

data/lib/nanoc/base/contracts_support.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'singleton'
-
 module Nanoc::Int
   # @api private
   module ContractsSupport

data/lib/nanoc/base/feature.rb

@@ -90,3 +90,6 @@ module Nanoc
     end
   end
 end
+
+Nanoc::Feature.define('live_cmd', version: '4.8')
+Nanoc::Feature.define('sensible_stack_traces', version: '4.8')

data/lib/nanoc/base/memoization.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'weakref'
-
 module Nanoc::Int
   # Adds support for memoizing functions.
   #

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

@@ -22,5 +22,13 @@ module Nanoc::Int
         Nanoc::Int::LayoutCollection.new(@config, objs)
       end
     end
+
+    def item_changes
+      SlowEnumeratorTools.merge(@data_sources.map(&:item_changes))
+    end
+
+    def layout_changes
+      SlowEnumeratorTools.merge(@data_sources.map(&:layout_changes))
+    end
   end
 end

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

@@ -98,6 +98,18 @@ module Nanoc
       []
     end
 
+    # @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."
+      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."
+      Enumerator.new { |_y| sleep }
+    end
+
     # Returns the collection of layouts (represented by {Nanoc::Int::Layout}) in
     # this site. The default implementation simply returns an empty array.
     #

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

@@ -5,11 +5,20 @@ module Nanoc::Int
     attr_reader :items
     attr_reader :layouts
 
-    def initialize(items, layouts)
+    def initialize(items, layouts, orig_data_source = nil)
       super({}, '/', '/', {})
 
       @items = items
       @layouts = layouts
+      @orig_data_source = orig_data_source
+    end
+
+    def item_changes
+      @orig_data_source ? @orig_data_source.item_changes : super
+    end
+
+    def layout_changes
+      @orig_data_source ? @orig_data_source.layout_changes : super
     end
   end
 end

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

@@ -17,5 +17,13 @@ module Nanoc::Int
     def layouts
       @data_source.layouts.map { |d| d.with_identifier_prefix(@layouts_prefix) }
     end
+
+    def item_changes
+      @data_source.item_changes
+    end
+
+    def layout_changes
+      @data_source.layout_changes
+    end
   end
 end

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

@@ -19,12 +19,7 @@ module Nanoc::Int
       Nanoc::Int::ConfigLoader.cwd_is_nanoc_site?
     end
 
-    private
-
-    def site_from_config(config)
-      code_snippets = code_snippets_from_config(config)
-      code_snippets.each(&:load)
-
+    def gen_data_source_for_config(config)
       data_sources_to_aggregate =
         with_data_sources(config) do |data_sources|
           data_sources.map do |ds|
@@ -32,7 +27,16 @@ module Nanoc::Int
           end
         end
 
-      data_source = Nanoc::Int::AggregateDataSource.new(data_sources_to_aggregate, config)
+      Nanoc::Int::AggregateDataSource.new(data_sources_to_aggregate, config)
+    end
+
+    private
+
+    def site_from_config(config)
+      code_snippets = code_snippets_from_config(config)
+      code_snippets.each(&:load)
+
+      data_source = gen_data_source_for_config(config)
 
       Nanoc::Int::Site.new(
         config: config,

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

@@ -78,7 +78,7 @@ module Nanoc::Int
       run_stage(prune_stage(reps))
       run_stage(compile_reps_stage(action_sequences, reps))
       run_stage(store_post_compilation_state_stage)
-      run_stage(postprocess_stage(reps), self)
+      run_stage(postprocess_stage, self)
     ensure
       run_stage(cleanup_stage)
     end
@@ -191,11 +191,10 @@ module Nanoc::Int
       )
     end
 
-    def postprocess_stage(reps)
+    def postprocess_stage
       @_postprocess_stage ||= Stages::Postprocess.new(
         action_provider: @action_provider,
         site: @site,
-        reps: reps,
       )
     end
 

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

@@ -4,15 +4,14 @@ module Nanoc::Int::Compiler::Stages
   class Postprocess
     include Nanoc::Int::ContractsSupport
 
-    def initialize(action_provider:, site:, reps:)
+    def initialize(action_provider:, site:)
       @action_provider = action_provider
       @site = site
-      @reps = reps
     end
 
     contract Nanoc::Int::Compiler => C::Any
     def run(compiler)
-      @action_provider.postprocess(@site, compiler, @reps)
+      @action_provider.postprocess(@site, compiler)
     end
   end
 end

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

@@ -13,7 +13,7 @@ module Nanoc::Int::Compiler::Stages
       return if @site.preprocessed?
 
       if @action_provider.need_preprocessing?
-        @site.data_source = Nanoc::Int::InMemDataSource.new(@site.items, @site.layouts)
+        @site.data_source = Nanoc::Int::InMemDataSource.new(@site.items, @site.layouts, @site.data_source)
         @action_provider.preprocess(@site)
 
         @dependency_store.items = @site.items

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'find'
-
 module Nanoc
   # Responsible for finding and deleting files in the site’s output directory
   # that are not managed by Nanoc.

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'tmpdir'
-
 module Nanoc::Int
   # @api private
   class TempFilenameFactory

data/lib/nanoc/checking/checks/external_links.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'net/https'
-require 'timeout'
-require 'uri'
-
 module ::Nanoc::Checking::Checks
   # A validator that verifies that all external links point to a location that exists.
   #

data/lib/nanoc/checking/checks/internal_links.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'uri'
-
 module Nanoc::Checking::Checks
   # A check that verifies that all internal links point to a location that exists.
   #

data/lib/nanoc/checking/checks/stale.rb

@@ -6,8 +6,6 @@ module Nanoc::Checking::Checks
     identifier :stale
 
     def run
-      require 'set'
-
       output_filenames.each do |f|
         next if pruner.filename_excluded?(f)
         next if item_rep_paths.include?(f)

data/lib/nanoc/cli.rb

@@ -20,6 +20,7 @@ require_relative 'cli/command_runner'
 require_relative 'cli/cleaning_stream'
 require_relative 'cli/stream_cleaners'
 require_relative 'cli/error_handler'
+require_relative 'cli/stack_trace_writer'
 
 require_relative 'cli/commands/compile_listeners/abstract'
 require_relative 'cli/commands/compile_listeners/debug_printer'
@@ -113,7 +114,12 @@ module Nanoc::CLI
     # Add other commands
     cmd_filenames = Dir[__dir__ + '/cli/commands/*.rb']
     cmd_filenames.each do |cmd_filename|
-      next if File.basename(cmd_filename, '.rb') == 'nanoc'
+      basename = File.basename(cmd_filename, '.rb')
+
+      next if basename == 'nanoc'
+
+      next if basename == 'live' && !Nanoc::Feature.enabled?(Nanoc::Feature::LIVE_CMD)
+
       cmd = load_command_at(cmd_filename)
       add_command(cmd)
     end

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

@@ -9,7 +9,6 @@ module Nanoc::CLI::Commands::CompileListeners
 
     # @see Listener#start
     def start
-      require 'tempfile'
       setup_diffs
       old_contents = {}
       Nanoc::Int::NotificationCenter.on(:will_write_rep, self) do |rep, path|
@@ -65,8 +64,6 @@ module Nanoc::CLI::Commands::CompileListeners
     end
 
     def diff_strings(a, b)
-      require 'open3'
-
       # Create files
       Tempfile.open('old') do |old_file|
         Tempfile.open('new') do |new_file|

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+usage 'live'
+summary 'auto-recompile and serve'
+description <<~EOS
+  Starts the live recompiler along with the static web server. Unless specified,
+  the web server will run on port 3000 and listen on all IP addresses. Running
+  this static web server requires `adsf` (not `asdf`!).
+EOS
+
+required :H, :handler, 'specify the handler to use (webrick/mongrel/...)'
+required :o, :host,    'specify the host to listen on (default: 127.0.0.1)'
+required :p, :port,    'specify the port to listen on (default: 3000)'
+
+module Nanoc::CLI::Commands
+  class Live < ::Nanoc::CLI::CommandRunner
+    def run
+      self.class.enter_site_dir
+
+      Thread.new do
+        Thread.current.abort_on_exception = true
+        Nanoc::CLI::Commands::View.new(options, [], self).run
+      end
+
+      Nanoc::Extra::LiveRecompiler.new(command_runner: self).run
+    end
+  end
+end
+
+runner Nanoc::CLI::Commands::Live