middleman 3.0.0.alpha.3 → 3.0.0.alpha.4

data/lib/middleman/base.rb

@@ -11,7 +11,7 @@ require "middleman/vendor/hooks-0.2.0/lib/hooks"
 require "active_support"
 require "active_support/json"
 require "active_support/core_ext/string/inflections"
-
+  
 # Core Middleman Class
 class Middleman::Base
   # Uses callbacks
@@ -59,7 +59,17 @@ class Middleman::Base
     # @return [Rack::Builder]
     def to_rack_app(&block)
       inner_app = inst(&block)
+      
+      (@middleware || []).each do |m|
+        app.use(m[0], *m[1], &m[2])
+      end
+      
       app.map("/") { run inner_app }
+      
+      (@mappings || []).each do |m|
+        app.map(m[0], &m[1])
+      end
+      
       app
     end
     
@@ -82,14 +92,16 @@ class Middleman::Base
     #
     # @param [Class] Middleware
     def use(middleware, *args, &block)
-      app.use(middleware, *args, &block)
+      @middleware ||= []
+      @middleware << [middleware, args, block]
     end
     
     # Add Rack App mapped to specific path
     #
     # @param [String] Path to map
     def map(map, &block)
-      app.map(map, &block)
+      @mappings ||= []
+      @mappings << [map, block]
     end
     
     # Mix-in helper methods. Accepts either a list of Modules
@@ -117,7 +129,7 @@ class Middleman::Base
     end
   end
   
-  # Set attributes
+  # Set attributes (global variables)
   #
   # @param [Symbol] Name of the attribue
   # @param Attribute value
@@ -129,47 +141,65 @@ class Middleman::Base
   end
   
   # Root project directory (overwritten in middleman build/server)
+  # @return [String]
   set :root,        Dir.pwd
   
   # Name of the source directory
+  # @return [String]
   set :source,      "source"
   
-  # Set the environment from the environment. Defaults to :development, set
-  # to :build by the build process
+  # Middleman environment. Defaults to :development, set to :build by the build process
+  # @return [String]
   set :environment, (ENV['MM_ENV'] && ENV['MM_ENV'].to_sym) || :development
   
-  # Disable logging by default
+  # Whether logging is active, disabled by default
+  # @return [String]
   set :logging, false
 
   # Which file should be used for directory indexes
+  # @return [String]
   set :index_file,  "index.html"
 
   # Location of javascripts within source. Used by Sprockets.
+  # @return [String]
   set :js_dir,      "javascripts"
   
   # Location of stylesheets within source. Used by Compass.
+  # @return [String]
   set :css_dir,     "stylesheets"
   
   # Location of images within source. Used by HTML helpers and Compass.
+  # @return [String]
   set :images_dir,  "images"
 
   # Where to build output files
+  # @return [String]
   set :build_dir,   "build"
   
   # Default prefix for building paths. Used by HTML helpers and Compass.
+  # @return [String]
   set :http_prefix, "/"
 
+  # Whether to catch and display exceptions
+  # @return [Boolean]
+  set :show_exceptions, true
+
   # Automatically loaded extensions
+  # @return [Array<Symbol>]
   set :default_extensions, [
     :lorem,
     # :sitemap_tree
   ]
 
   # Default layout name
+  # @return [String, Symbold]
   set :layout, :_auto_layout
   
   # Activate custom features and extensions
   include Middleman::CoreExtensions::Extensions
+  
+  # Handle exceptions
+  register Middleman::CoreExtensions::ShowExceptions
     
   # Add Builder Callbacks
   register Middleman::CoreExtensions::Builder
@@ -224,18 +254,30 @@ class Middleman::Base
   Middleman::Extensions.register(:sitemap_tree) { 
     Middleman::Extensions::SitemapTree }
   
+  # Backwards-compatibility with old request.path signature
+  attr :request
+  
   # Accessor for current path
-  attr_accessor :current_path
-    
+  # @return [String]
+  def current_path
+    @_current_path
+  end
+  
+  def current_path=(path)
+    @_current_path = path
+    @request = Thor::CoreExt::HashWithIndifferentAccess.new({ :path => path })
+  end
+  
   # Initialize the Middleman project
   def initialize(&block)
     # Current path defaults to nil, used in views.
-    @current_path = nil
+    self.current_path = nil
     
+    # Clear the static class cache
     cache.clear
     
     # Setup the default values from calls to set before initialization
-    self.class.superclass.defaults.each { |k,v| set k,v }
+    self.class.superclass.defaults.each { |k,v| set(k,v) }
     
     # Evaluate a passed block if given
     instance_exec(&block) if block_given?
@@ -266,9 +308,11 @@ class Middleman::Base
   attr :env
   
   # Rack request
+  # @return [Rack::Request]
   attr :req
   
   # Rack response
+  # @return [Rack::Response]
   attr :res
   
   # Rack Interface
