nanoc 4.8.9 → 4.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab60c9ed073c0ed1ec8197cd500adc4ca16ab185
-  data.tar.gz: be5ab8d5ea4c217520f86e4f18c570e7b3d3a52e
+  metadata.gz: 651f15c4ee22daacf31bab68c3ec1a00a02238f0
+  data.tar.gz: 6a8a41fd4ecc345ebb70814cd9f7f89d0cd6decc
 SHA512:
-  metadata.gz: fc8c28d6b45107d89b417c19c7f5a99eeac4c4f92b6bf8aee24acca066870228452613c7ad9d536546d65fd8a72e514a0359820f33391dce9affdf5d47e9a2c9
-  data.tar.gz: 25dc1e5794c6a965d13715f9172cbccd9c50458b5822ab29badd7714d2c0c8952a8ad38bcd7d5d6ab6a028ba57c725f097d7926abc55424b491279fd81a3d5e9
+  metadata.gz: 0f9576114f97906cf843f19dcff2e84a45d4612165162e267ef10ab441e910b82fbaac55d1cc71f68d7add44214269c003eca73c31118119b7f9d238f08e3391
+  data.tar.gz: 66be4b141524b69d045e636ecc01b33c69c9e7f4267eb8ff7a5a6978c2b7fbb9c1960bf6cd482458484a4477dfc1aeb1821a03d4ec3e358c2de3c2009b727792

data/.gitignore

@@ -1,8 +1,10 @@
-doc/yardoc
 .DS_Store
 *.gem
-/coverage/
-/.yardoc
+*.gemfile.lock
 *~
+
+/.yardoc/
+/coverage/
 /Gemfile.lock
-*.gemfile.lock
+/doc/yardoc/
+/.vscode/

data/Gemfile

@@ -40,7 +40,8 @@ group :plugins do
   gem 'compass'
   gem 'erubi'
   gem 'erubis'
-  gem 'fog'
+  gem 'fog-aws'
+  gem 'fog-local'
   gem 'haml'
   gem 'handlebars', platforms: :ruby
   gem 'kramdown'

data/NEWS.md

@@ -1,5 +1,12 @@
 # Nanoc news
 
