nanoc-core 4.14.6 → 4.14.8

data/lib/nanoc/core/prefixed_data_source.rb

@@ -12,11 +12,15 @@ module Nanoc
       end
 
       def items
-        @data_source.items.map { |d| d.with_identifier_prefix(@items_prefix) }
+        @data_source.items.map do |d|
+          d.with_identifier_prefix(@items_prefix)
+        end
       end
 
       def layouts
-        @data_source.layouts.map { |d| d.with_identifier_prefix(@layouts_prefix) }
+        @data_source.layouts.map do |d|
+          d.with_identifier_prefix(@layouts_prefix)
+        end
       end
 
       def item_changes

data/lib/nanoc/core/processing_actions/filter.rb

@@ -13,6 +13,8 @@ module Nanoc
         attr_reader :params
 
         def initialize(filter_name, params)
+          super()
+
           @filter_name = filter_name
           @params      = params
         end

data/lib/nanoc/core/processing_actions/layout.rb

@@ -11,6 +11,8 @@ module Nanoc
         attr_reader :params
 
         def initialize(layout_identifier, params)
+          super()
+
           @layout_identifier = layout_identifier
           @params = params
         end

data/lib/nanoc/core/processing_actions/snapshot.rb

@@ -14,6 +14,8 @@ module Nanoc
 
         contract C::IterOf[Symbol], C::IterOf[String] => C::Any
         def initialize(snapshot_names, paths)
+          super()
+
           @snapshot_names = snapshot_names
           @paths = paths
         end
@@ -23,9 +25,14 @@ module Nanoc
           [:snapshot, @snapshot_names, true, @paths]
         end
 
-        contract C::KeywordArgs[snapshot_names: C::Optional[C::IterOf[Symbol]], paths: C::Optional[C::IterOf[String]]] => self
+        contract C::KeywordArgs[
+          snapshot_names: C::Optional[C::IterOf[Symbol]],
+          paths: C::Optional[C::IterOf[String]]] => self
         def update(snapshot_names: [], paths: [])
-          self.class.new(@snapshot_names + snapshot_names.to_a, @paths + paths.to_a)
+          self.class.new(
+            @snapshot_names + snapshot_names.to_a,
+            @paths + paths.to_a,
+          )
         end
 
         contract C::None => String
@@ -38,7 +45,9 @@ module Nanoc
         end
 
         def ==(other)
-          self.class == other.class && snapshot_names == other.snapshot_names && paths == other.paths
+          self.class == other.class &&
+            snapshot_names == other.snapshot_names &&
+            paths == other.paths
         end
 
         def eql?(other)

data/lib/nanoc/core/pruner.rb

@@ -7,7 +7,12 @@ module Nanoc
     class Pruner
       include Nanoc::Core::ContractsSupport
 
-      contract Nanoc::Core::Configuration, Nanoc::Core::ItemRepRepo, C::KeywordArgs[dry_run: C::Optional[C::Bool], exclude: C::Optional[C::IterOf[String]]] => C::Any
+      contract Nanoc::Core::Configuration,
+               Nanoc::Core::ItemRepRepo,
+               C::KeywordArgs[
+                 dry_run: C::Optional[C::Bool],
+                 exclude: C::Optional[C::IterOf[String]],
+               ] => C::Any
       def initialize(config, reps, dry_run: false, exclude: [])
         @config  = config
         @reps    = reps
@@ -18,8 +23,11 @@ module Nanoc
       def run
         return unless File.directory?(@config.output_dir)
 
-        compiled_files = @reps.flat_map { |r| r.raw_paths.values.flatten }.compact
-        present_files, present_dirs = files_and_dirs_in(@config.output_dir + '/')
+        compiled_files = @reps.flat_map do |r|
+          r.raw_paths.values.flatten
+        end.compact
+        present_files, present_dirs =
+          files_and_dirs_in("#{@config.output_dir}/")
 
         remove_stray_files(present_files, compiled_files)
         remove_empty_directories(present_dirs)

data/lib/nanoc/core/regexp_pattern.rb

@@ -2,7 +2,7 @@
 
 module Nanoc
   module Core
