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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02dd866c5282faf778b2e57669ad86197c26cc90
-  data.tar.gz: 2402e62953aa0cb41f7cbe98078e7203b2bd98e4
+  metadata.gz: e102996c549a19735369428a6ca1fb6d2d9a735b
+  data.tar.gz: bd3b7074ef91dbef4d80491e1b67c41117ff0699
 SHA512:
-  metadata.gz: 5d66bfdb93ea7353d9c0f3750f13f5df0b31712e6f7527a256f53116ba422ed7b93cd14e9544e57ac531345ca09d2fb73c1c1c285d6a7848624cb4297a339cc8
-  data.tar.gz: 0653294a824cc10c51d0ecdb04fb0363d550e524ba04e58995d79dbd4d67fb7d751236e703a92c2f5a6860d970e2c879ce79bba92360c815242dc7e396cfbc55
+  metadata.gz: 52f6338f6da3da3c1f113826597376f95f0bf7948f6f01a512a924949eb9f8efc7784f4a082f6f32b3892e9f88d3ad6258e662ac297f14bf0b98547faaea2909
+  data.tar.gz: 44a55d6fcff77e9136d7701b15cfe4104eae02de1dc1f8d73698f02eddb5a5a089f2c201a7c2d36e680df845f2550edc9c6aa171258c61271856732fdb9fad32

data/lib/middleman-core/application.rb

@@ -1,29 +1,14 @@
-# i18n Built-in
-require 'i18n'
-
-# Don't fail on invalid locale, that's not what our current
-# users expect.
-::I18n.enforce_available_locales = false
-
 # Use ActiveSupport JSON
 require 'active_support/json'
 require 'active_support/core_ext/integer/inflections'
 
-# Simple callback library
-require 'hooks'
-
-# Our custom logger
-require 'middleman-core/logger'
-
 require 'middleman-core/contracts'
-
+require 'middleman-core/callback_manager'
+require 'middleman-core/logger'
 require 'middleman-core/sitemap/store'
-
 require 'middleman-core/configuration'
-
 require 'middleman-core/extension_manager'
 require 'middleman-core/core_extensions'
-
 require 'middleman-core/config_context'
 require 'middleman-core/file_renderer'
 require 'middleman-core/template_renderer'
@@ -38,6 +23,9 @@ module Middleman
     include Contracts
 
     class << self
+      extend Forwardable
+      def_delegator :config, :define_setting
+
       # Global configuration for the whole Middleman project.
       # @return [ConfigurationManager]
       def config
@@ -56,108 +44,119 @@ module Middleman
       end
     end
 
-    # Uses callbacks
-    include Hooks
-    include Hooks::InstanceHooks
+    Contract ::Middleman::ConfigContext
+    attr_reader :config_context
 
-    define_hook :initialized
-    define_hook :after_configuration
-    define_hook :before_configuration
+    Contract ::Middleman::Sitemap::Store
+    attr_reader :sitemap
 
-    # Before request hook
-    define_hook :before
+    # An anonymous subclass of ::Middleman::TemplateContext
+    attr_reader :template_context_class
 
-    # Ready (all loading and parsing of extensions complete) hook
-    define_hook :ready
+    # An instance of the above anonymouse class.
+    attr_reader :generic_template_context
 
-    # Runs before the build is started
-    define_hook :before_build
+    Contract ::Middleman::Configuration::ConfigurationManager
+    attr_reader :config
 
-    # Runs after the build is finished
-    define_hook :after_build
+    Contract ::Middleman::ExtensionManager
+    attr_reader :extensions
 
-    define_hook :before_shutdown
+    Contract SetOf[MiddlewareDescriptor]
+    attr_reader :middleware
 
-    define_hook :before_render
-    define_hook :after_render
+    Contract SetOf[MapDescriptor]
+    attr_reader :mappings
 
     # Which host preview should start on.
     # @return [Fixnum]
-    config.define_setting :host, '0.0.0.0', 'The preview server host'
+    define_setting :host, '0.0.0.0', 'The preview server host'
 
     # Which port preview should start on.
     # @return [Fixnum]
-    config.define_setting :port, 4567, 'The preview server port'
+    define_setting :port, 4567, 'The preview server port'
+
+    # Whether to serve the preview server over HTTPS.
+    # @return [Boolean]
+    config.define_setting :https, false, 'Serve the preview server over SSL/TLS'
+
+    # The (optional) path to the SSL cert to use for the preview server.
+    # @return [String]
+    config.define_setting :ssl_certificate, nil, 'Path to an X.509 certificate to use for the preview server'
+
+    # The (optional) private key for the certificate in :ssl_certificate.
+    # @return [String]
+    config.define_setting :ssl_private_key, nil, "Path to an RSA private key for the preview server's certificate"
 
     # Name of the source directory
     # @return [String]
