middleman-core 4.0.0.alpha.6 → 4.0.0.beta.1

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

@@ -22,7 +22,7 @@ module Middleman
           end
         end
 
-        Contract None => Any
+        Contract Any
         def before_configuration
           app.files.on_change(:source, &method(:update_files))
         end

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

@@ -7,12 +7,15 @@ module Middleman
       # Manages the list of proxy configurations and manipulates the sitemap
       # to include new resources based on those configurations
       class Proxies < Extension
+        # Expose `create_proxy` as `app.proxy`
+        expose_to_application proxy: :create_proxy
+
+        # Expose `create_proxy` to config as `proxy`
+        expose_to_config proxy: :create_proxy
+
         def initialize(app, config={}, &block)
           super
 
-          @app.add_to_config_context(:proxy, &method(:create_proxy))
-          @app.define_singleton_method(:proxy, &method(:create_proxy))
-
           @proxy_configs = Set.new
           @post_config = false
         end
@@ -71,10 +74,10 @@ module Middleman
           ProxyResource.new(app.sitemap, path, target).tap do |p|
             md = metadata.dup
             p.add_metadata(
-                             locals: md.delete(:locals) || {},
-                             page: md.delete(:data) || {},
-                             options: md
-                           )
+              locals: md.delete(:locals) || {},
+              page: md.delete(:data) || {},
+              options: md
+            )
           end
         end
       end
@@ -96,7 +99,7 @@ module Middleman
       # The resource for the page this page is proxied to. Throws an exception
       # if there is no resource.
       # @return [Sitemap::Resource]
-      Contract None => IsA['Middleman::Sitemap::Resource']
+      Contract IsA['Middleman::Sitemap::Resource']
       def target_resource
         resource = @store.find_resource_by_path(@target)
 
@@ -111,12 +114,12 @@ module Middleman
         resource
       end
 
-      Contract None => IsA['Middleman::SourceFile']
+      Contract IsA['Middleman::SourceFile']
       def source_file
         target_resource.source_file
       end
 
-      Contract None => Maybe[String]
+      Contract Maybe[String]
       def content_type
         mime_type = super
         return mime_type if mime_type

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

@@ -7,18 +7,19 @@ module Middleman
       # Manages the list of proxy configurations and manipulates the sitemap
       # to include new resources based on those configurations
       class Redirects < Extension
+        # Expose `create_redirect` to config as `redirect`
+        expose_to_config redirect: :create_redirect
+
         def initialize(app, config={}, &block)
           super
 
-          @app.add_to_config_context(:redirect, &method(:create_redirect))
-
           @redirects = {}
         end
 
         # Setup a redirect from a path to a target
         # @param [String] path
         # @param [Hash] opts The :to value gives a target path
-        Contract String, ({ to: Or[String, IsA['Middleman::Sitemap::Resource']] }), Proc => Any
+        Contract String, ({ to: Or[String, IsA['Middleman::Sitemap::Resource']] }), Maybe[Proc] => Any
         def create_redirect(path, opts={}, &block)
           opts[:template] = block if block_given?
 
@@ -44,7 +45,7 @@ module Middleman
       end
 
       class RedirectResource < ::Middleman::Sitemap::Resource
-        Contract None => Maybe[Proc]
+        Contract Maybe[Proc]
         attr_accessor :output
 
         def initialize(store, path, target)
@@ -53,7 +54,7 @@ module Middleman
           super(store, path)
         end
 
-        Contract None => Bool
+        Contract Bool
         def template?
           true
         end
@@ -63,7 +64,7 @@ module Middleman
           url = ::Middleman::Util.url_for(@store.app, @request_path,
                                           relative: false,
                                           find_resource: true
-          )
+                                         )
 
           if output
             output.call(path, url)
@@ -82,7 +83,7 @@ module Middleman
           end
         end
 
-        Contract None => Bool
+        Contract Bool
         def ignored?
           false
         end

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

@@ -4,13 +4,14 @@ module Middleman
   module Sitemap
     module Extensions
       class RequestEndpoints < Extension
+        # Expose `create_endpoint` to config as `endpoint`
+        expose_to_config endpoint: :create_endpoint
+
         # Manages the list of proxy configurations and manipulates the sitemap
         # to include new resources based on those configurations
         def initialize(app, config={}, &block)
           super
 
