middleman-core 4.5.0 → 5.0.0.rc.1

data/lib/middleman-core/filter.rb

@@ -0,0 +1,56 @@
+require 'hamster'
+require 'middleman-core/contracts'
+require 'middleman-core/dependencies/vertices/vertex'
+
+module Middleman
+  class Filter
+    include Contracts
+    include Comparable
+
+    Contract Symbol
+    attr_reader :filter_name
+
+    Contract Maybe[Symbol]
+    attr_reader :after_filter
+
+    def <=>(other)
+      shift = if other.after_filter.nil?
+                0
+              elsif filter_name == other.after_filter
+                1
+              else
+                -1
+              end
+
+      [0, object_id] <=> [shift, other.object_id]
+    end
+
+    Contract Symbol, Hash => Any
+    def initialize(filter_name, options_hash = ::Middleman::EMPTY_HASH)
+      @filter_name = filter_name
+
+      @options = options_hash
+      @after_filter = @options.fetch(:after_filter, nil)
+    end
+
+    Contract String => [String, ImmutableSetOf[::Middleman::Dependencies::Vertex]]
+    def execute_filter(_body)
+      raise NotImplementedError
+    end
+  end
+
+  class ProcFilter < Filter
+    Contract Symbol, RespondTo[:call], Hash => Any
+    def initialize(filter_name, callable, options_hash = ::Middleman::EMPTY_HASH)
+      super(filter_name, options_hash)
+
+      @callable = callable
+    end
+
+    Contract String => [String, ImmutableSetOf[::Middleman::Dependencies::Vertex]]
+    def execute_filter(body)
+      result = @callable.call(body)
+      result.is_a?(Array) ? result : [result, ::Hamster::Set.empty]
+    end
+  end
+end

data/lib/middleman-core/inline_url_filter.rb

@@ -0,0 +1,76 @@
+require 'hamster'
+require 'middleman-core/util'
+require 'middleman-core/filter'
+require 'middleman-core/contracts'
+require 'middleman-core/dependencies/vertices/vertex'
+require 'middleman-core/dependencies/vertices/file_vertex'
+
+module Middleman
+  class InlineURLRewriter < Filter
+    include Contracts
+
+    Contract Symbol, IsA['::Middleman::Application'], IsA['::Middleman::Sitemap::Resource'], Hash => Any
+    def initialize(filter_name, app, resource, options_hash = ::Middleman::EMPTY_HASH)
+      super(filter_name, options_hash)
+
+      @app = app
+      @resource = resource
+    end
+
+    Contract String, Pathname => Maybe[IsA['::Middleman::Sitemap::Resource']]
+    def target_resource(asset_path, dirpath)
+      uri = ::Middleman::Util.parse_uri(asset_path)
+      relative_path = !uri.path.start_with?('/')
+
+      full_asset_path = if relative_path
+                          dirpath.join(asset_path).to_s
+                        else
+                          asset_path
+                        end
+
+      @app.sitemap.by_destination_path(full_asset_path) || @app.sitemap.by_path(full_asset_path)
+    end
+
+    Contract String => [String, ImmutableSetOf[::Middleman::Dependencies::Vertex]]
+    def execute_filter(body)
+      path = "/#{@resource.destination_path}"
+      dirpath = ::Pathname.new(File.dirname(path))
+
+      ::Middleman::Util.instrument 'inline_url_filter', path: path do
+        vertices = ::Hamster::Set.empty
+
+        new_content = ::Middleman::Util.rewrite_paths(body, path, @options.fetch(:url_extensions), @app) do |asset_path|
+          uri = ::Middleman::Util.parse_uri(asset_path)
+
+          relative_path = uri.host.nil?
+          full_asset_path = if relative_path
+                              dirpath.join(asset_path).to_s
+                            else
+                              asset_path
+                            end
+
+          exts = @options.fetch(:url_extensions)
+          next unless exts.include?(::File.extname(asset_path))
+
+          next if @options.fetch(:ignore).any? { |r| ::Middleman::Util.should_ignore?(r, full_asset_path) }
+
+          result = @options.fetch(:proc).call(asset_path, dirpath, path)
+
+          if result
+            if @options.fetch(:create_dependencies, false)
+              vertices <<= ::Middleman::Dependencies::FileVertex.from_resource(
+                target_resource(asset_path, dirpath)
+              )
+            end
+
+            asset_path = result
+          end
+
+          asset_path
+        end
+
+        [new_content, vertices]
+      end
+    end
+  end
+end

data/lib/middleman-core/load_paths.rb

