middleman 1.1.0.beta.4 → 1.1.0.beta.5

data/.gitignore

@@ -6,3 +6,4 @@ pkg
 .sassc
 .tmp
 Gemfile.lock
+docs

data/Rakefile

@@ -7,4 +7,48 @@ Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
   t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
 end
 
+#$LOAD_PATH.unshift 'lib'
+
+require 'rake/testtask'
+require 'rake/clean'
+
 task :test => :cucumber
+
+# rocco depends on rdiscount, which makes me sad.
+unless defined?(JRUBY_VERSION)
+  # Bring in Rocco tasks
+  require 'rocco/tasks'
+  Rocco::make 'docs/'
+
+  desc 'Build rocco docs'
+  task :docs => :rocco
+  directory 'docs/'
+
+  # Make index.html a copy of rocco.html
+  file 'docs/index.html' => 'docs/middleman.html' do |f|
+    cp 'docs/middleman.html', 'docs/index.html', :preserve => true
+  end
+  task :docs => 'docs/index.html'
+  CLEAN.include 'docs/index.html'
+
+  desc 'Update gh-pages branch'
+  task :pages => ['docs/.git', :docs] do
+    rev = `git rev-parse --short HEAD`.strip
+    Dir.chdir 'docs' do
+      sh "git add *.html"
+      sh "git commit -m 'rebuild pages from #{rev}'" do |ok,res|
+        if ok
+          verbose { puts "gh-pages updated" }
+          sh "git push -q o HEAD:gh-pages"
+        end
+      end
+    end
+  end
+
+  # Update the pages/ directory clone
+  file 'docs/.git' => ['docs/', '.git/refs/heads/gh-pages'] do |f|
+    sh "cd docs && git init -q && git remote add o ../.git" if !File.exist?(f.name)
+    sh "cd docs && git fetch -q o && git reset -q --hard o/gh-pages && touch ."
+  end
+  CLOBBER.include 'docs/.git'
+end

data/bin/mm-init

@@ -7,24 +7,32 @@ module Middleman
   class Generator < ::Thor::Group
     include Thor::Actions
     
+    argument :location, :type => :string, :desc => "New project location"
+    
+    class_option :template, :aliases => "-T", :default => "default", :desc => 'Optionally use a pre-defined project template: html5, default'
+    
     def self.source_root
-      File.join(File.dirname(__FILE__), '..', 'lib', 'middleman', 'template')
+      File.join(File.dirname(__FILE__), '..', 'lib', 'middleman', 'templates')
     end
     
-    argument :location, :type => :string, :desc => "New project location"
-    
     class_option :css_dir, :default => "stylesheets", :desc => 'The path to the css files'
     class_option :js_dir, :default => "javascripts", :desc => 'The path to the javascript files'
     class_option :images_dir, :default => "images", :desc => 'The path to the image files'
     
     def create_project
-      template "config.tt", File.join(location, "config.rb")
-      directory "views", File.join(location, "views")
-      empty_directory File.join(location, "public", options[:css_dir])
-      empty_directory File.join(location, "public", options[:js_dir])
-      empty_directory File.join(location, "public", options[:images_dir])
+      if options[:template] == "html5"
+        template "html5boilerplate/config.tt", File.join(location, "config.rb")
+        directory "html5boilerplate/public", File.join(location, "public")
+        empty_directory File.join(location, "views")
+      else
+        template "default/config.tt", File.join(location, "config.rb")
+        directory "default/views", File.join(location, "views")
+        empty_directory File.join(location, "public", options[:css_dir])
+        empty_directory File.join(location, "public", options[:js_dir])
+        empty_directory File.join(location, "public", options[:images_dir])
+      end
     end
   end
 end
 
-Middleman::Generator.start
+Middleman::Generator.start

data/bin/mm-server

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # Non-blocking site rebuilding
-trap("TSTP") do 
+trap("TSTP") do
   fork do
     require "open3"
     first_run = true
@@ -38,7 +38,7 @@ OptionParser.new { |opts|
   opts.on("--debug", "Debug mode") {
     ::Middleman::Server.set :logging, true
   }
-  
+
   opts.parse! ARGV
 }
 
@@ -54,9 +54,16 @@ end
 app = Middleman::Server.new
 
 require 'rubygems'
-require 'thin'
-Thin::Logging.silent = true
 
-Rack::Handler::Thin.run app, options do |inst|
+unless defined?(JRUBY_VERSION)
+  require 'thin'
+  handler = Rack::Handler::Thin
+else
+  require 'kirk'
+  require 'rack/handler/kirk'
+  handler = Rack::Handler::Kirk
+end
+
+handler.run app, options do |inst|
   puts "== The Middleman is standing watch on port #{options[:Port]}"
-end
+end

data/lib/middleman.rb