+## 4.8.10 (2017-10-08)
+
+Fixes:
+
+* Fixed handling of four dashes for separating metadata (#1222, #1223)
+* Made `#raw_path` unavailable in rules context (#1231)
+
 ## 4.8.9 (2017-09-22)
 
 Fixes:

data/README.md

@@ -20,4 +20,4 @@ Contributions are greatly appreciated! Consult the [Development guidelines](http
 
 Many thanks to everyone who has contributed to Nanoc in one way or another:
 
-Ale Muñoz, Alexander Groß, Alexander Mankuta, Andy Drop, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Cédric Boutillier, Chris Burkhardt, Chris Chapman, Chris Eppstein, Christian Plessl, Colin Barrett, Colin Seymour, Croath Liu, Damien Pollet, Dan Callahan, Daniel Hofstetter, Daniel Mendler, Daniel Wollschlaeger, David Alexander, David Everitt, Denis Defreyne, Dennis Sutch, Devon Luke Buchanan, Dmitry Bilunov, Eric Sunshine, Erik Hollensbe, Fabian Buch, Felix Hanley, Garen Torikian, Go Maeda, Grégory Karékinian, Gregory Pakosz, Guilherme Garnier, Hugo Peixoto, Jack Chu, Jake Benilov, Jan M. Faber, Jasper Van der Jeugt, Jeff Forcier, Jim Mendenhall, John Nishinaga, Justin Clift, Justin Hileman, Kevin Lynagh, Lorin Werthen, Louis T., Lucas Vuotto, Mathias Bynens, Matt Keveney, Matthew Frazier, Matthias Beyer, Matthias Reitinger, Matthias Vallentin, Micha Rosenbaum, Michal Cichra, Michal Papis, Mike Pennisi, Nelson Chen, Nicky Peeters, Nikhil Marathe, Oliver Byford, Paul Boone, Peter Aronoff, Raphael von der Grün, Rémi Barraquand, Remko Tronçon, Riley Goodside, Ruben Verborgh, Scott Vokes, Šime Ramov, Simon South, Spencer Whitt, Stanley Rost, Starr Horne, Stefan Bühler, Stuart Montgomery, Takashi Uchibe, Toon Willems, Tuomas Kareinen, Ursula Kallio, Vincent Driessen, Vlatko Kosturjak, whitequark, Xavier Shay, Yannick Ihmels, Zaiste de Grengolada
+Abubakar Ango, Ale Muñoz, Alexander Groß, Alexander Mankuta, Andy Drop, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Cédric Boutillier, Chris Burkhardt, Chris Chapman, Chris Eppstein, Christian Plessl, Colin Barrett, Colin Seymour, Croath Liu, Damien Pollet, Dan Callahan, Daniel Hofstetter, Daniel Mendler, Daniel Wollschlaeger, David Alexander, David Everitt, Denis Defreyne, Dennis Sutch, Devon Luke Buchanan, Dmitry Bilunov, Eric Sunshine, Erik Hollensbe, Fabian Buch, Felix Hanley, Garen Torikian, Go Maeda, Grégory Karékinian, Gregory Pakosz, Guilherme Garnier, Hugo Peixoto, Jack Chu, Jake Benilov, Jan M. Faber, Jasper Van der Jeugt, Jeff Forcier, Jim Mendenhall, John Nishinaga, Justin Clift, Justin Hileman, Kevin Lynagh, Lorin Werthen, Louis T., Lucas Vuotto, Mathias Bynens, Matt Keveney, Matthew Frazier, Matthias Beyer, Matthias Reitinger, Matthias Vallentin, Micha Rosenbaum, Michal Cichra, Michal Papis, Mike Pennisi, Nelson Chen, Nicky Peeters, Nikhil Marathe, Oliver Byford, Paul Boone, Peter Aronoff, Raphael von der Grün, Rémi Barraquand, Remko Tronçon, Riley Goodside, Ruben Verborgh, Scott Vokes, Seiichi Yonezawa, Šime Ramov, Simon South, Spencer Whitt, Stanley Rost, Starr Horne, Stefan Bühler, Stuart Montgomery, Takashi Uchibe, Toon Willems, Tuomas Kareinen, Ursula Kallio, Vincent Driessen, Vlatko Kosturjak, whitequark, Xavier Shay, Yannick Ihmels, Zaiste de Grengolada

data/lib/nanoc.rb

@@ -6,12 +6,8 @@ module Nanoc
   #
   # @api private
   def self.version_information
-    gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : 'without RubyGems'
-    engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
-    res = +''
-    res << "Nanoc #{Nanoc::VERSION} © 2007-2017 Denis Defreyne.\n"
-    res << "Running #{engine} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} #{gem_info}.\n"
-    res
+    "Nanoc #{Nanoc::VERSION} © 2007-2017 Denis Defreyne.\n" \
+    "Running #{RUBY_ENGINE} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} with RubyGems #{Gem::VERSION}.\n"
   end
 
   # @return [Boolean] True if the current platform is Windows, false otherwise.

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

@@ -8,7 +8,6 @@ module Nanoc::Int
     attr_reader :code_snippets
     attr_reader :config
     attr_accessor :data_source
-    attr_writer :compiler
 
     contract C::KeywordArgs[config: Nanoc::Int::Configuration, code_snippets: C::IterOf[Nanoc::Int::CodeSnippet], data_source: C::Maybe[C::Named['Nanoc::DataSource']]] => C::Any
     def initialize(config:, code_snippets:, data_source:)
@@ -16,19 +15,24 @@ module Nanoc::Int
       @code_snippets = code_snippets
       @data_source = data_source
 
+      @preprocessed = false
+
       ensure_identifier_uniqueness(@data_source.items, 'item')
       ensure_identifier_uniqueness(@data_source.layouts, 'layout')
     end
 
     contract C::None => self
     def compile
-      compiler.run_all
+      Nanoc::Int::Compiler.new_for(self).run_until_end
       self
     end
 
-    contract C::None => C::Named['Nanoc::Int::Compiler']
-    def compiler
-      @compiler ||= Nanoc::Int::CompilerLoader.new.load(self)
+    def mark_as_preprocessed
+      @preprocessed = true
+    end
+
+    def preprocessed?
+      @preprocessed
     end
 
     def items

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

@@ -40,21 +40,6 @@ module Nanoc
       @references = 0
     end
 
-    # Loads the data source when necessary (calling {#up}), yields, and
-    # unloads (using {#down}) the data source when it is not being used
-    # elsewhere. All data source queries and data manipulations should be
-    # wrapped in a {#loading} block; it ensures that the data source is loaded
-    # when necessary and makes sure the data source does not get unloaded
-    # while it is still being used elsewhere.
-    #
-    # @return [void]
-    def loading
-      use
-      yield
-    ensure
-      unuse
-    end
-
     # Marks the data source as used by the caller.
     #
     # Calling this method increases the internal reference count. When the

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

@@ -5,47 +5,49 @@ module Nanoc::Int
   class OutdatednessStore < ::Nanoc::Int::Store
     include Nanoc::Int::ContractsSupport
 
-    contract C::KeywordArgs[site: C::Maybe[Nanoc::Int::Site], reps: Nanoc::Int::ItemRepRepo] => C::Any
-    def initialize(site: nil, reps:)
+    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)
 
-      @outdated_reps = Set.new
-      @all_reps = reps
+      @outdated_refs = Set.new
     end
 
     contract Nanoc::Int::ItemRep => C::Bool
     def include?(obj)
-      @outdated_reps.include?(obj)
+      @outdated_refs.include?(obj.reference)
     end
 
     contract Nanoc::Int::ItemRep => self
     def add(obj)
-      @outdated_reps << obj
+      @outdated_refs << obj.reference
       self
     end
 
     contract Nanoc::Int::ItemRep => self
     def remove(obj)
-      @outdated_reps.delete(obj)
+      @outdated_refs.delete(obj.reference)
       self
     end
 
-    contract C::None => C::ArrayOf[Nanoc::Int::ItemRep]
-    def to_a
-      @outdated_reps.to_a
+    contract C::None => C::Bool
+    def empty?
+      @outdated_refs.empty?
+    end
+
+    contract C::None => self
+    def clear
+      @outdated_refs = Set.new
+      self
     end
 
     protected
 
     def data
-      @outdated_reps.map(&:reference)
+      @outdated_refs
     end
 
     def data=(new_data)
-      outdated_refs = Set.new(new_data)
-      all_reps = Set.new(@all_reps)
-
-      @outdated_reps = Set.new(all_reps.select { |rep| outdated_refs.include?(rep.reference) })
+      @outdated_refs = Set.new(new_data)
     end
   end
 end

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

@@ -23,7 +23,7 @@ module Nanoc::Int
     end
 
     def create_view_context(dependency_tracker)
-      Nanoc::ViewContext.new(
+      Nanoc::ViewContextForCompilation.new(
         reps: @reps,
         items: @site.items,
         dependency_tracker: dependency_tracker,
@@ -44,9 +44,9 @@ module Nanoc::Int
       view_context = create_view_context(dependency_tracker)
 
       content_or_filename_assigns.merge(
-        item: Nanoc::ItemWithRepsView.new(rep.item, view_context),
-        rep: Nanoc::ItemRepView.new(rep, view_context),
-        item_rep: Nanoc::ItemRepView.new(rep, view_context),
+        item: Nanoc::CompilationItemView.new(rep.item, view_context),
+        rep: Nanoc::CompilationItemRepView.new(rep, view_context),
+        item_rep: Nanoc::CompilationItemRepView.new(rep, view_context),
         items: Nanoc::ItemCollectionWithRepsView.new(@site.items, view_context),
         layouts: Nanoc::LayoutCollectionView.new(@site.layouts, view_context),
         config: Nanoc::ConfigView.new(@site.config, view_context),

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

@@ -4,106 +4,93 @@ module Nanoc::Int
   class Compiler
     include Nanoc::Int::ContractsSupport
 
-    # @api private
-    attr_reader :site
-
-    # @api private
-    attr_reader :compiled_content_cache
-
-    # @api private
-    attr_reader :checksum_store
-
-    # @api private
-    attr_reader :action_sequence_store
-
-    # @api private
-    attr_reader :action_provider
-
-    # @api private
-    attr_reader :dependency_store
-
-    # @api private
-    attr_reader :reps
-
-    # @api private
-    attr_reader :outdatedness_store
-
-    # @api private
-    attr_reader :snapshot_repo
-
-    def initialize(site, compiled_content_cache:, checksum_store:, action_sequence_store:, action_provider:, dependency_store:, reps:, outdatedness_store:)
+    def initialize(site, compiled_content_cache:, checksum_store:, action_sequence_store:, action_provider:, dependency_store:, outdatedness_store:)
       @site = site
 
       @compiled_content_cache = compiled_content_cache
       @checksum_store         = checksum_store
       @action_sequence_store  = action_sequence_store
       @dependency_store       = dependency_store
-      @reps                   = reps
       @action_provider        = action_provider
       @outdatedness_store     = outdatedness_store
 
-      # TODO: inject
       @snapshot_repo = Nanoc::Int::SnapshotRepo.new
     end
 
-    def create_outdatedness_checker
-      Nanoc::Int::OutdatednessChecker.new(
-        site: @site,
-        checksum_store: @checksum_store,
-        dependency_store: @dependency_store,
-        action_sequence_store: @action_sequence_store,
-        action_sequences: @action_sequences,
-        checksums: @checksums,
-        reps: reps,
-      )
+    contract Nanoc::Int::Site => Nanoc::Int::Compiler
+    def self.new_for(site)
+      Nanoc::Int::CompilerLoader.new.load(site)
     end
 
-    def run_all
-      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(compile_reps_stage(@action_sequences))
-      run_stage(store_post_compilation_state_stage)
-      run_stage(postprocess_stage)
-    ensure
-      run_stage(cleanup_stage)
+    def run_until_preprocessed
+      @_res_preprocessed ||= begin
+        run_stage(preprocess_stage)
+        {}
+      end
     end
 
-    def prepare
-      # FIXME: State is ugly
+    def run_until_reps_built
+      @_res_reps_built ||= begin
+        prev = run_until_preprocessed
 
-      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
+        res = run_stage(build_reps_stage)
 
-    def compilation_context
-      @_compilation_context ||= Nanoc::Int::CompilationContext.new(
-        action_provider: action_provider,
-        reps: @reps,
-        site: @site,
-        compiled_content_cache: compiled_content_cache,
-        snapshot_repo: snapshot_repo,
-      )
+        prev.merge(
+          reps: res.fetch(:reps),
+          action_sequences: res.fetch(:action_sequences),
+        )
+      end
     end
 
-    # TODO: remove
-    def load_stores
-      load_stores_stage.run
+    def run_until_precompiled
+      @_res_precompiled ||= begin
+        prev = run_until_reps_built
+        action_sequences = prev.fetch(:action_sequences)
+        reps = prev.fetch(:reps)
+
+        run_stage(load_stores_stage)
+        checksums = run_stage(calculate_checksums_stage)
+        outdatedness_checker = create_outdatedness_checker(
+          checksums: checksums,
+          action_sequences: action_sequences,
+          reps: reps,
+        )
+        outdated_items = run_stage(determine_outdatedness_stage(outdatedness_checker, reps))
+
+        prev.merge(
+          checksums: checksums,
+          dependency_store: @dependency_store,
+          outdatedness_checker: outdatedness_checker,
+          outdated_items: outdated_items,
+        )
+      end
     end
 
-    # TODO: remove
-    def build_reps
-      @action_sequences = build_reps_stage.run
+    def run_until_end
+      res = run_until_precompiled
+      action_sequences = res.fetch(:action_sequences)
+      reps = res.fetch(:reps)
+      checksums = res.fetch(:checksums)
+      outdated_items = res.fetch(:outdated_items)
+
+      run_stage(forget_outdated_dependencies_stage, outdated_items)
+      run_stage(store_pre_compilation_state_stage(action_sequences, reps), checksums)
+      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)
+    ensure
+      run_stage(cleanup_stage)
     end
 
-    # TODO: remove
-    def calculate_checksums
-      @checksums = run_stage(calculate_checksums_stage)
+    def compilation_context(reps:)
+      Nanoc::Int::CompilationContext.new(
+        action_provider: @action_provider,
+        reps: reps,
+        site: @site,
+        compiled_content_cache: @compiled_content_cache,
+        snapshot_repo: @snapshot_repo,
+      )
     end
 
     private
@@ -115,36 +102,47 @@ module Nanoc::Int
       Nanoc::Int::NotificationCenter.post(:stage_ended, stage.class)
     end
 
+    def create_outdatedness_checker(checksums:, action_sequences:, reps:)
+      Nanoc::Int::OutdatednessChecker.new(
+        site: @site,
+        checksum_store: @checksum_store,
+        dependency_store: @dependency_store,
+        action_sequence_store: @action_sequence_store,
+        action_sequences: action_sequences,
+        checksums: checksums,
+        reps: reps,
+      )
+    end
+
     def preprocess_stage
       @_preprocess_stage ||= Stages::Preprocess.new(
-        action_provider: action_provider,
-        site: site,
-        dependency_store: dependency_store,
-        checksum_store: checksum_store,
+        action_provider: @action_provider,
+        site: @site,
+        dependency_store: @dependency_store,
+        checksum_store: @checksum_store,
       )
     end
 
     def build_reps_stage
       @_build_reps_stage ||= Stages::BuildReps.new(
-        site: site,
-        action_provider: action_provider,
-        reps: @reps,
+        site: @site,
+        action_provider: @action_provider,
       )
     end
 
-    def prune_stage
+    def prune_stage(reps)
       @_prune_stage ||= Stages::Prune.new(
-        config: site.config,
+        config: @site.config,
         reps: reps,
       )
     end
 
     def load_stores_stage
       @_load_stores_stage ||= Stages::LoadStores.new(
-        checksum_store: checksum_store,
-        compiled_content_cache: compiled_content_cache,
+        checksum_store: @checksum_store,
+        compiled_content_cache: @compiled_content_cache,
         dependency_store: @dependency_store,
-        action_sequence_store: action_sequence_store,
+        action_sequence_store: @action_sequence_store,
         outdatedness_store: @outdatedness_store,
       )
     end
@@ -158,50 +156,51 @@ module Nanoc::Int
       )
     end
 
-    def determine_outdatedness_stage
+    def determine_outdatedness_stage(outdatedness_checker, reps)
       @_determine_outdatedness_stage ||= Stages::DetermineOutdatedness.new(
         reps: reps,
-        outdatedness_checker: create_outdatedness_checker,
-        outdatedness_store: outdatedness_store,
+        outdatedness_checker: outdatedness_checker,
+        outdatedness_store: @outdatedness_store,
       )
     end
 
-    def store_pre_compilation_state_stage(action_sequences)
+    def store_pre_compilation_state_stage(action_sequences, reps)
       @_store_pre_compilation_state_stage ||= Stages::StorePreCompilationState.new(
-        reps: @reps,
-        layouts: site.layouts,
-        checksum_store: checksum_store,
-        action_sequence_store: action_sequence_store,
+        reps: reps,
+        layouts: @site.layouts,
+        checksum_store: @checksum_store,
+        action_sequence_store: @action_sequence_store,
         action_sequences: action_sequences,
       )
     end
 
-    def compile_reps_stage(action_sequences)
+    def compile_reps_stage(action_sequences, reps)
       @_compile_reps_stage ||= Stages::CompileReps.new(
+        reps: reps,
         outdatedness_store: @outdatedness_store,
         dependency_store: @dependency_store,
         action_sequences: action_sequences,
-        compilation_context: compilation_context,
-        compiled_content_cache: compiled_content_cache,
+        compilation_context: compilation_context(reps: reps),
+        compiled_content_cache: @compiled_content_cache,
       )
     end
 
     def store_post_compilation_state_stage
       @_store_post_compilation_state_stage ||= Stages::StorePostCompilationState.new(
-        dependency_store: dependency_store,
+        dependency_store: @dependency_store,
       )
     end
 
-    def postprocess_stage
+    def postprocess_stage(reps)
       @_postprocess_stage ||= Stages::Postprocess.new(
         action_provider: @action_provider,
         site: @site,
-        reps: @reps,
+        reps: reps,
       )
     end
 
     def cleanup_stage
-      @_cleanup_stage ||= Stages::Cleanup.new(site.config)
+      @_cleanup_stage ||= Stages::Cleanup.new(@site.config)
     end
 
     def forget_outdated_dependencies_stage