nanoc 4.11.1 → 4.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81da98fdd728f76e389fc4618fc54a22e98827d40e20320e0102ab7dc4b2b89f
-  data.tar.gz: c642b86779f1564d1d09a499e4b3e6bbe0d60ebdb5d3c828c05dee3101bf4c08
+  metadata.gz: c038b8ba7dfde390ca7151a64421060d91173371c080b1de0e8cf2b44cea073f
+  data.tar.gz: aef94fe2c56a0c01506d933fe68497b9e930b8b3b81933f5140dc15b9307b024
 SHA512:
-  metadata.gz: '078c89114ddab916b9bf54fcf7f32359d51472351fd9bde7abe1d03e575797b13fa02782e228bb87677d1e74950d187b2afcfd6612b80b37fe9438f37fe65dc5'
-  data.tar.gz: 8ab157e67fc2172adf8aa910f52937cf92505a42441bc9b54ec2b5d0beae5c880cd0f62472bc0633a0445a7916fdc3cadc208f96a012dffaddbddcb87bbf93b0
+  metadata.gz: a9687e4103a49256b1065f92107f0659f204e5b65b975af71f0240f9eb2857086b096081282a3038a25e1595a7af5c18077b44fbe4c6ce0ed388eca142369eae
+  data.tar.gz: ed741694c5373b8d8770211695dd7e6a53e2fe393ed1dfd96a6464e2ffd030e754a6c4e7eeb0cc04e0fe26bc09e4395849071967c8d0e0539a91affe01302fa3

data/NEWS.md

@@ -1,5 +1,11 @@
 # Nanoc news
 