@@ -1,15 +1,74 @@
+# Middleman is a static site renderer that provides all the conveniences of
+# a modern web stack, like Ruby on Rails, while remaining focused on building
+# the fastest, most-professional sites possible
+#
+# Install Middleman:
+#
+#     gem install middleman
+#
+# To accomplish its goals, Middleman supports provides access to:
+# 
+#### Command-line tools:
+# * **mm-init**: A tool for creating to new static sites.
+# * **mm-server**: A tool for rapidly developing your static site.
+# * **mm-build**: A tool for exporting your site into optimized HTML, CSS & JS.
+#
+#### Tons of templating languages including:
+# * ERB                        (.erb)
+# * Interpolated String        (.str)
+# * Sass                       (.sass)
+# * Scss                       (.scss)
+# * Haml                       (.haml)
+# * Sass                       (.sass)
+# * Less CSS                   (.less)
+# * Builder                    (.builder)
+# * Liquid                     (.liquid)
+# * RDiscount                  (.markdown)
+# * RedCloth                   (.textile)
+# * RDoc                       (.rdoc)
+# * Radius                     (.radius)
+# * Markaby                    (.mab)
+# * Nokogiri                   (.nokogiri)
+# * Mustache                   (.mustache)
+# * CoffeeScript               (.coffee)
+#
+#### Compile-time Optimiztions
+# * Javascript Minifiers: YUI, Google Closure & UglifyJS
+# * Smush.it Image Compression
+# * CSS Minification
+#
+#### Robust Extensions:
+# Add your own runtime and build-time features!
+#
+#### Next Steps:
+# * [Visit the website]
+# * [Read the wiki]
+# * [Email the users group]
+# * [Submit bug reports]
+#
+# [Visit the website]:     http://middlemanapp.com
+# [Read the wiki]:         https://github.com/tdreyno/middleman/wiki
+# [Email the users group]: http://groups.google.com/group/middleman-users
+# [Submit bug reports]:    https://github.com/tdreyno/middleman/issues
+
+# Setup out load paths
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
+# Require Rubygems (probably not necessary)
 require 'rubygems'
 
+# Top-level Middleman object
 module Middleman
+  # Auto-load modules on-demand
   autoload :Server, "middleman/server"
   
+  # Custom Renderers
   module Renderers
     autoload :Haml, "middleman/renderers/haml"
     autoload :Sass, "middleman/renderers/sass"
   end
 
+  # Features API
   autoload :Features, "middleman/features"
 end

data/lib/middleman/features.rb

@@ -1,33 +1,114 @@
+# Middleman provides an extension API which allows you to hook into the
+# lifecycle of a page request, or static build, and manipulate the output.
+# Internal to Middleman, these extensions are called "features," but we use
+# the exact same API as is made available to the public.
+#
+# A Middleman extension looks like this:
+#
+#     module MyExtension
+#       class << self
+#         def registered(app)
+#           # My Code
+#         end
+#       end
+#     end
+#
+# In your `config.rb`, you must load your extension (if it is not defined in
+# that file) and call `activate`.
+#
+#     require "my_extension"
+#     activate MyExtension
+#
+# This will call the `registered` method in your extension and provide you
+# with the `app` parameter which is a Middleman::Server context. From here
+# you can choose to respond to requests for certain paths or simply attach
+# Rack middleware to the stack.
+#
+# The built-in features cover a wide range of functions. Some provide helper
+# methods to use in your views. Some modify the output on-the-fly. And some
+# apply computationally-intensive changes to your final build files.
+
 module Middleman::Features
+
+  # RelativeAssets allow any asset path in dynamic templates to be either
+  # relative to the root of the project or use an absolute URL.
   autoload :RelativeAssets,      "middleman/features/relative_assets"
+
+  # 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.
   autoload :AssetHost,           "middleman/features/asset_host"
+
+  # CacheBuster adds a query string to assets in dynamic templates to avoid
+  # browser caches failing to update to your new content.
   autoload :CacheBuster,         "middleman/features/cache_buster"
+
+  # DefaultHelpers are the built-in dynamic template helpers.
   autoload :DefaultHelpers,      "middleman/features/default_helpers"
+
+  # AutomaticImageSizes inspects the images used in your dynamic templates and
+  # automatically adds width and height attributes to their HTML elements.
   autoload :AutomaticImageSizes, "middleman/features/automatic_image_sizes"
+
+  # UglyHaml enables the non-indented output format from Haml templates. Useful
+  # for somewhat obfuscating the output and hiding the fact that you're using Haml.
   autoload :UglyHaml,            "middleman/features/ugly_haml"
+
+  # MinifyCss uses the YUI compressor to shrink CSS files
   autoload :MinifyCss,           "middleman/features/minify_css"
+
+  # MinifyJavascript uses the YUI compressor to shrink JS files
   autoload :MinifyJavascript,    "middleman/features/minify_javascript"
+
+  # Slickmap (http://astuteo.com/slickmap/) is a beautiful sitemap tool which
+  # will attempt to generate a `sitemap.html` file from your project.
   autoload :Slickmap,            "middleman/features/slickmap"
+
+  # SmushPngs uses Yahoo's Smush.it API to compresses PNGs and JPGs. Often times
+  # the service can decrease the size of Photoshop-exported images by 30-50%
   autoload :SmushPngs,           "middleman/features/smush_pngs"
