middleman-core 4.0.0.beta.1 → 4.0.0.beta.2

data/lib/middleman-core/callback_manager.rb

@@ -0,0 +1,61 @@
+require 'hamster'
+require 'middleman-core/contracts'
+
+# Immutable Callback Management, complete with Contracts validation.
+module Middleman
+  class CallbackManager
+    include Contracts
+
+    Contract Any
+    def initialize
+      @callbacks = ::Hamster.hash
+      @subscribers = ::Hamster.vector
+    end
+
+    Contract RespondTo[:define_singleton_method], ArrayOf[Symbol] => Any
+    def install_methods!(install_target, names)
+      manager = self
+
+      names.each do |method_name|
+        install_target.define_singleton_method(method_name) do |*keys, &b|
+          key_set = keys.unshift(method_name)
+          manager.add(key_set.length > 1 ? key_set : key_set[0], &b)
+        end
+      end
+
+      install_target.define_singleton_method(:execute_callbacks) do |*args|
+        keys = args.shift
+        manager.execute(keys, args[0], self)
+      end
+
+      install_target.define_singleton_method(:callbacks_for, &method(:callbacks_for))
+      install_target.define_singleton_method(:subscribe_to_callbacks, &method(:subscribe))
+    end
+
+    Contract Or[Symbol, ArrayOf[Symbol]], Proc => Any
+    def add(keys, &block)
+      immutable_keys = keys.is_a?(Symbol) ? keys : ::Hamster::Vector.new(keys)
+
+      @callbacks = @callbacks.put(immutable_keys) do |v|
+        v.nil? ? ::Hamster::Vector.new([block]) : v.push(block)
+      end
+    end
+
+    Contract Proc => Any
+    def subscribe(&block)
+      @subscribers = @subscribers.push(block)
+    end
+
+    Contract Or[Symbol, ArrayOf[Symbol]], Maybe[ArrayOf[Any]], Maybe[RespondTo[:instance_exec]] => Any
+    def execute(keys, args=[], scope=self)
+      callbacks_for(keys).each { |b| scope.instance_exec(*args, &b) }
+      @subscribers.each { |b| scope.instance_exec(keys, args, &b) }
+    end
+
+    Contract Or[Symbol, ArrayOf[Symbol]] => ::Hamster::Vector
+    def callbacks_for(keys)
+      immutable_keys = keys.is_a?(Symbol) ? keys : ::Hamster::Vector.new(keys)
+      @callbacks.get(immutable_keys) || ::Hamster.vector
+    end
+  end
+end

data/lib/middleman-core/cli/server.rb

@@ -18,6 +18,13 @@ module Middleman::Cli
     method_option :port,
                   aliases: '-p',
                   desc: 'The port Middleman will listen on'
+    method_option :https,
+                  type: :boolean,
+                  desc: 'Serve the preview server over SSL/TLS'
+    method_option :ssl_certificate,
+                  desc: 'Path to an X.509 certificate to use for the preview server'
+    method_option :ssl_private_key,
+                  desc: "Path to an RSA private key for the preview server's certificate"
     method_option :verbose,
                   type: :boolean,
                   default: false,
