middleman-core 4.3.0.rc.1 → 4.3.0.rc.2

data/lib/middleman-core/renderers/redcarpet.rb

@@ -35,7 +35,7 @@ module Middleman
         end
 
         # Renderer Options
-        possible_render_opts = [:filter_html, :no_images, :no_links, :no_styles, :safe_links_only, :with_toc_data, :hard_wrap, :xhtml, :prettify, :link_attributes]
+        possible_render_opts = %i[filter_html no_images no_links no_styles safe_links_only with_toc_data hard_wrap xhtml prettify link_attributes]
 
         render_options = possible_render_opts.each_with_object({}) do |opt, sum|
           sum[opt] = options.delete(opt) if options.key?(opt)
@@ -65,7 +65,7 @@ module Middleman
     class MiddlemanRedcarpetHTML < ::Redcarpet::Render::HTML
       cattr_accessor :scope
 
-      def initialize(options={})
+      def initialize(options = {})
         @local_options = options.dup
 
         super

data/lib/middleman-core/renderers/sass.rb

@@ -16,7 +16,7 @@ module Middleman
       define_setting :sass_source_maps, nil, 'Whether to inline sourcemap into Sass'
 
       # Setup extension
-      def initialize(app, options={}, &block)
+      def initialize(app, options = {}, &block)
         super
 
         logger.info '== Preferring use of LibSass' if defined?(::SassC)
@@ -57,10 +57,10 @@ module Middleman
           @context ||= context
 
           sass_module = if defined?(::SassC)
-            ::SassC
-          else
-            ::Sass
-          end
+                          ::SassC
+                        else
+                          ::Sass
+                        end
 
           @engine = sass_module::Engine.new(data, sass_options)
 

data/lib/middleman-core/renderers/sass_functions.rb

@@ -14,7 +14,7 @@ module Middleman
       #   background: url(image-path("image.jpg"));                // background: url("/assets/image.jpg");
       #   background: url(image-path("image.jpg", $digest: true)); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
       #
-      def image_path(source, options={})
+      def image_path(source, options = {})
         p = ::Middleman::Util.asset_path(middleman_context, :images, source.value, map_options(options))
         ::Sass::Script::String.new p.to_s, :string
       end
@@ -28,7 +28,7 @@ module Middleman
       #   background: image-url("image.jpg");                // background: url("/assets/image.jpg");
       #   background: image-url("image.jpg", $digest: true); // background: url("/assets/image-27a8f1f96afd8d4c67a59eb9447f45bd.jpg");
       #
-      def image_url(source, options={}, _cache_buster=nil)
+      def image_url(source, options = {}, _cache_buster = nil)
         # Work with the Compass #image_url API
         if options.respond_to? :value
           case options.value
@@ -50,7 +50,7 @@ module Middleman
       #   src: url(font-path("font.ttf"));                // src: url("/assets/font.ttf");
       #   src: url(font-path("font.ttf", $digest: true)); // src: url("/assets/font-27a8f1f96afd8d4c67a59eb9447f45bd.ttf");
       #
-      def font_path(source, options={})
+      def font_path(source, options = {})
         p = ::Middleman::Util.asset_path(middleman_context, :fonts, source.value, map_options(options))
         ::Sass::Script::String.new p.to_s, :string
       end
@@ -64,7 +64,7 @@ module Middleman
       #   src: font-url("font.ttf");                  // src: url("/assets/font.ttf");
       #   src: font-url("image.jpg", $digest: true);  // src: url("/assets/font-27a8f1f96afd8d4c67a59eb9447f45bd.ttf");
       #
-      def font_url(source, options={})
+      def font_url(source, options = {})
         # Work with the Compass #font_url API
         if options.respond_to? :value
           case options.value
@@ -92,7 +92,7 @@ module Middleman
 
       # Returns an options hash where the keys are symbolized
       # and the values are unwrapped Sass literals.
-      def map_options(options={}) # :nodoc:
+      def map_options(options = {}) # :nodoc:
         ::Sass::Util.map_hash(options) do |key, value|
           [key.to_sym, value.respond_to?(:value) ? value.value : value]
         end

data/lib/middleman-core/renderers/slim.rb

@@ -13,7 +13,7 @@ class ::Slim::Template
   def initialize(file, line, opts, &block)
     if opts.key?(:context)
       ::Slim::Embedded::SassEngine.disable_option_validator!
-      %w(sass scss markdown).each do |engine|
+      %w[sass scss markdown].each do |engine|
         (::Slim::Embedded.options[engine.to_sym] ||= {})[:context] = opts[:context]
       end
     end
@@ -31,7 +31,7 @@ module Middleman
     # Slim renderer
     class Slim < ::Middleman::Extension
       # Setup extension