+## 4.11.2 (2019-02-16)
+
+Fixes:
+
+* Fixed issue which prevented Sass (not SCSS) files from being imported (#1397, #1407) [Alexander Groß]
+
 ## 4.11.1 (2019-02-09)
 
 Fixes:

data/lib/nanoc/base/feature.rb

@@ -98,3 +98,7 @@ Nanoc::Feature.define('live_cmd', version: '4.11')
 # Tracking issue:
 # https://github.com/nanoc/features/issues/40
 Nanoc::Feature.define('toml', version: '4.11')
+
+# Tracking issue:
+# https://github.com/nanoc/features/issues/20
+Nanoc::Feature.define('binary_compiled_content_cache', version: '4.11')

data/lib/nanoc/base/repos.rb

@@ -6,6 +6,8 @@ Nanoc::DataSource = Nanoc::Core::DataSource
 require_relative 'repos/store'
 
 require_relative 'repos/checksum_store'
+require_relative 'repos/binary_compiled_content_cache'
+require_relative 'repos/textual_compiled_content_cache'
 require_relative 'repos/compiled_content_cache'
 require_relative 'repos/config_loader'
 require_relative 'repos/dependency_store'

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Int
+    # Represents a cache than can be used to store already compiled content,
+    # to prevent it from being needlessly recompiled.
+    #
+    # @api private
+    class BinaryCompiledContentCache < ::Nanoc::Int::Store
+      include Nanoc::Core::ContractsSupport
+
+      contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
+      def initialize(config:)
+        super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'binary_content'), 1)
+
+        @cache = {}
+      end
+
+      contract Nanoc::Core::ItemRep => C::Maybe[C::HashOf[Symbol => Nanoc::Core::Content]]
+      # Returns the cached compiled content for the given item representation.
+      #
+      # This cached compiled content is a hash where the keys are the snapshot
+      # names, and the values the compiled content at the given snapshot.
+      def [](rep)
+        item_cache = @cache[rep.item.identifier] || {}
+
+        rep_cache = item_cache[rep.name]
+        return nil if rep_cache.nil?
+
+        rep_cache.transform_values do |filename|
+          Nanoc::Core::Content.create(filename, binary: true)
+        end
+      end
+
+      contract Nanoc::Core::ItemRep => C::Bool
+      def include?(rep)
+        item_cache = @cache[rep.item.identifier] || {}
+        item_cache.key?(rep.name)
+      end
+
+      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::BinaryContent] => C::HashOf[Symbol => Nanoc::Core::Content]
+      # Sets the compiled content for the given representation.
+      #
+      # This cached compiled content is a hash where the keys are the snapshot
+      # names, and the values the compiled content at the given snapshot.
+      def []=(rep, content)
+        @cache[rep.item.identifier] ||= {}
+        @cache[rep.item.identifier][rep.name] ||= {}
+        rep_cache = @cache[rep.item.identifier][rep.name]
+
+        content.each do |snapshot, binary_content|
+          filename = build_filename(rep, snapshot)
+          rep_cache[snapshot] = filename
+
+          # Avoid reassigning the same content if this binary cached content was
+          # already used, because it was available and the item wasn’t oudated.
+          next if binary_content.filename == filename
+
+          # Copy
+          #
+          # NOTE: hardlinking is not an option in this case, because hardlinking
+          # would make it possible for the content to be (inadvertently)
+          # changed outside of Nanoc.
+          FileUtils.mkdir_p(File.dirname(filename))
+          FileUtils.cp(binary_content.filename, filename)
+        end
+      end
+
+      def prune(items:)
+        item_identifiers = Set.new(items.map(&:identifier))
+
+        @cache.each_key do |key|
+          # TODO: remove unused item reps
+          next if item_identifiers.include?(key)
+
+          @cache.delete(key)
+          path = dirname_for_item_identifier(key)
+          FileUtils.rm_rf(path)
+        end
+      end
+
+      def data
+        @cache
+      end
+
+      def data=(new_data)
+        @cache = {}
+
+        new_data.each_pair do |item_identifier, content_per_rep|
+          @cache[item_identifier] ||= content_per_rep
+        end
+      end
+
+      private
+
+      def dirname
+        filename + '_data'
+      end
+
+      def string_to_path_component(string)
+        string.gsub(/[^a-zA-Z0-9]+/, '_') +
+          '-' +
+          Digest::SHA1.hexdigest(string)[0..9]
+      end
+
+      def dirname_for_item_identifier(item_identifier)
+        File.join(
+          dirname,
+          string_to_path_component(item_identifier.to_s),
+        )
+      end
+
+      def dirname_for_item_rep(rep)
+        File.join(
+          dirname_for_item_identifier(rep.item.identifier),
+          string_to_path_component(rep.name.to_s),
+        )
+      end
+
+      def build_filename(rep, snapshot_name)
+        File.join(
+          dirname_for_item_rep(rep),
+          string_to_path_component(snapshot_name.to_s),
+        )
+      end
+    end
+  end
+end

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

@@ -11,9 +11,10 @@ module Nanoc
 
       contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
       def initialize(config:)
-        super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'compiled_content'), 2)
+        @textual_cache = Nanoc::Int::TextualCompiledContentCache.new(config: config)
+        @binary_cache = Nanoc::Int::BinaryCompiledContentCache.new(config: config)
 
-        @cache = {}
+        @wrapped_caches = [@textual_cache, @binary_cache]
       end
 
       contract Nanoc::Core::ItemRep => C::Maybe[C::HashOf[Symbol => Nanoc::Core::Content]]
@@ -22,40 +23,45 @@ module Nanoc
       # This cached compiled content is a hash where the keys are the snapshot
       # names. and the values the compiled content at the given snapshot.
       def [](rep)
-        item_cache = @cache[rep.item.identifier] || {}
-        item_cache[rep.name]
+        textual_content_map = @textual_cache[rep]
+        binary_content_map = @binary_cache[rep]
+
+        # If either the textual or the binary content cache is nil, assume the
+        # cache is entirely absent.
+        #
+        # This is necessary to support the case where only textual content is
+        # cached (which was the case in older versions of Nanoc).
+        return nil if [textual_content_map, binary_content_map].any?(&:nil?)
+
+        textual_content_map.merge(binary_content_map)
       end
 
