ruhoh 2.1 → 2.2

data/Gemfile

@@ -3,11 +3,16 @@ gemspec
 
 gem 'rack', "~> 1.4"
 gem 'directory_watcher', "~> 1.4.0"
-gem 'psych', "~> 1.3"#, :platforms => [:ruby_18, :mingw_18]
+gem 'psych', "~> 1.3", :platforms => [:ruby_18, :mingw_18]
 gem 'redcarpet', "~> 2.1"
 gem 'nokogiri', "~> 1.5"
 
 group :development do
-  gem 'rspec', "~> 2"
   gem 'rake'
 end
+
+group :test do
+  gem 'cucumber'
+  gem 'capybara'
+  gem "rspec-expectations"
+end

data/README.md

@@ -1,19 +1,29 @@
+[![Build Status](https://travis-ci.org/ruhoh/ruhoh.rb.png?branch=master)](https://travis-ci.org/ruhoh/ruhoh.rb)
+
 ## Ruhoh is the Universal Static Blog API
 
-<http://ruhoh.com>
+Usage and quick start information at <http://ruhoh.com>
+
+### Running the Latest Version
 
-### Usage
+All official releases are pushed out to <http://rubygems.org/gems/ruhoh> which can be used with bundler via Gemfile entry:
 
-This is the new ruhoh 2.x.alpha code.
+```ruby
+gem 'ruhoh'
+```
 
-Please follow the directions on the [new 2.0.alpha blog scaffold](https://github.com/ruhoh/blog/tree/2.0.alpha#readme)
+The master branch will refer to the next version and can be used in the Gemfile:
+
+```ruby
+gem 'ruhoh' :git => "git@github.com:ruhoh/ruhoh.rb.git"
+```
 
 ### Platforms
 
-ruhoh is tested with ruby 1.9.2 on mac OSX Lion.
+ruhoh has official support for ruby 1.9.2, 1.9.3, ruby 2.0.0
 ruhoh runs in production with ruby 1.9.2 on Ubuntu 10.04.4 LTS.
 
-ruby 1.8.7 will not be (consciously) supported unless enough users bother me about it.
+ruby 1.8.7 is not supported.
 
 **Windows**
 
@@ -22,4 +32,37 @@ ruhoh should run on Windows with a few considerations:
 If you run into trouble with YAML and psych see: https://github.com/ruhoh/ruhoh.rb/issues/54
 More help is available here: https://github.com/ruhoh/ruhoh.rb/issues/search?q=windows
 
-I can't easily test ruhoh on a Windows machine, so please consider contributing back to the community for running on Windows.
+I can't easily test ruhoh on a Windows machine, so please consider contributing back to the community for running on Windows.
+
+### Contributing
+
+I enjoy getting better at managing contributions so all skill levels are welcome.
+
+Tips to ensure your work has the best chance of getting merged in:
+
+- Feel free to ask for guidance at any time via issues, twitter, or the google group.
+- Code quality does matter, but I'd rather encourage collaboration to make the code better than to scare you away from trying.
+- Always work in a feature branch and periodically rebase this branch with master to keep in sync.
+- Ensure any kind of indent or whitespace formatting is done in a separate commit _first_.
+- The feature branch should be single-purpose and not include wide-reaching changes because it will be too hard to verify your changes.
+- Do not do any version bumping. Bonus points if you are familiar with [semver](http://semver.org) and add features in a backwards compatible manner.
+- Working on major release updates is 100% encouraged, but best to start a dialogue first since it will take time to merge in.
+- **Super Bonus points for adding cucumber tests for your feature or fix.**
+
+### Testing
+
+We use [Cucumber](http://cukes.info) for integration tests. Please have a look at <https://github.com/ruhoh/ruhoh.rb/tree/master/features> to see how to quickly write out tests.
+It should be quite fast to make new tests if you take advantage of the current [step_defs](https://github.com/ruhoh/ruhoh.rb/blob/master/features/step_defs.rb).
+
+### Reporting Issues
+
+Please use GitHub's issue tracker to report all issues and bugs.
+
+If you are familiar enough with cucumber, it's best to include a failing `test.feature` file that sets up your situation and shows how the expected behavior is failing.
+In this way the bug can instantly be verified, a fix can be put in and a regression test will already exist =)
+
+### Community
+
+- <http://ruhoh.com>
+- <https://twitter.com/ruhohblog>
+- <https://groups.google.com/forum/?fromgroups#!forum/ruhoh>

data/Rakefile

@@ -3,7 +3,6 @@ require 'rubygems'
 require 'rake'
 require 'bundler'
 require 'ruhoh/version'
-require 'rspec/core/rake_task'
 
 name = Dir['*.gemspec'].first.split('.').first
 gemspec_file = "#{name}.gemspec"
@@ -21,11 +20,4 @@ task :build do
   sh "mkdir -p pkg"
   sh "gem build #{gemspec_file}"
   sh "mv #{gem_file} pkg"
-end
-
-## Tests
-
-RSpec::Core::RakeTask.new('spec')
-
-desc "Run tests"
-task :default => :spec
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: -r features

data/features/categories.feature

@@ -0,0 +1,38 @@
+Feature: Categories
+  As a content publisher
+  I want to add categories to pages
+  so that I can better organize and provide better access to my content for my readers
+
+  Scenario: Displaying a page's categories
+    Given some files with values:
+      | file | categories | body |
+      | essays/hello.md | apple, banana, pear | {{# page.categories }} <span>{{ name }}</span> {{/ page.categories }} |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "span|apple"
+      And this file should contain the content node "span|banana"
+      And this file should contain the content node "span|pear"
+
+  Scenario: Displaying a collection's categories with counts
+    Given some files with values:
+      | file | categories | body |
+      | _root/index.md | | {{# essays.categories.all }} <span>{{ name }}-{{ count }}</span> {{/ essays.categories.all }} |
+      | essays/hello.md | apple, banana, pear | |
+      | essays/goodbye.md | apple, banana, pear, watermelon | |
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "span|apple-2"
+      And this file should contain the content node "span|banana-2"
+      And this file should contain the content node "span|pear-2"
+      And this file should contain the content node "span|watermelon-1"
+
+  Scenario: Displaying a specific categories from a collection
+    Given some files with values:
+      | file | categories | body |
+      | _root/index.md | | {{# essays.categories.banana }} <span>{{ name }}-{{ count }}</span> {{/ essays.categories.banana }} |
+      | essays/hello.md | apple, banana, pear | |
+      | essays/goodbye.md | apple, banana, pear, watermelon | |
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should NOT contain the content node "span|apple-2"
+      And this file should contain the content node "span|banana-2"

data/features/conversion.feature

@@ -0,0 +1,35 @@
+Feature: Page Conversion
+  As a content publisher
+  I want my pages to be converted using the appropriate parser
+  so that I can have a more powerful publishing environment to write content.
+
+  Scenario: Converting a .txt document
+    Given some files with values:
+      | file              | body | blah |
+      | essays/hello.txt   |  cookie dough | tee hee |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello.txt"
+      And this file should contain the content "cookie dough"
+
+  Scenario: Converting a .json document
+    Given some files with values:
+      | file              | body |
+      | essays/hello.json   |  { "hello" : "world" } |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello.json"
+
+  Scenario: Converting a .md document
+    Given some files with values:
+      | file              | body |
+      | essays/hello.md   |  #cookie dough |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "h1|cookie dough"
+
+  Scenario: Converting a .markdown document
+    Given some files with values:
+      | file              | body |
+      | essays/hello.markdown |  _cookie dough_ |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "em|cookie dough"

data/features/data.feature

@@ -0,0 +1,32 @@
+Feature: Data
+  As a content publisher
+  I want to define arbitrary data objects
+  so I can quickly display and iterate through this data within my content
+
+  Scenario: Defining a basic data structure in data.yml
+    Given the file "data.yml" with body:
+      """
+      ---
+      name: "jade"
+      address:
+        city: "alhambra"
+      fruits:
+        - mango
+        - kiwi
+      """
+      And the file "_root/index.html" with body:
+        """
+        <name>{{ data.name }}</name>
+        <city>{{ data.address.city }}</city>
+        <ul>
+        {{# data.fruits }}
+          <li>{{ . }}</li>
+        {{/ data.fruits }}
+        </ul>
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "name|jade"
+      And this file should contain the content node "city|alhambra"
+      And this file should contain the content node "li|mango"
+      And this file should contain the content node "li|kiwi"

data/features/drafts.feature

@@ -0,0 +1,21 @@
+Feature: Drafts
+  As a content publisher
+  I want to maintain drafts
+  so that I can manage work-in-progress content alongside published content
+
+  Scenario: Defining a draft
+    Given some files with values:
+      | file |
+      | essays/drafts/hello.md |
+    When I compile my site
+    Then my compiled site should NOT have the file "essays/drafts/hello/index.html"
+    Then my compiled site should NOT have the file "essays/hello/index.html"
+
+  Scenario: Defining a nested draft
+    Given some files with values:
+      | file |
+      | essays/one/two/drafts/hello.md |
+    When I compile my site
+    Then my compiled site should NOT have the file "essays/one/two/drafts/hello/index.html"
+    Then my compiled site should NOT have the file "essays/one/two/hello/index.html"
+  

data/features/javascripts.feature

@@ -0,0 +1,42 @@
+Feature: Javascripts
+  As a content publisher
+  I want to load javascripts
+  so I can make my content interactive
+
+  Scenario: Defining javascripts
+    Given some files with values:
+      | file | body |
+      | javascripts/base.js | var meep; |
+      | javascripts/app.js | console.log('haro world') |
+      | javascripts/custom.js | console.log('haro world') |
+      And the file "_root/index.html" with body:
+        """
+        {{# javascripts.load }}
+          base.js
+          app.js
+          custom.js
+        {{/ javascripts.load }}",
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should have the fingerprinted javascripts "base, app, custom"
+
+  Scenario: Defining javascripts in a theme
+    Given a config file with values:
+      | sample_theme | { "use" : "theme" } |
+      And some files with values:
+        | file | body |
+        | javascripts/base.js | var meep; |
+        | sample_theme/javascripts/app.js | console.log('haro world') |
+        | sample_theme/javascripts/custom.js | (function() {}) |
+      And the file "_root/index.html" with body:
+        """
+        {{# javascripts.load }}
+          base.js
+          app.js
+          custom.js
+        {{/ javascripts.load }}",
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should have the fingerprinted javascripts "base, app, custom"

data/features/layouts.feature

@@ -0,0 +1,41 @@
+Feature: Layouts
+  As a content publisher
+  I want to use layouts
+  so that my site can have a unified look and feel while still being highly maintainable.
+
+  Scenario: Not using a layout
+    Given some files with values:
+      | file              | body | blah |
+      | essays/hello.md   |  cookie dough | tee hee |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content "cookie dough"
+
+  Scenario: Defining a default collection layout.
+    Given some files with values:
+      | file              | body |
+      | layouts/essays.md | <div id="minimal-layout">{{{ content }}}</div> |
+      | essays/hello.md   | meepio |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "div#minimal-layout|meepio"
+
+  Scenario: Defining a layout in page metadata.
+    Given some files with values:
+      | file              | body                    | layout  |
+      | layouts/custom.md | <div id="minimal-layout">{{{ content }}}</div>  |         |
+      | essays/hello.md   | meepio                  | custom  |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "div#minimal-layout|meepio"
+
+  Scenario: Defining a layout and sub layout.
+    Given some files with values:
+      | file               | body                         | layout  |
+      | layouts/default.md | <div id="minimal-layout">{{{ content }}}</div>       |         |
+      | layouts/essays.md  | <div id="minimal-sub-layout">{{{ content }}}</div>   | default |
+      | essays/hello.md    | cookie dough                 | essays  |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+      And this file should contain the content node "div#minimal-layout|cookie dough"
+      And this file should contain the content node "div#minimal-sub-layout|cookie dough"

data/features/pagination.feature

@@ -0,0 +1,55 @@
+Feature: Pagination
+  As a content publisher
+  I want to paginate my pages
+  so that my audience can better digest my content
+
+  Scenario: Disabling the paginator for a collection
+    Given a config file with values:
+      | essays | { "paginator" : { "enable" : false } } |
+      And some files with values:
+        | file | body |
+        | essays/hello.md | some hello content |
+        | essays/goodbye.md | some goodbye content |
+        | essays/caio.md | some caio content |
+    When I compile my site
+    Then my compiled site should NOT have the file "essays/index/1/index.html"
+
+  Scenario: Defining multiple pages in the same collection
+    Given some files with values:
+      | file | body |
+      | essays/hello.md | some hello content |
+      | essays/goodbye.md | some goodbye content |
+      | essays/caio.md | some caio content |
+    When I compile my site
+    Then my compiled site should have the file "essays/index/1/index.html"
+      And this file should have the links "/essays/hello, /essays/goodbye, /essays/caio"
+
+  Scenario: Configuring per_page and generating multiple pagination pages.
+    Given a config file with values:
+      | essays | { "paginator" : { "per_page" : 1 } } |
+      And some files with values:
+        | file | body |
+        | essays/hello.md | some hello content |
+        | essays/goodbye.md | some goodbye content |
+        | essays/caio.md | some caio content |
+    When I compile my site
+    Then my compiled site should have the file "essays/index/1/index.html"
+      And this file should have the links "/essays/caio, /essays/index/2, /essays/index/3"
+    Then my compiled site should have the file "essays/index/2/index.html"
+      And this file should have the links "/essays/goodbye, /essays/index/1, /essays/index/3"
+    Then my compiled site should have the file "essays/index/3/index.html"
+      And this file should have the links "/essays/hello, /essays/index/1, /essays/index/2"
+      And this file should NOT have the links "/essays/index/4"
+    Then my compiled site should NOT have the file "essays/index/4/index.html"
+
+  Scenario: Customizing the paginator url
+    Given a config file with values:
+      | essays | { "paginator" : { "url" : "/coolguy/index" } } |
+      And some files with values:
+        | file | body |
+        | essays/hello.md | some hello content |
+        | essays/goodbye.md | some goodbye content |
+        | essays/caio.md | some caio content |
+    When I compile my site
+    Then my compiled site should have the file "coolguy/index/1/index.html"
+      And this file should have the links "/essays/hello, /essays/goodbye, /essays/caio"

data/features/partials.feature

@@ -0,0 +1,13 @@
+Feature: Partials
+  As a content publisher
+  I want to maintain partials
+  so that I can reuse content without having to write it over and over
+
+  Scenario: Using a partial
+    Given some files with values:
+      | file | body |
+      | partials/watermelon.html | I like to eat watermelon =) |
+      | _root/index.md | {{> watermelon.html }} |
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content "I like to eat watermelon =)"

data/features/permalinks.feature

@@ -0,0 +1,118 @@
+Feature: Page Permalinks
+  As a content publisher
+  I want to customize the permalinks to my pages
+  so that my site is organized and can be accessed in an optimized way.
+
+  Scenario: Default Permalink format
+    Given some files with values:
+    | file              | body |
+    | essays/hello.md   |      |
+    When I compile my site
+    Then my compiled site should have the file "essays/hello/index.html"
+
+# in-page configuration
+
+  Scenario: Custom permalink format in page metadata.
+    Given some files with values:
+    | file              | permalink | body |
+    | essays/hello.md   | /yay/:path/:filename | |
+    When I compile my site
+    Then my compiled site should have the file "yay/essays/hello/index.html"
+
+  Scenario: Custom permalink format in page metadata using relative path.
+    Given some files with values:
+    | file              | permalink | body |
+    | essays/hello.md   | /:relative_path/:filename | |
+    When I compile my site
+    Then my compiled site should have the file "hello/index.html"
+
+  Scenario: Custom permalink format in page metadata using title.
+    Given some files with values:
+    | file              | permalink | title | body |
+    | essays/hello.md   | /:path/:title | Haro World | |
+    When I compile my site
+    Then my compiled site should have the file "essays/haro-world/index.html"
+
+  Scenario: Custom permalink format in page metadata using categories.
+    Given some files with values:
+    | file              | permalink | categories | body |
+    | essays/hello.md   | /:path/:categories/:filename | random stuff | |
+    When I compile my site
+    Then my compiled site should have the file "essays/random-stuff/hello/index.html"
+
+  Scenario: Custom permalink format in page metadata using date.
+    Given some files with values:
+    | file              | permalink | date | body |
+    | essays/hello.md   | /:path/:year/:month/:day/:filename | 2012-01-12 | |
+    When I compile my site
+    Then my compiled site should have the file "essays/2012/01/12/hello/index.html"
+
+  Scenario: Custom permalink format in page metadata using date with integer format.
+    Given some files with values:
+    | file              | permalink | date | body |
+    | essays/hello.md   | /:path/:year/:i_month/:i_day/:filename | 2012-01-02 | |
+    When I compile my site
+    Then my compiled site should have the file "essays/2012/1/2/hello/index.html"
+
+  Scenario: Literal permalink format in page metadata.
+    Given some files with values:
+    | file              | permalink | body |
+    | essays/hello.md   | /literal-page-permalink | |
+    When I compile my site
+    Then my compiled site should have the file "literal-page-permalink/index.html"
+
+## Collection configuration
+
+  Scenario: Custom permalink format in collection config.
+    Given a config file with values:
+      | essays | { "permalink" : "/yay/:path/:filename" } |
+      And some files with values:
+        | file              | body |
+        | essays/hello.md   | |
+    When I compile my site
+    Then my compiled site should have the file "yay/essays/hello/index.html"
+
+  Scenario: Custom permalink format in collection config using relative path.
+    Given a config file with values:
+      | essays | { "permalink" : "/:relative_path/:filename" } |
+      And some files with values:
+      | file              | body |
+      | essays/hello.md   | |
+    When I compile my site
+    Then my compiled site should have the file "hello/index.html"
+
+  Scenario: Custom permalink format in collection config using title.
+    Given a config file with values:
+      | essays | { "permalink" : "/:path/:title" } |
+      And some files with values:
+      | file              | title | body |
+      | essays/hello.md   | Haro World | |
+    When I compile my site
+    Then my compiled site should have the file "essays/haro-world/index.html"
+
+  Scenario: Custom permalink format in collection config using categories.
+    Given a config file with values:
+      | essays | { "permalink" : "/:path/:categories/:filename" } |
+      And some files with values:
+      | file              | categories | body |
+      | essays/hello.md   | random stuff | |
+    When I compile my site
+    Then my compiled site should have the file "essays/random-stuff/hello/index.html"
+
+  Scenario: Custom permalink format in collection config using date.
+    Given a config file with values:
+      | essays | { "permalink" : "/:path/:year/:month/:day/:filename" } |
+      And some files with values:
+      | file              | date | body |
+      | essays/hello.md   | 2012-01-12 | |
+    When I compile my site
+    Then my compiled site should have the file "essays/2012/01/12/hello/index.html"
+
+  Scenario: Custom permalink format in collection config using date with integer format.
+    Given a config file with values:
+      | essays | { "permalink" : "/:path/:year/:i_month/:i_day/:filename" } |
+      And some files with values:
+      | file              | date | body |
+      | essays/hello.md   | 2012-01-02 | |
+    When I compile my site
+    Then my compiled site should have the file "essays/2012/1/2/hello/index.html"