@@ -63,6 +70,9 @@ module Middleman::Cli
       params = {
         port: options['port'],
         host: options['host'],
+        https: options['https'],
+        ssl_certificate: options['ssl_certificate'],
+        ssl_private_key: options['ssl_private_key'],
         environment: options['environment'],
         debug: options['verbose'],
         instrumenting: options['instrument'],

data/lib/middleman-core/config_context.rb

@@ -1,4 +1,5 @@
 require 'rack/mime'
+require 'middleman-core/callback_manager'
 
 module Middleman
   class ConfigContext
@@ -14,10 +15,11 @@ module Middleman
       @app = app
       @template_context_class = template_context_class
 
-      @ready_callbacks = []
-      @after_build_callbacks = []
-      @after_configuration_callbacks = []
-      @configure_callbacks = {}
+      @callbacks = ::Middleman::CallbackManager.new
+      @callbacks.install_methods!(self, [:before_build, :after_build, :configure, :after_configuration, :ready])
+
+      # Trigger internal callbacks when app level are executed.
+      app.subscribe_to_callbacks(&method(:execute_callbacks))
     end
 
     def helpers(*helper_modules, &block)
@@ -43,48 +45,6 @@ module Middleman
       instance_eval File.read(other_config), other_config, 1
     end
 
-    def ready(&block)
-      @ready_callbacks << block
-    end
-
-    def execute_ready_callbacks
-      @ready_callbacks.each do |b|
-        instance_exec(&b)
-      end
-    end
-
-    def after_build(&block)
-      @after_build_callbacks << block
-    end
-
-    def execute_after_build_callbacks(*args)
-      @after_build_callbacks.each do |b|
-        instance_exec(*args, &b)
-      end
-    end
-
-    def after_configuration(&block)
-      @after_configuration_callbacks << block
-    end
-
-    def execute_after_configuration_callbacks
-      @after_configuration_callbacks.each do |b|
-        instance_exec(&b)
-      end
-    end
-
-    def configure(key, &block)
-      @configure_callbacks[key] ||= []
-      @configure_callbacks[key] << block
-    end
-
-    def execute_configure_callbacks(key)
-      @configure_callbacks[key] ||= []
-      @configure_callbacks[key].each do |b|
-        instance_exec(&b)
-      end
-    end
-
     def set(key, default=nil, &block)
       config.define_setting(key, default) unless config.defines_setting?(key)
       @app.config[key] = block_given? ? block : default

data/lib/middleman-core/contracts.rb

@@ -1,5 +1,6 @@
 if ENV['TEST'] || ENV['CONTRACTS'] == 'true'
   require 'contracts'
+  require 'hamster'
 
   module Contracts
     class IsA
@@ -27,21 +28,7 @@ if ENV['TEST'] || ENV['CONTRACTS'] == 'true'
       end
     end
 
-    # class MethodDefined
-    #   def self.[](val)
-    #     @lookup ||= {}
-    #     @lookup[val] ||= new(val)
-    #   end
-
-    #   def initialize(val)
-    #     @val = val
-    #   end
-
-    #   def valid?(val)
-    #     val.method_defined? @val
-    #   end
-    # end
-
+    VectorOf = Contracts::CollectionOf::Factory.new(::Hamster::Vector)
     ResourceList = Contracts::ArrayOf[IsA['Middleman::Sitemap::Resource']]
   end
 else
@@ -125,8 +112,8 @@ else
     class Frozen < Callable
     end
 
-    # class MethodDefined < Callable
-    # end
+    class VectorOf < Callable
+    end
   end
 end
 

data/lib/middleman-core/core_extensions/collections/step_context.rb

@@ -1,3 +1,5 @@
+require 'hamster'
+
 module Middleman
   module CoreExtensions
     module Collections
@@ -9,13 +11,13 @@ module Middleman
         attr_reader :descriptors
 
         def initialize
-          @descriptors = []
+          @descriptors = ::Hamster.set
         end
 
         def method_missing(name, *args, &block)
           internal = :"_internal_#{name}"
           if respond_to?(internal)
-            @descriptors << send(internal, *args, &block)
+            @descriptors = @descriptors.add(send(internal, *args, &block))
           else
             super
           end

data/lib/middleman-core/core_extensions/i18n.rb

@@ -10,6 +10,25 @@ class Middleman::CoreExtensions::Internationalization < ::Middleman::Extension
   # Exposes `langs` to templates
   expose_to_template :langs
 
+  def initialize(*)
+    super
+
+    require 'i18n'
+
+    # Don't fail on invalid locale, that's not what our current
+    # users expect.
+    ::I18n.enforce_available_locales = false
+
+    # This is for making the tests work - since the tests
+    # don't completely reload middleman, I18n.load_path can get
+    # polluted with paths from other test app directories that don't
+    # exist anymore.
+    app.after_configuration_eval do
+      ::I18n.load_path.delete_if { |path| path =~ %r{tmp/aruba} }
+      ::I18n.reload!
+    end if ENV['TEST']
+  end
+
   def after_configuration
     # See https://github.com/svenfuchs/i18n/wiki/Fallbacks
     unless options[:no_fallbacks]

data/lib/middleman-core/core_extensions/show_exceptions.rb

@@ -8,7 +8,7 @@ module Middleman::CoreExtensions
 
       return if app.config.defines_setting? :show_exceptions
 
-      app.config.define_setting :show_exceptions, !!ENV['TEST'], 'Whether to catch and display exceptions'
+      app.config.define_setting :show_exceptions, ENV['TEST'] ? false : true, 'Whether to catch and display exceptions'
     end
 
     def after_configuration

data/lib/middleman-core/extension.rb

@@ -380,6 +380,7 @@ module Middleman
 
     def bind_after_configuration
       ext = self
+
       @app.after_configuration do
         ext.after_configuration if ext.respond_to?(:after_configuration)
 

data/lib/middleman-core/extension_manager.rb

@@ -8,6 +8,17 @@ module Middleman
     def initialize(app)
       @app = app
       @activated = {}
+
+      manager = self
+      {
+        before_sitemap: :before_sitemap,
+        initialized: :before_configuration
+      }.each do |key, value|
+        cb = proc { manager.auto_activate(value) }
+        @app.send(key, &cb)
+      end
+
+      @app.after_configuration_eval(&method(:activate_all))
     end
 
     def auto_activate(key)

data/lib/middleman-core/file_renderer.rb

@@ -59,14 +59,10 @@ module Middleman
       options = options.deep_merge(options[:renderer_options]) if options[:renderer_options]
 
       template_class = ::Tilt[path]
+
       # Allow hooks to manipulate the template before render
-      @app.class.callbacks_for_hook(:before_render).each do |callback|
-        newbody = if callback.respond_to?(:call)
-          callback.call(body, path, locs, template_class)
-        elsif callback.respond_to?(:evaluate)
-          callback.evaluate(self, body, path, locs, template_class)
-        end
-        body = newbody if newbody # Allow the callback to return nil to skip it
+      body = @app.callbacks_for(:before_render).reduce(body) do |sum, callback|
+        callback.call(sum, path, locs, template_class) || sum
       end
 
       # Read compiled template from disk or cache
@@ -80,14 +76,8 @@ module Middleman
       end
 
       # Allow hooks to manipulate the result after render
-      @app.class.callbacks_for_hook(:after_render).each do |callback|
-        # Uber::Options::Value doesn't respond to call
-        newcontent = if callback.respond_to?(:call)
-          callback.call(content, path, locs, template_class)
-        elsif callback.respond_to?(:evaluate)
-          callback.evaluate(self, content, path, locs, template_class)
-        end
-        content = newcontent if newcontent # Allow the callback to return nil to skip it
+      content = @app.callbacks_for(:before_render).reduce(content) do |sum, callback|
+        callback.call(sum, path, locs, template_class) || sum
       end
 
       output = ::ActiveSupport::SafeBuffer.new ''

data/lib/middleman-core/preview_server.rb

@@ -1,4 +1,6 @@
 require 'webrick'
+require 'webrick/https'
+require 'openssl'
 require 'middleman-core/meta_pages'
 require 'middleman-core/logger'
 require 'middleman-core/rack'
@@ -9,9 +11,13 @@ module Middleman
     class << self
       extend Forwardable
 
-      attr_reader :app, :host, :port
+      attr_reader :app, :host, :port, :ssl_certificate, :ssl_private_key
       def_delegator :app, :logger
 
+      def https?
+        @https
+      end
+
       # Start an instance of Middleman::Application
       # @return [void]
       def start(opts={})
@@ -105,6 +111,8 @@ module Middleman
 
           config[:host] = opts[:host] if opts[:host]
           config[:port] = opts[:port] if opts[:port]
+          config[:ssl_certificate] = opts[:ssl_certificate] if opts[:ssl_certificate]
+          config[:ssl_private_key] = opts[:ssl_private_key] if opts[:ssl_private_key]
 
           ready do
             match_against = [
@@ -123,6 +131,10 @@ module Middleman
 
         @host = app.config[:host]
         @port = app.config[:port]
+        @https = app.config[:https]
+
+        @ssl_certificate = app.config[:ssl_certificate]
+        @ssl_private_key = app.config[:ssl_private_key]
 
         app.files.on_change :reload do
           $mm_reload = true
@@ -163,6 +175,22 @@ module Middleman
           DoNotReverseLookup: true
         }
 
+        if https?
+          http_opts[:SSLEnable] = true
+
+          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})
+            ].uniq
+          end
+        end
+
         if is_logging
           http_opts[:Logger] = FilteredWebrickLog.new
         else
