nanoc 4.9.9 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c23c8c05886939d4bc9c4e4799112a9ef174381d43c1873cbbbac67c097bc36
-  data.tar.gz: bc39d8366fc4bab70f88b9ed0e922e6de85d69f45385261e2d2c909f67286e09
+  metadata.gz: 046c9869b2f916776a4f0fe741916842cbbc68b584e11b606abac58b854a9f44
+  data.tar.gz: aeb902ad7fca66c89b63d46e2e9e8508c08e1cc3cdeb8dcbf0c45698d8c6a905
 SHA512:
-  metadata.gz: '05993eb336217ff6e8563b1d5d7f9adbded355ba096f69aed6d1acf9bcde1fbe8dce4452bfd51deb5e9364876a4a9a0e9603047b3fe64c31769e24c67a3d7ea2'
-  data.tar.gz: 83201d2e62a3439c0824b43490c946c2009b944016344d65d3a2398d5b966d82431dee4a44bc8f5e8dbf281ddf3908e27e3d4c5260465c1690fb3ea6afffd51d
+  metadata.gz: 93124b5f9eab590c046853ef39aa1c58516a365f2f721e7f1de73a34c0c4916ea1c3331a6c5db5e218e5921b0ef77abb5b50f5caf832d832eb0cc328133d58a8
+  data.tar.gz: f3c544d01d70da7ac4379311208fd57932ba26ca157b039fdda05d4c96f8c7f6fbe93a45376ad4bf4e2cf3c10e5c2e9a6157a8b729dd58006a675b9ffc3a48ce

data/NEWS.md

@@ -1,5 +1,20 @@
 # Nanoc news
 