@@ -5,7 +5,6 @@ module Middleman
   class << self
     def setup_load_paths
       @_is_setup ||= begin
-
         # Only look for config.rb if MM_ROOT isn't set
         if !ENV['MM_ROOT'] && (found_path = findup('config.rb'))
           ENV['MM_ROOT'] = found_path
@@ -22,27 +21,27 @@ module Middleman
 
     # Set BUNDLE_GEMFILE and run Bundler setup. Raises an exception if there is no Gemfile
     def setup_bundler
-      if found_gemfile_root = findup('Gemfile', ENV['MM_ROOT'])
-        ENV['BUNDLE_GEMFILE'] ||= File.join(found_gemfile_root, 'Gemfile')
-      end
+      found_gemfile_root = findup('Gemfile', ENV['MM_ROOT'])
 
-      unless File.exist?(ENV['BUNDLE_GEMFILE'])
-        ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../../Gemfile', __FILE__)
-      end
+      ENV['BUNDLE_GEMFILE'] ||= File.join(found_gemfile_root, 'Gemfile') if found_gemfile_root
 
-      if File.exist?(ENV['BUNDLE_GEMFILE'])
-        require 'bundler/setup'
-        Bundler.require
-      else
-        raise "Couldn't find your Gemfile. Middleman projects require a Gemfile for specifying dependencies."
-      end
+      ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../Gemfile', __dir__) unless File.exist?(ENV['BUNDLE_GEMFILE'])
+
+      raise "Couldn't find your Gemfile. Middleman projects require a Gemfile for specifying dependencies." unless File.exist?(ENV['BUNDLE_GEMFILE'])
+
+      require 'bundler/setup'
+      Bundler.require(
+        :default,
+        (ENV['MM_ENV'] || ENV['RACK_ENV'] || 'development').to_sym
+      )
     end
 
     # Recursive method to find a file in parent directories
-    def findup(filename, cwd=Dir.pwd)
+    def findup(filename, cwd = Dir.pwd)
       cwd = Pathname(cwd)
       return cwd.to_s if (cwd + filename).exist?
       return false if cwd.root?
+
       findup(filename, cwd.parent)
     end
   end

data/lib/middleman-core/logger.rb

@@ -1,31 +1,23 @@
 # Use the Ruby/Rails logger
-require 'active_support/notifications'
-require 'active_support/logger'
-require 'thread'
-
 module Middleman
   # The Middleman Logger
-  class Logger < ActiveSupport::Logger
+  class Logger < ::ActiveSupport::Logger
     def self.singleton(*args)
-      if !@_logger || !args || !args.empty?
-        if args.length == 1 && (args.first.is_a?(::String) || args.first.respond_to?(:write))
-          args = [0, false, args.first]
-        end
+      if !@_logger || !args.empty?
+        args = [0, false, args.first] if args.length == 1 && (args.first.is_a?(::String) || args.first.respond_to?(:write))
         @_logger = new(*args)
       end
 
       @_logger
     end
 
-    def initialize(log_level=1, is_instrumenting=false, target=$stdout)
+    def initialize(log_level = 1, is_instrumenting = false, target = $stdout)
       super(target)
 
       self.level = log_level
       @instrumenting = is_instrumenting
 
-      if @instrumenting != false
-        ::ActiveSupport::Notifications.subscribe(/\.middleman$/, self)
-      end
+      ::ActiveSupport::Notifications.subscribe(/\.middleman$/, self) if @instrumenting != false
 
       @mutex = Mutex.new
     end
@@ -41,6 +33,7 @@ module Middleman
 
       evt = ::ActiveSupport::Notifications::Event.new(message, *args)
       return unless evt.duration > 30
+
       info "== Instrument (#{evt.name.sub(/.middleman$/, '')}): #{evt.duration}ms\n#{args.last}"
     end
   end

data/lib/middleman-core/meta_pages/sitemap_resource.rb

@@ -1,6 +1,4 @@
 require 'padrino-helpers'
-require 'padrino-helpers/output_helpers'
-require 'padrino-helpers/tag_helpers'
 
 module Middleman
   module MetaPages

data/lib/middleman-core/meta_pages/sitemap_tree.rb

@@ -59,7 +59,7 @@ module Middleman
 
         if path_parts.size == 1
           sitemap_class = SitemapResource
-          # Allow special sitemap resources to use custom metadata view calsses
+          # Allow special sitemap resources to use custom metadata view classes
           sitemap_class = resource.meta_pages_class if resource.respond_to? :meta_pages_class
 
           @children[first_part] = sitemap_class.new(resource)