-    class RegexpPattern < Pattern
+    class RegexpPattern < Nanoc::Core::Pattern
       contract Regexp => C::Any
       def initialize(regexp)
         @regexp = regexp

data/lib/nanoc/core/site.rb

@@ -4,10 +4,12 @@ module Nanoc
   module Core
     # @api private
     class Site
-      # Error that is raised when multiple items or layouts with the same identifier exist.
+      # Error that is raised when multiple items or layouts with the same
+      # identifier exist.
       class DuplicateIdentifierError < ::Nanoc::Core::Error
         def initialize(identifier, type)
-          super("There are multiple #{type}s with the #{identifier} identifier.")
+          super(
+            "There are multiple #{type}s with the #{identifier} identifier.")
         end
       end
 
@@ -17,7 +19,10 @@ module Nanoc
       attr_reader :config
       attr_accessor :data_source
 
-      contract C::KeywordArgs[config: Nanoc::Core::Configuration, code_snippets: C::IterOf[Nanoc::Core::CodeSnippet], data_source: C::Named['Nanoc::Core::DataSource']] => C::Any
+      contract C::KeywordArgs[
+        config: Nanoc::Core::Configuration,
+        code_snippets: C::IterOf[Nanoc::Core::CodeSnippet],
+        data_source: C::Named['Nanoc::Core::DataSource']] => C::Any
       def initialize(config:, code_snippets:, data_source:)
         @config = config
         @code_snippets = code_snippets
@@ -54,7 +59,8 @@ module Nanoc
         self
       end
 
-      contract C::IterOf[C::Or[Nanoc::Core::Item, Nanoc::Core::Layout]], String => self
+      contract C::IterOf[C::Or[Nanoc::Core::Item, Nanoc::Core::Layout]],
+               String => self
       def ensure_identifier_uniqueness(objects, type)
         seen = Set.new
         objects.each do |obj|

data/lib/nanoc/core/site_loader.rb

@@ -3,42 +3,48 @@
 module Nanoc
   module Core
     class SiteLoader
-      ENCODING_REGEX = /\A#\s+(-\*-\s+)?(en)?coding: (?<encoding>[^\s]+)(\s+-\*-\s*)?\n{0,2}/
+      ENCODING_REGEX =
+        /\A#\s+(-\*-\s+)?(en)?coding: (?<encoding>[^\s]+)(\s+-\*-\s*)?\n{0,2}/
+
       # @return [Boolean]
       def self.cwd_is_nanoc_site?
         Nanoc::Core::ConfigLoader.cwd_is_nanoc_site?
       end
 
       def new_from_cwd
-        site_from_config(Nanoc::Core::ConfigLoader.new.new_from_cwd)
+        new_from_config(Nanoc::Core::ConfigLoader.new.new_from_cwd)
       end
 
       def gen_data_source_for_config(config)
         data_sources_to_aggregate =
           with_data_sources(config) do |data_sources|
             data_sources.map do |ds|
-              Nanoc::Core::PrefixedDataSource.new(ds, ds.items_root, ds.layouts_root)
+              Nanoc::Core::PrefixedDataSource.new(
+                ds, ds.items_root, ds.layouts_root
+              )
             end
           end
 
         Nanoc::Core::AggregateDataSource.new(data_sources_to_aggregate, config)
       end
 
-      private
-
-      def site_from_config(config)
-        code_snippets = code_snippets_from_config(config)
-        code_snippets.each(&:load)
+      def new_from_config(config)
+        Nanoc::Core::Instrumentor.call(:stage_ran, 'LoadSite') do
+          code_snippets = code_snippets_from_config(config)
+          code_snippets.each(&:load)
 
-        data_source = gen_data_source_for_config(config)
+          data_source = gen_data_source_for_config(config)
 
-        Nanoc::Core::Site.new(
-          config:,
-          code_snippets:,
-          data_source:,
-        )
+          Nanoc::Core::Site.new(
+            config:,
+            code_snippets:,
+            data_source:,
+          )
+        end
       end
 
+      private
+
       def with_data_sources(config, &)
         data_sources = create_data_sources(config)
 
