Merge pull request #1681 from maxmeyer/feature/server_hook_v3

Add "before_server"-hook to preview server in v3

middleman-core/features/cli/preview_server-hook.feature

@@ -0,0 +1,17 @@
+Feature: Run preview server before hook
+
+  Scenario: When run
+    Given a fixture app "preview-server-hook-app"
+    And the default aruba timeout is 30 seconds
+    When I run `middleman server --server-name localhost --bind-address 127.0.0.1` interactively
+    And I stop middleman if the output contains:
+    """
+    ### END ###
+    """
+    Then the output should contain:
+    """
+    /// 127.0.0.1:4567 ///
+    /// 4567 ///
+    /// localhost ///
+    /// http://localhost:4567 ///
+    """

middleman-core/features/cli/preview_server.feature

@@ -31,7 +31,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to ":::4567", "0.0.0.0:4567"
+    The Middleman preview server is bound to ":::4567", "0.0.0.0:4567"
     """
     And the output should contain:
     """
@@ -52,7 +52,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to ":::4567", "0.0.0.0:4567"
+    The Middleman preview server is bound to ":::4567", "0.0.0.0:4567"
     """
     And the output should contain:
     """
@@ -76,7 +76,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -104,7 +104,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -127,7 +127,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.5:4567"
+    The Middleman preview server is bound to "127.0.0.5:4567"
     """
     And the output should contain:
     """
@@ -151,7 +151,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "::1:4567"
+    The Middleman preview server is bound to "::1:4567"
     """
     And the output should contain:
     """
@@ -170,7 +170,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "0.0.0.0:4567"
+    The Middleman preview server is bound to "0.0.0.0:4567"
     """
     And the output should contain:
     """
@@ -189,7 +189,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to ":::4567"
+    The Middleman preview server is bound to ":::4567"
     """
     And the output should contain:
     """
@@ -213,7 +213,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -241,7 +241,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -265,7 +265,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -284,7 +284,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -303,7 +303,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "::1:4567"
+    The Middleman preview server is bound to "::1:4567"
     """
     And the output should contain:
     """
@@ -322,7 +322,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to ":::4567", "0.0.0.0:4567"
+    The Middleman preview server is bound to ":::4567", "0.0.0.0:4567"
     """
     And the output should contain:
     """
@@ -341,7 +341,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to ":::65432", "0.0.0.0:65432"
+    The Middleman preview server is bound to ":::65432", "0.0.0.0:65432"
     """
 
   Scenario: Start the server with port 65432 configured via config.rb
@@ -356,7 +356,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to ":::65432", "0.0.0.0:65432"
+    The Middleman preview server is bound to ":::65432", "0.0.0.0:65432"
     """
 
   Scenario: Start the server when port is blocked by other middleman instance