data/lib/middleman-core/meta_pages.rb

@@ -46,7 +46,7 @@ module Middleman
 
       # Inspect the sitemap
       def sitemap(_)
-        resources = @middleman.sitemap.resources(true)
+        resources = @middleman.sitemap.with_ignored
 
         sitemap_tree = SitemapTree.new
 
@@ -93,7 +93,7 @@ module Middleman
       private
 
       # Render a template with the given name and locals
-      def template(template_name, locals={})
+      def template(template_name, locals = {})
         template_path = File.join(File.dirname(__FILE__), 'meta_pages', 'templates', template_name)
         content = Tilt.new(template_path).render(::Object.new, locals)
         response(content)

data/lib/middleman-core/preview_server/checks.rb

@@ -34,7 +34,11 @@ module Middleman
           return if resolver.ips_for(information.server_name).include? information.bind_address
 
           information.valid = false
-          information.reason = format('Server name "%s" does not resolve to bind address "%s"', information.server_name, information.bind_address)
+          information.reason = format(
+            'Server name "%<name>s" does not resolve to bind address "%<addr>s"',
+            name: information.server_name,
+            addr: information.bind_address
+          )
         end
       end
 
@@ -46,10 +50,14 @@ module Middleman
         # @param [Information] information
         #   The information to be validated
         def validate(information)
-          return if information.bind_address.blank? || information.local_network_interfaces.include?(information.bind_address.to_s) || %w(0.0.0.0 ::).any? { |b| information.bind_address == b } || IPAddr.new('127.0.0.0/8').include?(information.bind_address.to_s)
+          return if information.bind_address.blank? || information.local_network_interfaces.include?(information.bind_address.to_s) || %w[0.0.0.0 ::].any? { |b| information.bind_address == b } || IPAddr.new('127.0.0.0/8').include?(information.bind_address.to_s)
 
           information.valid = false
-          information.reason = format('Bind address "%s" is not available on your system. Please use one of %s', information.bind_address, information.local_network_interfaces.map { |i| %("#{i}") }.join(', '))
+          information.reason = format(
+            'Bind address "%<bad_addr>s" is not available on your system. Please use one of %<good_addrs>s',
+            bad_addr: information.bind_address,
+            good_addrs: information.local_network_interfaces.map { |i| %("#{i}") }.join(', ')
+          )
         end
       end
 
@@ -61,7 +69,10 @@ module Middleman
           return unless information.bind_address.blank?
 
           information.valid = false
-          information.reason = format('Server name "%s" does not resolve to an ip address', information.server_name)
+          information.reason = format(
+            'Server name "%<name>s" does not resolve to an ip address',
+            name: information.server_name
+          )
         end
       end
 

data/lib/middleman-core/preview_server/information.rb

@@ -1,5 +1,4 @@
 require 'ipaddr'
-require 'active_support/core_ext/object/blank'
 require 'middleman-core/preview_server/checks'
 require 'middleman-core/preview_server/server_hostname'
 require 'middleman-core/preview_server/server_ip_address'
@@ -27,10 +26,10 @@ module Middleman
       #
       # @param [Integer] port
       #   The port to listen on
-      def initialize(opts={})
-        @bind_address = ServerIpAddress.new(opts[:bind_address])
-        @server_name  = ServerHostname.new(opts[:server_name])
-        @port         = opts[:port]
+      def initialize(options_hash = ::Middleman::EMPTY_HASH)
+        @bind_address = ServerIpAddress.new(options_hash[:bind_address])
+        @server_name  = ServerHostname.new(options_hash[:server_name])
+        @port         = options_hash[:port]
         @valid        = true
 
         @site_addresses = []
@@ -56,7 +55,7 @@ module Middleman
       end
 
       def resolve_me(*)
-        fail NoMethodError
+        raise NoMethodError
       end
 
       # Get network information
@@ -100,8 +99,8 @@ module Middleman
         after_init
       end
 
-      def self.matches?(opts={})
-        opts[:bind_address].blank? && opts[:server_name].blank?
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        options_hash[:bind_address].blank? && options_hash[:server_name].blank?
       end
 
       # Resolve ips
@@ -116,7 +115,7 @@ module Middleman
           @site_addresses << hostname
 
           network_interface = ServerIpAddress.new((local_network_interfaces & hostname_ips).first)
-        elsif RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+        elsif /mswin|mingw|cygwin/.match?(RbConfig::CONFIG['host_os'])
           @server_name = hostname
           @site_addresses << hostname
         elsif !resolved_name.blank?