@@ -203,7 +231,8 @@ module Middleman
       # @return [URI]
       def uri
         host = (@host == '0.0.0.0') ? 'localhost' : @host
-        URI("http://#{host}:#{@port}")
+        scheme = https? ? 'https' : 'http'
+        URI("#{scheme}://#{host}:#{@port}")
       end
     end
 

data/lib/middleman-core/rack.rb

@@ -85,7 +85,7 @@ module Middleman
       full_request_path = File.join(env['SCRIPT_NAME'], request_path) # Path including rack mount
 
       # Run before callbacks
-      @middleman.run_hook :before
+      @middleman.execute_callbacks(:before)
 
       # Get the resource object for this path
       resource = @middleman.sitemap.find_resource_by_destination_path(request_path.gsub(' ', '%20'))

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

@@ -13,9 +13,7 @@ module Middleman
         ::Tilt.register 'coffee', DebuggingCoffeeScriptTemplate
         ::Tilt.prefer(DebuggingCoffeeScriptTemplate)
 
-        app.before_configuration do
-          DebuggingCoffeeScriptTemplate.middleman_app = self
-        end
+        DebuggingCoffeeScriptTemplate.middleman_app = app
       end
 
       # A Template for Tilt which outputs debug messages

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

@@ -12,7 +12,7 @@ module Middleman
         def initialize(app, config={}, &block)
           super
 