@@ -342,7 +386,7 @@ class Middleman::Base
     return send_file(sitemap_page.source_file) unless sitemap_page.template?
     
     # Set the current path for use in helpers
-    @current_path = @request_path.dup
+    self.current_path = @request_path.dup
       
     # Set a HTTP content type based on the request's extensions
     content_type sitemap_page.mime_type

data/lib/middleman/builder.rb

@@ -30,20 +30,26 @@ module Middleman
     
     # @private
     module ThorActions
+      # Render a template to a file.
+      # @return [String] the actual destination file path that was created
       def tilt_template(source, *args, &block)
         config = args.last.is_a?(Hash) ? args.pop : {}
         destination = args.first || source
 
         request_path = destination.sub(/^#{::Middleman::Builder.shared_instance.build_dir}/, "")
 
-        # begin
+        begin
           destination, request_path = ::Middleman::Builder.shared_instance.reroute_builder(destination, request_path)
 
           response = ::Middleman::Builder.shared_rack.get(request_path.gsub(/\s/, "%20"))
-          create_file(destination, response.body, config) if response.status == 200
-        # rescue
-          # say_status :error, destination, :red
-        # end
+
+          create_file(destination, response.body, config)
+
+          destination
+        rescue
+          say_status :error, destination, :red
+          abort
+        end
       end
     end
     include ThorActions
@@ -130,11 +136,11 @@ module Middleman
     def queue_current_paths
       @cleaning_queue = []
       Find.find(@destination) do |path|
-        next if path.match(/\/\./)
+        next if path.match(/\/\./) && !path.match(/\.htaccess/)
         unless path == destination
           @cleaning_queue << path.sub(@destination, destination[/([^\/]+?)$/])
         end
-      end
+      end if File.exist?(@destination)
     end
     
     def execute!
@@ -154,7 +160,7 @@ module Middleman
         file_source = path
         file_destination = File.join(given_destination, file_source.gsub(source, '.'))
         file_destination.gsub!('/./', '/')
-        
+
         if @app.sitemap.generic?(file_source)
           # no-op
         elsif @app.sitemap.proxied?(file_source)
@@ -163,14 +169,14 @@ module Middleman
           next
         end
         
-        @cleaning_queue.delete(file_destination) if cleaning?
-        
         if @config[:glob]
           next unless File.fnmatch(@config[:glob], file_source)
         end
         
-        base.tilt_template(file_source, file_destination, { :force => true })
+        file_destination = base.tilt_template(file_source, file_destination, { :force => true })
+
+        @cleaning_queue.delete(file_destination) if cleaning?
       end
     end
   end
-end
+end

data/lib/middleman/cli.rb

@@ -16,7 +16,7 @@ module Middleman
     end
 
     desc "init NAME [options]", "Create new project NAME"
-    available_templates = Middleman::Templates.registered_names.join(", ")
+    available_templates = Middleman::Templates.registered.keys.join(", ")
     method_option "template", 
       :aliases => "-T", 
       :default => "default",
@@ -40,11 +40,11 @@ module Middleman
       :desc    => 'Create a Gemfile and use Bundler to manage gems'
     def init(name)
       key = options[:template].to_sym
-      unless Middleman::Templates.registered_templates.has_key?(key)
-        key = :default
+      unless Middleman::Templates.registered.has_key?(key)
+        raise Thor::Error.new "Unknown project template '#{key}'"
       end
       
-      thor_group = Middleman::Templates.registered_templates[key]
+      thor_group = Middleman::Templates.registered[key]
       thor_group.new([name], options).invoke_all
     end
 
@@ -120,4 +120,4 @@ module Middleman
       exit 0
     end
   end
-end
+end

data/lib/middleman/core_extensions/assets.rb

@@ -1,16 +1,28 @@
+# Base helper to manipulate asset paths
 module Middleman::CoreExtensions::Assets
+  
+  # Extension registered
   class << self
+    # @private
     def registered(app)
       # Disable Padrino cache buster
       app.set :asset_stamp, false
       
+      # Include helpers
       app.send :include, InstanceMethod
     end
     alias :included :registered
   end
   
+  # Methods to be mixed-in to Middleman::Base
   module InstanceMethod
+    
+    # Get the URL of an asset given a type/prefix
+    #
+    # @param [String] path The path (such as "photo.jpg")
+    # @param [String] prefix The type prefix (such as "images")
     def asset_url(path, prefix="")
+      # Don't touch assets which already have a full path
       path.include?("://") ? path : File.join(http_prefix, prefix, path)
     end
   end

data/lib/middleman/core_extensions/builder.rb

@@ -20,11 +20,11 @@ module Middleman::CoreExtensions::Builder
       self.class.build_reroute(&block)
     end
     
-    def reroute_builder(desination, request_path)
-      result = [desination, request_path]
+    def reroute_builder(destination, request_path)
+      result = [destination, request_path]
       
       build_reroute.each do |block|
-        output = instance_exec(desination, request_path, &block)
+        output = instance_exec(destination, request_path, &block)
         if output
           result = output
           break
@@ -34,4 +34,4 @@ module Middleman::CoreExtensions::Builder
       result
     end
   end
-end
+end

data/lib/middleman/core_extensions/extensions.rb

@@ -43,55 +43,6 @@ module Middleman::CoreExtensions::Extensions
       
       app.extend ClassMethods
       app.send :include, InstanceMethods
-      
-      # Setup extension API
-      ::Middleman::Extensions.extend API
-    end
-  end
-
-  module API
-    def registered
-      @_registered ||= {}
-    end
-    
-    def register(name, namespace=nil, version=nil, &block)
-      # If we've already got a matching extension that passed the 
-      # version check, bail out.
-      return if registered.has_key?(name.to_sym) && 
-      !registered[name.to_sym].is_a?(String)
-      
-      if block_given?
-        version = namespace
-      end
-      
-      passed_version_check = true
-      if !version.nil?
-        requirement = ::Gem::Requirement.create(version)
-        if !requirement.satisfied_by?(Middleman::GEM_VERSION)
-          passed_version_check = false
-        end
-      end
-      
-      registered[name.to_sym] = if !passed_version_check
-        "== #{name} failed version check. Requested #{version}, got #{Middleman::VERSION}"
-      elsif block_given?
-        block
-      elsif namespace
-        namespace
-      end
-    end
-    
-    def load(name)
-      name = name.to_sym
-      return nil unless registered.has_key?(name)
-      
-      extension = registered[name]
-      if extension.is_a?(Proc)
-        extension = extension.call() || nil
-        registered[name] = extension
-      end
-      
-      extension
     end
   end
 
@@ -140,9 +91,12 @@ module Middleman::CoreExtensions::Extensions
     # Load features before starting server
     def initialize
       super
-    
+      
       run_hook :before_configuration
     
+      # Search the root of the project for required files
+      $LOAD_PATH.unshift(root)
+      
       # Check for and evaluate local configuration
       local_config = File.join(root, "config.rb")
       if File.exists? local_config
@@ -157,7 +111,7 @@ module Middleman::CoreExtensions::Extensions
       
       # Add in defaults
       default_extensions.each do |ext|
-        # activate ext
+        activate ext
       end
       
       if logging?

data/lib/middleman/core_extensions/front_matter.rb

@@ -4,28 +4,41 @@ require "tilt"
 module Middleman::CoreExtensions::FrontMatter
   class << self
     def registered(app)
+      app.set :frontmatter_extensions, %w(.htm .html .php)
+      app.extend ClassMethods
       app.send :include, InstanceMethods
     end
     alias :included :registered
   end
   
+  module ClassMethods
+    def frontmatter_changed(matcher=nil, &block)
+      @_frontmatter_changed ||= []
+      @_frontmatter_changed << [block, matcher] if block_given?
+      @_frontmatter_changed
+    end
+  end
+  
   module InstanceMethods
     def initialize
       super
       
-      file_changed FrontMatter.matcher do |file|
+      exts = frontmatter_extensions.join("|").gsub(".", "\.")
+      matcher = %r{source/.*(#{exts})}
+      
+      file_changed matcher do |file|
         frontmatter.touch_file(file)
       end
 
-      file_deleted do |file|
+      file_deleted matcher do |file|
         frontmatter.remove_file(file)
       end
 
-      provides_metadata FrontMatter.matcher do |path|
+      provides_metadata matcher do |path|
         relative_path = path.sub(source_dir, "")
 
         data = if frontmatter.has_data?(relative_path)
-          frontmatter.data(relative_path).first
+          frontmatter.data(relative_path)[0]
         else
           {}
         end
@@ -41,7 +54,18 @@ module Middleman::CoreExtensions::FrontMatter
 
         { :options => data }
       end
+    end
+    
+    def frontmatter_changed(*args, &block)
+      self.class.frontmatter_changed(*args, &block)
+    end
 
+    def frontmatter_did_change(path)
+      frontmatter_changed.each do |callback, matcher|
+        next if path.match(%r{^#{build_dir}/})
+        next if !matcher.nil? && !path.match(matcher)
+        instance_exec(path, &callback)
+      end
     end
     
     def frontmatter
@@ -50,12 +74,6 @@ module Middleman::CoreExtensions::FrontMatter
   end
   
   class FrontMatter
-    class << self
-      def matcher
-        %r{source/.*\.html}
-      end
-    end
-    
     def initialize(app)
       @app = app
       @source = File.expand_path(@app.source, @app.root)
@@ -81,6 +99,7 @@ module Middleman::CoreExtensions::FrontMatter
         @local_data[file] = result
         path = File.join(@app.source_dir, file)
         @app.cache.set([:raw_template, path], result[1])
+        @app.frontmatter_did_change(path)
       end
     end
     
@@ -121,4 +140,4 @@ module Middleman::CoreExtensions::FrontMatter
       [data, content]
     end
   end
-end
+end