middleman-core 4.4.0 → 5.0.0.rc.1

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

@@ -13,12 +13,14 @@ module Middleman
         expose_to_config :move_file
 
         MoveFileDescriptor = Struct.new(:from, :to) do
-          def execute_descriptor(_app, resources)
-            resources.each do |r|
-              r.destination_path = to if from == r.path || from == r.destination_path
-            end
+          def execute_descriptor(_app, resource_list)
+            resource_list.each do |r|
+              next unless from == r.path || from == r.destination_path
 
-            resources
+              resource_list.update!(r, :destination_path) do
+                r.destination_path = to
+              end
+            end
           end
         end
 

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, options_hash = ::Middleman::EMPTY_HASH, &block)
           super
 
           @file_paths_on_disk = Set.new
@@ -57,14 +57,15 @@ module Middleman
         end
 
         # Update the main sitemap resource list
-        # @return Array<Middleman::Sitemap::Resource>
-        Contract ResourceList => ResourceList
-        def manipulate_resource_list(resources)
-          resources + files_for_sitemap.map do |file|
-            ::Middleman::Sitemap::Resource.new(
-              @app.sitemap,
-              @app.sitemap.file_to_path(file),
-              file
+        Contract IsA['Middleman::Sitemap::ResourceListContainer'] => Any
+        def manipulate_resource_list_container!(resource_list)
+          files_for_sitemap.each do |file|
+            resource_list.add!(
+              ::Middleman::Sitemap::Resource.new(
+                @app.sitemap,
+                @app.sitemap.file_to_path(file),
+                file
+              )
             )
           end
         end

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

@@ -22,17 +22,17 @@ 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, options_hash = ::Middleman::EMPTY_HASH)
           ProxyDescriptor.new(
             ::Middleman::Util.normalize_path(path),
             ::Middleman::Util.normalize_path(target),
-            opts.dup
+            options_hash
           )
         end
       end
 
       ProxyDescriptor = Struct.new(:path, :target, :metadata) do
-        def execute_descriptor(app, resources)
+        def execute_descriptor(app, resource_list)
           md = metadata.dup
           should_ignore = md.delete(:ignore)
 
@@ -40,18 +40,20 @@ module Middleman
           page_data[:id] = md.delete(:id) if md.key?(:id)
 
           r = ProxyResource.new(app.sitemap, path, target)
-          r.add_metadata(
-            locals: md.delete(:locals) || {},
-            page: page_data || {},
-            options: md
-          )
+          if (locs = md.delete(:locals))
+            r.add_metadata_locals(locs)
+          end
+
+          r.add_metadata_page(page_data) if page_data
+
+          r.add_metadata_options(md)
 
           if should_ignore
             d = ::Middleman::Sitemap::Extensions::Ignores::StringIgnoreDescriptor.new(target)
-            d.execute_descriptor(app, resources)
+            d.execute_descriptor(app, resource_list)
           end
 
-          resources + [r]
+          resource_list.add! r
         end
       end
     end
@@ -71,10 +73,11 @@ module Middleman
       # @param [String] path
       # @param [String] target
       def initialize(store, path, target)
-        super(store, path)
+        super(store, path, nil, 2)
 
         target = ::Middleman::Util.normalize_path(target)
         raise "You can't proxy #{path} to itself!" if target == path
+
         @target = target
       end
 
@@ -83,15 +86,11 @@ module Middleman
       # @return [Sitemap::Resource]
       Contract IsA['Middleman::Sitemap::Resource']
       def target_resource
-        resource = @store.find_resource_by_path(@target)
+        resource = @store.by_path(@target)
 
-        unless resource
-          raise "Path #{path} proxies to unknown file #{@target}:#{@store.resources.map(&:path)}"
-        end
+        raise "Path #{path} proxies to unknown file #{@target}" unless resource
 
-        if resource.is_a? ProxyResource
-          raise "You can't proxy #{path} to #{@target} which is itself a proxy."
-        end
+        raise "You can't proxy #{path} to #{@target} which is itself a proxy." if resource.is_a? ProxyResource
 
         resource
       end
@@ -101,8 +100,16 @@ module Middleman
         target_resource.file_descriptor
       end
 
-      def metadata
-        target_resource.metadata.deep_merge super
+      def page
+        target_resource.page.deep_merge super
+      end
+
+      def options
+        target_resource.options.deep_merge super
+      end
+
+      def locals
+        target_resource.locals.deep_merge super
       end
 
       Contract Maybe[String]

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