@@ -53,9 +59,11 @@ module Nanoc
       def create_data_sources(config)
         config[:data_sources].map do |data_source_hash|
           # Get data source class
-          data_source_class = Nanoc::Core::DataSource.named(data_source_hash[:type].to_sym)
+          data_source_class =
+            Nanoc::Core::DataSource.named(data_source_hash[:type].to_sym)
           if data_source_class.nil?
-            raise Nanoc::Core::Errors::UnknownDataSource.new(data_source_hash[:type])
+            raise Nanoc::Core::Errors::UnknownDataSource
+              .new(data_source_hash[:type])
           end
 
           # Create data source
@@ -70,7 +78,7 @@ module Nanoc
 
       def code_snippets_from_config(config)
         config[:lib_dirs].flat_map do |lib|
-          Dir["#{File.expand_path(lib)}/**/*.rb"].sort.map do |filename|
+          Dir["#{File.expand_path(lib)}/**/*.rb"].map do |filename|
             Nanoc::Core::CodeSnippet.new(
               read_code_snippet_contents(filename),
               filename,

data/lib/nanoc/core/store.rb

@@ -15,7 +15,10 @@ module Nanoc
 
       # Logic for building tmp path from active environment and store name
       # @api private
-      contract C::KeywordArgs[config: Nanoc::Core::Configuration, store_name: String] => C::AbsolutePathString
+      contract C::KeywordArgs[
+        config: Nanoc::Core::Configuration,
+        store_name: String,
+      ] => C::AbsolutePathString
       def self.tmp_path_for(store_name:, config:)
         File.absolute_path(
           File.join(tmp_path_prefix(config.output_dir), store_name),
@@ -57,7 +60,9 @@ module Nanoc
       #
       # @abstract This method must be implemented by the subclass.
       def data
-        raise NotImplementedError.new('Nanoc::Core::Store subclasses must implement #data and #data=')
+        raise NotImplementedError.new(
+          'Nanoc::Core::Store subclasses must implement #data and #data=',
+        )
       end
 
       # @param new_data The data that has been loaded from the disk
@@ -66,7 +71,9 @@ module Nanoc
       #
       # @return [void]
       def data=(new_data) # rubocop:disable Lint/UnusedMethodArgument
-        raise NotImplementedError.new('Nanoc::Core::Store subclasses must implement #data and #data=')
+        raise NotImplementedError.new(
+          'Nanoc::Core::Store subclasses must implement #data and #data=',
+        )
       end
 
       # Loads the data from the filesystem into memory. This method will set the
@@ -98,7 +105,7 @@ module Nanoc
       rescue
         # An error occurred! Remove the database and try again
         FileUtils.rm_f(version_filename)
-        FileUtils.rm_f(data_filename)
+        reset_data
 
         # Try again
         unsafe_load_uninstrumented
@@ -108,7 +115,7 @@ module Nanoc
         FileUtils.mkdir_p(File.dirname(filename))
 
         write_obj_to_file(version_filename, version)
-        write_obj_to_file(data_filename, data)
+        store_data
 
         # Remove old file (back from the PStore days), if there are any.
         FileUtils.rm_f(filename)
@@ -124,10 +131,30 @@ module Nanoc
         read_version = read_obj_from_file(version_filename)
         return if read_version != version
 
-        # Load data
+        load_data
+      end
+
+      # Can be overridden by subclasses for finer-grained control over how data
+      # get (de)serialized. #load_data, #store_data and #reset_data must be
+      # implemented all together.
+      def load_data
         self.data = read_obj_from_file(data_filename)
       end
 
+      # Can be overridden by subclasses for finer-grained control over how data
+      # get (de)serialized. #load_data, #store_data and #reset_data must be
+      # implemented all together.
+      def store_data
+        write_obj_to_file(data_filename, data)
+      end
+
+      # Can be overridden by subclasses for finer-grained control over how data
+      # get (de)serialized. #load_data, #store_data and #reset_data must be
+      # implemented all together.
+      def reset_data
+        FileUtils.rm_f(data_filename)
+      end
+
       def write_obj_to_file(filename, obj)
         data = Marshal.dump(obj)
         compressed_data = Zlib::Deflate.deflate(data, Zlib::BEST_SPEED)

data/lib/nanoc/core/string_pattern.rb

@@ -2,7 +2,7 @@
 
 module Nanoc
   module Core
-    class StringPattern < Pattern
+    class StringPattern < Nanoc::Core::Pattern
       MATCH_OPTS = File::FNM_PATHNAME | File::FNM_EXTGLOB
 
       contract String => C::Any

data/lib/nanoc/core/textual_compiled_content_cache.rb

@@ -9,21 +9,56 @@ module Nanoc
     class TextualCompiledContentCache < ::Nanoc::Core::Store
       include Nanoc::Core::ContractsSupport
 
+      class LazyCompressedValue
+        def initialize(uncompressed: nil, compressed: nil)
+          if uncompressed.nil? && compressed.nil?
+            raise ArgumentError, 'must specify at least uncompressed or compressed'
+          end
+
+          @_uncompressed = uncompressed
+          @_compressed = compressed
+        end
+
+        def compressed
+          @_compressed ||= Zlib::Deflate.deflate(Marshal.dump(@_uncompressed), Zlib::BEST_SPEED)
+        end
+
+        def uncompressed
+          @_uncompressed ||= Marshal.load(Zlib::Inflate.inflate(@_compressed))
+        end
+
+        def marshal_dump
+          [compressed]
+        end
+
+        def marshal_load(array)
+          @_compressed = array[0]
+          @_uncompressed = nil
+        end
+      end
+
       contract C::KeywordArgs[config: Nanoc::Core::Configuration] => C::Any
       def initialize(config:)
-        super(Nanoc::Core::Store.tmp_path_for(config:, store_name: 'compiled_content'), 4)
+        super(
+          self.class.tmp_path_for(
+            config:,
+            store_name: 'compiled_content',
+          ),
+          5,
+        )
 
         @cache = {}
       end
 
-      contract Nanoc::Core::ItemRep => C::Maybe[C::HashOf[Symbol => Nanoc::Core::Content]]
+      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]
+        item_cache[rep.name]&.uncompressed
       end
 
       contract Nanoc::Core::ItemRep => C::Bool
@@ -32,14 +67,15 @@ module Nanoc
         item_cache.key?(rep.name)
       end
 
-      contract Nanoc::Core::ItemRep, C::HashOf[Symbol => Nanoc::Core::TextualContent] => C::Any
+      contract Nanoc::Core::ItemRep,
+               C::HashOf[Symbol => Nanoc::Core::TextualContent] => 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)
         @cache[rep.item.identifier] ||= {}
