mango 0.6.2 → 0.6.3

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## v0.6.3 / 2013-11-28
+
+[Full changes](https://github.com/ryansobol/mango/compare/v0.6.2...v0.6.3)
+
+## Documentation
+
+* Improve Features section of the README.md [GH#71](https://github.com/ryansobol/mango/issues/71)
+* Update the WRITING section of the README.md [GH#2](https://github.com/ryansobol/mango/issues/2)
+* insolation v. isolation [GH#74](https://github.com/ryansobol/mango/issues/74) (TrevorBramble)
+
 ## v0.6.2 / 2011-06-06
 
 [Full changes](https://github.com/ryansobol/mango/compare/v0.6.1...v0.6.2)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mango (0.6.2)
+    mango (0.6.3)
       bluecloth (~> 2.1.0)
       bundler (~> 1.0.7)
       coffee-script (~> 2.2.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Ryan Sobol
+Copyright (c) 2013 Ryan Sobol
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
-Mango release 0.6.2 (June 6, 2011)
-==================================
+Mango release 0.6.3 (November 28, 2013)
+=======================================
 
-Copyright (c) 2011 Ryan Sobol. Licensed under the MIT license.  Please see the {file:LICENSE} for more information.
+Copyright (c) 2013 Ryan Sobol. Licensed under the MIT license.  Please see the {file:LICENSE} for more information.
 
   * **Demo Application** : [http://mango-fireworks.heroku.com/](http://mango-fireworks.heroku.com/)
   * **Source Code**: [https://github.com/ryansobol/mango](https://github.com/ryansobol/mango)
@@ -12,33 +12,31 @@ Copyright (c) 2011 Ryan Sobol. Licensed under the MIT license.  Please see the {
 SYNOPSIS
 --------
 
-**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 is a dynamic, database-free, and open source website framework that is designed to make life easier for small teams of developers, designers, and writers.**
 
 FEATURES
 --------
 
-### Easy to install
-
-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 eliminates the barriers to collaboration by decoupling from one another the activities of writing, theming, publishing, extending, and maintaining a website.  Mango websites are also decoupled from a database, and instead utilize file-based storage and "convention over configuration".
 
 ### Easy to write
 
-Mango integrates with the writing tools you're already familiar with -- the file system and your favorite text editor.
+Writing and revising copy using the clunky administrator interface of a CMS is painful.  Which is why it's common for people to work in a text editor and then copy-and-paste their changes back into the CMS.
 
-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!
+Mango leverages the writing tools you're already familiar with -- the file system and your favorite text editor.  As a bonus, files match perfectly with version control systems, like [Git](http://git-scm.com/), making for powerful revision history.
 
-Mango supports the following *easy to write* content formats:
+Mango supports the following content formats:
 
   * [Markdown](http://daringfireball.net/projects/markdown/basics)
   * [Haml](http://haml-lang.com/tutorial.html)
   * [ERB](http://ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html)
   * [Liquid](https://github.com/tobi/liquid/wiki)
 
-Don't see your favorite content format?  [Patches are welcomed](https://github.com/ryansobol/mango/issues)
+Don't see your favorite content format?  [Patches are welcome](https://github.com/ryansobol/mango/issues)
 
 ### Easy to theme
 
-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.  In addition to the standard browser formats -- HTML, CSS, and JavaScript --  Mango also supports the following template engines:
+Mango separates a website's theme from it's content.  Using a powerful and flexible template system, Mango facilitates both uniformity of major sections and individuality of content presentation.  In addition to the standard browser formats -- HTML, CSS, and JavaScript --  Mango also supports the following template formats:
 
   * [Haml](http://haml-lang.com/)
   * [ERB](http://ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html)
@@ -46,31 +44,36 @@ Mango separates a website's theme from it's content.  This makes it *easy to cha
   * [Scss](http://sass-lang.com/) and [Sass](http://sass-lang.com/)
   * [CoffeeScript](http://jashkenas.github.com/coffee-script/)
 
-Don't see your favorite template engine?  [Patches are welcomed](https://github.com/ryansobol/mango/issues)
+Don't see your favorite template formats?  [Patches are welcome](https://github.com/ryansobol/mango/issues)
 
 ### Easy to publish
 
-Mango applications are dead-simple to publish.  Mango was designed to support a wide variety of publishing tools like:
+Mango websites are dead-simple to publish.  Mango supports a wide variety of publishing tools like:
 
+  * Cutting-edge cloud deploying with [Git](http://git-scm.com/) and [Heroku](http://heroku.com/)
   * Single target, drag-and-drop secure FTP uploading
   * Multiple target, automated deploying with [Capistrano](https://github.com/capistrano/capistrano)
-  * Cutting-edge cloud deploying with [Git](http://git-scm.com/) and [Heroku](http://heroku.com/)
 
-### Easy to collaborate
+### Easy to extend
 
-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.
+Mango is related to a family of tools called static website generators.  One killer feature missing from Mango's cousins is the ability to dynamically process HTTP requests on the server.
 
-### Easy to maintain
+Mango websites leverage the [Sinatra](http://www.sinatrarb.com/) framework to connect web requests to content pages on-the-fly.  Additionally, developers can enhance a Mango website to intercept specific web requests and dynamically customize the HTTP response, communicate with other Internet services, or serve unique content.
 
-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 and backwards-compatible* between patch releases.
+With Mango and server-side processing you can:
 
-### Easy to scale
+  * Redirect the browser
+  * Cache static assets in the browser
+  * Connect with browser frameworks, like [Backbone.js](http://documentcloud.github.com/backbone/), over AJAX
+  * Send e-mails via a contact form
+  * Subscribe customers to a newsletter
+  * Detect mobile devices
+  * Detect geographic locations
+  * Translate content to native languages
 
-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.
-
-### Easy on the wallet
+### Easy to maintain
 
-Mango is *free* and open source software.
+Mango is distributed as a RubyGem and respects [Semantic Versioning](http://semver.org/).  In concert with Bundler, upgrading a Mango website is painless and backwards-compatible between patch releases.
 
 REQUIREMENTS
 ------------
@@ -117,33 +120,33 @@ Mango, and all its necessary components, are packaged as RubyGems for easy distr
 
     $ gem install mango
 
-**TIP:** If you're not using [RVM](http://rvm.beginrescueend.com/), you *may* want to prepend the `gem` command with `sudo`.
+**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
+### Upgrading a Mango website
 
-Simply edit the gem version in your application's `Gemfile` and re-install with [Bundler](http://gembundler.com/).
+Simply edit the gem version in your website'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.6.2"
+    gem "mango", "~> 0.6.3"
     $ 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.
+**TIP:** If you're working in the isolation of an [RVM gemset](http://rvm.beginrescueend.com/gemsets/basics/), type `gem clean` to uninstall outdated gems.
 
 GETTING STARTED
 ---------------
 
-### Generating a Mango application
+### Generating a Mango website
 
-With Mango installed, the `mango` command will generate a new application.
+With Mango installed, the `mango` command will generate a new website.
 
     $ mango create /path/to/your/app
 
-### Starting the application
+### Starting the web-server
 
-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`.
+Mango websites 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
@@ -166,9 +169,9 @@ If you prefer an alternative web-server (e.g. `thin`), simply install the gem an
 
 **TIP:** To see a list of all the `rackup` command-line options, use the `--help` option.
 
-### Generated application structure
+### Generated website structure
 
-Now that the newly generated Mango application is running, here's how the application is structured.
+Now that the newly generated Mango website is running, here's how the website is structured.
 
     $ tree /path/to/your/app
     /path/to/your/app
@@ -213,29 +216,103 @@ Now that the newly generated Mango application is running, here's how the applic
 WRITING
 -------
 
-Coming soon.  [Patches are welcomed](https://github.com/ryansobol/mango/issues#issue/2).
+Authors write and revise copy in text file called a content page.  A content page contains two optional components -- a body and a header.  Though optional, the majority of authors will utilize both components.
 
-THEMING
--------
+For example, the Mango website generator produces the following content page:
 
-Coming soon.  [Patches are welcomed](https://github.com/ryansobol/mango/issues#issue/3).
+    $ cat content/index.erb
+    ---
+    title: Congratulations!
+    ---
+    <h1><%= page.title %></h1>
 
-PUBLISHING
-----------
+    <h2>You did it!</h2>
 
-### Deploying to a single target with secure FTP uploads
+The above example highlights the key facets of writing a content page.
 
-Coming soon.  [Patches are welcomed](https://github.com/ryansobol/mango/issues#issue/4).
+  1. A content page is stored as a file in the `content` directory.  Here, the file name is `index.erb`.
+  2. The header, if defined, comes first and is embedded within triple-dashed `---` dividers.
+  3. The body comes second, nestled comfortably below the header.
+  4. The header is composed of key-value attribute pairs in [YAML](http://www.yaml.org/) format.
+  5. The file's extension signals that the body should be treated as ERB.
 
-### Deploying to multiple targets with Capistrano
+### The Header
+
+The header is composed of key-value attribute pairs in [YAML](http://www.yaml.org/) format.  Utilizing the `page` local variable, attribute data is available within the content page's body and view template.
+
+In the previous example, the message `Congratulations!` is substituted for `<%= page.title %>` whenever the content page is rendered.
+
+### The Body
+
+The body of a content page supports many writer and designer friendly formats.  The content page's file extension determines the body's format.  Rendering a content page converts the body to HTML.
+
+Mango supports the following body formats:
+
+  * [Markdown](http://daringfireball.net/projects/markdown/basics)
+  * [Haml](http://haml-lang.com/tutorial.html)
+  * [ERB](http://ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html)
+  * [Liquid](https://github.com/tobi/liquid/wiki)
+
+### The Data and Body Attributes
+
+A handful of attributes are automatically inserted into every content page and **cannot** be altered in the header.  Two such attributes are `data` and `body` which contain a content page's data and pre-rendered body respectively.
+
+For example, given the following content page:
+
+    ---
+    title: Congratulations!
+    ---
+    <h1><%= page.title %></h1>
+
+    <h2>You did it!</h2>
+
+Calling `<%= page.data %>` would yield:
 
-Coming soon.  [Patches are welcomed](https://github.com/ryansobol/mango/issues#issue/5).
+    ---
+    title: Congratulations!
+    ---
+    <h1><%= page.title %></h1>
+
+    <h2>You did it!</h2>
+
+and calling `<%= page.body %>` would yield:
+
+    <h1><%= page.title %></h1>
+
+    <h2>You did it!</h2>
+
+### The Content Attribute
+
+The `content` attribute contains the rendered body of a content page.  Like the `data` and `body` attributes, the `content` attribute is automatically inserted into every content page and **cannot** be altered in the header.  The rendered body contained within the `content` attribute is **only** available inside a view template.
+
+For example, given the following content page:
+
+    ---
+    title: Congratulations!
+    ---
+    <h1><%= page.title %></h1>
+
+    <h2>You did it!</h2>
+
+Calling `<%= page.content %>` in a view template would yield:
+
+    <h1>Congratulations!</h1>
+
+    <h2>You did it!</h2>
+
+THEMING
+-------
+
+Coming soon.  [Patches are welcome](https://github.com/ryansobol/mango/issues#issue/3).
+
+PUBLISHING
+----------
 
 ### 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).
+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 websites 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.
+If you haven't done so already, prepare your Mango website with Git.  Just initialize a new Git repository, add the project directory, and commit.
 
     $ cd /path/to/your/app
     $ git init
@@ -255,12 +332,25 @@ Finally, [deploy](http://docs.heroku.com/git) the heroku app.  If you've followe
 
     $ git push heroku master
 
-Now, bask in the glory of your *live application* in the cloud.
+Now, bask in the glory of your live website 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).
 
+### Deploying to a single target with secure FTP uploads
+
+Coming soon.  [Patches are welcome](https://github.com/ryansobol/mango/issues#issue/4).
+
+### Deploying to multiple targets with Capistrano
+
+Coming soon.  [Patches are welcome](https://github.com/ryansobol/mango/issues#issue/5).
+
+EXTENDING
+---------
+
+Coming soon.  [Patches are welcome](https://github.com/ryansobol/mango/issues#issue/73).
+
 PHILOSOPHY
 ----------
 
@@ -285,7 +375,7 @@ Is Mango not behaving like you expect it should?  Please forgive me.  Submit a r
 
 ### Submitting Patches
 
-Is Mango not behaving like you need?  Patches are always welcomed and appreciated.  [Report your issue](https://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](https://github.com/ryansobol/mango/issues).
+Is Mango not behaving like you need?  Patches are always welcome and appreciated.  [Report your issue](https://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](https://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.
 

data/lib/mango/content_page.rb

@@ -8,7 +8,7 @@ module Mango
   # user-generated data into markup like HTML.  It accomplishes this task by utilizing a variety of
   # content engines.
   #
-  # A `ContentPage` file contains **a body** and possibly **a header**.
+  # A `ContentPage` file contains two optional components -- a body and a header.
   #
   # ### Example content file
   #
@@ -24,14 +24,14 @@ module Mango
   #     until there is no Mango left.
   #     Not even for Mango!
   #
-  # Mangos aside, let's bring attention to a few important facets of this example and content files
-  # in general.
+  # Mangos aside, the above example highlights the key facets of writing a content page.
   #
-  # 1. A content page is stored as file on disk.  Here, the file name is `mango_poem.markdown`.
-  # 2. The header is defined first, embedded within triple-dashed ("---") dividers.
+  # 1. A content page is stored as a file in the `content` directory  Here, the file name is
+  #    `mango_poem.markdown`.
+  # 2. The header, if defined, comes first and is embedded within triple-dashed `---` dividers.
   # 3. The body comes second, nestled comfortably below the header.
   # 4. The header is composed of key-value attribute pairs in [YAML](http://www.yaml.org/) format.
-  # 5. The file's extension signals that the body should treated as Markdown.
+  # 5. The file's extension signals that the body should be treated as Markdown.
   #
   # ### The Header
   #
@@ -45,14 +45,14 @@ module Mango
   #
   # ### The Body
   #
-  # The body of a content file can be written in many human and designer friendly formats.  It's the
-  # content file's extension that determines the format, and therefore, the template engine used to
+  # The body of a content file supports many writer and designer friendly formats.  The content
+  # file's extension determines the body's format, and therefore, the template engine used to
   # convert the body into markup like HTML.  For a list of supported content page template engines,
   # and their formats, see `Mango::ContentPage::TEMPLATE_ENGINES`.
   #
   # Each `ContentPage` instance is passed into their body and view templates as the `page` local
-  # variable.  For example, this is how to access the raw data, unrendered body, and rendered
-  # content of a content page inside an ERB template:
+  # variable.  For example, this is how to access the complete data, pre-rendered body, and
+  # rendered content of a content page inside an ERB template:
   #
   #     <p><%= page.data %></p>
   #     <p><%= page.body %></p>

data/lib/mango/templates/Gemfile

@@ -1,3 +1,3 @@
 # encoding: UTF-8
 source "http://rubygems.org"
-gem "mango", "~> 0.6.2"
+gem "mango", "~> 0.6.3"

data/lib/mango/version.rb

@@ -2,5 +2,5 @@
 
 module Mango
   # Current stable released version
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/spec/lib/runner_spec.rb

@@ -81,7 +81,7 @@ run Mango::Application
       File.read(expected).should == <<-EOS
 # encoding: UTF-8
 source "http://rubygems.org"
-gem "mango", "~> 0.6.2"
+gem "mango", "~> 0.6.3"
       EOS
     end
 
@@ -379,4 +379,4 @@ h2
     end
 
   end
-end
+end

data/spec/lib/version_spec.rb

@@ -4,7 +4,7 @@ require "spec_helper"
 describe Mango do
   describe "version synchronizing" do
     before(:all) do
-      @expected = "0.6.2"
+      @expected = "0.6.3"
     end
 
     it "is correct for Mango::VERSION" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Ryan Sobol
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-06 00:00:00 -04:00
+date: 2013-11-28 00:00:00 +08:00
 default_executable: mango
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -375,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: mango
-rubygems_version: 1.3.7
+rubygems_version: 1.3.7.1
 signing_key: 
 specification_version: 3
 summary: Mango is a dynamic, database-free, and open source website framework.