@@ -146,8 +145,8 @@ module Middleman
     # This is used if bind address is 0.0.0.0, the server name needs to be
     # blank
     class AllIpv4Interfaces < AllInterfaces
-      def self.matches?(opts={})
-        opts[:bind_address] == '0.0.0.0' && opts[:server_name].blank?
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        options_hash[:bind_address] == '0.0.0.0' && options_hash[:server_name].blank?
       end
 
       # Use only ipv4 interfaces
@@ -164,8 +163,8 @@ module Middleman
 
     # This is used if bind address is ::, the server name needs to be blank
     class AllIpv6Interfaces < AllInterfaces
-      def self.matches?(opts={})
-        opts[:bind_address] == '::' && opts[:server_name].blank?
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        options_hash[:bind_address] == '::' && options_hash[:server_name].blank?
       end
 
       # Use only ipv6 interfaces
@@ -189,8 +188,8 @@ module Middleman
         @site_addresses << bind_address
       end
 
-      def self.matches?(opts={})
-        !opts[:bind_address].blank? && opts[:server_name].blank?
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        !options_hash[:bind_address].blank? && options_hash[:server_name].blank?
       end
 
       # Resolv
@@ -222,8 +221,8 @@ module Middleman
         self
       end
 
-      def self.matches?(opts={})
-        opts[:bind_address].blank? && !opts[:server_name].blank?
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        options_hash[:bind_address].blank? && !options_hash[:server_name].blank?
       end
     end
 
@@ -240,8 +239,8 @@ module Middleman
         @checks << Checks::ServerNameResolvesToBindAddress.new
       end
 
-      def self.matches?(opts={})
-        !opts[:bind_address].blank? && !opts[:server_name].blank? && !%w(:: 0.0.0.0).include?(opts[:bind_address])
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        !options_hash[:bind_address].blank? && !options_hash[:server_name].blank? && !%w[:: 0.0.0.0].include?(options_hash[:bind_address])
       end
 
       def resolve_me(*); end
@@ -250,7 +249,7 @@ module Middleman
     # If the server name is either an ipv4 or ipv6 address, e.g. 127.0.0.1 or
     # ::1, use this one
     class ServerNameIsIpInformation < BasicInformation
-      def initialize(opts={})
+      def initialize(_options_hash = ::Middleman::EMPTY_HASH)
         super
 
         ip = ServerIpAddress.new(server_name.to_s)
@@ -261,11 +260,11 @@ module Middleman
 
       def resolve_me(*); end
 
-      def self.matches?(opts={})
-        ip = IPAddr.new(opts[:server_name])
+      def self.matches?(options_hash = ::Middleman::EMPTY_HASH)
+        ip = IPAddr.new(options_hash[:server_name])
 
         ip.ipv4? || ip.ipv6?
-      rescue
+      rescue StandardError
         false
       end
     end

data/lib/middleman-core/preview_server/network_interface_inventory.rb

@@ -25,7 +25,7 @@ module Middleman
         end
 
         def self.match?(type)
-          :ipv4 == type
+          type == :ipv4
         end
       end
 
@@ -36,7 +36,7 @@ module Middleman
         end
 
         def self.match?(type)
-          :ipv6 == type
+          type == :ipv6
         end
       end
 
@@ -57,7 +57,7 @@ module Middleman
       #
       # @param [Symbol] type
       #   The type of interface which should be returned
-      def network_interfaces(type=:all)
+      def network_interfaces(type = :all)
         types.find { |t| t.match? type.to_sym }.new.network_interfaces
       end
     end

data/lib/middleman-core/preview_server/server_information.rb

@@ -22,11 +22,11 @@ module Middleman
 
       attr_writer :https
 
-      def initialize(opts={})
-        @resolver     = opts.fetch(:resolver, DnsResolver.new)
-        @validator    = opts.fetch(:validator, ServerInformationValidator.new)
-        @network_interface_inventory = opts.fetch(:network_interface_inventory, NetworkInterfaceInventory.new)
-        @tcp_port_prober = opts.fetch(:tcp_port_prober, TcpPortProber.new)
+      def initialize(options_hash = ::Middleman::EMPTY_HASH)
+        @resolver     = options_hash.fetch(:resolver, DnsResolver.new)
+        @validator    = options_hash.fetch(:validator, ServerInformationValidator.new)
+        @network_interface_inventory = options_hash.fetch(:network_interface_inventory, NetworkInterfaceInventory.new)
+        @tcp_port_prober = options_hash.fetch(:tcp_port_prober, TcpPortProber.new)
 
         @informations = []
         @informations << AllInterfaces