-    config.define_setting :source, 'source', 'Name of the source directory'
+    define_setting :source, 'source', 'Name of the source directory'
 
     # Middleman mode. Defaults to :server, set to :build by the build process
     # @return [String]
-    config.define_setting :mode, ((ENV['MM_ENV'] && ENV['MM_ENV'].to_sym) || :server), 'Middleman mode. Defaults to :server'
+    define_setting :mode, ((ENV['MM_ENV'] && ENV['MM_ENV'].to_sym) || :server), 'Middleman mode. Defaults to :server'
 
     # Middleman environment. Defaults to :development
     # @return [String]
-    config.define_setting :environment, :development, 'Middleman environment. Defaults to :development'
+    define_setting :environment, :development, 'Middleman environment. Defaults to :development'
 
     # Which file should be used for directory indexes
     # @return [String]
-    config.define_setting :index_file,  'index.html', 'Which file should be used for directory indexes'
+    define_setting :index_file,  'index.html', 'Which file should be used for directory indexes'
 
     # Whether to strip the index file name off links to directory indexes
     # @return [Boolean]
-    config.define_setting :strip_index_file, true, 'Whether to strip the index file name off links to directory indexes'
+    define_setting :strip_index_file, true, 'Whether to strip the index file name off links to directory indexes'
 
     # Whether to include a trailing slash when stripping the index file
     # @return [Boolean]
-    config.define_setting :trailing_slash, true, 'Whether to include a trailing slash when stripping the index file'
+    define_setting :trailing_slash, true, 'Whether to include a trailing slash when stripping the index file'
 
     # Location of javascripts within source.
     # @return [String]
-    config.define_setting :js_dir,      'javascripts', 'Location of javascripts within source'
+    define_setting :js_dir,      'javascripts', 'Location of javascripts within source'
 
     # Location of stylesheets within source. Used by Compass.
     # @return [String]
-    config.define_setting :css_dir,     'stylesheets', 'Location of stylesheets within source'
+    define_setting :css_dir,     'stylesheets', 'Location of stylesheets within source'
 
     # Location of images within source. Used by HTML helpers and Compass.
     # @return [String]
-    config.define_setting :images_dir,  'images', 'Location of images within source'
+    define_setting :images_dir,  'images', 'Location of images within source'
 
     # Location of fonts within source. Used by Compass.
     # @return [String]
-    config.define_setting :fonts_dir,   'fonts', 'Location of fonts within source'
+    define_setting :fonts_dir,   'fonts', 'Location of fonts within source'
 
     # Location of layouts within source. Used by renderers.
     # @return [String]
-    config.define_setting :layouts_dir, 'layouts', 'Location of layouts within source'
+    define_setting :layouts_dir, 'layouts', 'Location of layouts within source'
 
     # Where to build output files
     # @return [String]
-    config.define_setting :build_dir,   'build', 'Where to build output files'
+    define_setting :build_dir,   'build', 'Where to build output files'
 
     # Default prefix for building paths. Used by HTML helpers and Compass.
     # @return [String]
-    config.define_setting :http_prefix, '/', 'Default prefix for building paths'
+    define_setting :http_prefix, '/', 'Default prefix for building paths'
 
     # Default layout name
     # @return [String, Symbold]
-    config.define_setting :layout, :_auto_layout, 'Default layout name'
+    define_setting :layout, :_auto_layout, 'Default layout name'
 
     # Default string encoding for templates and output.
     # @return [String]
-    config.define_setting :encoding, 'utf-8', 'Default string encoding for templates and output'
+    define_setting :encoding, 'utf-8', 'Default string encoding for templates and output'
 
     # Should Padrino include CRSF tag
     # @return [Boolean]
-    config.define_setting :protect_from_csrf, false, 'Should Padrino include CRSF tag'
+    define_setting :protect_from_csrf, false, 'Should Padrino include CRSF tag'
 
     # Set to automatically convert some characters into a directory
-    config.define_setting :automatic_directory_matcher, nil, 'Set to automatically convert some characters into a directory'
+    define_setting :automatic_directory_matcher, nil, 'Set to automatically convert some characters into a directory'
 
     # Setup callbacks which can exclude paths from the sitemap