-        @cache[rep.item.identifier][rep.name] = content
+        @cache[rep.item.identifier][rep.name] = LazyCompressedValue.new(uncompressed: content)
       end
 
       def prune(items:)
@@ -53,6 +89,25 @@ module Nanoc
         end
       end
 
+      # Similar to Store#load_data, but does not use zlib compression on the
+      # data itself (instead, values are compressed individually).
+      def load_data
+        raw_data = File.binread(data_filename)
+        self.data = Marshal.load(raw_data)
+      end
+
+      # Similar to Store#store_data, but does not use zlib compression on the
+      # data itself (instead, values are compressed individually).
+      def store_data
+        raw_data = Marshal.dump(data)
+        write_data_to_file(data_filename, raw_data)
+      end
+
+      # Identical to Store#store_data; replicated for clarity.
+      def reset_data
+        FileUtils.rm_f(data_filename)
+      end
+
       protected
 
       def data

data/lib/nanoc/core/textual_content.rb

@@ -3,7 +3,10 @@
 module Nanoc
   module Core
     class TextualContent < Content
-      contract C::Or[String, Proc], C::KeywordArgs[filename: C::Optional[C::Maybe[String]]] => C::Any
+      contract C::Or[String, Proc],
+               C::KeywordArgs[
+                 filename: C::Optional[C::Maybe[String]],
+               ] => C::Any
       def initialize(string, filename: nil)
         super(filename)
         @string = Nanoc::Core::LazyValue.new(string)

