middleman 0.9.4 → 0.9.5

data/VERSION

@@ -1 +1 @@
-0.9.4
+0.9.5

data/bin/mm-server

@@ -1,9 +1,19 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
+
 # Require Middleman
 require File.join(File.dirname(__FILE__), '..', 'lib', 'middleman')
 
-# Start Middleman
-Middleman::Base.set({ :server => %w[thin webrick],
-                      :root   => Dir.pwd })
-Middleman::Base.run!
+class Middleman::Base
+  set :root, Dir.pwd
+
+  OptionParser.new { |op|
+    op.on('-e env')    { |val| set :environment, val.to_sym }
+    op.on('-s server') { |val| set :server, val }
+    op.on('-p port')   { |val| set :port, val.to_i }
+  }.parse!(ARGV.dup)
+
+  # Start Middleman
+  run!
+end

data/lib/middleman/base.rb

@@ -1,8 +1,10 @@
+# Be nice to other library systems, like the wonderful Rip
 require 'rubygems' unless ENV['NO_RUBYGEMS']
-require 'haml'
+
+# We're riding on Sinatra, so let's include it
 require 'sinatra/base'
-require 'middleman/helpers'
 
+# Rack helper for adding mime-types during local preview
 def mime(ext, type)
   ext = ".#{ext}" unless ext.to_s[0] == ?.
   Rack::Mime::MIME_TYPES[ext.to_s] = type
@@ -15,14 +17,19 @@ module Middleman
     set :environment, ENV['MM_ENV'] || :development
     set :supported_formats, []
     set :index_file, 'index.html'
+    set :js_dir, "javascripts"
     set :css_dir, "stylesheets"
     set :images_dir, "images"
     set :build_dir, "build"
+    set :http_prefix, "/"
 
+    # Features enabled by default
     enable :compass
     enable :content_for
     enable :sprockets
-    #enable :slickmap
+    
+    # Features disabled by default
+    disable :slickmap
     disable :cache_buster
     disable :minify_css
     disable :minify_javascript
@@ -30,17 +37,14 @@ module Middleman
     disable :markaby
     disable :maruku
     
-    # include helpers
-    helpers Middleman::Helpers
-    
     # Default build features
     configure :build do
       enable :minify_css
       enable :minify_javascript
       enable :cache_buster
-      # disable :slickmap
     end
   
+    # Convenience function to discover if a tempalte exists for the requested renderer (haml, sass, etc)
     def template_exists?(path, renderer=nil)
       template_path = path.dup
       template_path << ".#{renderer}" if renderer
@@ -55,21 +59,25 @@ module Middleman
     end
     include StaticRender
   
-    # All other files
+    # Disable static asset handling in Rack, so we can customize it here
     disable :static
+    
+    # This will match all requests not overridden in the project's init.rb
     not_found do
+      # Normalize the path and add index if we're looking at a directory
       path = request.path
       path << options.index_file if path.match(%r{/$})
       path.gsub!(%r{^/}, '')
     
+      # If the enabled renderers succeed, return the content, mime-type and an HTTP 200
       if content = render_path(path)
         content_type media_type(File.extname(path)), :charset => 'utf-8'
         status 200
         content
       else
-        # Otherwise, send the static file
+        # If no template handler renders the template, return the static file if it exists
         path = File.join(options.public, request.path)
-        if File.exists?(path)
+        if !File.directory?(path) && File.exists?(path)
           status 200
           send_file(path)
         else
@@ -78,6 +86,8 @@ module Middleman
       end
     end
     
+    # Copy, pasted & edited version of the setup in Sinatra.
+    # Basically just changed the app's name and call out feature & configuration init.
     def self.run!(options={}, &block)
       init!
       set options
@@ -101,15 +111,21 @@ module Middleman
       puts "== The Middleman is already standing watch on port #{port}!"
     end
     
+    # Require the features for this project
     def self.init!
