nanoc 4.8.12 → 4.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5cc17f8346af531417d26173e8610348080326f2f9faceb6485e19d9fc9c194
-  data.tar.gz: 2e9ebdd0c7da3bb1d4119b4dc8ca51dc840b66ff191af0336a88da006b5af8f4
+  metadata.gz: b1fd7ed8596d83be40be2bcfc0e6133dbda0fa89f71ab9d8e04ba2250873bc1f
+  data.tar.gz: 9f03533a81092eed23196203db3420e0f12d00afe55c069af5cde66b4ddf3497
 SHA512:
-  metadata.gz: d3674db085f03b8a75de0c39c202c69769b77317a830eb3ffb8164e14959842270e16c8cc153f1e8de75ba1e35a6c23e6c410a35a459873173664a71829b9373
-  data.tar.gz: 650b49e7c74857d1d2dfd3fe16edd60005a0a47cd06799cc894813896edf406560f8712063959f94993d40bdaf7bf308a382f5c165a12d9d96a1759b9b7ea3fa
+  metadata.gz: d6cb159b049f179d74e3db094260ac6d382b2c9904a2f3344e77ab77116820e7aaacbe7f16fb01ff3fb34cb3204612f6bd1b259cb5aa2e8c463beb34ad3fa582
+  data.tar.gz: 30a00c3a821c24368f3348f983e07045887d221f297f49e26e5e02f928d70732a8e314ebdd2a722b0648333867623639581ff42414ce70cdf1bcddc723a773fe

data/NEWS.md

@@ -1,5 +1,11 @@
 # Nanoc news
 
+## 4.8.13 (2017-11-16)
+
+Enhancements:
+
+* Added `-L`/`--live-reload` option to `nanoc view` (#1251)
+
 ## 4.8.12 (2017-11-16)
 
 Fixes:

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

@@ -7,7 +7,7 @@ module Nanoc
       include Nanoc::Int::ContractsSupport
 
       # @return [Nanoc::Int::Content]
-      attr_accessor :content
+      attr_reader :content
 
       # @return [Hash]
       def attributes
@@ -86,6 +86,21 @@ module Nanoc
         @identifier = Nanoc::Identifier.from(new_identifier)
       end
 
+      contract Nanoc::Int::Content => C::Any
+      def content=(new_content)
+        @content = new_content
+
+        @checksum_data = nil
+        @content_checksum_data = nil
+      end
+
+      def set_attribute(key, value)
+        attributes[key] = value
+
+        @checksum_data = nil
+        @attributes_checksum_data = nil
+      end
+
       contract C::None => String
       def inspect
         "<#{self.class} identifier=\"#{identifier}\">"

data/lib/nanoc/base/feature.rb

@@ -6,7 +6,7 @@ module Nanoc
   # @example Defining a feature and checking its enabledness
   #
   #     Nanoc::Feature.define('environments', version: '4.3')
-  #     Nanoc::Feaure.enabled?(Nanoc::Feature::ENVIRONMENTS)
+  #     Nanoc::Feature.enabled?(Nanoc::Feature::ENVIRONMENTS)
   #
   module Feature
     # Defines a new feature with the given name, experimental in the given

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

@@ -8,9 +8,9 @@ module Nanoc::Int
   class ActionSequenceStore < ::Nanoc::Int::Store
     include Nanoc::Int::ContractsSupport
 
-    contract C::KeywordArgs[site: Nanoc::Int::Site] => C::Any
-    def initialize(site:)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'rule_memory'), 1)
+    contract C::KeywordArgs[config: Nanoc::Int::Configuration] => C::Any
+    def initialize(config:)
+      super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'rule_memory'), 1)
 
       @action_sequences = {}
     end

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

@@ -13,9 +13,9 @@ module Nanoc::Int
 
     c_obj = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::CodeSnippet]
 
-    contract C::KeywordArgs[site: C::Maybe[Nanoc::Int::Site], objects: C::IterOf[c_obj]] => C::Any
-    def initialize(site: nil, objects:)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'checksums'), 2)
+    contract C::KeywordArgs[config: Nanoc::Int::Configuration, objects: C::IterOf[c_obj]] => C::Any
+    def initialize(config:, objects:)
+      super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'checksums'), 2)
 
       @objects = objects
 

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

