middleman-core 3.1.0.rc.1 → 3.1.0.rc.2

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

@@ -38,6 +38,7 @@ module Middleman
         # @private
         def registered(app)
           app.define_hook :initialized
+          app.define_hook :instance_available
           app.define_hook :after_configuration
           app.define_hook :before_configuration
           app.define_hook :build_config
@@ -69,15 +70,19 @@ module Middleman
         # @param [Hash] options Per-extension options hash
         # @return [void]
         def register(extension, options={}, &block)
-          extend extension
-          if extension.respond_to?(:registered)
-            if extension.method(:registered).arity === 1
-              extension.registered(self, &block)
-            else
-              extension.registered(self, options, &block)
+          if extension.instance_of?(Class) && extension.ancestors.include?(::Middleman::Extension)
+            extension.new(self, options, &block)
+          else
+            extend extension
+            if extension.respond_to?(:registered)
+              if extension.method(:registered).arity === 1
+                extension.registered(self, &block)
+              else
+                extension.registered(self, options, &block)
+              end
             end
+            extension
           end
-          extension
         end
       end
 
@@ -133,11 +138,12 @@ module Middleman
           super
 
           self.class.inst = self
-          run_hook :before_configuration
 
           # Search the root of the project for required files
           $LOAD_PATH.unshift(root)
 
+          run_hook :initialized
+
           if config[:autoload_sprockets]
             begin
               require "middleman-sprockets"
@@ -146,6 +152,8 @@ module Middleman
             end
           end
 
+          run_hook :before_configuration
+
           # Check for and evaluate local configuration
           local_config = File.join(root, "config.rb")
           if File.exists? local_config
@@ -156,7 +164,16 @@ module Middleman
           run_hook :build_config if build?
           run_hook :development_config if development?
 
-          run_hook :initialized
+          run_hook :instance_available
+
+          # 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_hook :after_configuration
 

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

@@ -17,7 +17,8 @@ module Middleman
         /^Gemfile$/,
         /^Gemfile\.lock$/,
         /~$/,
-        /(^|\/)\.?#/
+        /(^|\/)\.?#/,
+        /^tmp\//
       ]
 
       # Setup extension
@@ -56,6 +57,7 @@ module Middleman
       class API
 
         attr_reader :app
+        attr_reader :known_paths
         delegate :logger, :to => :app
 
         # Initialize api and internal path cache
@@ -142,6 +144,12 @@ module Middleman
           reload_path(path, true)
         end
 
+        def exists?(path)
+          p = Pathname(path)
+          p = p.relative_path_from(Pathname(@app.root)) if !p.relative?
+          @known_paths.include?(p)
+        end
+
       protected
         # Whether this path is ignored
         # @param [Pathname] path

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

@@ -1,230 +1,202 @@
 require "active_support/core_ext/hash/keys"
 require 'pathname'
 
+# Parsing YAML frontmatter
+require "yaml"
+
+# Parsing JSON frontmatter
+require "active_support/json"
+
 # Extensions namespace
 module Middleman::CoreExtensions
 
-  # Frontmatter namespace
-  module FrontMatter
-
-    # Setup extension
-    class << self
+  class FrontMatter < ::Middleman::Extension
 
-      # Once registered
-      def registered(app)
-        # Parsing YAML frontmatter
-        require "yaml"
+    YAML_ERRORS = [ StandardError ]
 
-        # Parsing JSON frontmatter
-        require "active_support/json"
+    # https://github.com/tenderlove/psych/issues/23
+    if defined?(Psych) && defined?(Psych::SyntaxError)
+      YAML_ERRORS << Psych::SyntaxError
+    end
 
-        app.send :include, InstanceMethods
+    def initialize(app, options_hash={}, &block)
+      super
 
-        app.before_configuration do
-          files.changed { |file| frontmatter_manager.clear_data(file) }
-          files.deleted { |file| frontmatter_manager.clear_data(file) }
-        end
+      @cache = {}
+    end
 