-      # Check for local config
+      # Built-in helpers
+      require 'middleman/helpers'
+      helpers Middleman::Helpers
+
+      # Haml is required & includes helpers
+      require "middleman/features/haml"
+      
+      # Check for and evaluate local configuration
       local_config = File.join(self.root, "init.rb")
       if File.exists? local_config
         puts "== Local config at: #{local_config}"
         class_eval File.read(local_config)
       end
-
-      require "middleman/features/haml"
       
       # loop over enabled feature
       features_path = File.expand_path("features/*.rb", File.dirname(__FILE__))

data/lib/middleman/builder.rb

@@ -1,7 +1,10 @@
+# Use Rack::Test to access Sinatra without starting up a full server
 require 'rack/test'
 
+# Placeholder for any methods the builder needs to abstract to allow feature integration
 module Middleman
   class Builder
+    # The default render just requests the page over Rack and writes the response
     def self.render_file(source, destination)      
       request_path = destination.gsub(File.join(Dir.pwd, Middleman::Base.build_dir), "")
       browser = Rack::Test::Session.new(Rack::MockSession.new(Middleman::Base))

data/lib/middleman/features/cache_buster.rb

@@ -1,9 +1,18 @@
-
-
-# def cache_buster
-#   if File.readable?(real_path)
-#     File.mtime(real_path).strftime("%s") 
-#   else
-#     $stderr.puts "WARNING: '#{File.basename(path)}' was not found (or cannot be read) in #{File.dirname(real_path)}"
-#   end
-# end
+class Middleman::Base
+  helpers do
+    alias_method :pre_cache_buster_asset_url, :asset_url
+    def asset_url(path, prefix="")
+      path = pre_cache_buster_asset_url(path, prefix)
+      if path.include?("://")
+        path
+      else
+        real_path = File.join(options.public, path)
+        if File.readable?(real_path)
+          path << "?" + File.mtime(real_path).strftime("%s")
+        else
+          $stderr.puts "WARNING: '#{File.basename(path)}' was not found (or cannot be read) in #{File.dirname(real_path)}"
+        end
+      end
+    end
+  end
+end

data/lib/middleman/features/compass.rb

@@ -17,9 +17,9 @@ class Middleman::Base
           false
         end
       end
-    
-      config.http_images_path = "/#{self.images_dir}"
-      config.http_stylesheets_path = "/#{self.css_dir}"
+        
+      config.http_images_path = File.join(self.http_prefix, self.images_dir)
+      config.http_stylesheets_path = File.join(self.http_prefix, self.css_dir)
       config.add_import_path(config.sass_dir)
     end
     

data/lib/middleman/features/haml.rb

@@ -1,3 +1,5 @@
+require 'haml'
+
 module Middleman
   module Haml
     def self.included(base)
@@ -70,7 +72,7 @@ module Middleman
           static_version = options.public + request.path_info
           send_file(static_version) if File.exists? static_version
 
-          location_of_sass_file = options.environment == "build" ? "build" : "views"
+          location_of_sass_file = options.environment == "build" ? "build" : "public"
           css_filename = File.join(Dir.pwd, location_of_sass_file) + request.path_info
           sass(path.to_sym, Compass.sass_engine_options.merge({ :css_filename => css_filename }))
         rescue Exception => e

data/lib/middleman/features/relative_assets.rb

@@ -8,12 +8,15 @@ class Middleman::Base
   end
   
   helpers do
-    def asset_url(path)
+    alias_method :pre_relative_asset_url, :asset_url
+    def asset_url(path, prefix="")
+      path = pre_relative_asset_url(path, prefix)
       if path.include?("://")
         path
       else
+        path = path[1,path.length-1] if path[0,1] == '/'
         request_path = request.path_info.dup
-        request_path << "index.html" if path.match(%r{/$})
+        request_path << options.index_file if path.match(%r{/$})
         request_path.gsub!(%r{^/}, '')
         parts = request_path.split('/')
       

data/lib/middleman/features/slickmap.rb

@@ -1,5 +1,24 @@
 require 'slickmap'
 
