nanoc 4.6.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c5effeb7d9dc719725af84e69e43fd8114804d9
-  data.tar.gz: '068728706ce3eaa7ca6b05627b23f2c014c9b33e'
+  metadata.gz: 3215906d4c407f3712161bcf4464b5b5358e50c8
+  data.tar.gz: 1e3877875fd5f931ab99fce68ff6c1130acd2936
 SHA512:
-  metadata.gz: a7ca4e77db7c096579d28c7af8206505d11fad7c858d87362ceda01087ee39ea8da60cadb2833911e9ed37fe505a68bda39b933bd6bde84ee27a0ec99c84d26e
-  data.tar.gz: db7dcee097e6515ca68ba39ec8a139070b003120c23864dfe20b02f7ab79b7e617be4d6be46cdf0da8808c86b51c9137fdf6e1f5a908a27894aaf27771d67974
+  metadata.gz: 34b4e72944f26ee705b66ab40367528a78733ee623bd580656d385e9a71f0b4d125dd334c356699723390c82e214064fc85a627865e52414737a4141705af294
+  data.tar.gz: f1772e11403f7ffc7b62e1421a63c59c87c2024f448d61ddc4eb7c5c838dd6a576d40580eb4a8fcf502603bdbd54906a33981d28af30e9e761bac3b8dbfdac67

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: git://github.com/bbatsov/rubocop.git
-  revision: c500b3c760d334c733af1ce2229a2db65957c875
+  revision: 1c0cf571afc608229c3116fa6f66dd480e395772
   specs:
     rubocop (0.47.1)
       parser (>= 2.3.3.1, < 3.0)
@@ -27,7 +27,7 @@ GIT
 PATH
   remote: .
   specs:
-    nanoc (4.6.0)
+    nanoc (4.6.1)
       cri (~> 2.3)
       ddplugin (~> 1.0)
       hamster (~> 3.0)
@@ -36,7 +36,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    CFPropertyList (2.3.4)
+    CFPropertyList (2.3.5)
     RedCloth (4.3.2)
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
@@ -219,7 +219,7 @@ GEM
     fuubar (2.2.0)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