-    config.define_setting :ignored_sitemap_matchers, {
+    define_setting :ignored_sitemap_matchers, {
       # Files starting with an underscore, but not a double-underscore
       partials: proc { |file|
         ignored = false
@@ -178,37 +177,40 @@ module Middleman
       }
     }, 'Callbacks that can exclude paths from the sitemap'
 
-    config.define_setting :watcher_disable, false, 'If the Listen watcher should not run'
-    config.define_setting :watcher_force_polling, false, 'If the Listen watcher should run in polling mode'
-    config.define_setting :watcher_latency, nil, 'The Listen watcher latency'
-
-    attr_reader :config_context
-    attr_reader :sitemap
-    attr_reader :cache
-    attr_reader :template_context_class
-    attr_reader :config
-    attr_reader :generic_template_context
-    attr_reader :extensions
-    attr_reader :sources
-
-    Contract SetOf[MiddlewareDescriptor]
-    attr_reader :middleware
-
-    Contract SetOf[MapDescriptor]
-    attr_reader :mappings
+    define_setting :watcher_disable, false, 'If the Listen watcher should not run'
+    define_setting :watcher_force_polling, false, 'If the Listen watcher should run in polling mode'
+    define_setting :watcher_latency, nil, 'The Listen watcher latency'
 
-    # Reference to Logger singleton
+    # Delegate convenience methods off to their implementations
     def_delegator :"::Middleman::Logger", :singleton, :logger
     def_delegator :"::Middleman::Util", :instrument
     def_delegators :"self.class", :root, :root_path
     def_delegators :@generic_template_context, :link_to, :image_tag, :asset_path
     def_delegators :@extensions, :activate
+    def_delegators :config, :define_setting
 
     # Initialize the Middleman project
     def initialize(&block)
       # Search the root of the project for required files
       $LOAD_PATH.unshift(root) unless $LOAD_PATH.include?(root)
 
+      @callbacks = ::Middleman::CallbackManager.new
+      @callbacks.install_methods!(self, [
+        :initialized,
+        :configure,
+        :before_sitemap,
+        :before_configuration,
+        :after_configuration,
+        :after_configuration_eval,
+        :ready,
+        :before_build,
+        :after_build,
+        :before_shutdown,
+        :before, # Before Rack requests
+        :before_render,
+        :after_render
+      ])
+
       @middleware = Set.new
       @mappings = Set.new
 
@@ -216,21 +218,22 @@ module Middleman
       @generic_template_context = @template_context_class.new(self)
       @config_context = ConfigContext.new(self, @template_context_class)
 
-      ::Middleman::FileRenderer.cache.clear
-      ::Middleman::TemplateRenderer.cache.clear
-
       # Setup the default values from calls to set before initialization
       @config = ::Middleman::Configuration::ConfigurationManager.new
       @config.load_settings(self.class.config.all_settings)
 
       config[:source] = ENV['MM_SOURCE'] if ENV['MM_SOURCE']
 
+      # TODO, make this less global
+      ::Middleman::FileRenderer.cache.clear
+      ::Middleman::TemplateRenderer.cache.clear
+
       @extensions = ::Middleman::ExtensionManager.new(self)
 
       # Evaluate a passed block if given
       config_context.instance_exec(&block) if block_given?
 
-      @extensions.auto_activate(:before_sitemap)
+      execute_callbacks(:before_sitemap)
 
       # Initialize the Sitemap
       @sitemap = ::Middleman::Sitemap::Store.new(self)
@@ -242,42 +245,40 @@ module Middleman
 
       ::Middleman::Extension.clear_after_extension_callbacks
 
-      @extensions.auto_activate(:before_configuration)
+      after_configuration_eval(&method(:prune_tilt_templates))
+
+      start_lifecycle
+    end
 
-      run_hook :initialized
+    # Boot the app.
+    def start_lifecycle
+      # Before config is parsed, before extensions get to it.
+      execute_callbacks(:initialized)
 
-      run_hook :before_configuration
+      # Before config is parsed. Mostly used for extensions.
+      execute_callbacks(:before_configuration)
 
-      evaluate_configuration
+      # Eval config.
+      evaluate_configuration!
 
-      # 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.
-      if ENV['TEST']
-        ::I18n.load_path.delete_if { |path| path =~ %r{tmp/aruba} }
-        ::I18n.reload!
-      end
+      # Run any `configure` blocks for the current environment.
+      execute_callbacks([:configure, config[:environment]])
 
-      # Clean up missing Tilt exts
-      Tilt.mappings.each do |key, _|
-        begin
-          Tilt[".#{key}"]
-        rescue LoadError, NameError
-          Tilt.mappings.delete(key)
-        end
-      end
+      # Run any `configure` blocks for the current mode.
+      execute_callbacks([:configure, config[:mode]])
 
-      @extensions.activate_all
+      # Post parsing, pre-extension callback
+      execute_callbacks(:after_configuration_eval)
 
-      run_hook :after_configuration
-      config_context.execute_after_configuration_callbacks
+      # After extensions have worked after_config
+      execute_callbacks(:after_configuration)
 
-      run_hook :ready
-      @config_context.execute_ready_callbacks
+      # Everything is stable
+      execute_callbacks(:ready)
     end
 
-    def evaluate_configuration
+    # Eval config
+    def evaluate_configuration!
       # Check for and evaluate local configuration in `config.rb`
       config_rb = File.join(root, 'config.rb')
       if File.exist? config_rb
@@ -293,55 +294,67 @@ module Middleman
       end
 
       env_config = File.join(root, 'environments', "#{config[:environment]}.rb")
-      if File.exist? env_config
-        logger.debug "== Reading: #{config[:environment]} config"
-        config_context.instance_eval File.read(env_config), env_config, 1
-      end
+      return unless File.exist? env_config
 
-      # Run any `configure` blocks for the current environment.
-      config_context.execute_configure_callbacks(config[:environment])
+      logger.debug "== Reading: #{config[:environment]} config"
+      config_context.instance_eval File.read(env_config), env_config, 1
+    end
 
-      # Run any `configure` blocks for the current mode.
-      config_context.execute_configure_callbacks(config[:mode])
+    # Clean up missing Tilt exts
+    def prune_tilt_templates
+      ::Tilt.mappings.each do |key, _|
+        begin
+          ::Tilt[".#{key}"]
+        rescue LoadError, NameError
+          ::Tilt.mappings.delete(key)
+        end
+      end
     end
 
     # Whether we're in server mode
     # @return [Boolean] If we're in dev mode
+    Contract Bool
     def server?
       config[:mode] == :server
     end
 
     # Whether we're in build mode
     # @return [Boolean] If we're in dev mode
+    Contract Bool
     def build?
       config[:mode] == :build
     end
 
     # Whether we're in a specific environment
     # @return [Boolean]
+    Contract Bool
     def environment?(key)
       config[:environment] == key
     end
 
     # Backwards compatible helper. What the current environment is.
     # @return [Symbol]
+    Contract Symbol
     def environment
       config[:environment]
     end
 
     # Backwards compatible helper. Whether we're in dev mode.
     # @return [Boolean]
+    Contract Bool
     def development?
       environment?(:development)
     end
 
     # Backwards compatible helper. Whether we're in production mode.
     # @return [Boolean]
+    Contract Bool
     def production?
       environment?(:production)
     end
 
     # Backwards compatible helper. The full path to the default source dir.
+    Contract Pathname
     def source_dir
       Pathname(File.join(root, config[:source]))
     end
@@ -364,8 +377,9 @@ module Middleman
       @mappings << MapDescriptor.new(map, block)
     end
 
+    # Let everyone know we're shutting down.
     def shutdown!
-      run_hook :before_shutdown
+      execute_callbacks(:before_shutdown)
     end
 
     # Work around this bug: http://bugs.ruby-lang.org/issues/4521

data/lib/middleman-core/builder.rb

@@ -2,6 +2,7 @@ require 'pathname'
 require 'fileutils'
 require 'tempfile'
 require 'middleman-core/rack'
+require 'middleman-core/callback_manager'
 require 'middleman-core/contracts'
 
 module Middleman
@@ -36,10 +37,11 @@ module Middleman
       @glob = opts.fetch(:glob)
       @cleaning = opts.fetch(:clean)
 
-      @_event_callbacks = []
-
       rack_app = ::Middleman::Rack.new(@app).to_app
       @rack = ::Rack::MockRequest.new(rack_app)
+
+      @callbacks = ::Middleman::CallbackManager.new
+      @callbacks.install_methods!(self, [:on_build_event])
     end
 
     # Run the build phase.
@@ -49,7 +51,7 @@ module Middleman
       @has_error = false
       @events = {}
 
-      @app.run_hook :before_build, self
+      @app.execute_callbacks(:before_build, [self])
 
       queue_current_paths if @cleaning
       prerender_css
@@ -60,21 +62,11 @@ module Middleman
 
       ::Middleman::Profiling.report('build')
 
-      # Run hooks
-      @app.run_hook :after_build, self
-      @app.config_context.execute_after_build_callbacks(self)
+      @app.execute_callbacks(:after_build, [self])
 
       !@has_error
     end
 
-    # Attach callbacks for build events.
-    # @return [Array<Proc>] All the attached events.
-    Contract Proc => ArrayOf[Proc]
-    def on_build_event(&block)
-      @_event_callbacks << block if block_given?
-      @_event_callbacks
-    end
-
     # Pre-request CSS to give Compass a chance to build sprites
     # @return [Array<Resource>] List of css resources that were output.
     Contract ResourceList
@@ -253,9 +245,7 @@ module Middleman
       @events[event_type] ||= []
       @events[event_type] << target
 
-      @_event_callbacks.each do |callback|
-        callback.call(event_type, target, extra)
-      end
+      execute_callbacks(:on_build_event, [event_type, target, extra])
     end
   end
 end