data/lib/nanoc/core/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Core
-    VERSION = '4.14.6'
+    VERSION = '4.14.8'
   end
 end

data/lib/nanoc/core/view_context_for_compilation.rb

@@ -18,7 +18,10 @@ module Nanoc
         compilation_context: Nanoc::Core::CompilationContext,
         compiled_content_repo: Nanoc::Core::CompiledContentRepo,
       ] => C::Any
-      def initialize(reps:, items:, dependency_tracker:, compilation_context:, compiled_content_repo:)
+      def initialize(
+        reps:, items:, dependency_tracker:, compilation_context:,
+        compiled_content_repo:
+      )
         @reps = reps
         @items = items
         @dependency_tracker = dependency_tracker
@@ -26,7 +29,8 @@ module Nanoc
         @compiled_content_repo = compiled_content_repo
       end
 
-      contract Nanoc::Core::ItemRep, C::KeywordArgs[site: Nanoc::Core::Site] => Hash
+      contract Nanoc::Core::ItemRep,
+               C::KeywordArgs[site: Nanoc::Core::Site] => Hash
       def assigns_for(rep, site:)
         last_content = @compiled_content_repo.get_current(rep)
         content_or_filename_assigns =

data/lib/nanoc/core/views/basic_item_rep_collection_view.rb

@@ -31,7 +31,8 @@ module Nanoc
         @item_reps.map { |ir| view_class.new(ir, @context) }
       end
 
-      # Calls the given block once for each item rep, passing that item rep as a parameter.
+      # Calls the given block once for each item rep, passing that item rep as a
+      # parameter.
       #
       # @yieldparam [Object] item rep view
       #
@@ -54,16 +55,22 @@ module Nanoc
       #
       # @return [nil] if no item rep with the given name was found
       #
-      # @return [Nanoc::Core::BasicItemRepView] if an item rep with the given name was found
+      # @return [Nanoc::Core::BasicItemRepView] if an item rep with the given
+      #   name was found
       def [](rep_name)
         case rep_name
         when Symbol
           res = @item_reps.find { |ir| ir.name == rep_name }
           res && view_class.new(res, @context)
         when Integer
-          raise ArgumentError, "expected BasicItemRepCollectionView#[] to be called with a symbol (you likely want `.reps[:default]` rather than `.reps[#{rep_name}]`)"
+          raise ArgumentError,
+                'expected BasicItemRepCollectionView#[] to be called with a ' \
+                'symbol (you likely want `.reps[:default]` rather than ' \
+                "`.reps[#{rep_name}]`)"
         else
-          raise ArgumentError, 'expected BasicItemRepCollectionView#[] to be called with a symbol'
+          raise ArgumentError,
+                'expected BasicItemRepCollectionView#[] to be called with a ' \
+                'symbol'
         end
       end
 

data/lib/nanoc/core/views/basic_item_rep_view.rb

@@ -21,7 +21,10 @@ module Nanoc
 
       # @see Object#==
       def ==(other)
-        other.respond_to?(:item) && other.respond_to?(:name) && item == other.item && name == other.name
+        other.respond_to?(:item) &&
+          other.respond_to?(:name) &&
+          item == other.item &&
+          name == other.name
       end
 
       # @see Object#eql?
@@ -70,7 +73,11 @@ module Nanoc
       # @api private
       def binary?
         snapshot_def = _unwrap.snapshot_defs.find { |sd| sd.name == :last }
-        raise Nanoc::Core::Errors::NoSuchSnapshot.new(_unwrap, :last) if snapshot_def.nil?
+        if snapshot_def.nil?
+          raise Nanoc::Core::Errors::NoSuchSnapshot.new(
+            _unwrap, :last
+          )
+        end
 
         snapshot_def.binary?
       end

data/lib/nanoc/core/views/basic_item_view.rb

@@ -11,28 +11,35 @@ module Nanoc
       # @return [Enumerable<Nanoc::Core::CompilationItemView>]
       def children
         unless _unwrap.identifier.legacy?