@@ -13,7 +13,7 @@ module Middleman
         expose_to_config :redirect
 
         RedirectDescriptor = Struct.new(:path, :to, :template) do
-          def execute_descriptor(app, resources)
+          def execute_descriptor(app, resource_list)
             r = RedirectResource.new(
               app.sitemap,
               path,
@@ -21,7 +21,7 @@ module Middleman
             )
             r.output = template if template
 
-            resources + [r]
+            resource_list.add! r
           end
         end
 
@@ -29,8 +29,8 @@ 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)
-          RedirectDescriptor.new(path, opts[:to], block_given? ? block : nil)
+        def redirect(path, options_hash = ::Middleman::EMPTY_HASH, &block)
+          RedirectDescriptor.new(path, options_hash[:to], block_given? ? block : nil)
         end
       end
 

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

@@ -10,7 +10,7 @@ module Middleman
         expose_to_config :endpoint
 
         EndpointDescriptor = Struct.new(:path, :request_path, :block) do
-          def execute_descriptor(app, resources)
+          def execute_descriptor(app, resource_list)
             r = EndpointResource.new(
               app.sitemap,
               path,
@@ -18,20 +18,19 @@ module Middleman
             )
             r.output = block if block
 
-            resources + [r]
+            resource_list.add! r
           end
         end
 
         # Setup a proxy from a path to a target
         # @param [String] path
-        # @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, options_hash = ::Middleman::EMPTY_HASH, &block)
           if block_given?
             EndpointDescriptor.new(path, path, block)
           else
-            EndpointDescriptor.new(path, opts[:path] || path, nil)
+            EndpointDescriptor.new(path, options_hash[:path] || path, nil)
           end
         end
       end

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

@@ -4,39 +4,87 @@ 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 localized pages and `/[lang]/` for
+          # localized pages.
+          at_traversal_root = !(child_path =~ /^#{traversal_root}#{current_page}$/).nil?
 
-          tail = parts.pop
-          is_index = (tail == @app.config[:index_file])
+          # 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
 
-          if parts.empty?
-            return is_index ? nil : @store.find_resource_by_path(@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.by_path("#{traversal_root}#{index_file}")
           end
 
-          test_expr = parts.join('\\/')
-          # eponymous reverse-lookup
-          found = @store.resources.find do |candidate|
-            candidate.path =~ %r{^#{test_expr}(?:\.[a-zA-Z0-9]+|\/)$}
+          # Get the index file for the parent path parts, e.g.: `/blog/index.html`
+          # for `/blog/`.
+          index_by_parts = proc do |subparts|
+            found = @store.by_destination_path("#{subparts.join('/')}/#{index_file}")
+            return found unless found.nil?
           end
 
-          if found
-            found
-          else
-            parts.pop if is_index
-            @store.find_resource_by_destination_path("#{parts.join('/')}/#{@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
+
+          # 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-localized parent instead if `traversal_root`
+          # indicates the path is localized and there are still more parts
+          # remaining, and return it.
+          # E.g. `parts == ['en', 'blog']`, we try to find: `/blog.html`
+          file_by_parts.call(parts[1..-1]) if traversal_root != '/' && parts.length > 1
+
+          # 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-localized 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`
+          index_by_parts.call(parts[1..-1] || '') if traversal_root == "#{parts.first}/"
+          return parent_helper(parts.join('/'), max_recursion - 1) if !parts.empty? && max_recursion.positive?
+
+          nil
         end
 
         # This resource's child resources
@@ -45,12 +93,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 +121,7 @@ module Middleman
         # @return [Array<Middleman::Sitemap::Resource>]
         def siblings
           return [] unless parent
+
           parent.children.reject { |p| p == self }
         end
 
@@ -86,9 +135,7 @@ module Middleman
         # (e.g., if the resource is named 'gallery.html' and a path exists named 'gallery/', this would return true)
         # @return [Boolean]
         def eponymous_directory?
-          if !path.end_with?("/#{@app.config[:index_file]}") && destination_path.end_with?("/#{@app.config[:index_file]}")
-            return true
-          end
+          return true if !path.end_with?("/#{@app.config[:index_file]}") && destination_path.end_with?("/#{@app.config[:index_file]}")
 
           @app.files.by_type(:source).watchers.any? do |source|
             (source.directory + Pathname(eponymous_directory_path)).directory?