-      def initialize(_app, _options={}, &_block)
+      def initialize(_app, _options = {}, &_block)
         super
 
         # Setup Slim options to work with partials

data/lib/middleman-core/sitemap/extensions/ignores.rb

@@ -12,7 +12,7 @@ module Middleman
         # @param [String, Regexp] path Path glob expression, or path regex
         # @return [IgnoreDescriptor]
         Contract Or[String, Regexp, Proc] => RespondTo[:execute_descriptor]
-        def ignore(path=nil, &block)
+        def ignore(path = nil, &block)
           @app.sitemap.invalidate_resources_not_ignored_cache!
 
           if path.is_a? Regexp
@@ -34,7 +34,7 @@ module Middleman
 
         IgnoreDescriptor = Struct.new(:path, :block) do
           def execute_descriptor(_app, resources)
-            resources.map do |r|
+            resources.each do |r|
               # Ignore based on the source path (without template extensions)
               if ignored?(r.normalized_path)
                 r.ignore!
@@ -42,8 +42,6 @@ module Middleman
                 # This allows files to be ignored by their source file name (with template extensions)
                 r.ignore!
               end
-
-              r
             end
           end
 

data/lib/middleman-core/sitemap/extensions/import.rb

@@ -12,7 +12,7 @@ module Middleman
 
         ImportFileDescriptor = Struct.new(:from, :to) do
           def execute_descriptor(app, resources)