-          raise Nanoc::Core::Errors::CannotGetParentOrChildrenOfNonLegacyItem.new(_unwrap.identifier)
+          raise Nanoc::Core::Errors::CannotGetParentOrChildrenOfNonLegacyItem
+            .new(_unwrap.identifier)
         end
 
-        children_pattern = Nanoc::Core::Pattern.from(_unwrap.identifier.to_s + '*/')
-        children = @context.items.select { |i| children_pattern.match?(i.identifier) }
+        children_pattern = Nanoc::Core::Pattern.from("#{_unwrap.identifier}*/")
+        children = @context.items.select do |i|
+          children_pattern.match?(i.identifier)
+        end
 
         children.map { |i| self.class.new(i, @context) }.freeze
       end
 
-      # Returns the parent of this item, if one exists. For items with identifiers
-      # that have extensions, returns nil.
+      # Returns the parent of this item, if one exists. For items with
+      # identifiers that have extensions, returns nil.
       #
       # @return [Nanoc::Core::CompilationItemView] if the item has a parent
       #
       # @return [nil] if the item has no parent
       def parent
         unless _unwrap.identifier.legacy?
-          raise Nanoc::Core::Errors::CannotGetParentOrChildrenOfNonLegacyItem.new(_unwrap.identifier)
+          raise Nanoc::Core::Errors::CannotGetParentOrChildrenOfNonLegacyItem
+            .new(_unwrap.identifier)
         end
 
-        parent_identifier = '/' + _unwrap.identifier.components[0..-2].join('/') + '/'
-        parent_identifier = '/' if parent_identifier == '//'
+        parent_identifier =
+          "/#{_unwrap.identifier.components[0..-2].join('/')}/"
+        if parent_identifier == '//'
+          parent_identifier = '/'
+        end
 
         parent = @context.items.object_with_identifier(parent_identifier)
 
@@ -44,7 +51,8 @@ module Nanoc
         _unwrap.content.binary?
       end
 
-      # @return [String, nil] The path to the file containing the uncompiled content of this item.
+      # @return [String, nil] The path to the file containing the uncompiled
+      #   content of this item.
       def raw_filename
         @context.dependency_tracker.bounce(_unwrap, raw_content: true)
         _unwrap.content.filename

data/lib/nanoc/core/views/compilation_item_rep_view.rb

@@ -48,7 +48,10 @@ module Nanoc
       def compiled_content(snapshot: nil)
         compiled_content_repo = @context.compiled_content_repo
 
-        @context.dependency_tracker.bounce(@item_rep.item, compiled_content: true)
+        @context.dependency_tracker.bounce(
+          @item_rep.item,
+          compiled_content: true,
+        )
 
         begin
           compiled_content_repo.compiled_content(rep: @item_rep, snapshot:)
@@ -77,13 +80,18 @@ module Nanoc
         outdated = compilation_context.outdatedness_store.include?(@item_rep)
         return false if outdated
 
-        # Requirement: The compiled content cache must have a cache entry for this item rep.
-        cache_available = compiled_content_cache.full_cache_available?(@item_rep)
+        # Requirement: The compiled content cache must have a cache entry for
+        # this item rep.
+        cache_available =
+          compiled_content_cache.full_cache_available?(@item_rep)
         return false unless cache_available
 
         # Load the compiled content from the cache
         Nanoc::Core::NotificationCenter.post(:cached_content_used, @item_rep)
-        compiled_content_repo.set_all(@item_rep, compiled_content_cache[@item_rep])
+        compiled_content_repo.set_all(
+          @item_rep,
+          compiled_content_cache[@item_rep],
+        )
 
         # Mark as compiled
         @item_rep.compiled = true

data/lib/nanoc/core/views/compilation_item_view.rb

@@ -40,7 +40,9 @@ module Nanoc
       #
       # @return [Nanoc::Core::BasicItemRepCollectionView]
       def reps
-        Nanoc::Core::CompilationItemRepCollectionView.new(@context.reps[_unwrap], @context)
+        Nanoc::Core::CompilationItemRepCollectionView.new(
+          @context.reps[_unwrap], @context
+        )
       end
     end
   end