nanoc 4.5.2 → 4.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64b516baea97186cbb7ad99448ae7c02e9ce9ab2
-  data.tar.gz: 0ff4539f5c80a3c1f75838b7cb60014d3ab13a0a
+  metadata.gz: 313d3c808d70b4205249d9c65a62bacb56ed63d6
+  data.tar.gz: d583fb40f3264a55ba3bc283a4db921d65c488f4
 SHA512:
-  metadata.gz: 75b0aa1a6e74954ae178edbb234d46090310344ec13f00fde190cc0ab6822c136662a57c46f418fb68310a30ab194491ad42c3283a5e3f488913e7ccfa473c80
-  data.tar.gz: 242c70e3aa96b2730ce5614ee2d7a371cce65a8df888d40e8fc45b15f7deb73742643a5e509cdae79b6fd7a4ff8e3b6985fe2128b67d1e9087f784908d8ed65c
+  metadata.gz: e521ca2081dd8fe9377ab40e09d31b603f08cc6100ec875fee3cd0f629d982a8d142f94877f0f7335998737ad860bb8bb62ad16f26edf3c5b10a798325e15021
+  data.tar.gz: f64f51bfa27c7e6db9ef29a3266e5bc6a52797dfdc69e442fbedee9665afcc8a2216fea8b647f7513490745afc42a2babeeeaf8d9e5d69ad79f69217d142ce4b

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: git://github.com/bbatsov/rubocop.git
-  revision: c8d652dfa521526ff91cbf769e0d3551d50e1f3e
+  revision: d2652328e819cc8317e69b883449e71b83dcdffc
   specs:
     rubocop (0.46.0)
       parser (>= 2.3.3.1, < 3.0)
@@ -48,7 +48,7 @@ GEM
       thor (>= 0.14.0)
     ast (2.3.0)
     bluecloth (2.2.0)
-    builder (3.2.2)
+    builder (3.2.3)
     chunky_png (1.3.8)
     coderay (1.1.1)
     coffee-script (2.4.1)
@@ -87,7 +87,7 @@ GEM
     erubis (2.7.0)
     excon (0.54.0)
     execjs (2.7.0)
-    ffi (1.9.14)
+    ffi (1.9.17)
     fission (0.5.0)
       CFPropertyList (~> 2.2)
     fog (1.38.0)
@@ -242,7 +242,7 @@ GEM
     hashdiff (0.3.2)
     inflecto (0.0.2)
     ipaddress (0.8.3)
-    json (2.0.2)
+    json (2.0.3)
     kramdown (1.13.2)
     less (2.6.0)
       commonjs (~> 0.2.7)
@@ -257,7 +257,7 @@ GEM
       rake (>= 0.9.2.2)
     markaby (0.8.0)
       builder
-    maruku (0.7.2)
+    maruku (0.7.3)
     metaclass (0.0.4)
     method_source (0.8.2)
     mime-types (3.1)
@@ -344,7 +344,7 @@ GEM
       rubypants
     uglifier (3.0.4)
       execjs (>= 0.3.0, < 3)
-    unicode-display_width (1.1.2)
+    unicode-display_width (1.1.3)
     vcr (3.0.3)
     w3c_validators (1.3.1)
       json (~> 2.0)
@@ -354,7 +354,7 @@ GEM
       crack (>= 0.3.2)
       hashdiff
     xml-simple (1.1.5)
-    yard (0.9.7)
+    yard (0.9.8)
     yard-contracts (0.1.5)
       contracts (~> 0.7)
       yard (~> 0.8)

data/NEWS.md

@@ -1,5 +1,12 @@
 # Nanoc news
 