-        app.after_configuration do
-          ::Middleman::Sitemap::Resource.send :include, ResourceInstanceMethods
+    def before_configuration
+      ext = self
+      app.files.changed { |file| ext.clear_data(file) }
+      app.files.deleted { |file| ext.clear_data(file) }
+    end
 
-          ignore %r{\.frontmatter$}
+    def after_configuration
+      app.extensions[:frontmatter] = self
+      app.ignore %r{\.frontmatter$}
 
-          sitemap.provides_metadata do |path|
-            fmdata = frontmatter_manager.data(path).first || {}
+      ::Middleman::Sitemap::Resource.send :include, ResourceInstanceMethods
 
-            data = {}
-            [:layout, :layout_engine].each do |opt|
-              data[opt] = fmdata[opt] unless fmdata[opt].nil?
-            end
+      app.sitemap.provides_metadata do |path|
+        fmdata = data(path).first
 
-            { :options => data, :page => ::Middleman::Util.recursively_enhance(fmdata).freeze }
-          end
+        data = {}
+        [:layout, :layout_engine].each do |opt|
+          data[opt] = fmdata[opt] unless fmdata[opt].nil?
         end
+
+        { :options => data, :page => ::Middleman::Util.recursively_enhance(fmdata).freeze }
       end
-      alias :included :registered
     end
-
-    class FrontmatterManager
-      attr_reader :app
-      delegate :logger, :to => :app
-
-      def initialize(app)
-        @app = app
-        @cache = {}
+    
+    module ResourceInstanceMethods
+      def ignored?
+        if !proxy? && raw_data[:ignored] == true
+          true
+        else
+          super
+        end
       end
 
-      def data(path)
-        p = normalize_path(path)
-        @cache[p] ||= begin
-          in_file = frontmatter_and_content(p)
+      # This page's frontmatter without being enhanced for access by either symbols or strings.
+      # Used internally
+      # @private
+      # @return [Hash]
+      def raw_data
+        app.extensions[:frontmatter].data(source_file).first
+      end
 
-          external_file = frontmatter_and_content("#{p}.frontmatter")
-          
-          return in_file if external_file.nil?
+      # This page's frontmatter
+      # @return [Hash]
+      def data
+        @enhanced_data ||= ::Middleman::Util.recursively_enhance(raw_data).freeze
+      end
 
-          [
-            external_file[0].deep_merge(in_file[0]),
-            in_file[1]
-          ]
+      # Override Resource#content_type to take into account frontmatter
+      def content_type
+        # Allow setting content type in frontmatter too
+        raw_data.fetch :content_type do
+          super
         end
       end
+    end
 
-      def clear_data(file)
-        # Copied from Sitemap::Store#file_to_path, but without
-        # removing the file extension
-        file = File.join(@app.root, file)
-        prefix = @app.source_dir.sub(/\/$/, "") + "/"
-        return unless file.include?(prefix)
-        path = file.sub(prefix, "").sub(/\.frontmatter$/, "")
-
-        @cache.delete(path)
+    helpers do
+      # Get the template data from a path
+      # @param [String] path
+      # @return [String]
+      def template_data_for_file(path)
+        extensions[:frontmatter].data(path).last
       end
+    end
 
-      YAML_ERRORS = [ StandardError ]
-
-      # https://github.com/tenderlove/psych/issues/23
-      if defined?(Psych) && defined?(Psych::SyntaxError)
-        YAML_ERRORS << Psych::SyntaxError
-      end
+    def data(path)
+      p = normalize_path(path)
+      @cache[p] ||= begin
+        data, content = frontmatter_and_content(p)
 
-      # Parse YAML frontmatter out of a string
-      # @param [String] content
-      # @return [Array<Hash, String>]
-      def parse_yaml_front_matter(content)
-        yaml_regex = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
-        if content =~ yaml_regex
-          content = content.sub(yaml_regex, "")
-
-          begin
-            data = YAML.load($1) || {}
-            data = data.symbolize_keys
-          rescue *YAML_ERRORS => e
-            logger.error "YAML Exception: #{e.message}"
-            return false
-          end
-        else
-          return false
+        if app.files.exists?("#{path}.frontmatter")
+          external_data, _ = frontmatter_and_content("#{p}.frontmatter")
+          data = external_data.deep_merge(data)
         end
 
         [data, content]