@@ -8,9 +8,9 @@ module Nanoc::Int
   class CompiledContentCache < ::Nanoc::Int::Store
     include Nanoc::Int::ContractsSupport
 
-    contract C::KeywordArgs[site: Nanoc::Int::Site, items: C::IterOf[Nanoc::Int::Item]] => C::Any
-    def initialize(site:, items:)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'compiled_content'), 2)
+    contract C::KeywordArgs[config: Nanoc::Int::Configuration, items: C::IterOf[Nanoc::Int::Item]] => C::Any
+    def initialize(config:, items:)
+      super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'compiled_content'), 2)
 
       @items = items
       @cache = {}

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

@@ -8,9 +8,9 @@ module Nanoc::Int
     attr_reader :items
     attr_reader :layouts
 
-    contract Nanoc::Int::ItemCollection, Nanoc::Int::LayoutCollection, Nanoc::Int::Configuration, C::KeywordArgs[site: C::Optional[C::Maybe[Nanoc::Int::Site]]] => C::Any
-    def initialize(items, layouts, config, site: nil)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'dependencies'), 5)
+    contract Nanoc::Int::ItemCollection, Nanoc::Int::LayoutCollection, Nanoc::Int::Configuration => C::Any
+    def initialize(items, layouts, config)
+      super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'dependencies'), 5)
 
       @items = items
       @layouts = layouts

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

@@ -5,9 +5,9 @@ module Nanoc::Int
   class OutdatednessStore < ::Nanoc::Int::Store
     include Nanoc::Int::ContractsSupport
 
-    contract C::KeywordArgs[site: C::Maybe[Nanoc::Int::Site]] => C::Any
-    def initialize(site: nil)
-      super(Nanoc::Int::Store.tmp_path_for(site: site, store_name: 'outdatedness'), 1)
+    contract C::KeywordArgs[config: Nanoc::Int::Configuration] => C::Any
+    def initialize(config:)
+      super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'outdatedness'), 1)
 
       @outdated_refs = Set.new
     end

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

@@ -40,11 +40,9 @@ module Nanoc::Int
 
     # Logic for building tmp path from active environment and store name
     # @api private
-    contract C::KeywordArgs[site: C::Maybe[Nanoc::Int::Site], store_name: String] => String
-    def self.tmp_path_for(store_name:, site:)
-      # FIXME: disallow site from being nil
-      output_dir = site ? site.config.output_dir : ''
-      File.join(tmp_path_prefix(output_dir), store_name)
+    contract C::KeywordArgs[config: Nanoc::Int::Configuration, store_name: String] => String
+    def self.tmp_path_for(store_name:, config:)
+      File.join(tmp_path_prefix(config.output_dir), store_name)
     end
 
     def self.tmp_path_prefix(output_dir)

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

@@ -4,24 +4,24 @@ module Nanoc::Int
   # @api private
   class CompilerLoader
     def load(site, action_provider: nil)
-      action_sequence_store = Nanoc::Int::ActionSequenceStore.new(site: site)
+      action_sequence_store = Nanoc::Int::ActionSequenceStore.new(config: site.config)
 
       dependency_store =
-        Nanoc::Int::DependencyStore.new(site.items, site.layouts, site.config, site: site)
+        Nanoc::Int::DependencyStore.new(site.items, site.layouts, site.config)
 
       objects = site.items.to_a + site.layouts.to_a + site.code_snippets + [site.config]
 
       checksum_store =
-        Nanoc::Int::ChecksumStore.new(site: site, objects: objects)
+        Nanoc::Int::ChecksumStore.new(config: site.config, objects: objects)
 
       action_provider ||= Nanoc::Int::ActionProvider.named(:rule_dsl).for(site)
 
       outdatedness_store =
-        Nanoc::Int::OutdatednessStore.new(site: site)
+        Nanoc::Int::OutdatednessStore.new(config: site.config)
 
       compiled_content_cache =
         Nanoc::Int::CompiledContentCache.new(
-          site: site,
+          config: site.config,
           items: site.items,
         )
 

data/lib/nanoc/base/views/mixins/mutable_document_view_mixin.rb

@@ -16,10 +16,6 @@ module Nanoc
     end
 
     def raw_content=(arg)