-          @app.add_to_config_context(:endpoint, &method(:create_endpoint))
-
           @endpoints = {}
         end
 
@@ -52,7 +53,7 @@ module Middleman
       end
 
       class EndpointResource < ::Middleman::Sitemap::Resource
-        Contract None => Maybe[Proc]
+        Contract Maybe[Proc]
         attr_accessor :output
 
         def initialize(store, path, request_path)
@@ -60,10 +61,10 @@ module Middleman
           @request_path = ::Middleman::Util.normalize_path(request_path)
         end
 
-        Contract None => String
+        Contract String
         attr_reader :request_path
 
-        Contract None => Bool
+        Contract Bool
         def template?
           true
         end
@@ -73,7 +74,7 @@ module Middleman
           return output.call if output
         end
 
-        Contract None => Bool
+        Contract Bool
         def ignored?
           false
         end

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

@@ -9,7 +9,9 @@ module Middleman
           tail = parts.pop
           is_index = (tail == @app.config[:index_file])
 
-          return nil if is_index && parts.length < 1
+          if parts.empty?
+            return is_index ? nil : @store.find_resource_by_path(@app.config[:index_file])
+          end
 
           test_expr = parts.join('\\/')
           # eponymous reverse-lookup

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

@@ -23,7 +23,7 @@ module Middleman
 
       # The on-disk source file for this resource, if there is one
       # @return [String]
-      Contract None => Maybe[IsA['Middleman::SourceFile']]
+      Contract Maybe[IsA['Middleman::SourceFile']]
       attr_reader :source_file
 
       # The path to use when requesting this resource. Normally it's
@@ -35,7 +35,7 @@ module Middleman
 
       # The metadata for this resource
       # @return [Hash]
-      Contract None => METADATA_HASH
+      Contract METADATA_HASH
       attr_reader :metadata
 
       # Initialize resource with parent store and URL
@@ -46,7 +46,7 @@ module Middleman
       def initialize(store, path, source_file=nil)
         @store       = store
         @app         = @store.app
-        @path        = path.gsub(' ', '%20') # handle spaces in filenames
+        @path        = path
 
         if source_file && source_file.is_a?(String)
           source_file = Pathname(source_file)
@@ -69,7 +69,7 @@ module Middleman
 
       # Whether this resource has a template file
       # @return [Boolean]
-      Contract None => Bool
+      Contract Bool
       def template?
         return false if source_file.nil?
         !::Tilt[source_file[:full_path].to_s].nil?
@@ -87,31 +87,30 @@ module Middleman
       end
 
       # Data about this resource, populated from frontmatter or extensions.
-      # @return [HashWithIndifferentAccess]
-      Contract None => IsA['Middleman::Util::HashWithIndifferentAccess']
+      # @return [IndifferentHash]
+      Contract IsA['Middleman::Util::IndifferentHash']
       def data
-        # TODO: Should this really be a HashWithIndifferentAccess?
         ::Middleman::Util.recursively_enhance(metadata[:page])
       end
 
       # Options about how this resource is rendered, such as its :layout,
       # :renderer_options, and whether or not to use :directory_indexes.
       # @return [Hash]
-      Contract None => Hash
+      Contract Hash
       def options
         metadata[:options]
       end
 
       # Local variable mappings that are used when rendering the template for this resource.
       # @return [Hash]
-      Contract None => Hash
+      Contract Hash
       def locals
         metadata[:locals]
       end
 
       # Extension of the path (i.e. '.js')
       # @return [String]
-      Contract None => String
+      Contract String
       def ext
         File.extname(path)
       end
@@ -141,7 +140,7 @@ module Middleman
       # A path without the directory index - so foo/index.html becomes
       # just foo. Best for linking.
       # @return [String]
-      Contract None => String
+      Contract String
       def url
         url_path = destination_path
         if @app.config[:strip_index_file]
@@ -154,7 +153,7 @@ module Middleman
       # Whether the source file is binary.
       #
       # @return [Boolean]
-      Contract None => Bool
+      Contract Bool
       def binary?
         !source_file.nil? && ::Middleman::Util.binary?(source_file[:full_path].to_s)
       end