+
+  # CodeRay is a syntax highlighter.
   autoload :CodeRay,             "middleman/features/code_ray"
+
+  # Lorem provides a handful of helpful prototyping methods to generate words,
+  # paragraphs, fake images, names and email addresses.
   autoload :Lorem,               "middleman/features/lorem"
-  # autoload :LiveReload,          "middleman/features/live_reload"
-  
+
+  # LiveReload will auto-reload browsers with the live reload extension installed after changes
+  # Currently disabled and untested.
+  #autoload :LiveReload,          "middleman/features/live_reload"
+
+  # The Feature API is itself a Feature. Mind blowing!
   class << self
     def registered(app)
       app.extend ClassMethods
     end
     alias :included :registered
   end
-  
+
   module ClassMethods
-    def activate(feature_name)
-      mod_name = feature_name.to_s.camelize
-      if Middleman::Features.const_defined?(mod_name)
-        register Middleman::Features.const_get(mod_name)
+    # This method is available in the project's `config.rb`.
+    # It takes a underscore-separated symbol, finds the appropriate
+    # feature module and includes it.
+    #
+    #     activate :lorem
+    #
+    # Alternatively, you can pass in a Middleman feature module directly.
+    #
+    #     activate MyFeatureModule
+    def activate(feature)
+      feature = feature.to_s if feature.is_a? Symbol
+
+      if feature.is_a? String
+        feature = feature.camelize
+        feature = Middleman::Features.const_get(feature)
       end
+
+      register feature
     end
-    
+
+    # Deprecated API. Please use `activate` instead.
     def enable(feature_name)
       $stderr.puts "Warning: Feature activation has been renamed from enable to activate"
       activate(feature_name)

data/lib/middleman/templates/html5boilerplate/config.tt

@@ -0,0 +1,51 @@
+# html5boilerplate uses "css"
+set :css_dir, "css"
+
+# html5boilerplate uses "js"
+set :js_dir, "js"
+
+# html5boilerplate uses "images"
+set :images_dir, "images"
+
+# Per-page layout changes
+# With no layout
+# page "/path/to/file.html", :layout => false
+# With alternative layout
+# page "/path/to/file.html", :layout => :otherlayout
+
+# Helpers
+helpers do
+  def some_helper(*args)
+    "Helping"
+  end
+end
+
+# Automatic sitemaps
+# activate :slickmap
+
+# CodeRay syntax highlighting in Haml
+# activate :code_ray
+
+# Automatic image dimension calculations in Haml
+# activate :automatic_image_sizes
+
+# Build-specific configuration
+configure :build do
+  # For example, change the Compass output style for deployment
+  # activate :minify_css
+  
+  # Minify Javascript on build
+  # activate :minify_javascript
+  
+  # Shrink/smush PNG/JPEGs on build
+  # activate :smush_pngs
+  
+  # Enable cache buster
+  # activate :cache_buster
+
+  # Generate ugly/obfuscated HTML from Haml
+  # activate :ugly_haml
+  
+  # Or use a different image path
+  # set :http_path, "/Content/images/"
+end

data/lib/middleman/templates/html5boilerplate/public/404.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<title>not found</title>
+
+<style>
+body { text-align: center;}
+h1 { font-size: 50px; }
+body { font: 20px Constantia, 'Hoefler Text',  "Adobe Caslon Pro", Baskerville, Georgia, Times, serif; color: #999; text-shadow: 2px 2px 2px rgba(200, 200, 200, 0.5); }
+::-moz-selection{ background:#FF5E99; color:#fff; }
+::selection { background:#FF5E99; color:#fff; } 
+details { display:block; }
+a { color: rgb(36, 109, 56); text-decoration:none; }
+a:hover { color: rgb(96, 73, 141) ; text-shadow: 2px 2px 2px rgba(36, 109, 56, 0.5); }
+span[frown] { transform: rotate(90deg); display:inline-block; color: #bbb; }
+</style>
+
+
+
+
+<details>
+  <summary><h1>Not found</h1></summary>
+  <p><span frown>:(</span></p>
+</details>

data/lib/middleman/templates/html5boilerplate/public/crossdomain.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<!DOCTYPE cross-domain-policy SYSTEM "http://www.adobe.com/xml/dtds/cross-domain-policy.dtd">
+<cross-domain-policy>
+  
+  
+<!-- Read this: www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html -->
+
+<!-- Most restrictive policy: -->
+	<site-control permitted-cross-domain-policies="none"/>
+	
+	
+	
+<!-- Least restrictive policy: -->
+<!--
+	<site-control permitted-cross-domain-policies="all"/>
+	<allow-access-from domain="*" to-ports="*" secure="false"/>
+	<allow-http-request-headers-from domain="*" headers="*" secure="false"/>
+-->
+<!--
+  If you host a crossdomain.xml file with allow-access-from domain=“*” 	 	
+  and don’t understand all of the points described here, you probably 	 	
+  have a nasty security vulnerability. ~ simon willison
+-->
+
+</cross-domain-policy>