-      # FIXME: clearing checksum data should be done in the document
-      unwrap.checksum_data = nil
-      unwrap.content_checksum_data = nil
-
       unwrap.content = Nanoc::Int::Content.create(arg)
     end
 
@@ -29,10 +25,6 @@ module Nanoc
     #
     # @see Hash#[]=
     def []=(key, value)
-      # FIXME: clearing checksum data should be done in the document
-      unwrap.checksum_data = nil
-      unwrap.attributes_checksum_data = nil
-
       disallowed_value_classes = Set.new([
         Nanoc::Int::Item,
         Nanoc::Int::Layout,
@@ -43,7 +35,7 @@ module Nanoc
         raise DisallowedAttributeValueError.new(value)
       end
 
-      unwrap.attributes[key] = value
+      unwrap.set_attribute(key, value)
     end
 
     # Sets the identifier to the given argument.
@@ -59,11 +51,7 @@ module Nanoc
     #
     # @return [self]
     def update_attributes(hash)
-      # FIXME: clearing checksum data should be done in the document
-      unwrap.checksum_data = nil
-      unwrap.attributes_checksum_data = nil
-
-      hash.each { |k, v| unwrap.attributes[k] = v }
+      hash.each { |k, v| unwrap.set_attribute(k, v) }
       self
     end
   end

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

@@ -5,13 +5,31 @@ summary 'compile items of this site'
 description <<~EOS
   Compile all items of the current site.
 EOS
+
 flag nil, :diff, 'generate diff'
+if Nanoc::Feature.enabled?(Nanoc::Feature::LIVE_CMD)
+  flag :w, :watch, 'watch for changes and recompile when needed'
+end
 
 module Nanoc::CLI::Commands
   class Compile < ::Nanoc::CLI::CommandRunner
     attr_accessor :listener_classes
 
     def run
+      self.class.enter_site_dir
+
+      if options[:watch]
+        run_repeat
+      else
+        run_once
+      end
+    end
+
+    def run_repeat
+      Nanoc::Extra::LiveRecompiler.new(command_runner: self).run
+    end
+
+    def run_once
       time_before = Time.now
 
       @site = load_site

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

@@ -11,6 +11,7 @@ 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)'
+flag :L, :'live-reload', 'reload on changes'
 
 module Nanoc::CLI::Commands
   class Live < ::Nanoc::CLI::CommandRunner

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

@@ -11,6 +11,7 @@ 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)'
+flag :L, :'live-reload', 'reload on changes'
 
 module Nanoc::CLI::Commands
   class View < ::Nanoc::CLI::CommandRunner
@@ -18,45 +19,21 @@ module Nanoc::CLI::Commands
 
     def run
       load_adsf
-      require 'rack'
+      require 'adsf/live'
 
       config = Nanoc::Int::ConfigLoader.new.new_from_cwd
 
-      # Set options
-      options_for_rack = {
-        Port: (options[:port] || 3000).to_i,
-        Host: (options[:host] || '127.0.0.1'),
-      }
+      server =
+        Adsf::Server.new(
+          root: File.absolute_path(config[:output_dir]),
+          live: options[:'live-reload'],
+          index_filenames: config[:index_filenames],
+          host: (options[:host] || '127.0.0.1'),
+          port: (options[:port] || 3000).to_i,
+          handler: options[:handler],
+        )
 
-      # Get handler
-      if options.key?(:handler)
-        handler = Rack::Handler.get(options[:handler])
-      else
-        begin
-          handler = Rack::Handler.get(DEFAULT_HANDLER_NAME)
-        rescue LoadError
-          handler = Rack::Handler::WEBrick
-        end
-      end
-
-      # Build app
-      app = Rack::Builder.new do
-        use Rack::CommonLogger
-        use Rack::ShowExceptions
-        use Rack::Lint
-        use Rack::Head
-        use Adsf::Rack::IndexFileFinder,
-            root: config[:output_dir],
-            index_filenames: config[:index_filenames]
-        run Rack::File.new(config[:output_dir])
-      end.to_app
-
-      # Print a link
-      url = "http://#{options_for_rack[:Host]}:#{options_for_rack[:Port]}/"
-      puts "View the site at #{url}"
-
-      # Run autocompiler
-      handler.run(app, options_for_rack)
+      server.run
     end
 
     protected