-    guard (2.14.0)
+    guard (2.14.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (~> 1.0)
@@ -289,7 +289,7 @@ GEM
     rainpress (1.0)
     rake (12.0.0)
     rb-fsevent (0.9.8)
-    rb-inotify (0.9.7)
+    rb-inotify (0.9.8)
       ffi (>= 0.5.0)
     rbvmomi (1.9.4)
       builder (~> 3.2)
@@ -336,7 +336,7 @@ GEM
     term-ansicolor (1.4.0)
       tins (~> 1.0)
     thor (0.19.4)
-    tilt (2.0.5)
+    tilt (2.0.6)
     timecop (0.8.1)
     tins (1.13.0)
     trollop (2.1.2)
@@ -425,4 +425,4 @@ DEPENDENCIES
   yuicompressor
 
 BUNDLED WITH
-   1.14.1
+   1.14.3

data/NEWS.md

@@ -1,6 +1,16 @@
 # Nanoc news
 
-## 4.6.0 (2017-01-22)
+## 4.6.1 (2017-01-29)
+
+Fixes:
+
+* Fixed table formatting in `compile --verbose` (#1074) [Hugo Peixoto]
+
+Enhancements:
+
+* Reduced memory usage (#1075, #1076, #1077, #1078)
+
+## 4.6 (2017-01-22)
 
 Features:
 
@@ -39,7 +49,7 @@ Fixes:
 
 * Fixed crash when Nokogiri is not installed (#1053)
 
-## 4.5.0 (2017-01-09)
+## 4.5 (2017-01-09)
 
 Features:
 
@@ -113,7 +123,7 @@ Enhancements:
 
 * Made `view` command use index filenames specified in the `index_filenames` site configuration attribute (#998)
 
-## 4.4.0 (2016-11-19)
+## 4.4 (2016-11-19)
 
 Features:
 

data/README.md

@@ -19,4 +19,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 Mankuta, Andy Drop, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Cédric Boutillier, 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, Jack Chu, Jake Benilov, 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
+Ale Muñoz, Alexander Mankuta, Andy Drop, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Cédric Boutillier, 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, 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

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

@@ -24,10 +24,8 @@ module Nanoc::Int
     #     end
     #     # => "I am Max Payne and I am hiding in a cheap motel."
     def initialize(hash)
-      metaclass = class << self; self; end
       hash.each_pair do |key, value|
         instance_variable_set('@' + key.to_s, value)
-        metaclass.send(:define_method, key) { value }
       end
     end
 
@@ -40,6 +38,20 @@ module Nanoc::Int
     end
     # rubocop:enable Style/AccessorMethodName
 
+    def method_missing(method, *args, &blk)
+      ivar_name = '@' + method.to_s
+      if instance_variable_defined?(ivar_name)
+        instance_variable_get(ivar_name)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_all)
+      ivar_name = '@' + method.to_s
+      instance_variable_defined?(ivar_name) || super
+    end
+
     def include(mod)
       metaclass = class << self; self; end
       metaclass.instance_eval { include(mod) }

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

@@ -0,0 +1,32 @@
+module Nanoc::Int::Compiler::Phases
+  # Provides functionality for (re)calculating the content of an item rep, with caching or
+  # outdatedness checking. Delegates to s::Recalculate if outdated or no cache available.
+  class Cache
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(compiled_content_cache:, snapshot_repo:, wrapped:)
+      @compiled_content_cache = compiled_content_cache
+      @snapshot_repo = snapshot_repo
+      @wrapped = wrapped
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    def run(rep, is_outdated:)
+      if can_reuse_content_for_rep?(rep, is_outdated: is_outdated)
+        Nanoc::Int::NotificationCenter.post(:cached_content_used, rep)
+
+        @snapshot_repo.set_all(rep, @compiled_content_cache[rep])
+      else
+        @wrapped.run(rep, is_outdated: is_outdated)
+      end
+
+      rep.compiled = true
+      @compiled_content_cache[rep] = @snapshot_repo.get_all(rep)
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Bool
+    def can_reuse_content_for_rep?(rep, is_outdated:)
+      !is_outdated && !@compiled_content_cache[rep].nil?
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Nanoc::Int::Compiler::Phases
+  class MarkDone
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(wrapped:, outdatedness_store:)
+      @wrapped = wrapped
+      @outdatedness_store = outdatedness_store
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    def run(rep, is_outdated:)
+      @wrapped.run(rep, is_outdated: is_outdated)
+      @outdatedness_store.remove(rep)
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Nanoc::Int::Compiler::Phases
+  # Provides functionality for (re)calculating the content of an item rep, without caching or
+  # outdatedness checking.
+  class Recalculate
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(action_provider:, dependency_store:, compilation_context:)
+      @action_provider = action_provider
+      @dependency_store = dependency_store
+      @compilation_context = compilation_context
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    def run(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
+      dependency_tracker = Nanoc::Int::DependencyTracker.new(@dependency_store)
+      dependency_tracker.enter(rep.item)
+
+      executor = Nanoc::Int::Executor.new(rep, @compilation_context, dependency_tracker)
+
+      @compilation_context.snapshot_repo.set(rep, :last, rep.item.content)
+
+      @action_provider.memory_for(rep).each do |action|
+        case action
+        when Nanoc::Int::ProcessingActions::Filter
+          executor.filter(action.filter_name, action.params)
+        when Nanoc::Int::ProcessingActions::Layout
+          executor.layout(action.layout_identifier, action.params)
+        when Nanoc::Int::ProcessingActions::Snapshot
+          executor.snapshot(action.snapshot_name)
+        else
+          raise Nanoc::Int::Errors::InternalInconsistency, "unknown action #{action.inspect}"
+        end
+      end
+    ensure
+      dependency_tracker.exit
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Nanoc::Int::Compiler::Phases
+  # Provides functionality for suspending and resuming item rep compilation (using fibers).
+  class Resume
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(wrapped:)
+      @wrapped = wrapped
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    def run(rep, is_outdated:)
+      fiber = fiber_for(rep, is_outdated: is_outdated)
+      while fiber.alive?
+        Nanoc::Int::NotificationCenter.post(:compilation_started, rep)
+        res = fiber.resume
+
+        case res
+        when Nanoc::Int::Errors::UnmetDependency
+          Nanoc::Int::NotificationCenter.post(:compilation_suspended, rep, res)
+          raise(res)
+        when Proc
+          fiber.resume(res.call)
+        else
+          # TODO: raise
+        end
+      end
+
+      Nanoc::Int::NotificationCenter.post(:compilation_ended, rep)
+    end
+
+    private
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => Fiber
+    def fiber_for(rep, is_outdated:)
+      @fibers ||= {}
+
+      @fibers[rep] ||=
+        Fiber.new do
+          @wrapped.run(rep, is_outdated: is_outdated)
+          @fibers.delete(rep)
+        end
+
+      @fibers[rep]
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Nanoc::Int::Compiler::Phases
+  class Write
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(snapshot_repo:, wrapped:)
+      @snapshot_repo = snapshot_repo
+      @wrapped = wrapped
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    def run(rep, is_outdated:)
+      @wrapped.run(rep, is_outdated: is_outdated)
+
+      rep.snapshot_defs.each do |sdef|
+        Nanoc::Int::ItemRepWriter.new.write(rep, @snapshot_repo, sdef.name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Nanoc::Int::Compiler::Phases
+end
+
+require_relative 'phases/recalculate'
+require_relative 'phases/cache'
+require_relative 'phases/resume'
+require_relative 'phases/write'
+require_relative 'phases/mark_done'

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

@@ -0,0 +1,37 @@
+module Nanoc::Int::Compiler::Stages
+  class Cleanup
+    def initialize(config)
+      @config = config
+    end
+
+    def run
+      cleanup_temps(Nanoc::Filter::TMP_BINARY_ITEMS_DIR)
+      cleanup_temps(Nanoc::Int::ItemRepWriter::TMP_TEXT_ITEMS_DIR)
+      cleanup_unused_stores
+      cleanup_old_stores
+    end
+
+    private
+
+    def cleanup_temps(dir)
+      Nanoc::Int::TempFilenameFactory.instance.cleanup(dir)
+    end
+
+    def cleanup_unused_stores
+      used_paths = @config.output_dirs.map { |d| Nanoc::Int::Store.tmp_path_prefix(d) }
+      all_paths = Dir.glob('tmp/nanoc/*')
+      (all_paths - used_paths).each do |obsolete_path|
+        FileUtils.rm_rf(obsolete_path)
+      end
+    end
+
+    def cleanup_old_stores
+      %w(checksums compiled_content dependencies outdatedness rule_memory).each do |fn|
+        full_fn = File.join('tmp', fn)
+        if File.file?(full_fn)
+          FileUtils.rm_f(full_fn)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Nanoc::Int::Compiler::Stages
+  class CompileReps
+    def initialize(outdatedness_store:, dependency_store:, action_provider:, compilation_context:, compiled_content_cache:)
+      @outdatedness_store = outdatedness_store
+      @dependency_store = dependency_store
+      @action_provider = action_provider
+      @compilation_context = compilation_context
+      @compiled_content_cache = compiled_content_cache
+    end
+
+    def run
+      selector = Nanoc::Int::ItemRepSelector.new(@outdatedness_store.to_a)
+      selector.each do |rep|
+        handle_errors_while(rep) { compile_rep(rep, is_outdated: @outdatedness_store.include?(rep)) }
+      end
+    ensure
+      @outdatedness_store.store
+      @compiled_content_cache.store
+    end
+
+    private
+
+    def handle_errors_while(item_rep)
+      yield
+    rescue => e
+      raise Nanoc::Int::Errors::CompilationError.new(e, item_rep)
+    end
+
+    def compile_rep(rep, is_outdated:)
+      item_rep_compiler.run(rep, is_outdated: is_outdated)
+    end
+
+    def item_rep_compiler
+      @_item_rep_compiler ||= begin
+        recalculate_phase = Nanoc::Int::Compiler::Phases::Recalculate.new(
+          action_provider: @action_provider,
+          dependency_store: @dependency_store,
+          compilation_context: @compilation_context,
+        )
+
+        cache_phase = Nanoc::Int::Compiler::Phases::Cache.new(
+          compiled_content_cache: @compiled_content_cache,
+          snapshot_repo: @compilation_context.snapshot_repo,
+          wrapped: recalculate_phase,
+        )
+
+        resume_phase = Nanoc::Int::Compiler::Phases::Resume.new(
+          wrapped: cache_phase,
+        )
+
+        write_phase = Nanoc::Int::Compiler::Phases::Write.new(
+          snapshot_repo: @compilation_context.snapshot_repo,
+          wrapped: resume_phase,
+        )
+
+        mark_done_phase = Nanoc::Int::Compiler::Phases::MarkDone.new(
+          wrapped: write_phase,
+          outdatedness_store: @outdatedness_store,
+        )
+
+        mark_done_phase
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Nanoc::Int::Compiler::Stages
+  class DetermineOutdatedness
+    def initialize(reps:, outdatedness_checker:, outdatedness_store:)
+      @reps = reps
+      @outdatedness_checker = outdatedness_checker
+      @outdatedness_store = outdatedness_store
+    end
+
+    def run
+      outdated_reps_tmp = @reps.select do |r|
+        @outdatedness_store.include?(r) || @outdatedness_checker.outdated?(r)
+      end
+
+      outdated_items = outdated_reps_tmp.map(&:item).uniq
+      outdated_reps = Set.new(outdated_items.flat_map { |i| @reps[i] })
+
+      outdated_reps.each { |r| @outdatedness_store.add(r) }
+
+      yield(outdated_items)
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Nanoc::Int::Compiler::Stages
+  class Preprocess
+    def initialize(action_provider:, site:, dependency_store:, checksum_store:)
+      @action_provider = action_provider
+      @site = site
+      @dependency_store = dependency_store
+      @checksum_store = checksum_store
+    end
+
+    def run
+      @action_provider.preprocess(@site)
+
+      @dependency_store.objects = @site.items.to_a + @site.layouts.to_a
+      @checksum_store.objects = @site.items.to_a + @site.layouts.to_a + @site.code_snippets + [@site.config]
+
+      @site.freeze
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Nanoc::Int::Compiler::Stages
+  class Prune
+    def initialize(config:, reps:)
+      @config = config
+      @reps = reps
+    end
+
+    def run
+      if @config[:prune][:auto_prune]
+        Nanoc::Pruner.new(@config, @reps, exclude: prune_config_exclude).run
+      end
+    end
+
+    private
+
+    def prune_config
+      @config[:prune] || {}
+    end
+
+    def prune_config_exclude
+      prune_config[:exclude] || {}
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Nanoc::Int::Compiler::Stages
+end
+
+require_relative 'stages/cleanup'
+require_relative 'stages/compile_reps'
+require_relative 'stages/determine_outdatedness'
+require_relative 'stages/prune'
+require_relative 'stages/preprocess'