data/lib/middleman-core/preview_server/server_information_callback_proxy.rb

@@ -7,7 +7,7 @@ module Middleman
     # * server name
     # * site_addresses
     #
-    # All information is "dupped" and the callback is not meant to be used to
+    # All information is "duped" and the callback is not meant to be used to
     # modify these information.
     class ServerInformationCallbackProxy
       attr_reader :server_name, :port, :site_addresses, :listeners

data/lib/middleman-core/preview_server/server_ip_address.rb

@@ -32,14 +32,23 @@ module Middleman
       end
 
       def to_browser
-        format('[%s]', to_s)
+        format('[%<addr>s]', addr: to_s)
       end
 
-      def self.match?(str)
-        str = str.to_s.sub(/%.*$/, '')
-        IPAddr.new(str).ipv6?
-      rescue IPAddr::InvalidAddressError, IPAddr::AddressFamilyError
-        false
+      if RUBY_VERSION < '2'
+        def self.match?(str)
+          str = str.to_s.sub(/%.*$/, '')
+          IPAddr.new(str).ipv6?
+        rescue StandardError
+          false
+        end
+      else
+        def self.match?(str)
+          str = str.to_s.sub(/%.*$/, '')
+          IPAddr.new(str).ipv6?
+        rescue IPAddr::InvalidAddressError, IPAddr::AddressFamilyError
+          false
+        end
       end
     end
   end

data/lib/middleman-core/preview_server/server_url.rb

@@ -10,11 +10,11 @@ module Middleman
 
       public
 
-      def initialize(opts={})
-        @hosts = opts.fetch(:hosts)
-        @port  = opts.fetch(:port)
-        @https = opts.fetch(:https, false)
-        @format_output = opts.fetch(:format_output, true)
+      def initialize(options_hash = ::Middleman::EMPTY_HASH)
+        @hosts = options_hash.fetch(:hosts)
+        @port  = options_hash.fetch(:port)
+        @https = options_hash.fetch(:https, false)
+        @format_output = options_hash.fetch(:format_output, true)
       end
 
       # Return bind addresses
@@ -23,9 +23,9 @@ module Middleman
       #   List of bind addresses of format host:port
       def to_bind_addresses
         if format_output
-          hosts.map { |l| format('"%s:%s"', l.to_s, port) }
+          hosts.map { |l| format('"%<host>s:%<port>s"', host: l.to_s, port: port) }
         else
-          hosts.map { |l| format('%s:%s', l.to_s, port) }
+          hosts.map { |l| format('%<host>s:%<port>s', host: l.to_s, port: port) }
         end
       end
 
@@ -35,9 +35,23 @@ module Middleman
       #   List of urls of format http://host:port
       def to_urls
         if format_output
-          hosts.map { |l| format('"%s://%s:%s"', https? ? 'https' : 'http', l.to_browser, port) }
+          hosts.map do |l|
+            format(
+              '"%<protocol>s://%<host>s:%<port>s"',
+              protocol: https? ? 'https' : 'http',
+              host: l.to_browser,
+              port: port
+            )
+          end
         else
-          hosts.map { |l| format('%s://%s:%s', https? ? 'https' : 'http', l.to_browser, port) }
+          hosts.map do |l|
+            format(
+              '%<protocol>s://%<host>s:%<port>s',
+              protocol: https? ? 'https' : 'http',
+              host: l.to_browser,
+              port: port
+            )
+          end
         end
       end
 
@@ -47,9 +61,23 @@ module Middleman
       #   List of urls of format http://host:port/__middleman
       def to_config_urls
         if format_output
-          hosts.map { |l| format('"%s://%s:%s/__middleman"', https? ? 'https' : 'http', l.to_browser, port) }
+          hosts.map do |l|
+            format(
+              '"%<protocol>s://%<host>s:%<port>s/__middleman"',
+              protocol: https? ? 'https' : 'http',
+              host: l.to_browser,
+              port: port
+            )
+          end
         else
-          hosts.map { |l| format('%s://%s:%s/__middleman', https? ? 'https' : 'http', l.to_browser, port) }
+          hosts.map do |l|
+            format(
+              '%<protocol>s://%<host>s:%<port>s/__middleman',
+              protocol: https? ? 'https' : 'http',
+              host: l.to_browser,
+              port: port
+            )
+          end
         end
       end
 

data/lib/middleman-core/preview_server/tcp_port_prober.rb

@@ -17,7 +17,7 @@ module Middleman
         server.close
 
         try_port
-      rescue
+      rescue StandardError
         server = TCPServer.open(0)
         port = server.addr[1]
         server.close