@@ -456,7 +456,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -488,7 +488,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """
@@ -520,7 +520,7 @@ Feature: Run the preview server
     """
     Then the output should contain:
     """
-    The Middleman preview server is bind to "127.0.0.1:4567"
+    The Middleman preview server is bound to "127.0.0.1:4567"
     """
     And the output should contain:
     """

middleman-core/fixtures/preview-server-hook-app/config.rb

@@ -0,0 +1,19 @@
+set :layout, false
+
+class MyFeature < Middleman::Extension
+  def initialize(app, options_hash = {}, &block)
+    super
+
+    app.before_server do |server_information|
+      puts "/// #{server_information.listeners.first} ///"
+      puts "/// #{server_information.port} ///"
+      puts "/// #{server_information.server_name} ///"
+      puts "/// #{server_information.site_addresses.first} ///"
+      puts "/// ### END ### ///"
+    end
+  end
+end
+
+::Middleman::Extensions.register(:my_feature, MyFeature)
+
+activate :my_feature

middleman-core/fixtures/preview-server-hook-app/source/index.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>preview-server-hook-app</title>
+  </head>
+  <body>
+    <h1>preview-server-hook-app</h1>
+  </body>
+</html>

middleman-core/lib/middleman-core/application.rb

@@ -41,6 +41,9 @@ module Middleman
     # Runs after the build is finished
     define_hook :after_build
 
+    # Runs before the preview server is started
+    define_hook :before_server
+
     # Mix-in helper methods. Accepts either a list of Modules
     # and/or a block to be evaluated
     # @return [void]

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

@@ -5,6 +5,7 @@ require 'middleman-core/meta_pages'
 require 'middleman-core/logger'
 require 'middleman-core/preview_server/server_information'
 require 'middleman-core/preview_server/server_url'
+require 'middleman-core/preview_server/server_information_callback_proxy'
 
 # rubocop:disable GlobalVars
 module Middleman
@@ -13,10 +14,6 @@ module Middleman
       attr_reader :app, :ssl_certificate, :ssl_private_key, :environment, :server_information
       delegate :logger, to: :app
 
-      def https?
-        @https
-      end
-
       # Start an instance of Middleman::Application
       # @return [void]
       def start(opts={})
@@ -26,6 +23,7 @@ module Middleman
 
         @options = opts
         @server_information = ServerInformation.new
+        @server_information.https = (@options[:https] == true)
 
         # New app evaluates the middleman configuration. Since this can be
         # invalid as well, we need to evaluate the configuration BEFORE
@@ -42,9 +40,9 @@ module Middleman
 
         logger.debug %(== Server information is provided by #{server_information.handler})
         logger.debug %(== The Middleman is running in "#{environment}" environment)
-        logger.debug format('== The Middleman preview server is bind to %s', ServerUrl.new(hosts: server_information.listeners, port: server_information.port, https: https?).to_bind_addresses.join(', '))
-        logger.info format('== View your site at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: https?).to_urls.join(', '))
-        logger.info format('== Inspect your site configuration at %s', ServerUrl.new(hosts: server_information.site_addresses, port: server_information.port, https: https?).to_config_urls.join(', '))
+        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(', '))
+        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(', '))
+        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(', '))
 
         @initialized ||= false
         return if @initialized
@@ -56,6 +54,8 @@ module Middleman
         # reloading later on.
         ::Middleman::Profiling.report('server_start')
 
+        app.run_hook(:before_server, ServerInformationCallbackProxy.new(server_information))
+
         loop do
           @webrick.start
 
@@ -153,7 +153,6 @@ module Middleman
 
         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 @app.config[:port] == configured_port
 
-        @https        = @app.config[:https]
         @environment  = @app.config[:environment]
 
         @ssl_certificate = @app.config[:ssl_certificate]
@@ -224,7 +223,7 @@ module Middleman
           DoNotReverseLookup: true
         }
 
-        if https?
+        if server_information.https?
           http_opts[:SSLEnable] = true
 
           if ssl_certificate || ssl_private_key

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

@@ -20,6 +20,8 @@ module Middleman
 
       public
 
+      attr_writer :https
+
       def initialize(opts={})
         @resolver     = opts.fetch(:resolver, DnsResolver.new)
         @validator    = opts.fetch(:validator, ServerInformationValidator.new)
@@ -64,10 +66,12 @@ module Middleman
         @bind_address = config[:bind_address]
         @port         = config[:port]
         @server_name  = config[:server_name]
+        @https        = config[:https]
 
         config[:bind_address] = bind_address
         config[:port]         = port
         config[:server_name]  = server_name
+        config[:https]        = https?
       end
 
       # Make information of internal server class available to make debugging
@@ -139,6 +143,11 @@ module Middleman
       def listeners
         information.listeners
       end
+
+      # Is https enabled?
+      def https?
+        @https == true
+      end
     end
   end
 end

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

@@ -0,0 +1,35 @@
+module Middleman
+  class PreviewServer
+    # This class wraps server information to be used in call back
+    #
+    # * listeners
+    # * port
+    # * server name
+    # * site_addresses
+    #
+    # All information is "dupped" and the callback is not meant to be used to
+    # modify these information.
+    class ServerInformationCallbackProxy
+      attr_reader :server_name, :port, :site_addresses, :listeners
+
+      def initialize(server_information)
+        @listeners   = ServerUrl.new(
+          hosts: server_information.listeners,
+          port: server_information.port, 
+          https: server_information.https?,
+          format_output: false
+        ).to_bind_addresses
+
+        @port           = server_information.port
+        @server_name    = server_information.server_name.dup unless server_information.server_name == nil
+
+        @site_addresses = ServerUrl.new(
+          hosts: server_information.site_addresses,
+          port: server_information.port,
+          https: server_information.https?,
+          format_output: false
+        ).to_urls
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Middleman
     class ServerUrl
       private
 
-      attr_reader :hosts, :port, :https
+      attr_reader :hosts, :port, :https, :format_output
 
       public
 
@@ -14,6 +14,7 @@ module Middleman
         @hosts = opts.fetch(:hosts)
         @port  = opts.fetch(:port)
         @https = opts.fetch(:https, false)
+        @format_output = opts.fetch(:format_output, true)
       end
 
       # Return bind addresses
@@ -21,7 +22,11 @@ module Middleman
       # @return [Array]
       #   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) }
+        else
+          hosts.map { |l| format('%s:%s', l.to_s, port) }
+        end
       end
 
       # Return server urls
@@ -29,7 +34,11 @@ module Middleman
       # @return [Array]
       #   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) }
+        else
+          hosts.map { |l| format('%s://%s:%s', https? ? 'https' : 'http', l.to_browser, port) }
+        end
       end
 
       # Return server config urls
@@ -37,7 +46,11 @@ module Middleman
       # @return [Array]
       #   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) }
+        else
+          hosts.map { |l| format('%s://%s:%s/__middleman', https? ? 'https' : 'http', l.to_browser, port) }
+        end
       end
 
       private