data/lib/nanoc/filters/redcarpet.rb

@@ -7,77 +7,38 @@ module Nanoc::Filters
 
     requires 'redcarpet'
 
-    # Runs the content through [Redcarpet](https://github.com/vmg/redcarpet).
-    # This method optionally takes processing options to pass on to Redcarpet.
-    #
-    # @overload run(content, params={})
-    #
-    #   For Redcarpet 1.x
-    #
-    #   @param [String] content The content to filter
-    #
-    #   @option params [Array] :options ([]) A list of options to pass on to
-    #     Redcarpet
-    #
-    #   @return [String] The filtered content
-    #
-    # @overload run(content, params={})
-    #
-    #   For Redcarpet 2.x
-    #
-    #   @param [String] content The content to filter
-    #
-    #   @option params [Hash] :options ({}) A list of options to pass on to
-    #     Redcarpet itself (not the renderer)
-    #
-    #   @option params [::Redcarpet::Render::Base] :renderer
-    #     (::Redcarpet::Render::HTML) The class of the renderer to use
-    #
-    #   @option params [Hash] :renderer_options ({}) A list of options to pass
-    #     on to the Redcarpet renderer
-    #
-    #   @option params [Boolean] :with_toc (false) A boolean to request a table
-    #     of contents
-    #
-    #   @return [String] The filtered content
     def run(content, params = {})
-      if ::Redcarpet::VERSION > '2'
-        options          = params.fetch(:options,          {})
-        renderer_class   = params.fetch(:renderer,         ::Redcarpet::Render::HTML)
-        renderer_options = params.fetch(:renderer_options, {})
-        with_toc         = params.fetch(:with_toc,         false)
-
-        if options.is_a?(Array)
-          warn 'WARNING: You are passing an array of options to the :redcarpet filter, but Redcarpet 2.x expects a hash instead. This will likely fail.'
-        end
-
-        # Setup TOC
-        if with_toc
-          unless renderer_class <= ::Redcarpet::Render::HTML
-            raise "Unexpected renderer: #{renderer_class}"
-          end
-
-          # `with_toc` implies `with_toc_data` for the HTML renderer
-          renderer_options[:with_toc_data] = true
+      options          = params.fetch(:options,          {})
+      renderer_class   = params.fetch(:renderer,         ::Redcarpet::Render::HTML)
+      renderer_options = params.fetch(:renderer_options, {})
+      with_toc         = params.fetch(:with_toc,         false)
+
+      # Setup TOC
+      if with_toc
+        unless renderer_class <= ::Redcarpet::Render::HTML
+          raise "Unexpected renderer: #{renderer_class}"
         end
 
-        # Create renderer
-        renderer =
-          if renderer_class == ::Redcarpet::Render::HTML_TOC
-            renderer_class.new
-          else
-            renderer_class.new(renderer_options)
-          end
+        # `with_toc` implies `with_toc_data` for the HTML renderer
+        renderer_options[:with_toc_data] = true
+      end
 
-        # Render
-        if with_toc
-          renderer_toc = ::Redcarpet::Render::HTML_TOC.new
-          toc  = ::Redcarpet::Markdown.new(renderer_toc, options).render(content)
-          body = ::Redcarpet::Markdown.new(renderer,     options).render(content)
-          toc + body
+      # Create renderer
+      renderer =
+        if renderer_class == ::Redcarpet::Render::HTML_TOC
+          renderer_class.new
         else
-          ::Redcarpet::Markdown.new(renderer, options).render(content)
+          renderer_class.new(renderer_options)
         end
+
+      # Render
+      if with_toc
+        renderer_toc = ::Redcarpet::Render::HTML_TOC.new
+        toc  = ::Redcarpet::Markdown.new(renderer_toc, options).render(content)
+        body = ::Redcarpet::Markdown.new(renderer,     options).render(content)
+        toc + body
+      else
+        ::Redcarpet::Markdown.new(renderer, options).render(content)
       end
     end
   end

data/lib/nanoc/version.rb

@@ -2,5 +2,5 @@
 
 module Nanoc
   # The current Nanoc version.
-  VERSION = '4.8.12'
+  VERSION = '4.8.13'
 end