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

data/.gitignore

@@ -7,9 +7,8 @@ pkg
 .tmp
 Gemfile.lock
 docs
-.rvmrc
 .rbenv-version
-fixtures/test-app/build
+fixtures/generator-test
 .*.swp
 build
 doc

data/.yardopts

@@ -2,4 +2,6 @@ lib/**/*.rb
 --exclude lib/middleman/vendor 
 --exclude lib/middleman/extensions/automatic_image_sizes/fastimage.rb 
 --exclude lib/middleman/extensions/minify_css/cssmin.rb
+--exclude lib/middleman/step_definitions
+--exclude lib/middleman/step_definitions.rb
 --no-private

data/CHANGELOG.md

@@ -0,0 +1,97 @@
+3.0.pre
+====
+* Rewritten to work directly with Rack (Sinatra apps can still be mounted)
+* Sitemap maintains own state
+* New Extension Registration API
+* Remove old 1.x mm- binaries and messaging
+* New default layout functionality: https://github.com/tdreyno/middleman/issues/165
+* Enable chained templates outside of sprockets (file.html.markdown.erb)
+* Finally support Compass in Sprockets! Thanks to @xdite and @petebrowne
+* Sitemap object representing the known world
+* FileWatcher proxies file change events
+* Unified callback solution
+* Removed Slim and Maruku from base install. Will need to be installed and required by the user (in - config.rb)
+* Activate mobile html5boilerplate template
+* Update to Redcarpet for Markdown (breaks Haml :markdown filter)
+
+2.0.14
+====
+* Minor fix for i18n
+
+2.0.13.2
+====
+* Update Windows eventmachine dep
+
+2.0.13.1
+====
+* build --clean shouldn't remove dotfiles
+
+2.0.13
+====
+* middleman build --clean keeps the build directory clean of leftover files
+* Padrino 0.10.5 and Rack 1.3.5
+
+2.0.12
+====
+* Sinatra 1.3.1 and Padrino 0.10.4
+
+2.0.11
+=====
+* Lock Padrino and Sinatra versions (for now)
+
+2.0.9
+=====
+* Added --glob option to build which only builds matching files
+* Allow data/ files to be in JSON format as well
+* Enabled Liquid {% include %} tag
+* RubyInstaller-specific gem
+* Allow access to data/ in config.rb
+* Add mobile html5boilerplate template
+
+2.0.8
+=====
+* Support accessing variables and data objects in ERb Sprockets files (library.js.coffee.erb)
+* Make :markdown_engine support simple symbol names (:maruku instead of ::Tilt::MarkukuTemplate)
+* Update Padrino deps to 0.10.2
+* Include therubyracer on *nix
+* Enable frontmatter for Liquid templates
+
+2.0.7
+=====
+* Updated HTML5 Boilerplate to v2
+* Make Rails 3.1 javascript gems available to Sprockets
+
+2.0.6
+=====
+* Pulled out livereload feature into its own extension, still installed by default.
+
+2.0.5
+=====
+* Vendored Padrino 0.10.0
+
+2.0.4
+=====
+* Pulled out undocumented remote data feature into its own extension
+
+2.0.3
+=====
+* Pulled out undocumented Blog feature into its own extension
+
+2.0.2
+=====
+* Fixed Sprockets circular error
+* Added auto-requiring extensions
+
+2.0.0
+=====
+* Guard-powered auto-reloading of config.rb
+* Guard LiveReload
+* Sprockets JS
+* Refactored Dynamically Reloadable Core
+* Combine views/ and public/ into a single source/ folder.
+* Support YAML front-matter
+* Added callback to run code after Compass is configured
+* Added support for a compass.config file which is passed directly to Compass
+* Blog-aware Feature (and project template)
+* Thor-based, unified `middleman` binary
+* :directory_indexes feature

data/README.md

