mango 0.5.0.beta5 → 0.5.0

data/.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+.bundle
 .rvmrc
 .yardoc
 *.gem

data/CHANGES.mdown

@@ -1,5 +1,5 @@
-Mango release 0.5.0.beta5 (October 29, 2010)
-============================================
+Mango release 0.5.0 (October 31, 2010)
+======================================
 
 ### Features
 
@@ -9,19 +9,20 @@ Mango release 0.5.0.beta5 (October 29, 2010)
   * Mango now supports theme-switching!
     * For example, add `class Mango::Application; set :theme, "theme_name"; end` to your application's config.ru.
   * As a result of the new command-line application generator, all embedded application code has been removed.
-  * Now routes like `GET /images/` return a 200 response if the `themes/default/public/images/index.html` file is exists.
+  * Now routes like `GET /images/` return a 200 response as long as `themes/default/public/images/index.html` exists.
 
 ### Dependencies
 
   * Added [RubyGems](https://rubygems.org/) 1.3.7
-  * Updated [Ruby](http://www.ruby-lang.org/) to 1.9.1 or 1.9.2
+  * Updated [Ruby](http://www.ruby-lang.org/) to 1.9.2
   * Updated [Bundler](http://gembundler.com/) to 1.0.3
+  * Updated [Sinatra](http://www.sinatrarb.com/) to 1.1.0
   * Updated [Haml](http://haml-lang.com/) to 3.0.22
   * Updated [Sass](http://sass-lang.com/) to 3.0.22 (bundled with Haml)
   * Updated [BlueCloth](http://deveiate.org/projects/BlueCloth) to 2.0.9
   * Updated [Rack::Test](http://github.com/brynary/rack-test) to 0.5.6
   * Updated [RSpec](http://rspec.info/) to 2.0.1
-  * Updated [YARD](http://yardoc.org/) to 0.5.8
+  * Updated [YARD](http://yardoc.org/) to 0.6.1
   * Updated [YARD::Sinatra](http://github.com/rkh/yard-sinatra) to 0.5.1
 
 ### Bugs

data/Gemfile

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+source "http://rubygems.org"
+
+gem "rack",      "~> 1.2.1"
+gem "sinatra",   "~> 1.1.0"
+gem "haml",      "~> 3.0.22"
+gem "bluecloth", "~> 2.0.9"
+gem "thor",      "~> 0.14.3"
+
+gem "rspec",         "~> 2.0.1"
+gem "rack-test",     "~> 0.5.6"
+gem "yard",          "~> 0.6.1"
+gem "bluecloth",     "~> 2.0.9"
+gem "yard-sinatra",  "~> 0.5.1"
+

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.0.9)
+    diff-lcs (1.1.2)
+    haml (3.0.22)
+    rack (1.2.1)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    sinatra (1.1.0)
+      rack (~> 1.1)
+      tilt (~> 1.1)
+    thor (0.14.3)
+    tilt (1.1)
+    yard (0.6.1)
+    yard-sinatra (0.5.1)
+      yard (~> 0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth (~> 2.0.9)
+  haml (~> 3.0.22)
+  rack (~> 1.2.1)
+  rack-test (~> 0.5.6)
+  rspec (~> 2.0.1)
+  sinatra (~> 1.1.0)
+  thor (~> 0.14.3)
+  yard (~> 0.6.1)
+  yard-sinatra (~> 0.5.1)

data/README.mdown

@@ -1,120 +1,165 @@
-![Exotic Fruit](http://www.bctree.com/images/photos/sourced-mango.jpg)
+Mango release 0.5.0 (October 31, 2010)
+======================================
 
-Image courtesy of [B.C. Tree Fruits LTD.](http://www.bctree.com/products/sourced/mango.php)
+Copyright (c) 2010 Ryan Sobol. Licensed under the MIT license.  Please see the {file:LICENSE} for more information.
 
-Mango release 0.5.0.beta5 (October 29, 2010)
-============================================
+  * **Source Code**: [http://github.com/ryansobol/mango](http://github.com/ryansobol/mango)
+  * **Documentation**: [http://rubydoc.info/github/ryansobol/mango/master/frames](http://rubydoc.info/github/ryansobol/mango/master/frames)
+  * **Issue Tracker**: [http://github.com/ryansobol/mango/issues](http://github.com/ryansobol/mango/issues)
+  * **Wiki**: [http://wiki.github.com/ryansobol/mango](http://wiki.github.com/ryansobol/mango)
 
-Copyright (c) 2010 Ryan Sobol. Licensed under the MIT license.  Please see the {file:LICENSE} for more information.
+SYNOPSIS
+--------
 
-* **Source Code**: [http://github.com/ryansobol/mango](http://github.com/ryansobol/mango)
-* **Documentation**: [http://rubydoc.info/github/ryansobol/mango](http://rubydoc.info/github/ryansobol/mango)
-* **Issue Tracker**: [http://github.com/ryansobol/mango/issues](http://github.com/ryansobol/mango/issues)
-* **Wiki**: [http://wiki.github.com/ryansobol/mango](http://wiki.github.com/ryansobol/mango)
+**Mango is a dynamic, database-free, and open source website framework that is designed to make life easier for small teams of designers, developers, and content writers.**
 
-**Mango respects [Semantic Versioning](http://semver.org/)!**
+FEATURES
+--------
 
-WHAT'S NEW?
------------
+### Easy to install
 
-### Features
+Mango installs as a [RubyGem](https://rubygems.org/gems/mango) and contains all the necessary components to get a basic website up-and-running in seconds.
 
-  * Mango has been split into two pieces!
-    1. A web framework, distributed as a Ruby gem, that is completely abstracted away from application code.
-    2. A `mango` command-line tool that generates a [demo Mango application](http://mango-fireworks.heroku.com/).
-  * Mango now supports theme-switching!
-    * For example, add `class Mango::Application; set :theme, "theme_name"; end` to your application's config.ru.
-  * As a result of the new command-line application generator, all embedded application code has been removed.
-  * Now routes like `GET /images/` return a 200 response if the `themes/default/public/images/index.html` file is exists.
+### Easy to write
 
-### Dependencies
+Mango integrates with the writing tools you're already familiar with -- the file system and your favorite text editor.
 
-  * Added [RubyGems](https://rubygems.org/) 1.3.7
-  * Updated [Ruby](http://www.ruby-lang.org/) to 1.9.1 or 1.9.2
-  * Updated [Bundler](http://gembundler.com/) to 1.0.3
-  * Updated [Haml](http://haml-lang.com/) to 3.0.22
-  * Updated [Sass](http://sass-lang.com/) to 3.0.22 (bundled with Haml)
-  * Updated [BlueCloth](http://deveiate.org/projects/BlueCloth) to 2.0.9
-  * Updated [Rack::Test](http://github.com/brynary/rack-test) to 0.5.6
-  * Updated [RSpec](http://rspec.info/) to 2.0.1
-  * Updated [YARD](http://yardoc.org/) to 0.5.8
-  * Updated [YARD::Sinatra](http://github.com/rkh/yard-sinatra) to 0.5.1
+Working with a text editor you already know *saves time*.  And writing and revising content in a file *is often easier* then using the clunky administrator interface of a CMS (e.g. WordPress).  Plus, files *match perfectly* with version control systems, like [Git](http://git-scm.com/), for powerful revision history.  Bonus!
 
-### Bugs
+### Easy to theme
 
-  * The NOT_FOUND handler no longer renders the 404 template within a layout template.
-  * Improved install-time and run-time error messages for Ruby 1.8 environments
+Mango separates a website's theme from it's content.  This makes it *easy to change* the look-and-feel of a single page or an entire website.  Mango also supports powerful template languages that make it *easy to have uniformity*  with major sections (i.e. headers, footers, navigation, sidebars, etc.) across multiple pages.  The following web and template formats are supported by Mango:
 
-Please see {file:CHANGES.mdown} for the historical overview of the project.
+  * HAML
+  * HTML
+  * SASS
+  * CSS
+  * JavaScript
 
-SYNOPSIS
---------
+with [more](http://github.com/sinatra/sinatra/blob/1.1.0/CHANGES#L12) on the way.
 
-**Mango is a dynamic, database-free, and open source website framework that is designed to make life easier for small teams of designers, developers, and content writers.**
+### Easy to publish
 
-FEATURES
---------
+Mango applications are dead-simple to publish.  Mango was designed to support a wide variety of publishing tools like:
+
+  * Single target, drag-and-drop secure FTP uploading
+  * Multiple target, automated deploying with [Capistrano](http://github.com/capistrano/capistrano)
+  * Cutting-edge cloud deploying with [Git](http://git-scm.com/) and [Heroku](http://heroku.com/)
 
-  1. Easy to install:  Mango installs as a RubyGem and can generate a basic website structure in seconds.
+### Easy to collaborate
 
-  2. Easy to publish: Supports many types of deployments like direct SFTP uploading and source control systems like Git, Mercurial, SVN, CSV, etc.
+With a strong separation of writing, theming and publishing, Mango applications are *designed to be shared* with content writers, web designers, and web developers.  But the beauty of Mango is that its simple, file-based approach *appeals to both veterans and newcomers*.  In addition, Mango has an emphasis on *accurate documentation*.  Mango understands that getting up and running quickly is critical for domain-specific experts.
 
-  3. Easy to write:  Mango let's you publish to the web using the tools you're already familiar with -- the file system and your trusty text editor.  Mango supports a variety of formats include Markdown, HAML, HTML, SASS, CSS, and JavaScript.  These files are easier to create and revise then working with database records.  Say goodbye to clunky administrator interfaces for managing content!
+### Easy to maintain
 
-  4. Easy to deploy: There's no database to install, configure, and manage.
+Mango is a database-less web framework.  With no database to install, configure, or manage, the maintenance needed to keep your website in working order is *drastically reduced*.  And because Mango is distributed as a RubyGem and respects [Semantic Versioning](http://semver.org/), *upgrading is painless andi backwards-compatible* between patch releases.
 
-  5. Easy to understand:  Mango is perfect for smalls teams of varying levels of coding expertise.  Why not take the simple route where everyone is on the same page?  Instead of struggling with complex platforms, which most CMS are, Mango is perfect for people who has no coding experience.
+### Easy to scale
 
-  6. Easy on the wallet: It's free!
+Mango application's are *built for speed*.  With minimal server side scripting and zero database queries, Mango is *lightening fast* and the user experience is snappy.
 
-  7. Easy to... SPEED:  A major advantage of a database-less website framework is speed.  Database queries slow down servers.  On a high traffic website, this has a dramatic effect on the speed of the site.  With minimal server side scripting and zero database queries, Mango is lightening fast.
+### Easy on the wallet
+
+Mango is *free* and open source software.
 
 REQUIREMENTS
 ------------
 
-**Required dependencies**
+**Mango respects [Semantic Versioning](http://semver.org/).**
+
+### Required dependencies
 
-  * [Ruby](http://www.ruby-lang.org/) 1.9.1 or 1.9.2 ([RVM](http://rvm.beginrescueend.com/) recommended)
+  * [Ruby](http://www.ruby-lang.org/) 1.9.2 ([RVM](http://rvm.beginrescueend.com/) recommended)
   * [RubyGems](https://rubygems.org/) 1.3.7 (bundled with Ruby)
   * [Bundler](http://gembundler.com/) 1.0.3
   * [Rack](http://rack.rubyforge.org/) 1.2.1
-  * [Sinatra](http://www.sinatrarb.com/) 1.0
+  * [Sinatra](http://www.sinatrarb.com/) 1.1.0
   * [Haml](http://haml-lang.com/) 3.0.22
   * [Sass](http://sass-lang.com/) 3.0.22 (bundled with Haml)
   * [BlueCloth](http://deveiate.org/projects/BlueCloth) 2.0.9
 
-**Optional development dependencies**
+### Optional development dependencies
 
   * [Rake](http://rake.rubyforge.org/) 0.8.7 (bundled with Ruby)
   * [Rack::Test](http://github.com/brynary/rack-test) 0.5.6
   * [RSpec](http://rspec.info/) 2.0.1
-  * [YARD](http://yardoc.org/) 0.5.8
+  * [YARD](http://yardoc.org/) 0.6.1
   * [YARD::Sinatra](http://github.com/rkh/yard-sinatra) 0.5.1
   * [BlueCloth](http://deveiate.org/projects/BlueCloth) 2.0.9
 
 INSTALLING
 ----------
 
-    $ gem install mango -v 0.5.0.beta5
+### Ensuring Ruby 1.9.2 is installed and active
+
+I highly recommend [RVM](http://rvm.beginrescueend.com/) by Wayne E. Seguin.  It trivializes managing multiple versions of Ruby on one machine.
+
+    $ ruby -v
+    ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-darwin10.4.0]
 
-Note: Depending on how RubyGems is installed on your machine, you *may* need to prepend the command with `sudo`.
+**TIP:** The revision and arch-type may differ on your machine.
 
-USAGE
------
+### Installing the Mango gem
+
+Mango, and all its necessary components, are packaged as RubyGems for easy distribution.
+
+    $ gem install mango
+
+**TIP:** If you're not using [RVM](http://rvm.beginrescueend.com/), you *may* want to prepend the `gem` command with `sudo`.
+
+### Upgrading a Mango application
+
+Simply edit the gem version in your application's `Gemfile` and re-install with [Bundler](http://gembundler.com/).
+
+    $ cd /path/to/your/app
+    $ cat Gemfile
+    # encoding: UTF-8
+    source "http://rubygems.org"
+    gem "mango", "~> 0.5.0"
+    $ bundle install
+
+**TIP:** If you're working in the insolation of an [RVM gemset](http://rvm.beginrescueend.com/gemsets/basics/), type `gem clean` to uninstall outdated gems.
+
+GETTING STARTED
+---------------
 
 ### Generating a Mango application
 
+With Mango installed, the `mango` command will generate a new application.
+
     $ mango create /path/to/your/app
 
 ### Starting the application
 
+Mango applications are compatible with any [Rack supported web-server](http://rack.rubyforge.org/doc/).  The `rackup` command will start a web-server (default: WEBrick) listening at `http://0.0.0.0:9292`.
+
     $ cd /path/to/your/app
     $ rackup
+    [2010-10-30 15:39:41] INFO  WEBrick 1.3.1
+    [2010-10-30 15:39:41] INFO  ruby 1.9.2 (2010-08-18) [x86_64-darwin10.4.0]
+    [2010-10-30 15:39:41] INFO  WEBrick::HTTPServer#start: pid=27513 port=9292
+
+**TIP:** Type `Control + C` to quit `rackup`.
+
+### Using an alternative web-server
+
+If you prefer an alternative web-server (e.g. `thin`), simply install the gem and use the `-s SERVER` option to specify the web-server.
+
+    $ cd /path/to/your/app
+    $ gem install thin
+    $ rackup -s thin
+    >> Thin web server (v1.2.7 codename No Hup)
+    >> Maximum connections set to 1024
+    >> Listening on 0.0.0.0:9292, CTRL+C to stop
+
+**TIP:** To see a list of all the `rackup` command-line options, use the `--help` option.
 
 ### Generated application structure
 
-    $ tree
-    .
+Now that the newly generated Mango application is running, here's how the application is structured.
+
+    $ tree /path/to/your/app
+    /path/to/your/app
     ├── Gemfile
     ├── README.md
     ├── config.ru
@@ -140,44 +185,112 @@ USAGE
                 ├── layout.haml
                 └── page.haml
 
-UNDER THE HOOD
---------------
+**TIP:** The [tree](http://mama.indstate.edu/users/ice/tree/) command is awesome!
+
+### Under the hood
+
+  * First, Mango tries to route an HTTP request to a static file found in `themes/default/public/`.
+  * If no static file is found, Mango tries to route the request to a template file.
+    * For routes ending in `.css`, Mango searches for [Sass](http://sass-lang.com/) styles found in `themes/styles/`.
+    * For all other routes:
+      * Mango searches for [Markdown](http://daringfireball.net/projects/markdown/syntax) or [Haml](http://haml-lang.com/) content pages in `content/`.
+      * Mango will also try to wrap the content page within [Haml](http://haml-lang.com/) page and layout templates in `themes/default/views`.
+  * If no static or template file is found, Mango routes unknown HTTP requests to a customizable 404 page found in `themes/default/views`.
+
+WRITING
+-------
+
+Coming soon.  [Patches are welcomed](http://github.com/ryansobol/mango/issues#issue/2).
 
-  * Mango tries to route HTTP requests to static files first
-  * Then it tries to route HTTP requests to Markdown or Haml content pages or Sass style templates
-  * Finally, it routes unknown HTTP requests to a customizable 404 page
-  * Wraps content pages within a customizable Haml template and layout
-  * Supports any Rack-based application server (e.g. Phusion Passenger, thin, mongrel, webrick, etc.)
+THEMING
+-------
 
-MOTIVATION
+Coming soon.  [Patches are welcomed](http://github.com/ryansobol/mango/issues#issue/3).
+
+PUBLISHING
 ----------
 
-Scratching my own itch.  Inspired by [Nesta](http://effectif.com/nesta) and [Jekyll](http://jekyllrb.com/).
+### Deploying to a single target with secure FTP uploads
+
+Coming soon.  [Patches are welcomed](http://github.com/ryansobol/mango/issues#issue/4).
+
+### Deploying to multiple targets with Capistrano
+
+Coming soon.  [Patches are welcomed](http://github.com/ryansobol/mango/issues#issue/5).
+
+### Deploying to the cloud with Heroku
+
+Heroku (pronounced her-OH-koo) is a cloud platform for Ruby-powered web applications.  Heroku lets app developers spend 100% of their time on their application code, not managing servers, deployment, ongoing operations, or scaling.  And best of all, Mango applications can leverage this power with their *free* [Blossom tier](http://heroku.com/pricing).
+
+If you haven't done so already, prepare your Mango application with Git.  Just initialize a new Git repository, add the project directory, and commit.
+
+    $ cd /path/to/your/app
+    $ git init
+    $ git add .
+    $ git commit -m "First commit"
+
+Next, [get started with Heroku](http://docs.heroku.com/heroku-command#installation) by signing up for an account, installing the `heroku` gem, and adding your ssh public key to their network.
+
+    $ gem install heroku
+    $ heroku keys:add
+
+Then [create a heroku app](http://docs.heroku.com/creating-apps) that targets the "Badius Bamboo" plus "Matz Ruby Implementation" 1.9.2 [platform stack](http://docs.heroku.com/stack).
 
-REPORTING ISSUES
-----------------
+    $ heroku create APP_NAME --stack bamboo-mri-1.9.2
 
-Is Mango not behaving like you expect it should?  Please forgive me!  Would you take a moment to shed light on my negligence over at the [Issue Tracker](http://github.com/ryansobol/mango/issues)?  Here's a **Pro Tip** -- you can read through existing issues and vote for which issues you'd like to see resolved first!
+Finally, [deploy](http://docs.heroku.com/git) the heroku app.  If you've followed these instructions carefully, deployment is trivial.
 
-Thank you for taking the time to help improve Mango.
+    $ git push heroku master
+
+Now, bask in the glory of your *live application* in the cloud.
+
+    $ heroku open
+
+**TIP:** Like the entire the platform, the `heroku` command-line tool has [great documentation](http://docs.heroku.com/heroku-command).
+
+PHILOSOPHY
+----------
+
+### Painless collaboration
+
+Mango is designed to make life easier for small, integrated teams.  They prefer tools that allow for shared access to the same resources and for processes that provide instantaneous feedback.
+
+### Harness the power of the Ruby toolbox
+
+The Ruby on Rails revolution has arrived.  The world's next-generation web applications are built with powerful tools from the Ruby eco-system.  Mango is designed to harness this power, but delivered in a smaller package to meet the needs of simpler websites.
 
 CONTRIBUTING
 ------------
 
-Is Mango not behaving like you need?  Open-source to the rescue!  There is a plethora of documentation to bring a Rubyist of any level up to speed.  The API documentation is generated, once the dependencies are met (please see the REQUIREMENTS section), by issuing the follow command:
+**Thank you for taking the time to help improve Mango.**
+
+### Reporting Issues
+
+Is Mango not behaving like you expect it should?  Please forgive me.  Submit a report over at the [Issue Tracker](http://github.com/ryansobol/mango/issues) and I'll get that sorted out.
+
+**TIP:** You can read through existing issues and vote for the ones you'd like to see resolved first.
+
+### Submitting Patches
+
+Is Mango not behaving like you need?  Patches are always welcomed and appreciated.  [Report your issue](http://github.com/ryansobol/mango/issues) to make sure we're not duplicating any work and go to town.  Alternatively, you can lend a hand on [existing issues](http://github.com/ryansobol/mango/issues).
+
+Once you've been assigned an issue, the process for contributing your work back to the source is straight-forward.
+
+  * Fork the project.
+  * Make your feature addition or bug fix **with specifications**.  It's important that your hard work isn't unintentionally broken in a future version.
+  * Please do not casually alter files in the project root. (e.g. `LICENSE`, `README.mdown`, `mango.gemspec`, etc.)
+  * Commit and publish your change-set.
+  * Send a pull request.  **Remember, all specs must pass.**
 
-    $ rake yard
+**TIP:** Take a moment to get a feel for the style of coding, specifications, and in-line documentation.
 
-Patches are always welcome and appreciated!  The process is straight-forward for contributing your work back to the source:
+Mango has a plethora of documentation to bring a Rubyist of any level up to speed.  Once the development dependencies are met (please see the REQUIREMENTS section), fire up the documentation web server.
 
-* Fork the project -- may I suggest [Github](http://www.github.com)?
-* Make your feature addition or bug fix **with specifications**.  It's important that I don't break your hard work in a future version unintentionally.
-* Please do not casually alter files in the project root. (e.g. LICENSE, Rakefile, README.mdown, VERSION, etc.)
-* Commit your changes and publish the change-set.
-* Send me a pull request.  Remember, all specs must pass!
+    $ yard server
 
-Before making your change, take a moment to get a feel for the style of coding, specifications, and in-line documentation.
+Then point your browser to `http://0.0.0.0:8808`
 
-Visit the [Issue Tracker](http://github.com/ryansobol/mango/issues) learn how you can lend a hand and where to start.
+CREDITS
+-------
 
-Again, thank you for taking the time to help improve Mango.
+Thanks to all of my friends and family for their invaluable support!