@@ -162,14 +161,14 @@ module Middleman
       # Ignore a resource directly, without going through the whole
       # ignore filter stuff.
       # @return [void]
-      Contract None => Any
+      Contract Any
       def ignore!
         @ignored = true
       end
 
       # Whether the Resource is ignored
       # @return [Boolean]
-      Contract None => Bool
+      Contract Bool
       def ignored?
         return true if @ignored
         # Ignore based on the source path (without template extensions)
@@ -184,7 +183,7 @@ module Middleman
 
       # The preferred MIME content type for this resource based on extension or metadata
       # @return [String] MIME type for this resource
-      Contract None => Maybe[String]
+      Contract Maybe[String]
       def content_type
         options[:content_type] || ::Rack::Mime.mime_type(ext, nil)
       end

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

@@ -74,12 +74,13 @@ module Middleman
       # @param [Symbol] name Name of the manipulator for debugging
       # @param [#manipulate_resource_list] manipulator Resource list manipulator
       # @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] => Any
-      def register_resource_list_manipulator(name, manipulator, priority=50)
+      Contract Symbol, RespondTo['manipulate_resource_list'], Maybe[Num], 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
-        @resource_list_manipulators << [name, manipulator, priority]
+        @resource_list_manipulators << [name, manipulator, priority, custom_name]
         # The index trick is used so that the sort is stable - manipulators with the same priority
         # will always be ordered in the same order as they were registered.
         n = 0
@@ -177,8 +178,8 @@ module Middleman
 
           @app.logger.debug '== Rebuilding resource list'
 
-          @resources = @resource_list_manipulators.reduce([]) do |result, (_, manipulator, _)|
-            newres = manipulator.manipulate_resource_list(result)
+          @resources = @resource_list_manipulators.reduce([]) do |result, (_, manipulator, _, custom_name)|
+            newres = manipulator.send(custom_name || :manipulate_resource_list, result)
 
             # Reset lookup cache
             reset_lookup_cache!

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

@@ -17,15 +17,15 @@ module Middleman
     def_delegator :app, :logger
 
     # The type this watcher is representing
-    Contract None => Symbol
+    Contract Symbol
     attr_reader :type
 
     # The directory that is being watched
-    Contract None => Pathname
+    Contract Pathname
     attr_reader :directory
 
     # Options for configuring the watcher
-    Contract None => Hash
+    Contract Hash
     attr_reader :options
 
     # Construct a new SourceWatcher
@@ -47,6 +47,7 @@ module Middleman
 
       @validator = options.fetch(:validator, proc { true })
       @ignored = options.fetch(:ignored, proc { false })
+      @only = Array(options.fetch(:only, []))
 
       @disable_watcher = app.build? || @parent.options.fetch(:disable_watcher, false)
       @force_polling = @parent.options.fetch(:force_polling, false)
@@ -79,7 +80,7 @@ module Middleman
     # Stop watching.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def unwatch
       stop_listener!
     end
@@ -87,7 +88,7 @@ module Middleman
     # All the known files in this watcher.
     #
     # @return [Array<Middleman::SourceFile>]
-    Contract None => ArrayOf[IsA['Middleman::SourceFile']]
+    Contract ArrayOf[IsA['Middleman::SourceFile']]
     def files
       @files.values
     end
@@ -123,21 +124,27 @@ module Middleman
     # Start the `listen` gem Listener.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def listen!
       return if @disable_watcher || @listener || @waiting_for_existence
 
-      config = { force_polling: @force_polling }
+      config = {
+        force_polling: @force_polling,
+        wait_for_delay: 0.5
+      }
+
       config[:latency] = @latency if @latency
 
       @listener = ::Listen.to(@directory.to_s, config, &method(:on_listener_change))
       @listener.start
+
+      @listener.only(@only) unless @only.empty?
     end
 
     # Stop the listener.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def stop_listener!
       return unless @listener
 
@@ -148,7 +155,7 @@ module Middleman
     # Manually trigger update events.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def poll_once!
       removed = @files.keys
 
@@ -247,10 +254,9 @@ module Middleman
       @extensionless_files.delete(strip_extensions(f[:full_path]))
     end
 
