middleman-core-with-external-sources-watch-fix 4.1.0 → 4.1.10

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

@@ -75,26 +75,36 @@ module Middleman
       Contract Bool
       def template?
         return false if file_descriptor.nil?
-        !::Tilt[file_descriptor[:full_path].to_s].nil?
+        !::Middleman::Util.tilt_class(file_descriptor[:full_path].to_s).nil?
       end
 
       # Backwards compatible method for turning descriptor into a string.
       # @return [String]
-      Contract String
+      Contract Maybe[String]
       def source_file
         file_descriptor && file_descriptor[:full_path].to_s
       end
 
+      Contract Or[Symbol, String, Fixnum]
+      def page_id
+        metadata[:page][:id] || destination_path
+      end
+
       # Merge in new metadata specific to this resource.
       # @param [Hash] meta A metadata block with keys :options, :locals, :page.
       #   Options are generally rendering/sitemap options
       #   Locals are local variables for rendering this resource's template
       #   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 => METADATA_HASH
-      def add_metadata(meta={})
+      Contract METADATA_HASH, Maybe[Bool] => METADATA_HASH
+      def add_metadata(meta={}, reverse=false)
         @page_data = nil
-        @metadata.deep_merge!(meta)
+
+        @metadata = if reverse
+          meta.deep_merge(@metadata)
+        else
+          @metadata.deep_merge(meta)
+        end
       end
 
       # Data about this resource, populated from frontmatter or extensions.

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

@@ -87,6 +87,13 @@ module Middleman
         @app.config_context.class.send :def_delegator, :app, :sitemap
       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)
+        Array(priority || 50).each do |p|
+          register_resource_list_manipulator(name, manipulator, p, custom_name)
+        end
+      end
+
       # Register an object which can transform the sitemap resource list. Best to register
       # these in a `before_configuration` or `after_configuration` hook.
       #
@@ -95,7 +102,7 @@ module Middleman
       # @param [Numeric] priority Sets the order of this resource list manipulator relative to the rest. By default this is 50, and manipulators run in the order they are registered, but if a priority is provided then this will run ahead of or behind other manipulators.
       # @param [Symbol] custom_name The method name to execute.
       # @return [void]
-      Contract Symbol, RespondTo[:manipulate_resource_list], Maybe[Num], Maybe[Symbol] => Any
+      Contract Symbol, RespondTo[:manipulate_resource_list], Maybe[Num, Bool], Maybe[Symbol] => Any
       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
@@ -149,6 +156,17 @@ module Middleman
         end
       end
 
+      # Find a resource given its page id
+      # @param [String] page_id The page id.
+      # @return [Middleman::Sitemap::Resource]
+      Contract Or[String, Symbol] => Maybe[IsA['Middleman::Sitemap::Resource']]
+      def find_resource_by_page_id(page_id)
+        @lock.synchronize do
+          ensure_resource_list_updated!
+          @_lookup_by_page_id[page_id.to_sym]
+        end
+      end
+
       # Get the array of all resources
       # @param [Boolean] include_ignored Whether to include ignored resources
       # @return [Array<Middleman::Sitemap::Resource>]
@@ -198,6 +216,8 @@ module Middleman
       # rebuild_resource_list! since the last time it was run. This is
       # very expensive!
       def ensure_resource_list_updated!
+        return if @app.config[:disable_sitemap]
+
         @lock.synchronize do
           return unless @needs_sitemap_rebuild
 
@@ -210,7 +230,7 @@ module Middleman
 
             @resource_list_manipulators.each do |m|
               ::Middleman::Util.instrument 'sitemap.manipulator', name: m[:name] do
-                @app.logger.debug "== Running manipulator: #{m[:name]}"
+                @app.logger.debug "== Running manipulator: #{m[:name]} (#{m[:priority]})"
                 @resources = m[:manipulator].send(m[:custom_name] || :manipulate_resource_list, @resources)
 
                 # Reset lookup cache
@@ -219,9 +239,19 @@ module Middleman
                 # Rebuild cache
                 @resources.each do |resource|
                   @_lookup_by_path[resource.path] = resource
+                end
+
+                @resources.each do |resource|
                   @_lookup_by_destination_path[resource.destination_path] = resource
                 end
 
+                # NB: This needs to be done after the previous two steps,
+                # since some proxy resources are looked up by path in order to
+                # get their metadata and subsequently their page_id.
+                @resources.each do |resource|
+                  @_lookup_by_page_id[resource.page_id.to_sym] = resource
+                end
+
                 invalidate_resources_not_ignored_cache!
               end
             end
@@ -239,6 +269,7 @@ module Middleman
         @lock.synchronize do
           @_lookup_by_path = {}
           @_lookup_by_destination_path = {}
+          @_lookup_by_page_id = {}
         end
       end
 

data/lib/middleman-core/sources.rb