-      rescue
-        [{}, content]
       end
+    end
 
-      def parse_json_front_matter(content)
-        json_regex = /\A(;;;\s*\n.*?\n?)^(;;;\s*$\n?)/m
-
-        if content =~ json_regex
-          content = content.sub(json_regex, "")
+    def clear_data(file)
+      # Copied from Sitemap::Store#file_to_path, but without
+      # removing the file extension
+      file = File.join(app.root, file)
+      prefix = app.source_dir.sub(/\/$/, "") + "/"
+      return unless file.include?(prefix)
+      path = file.sub(prefix, "").sub(/\.frontmatter$/, "")
 
-          begin
-            json = ($1+$2).sub(";;;", "{").sub(";;;", "}")
-            data = ActiveSupport::JSON.decode(json).symbolize_keys
-          rescue => e
-            logger.error "JSON Exception: #{e.message}"
-            return false
-          end
+      @cache.delete(path)
+    end
 
-        else
+  private
+    # Parse YAML frontmatter out of a string
+    # @param [String] content
+    # @return [Array<Hash, String>]
+    def parse_yaml_front_matter(content)
+      yaml_regex = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      if content =~ yaml_regex
+        content = content.sub(yaml_regex, "")
+
+        begin
+          data = YAML.load($1) || {}
+          data = data.symbolize_keys
+        rescue *YAML_ERRORS => e
+          app.logger.error "YAML Exception: #{e.message}"
           return false
         end
-
-        [data, content]
-      rescue
-        [{}, content]
+      else
+        return false
       end
 
-      # Get the frontmatter and plain content from a file
-      # @param [String] path
-      # @return [Array<Thor::CoreExt::HashWithIndifferentAccess, String>]
-      def frontmatter_and_content(path)
-        full_path = if Pathname(path).relative?
-          File.join(@app.source_dir, path)
-        else
-          path
-        end
+      [data, content]
+    rescue
+      [{}, content]
+    end
 
-        return nil unless File.exists?(full_path)
-        
-        data = {}
-        content = nil
-
-        if !::Middleman::Util.binary?(full_path)
-          content = File.read(full_path)
-          
-          begin
-            if content =~ /\A.*coding:/
-              lines = content.split(/\n/)
-              lines.shift
-              content = lines.join("\n")
-            end
-
-            if result = parse_yaml_front_matter(content)
-              data, content = result
-            elsif result = parse_json_front_matter(content)
-              data, content = result
-            end
-          rescue
-            # Probably a binary file, move on
-          end
+    def parse_json_front_matter(content)
+      json_regex = /\A(;;;\s*\n.*?\n?)^(;;;\s*$\n?)/m
+
+      if content =~ json_regex
+        content = content.sub(json_regex, "")
+
+        begin
+          json = ($1+$2).sub(";;;", "{").sub(";;;", "}")
+          data = ActiveSupport::JSON.decode(json).symbolize_keys
+        rescue => e
+          app.logger.error "JSON Exception: #{e.message}"
+          return false
         end
 
-        [data, content]
+      else
+        return false
       end
 