-          # Array of callbacks which can ass ignored
+          # Array of callbacks which can assign ignored
           @ignored_callbacks = Set.new
 
           @app.sitemap.define_singleton_method(:ignored?, &method(:ignored?))

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

@@ -5,21 +5,18 @@ module Middleman
   module Sitemap
     module Extensions
       class OnDisk < Extension
-        attr_accessor :waiting_for_ready
-
         def initialize(app, config={}, &block)
           super
 
           @file_paths_on_disk = Set.new
-
-          scoped_self = self
           @waiting_for_ready = true
+        end
 
-          @app.ready do
-            scoped_self.waiting_for_ready = false
-            # Make sure the sitemap is ready for the first request
-            sitemap.ensure_resource_list_updated!
-          end
+        def ready
+          @waiting_for_ready = false
+
+          # Make sure the sitemap is ready for the first request
+          app.sitemap.ensure_resource_list_updated!
         end
 
         Contract Any
@@ -27,6 +24,7 @@ module Middleman
           app.files.on_change(:source, &method(:update_files))
         end
 
+        Contract IsA['Middleman::SourceFile'] => Bool
         def ignored?(file)
           @app.config[:ignored_sitemap_matchers].any? do |_, callback|
             callback.call(file, @app)
@@ -48,9 +46,10 @@ module Middleman
 
           # Force sitemap rebuild so the next request is ready to go.
           # Skip this during build because the builder will control sitemap refresh.
-          @app.sitemap.ensure_resource_list_updated! unless waiting_for_ready || @app.build?
+          @app.sitemap.ensure_resource_list_updated! unless @waiting_for_ready || @app.build?
         end
 
+        Contract ArrayOf[IsA['Middleman::SourceFile']]
         def files_for_sitemap
           @app.files.by_type(:source).files.reject(&method(:ignored?))
         end