-      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::Content] => C::HashOf[Symbol => Nanoc::Core::Content]
+      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::Content] => C::Any
       # Sets the compiled content for the given representation.
       #
       # This cached compiled content is a hash where the keys are the snapshot
-      # names. and the values the compiled content at the given snapshot.
+      # names and the values the compiled content at the given snapshot.
       def []=(rep, content)
-        @cache[rep.item.identifier] ||= {}
-        @cache[rep.item.identifier][rep.name] = content
+        @textual_cache[rep] = content.select { |_key, c| c.textual? }
+        @binary_cache[rep] = content.select { |_key, c| c.binary? }
       end
 
-      def prune(items:)
-        item_identifiers = Set.new(items.map(&:identifier))
-
-        @cache.keys.each do |key|
-          @cache.delete(key) unless item_identifiers.include?(key)
-        end
+      def prune(*args)
+        @wrapped_caches.each { |w| w.prune(*args) }
       end
 
-      protected
-
-      def data
-        @cache
+      # True if there is cached compiled content available for this item, and
+      # all entries are present (either textual or binary).
+      def full_cache_available?(rep)
+        @textual_cache.include?(rep) && @binary_cache.include?(rep)
       end
 
-      def data=(new_data)
-        @cache = {}
+      def load(*args)
+        @wrapped_caches.each { |w| w.load(*args) }
+      end
 
-        new_data.each_pair do |item_identifier, content_per_rep|
-          @cache[item_identifier] ||= content_per_rep
-        end
+      def store(*args)
+        @wrapped_caches.each { |w| w.store(*args) }
       end
     end
   end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Int
+    # Represents a cache than can be used to store already compiled content,
+    # to prevent it from being needlessly recompiled.
+    #
+    # @api private
+    class TextualCompiledContentCache < ::Nanoc::Int::Store
+      include Nanoc::Core::ContractsSupport
+
+      contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
+      def initialize(config:)
+        super(Nanoc::Int::Store.tmp_path_for(config: config, store_name: 'compiled_content'), 2)
+
+        @cache = {}
+      end
+
+      contract Nanoc::Core::ItemRep => C::Maybe[C::HashOf[Symbol => Nanoc::Core::Content]]
+      # Returns the cached compiled content for the given item representation.
+      #
+      # This cached compiled content is a hash where the keys are the snapshot
+      # names, and the values the compiled content at the given snapshot.
+      def [](rep)
+        item_cache = @cache[rep.item.identifier] || {}
+        item_cache[rep.name]
+      end
+
+      contract Nanoc::Core::ItemRep => C::Bool
+      def include?(rep)
+        item_cache = @cache[rep.item.identifier] || {}
+        item_cache.key?(rep.name)
+      end
+
+      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::Content] => C::Any
+      # Sets the compiled content for the given representation.
+      #
+      # This cached compiled content is a hash where the keys are the snapshot
+      # names, and the values the compiled content at the given snapshot.
+      def []=(rep, content)
+        # FIXME: once the binary content cache is properly enabled (no longer
+        # behind a feature flag), change contract to be TextualContent, rather
+        # than Content.
+
+        @cache[rep.item.identifier] ||= {}
+        @cache[rep.item.identifier][rep.name] = content
+      end
+
+      def prune(items:)
+        item_identifiers = Set.new(items.map(&:identifier))
+
+        @cache.each_key do |key|
+          # TODO: remove unused item reps
+          next if item_identifiers.include?(key)
+
+          @cache.delete(key)
+        end
+      end
+
+      # True if there is cached compiled content available for this item, and
+      # all entries are textual.
+      def full_cache_available?(rep)
+        cache = self[rep]
+        cache ? cache.none? { |_snapshot_name, content| content.binary? } : false
+      end
+
+      protected
+
+      def data
+        @cache
+      end
+
+      def data=(new_data)
+        @cache = {}
+
+        new_data.each_pair do |item_identifier, content_per_rep|
+          @cache[item_identifier] ||= content_per_rep
+        end
+      end
+    end
+  end
+end

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

@@ -35,8 +35,7 @@ module Nanoc
             if is_outdated
               false
             else