-get '/sitemap.html' do
-  haml :sitemap, :layout => false
-end
+class Middleman::Base
+  def build_sitemap(&block)
+    # views - stylesheets
+    # public
+    # .select
+    #   block.call(this)
+  end
+  
+  get '/sitemap.html' do
+    @tree = build_sitemap do |file_name|
+      true
+    end
+    haml :sitemap, :layout => false
+  end
+
+  use_in_file_templates!
+end
+
+__END__
+
+@@ sitemap
+%div.title Hello world!!!!!

data/lib/middleman/helpers.rb

@@ -2,7 +2,7 @@ module Middleman
   module Helpers
     def page_classes(*additional)
       path = request.path_info
-      path << "index.html" if path.match(%r{/$})
+      path << options.index_file if path.match(%r{/$})
       path.gsub!(%r{^/}, '')
   
       classes = []
@@ -20,26 +20,27 @@ module Middleman
       %Q{<a #{params}>#{title}</a>}
     end
     
-    def asset_url(path)
-      path.include?("://") ? path : "/#{path}"
+    def asset_url(path, prefix="")
+      base_url = File.join(options.http_prefix, prefix)
+      path.include?("://") ? path : File.join(base_url, path)
     end
 
-    def image_tag(path, options={})
-      options[:alt] ||= ""
-      params = options.merge(:src => asset_url(path))
+    def image_tag(path, params={})
+      params[:alt] ||= ""
+      params = params.merge(:src => asset_url(path, options.images_dir))
       params = params.map { |k,v| %Q{#{k}="#{v}"}}.join(' ')
       "<img #{params} />"
     end
 
-    def javascript_include_tag(path, options={})
-      params = options.merge(:src => asset_url(path), :type => "text/javascript")
+    def javascript_include_tag(path, params={})
+      params = params.merge(:src => asset_url(path, options.js_dir), :type => "text/javascript")
       params = params.map { |k,v| %Q{#{k}="#{v}"}}.join(' ')
       "<script #{params}></script>"
     end
 
-    def stylesheet_link_tag(path, options={})
-      options[:rel] ||= "stylesheet"
-      params = options.merge(:href => asset_url(path), :type => "text/css")
+    def stylesheet_link_tag(path, params={})
+      params[:rel] ||= "stylesheet"
+      params = params.merge(:href => asset_url(path, options.css_dir), :type => "text/css")
       params = params.map { |k,v| %Q{#{k}="#{v}"}}.join(' ')
       "<link #{params} />"
     end

data/lib/middleman/template/init.rb

@@ -2,21 +2,17 @@
 helpers do
 end
 
-# Or inject more templating languages
-# helpers Sinatra::Markdown
+# Generic configuration
+# enable :slickmap
 
 # Build-specific configuration
 configure :build do
-  Compass.configuration do |config|
-    # For example, change the Compass output style for deployment
-    # config.output_style = :compressed
-    
-    # Or use a different image path
-    # config.http_images_path = "/Content/images/"
-    
-    # Disable cache buster
-    # config.asset_cache_buster do
-    #   false
-    # end
-  end
+  # For example, change the Compass output style for deployment
+  # enable :minified_css
+  
+  # Or use a different image path
+  # set :http_path, "/Content/images/"
+  
+  # Disable cache buster
+  # disable :cache_buster
 end

data/lib/middleman/template/views/index.haml

@@ -1 +1,4 @@
+- content_for :head do
+  %title Custom head title
+
 %h1 The Middleman is watching.

data/lib/middleman/template/views/layout.haml

@@ -1,6 +1,7 @@
 %html
   %head
     %title The Middleman!
+    = yield_content :head
     
   %body
     = yield

data/middleman.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{middleman}
-  s.version = "0.9.4"
+  s.version = "0.9.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thomas Reynolds"]
-  s.date = %q{2009-09-30}
+  s.date = %q{2009-10-01}
   s.email = %q{tdreyno@gmail.com}
   s.executables = ["mm-init", "mm-build", "mm-server"]
   s.extra_rdoc_files = [
@@ -50,6 +50,7 @@ Gem::Specification.new do |s|
      "lib/middleman/template/views/stylesheets/site.sass",
      "middleman.gemspec",
      "spec/builder_spec.rb",
+     "spec/cache_buster_spec.rb",
      "spec/fixtures/sample/init.rb",
      "spec/fixtures/sample/public/javascripts/empty-with-include.js",
      "spec/fixtures/sample/public/javascripts/to-be-included.js",
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
      "spec/fixtures/sample/views/services/index.html.haml",
      "spec/fixtures/sample/views/stylesheets/site.css.sass",
      "spec/generator_spec.rb",
+     "spec/relative_assets_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.has_rdoc = true
@@ -75,8 +77,10 @@ Gem::Specification.new do |s|
   s.summary = %q{A static site generator utilizing Haml, Sass and providing YUI compression and cache busting}
   s.test_files = [
     "spec/builder_spec.rb",
+     "spec/cache_buster_spec.rb",
      "spec/fixtures/sample/init.rb",
      "spec/generator_spec.rb",
+     "spec/relative_assets_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/cache_buster_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+base = ::Middleman::Base
+base.set :root, File.join(File.dirname(__FILE__), "fixtures", "sample")
+
+describe "Cache Buster Feature" do
+  before do
+    base.disable :cache_buster
+    base.init!
+    @app = base.new
+  end
+  
+  it "should not append query string if off" do
+    @app.asset_url("stylesheets/static.css").should_not include("?")
+  end
+end
+
+describe "Cache Buster Feature" do
+  before do
+    base.enable :cache_buster
+    base.init!
+    @app = base.new
+  end
+
+  it "should append query string if on" do
+    @app.asset_url("stylesheets/static.css").should include("?")
+  end
+end

data/spec/relative_assets_spec.rb

@@ -0,0 +1,28 @@
+# require File.join(File.dirname(__FILE__), "spec_helper")
+# 
+# base = ::Middleman::Base
+# base.set :root, File.join(File.dirname(__FILE__), "fixtures", "sample")
+# 
+# describe "Relative Assets Feature" do
+#   before do
+#     base.disable :relative_assets
+#     base.init!
+#     @app = base.new
+#   end
+#   
+#   it "should not contain ../ if off" do
+#     @app.asset_url("stylesheets/static.css").should_not include("?")
+#   end
+# end
+# 
+# describe "Relative Assets Feature" do
+#   before do
+#     base.enable :relative_assets
+#     base.init!
+#     @app = base.new
+#   end
+#   
+#   it "should contain ../ if on" do
+#     @app.asset_url("stylesheets/static.css").should include("?")
+#   end
+# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: middleman
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors: 
 - Thomas Reynolds
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-30 00:00:00 -07:00
+date: 2009-10-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -137,6 +137,7 @@ files:
 - lib/middleman/template/views/stylesheets/site.sass
 - middleman.gemspec
 - spec/builder_spec.rb
+- spec/cache_buster_spec.rb
 - spec/fixtures/sample/init.rb
 - spec/fixtures/sample/public/javascripts/empty-with-include.js
 - spec/fixtures/sample/public/javascripts/to-be-included.js
@@ -151,6 +152,7 @@ files:
 - spec/fixtures/sample/views/services/index.html.haml
 - spec/fixtures/sample/views/stylesheets/site.css.sass
 - spec/generator_spec.rb
+- spec/relative_assets_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://wiki.github.com/tdreyno/middleman
@@ -180,6 +182,8 @@ specification_version: 2
 summary: A static site generator utilizing Haml, Sass and providing YUI compression and cache busting
 test_files: 
 - spec/builder_spec.rb
+- spec/cache_buster_spec.rb
 - spec/fixtures/sample/init.rb
 - spec/generator_spec.rb
+- spec/relative_assets_spec.rb
 - spec/spec_helper.rb