+    Contract Pathname => Pathname
     def strip_extensions(p)
-      while ::Tilt[p.to_s] || p.extname === '.html'
-        p = p.sub_ext('')
-      end
+      p = p.sub_ext('') while ::Tilt[p.to_s] || p.extname == '.html'
       Pathname(p.to_s + '.*')
     end
 
@@ -260,9 +266,13 @@ module Middleman
     # @return [Boolean]
     Contract IsA['Middleman::SourceFile'] => Bool
     def valid?(file)
-      @validator.call(file) &&
-        !globally_ignored?(file) &&
+      return false unless @validator.call(file) && !globally_ignored?(file)
+
+      if @only.empty?
         !@ignored.call(file)
+      else
+        @only.any? { |reg| reg.match(file[:relative_path].to_s) }
+      end
     end
 
     # Convert a path to a file resprentation.
@@ -273,8 +283,11 @@ module Middleman
     def path_to_source_file(path)
       types = Set.new([@type])
 
-      ::Middleman::SourceFile.new(
-          path.relative_path_from(@directory), path, @directory, types)
+      relative_path   = path.relative_path_from(@directory)
+      destination_dir = @options.fetch(:destination_dir, false)
+      relative_path   = File.join(destination_dir, relative_path) if destination_dir
+
+      ::Middleman::SourceFile.new(Pathname(relative_path), path, @directory, types)
     end
 
     # Notify callbacks for a file given an array of callbacks

data/lib/middleman-core/sources.rb

@@ -14,15 +14,17 @@ module Middleman
     extend Forwardable
     include Contracts
 
+    Matcher = Or[Regexp, RespondTo[:call]]
+
     # A reference to the current app.
-    Contract None => IsA['Middleman::Application']
+    Contract IsA['Middleman::Application']
     attr_reader :app
 
     # Duck-typed definition of a valid source watcher
     HANDLER = RespondTo[:on_change]
 
     # Config
-    Contract None => Hash
+    Contract Hash
     attr_reader :options
 
     # Reference to the global logger.
@@ -125,7 +127,7 @@ module Middleman
     end
 
     # A list of registered watchers
-    Contract None => ArrayOf[HANDLER]
+    Contract ArrayOf[HANDLER]
     def watchers
       @sorted_watchers
     end
@@ -155,7 +157,7 @@ module Middleman
     # Get all files for this collection of watchers.
     #
     # @return [Array<Middleman::SourceFile>]
-    Contract None => ArrayOf[SourceFile]
+    Contract ArrayOf[SourceFile]
     def files
       watchers.flat_map(&:files).uniq { |f| f[:relative_path] }
     end
@@ -204,7 +206,7 @@ module Middleman
     # Manually poll all watchers for new content.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def find_new_files!
       return unless @update_count != @last_update_count
 
@@ -215,7 +217,7 @@ module Middleman
     # Start up all listeners.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def start!
       watchers.each(&:listen!)
       @running = true
@@ -224,7 +226,7 @@ module Middleman
     # Stop the watchers.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def stop!
       watchers.each(&:stop_listener!)
       @running = false
@@ -246,28 +248,24 @@ module Middleman
     # Backwards compatible change handler.
     #
     # @param [nil,Regexp] matcher A Regexp to match the change path against
-    # Contract Maybe[Regexp] => Any
+    Contract Maybe[Matcher] => Any
     def changed(matcher=nil, &block)
       on_change :source do |updated, _removed|
-        updated.select { |f|
-          matcher.nil? ? true : matches?(matcher, f)
-        }.each do |f|
-          block.call(f[:relative_path])
-        end
+        updated
+          .select { |f| matcher.nil? ? true : matches?(matcher, f) }
+          .each { |f| block.call(f[:relative_path]) }
       end
     end
 
     # Backwards compatible delete handler.
     #
     # @param [nil,Regexp] matcher A Regexp to match the change path against
-    # Contract Maybe[Regexp] => Any
+    Contract Maybe[Matcher] => Any
     def deleted(matcher=nil, &block)
       on_change :source do |_updated, removed|
-        removed.select { |f|
-          matcher.nil? ? true : matches?(matcher, f)
-        }.each do |f|
-          block.call(f[:relative_path])
-        end
+        removed
+          .select { |f| matcher.nil? ? true : matches?(matcher, f) }
+          .each { |f| block.call(f[:relative_path]) }
       end
     end
 