+## 4.10.0 (2018-10-14)
+
+Features:
+
+* Added source map support to the Sass filter (#1365) [Gregory Pakosz]
+* Added a `nanoc()` Sass function (#1365) [Gregory Pakosz]
+
+Fixes:
+
+* Ensured breadcrumb trail always ends in item itself (#1367)
+
+Enhancemens:
+
+* Made Nanoc error when meta-file cannot be unambiguously associated (#1370)
+
 ## 4.9.9 (2018-10-06)
 
 Fixes:

data/lib/nanoc/base/errors.rb

@@ -236,6 +236,12 @@ module Nanoc::Int
       end
     end
 
+    class AmbiguousMetadataAssociation < Generic
+      def initialize(content_filenames, meta_filename)
+        super("There are multiple content files (#{content_filenames.join(', ')}) that could match the file containing metadata (#{meta_filename}).")
+      end
+    end
+
     class InternalInconsistency < Generic
     end
   end

data/lib/nanoc/base/feature.rb

@@ -93,8 +93,8 @@ end
 
 # Tracking issue:
 # https://github.com/nanoc/features/issues/24
-Nanoc::Feature.define('live_cmd', version: '4.9')
+Nanoc::Feature.define('live_cmd', version: '4.10')
 
 # Tracking issue:
 # https://github.com/nanoc/features/issues/40
-Nanoc::Feature.define('toml', version: '4.9')
+Nanoc::Feature.define('toml', version: '4.10')

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

@@ -34,7 +34,7 @@ module Nanoc
     class << self
       def define(ident, &block)
         filter_class = Class.new(::Nanoc::Filter) { identifier(ident) }
-        filter_class.send(:define_method, :run) do |content, params|
+        filter_class.send(:define_method, :run) do |content, params = {}|
           instance_exec(content, params, &block)
         end
       end

data/lib/nanoc/data_sources/filesystem.rb

@@ -176,30 +176,49 @@ module Nanoc::DataSources
 
       return [] if dir_name.nil?
 
-      all_split_files_in(dir_name).each do |base_filename, (meta_ext, content_exts)|
-        content_exts.each do |content_ext|
-          meta_filename    = filename_for(base_filename, meta_ext)
-          content_filename = filename_for(base_filename, content_ext)
-
-          proto_doc = read_proto_document(content_filename, meta_filename, klass)
-
-          content = content_for(proto_doc, content_filename)
-          attributes = attributes_for(proto_doc, content_filename, meta_filename)
-          identifier = identifier_for(content_filename, meta_filename, dir_name)
-
-          res << klass.new(
-            content,
-            attributes,
-            identifier,
-            content_checksum_data: content_checksum_data_for(proto_doc),
-            attributes_checksum_data: attributes_checksum_data_for(proto_doc, content_filename, meta_filename),
-          )
-        end
+      each_content_meta_pair_in(dir_name) do |content_filename, meta_filename|
+        proto_doc = read_proto_document(content_filename, meta_filename, klass)
+
+        content = content_for(proto_doc, content_filename)
+        attributes = attributes_for(proto_doc, content_filename, meta_filename)
+        identifier = identifier_for(content_filename, meta_filename, dir_name)
+
+        res << klass.new(
+          content,
+          attributes,
+          identifier,
+          content_checksum_data: content_checksum_data_for(proto_doc),
+          attributes_checksum_data: attributes_checksum_data_for(proto_doc, content_filename, meta_filename),
+        )
       end
 
       res
     end
 
+    # Enumerates each pair of content file and meta file. If there is ambiguity, it will raise an error.
+    def each_content_meta_pair_in(dir_name)
+      all_split_files_in(dir_name).each do |base_filename, (meta_ext, content_exts)|
+        meta_filename = filename_for(base_filename, meta_ext)
+        content_filenames = content_exts.map { |e| filename_for(base_filename, e) }
+
+        have_possible_ambiguity = meta_filename && content_filenames.size > 1
+        if have_possible_ambiguity && content_filenames.count { |fn| !parser.frontmatter?(fn) } != 1
+          raise Nanoc::Int::Errors::AmbiguousMetadataAssociation.new(content_filenames, meta_filename)
+        end
+
+        content_filenames.each do |content_filename|
+          real_meta_filename =
+            if have_possible_ambiguity && parser.frontmatter?(content_filename)
+              nil
+            else
+              meta_filename
+            end
+
+          yield(content_filename, real_meta_filename)
+        end
+      end
+    end
+
     def content_checksum_data_for(proto_doc)
       data = proto_doc.content_checksum_data
       data ? Digest::SHA1.digest(data) : nil
@@ -379,8 +398,11 @@ module Nanoc::DataSources
       end
     end
 
+    def parser
+      @parser ||= Parser.new(config: @config)
+    end
+
     def parse(content_filename, meta_filename)
-      parser = Parser.new(config: @config)
       parser.call(content_filename, meta_filename)
     end
   end

data/lib/nanoc/data_sources/filesystem/parser.rb

@@ -70,6 +70,11 @@ class Nanoc::DataSources::Filesystem
       meta
     end
 
+    def frontmatter?(filename)
+      data = Tools.read_file(filename, config: @config)
+      /\A#{SEPARATOR}\s*$/.match?(data)
+    end
+
     def verify_meta(meta, filename)
       return if meta.is_a?(Hash)
 

data/lib/nanoc/filters/sass.rb

@@ -1,45 +1,153 @@
 # frozen_string_literal: true
 
 module Nanoc::Filters
-  # @api private
-  class Sass < Nanoc::Filter
-    identifier :sass
-
-    requires 'sass', 'nanoc/filters/sass/sass_filesystem_importer'
-
-    # Runs the content through [Sass](http://sass-lang.com/).
-    # Parameters passed to this filter will be passed on to Sass.
-    #
-    # @param [String] content The content to filter
-    #
-    # @return [String] The filtered content
-    def run(content, params = {})
+  Nanoc::Filter.define(:sass) do |content, params = {}|
+    include Sass
+    css(self, @item_rep, content, params)
+  end
+
+  Nanoc::Filter.define(:sass_sourcemap) do |content, params = {}|
+    include Sass
+    sourcemap(self, @item_rep, content, params)
+  end
+
+  require 'sass'
+
+  module Sass
+    def css(filter, rep, content, params)
+      css, = render(filter, rep, content, params)
+      css
+    end
+
+    def sourcemap(filter, rep, content, params)
+      _, sourcemap = render(filter, rep, content, params)
+      sourcemap
+    end
+
+    private
+
+    def render(filter, rep, content, params = {})
+      importer = NanocSassImporter.new(filter)
+
       options = params.merge(
-        nanoc_current_filter: self,
-        filename: @item&.raw_filename,
+        load_paths: [importer, *params[:load_paths]&.reject { |p| p.is_a?(String) && %r{^content/} =~ p }],
+        importer: importer,
+        filename: rep.item.identifier.to_s,
+        cache: false,
       )
+      sourcemap_path = options.delete(:sourcemap_path)
+
       engine = ::Sass::Engine.new(content, options)
-      engine.render
+      css, sourcemap = sourcemap_path ? engine.render_with_sourcemap(sourcemap_path) : engine.render
+      [css, sourcemap&.to_json(css_uri: rep.path, type: rep.path.nil? ? :inline : :auto)]
     end
 
-    def self.item_filename_map_for_config(config, items)
-      @item_filename_map ||= {}
-      @item_filename_map[config] ||=
-        {}.tap do |map|
-          items.each do |item|
-            if item.raw_filename
-              path = Pathname.new(item.raw_filename).realpath.to_s
-              map[path] = item
+    # @api private
+    class NanocSassImporter < ::Sass::Importers::Filesystem
+      attr_reader :filter
+
+      def initialize(filter)
+        @filter = filter
+        super('.')
+      end
+
+      def find_relative(name, base_identifier, options)
+        base_raw_filename = filter.items[base_identifier].raw_filename
+
+        # we can't resolve a relative filename from an in-memory item
+        return unless base_raw_filename
+
+        raw_filename, syntax = ::Sass::Util.destructure(find_real_file(File.dirname(base_raw_filename), name, options))
+        return unless raw_filename
+
+        item = raw_filename_to_item(raw_filename)
+        # it doesn't make sense to import a file, from Nanoc's content if the corresponding item has been deleted
+        raise "unable to map #{raw_filename} to any item" if item.nil?
+
+        filter.depend_on([item])
+
+        options[:syntax] = syntax
+        options[:filename] = item.identifier.to_s
+        options[:importer] = self
+        ::Sass::Engine.new(item.raw_content, options)
+      end
+
+      def find(identifier, options)
+        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
+
+        options[:syntax] = :scss
+        options[:filename] = identifier.to_s
+        options[:importer] = self
+        ::Sass::Engine.new(content, options)
+      end
+
+      def key(identifier, _options)
+        [self.class.name + ':' + root, identifier.to_s]
+      end
+
+      def public_url(identifier, _sourcemap_directory)
+        path = filter.items[identifier].path
+        return path unless path.nil?
+
+        raw_filename = filter.items[identifier].raw_filename
+        return if raw_filename.nil?
+
+        ::Sass::Util.file_uri_from_path(raw_filename)
+      end
+
+      def to_s
+        'Nanoc Sass Importer'
+      end
+
+      def self.raw_filename_to_item_map_for_config(config, items)
+        @raw_filename_to_item_map ||= {}
+        @raw_filename_to_item_map[config.object_id] ||=
+          {}.tap do |map|
+            items.each do |item|
+              if item.raw_filename
+                path = Pathname.new(item.raw_filename).realpath.to_s
+                map[path] = item
+              end
             end
           end
-        end
-    end
+      end
+
+      def raw_filename_to_item(filename)
+        realpath = Pathname.new(filename).realpath.to_s
 
-    def imported_filename_to_item(filename)
-      realpath = Pathname.new(filename).realpath.to_s
+        map = self.class.raw_filename_to_item_map_for_config(filter.config, filter.items)
+        map[realpath]
+      end
+    end
+  end
 
-      map = self.class.item_filename_map_for_config(@config, @items)
-      map[realpath]
+  module ::Sass::Script::Functions
+    def nanoc(string, params)
+      assert_type string, :String
+      assert_type params, :Hash
+      result = options[:importer].filter.instance_eval(string.value)
+      case result
+      when TrueClass, FalseClass
+        bool(result)
+      when Array
+        list(result, :comma)
+      when Hash
+        map(result)
+      when nil
+        null
+      when Numeric
+        number(result)
+      else
+        params['unquote'] ? unquoted_string(result) : quoted_string(result)
+      end
     end
+    declare :nanoc, [:string], var_kwargs: true
   end
 end

data/lib/nanoc/helpers/breadcrumbs.rb

@@ -33,6 +33,34 @@ module Nanoc::Helpers
 
     # @return [Array]
     def breadcrumbs_trail
+      # The design of this function is a little complicated.
+      #
+      # We can’t use #parent_of from the ChildParent helper, because the
+      # breadcrumb trail can have gaps. For example, the breadcrumbs trail for
+      # /software/oink.md might be /index.md -> nil -> /software/oink.md if
+      # there is no item matching /software.* or /software/index.*.
+      #
+      # What this function does instead is something more complicated:
+      #
+      # 1.  It creates an ordered prefix list, based on the identifier of the
+      #     item to create a breadcrumbs trail for. For example,
+      #     /software/oink.md might have the prefix list
+      #     ['', '/software', '/software/oink.md'].
+      #
+      # 2.  For each of the elements in that list, it will create a list of
+      #     patterns could match zero or more items. For example, the element
+      #     '/software' would correspond to the pattern '/software.*'.
+      #
+      # 3.  For each of the elements in that list, and for each pattern for that
+      #     element, it will find any matching element. For example, the
+      #     pattern '/software.*' (coming from the prefix /software) would match
+      #     the item /software.md.
+      #
+      # 4.  Return the list of items, with the last element replaced by the item
+      #     for which the breadcrumb is generated for -- while ancestral items
+      #     in the breadcrumbs trail can have a bit of ambiguity, the item for
+      #     which to generate the breadcrumbs trail is fixed.
+
       # e.g. ['', '/foo', '/foo/bar']
       components = item.identifier.components
       prefixes = components.inject(['']) { |acc, elem| acc + [acc.last + '/' + elem] }
@@ -40,9 +68,9 @@ module Nanoc::Helpers
       if @item.identifier.legacy?
         prefixes.map { |pr| @items[Nanoc::Identifier.new('/' + pr, type: :legacy)] }
       else
-        prefixes
-          .reject { |pr| pr =~ /^\/index\./ }
-          .map do |pr|
+        ancestral_prefixes = prefixes.reject { |pr| pr =~ /^\/index\./ }[0..-2]
+        ancestral_items =
+          ancestral_prefixes.map do |pr|
             if pr == ''
               @items['/index.*']
             else
@@ -50,6 +78,7 @@ module Nanoc::Helpers
               prefix_patterns.lazy.map { |pat| @items[pat] }.find(&:itself)
             end
           end
+        ancestral_items + [item]
       end
     end
   end

data/lib/nanoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.9.9
+  version: 4.10.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-06 00:00:00.000000000 Z
+date: 2018-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -401,7 +401,6 @@ files:
 - lib/nanoc/filters/relativize_paths.rb
 - lib/nanoc/filters/rubypants.rb
 - lib/nanoc/filters/sass.rb
-- lib/nanoc/filters/sass/sass_filesystem_importer.rb
 - lib/nanoc/filters/slim.rb
 - lib/nanoc/filters/typogruby.rb
 - lib/nanoc/filters/uglify_js.rb

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-class ::Sass::Importers::Filesystem
-  alias _orig_find _find
-
-  def _find(dir, name, options)
-    # Find filename
-    full_filename, _syntax = ::Sass::Util.destructure(find_real_file(dir, name, options))
-    return nil if full_filename.nil?
-
-    # Create dependency
-    filter = options[:nanoc_current_filter]
-    if filter
-      item = filter.imported_filename_to_item(full_filename)
-      filter.depend_on([item]) unless item.nil?
-    end
-
-    # Call original _find
-    _orig_find(dir, name, options)
-  end
-end