@@ -116,7 +116,8 @@ module Middleman
     Contract Or[Symbol, HANDLER], Maybe[Hash] => HANDLER
     def watch(type_or_handler, options={})
       handler = if type_or_handler.is_a? Symbol
-        SourceWatcher.new(self, type_or_handler, options.delete(:path), options)
+        path = File.expand_path(options.delete(:path), app.root)
+        SourceWatcher.new(self, type_or_handler, path, options)
       else
         type_or_handler
       end

data/lib/middleman-core/sources/source_watcher.rb

@@ -2,6 +2,7 @@
 require 'listen'
 require 'middleman-core/contracts'
 require 'digest'
+require 'set'
 
 # Monkey patch Listen silencer so `only` works on directories too
 module Listen
@@ -49,7 +50,7 @@ module Middleman
     # Reference to lower level listener
     attr_reader :listener
 
-    IGNORED_DIRECTORIES = %w(.git node_modules .sass-cache).freeze
+    IGNORED_DIRECTORIES = Set.new(%w(.git node_modules .sass-cache vendor/bundle .bundle))
 
     # Construct a new SourceWatcher
     #
@@ -92,7 +93,7 @@ module Middleman
     # @return [void]
     Contract String => Any
     def update_path(directory)
-      @directory = Pathname(directory)
+      @directory = Pathname(File.expand_path(directory, app.root))
 
       stop_listener! if @listener
 
@@ -139,6 +140,7 @@ module Middleman
       end
 
       p = @directory + p if p.relative?
+
       if glob
         @extensionless_files[p]
       else
@@ -167,12 +169,13 @@ module Middleman
         wait_for_delay: 0.5
       }
 
-      config[:latency] = @latency if @latency
+      config[:latency] = @latency.to_i if @latency
 
       @listener = ::Listen.to(@directory.to_s, config, &method(:on_listener_change))
 
       @listener.ignore(/^\.sass-cache/)
-      # @listener.only(@only) unless @only.empty?
+      @listener.ignore(/^node_modules/)
+      @listener.ignore(/^vendor\/bundle/)
 
       @listener.start
     end
@@ -227,7 +230,8 @@ module Middleman
 
     Contract Pathname => Bool
     def should_not_recurse?(p)
-      IGNORED_DIRECTORIES.include?(p.basename.to_s)
+      relative_path = p.relative_path_from(@directory).to_s
+      IGNORED_DIRECTORIES.include?(relative_path)
     end
 
     # The `listen` gem callback.
@@ -260,7 +264,8 @@ module Middleman
         logger.debug "== Change (#{f[:types].inspect}): #{f[:relative_path]}"
       end
 
-      related_updates = ::Middleman::Util.find_related_files(app, (updated_paths + removed_paths)).select(&method(:valid?))
+      related_sources = valid_updates.map { |u| u[:full_path] } + removed_paths
+      related_updates = ::Middleman::Util.find_related_files(app, related_sources).select(&method(:valid?))
 
       related_updates.each do |f|
         logger.debug "== Possible Change (#{f[:types].inspect}): #{f[:relative_path]}"
@@ -299,9 +304,15 @@ module Middleman
       relative_path = path.relative_path_from(directory)
       relative_path = File.join(destination_dir, relative_path) if destination_dir
 
+      types << :no_frontmatter if partial?(relative_path.to_s)
+
       ::Middleman::SourceFile.new(Pathname(relative_path), path, directory, types, 0)
     end
 
+    def partial?(relative_path)
+      relative_path.split(::File::SEPARATOR).any? { |p| p.start_with?('_') }
+    end
+
     Contract IsA['Middleman::SourceFile'] => Any
     def record_file_change(f)
       if @files[f[:full_path]]

data/lib/middleman-core/template_context.rb

@@ -23,7 +23,7 @@ module Middleman
     attr_accessor :current_engine
 
     # Shorthand references to global values on the app instance.
-    def_delegators :@app, :config, :logger, :sitemap, :server?, :build?, :environment?, :data, :extensions, :root
+    def_delegators :@app, :config, :logger, :sitemap, :server?, :build?, :environment?, :environment, :data, :extensions, :root, :development?, :production?
 
     # Initialize a context with the current app and predefined locals and options hashes.
     #
@@ -84,6 +84,7 @@ module Middleman
         # Reset stored buffer, regardless of success
         restore_buffer(buf_was)
       end
+
       # Render the layout, with the contents of the block inside.
       concat_safe_content render_file(layout_file, @locs, @opts) { content }
     ensure
@@ -96,14 +97,14 @@ module Middleman
     #
     # @param [String, Symbol] name The partial to render.
     # @param [Hash] options
+    # @param [Proc] block A block will be evaluated to return internal contents.
     # @return [String]