+## 4.5.3 (2017-01-15)
+
+Fixes:
+
+* Fixed “Fixnum is deprecated” message (#1061, #1062)
+* Fixed `:pre` snapshot not being created for items that are not laid out (#1064, #1065)
+
 ## 4.5.2 (2017-01-11)
 
 Fixes:

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

@@ -3,9 +3,6 @@ module Nanoc::Int
   class ItemRep
     include Nanoc::Int::ContractsSupport
 
-    # @return [Hash<Symbol,Nanoc::Int::Content>]
-    attr_accessor :snapshot_contents
-
     # @return [Boolean]
     attr_accessor :compiled
     alias compiled? compiled
@@ -42,54 +39,11 @@ module Nanoc::Int
       @raw_paths  = {}
       @paths      = {}
       @snapshot_defs = []
-      @snapshot_contents = { last: @item.content }
 
       # Reset flags
       @compiled = false
     end
 
-    contract C::None => C::Bool
-    def binary?
-      @snapshot_contents[:last].binary?
-    end
-
-    contract C::KeywordArgs[snapshot: C::Optional[C::Maybe[Symbol]]] => String
-    # Returns the compiled content from a given snapshot.
-    #
-    # @param [Symbol] snapshot The name of the snapshot from which to
-    #   fetch the compiled content. By default, the returned compiled content
-    #   will be the content compiled right before the first layout call (if
-    #   any).
-    #
-    # @return [String] The compiled content at the given snapshot (or the
-    #   default snapshot if no snapshot is specified)
-    def compiled_content(snapshot: nil)
-      # Get name of last pre-layout snapshot
-      snapshot_name = snapshot || (@snapshot_contents[:pre] ? :pre : :last)
-
-      # Check existance of snapshot
-      snapshot_def = snapshot_defs.reverse.find { |sd| sd.name == snapshot_name }
-      unless snapshot_def
-        raise Nanoc::Int::Errors::NoSuchSnapshot.new(self, snapshot_name)
-      end
-
-      # Verify snapshot is usable
-      stopped_moving = snapshot_name != :last || compiled?
-      is_usable_snapshot = @snapshot_contents[snapshot_name] && stopped_moving
-      unless is_usable_snapshot
-        Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(self))
-        return compiled_content(snapshot: snapshot)
-      end
-
-      # Verify snapshot is not binary
-      snapshot_content = @snapshot_contents[snapshot_name]
-      if snapshot_content.binary?
-        raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(self)
-      end
-
-      snapshot_content.string
-    end
-
     contract C::KeywordArgs[snapshot: C::Optional[Symbol]] => C::Maybe[String]
     # Returns the item rep’s raw path. It includes the path to the output
     # directory and the full filename.

data/lib/nanoc/base/repos.rb

@@ -9,3 +9,4 @@ require_relative 'repos/item_rep_repo'
 require_relative 'repos/outdatedness_store'
 require_relative 'repos/rule_memory_store'
 require_relative 'repos/site_loader'
+require_relative 'repos/snapshot_repo'

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

@@ -0,0 +1,60 @@
+module Nanoc::Int
+  # @api private
+  class SnapshotRepo
+    include Nanoc::Int::ContractsSupport
+
+    def initialize
+      @contents = {}
+    end
+
+    contract Nanoc::Int::ItemRep, Symbol => C::Maybe[Nanoc::Int::Content]
+    def get(rep, snapshot_name)
+      @contents[rep] ||= {}
+      @contents[rep][snapshot_name]
+    end
+
+    contract Nanoc::Int::ItemRep, Symbol, Nanoc::Int::Content => C::Any
+    def set(rep, snapshot_name, contents)
+      @contents[rep] ||= {}
+      @contents[rep][snapshot_name] = contents
+    end
+
+    contract Nanoc::Int::ItemRep => C::HashOf[Symbol => Nanoc::Int::Content]
+    def get_all(rep)
+      @contents[rep] || {}
+    end
+
+    contract Nanoc::Int::ItemRep, C::HashOf[Symbol => Nanoc::Int::Content] => C::Any
+    def set_all(rep, contents_per_snapshot)
+      @contents[rep] = contents_per_snapshot
+    end
+
+    contract C::KeywordArgs[rep: Nanoc::Int::ItemRep, snapshot: C::Optional[C::Maybe[Symbol]]] => String
+    def compiled_content(rep:, snapshot: nil)
+      # Get name of last pre-layout snapshot
+      snapshot_name = snapshot || (get(rep, :pre) ? :pre : :last)
+
+      # Check existance of snapshot
+      snapshot_def = rep.snapshot_defs.reverse.find { |sd| sd.name == snapshot_name }
+      unless snapshot_def
+        raise Nanoc::Int::Errors::NoSuchSnapshot.new(rep, snapshot_name)
+      end
+
+      # Verify snapshot is usable
+      stopped_moving = snapshot_name != :last || rep.compiled?
+      is_usable_snapshot = get(rep, snapshot_name) && stopped_moving
+      unless is_usable_snapshot
+        Fiber.yield(Nanoc::Int::Errors::UnmetDependency.new(rep))
+        return compiled_content(rep: rep, snapshot: snapshot)
+      end
+
+      # Verify snapshot is not binary
+      snapshot_content = get(rep, snapshot_name)
+      if snapshot_content.binary?
+        raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(rep)
+      end
+
+      snapshot_content.string
+    end
+  end
+end

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

@@ -20,11 +20,16 @@ module Nanoc::Int
   class Compiler
     # Provides common functionality for accesing “context” of an item that is being compiled.
     class CompilationContext
-      def initialize(action_provider:, reps:, site:, compiled_content_cache:)
+      attr_reader :site
+      attr_reader :compiled_content_cache
+      attr_reader :snapshot_repo
+
+      def initialize(action_provider:, reps:, site:, compiled_content_cache:, snapshot_repo:)
         @action_provider = action_provider
         @reps = reps
         @site = site
         @compiled_content_cache = compiled_content_cache
+        @snapshot_repo = snapshot_repo
       end
 
       def filter_name_and_args_for_layout(layout)
@@ -41,15 +46,17 @@ module Nanoc::Int
           items: @site.items,
           dependency_tracker: dependency_tracker,
           compilation_context: self,
+          snapshot_repo: @snapshot_repo,
         )
       end
 
       def assigns_for(rep, dependency_tracker)