-            source = ::Middleman::SourceFile.new(Pathname(from).relative_path_from(app.source_dir), Pathname(from), app.source_dir, Set.new([:source, :binary]), 0)
+            source = ::Middleman::SourceFile.new(Pathname(from).relative_path_from(app.source_dir), Pathname(from), app.source_dir, Set.new(%i[source binary]), 0)
 
             resources + [
               ::Middleman::Sitemap::Resource.new(app.sitemap, to, source)

data/lib/middleman-core/sitemap/extensions/on_disk.rb

@@ -7,7 +7,7 @@ module Middleman
       class OnDisk < Extension
         self.resource_list_manipulator_priority = 0
 
-        def initialize(app, config={}, &block)
+        def initialize(app, config = {}, &block)
           super
 
           @file_paths_on_disk = Set.new

data/lib/middleman-core/sitemap/extensions/proxies.rb

@@ -22,7 +22,7 @@ module Middleman
         # @option opts [Hash] data Extra metadata to add to the page. This is the same as frontmatter, though frontmatter will take precedence over metadata defined here. Available via {Resource#data}.
         # @return [ProxyDescriptor]
         Contract String, String, Maybe[Hash] => RespondTo[:execute_descriptor]
-        def proxy(path, target, opts={})
+        def proxy(path, target, opts = {})
           ProxyDescriptor.new(
             ::Middleman::Util.normalize_path(path),
             ::Middleman::Util.normalize_path(target),
@@ -75,6 +75,7 @@ module Middleman
 
         target = ::Middleman::Util.normalize_path(target)
         raise "You can't proxy #{path} to itself!" if target == path
+
         @target = target
       end
 

data/lib/middleman-core/sitemap/extensions/redirects.rb

@@ -29,7 +29,7 @@ module Middleman
         # @param [String] path
         # @param [Hash] opts The :to value gives a target path
         Contract String, { to: Or[String, ::Middleman::Sitemap::Resource] }, Maybe[Proc] => RedirectDescriptor
-        def redirect(path, opts={}, &block)
+        def redirect(path, opts = {}, &block)
           RedirectDescriptor.new(path, opts[:to], block_given? ? block : nil)
         end
       end

data/lib/middleman-core/sitemap/extensions/request_endpoints.rb

@@ -27,7 +27,7 @@ module Middleman
         # @param [Hash] opts The :path value gives a request path if it
         # differs from the output path
         Contract String, Or[{ path: String }, Proc] => EndpointDescriptor
-        def endpoint(path, opts={}, &block)
+        def endpoint(path, opts = {}, &block)
           if block_given?
             EndpointDescriptor.new(path, path, block)
           else

data/lib/middleman-core/sitemap/extensions/traversal.rb

@@ -4,39 +4,93 @@ module Middleman
       module Traversal
         def traversal_root
           root = if !@app.extensions[:i18n]
-            '/'
-          else
-            @app.extensions[:i18n].path_root(::I18n.locale)
-          end
+                   '/'
+                 else
+                   @app.extensions[:i18n].path_root(::I18n.locale)
+                 end
 
           root.sub(/^\//, '')
         end
 
         # This resource's parent resource
         # @return [Middleman::Sitemap::Resource, nil]
-        def parent
-          root = path.sub(/^#{::Regexp.escape(traversal_root)}/, '')
-          parts = root.split('/')
+        def parent(_recurse = false)
+          max_recursion = @app.config[:max_traversal_recursion] || 99
+          parent_helper(path, max_recursion)
+        end
+
+        def parent_helper(child_path, max_recursion)
+          # What is the configured format for index pages.
+          index_file = @app.config[:index_file]
+          parts = child_path.split('/')
+          # Reduce the path by the current page to get the parent level path.
+          current_page = parts.pop
+          # Does the current page has the name of an index file?
+          is_index = current_page == index_file
+          # Is the `current_page` in the traversal root?
+          # Note: `traversal_root` is `/` for non localised pages and `/[lang]/` for
+          # localised pages.
+          at_traversal_root = !(child_path =~ /^#{traversal_root}#{current_page}$/).nil?
+
+          # Check that we have any path parts left after the pop because if we
+          # don't, `current_page` is either root or another file under root.
+          # Also, if we are `at_traversal_root`, we consider this root.
+          if parts.empty? || at_traversal_root
+            # If this `is_index`, the `current_page` is root and there is no parent.
+            return nil if is_index
 
-          tail = parts.pop
-          is_index = (tail == @app.config[:index_file])
+            # `current_page` must be a page under root, let's return the root
+            # index page of the `traversal_root` (`/` or `/[lang]/`).
+            return @store.find_resource_by_path("#{traversal_root}#{index_file}")
+          end
+
+          # Get the index file for the parent path parts, e.g.: `/blog/index.html`
+          # for `/blog/`.
+          index_by_parts = proc do |subparts|
+            found = @store.find_resource_by_destination_path("#{subparts.join('/')}/#{index_file}")
+            return found unless found.nil?
+          end
 
-          if parts.empty?
-            return is_index ? nil : @store.find_resource_by_path(@app.config[:index_file])
+          # Get a file that has the name of the parent path parts e.g.:
+          # `/blog.html` for `/blog/`.
+          file_by_parts = proc do |subparts|
+            test_expr = Regexp.escape(subparts.join('/'))
+            # eponymous reverse-lookup
+            found = @store.resources.find do |candidate|
+              candidate.path =~ %r{^#{test_expr}(?:\.[a-zA-Z0-9]+|\/)$}
+            end
+            return found unless found.nil?
           end
 
-          test_expr = parts.join('\\/')
-          # eponymous reverse-lookup
-          found = @store.resources.find do |candidate|
-            candidate.path =~ %r{^#{test_expr}(?:\.[a-zA-Z0-9]+|\/)$}
+          # Try to find a file matching the parent path name and return it.
+          # E.g. `parts == ['en', 'blog']`, we try to find: `/en/blog.html`
+          file_by_parts.call(parts)
+
+          # Try to find an non-localised parent instead if `traversal_root`
+          # indicates the path is localised and there are still more parts
+          # remaining, and return it.
+          # E.g. `parts == ['en', 'blog']`, we try to find: `/blog.html`
+          if traversal_root != '/' && parts.length > 1
+            file_by_parts.call(parts[1..-1])
           end
 
-          if found
-            found
-          else
-            parts.pop if is_index
-            @store.find_resource_by_destination_path("#{parts.join('/')}/#{@app.config[:index_file]}")
+          # Now let's drop the last part of the path to try to find an index
+          # file in the path above `current_page`'s path and return it.
+          # E.g. `parts == ['en', 'blog']`, we try to find: `/en/index.html`
+          parts.pop if is_index
+          index_by_parts.call(parts)
+
+          # Lastly, check for an non-localised index index file in the path
+          # above `current_page`'s path and return it.
+          # E.g. `parts == ['en', 'blog']`, we try to find: `/index.html`
+          if traversal_root == "#{parts.first}/"
+            index_by_parts.call(parts[1..-1] || '')
+          end
+          if !parts.empty? && max_recursion.positive?
+            return parent_helper(parts.join('/'), max_recursion - 1)
           end
+
+          nil
         end
 
         # This resource's child resources
@@ -45,12 +99,12 @@ module Middleman
           return [] unless directory_index?
 
           base_path = if eponymous_directory?
-            eponymous_directory_path
-          else
-            path.sub(@app.config[:index_file].to_s, '')
-          end
+                        eponymous_directory_path
+                      else
+                        path.sub(@app.config[:index_file].to_s, '')
+                      end
 
-          prefix = %r{^#{base_path.sub("/", "\\/")}}
+          prefix = /^#{base_path.sub("/", "\\/")}/
 
           @store.resources.select do |sub_resource|
             if sub_resource.path == path || sub_resource.path !~ prefix
@@ -73,6 +127,7 @@ module Middleman
         # @return [Array<Middleman::Sitemap::Resource>]
         def siblings
           return [] unless parent
+
           parent.children.reject { |p| p == self }
         end
 

data/lib/middleman-core/sitemap/resource.rb

@@ -45,19 +45,19 @@ module Middleman
       # @param [String] path
       # @param [String] source
       Contract IsA['Middleman::Sitemap::Store'], String, Maybe[Or[IsA['Middleman::SourceFile'], String]] => Any
-      def initialize(store, path, source=nil)
+      def initialize(store, path, source = nil)
         @store       = store
         @app         = @store.app
         @path        = path
         @ignored     = false
 
-        source = Pathname(source) if source && source.is_a?(String)
+        source = Pathname(source) if source&.is_a?(String)
 
-        @file_descriptor = if source && source.is_a?(Pathname)
-          ::Middleman::SourceFile.new(source.relative_path_from(@app.source_dir), source, @app.source_dir, Set.new([:source]), 0)
-        else
-          source
-        end
+        @file_descriptor = if source&.is_a?(Pathname)
+                             ::Middleman::SourceFile.new(source.relative_path_from(@app.source_dir), source, @app.source_dir, Set.new([:source]), 0)
+                           else
+                             source
+                           end
 
         @destination_path = @path
 
@@ -75,6 +75,7 @@ module Middleman
       Contract Bool
       def template?
         return false if file_descriptor.nil?
+
         !::Middleman::Util.tilt_class(file_descriptor[:full_path].to_s).nil?
       end
 
@@ -97,14 +98,14 @@ module Middleman
       #   Page are data that is exposed through this resource's data member.
       #   Note: It is named 'page' for backwards compatibility with older MM.
       Contract METADATA_HASH, Maybe[Bool] => METADATA_HASH
-      def add_metadata(meta={}, reverse=false)
+      def add_metadata(meta = {}, reverse = false)
         @page_data = nil
 
         @metadata = if reverse
-          meta.deep_merge(@metadata)
-        else
-          @metadata.deep_merge(meta)
-        end
+                      meta.deep_merge(@metadata)
+                    else
+                      @metadata.deep_merge(meta)
+                    end
       end
 
       # Data about this resource, populated from frontmatter or extensions.
@@ -139,7 +140,7 @@ module Middleman
       # Render this resource
       # @return [String]
       Contract Hash, Hash => String
-      def render(opts={}, locs={})
+      def render(opts = {}, locs = {})
         return ::Middleman::FileRenderer.new(@app, file_descriptor[:full_path].to_s).template_data_for_file unless template?
 
         md   = metadata
@@ -218,14 +219,14 @@ module Middleman
       Contract String => String
       def make_implicit_page_id(path)
         @id ||= begin
-          if prok = @app.config[:page_id_generator]
-            return prok.call(path)
-          end
+          prok = @app.config[:page_id_generator]
+
+          return prok.call(path) if prok
 
           basename = if ext == '.html'
-            File.basename(path, ext)
-          else
-            File.basename(path)
+                       File.basename(path, ext)
+                     else
+                       File.basename(path)
                      end
 
           # Remove leading dot or slash if present
@@ -235,7 +236,7 @@ module Middleman
     end
 
     class StringResource < Resource
-      def initialize(store, path, contents=nil, &block)
+      def initialize(store, path, contents = nil, &block)
         @request_path = path
         @contents = block_given? ? block : contents
         super(store, path)

data/lib/middleman-core/sitemap/store.rb

@@ -88,7 +88,7 @@ module Middleman
       end
 
       Contract Symbol, RespondTo[:manipulate_resource_list], Maybe[Or[Num, ArrayOf[Num]]], Maybe[Symbol] => Any
-      def register_resource_list_manipulators(name, manipulator, priority=50, custom_name=nil)
+      def register_resource_list_manipulators(name, manipulator, priority = 50, custom_name = nil)
         Array(priority || 50).each do |p|
           register_resource_list_manipulator(name, manipulator, p, custom_name)
         end
@@ -103,7 +103,7 @@ module Middleman
       # @param [Symbol] custom_name The method name to execute.
       # @return [void]
       Contract Symbol, RespondTo[:manipulate_resource_list], Maybe[Num, Bool], Maybe[Symbol] => Any
-      def register_resource_list_manipulator(name, manipulator, priority=50, custom_name=nil)
+      def register_resource_list_manipulator(name, manipulator, priority = 50, custom_name = nil)
         # The third argument used to be a boolean - handle those who still pass one
         priority = 50 unless priority.is_a? Numeric
         @resource_list_manipulators = @resource_list_manipulators.push(
@@ -171,7 +171,7 @@ module Middleman
       # @param [Boolean] include_ignored Whether to include ignored resources
       # @return [Array<Middleman::Sitemap::Resource>]
       Contract Bool => ResourceList
-      def resources(include_ignored=false)
+      def resources(include_ignored = false)
         @lock.synchronize do
           ensure_resource_list_updated!
           if include_ignored