-              cache = @compiled_content_cache[rep]
-              cache ? cache.none? { |_snapshot_name, content| content.binary? } : false
+              @compiled_content_cache.full_cache_available?(rep)
             end
           end
         end

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

@@ -21,7 +21,7 @@ module Nanoc
           Nanoc::Int::OutdatednessStore.new(config: site.config)
 
         compiled_content_cache =
-          Nanoc::Int::CompiledContentCache.new(config: site.config)
+          compiled_content_cache_class.new(config: site.config)
 
         params = {
           compiled_content_cache: compiled_content_cache,
@@ -34,6 +34,15 @@ module Nanoc
 
         Nanoc::Int::Compiler.new(site, params)
       end
+
+      def compiled_content_cache_class
+        feature_name = Nanoc::Feature::BINARY_COMPILED_CONTENT_CACHE
+        if Nanoc::Feature.enabled?(feature_name)
+          Nanoc::Int::CompiledContentCache
+        else
+          Nanoc::Int::TextualCompiledContentCache
+        end
+      end
     end
   end
 end

data/lib/nanoc/base/views/post_compile_item_rep_view.rb

@@ -8,7 +8,7 @@ module Nanoc
 
     def compiled_content(snapshot: nil)
       compilation_context = @context.compilation_context
-      snapshot_contents = compilation_context.compiled_content_cache[_unwrap]
+      snapshot_contents = compilation_context.compiled_content_cache[_unwrap] || {}
 
       snapshot_name = snapshot || (snapshot_contents[:pre] ? :pre : :last)
 

data/lib/nanoc/filters/sass/importer.rb

@@ -36,13 +36,9 @@ module Nanoc::Filters::SassCommon
       items = filter.items.find_all(identifier)
       return if items.empty?
 
-      content = if items.size == 1
-                  items.first.compiled_content
-                else
-                  items.map { |item| %(@import "#{item.identifier}";) }.join("\n")
-                end
+      content, syntax = import(items)
 
-      options[:syntax] = :scss
+      options[:syntax] = syntax
       options[:filename] = identifier.to_s
       options[:importer] = self
       ::Sass::Engine.new(content, options)
@@ -85,5 +81,37 @@ module Nanoc::Filters::SassCommon
       map = self.class.raw_filename_to_item_map_for_config(filter.config, filter.items)
       map[realpath]
     end
+
+    private
+
+    def import(items)
+      if items.size == 1
+        import_single(items.first)
+      else
+        import_all(items)
+      end
+    end
+
+    def import_single(item)
+      syntax = if (ext = item.identifier.ext).nil?
+                 nil
+               else
+                 ext.downcase.to_sym
+               end
+
+      [
+        item.compiled_content,
+        syntax,
+      ]
+    end
+
+    def import_all(items)
+      import_all = items.map { |i| %(@import "#{i.identifier}";) }.join("\n")
+
+      [
+        import_all,
+        :scss,
+      ]
+    end
   end
 end

data/lib/nanoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.11.1
+  version: 4.11.2
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-09 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.1
+        version: 4.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.1
+        version: 4.11.2
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - lib/nanoc/base/repos.rb
 - lib/nanoc/base/repos/action_sequence_store.rb
 - lib/nanoc/base/repos/aggregate_data_source.rb
+- lib/nanoc/base/repos/binary_compiled_content_cache.rb
 - lib/nanoc/base/repos/checksum_store.rb
 - lib/nanoc/base/repos/compiled_content_cache.rb
 - lib/nanoc/base/repos/compiled_content_store.rb
@@ -137,6 +138,7 @@ files:
 - lib/nanoc/base/repos/prefixed_data_source.rb
 - lib/nanoc/base/repos/site_loader.rb
 - lib/nanoc/base/repos/store.rb
+- lib/nanoc/base/repos/textual_compiled_content_cache.rb
 - lib/nanoc/base/services.rb
 - lib/nanoc/base/services/action_provider.rb
 - lib/nanoc/base/services/action_sequence_builder.rb