@@ -287,7 +285,7 @@ module Middleman
     # @param [Regexp, #call] validator The match validator.
     # @param [Middleman::SourceFile] file The file to check.
     # @return [Boolean]
-    Contract Or[Regexp, RespondTo[:call]], SourceFile => Bool
+    Contract Matcher, SourceFile => Bool
     def matches?(validator, file)
       path = file[:relative_path]
       if validator.is_a? Regexp
@@ -300,7 +298,7 @@ module Middleman
     # Increment the internal counter for changes.
     #
     # @return [void]
-    Contract None => Any
+    Contract Any
     def bump_count
       @update_count += 1
     end

data/lib/middleman-core/step_definitions/builder_steps.rb

@@ -69,7 +69,7 @@ end
 
 # Provide this Aruba overload in case we're matching something with quotes in it
 Then /^the file "([^"]*)" should contain '([^']*)'$/ do |file, partial_content|
-  check_file_content(file, partial_content, true)
+  check_file_content(file, Regexp.new(Regexp.escape(partial_content)), true)
 end
 
 And /the file "(.*)" should be gzipped/ do |file|

data/lib/middleman-core/step_definitions/server_steps.rb

@@ -70,7 +70,7 @@ end
 
 When /^I go to "([^\"]*)"$/ do |url|
   in_current_dir do
-    @last_response = @browser.get(URI.escape(url))
+    @last_response = @browser.get(URI.encode(url))
   end
 end
 
@@ -78,8 +78,8 @@ Then /^going to "([^\"]*)" should not raise an exception$/ do |url|
   in_current_dir do
     last_response = nil
     expect {
-      last_response = @browser.get(URI.escape(url))
-    }.to_not raise_error
+      last_response = @browser.get(URI.encode(url))
+    }.to_not raise_exception
     @last_response = last_response
   end
 end

data/lib/middleman-core/template_context.rb

@@ -100,7 +100,7 @@ module Middleman
     def render(_, name, options={}, &block)
       name = name.to_s
 
-      partial_file = locate_partial(name)
+      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
@@ -123,8 +123,8 @@ module Middleman
     # @api private
     # @param [String] partial_path
     # @return [String]
-    Contract String => Maybe[IsA['Middleman::SourceFile']]
-    def locate_partial(partial_path)
+    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
@@ -140,9 +140,9 @@ module Middleman
       [
         [relative_dir.to_s, { preferred_engine: resource.source_file[:relative_path].extname[1..-1].to_sym }],
         [non_root],
-        [non_root, { try_static: true }],
-        [relative_dir_no_underscore.to_s, { try_static: true }],
-        [non_root_no_underscore, { try_static: true }]
+        [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|
         partial_file = ::Middleman::TemplateRenderer.resolve_template(@app, *args)
         break if partial_file
@@ -161,11 +161,12 @@ module Middleman
     # @param [Hash] opts Template options.
     # @param [Proc] block A block will be evaluated to return internal contents.
     # @return [String] The resulting content string.
-    Contract IsA['Middleman::SourceFile'], Hash, Hash, Proc => String
+    Contract IsA['Middleman::SourceFile'], Hash, Hash, Maybe[Proc] => String
     def render_file(file, locs, opts, &block)
       _render_with_all_renderers(file[:relative_path].to_s, locs, self, opts, &block)
     end
 
+    Contract String, Hash, Any, Hash, Maybe[Proc] => String
     def _render_with_all_renderers(path, locs, context, opts, &block)
       # Keep rendering template until we've used up all extensions. This
       # handles cases like `style.css.sass.erb`

data/lib/middleman-core/template_renderer.rb

@@ -58,8 +58,8 @@ module Middleman
       # Sandboxed class for template eval
       context = @app.template_context_class.new(@app, locals, options)
 
-      # TODO: Only for HAML files
-      context.init_haml_helpers if context.respond_to?(:init_haml_helpers)
+      # Add extension helpers to context.
+      @app.extensions.add_exposed_to_context(context)
 
       content = _render_with_all_renderers(path, locs, context, opts, &block)