+        last_content = @snapshot_repo.get(rep, :last)
         content_or_filename_assigns =
-          if rep.binary?
-            { filename: rep.snapshot_contents[:last].filename }
+          if last_content.binary?
+            { filename: last_content.filename }
           else
-            { content: rep.snapshot_contents[:last].string }
+            { content: last_content.string }
           end
 
         view_context = create_view_context(dependency_tracker)
@@ -63,14 +70,6 @@ module Nanoc::Int
           config: Nanoc::ConfigView.new(@site.config, view_context),
         )
       end
-
-      def site
-        @site
-      end
-
-      def compiled_content_cache
-        @compiled_content_cache
-      end
     end
 
     # All phases for the compilation of a single item rep. Phases will be repeated for every rep.
@@ -93,6 +92,8 @@ module Nanoc::Int
 
           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
@@ -115,8 +116,9 @@ module Nanoc::Int
       class Cache
         include Nanoc::Int::ContractsSupport
 
-        def initialize(compiled_content_cache:, wrapped:)
+        def initialize(compiled_content_cache:, snapshot_repo:, wrapped:)
           @compiled_content_cache = compiled_content_cache
+          @snapshot_repo = snapshot_repo
           @wrapped = wrapped
         end
 
@@ -124,13 +126,14 @@ module Nanoc::Int
         def run(rep, is_outdated:)
           if can_reuse_content_for_rep?(rep, is_outdated: is_outdated)
             Nanoc::Int::NotificationCenter.post(:cached_content_used, rep)
-            rep.snapshot_contents = @compiled_content_cache[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] = rep.snapshot_contents
+          @compiled_content_cache[rep] = @snapshot_repo.get_all(rep)
         end
 
         contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Bool
@@ -187,7 +190,8 @@ module Nanoc::Int
       class Write
         include Nanoc::Int::ContractsSupport
 
-        def initialize(wrapped:)
+        def initialize(snapshot_repo:, wrapped:)
+          @snapshot_repo = snapshot_repo
           @wrapped = wrapped
         end
 
@@ -196,7 +200,7 @@ module Nanoc::Int
           @wrapped.run(rep, is_outdated: is_outdated)
 
           rep.snapshot_defs.each do |sdef|
-            ItemRepWriter.new.write(rep, sdef.name)
+            ItemRepWriter.new.write(rep, @snapshot_repo, sdef.name)
           end
         end
       end
@@ -321,6 +325,7 @@ module Nanoc::Int
 
             cache_phase = Phases::Cache.new(
               compiled_content_cache: @compiled_content_cache,
+              snapshot_repo: @compilation_context.snapshot_repo,
               wrapped: recalculate_phase,
             )
 
@@ -329,6 +334,7 @@ module Nanoc::Int
             )
 
             write_phase = Phases::Write.new(
+              snapshot_repo: @compilation_context.snapshot_repo,
               wrapped: resume_phase,
             )
 
@@ -372,6 +378,9 @@ module Nanoc::Int
     # @api private
     attr_reader :outdatedness_store
 
+    # @api private
+    attr_reader :snapshot_repo
+
     def initialize(site, compiled_content_cache:, checksum_store:, rule_memory_store:, action_provider:, dependency_store:, outdatedness_checker:, reps:, outdatedness_store:)
       @site = site
 
@@ -383,6 +392,9 @@ module Nanoc::Int
       @reps                   = reps
       @action_provider        = action_provider
       @outdatedness_store     = outdatedness_store
