middleman-core 4.6.0 → 5.0.0.rc.1

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_hostname.rb

@@ -19,7 +19,9 @@ module Middleman
         end
 
         def self.match?(name)
+          # rubocop:disable Style/CaseEquality
           name != 'localhost' && /^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?\.?$/ === name
+          # rubocop:enable Style/CaseEquality
         end
 
         alias to_browser to_s

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

data/lib/middleman-core/preview_server.rb

@@ -17,13 +17,13 @@ module Middleman
 
       # Start an instance of Middleman::Application
       # @return [void]
-      def start(opts={}, cli_options={})
+      def start(options_hash = ::Middleman::EMPTY_HASH, cli_options_hash = ::Middleman::EMPTY_HASH)
         # Do not buffer output, otherwise testing of output does not work
         $stdout.sync = true
         $stderr.sync = true
 
-        @options = opts
-        @cli_options = cli_options
+        @options = options_hash
+        @cli_options = cli_options_hash
         @server_information = ServerInformation.new
         @server_information.https = (@options[:https] == true)
 
@@ -34,7 +34,7 @@ module Middleman
 
         # And now comes the check
         unless server_information.valid?
-          $stderr.puts %(== Running Middleman failed: #{server_information.reason}. Please fix that and try again.)
+          warn %(== Running Middleman failed: #{server_information.reason}. Please fix that and try again.)
           exit 1
         end
 
@@ -42,12 +42,13 @@ module Middleman
 
         app.logger.debug %(== Server information is provided by #{server_information.handler})
         app.logger.debug %(== The Middleman is running in "#{environment}" environment)
-        app.logger.debug format('== The Middleman preview server is bound to %s', ServerUrl.new(hosts: server_information.listeners, port: server_information.port, https: server_information.https?).to_bind_addresses.join(', '))
-        app.logger.info format('== View your site at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: server_information.https?).to_urls.join(', '))
-        app.logger.info format('== Inspect your site configuration at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: server_information.https?).to_config_urls.join(', '))
+        app.logger.debug format('== The Middleman preview server is bound to %<url>s', url: ServerUrl.new(hosts: server_information.listeners, port: server_information.port, https: server_information.https?).to_bind_addresses.join(', '))
+        app.logger.info format('== View your site at %<url>s', url: ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: server_information.https?).to_urls.join(', '))
+        app.logger.info format('== Inspect your site configuration at %<url>s', url: ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: server_information.https?).to_config_urls.join(', '))
 
         @initialized ||= false
         return if @initialized
+
         @initialized = true
 
         register_signal_handlers
@@ -60,7 +61,9 @@ module Middleman
 
         if @options[:daemon]
           # To output the child PID, let's make preview server a daemon by hand
-          if child_pid = fork
+          child_pid = fork
+
+          if child_pid
             app.logger.info "== Middleman preview server is running in background with PID #{child_pid}"
             Process.detach child_pid
             exit 0
@@ -90,7 +93,7 @@ module Middleman
       def stop
         begin
           app.logger.info '== The Middleman is shutting down'
-        rescue
+        rescue StandardError
           # if the user closed their terminal STDOUT/STDERR won't exist
         end
 
@@ -106,8 +109,8 @@ module Middleman
 
         begin
           app = initialize_new_app
-        rescue => e
-          $stderr.puts "Error reloading Middleman: #{e}\n#{e.backtrace.join("\n")}"
+        rescue StandardError => e
+          warn "Error reloading Middleman: #{e}\n#{e.backtrace.join("\n")}"
           app.logger.info '== The Middleman is still running the application from before the error'
           return
         end
@@ -148,7 +151,7 @@ module Middleman
           ready do
             unless config[:watcher_disable]
               match_against = [
-                %r{^config\.rb$},
+                /^config\.rb$/,
                 %r{^environments/[^\.](.*)\.rb$},
                 %r{^lib/[^\.](.*)\.rb$},
                 %r{^#{config[:helpers_dir]}/[^\.](.*)\.rb$}
@@ -184,7 +187,13 @@ module Middleman
                                server_name: possible_from_cli(:server_name, app.config),
                                https: possible_from_cli(:https, app.config))
 
-        app.logger.warn format('== The Middleman uses a different port "%s" then the configured one "%s" because some other server is listening on that port.', server_information.port, configured_port) unless server_information.port == configured_port
+        unless server_information.port == configured_port
+          app.logger.warn format(
+            '== The Middleman uses a different port "%<new_port>s" then the configured one "%<old_port>s" because some other server is listening on that port.',
+            new_port: server_information.port,
+            old_port: configured_port
+          )
+        end
 
         @environment = possible_from_cli(:environment, app.config)
 
@@ -198,25 +207,21 @@ module Middleman
 
         # Add in the meta pages application
         meta_app = Middleman::MetaPages::Application.new(app)
-        app.map '/__middleman' do
-          run meta_app
+        app.map '/__middleman' do |rack|
+          rack.run meta_app
         end
 
         app
       end
 
       def possible_from_cli(key, config)
-        if @cli_options[key]
-          @cli_options[key]
-        else
-          config[key]
-        end
+        @cli_options[key] || config[key]
       end
 
-      # Trap some interupt signals and shut down smoothly
+      # Trap some interrupt signals and shut down smoothly
       # @return [void]
       def register_signal_handlers
-        %w(INT HUP TERM QUIT).each do |sig|
+        %w[INT HUP TERM QUIT].each do |sig|
           next unless Signal.list[sig]
 
           Signal.trap(sig) do
@@ -244,13 +249,14 @@ module Middleman
 
           if ssl_certificate || ssl_private_key
             raise 'You must provide both :ssl_certificate and :ssl_private_key' unless ssl_private_key && ssl_certificate
+
             http_opts[:SSLCertificate] = OpenSSL::X509::Certificate.new ::File.read ssl_certificate
             http_opts[:SSLPrivateKey] = OpenSSL::PKey::RSA.new ::File.read ssl_private_key
           else
             # use a generated self-signed cert
             http_opts[:SSLCertName] = [
-              %w(CN localhost),
-              %w(CN #{host})
+              %w[CN localhost],
+              ['CN', host]
             ].uniq
             cert, key = create_self_signed_cert(1024, [['CN', server_information.server_name]], server_information.site_addresses, 'Middleman Preview Server')
             http_opts[:SSLCertificate] = cert
@@ -259,15 +265,16 @@ module Middleman
         end
 
         http_opts[:Logger] = if is_logging
-          FilteredWebrickLog.new
-        else
-          ::WEBrick::Log.new(nil, 0)
-        end
+                               FilteredWebrickLog.new
+                             else
+                               ::WEBrick::Log.new(nil, 0)
+                             end
 
         begin
           ::WEBrick::HTTPServer.new(http_opts)
         rescue Errno::EADDRINUSE
-          $stderr.puts %(== Port "#{http_opts[:Port]}" is in use. This should not have happened. Please start "middleman server" again.)
+          port = http_opts[:Port]
+          warn %(== Port #{port} is already in use. This could mean another instance of middleman is already running. Please make sure port #{port} is free and start `middleman server` again, or choose another port by running `middleman server —-port=#{port + 1}` instead.)
         end
       end
 
@@ -314,9 +321,7 @@ module Middleman
         @webrick ||= setup_webrick(@options[:debug] || false)
 
         rack_app = ::Middleman::Rack.new(@app).to_app
-
-        require "rackup/handler/webrick"
-        @webrick.mount '/', ::Rackup::Handler::WEBrick, rack_app
+        @webrick.mount '/', ::Rack::Handler::WEBrick, rack_app
       end
 
       # Detach the current Middleman::Application instance
@@ -332,7 +337,7 @@ module Middleman
 
     class FilteredWebrickLog < ::WEBrick::Log
       def log(level, data)
-        super(level, data) unless data =~ %r{Could not determine content-length of response body.}
+        super(level, data) unless data =~ /Could not determine content-length of response body./
       end
     end
   end

data/lib/middleman-core/rack.rb

@@ -1,9 +1,8 @@
 require 'rack'
-require 'rack/files'
+require 'rack/file'
 require 'rack/lint'
 require 'rack/head'
 require 'rack/utils'
-require 'addressable/uri'
 
 require 'middleman-core/util'
 require 'middleman-core/logger'
@@ -87,26 +86,21 @@ module Middleman
     def process_request(env, req, res)
       start_time = Time.now
 
-      request_path = Addressable::URI.unencode(env['PATH_INFO'].dup)
-      if request_path.respond_to? :force_encoding
-        request_path.force_encoding('UTF-8')
-      end
+      request_path = URI.decode(env['PATH_INFO'].dup)
+      request_path.force_encoding('UTF-8') if request_path.respond_to? :force_encoding
       request_path = ::Middleman::Util.full_path(request_path, @middleman)
       full_request_path = File.join(env['SCRIPT_NAME'], request_path) # Path including rack mount
 
-      # Run before callbacks
-      @middleman.execute_callbacks(:before)
-
       # Get the resource object for this path
-      resource = @middleman.sitemap.find_resource_by_destination_path(request_path.gsub(' ', '%20'))
+      resource = @middleman.sitemap.by_destination_path(request_path.gsub(' ', '%20'))
 
       # Return 404 if not in sitemap
       return not_found(res, full_request_path) unless resource && !resource.ignored?
 
       # If this path is a binary file, send it immediately
-      return send_file(resource, env) if resource.binary?
+      return send_file(resource, env) if resource.binary? || resource.static_file?
 
-      res['content-type'] = resource.content_type || 'text/plain'
+      res['Content-Type'] = resource.content_type || 'text/plain'
 
       begin
         # Write out the contents of the page
@@ -134,7 +128,7 @@ module Middleman
 
     # Immediately send static file
     def send_file(resource, env)
-      file     = ::Rack::Files.new nil
+      file     = ::Rack::File.new nil
       path     = resource.file_descriptor[:full_path]
       if !file.respond_to?(:path=)
         request  = ::Rack::Request.new(env)
@@ -144,12 +138,13 @@ module Middleman
         response = file.serving(env)
       end
       status = response[0]
-      response[1]['content-encoding'] = 'gzip' if %w(.svgz .gz).include?(resource.ext)
-      # Do not set content-type if status is 1xx, 204, 205 or 304, otherwise
+      response[1]['Content-Encoding'] = 'gzip' if %w[.svgz .gz].include?(resource.ext)
+      # Do not set Content-Type if status is 1xx, 204, 205 or 304, otherwise
       # Rack will throw an error (500)
       if !(100..199).cover?(status) && ![204, 205, 304].include?(status)
-        response[1]['content-type'] = resource.content_type || 'application/octet-stream'
+        response[1]['Content-Type'] = resource.content_type || (resource.binary? ? 'application/octet-stream' : 'text/plain')
       end
+
       halt response
     end
   end

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

@@ -6,7 +6,7 @@ module Middleman
     # CoffeeScript Renderer
     class CoffeeScript < ::Middleman::Extension
       # Setup extension
-      def initialize(app, options={}, &block)
+      def initialize(app, options_hash = ::Middleman::EMPTY_HASH, &block)
         super
 
         # Tell Tilt to use it as well (for inline scss blocks)
@@ -21,14 +21,18 @@ module Middleman
         # Make the current Middleman app accessible to the template
         cattr_accessor :middleman_app
 
-        def prepare
+        # Add exception messaging
+        # @param [Class] context
+        # @param [Hash] locals
+        # @return [String]
+        def evaluate(context, locals, &block)
           return super unless middleman_app.server?
 
-          @output = begin
+          begin
             super
           rescue ::ExecJS::RuntimeError => e
             e.to_s
-          rescue => e
+          rescue StandardError => e
             e.to_s
           end
         end

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

@@ -6,26 +6,14 @@ module Middleman
         ::Tilt.prefer(Template, :erb)
       end
 
-      class Template < ::Tilt::ErubiTemplate
-        def initialize(*args, &block)
-          super
-
-          @context = @options[:context]
-        end
-
+      class Template < ::Tilt::ErubisTemplate
         ##
-        # In preamble we need a flag `__in_erb_template` for padrino apps.
+        # In preamble we need a flag `__in_erb_template` and SafeBuffer for padrino apps.
         #
         def precompiled_preamble(locals)
           original = super
           "__in_erb_template = true\n" << original
-        end
-
-        ##
-        # Force the template the use the configured encoding.
-        #
-        def precompiled_template(locals)
-          super.dup.force_encoding(@context.app.config[:encoding])
+          # .rpartition("\n").first << "#{@outvar} = _buf = ::ActiveSupport::SafeBuffer.new\n"
         end
       end
     end