-      def normalize_path(path)
-        path.sub(%r{^#{@app.source_dir}\/}, "")
-      end
+      [data, content]
+    rescue
+      [{}, content]
     end
 
-    module ResourceInstanceMethods
-
-      def ignored?
-        if !proxy? && data["ignored"] == true
-          true
-        else
-          super
-        end
+    # Get the frontmatter and plain content from a file
+    # @param [String] path
+    # @return [Array<Thor::CoreExt::HashWithIndifferentAccess, String>]
+    def frontmatter_and_content(path)
+      full_path = if Pathname(path).relative?
+        File.join(app.source_dir, path)
+      else
+        path
       end
 
-      # This page's frontmatter without being enhanced for access by either symbols or strings.
-      # Used internally
-      # @private
-      # @return [Hash]
-      def raw_data
-        app.frontmatter_manager.data(source_file).first
-      end
+      data = {}
 
-      # This page's frontmatter
-      # @return [Hash]
-      def data
-        ::Middleman::Util.recursively_enhance(raw_data).freeze
-      end
+      return [data, nil] if !app.files.exists?(full_path) || ::Middleman::Util.binary?(full_path)
 
-      # Override Resource#content_type to take into account frontmatter
-      def content_type
-        # Allow setting content type in frontmatter too
-        fm_type = data[:content_type]
-        return fm_type if fm_type
+      content = File.read(full_path)
+      
+      begin
+        if content =~ /\A.*coding:/
+          lines = content.split(/\n/)
+          lines.shift
+          content = lines.join("\n")
+        end
 
-        super
+        result = parse_yaml_front_matter(content) || parse_json_front_matter(content)
+        return result if result
+      rescue
+        # Probably a binary file, move on
       end
-    end
 
-    module InstanceMethods
-
-      # Access the Frontmatter API
-      def frontmatter_manager
-        @_frontmatter_manager ||= FrontmatterManager.new(self)
-      end
+      [data, content]
+    end
 
-      # Get the template data from a path
-      # @param [String] path
-      # @return [String]
-      def template_data_for_file(path)
-        frontmatter_manager.data(path).last
-      end
+    def normalize_path(path)
+      path.sub(%r{^#{app.source_dir}\/}, "")
     end
   end
 end

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

@@ -153,7 +153,7 @@ module Middleman
               content = render_individual_file(path, locs, opts, context)
               path = File.basename(path, File.extname(path))
             rescue LocalJumpError
-              raise "Tried to render a layout (calls yield) at #{path} like it was a template. Non-default layouts need to be in #{source}/layouts."
+              raise "Tried to render a layout (calls yield) at #{path} like it was a template. Non-default layouts need to be in #{source}/#{layout_dir}."
             end
           end
 
@@ -369,7 +369,7 @@ module Middleman
 
             # Check layouts folder
             if !layout_path
-              layout_path, layout_engine = resolve_template(File.join("layouts", name.to_s), :preferred_engine => preferred_engine)
+              layout_path, layout_engine = resolve_template(File.join(config[:layouts_dir], name.to_s), :preferred_engine => preferred_engine)
             end
           end
 
@@ -380,7 +380,7 @@ module Middleman
 
           # Check layouts folder, no preference
           if !layout_path
-            layout_path, layout_engine = resolve_template(File.join("layouts", name.to_s))
+            layout_path, layout_engine = resolve_template(File.join(config[:layouts_dir], name.to_s))
           end
 
           # Return the path
@@ -476,7 +476,7 @@ module Middleman
             end
 
             # If we found one, return it and the found engine
-            if found_path || (File.exists?(on_disk_path) && !File.directory?(on_disk_path))
+            if found_path || files.exists?(on_disk_path)
               engine = found_path ? File.extname(found_path)[1..-1].to_sym : nil
               [ found_path || on_disk_path, engine ]
             else

data/lib/middleman-core/core_extensions.rb

@@ -25,3 +25,66 @@ require "middleman-core/core_extensions/routing"
 
 # Catch and show exceptions at the Rack level
 require "middleman-core/core_extensions/show_exceptions"
+
+# Setup default helpers
+require "middleman-more/core_extensions/default_helpers"
+
+require "middleman-more/core_extensions/i18n"
+
+# Compass framework
+begin
+  require "middleman-more/core_extensions/compass"
+rescue LoadError
+  $stderr.puts "Compass not installed: #{$!}"
+end
+
+###
+# Setup Optional Extensions
+###
+
+# CacheBuster adds a query string to assets in dynamic templates to
+# avoid browser caches failing to update to your new content.
+require "middleman-more/extensions/cache_buster"
+Middleman::Extensions::CacheBuster.register
+
+# RelativeAssets allow any asset path in dynamic templates to be either
+# relative to the root of the project or use an absolute URL.
+require "middleman-more/extensions/relative_assets"
+Middleman::Extensions::RelativeAssets.register
+
+# AssetHost allows you to setup multiple domains to host your static
+# assets. Calls to asset paths in dynamic templates will then rotate
+# through each of the asset servers to better spread the load.
+require "middleman-more/extensions/asset_host"
+Middleman::Extensions::AssetHost.register
+
+# MinifyCss compresses CSS
+require "middleman-more/extensions/minify_css"
+Middleman::Extensions::MinifyCss.register
+
+# MinifyJavascript compresses JS
+require "middleman-more/extensions/minify_javascript"
+Middleman::Extensions::MinifyJavascript.register
+
+# GZIP assets and pages during build
+require "middleman-more/extensions/gzip"
+Middleman::Extensions::Gzip.register
+
+# AssetHash appends a hash of the file contents to the assets filename
+# to avoid browser caches failing to update to your new content.
+require "middleman-more/extensions/asset_hash"
+Middleman::Extensions::AssetHash.register
+
+# Provide Apache-style index.html files for directories
+require "middleman-more/extensions/directory_indexes"
+Middleman::Extensions::DirectoryIndexes.register
+
+# Lorem provides a handful of helpful prototyping methods to generate
+# words, paragraphs, fake images, names and email addresses.
+require "middleman-more/extensions/lorem"
+
+# AutomaticImageSizes inspects the images used in your dynamic templates
+# and automatically adds width and height attributes to their HTML
+# elements.
+require "middleman-more/extensions/automatic_image_sizes"
+Middleman::Extensions::AutomaticImageSizes.register

data/lib/middleman-core/extensions.rb

@@ -127,13 +127,39 @@ module Middleman
       def register(n=self.extension_name)
         ::Middleman::Extensions.register(n, self)
       end
+
+      def activate
+        new(::Middleman::Application)
+      end
     end
 
-    attr_accessor :app, :options
+    attr_accessor :options
+    attr_reader :app
 
-    def initialize(klass, options_hash={})
+    def initialize(klass, options_hash={}, &block)
       @_helpers = []
+      @klass = klass
+
+      setup_options(options_hash, &block)
+      setup_app_reference_when_available
+
+      # Bind app hooks to local methods
+      bind_before_configuration
+      bind_after_configuration
+      bind_after_build
+    end
+
+    def app=(app)
+      @app = app
+      
+      (self.class.defined_helpers || []).each do |m|
+        app.class.send(:include, m)
+      end
+    end
+
+  protected
 
+    def setup_options(options_hash, &block)
       @options = self.class.config.dup
       @options.finalize!
 
@@ -142,17 +168,32 @@ module Middleman
       end
 
       yield @options if block_given?
+    end
 
+    def setup_app_reference_when_available
       ext = self
-      klass.initialized do
+
+      @klass.initialized do
         ext.app = self
-        
-        (ext.class.defined_helpers || []).each do |m|
-          ext.app.class.send(:include, m)
+      end
+
+      @klass.instance_available do
+        ext.app ||= self
+      end
+    end
+
+    def bind_before_configuration
+      ext = self
+      if ext.respond_to?(:before_configuration)
+        @klass.before_configuration do
+          ext.before_configuration
         end
       end
+    end
 
-      klass.after_configuration do
+    def bind_after_configuration
+      ext = self
+      @klass.after_configuration do
         if ext.respond_to?(:after_configuration)
           ext.after_configuration
         end
@@ -162,5 +203,18 @@ module Middleman
         end
       end
     end
+
+    def bind_after_build
+      ext = self
+      if ext.respond_to?(:after_build)
+        @klass.after_build do |builder|
+          if ext.method(:after_build).arity === 1
+            ext.after_build(builder)
+          else
+            ext.after_build
+          end
+        end
+      end
+    end
   end
 end