@@ -1,22 +1,93 @@
-Middleman [![Build Status](http://travis-ci.org/tdreyno/middleman.png)](http://travis-ci.org/tdreyno/middleman)
-=========
+# Middleman
 
-Middleman is ever-vigilant against tag-soup, unreadable CSS and repetition. He stands-watch over your Haml, Sass, and CoffeeScript producing only the cleanest and most efficient markup.
+Middleman makes developing stand-alone websites simple. The last few years has seen an explosion in the amount and variety of tools developers can use to build web applications. Ruby on Rails selects a handful of these tools:
 
-[![Click here to lend your support to Middleman](https://www.pledgie.com/campaigns/15807.png)](http://www.pledgie.com/campaigns/15807)
+* Sass for DRY stylesheets
+* CoffeeScript for safer and less verbose javascript
+* Sprockets for combining and minifying assets
+* ERb & Haml for dynamic pages and simplified HTML syntax
+
+Middleman gives the stand-alone developer access to all these tool and many, many more. Why would you use a stand-alone framework instead of Ruby on Rails?
+
+These days, many websites are built with an API in mind. Rather than package the frontend and the backend together, both can be built and deployed independently using the public API to pull data from the backend and display it on the frontend. Static websites are incredibly fast and require very little RAM. A front-end built to stand-alone can be deployed directly to the cloud or a CDN. Many designers and developers simply deliver static HTML/JS/CSS to their clients.
+
+# Install
+
+Middleman is built on Ruby and uses the RubyGems package manager for installation. These are usually pre-installed on Mac OS X and Linux. Windows users can install both using [RubyInstaller].
+
+    gem install middleman
+
+# Getting Started
+
+Once Middleman is installed, you will have access to the `middleman` command. First, let's create a new project. From the terminal:
+
+    middleman init MY_PROJECT
+
+This will create a new Middleman project located in the "MY_PROJECT" directory. This project contains a `config.rb` file for configuring Middleman and a `source` directory for storing your pages, stylesheets, javascripts and images.
+
+Change directories into your new project and start the preview server:
+
+    cd MY_PROJECT
+    middleman server
+
+The preview server allows you to build your site, by modifying the contents of the `source` directory, and see your changes reflected in the browser at: `http://localhost:4567/`
+
+To get started, simply develop as you normally would by building HTML, CSS, and Javascript in the `source` directory. When you're ready to use more complex templates, simply add the templating engine's extension to the file and start writing in that format.
+
+For example, say I am working on a stylesheet at `source/stylesheets/site.css` and I'd like to start using Compass and Sass. I would rename the file to `source/stylesheets/site.css.scss` and Middleman will automatically begin processing that file as Sass. The same would apply to CoffeeScript (`.js.coffee`), Haml (`.html.haml`) and any other templating engine you might want to use.
+
+Finally, you will want to build your project into a stand-alone site. From the project directory:
+
+    middleman build
 
-## Getting Started
+This will compile your templates and output a stand-alone site which can be easily hosted or delivered to your client. The build step can also compress images, employ Javascript & CSS dependency management, minify Javascript & CSS and run additional code of your choice. Take a look at the `config.rb` file to see some of the most common extensions which can be activated.
 
-Everything you need to know is on the official site: 
-http://middlemanapp.com
+# Learn More
 
-## Mailing List
+A full set of in-depth instructional guides are available on the official website at:
 
-If you have questions, answers can be found on community forum: https://convore.com/middleman/
+  http://middlemanapp.com/
+
+The community maintains it's own collection of tips and tricks in the GitHub wiki:
+
+  https://github.com/tdreyno/middleman/wiki
+
+Finally, up-to-date generated code documentation is available on RubyDoc: 
+http://rubydoc.info/github/tdreyno/middleman
+
+# Community
+
+The official community forum is available on Convore at:
+
+  https://convore.com/middleman/
+
+# Bug Reports
+
+GitHub Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems:
+
+https://github.com/tdreyno/middleman/issues
+
+The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
+
+# Build & Dependency Status
+
+[![Build Status](http://travis-ci.org/tdreyno/middleman.png)](http://travis-ci.org/tdreyno/middleman)
+[![Dependency Status](https://gemnasium.com/tdreyno/middleman.png?travis)](https://gemnasium.com/tdreyno/middleman)
+
+# How to Run Cucumber Tests
+
+1. Checkout Repository: `git clone https://tdreyno@github.com/tdreyno/middleman.git`
+2. Install Bundler: `gem install bundler`
+3. Run `bundle` inside the project root to install the gem dependencies.
+4. Run test cases: `bundle exec rake test`
+
+# Donate
+
+[![Click here to lend your support to Middleman](https://www.pledgie.com/campaigns/15807.png)](http://www.pledgie.com/campaigns/15807)
 
-## Generated Source Documentation
-http://rubydoc.info/github/tdreyno/middleman/master/frames
+# License
 
-## Copyright
+Copyright (c) 2010 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
 
-Copyright (c) 2010 Thomas Reynolds. See LICENSE for details.
+[RubyInstaller]: http://rubyinstaller.org/
+[LICENSE]: https://github.com/tdreyno/middleman/blob/master/LICENSE

data/Rakefile

@@ -7,7 +7,11 @@ 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
 
-require 'rake/testtask'
 require 'rake/clean'
 
-task :test => ["cucumber"]
+task :test => ["cucumber"]
+
+desc "Build HTML documentation"
+task :doc do
+  sh 'bundle exec yard'
+end

data/bin/middleman

@@ -59,10 +59,11 @@ end
 args = ARGV.dup
 
 ARG_ALIASES = {
-  "s" => "server",
-  "b" => "build",
-  "i" => "init",
-  "w" => "watch"
+  "s"   => "server",
+  "b"   => "build",
+  "i"   => "init",
+  "new" => "init",
+  "n"   => "init"
 }
 
 if ARG_ALIASES.has_key?(args[0])

data/features/builder.feature

@@ -13,14 +13,21 @@ Feature: Builder
     Then "stylesheets/static.css" should exist at "test-app" and include "body"
     Then "_partial.html" should not exist at "test-app"
     Then "spaces in file.html" should exist at "test-app" and include "spaces"
+    Then "images/blank.gif" should exist at "test-app"
     Then "images/Read me (example).txt" should exist at "test-app"
     Then "images/Child folder/regular_file(example).txt" should exist at "test-app"
     Then ".htaccess" should exist at "test-app"
+    Then the last exit code should be "0"
     
   Scenario: Build glob
     Given a built app at "glob-app" with flags "--glob '*.css'"
     Then "stylesheets/site.css" should exist at "glob-app" and include "html"
     Then "index.html" should not exist at "glob-app"
+    Then the last exit code should be "0"
+  
+  Scenario: Build with errors
+    Given a built app at "build-with-errors-app"
+    Then the last exit code should be "1"
     
   # Scenario: Force relative assets
   #   Given a built app at "relative-app" with flags "--relative"

data/features/clean_build.feature

@@ -7,3 +7,14 @@ Feature: Build Clean
     Then "should_be_ignored.html" should not exist at "clean-app"
     And "should_be_ignored2.html" should not exist at "clean-app"
     And "should_be_ignored3.html" should not exist at "clean-app"
+
+  Scenario: Clean an app with directory indexes
+    Given a built app at "clean-dir-app"
+    Then "about/index.html" should exist at "clean-dir-app"
+    Given a built app at "clean-dir-app" with flags "--clean"
+    Then "about/index.html" should exist at "clean-dir-app"
+    Then cleanup built app at "clean-dir-app"
+
+  Scenario: Clean build an app that's never been built
+    Given a built app at "clean-dir-app" with flags "--clean"
+    Then "about/index.html" should exist at "clean-dir-app"

data/features/current_page_request_path_backwards.feature

@@ -0,0 +1,6 @@
+Feature: Support old request.path object used by many extensions
+  
+  Scenario: Viewing the root path
+    Given the Server is running at "test-app"
+    When I go to "/request-path.html"
+    Then I should see "true"

data/features/front-matter.feature

@@ -5,4 +5,31 @@ Feature: YAML Front Matter
     Given the Server is running at "test-app"
     When I go to "/front-matter.html"
     Then I should see "<h1>This is the title</h1>"
-    Then I should not see "---"
+    Then I should not see "---"
+    When I go to "/front-matter-2.php"
+    Then I should see "<h1>This is the title</h1>"
+    Then I should see "<?php"
+    Then I should not see "---"
+
+  Scenario: A template changes frontmatter during preview
+    Given the Server is running at "test-app"
+    And the file "source/front-matter-change.html.erb" has the contents
+      """
+      ---
+      title: Hello World
+      layout: false
+      ---
+      <%= data.page.title %>
+      """
+    When I go to "/front-matter-change.html"
+    Then I should see "Hello World"
+    And the file "source/front-matter-change.html.erb" has the contents
+      """
+      ---
+      title: Hola Mundo
+      layout: false
+      ---
+      <%= data.page.title %>
+      """
+    When I go to "/front-matter-change.html"
+    Then I should see "Hola Mundo"

data/features/generator.feature

@@ -2,7 +2,7 @@ Feature: Generator
   In order to generate static assets for client
 
   Scenario: Copying template files
-    Given generated directory at "generator-test"
-    Then template files should exist at "generator-test"
-    And empty directories should exist at "generator-test"
-    And cleanup at "generator-test"
+    Given a project at "generator-test"
+    And the project has been initialized
+    Then template files should exist
+    And empty directories should exist

data/features/helpers_external.feature

@@ -0,0 +1,6 @@
+Feature: Helpers in external files
+
+  Scenario: Hello Helper
+    Given the Server is running at "external-helpers"
+    Then going to "/index.html" should not raise an exception
+    And I should see "Hello World"

data/features/helpers_lorem.feature

@@ -0,0 +1,5 @@
+Feature: Lorem generating helper
+
+  Scenario: Lorem Helper
+    Given the Server is running at "test-app"
+    Then going to "/lorem.html" should not raise an exception

data/features/instance_vars.feature

@@ -0,0 +1,20 @@
+Feature: Instance Vars
+  In order to share data with layouts and partials via instance variables
+
+  Scenario: Setting an instance var in a template should be visible in its layout
+    Given the Server is running at "instance-vars-app"
+    When I go to "/instance-var-set.html"
+    Then I should see "Var is 100"
+
+  Scenario: Setting an instance var in a template should be visible in a partial
+    Given the Server is running at "instance-vars-app"
+    When I go to "/instance-var-set.html"
+    Then I should see "My var is here!"
+
+  Scenario: Setting an instance var in one file should not be visible in another
+    Given the Server is running at "instance-vars-app"
+    When I go to "/instance-var-set.html"
+    When I go to "/no-instance-var.html"
+    Then I should see "No var..."
+  
+    

data/features/markdown.feature

@@ -2,6 +2,26 @@ Feature: Markdown support
   In order to test included Maruku support
 
   Scenario: Rendering html
-    Given the Server is running at "test-app"
-    When I go to "/markdown.html"
-    Then I should see "<p>Hello World</p>"
+    Given the Server is running at "markdown-app"
+    When I go to "/index.html"
+    Then I should see "<p>Hello World</p>"
+  
+  Scenario: Redcarpet 2 extensions
+    Given the Server is running at "markdown-app"
+    When I go to "/smarty_pants.html"
+    Then I should see "&ldquo;"
+    When I go to "/no_intra_emphasis.html"
+    Then I should not see "<em>"
+    When I go to "/tables.html"
+    Then I should see "<table>"
+    When I go to "/fenced_code_blocks.html"
+    Then I should see "<code>"
+    When I go to "/autolink.html"
+    Then I should see "<a href"
+    When I go to "/strikethrough.html"
+    Then I should see "<del>"
+    When I go to "/space_after_headers.html"
+    Then I should not see "<h1>"
+    When I go to "/superscript.html"
+    Then I should see "<sup>"
+    

data/features/minify_css.feature

@@ -21,4 +21,9 @@ Feature: Minify CSS
     Given "minify_css" feature is "enabled"
     And the Server is running at "test-app"
     When I go to "/stylesheets/site.css"
-    Then I should see "1" lines
+    Then I should see "1" lines
+    
+  Scenario: Rendering external css with passthrough compressor
+    Given the Server is running at "passthrough-app"
+    When I go to "/stylesheets/site.css"
+    Then I should see "55" lines

data/features/minify_javascript.feature

@@ -9,15 +9,47 @@ Feature: Minify Javascript
     And the Server is running at "test-app"
     When I go to "/inline-js.html"
     Then I should see "10" lines
+    
+  Scenario: Rendering inline js with a passthrough minifier
+    Given the Server is running at "passthrough-app"
+    When I go to "/inline-js.html"
+    Then I should see "11" lines
 
   Scenario: Rendering inline js with the feature enabled
     Given "minify_javascript" feature is "enabled"
     And the Server is running at "test-app"
     When I go to "/inline-js.html"
     Then I should see "5" lines
+    
+  Scenario: Rendering external js with the feature enabled
+    Given "minify_javascript" feature is "enabled"
+    And the Server is running at "test-app"
+    When I go to "/javascripts/js_test.js"
+    Then I should see "1" lines
+    
+  Scenario: Rendering external js with a passthrough minifier
+    And the Server is running at "passthrough-app"
+    When I go to "/javascripts/js_test.js"
+    Then I should see "8" lines
 
   Scenario: Rendering inline js (coffeescript) with the feature enabled
     Given "minify_javascript" feature is "enabled"
     And the Server is running at "test-app"
     When I go to "/inline-coffeescript.html"
-    Then I should see "5" lines
+    Then I should see "5" lines
+  
+  Scenario: Rendering external js (coffeescript) with the feature enabled
+    Given "minify_javascript" feature is "enabled"
+    And the Server is running at "test-app"
+    When I go to "/javascripts/coffee_test.js"
+    Then I should see "1" lines
+    
+  Scenario: Rendering inline js (coffeescript) with a passthrough minifier
+    Given the Server is running at "passthrough-app"
+    When I go to "/inline-coffeescript.html"
+    Then I should see "17" lines
+    
+  Scenario: Rendering external js (coffeescript) with a passthrough minifier
+    And the Server is running at "passthrough-app"
+    When I go to "/javascripts/coffee_test.js"
+    Then I should see "11" lines