+
+      # TODO: inject
+      @snapshot_repo = Nanoc::Int::SnapshotRepo.new
     end
 
     def run_all
@@ -443,6 +455,7 @@ module Nanoc::Int
         reps: @reps,
         site: @site,
         compiled_content_cache: compiled_content_cache,
+        snapshot_repo: snapshot_repo,
       )
     end
 

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

@@ -20,17 +20,20 @@ module Nanoc
           Nanoc::Int::NotificationCenter.post(:filtering_started, @rep, filter_name)
 
           # Run filter
-          last = @rep.snapshot_contents[:last]
-          source = @rep.binary? ? last.filename : last.string
+          last = @compilation_context.snapshot_repo.get(@rep, :last)
+          source = last.binary? ? last.filename : last.string
           filter_args.freeze
           result = filter.setup_and_run(source, filter_args)
-          @rep.snapshot_contents[:last] =
+          last =
             if filter.class.to_binary?
               Nanoc::Int::BinaryContent.new(filter.output_filename).tap(&:freeze)
             else
               Nanoc::Int::TextualContent.new(result).tap(&:freeze)
             end
 
+          # Store
+          @compilation_context.snapshot_repo.set(@rep, :last, last)
+
           # Check whether file was written
           if filter.class.to_binary? && !File.file?(filter.output_filename)
             raise OutputNotWrittenError.new(filter_name, filter.output_filename)
@@ -50,7 +53,8 @@ module Nanoc
         filter_args.freeze
 
         # Check whether item can be laid out
-        raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(@rep) if @rep.binary?
+        last = @compilation_context.snapshot_repo.get(@rep, :last)
+        raise Nanoc::Int::Errors::CannotLayoutBinaryItem.new(@rep) if last.binary?
 
         # Create filter
         klass = Nanoc::Filter.named(filter_name)
@@ -69,14 +73,18 @@ module Nanoc
           content = layout.content
           arg = content.binary? ? content.filename : content.string
           res = filter.setup_and_run(arg, filter_args)
-          @rep.snapshot_contents[:last] = Nanoc::Int::TextualContent.new(res).tap(&:freeze)
+
+          # Store
+          last = Nanoc::Int::TextualContent.new(res).tap(&:freeze)
+          @compilation_context.snapshot_repo.set(@rep, :last, last)
         ensure
           Nanoc::Int::NotificationCenter.post(:filtering_ended, @rep, filter_name)
         end
       end
 
       def snapshot(snapshot_name)
-        @rep.snapshot_contents[snapshot_name] = @rep.snapshot_contents[:last]
+        last = @compilation_context.snapshot_repo.get(@rep, :last)
+        @compilation_context.snapshot_repo.set(@rep, snapshot_name, last)
       end
 
       def assigns_for(rep)
@@ -105,9 +113,10 @@ module Nanoc
         klass = Nanoc::Filter.named(filter_name)
         raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if klass.nil?
 
-        if klass.from_binary? && !rep.binary?
+        last = @compilation_context.snapshot_repo.get(@rep, :last)
+        if klass.from_binary? && !last.binary?
           raise Nanoc::Int::Errors::CannotUseBinaryFilter.new(rep, klass)
-        elsif !klass.from_binary? && rep.binary?
+        elsif !klass.from_binary? && last.binary?
           raise Nanoc::Int::Errors::CannotUseTextualFilter.new(rep, klass)
         end
 

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

@@ -3,7 +3,7 @@ module Nanoc::Int
   class ItemRepWriter
     TMP_TEXT_ITEMS_DIR = 'text_items'.freeze
 
-    def write(item_rep, snapshot_name)
+    def write(item_rep, snapshot_repo, snapshot_name)
       raw_path = item_rep.raw_path(snapshot: snapshot_name)
       return unless raw_path
 
@@ -18,7 +18,7 @@ module Nanoc::Int
         :will_write_rep, item_rep, raw_path
       )
 
-      content = item_rep.snapshot_contents[snapshot_name]
+      content = snapshot_repo.get(item_rep, snapshot_name)
       if content.binary?
         temp_path = content.filename
       else
@@ -36,7 +36,7 @@ module Nanoc::Int
 
       # Notify
       Nanoc::Int::NotificationCenter.post(
-        :rep_written, item_rep, raw_path, is_created, is_modified
+        :rep_written, item_rep, content.binary?, raw_path, is_created, is_modified
       )
     end