-    Contract Any, Or[Symbol, String], Hash => String
+    Contract Any, Or[Symbol, String], Hash => String, Maybe[Proc] => String
     def render(_, name, options={}, &block)
       name = name.to_s
 
       partial_file = locate_partial(name, false) || locate_partial(name, true)
 
-      return '' unless partial_file
       raise ::Middleman::TemplateRenderer::TemplateNotFound, "Could not locate partial: #{name}" unless partial_file
 
       source_path = sitemap.file_to_path(partial_file)
@@ -126,30 +127,34 @@ module Middleman
     # @return [String]
     Contract String, Maybe[Bool] => Maybe[IsA['Middleman::SourceFile']]
     def locate_partial(partial_path, try_static=true)
-      return unless resource = sitemap.find_resource_by_destination_path(current_path)
-
-      # Look for partials relative to the current path
-      current_dir = resource.file_descriptor[:relative_path].dirname
-      non_root = partial_path.to_s.sub(/^\//, '')
-      relative_dir = current_dir + Pathname(non_root)
-
+      partial_file = nil
+      lookup_stack = []
+      non_root     = partial_path.to_s.sub(/^\//, '')
       non_root_no_underscore = non_root.sub(/^_/, '').sub(/\/_/, '/')
-      relative_dir_no_underscore = current_dir + Pathname(non_root_no_underscore)
 
-      partial_file = nil
+      if resource = current_resource
+        current_dir  = resource.file_descriptor[:relative_path].dirname
+        relative_dir = current_dir + Pathname(non_root)
+        relative_dir_no_underscore = current_dir + Pathname(non_root_no_underscore)
+      end
 
-      [
-        [relative_dir.to_s, { preferred_engine: resource.file_descriptor[:relative_path].extname[1..-1].to_sym }],
-        [non_root],
-        [non_root, { try_static: try_static }],
-        [relative_dir_no_underscore.to_s, { try_static: try_static }],
-        [non_root_no_underscore, { try_static: try_static }]
-      ].each do |args|
+      lookup_stack.push [relative_dir.to_s,
+                         { preferred_engine: resource.file_descriptor[:relative_path]
+                           .extname[1..-1].to_sym }] if relative_dir
+      lookup_stack.push [non_root]
+      lookup_stack.push [non_root,
+                         { try_static: try_static }]
+      lookup_stack.push [relative_dir_no_underscore.to_s,
+                         { try_static: try_static }] if relative_dir_no_underscore
+      lookup_stack.push [non_root_no_underscore,
+                         { try_static: try_static }]
+
+      lookup_stack.each do |args|
         partial_file = ::Middleman::TemplateRenderer.resolve_template(@app, *args)
         break if partial_file
       end
 
-      partial_file || nil
+      partial_file
     end
 
     def current_path
@@ -185,7 +190,7 @@ module Middleman
       # handles cases like `style.css.sass.erb`
       content = nil
 
-      while ::Tilt[path]
+      while ::Middleman::Util.tilt_class(path)
         begin
           opts[:template_body] = content if content
 

data/lib/middleman-core/template_renderer.rb

@@ -61,7 +61,7 @@ module Middleman
 
       # If we're specifically looking for a preferred engine
       if options.key?(:preferred_engine)
-        extension_class = ::Tilt[options[:preferred_engine]]
+        extension_class = ::Middleman::Util.tilt_class(options[:preferred_engine])
 
         # Get a list of extensions for a preferred engine
         preferred_engines += ::Tilt.mappings.select do |_, engines|
@@ -89,7 +89,7 @@ module Middleman
           app.files.find(:source, path_with_ext, globbing)
         end
 
-        found_template = file if file && (preferred_engine.nil? || ::Tilt[file[:full_path]])
+        found_template = file if file && (preferred_engine.nil? || ::Middleman::Util.tilt_class(file[:full_path].to_s))
         break if found_template
       end
 
@@ -133,20 +133,33 @@ module Middleman
       # Add extension helpers to context.
       @app.extensions.add_exposed_to_context(context)
 
+      locals.each do |k, _|
+        next unless context.respond_to?(k) && ![:current_path, :paginate, :page_articles, :blog_controller, :lang, :locale].include?(k.to_sym)
+
+        msg = "Template local `#{k}` tried to overwrite an existing context value. Please rename the key when passing to `locals`"
+
+        if @app.build?
+          throw msg
+        else
+          @app.logger.error(msg)
+        end
+      end
+
       content = ::Middleman::Util.instrument 'builder.output.resource.render-template', path: File.basename(path) do
-        _render_with_all_renderers(path, locs, context, opts, &block)
+        _render_with_all_renderers(path, locals, context, options, &block)
       end
 
       # If we need a layout and have a layout, use it
       layout_file = fetch_layout(engine, options)
       if layout_file
-        content = ::Middleman::Util.instrument 'builder.output.resource.render-layout', path: File.basename(layout_file[:relative_path].to_s) do
-          if layout_file = fetch_layout(engine, options)
-            layout_renderer = ::Middleman::FileRenderer.new(@app, layout_file[:relative_path].to_s)
+        content = if layout_file = fetch_layout(engine, options)
+          layout_renderer = ::Middleman::FileRenderer.new(@app, layout_file[:relative_path].to_s)
+
+          ::Middleman::Util.instrument 'builder.output.resource.render-layout', path: File.basename(layout_file[:relative_path].to_s) do
             layout_renderer.render(locals, options, context) { content }
-          else
-            content
           end
+        else
+          content
         end
       end
 
@@ -165,7 +178,7 @@ module Middleman
       # handles cases like `style.css.sass.erb`
       content = nil
 
-      while ::Tilt[path]
+      while ::Middleman::Util.tilt_class(path)
         begin
           opts[:template_body] = content if content
 

data/lib/middleman-core/util/binary.rb

@@ -47,14 +47,13 @@ module Middleman
     # @return [Boolean]
     Contract String => Bool
     def nonbinary_mime?(mime)
-      case
-      when mime.start_with?('text/')
+      if mime.start_with?('text/')
         true
-      when mime.include?('xml') && !mime.include?('officedocument')
+      elsif mime.include?('xml') && !mime.include?('officedocument')
         true
-      when mime.include?('json')
+      elsif mime.include?('json')
         true
-      when mime.include?('javascript')
+      elsif mime.include?('javascript')
         true
       else
         false

data/lib/middleman-core/util/data.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'pathname'
 require 'backports/2.1.0/array/to_h'
 require 'hashie'
+require 'memoist'
 
 require 'middleman-core/util/binary'
 require 'middleman-core/contracts'
@@ -29,13 +30,14 @@ module Middleman
       if obj.is_a? ::Array
         obj.map { |e| recursively_enhance(e) }
       elsif obj.is_a? ::Hash
-        ::Hashie::Mash.new(obj)
+        EnhancedHash.new(obj)
       else
         obj
       end
     end
 
     module Data
+      extend Memoist
       include Contracts
 
       module_function
@@ -55,20 +57,7 @@ module Middleman
           return [{}, nil]
         end
 
-        start_delims, stop_delims = frontmatter_delims
-                                    .values
-                                    .flatten(1)
-                                    .transpose
-                                    .map(&::Regexp.method(:union))
-
-        match = /
-          \A(?:[^\r\n]*coding:[^\r\n]*\r?\n)?
-          (?<start>#{start_delims})[ ]*\r?\n
-          (?<frontmatter>.*?)[ ]*\r?\n?
-          ^(?<stop>#{stop_delims})[ ]*\r?\n?
-          \r?\n?
-          (?<additional_content>.*)
-        /mx.match(content) || {}
+        match = build_regex(frontmatter_delims).match(content) || {}
 
         unless match[:frontmatter]
           case known_type
@@ -98,27 +87,53 @@ module Middleman
         end
       end
 
+      def build_regex(frontmatter_delims)
+        start_delims, stop_delims = frontmatter_delims
+                                    .values
+                                    .flatten(1)
+                                    .transpose
+                                    .map(&::Regexp.method(:union))
+
+        /
+          \A(?:[^\r\n]*coding:[^\r\n]*\r?\n)?
+          (?<start>#{start_delims})[ ]*\r?\n
+          (?<frontmatter>.*?)[ ]*\r?\n?
+          ^(?<stop>#{stop_delims})[ ]*\r?\n?
+          \r?\n?
+          (?<additional_content>.*)
+        /mx
+      end
+      memoize :build_regex
+
       # Parse YAML frontmatter out of a string
       # @param [String] content
       # @return [Hash]
-      Contract String, Pathname, Bool => Hash
+      Contract String, Pathname => Hash
       def parse_yaml(content, full_path)
-        symbolize_recursive(::YAML.load(content) || {})
+        c = ::Middleman::Util.instrument 'parse.yaml' do
+          ::YAML.load(content)
+        end
+        c ? symbolize_recursive(c) : {}
       rescue StandardError, ::Psych::SyntaxError => error
         warn "YAML Exception parsing #{full_path}: #{error.message}"
         {}
       end
+      memoize :parse_yaml
 
       # Parse JSON frontmatter out of a string
       # @param [String] content
       # @return [Hash]
       Contract String, Pathname => Hash
       def parse_json(content, full_path)
-        symbolize_recursive(::JSON.parse(content) || {})
+        c = ::Middleman::Util.instrument 'parse.json' do
+          ::JSON.parse(content)
+        end
+        c ? symbolize_recursive(c) : {}
       rescue StandardError => error
         warn "JSON Exception parsing #{full_path}: #{error.message}"
         {}
       end
+      memoize :parse_json
 
       def symbolize_recursive(value)
         case value