ruhoh 2.5 → 2.6

data/Gemfile

@@ -13,5 +13,5 @@ end
 group :test do
   gem 'cucumber'
   gem 'capybara'
-  gem "rspec-expectations"
+  gem 'rspec'
 end

data/bin/ruhoh

@@ -2,6 +2,13 @@
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+if File.exists?(ENV['BUNDLE_GEMFILE'])
+  require 'bundler/setup'
+  Bundler.require :default
+end
+
 require 'ruhoh'
 require 'ruhoh/version'
 require 'ruhoh/client'
@@ -13,7 +20,7 @@ options = Options.new
 
 opt_parser = OptionParser.new do |opts|
   opts.banner = 'Use `ruhoh help` for full command list.'
-  
+
   opts.on("--hg", "Use mercurial (hg) instead of git for source control.") do
     options.hg = true
   end
@@ -21,13 +28,13 @@ opt_parser = OptionParser.new do |opts|
   opts.on("-v", "--[no-]verbose", "Run verbosely. For pages, shows extra title, url meta-data.") do |v|
     options.verbose = v
   end
-    
+
   opts.on("--version", "Display current gem and ruhoh specification versions.") do
     puts "ruhoh " + Ruhoh::VERSION
     puts "RuhohSpec " + Ruhoh::RuhohSpec
     exit 0
   end
-  
+
 end
 opt_parser.parse!
 

data/features/_root.feature

@@ -0,0 +1,11 @@
+Feature: _root collection
+  As a content publisher
+  I want to include pages at my domain's root
+  so I can organize my content.
+
+  Scenario: Adding a page to _root folder
+  Given some files with values:
+    | file              | 
+    | _root/index.html  |
+  When I compile my site
+  Then my compiled site should have the file "index.html"

data/features/data.feature

@@ -61,3 +61,81 @@ Feature: Data
       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"
+
+
+  Scenario: Defining a basic data structure in data.json and merging with a theme data.json
+    Given a config file with values:
+      | theme-test | { "use" : "theme" } |
+      And the file "data.json" with body:
+      """
+      {
+        "address": {
+          "city": "alhambra"
+        }, 
+        "name": "jade", 
+        "fruits": [
+          "mango", 
+          "kiwi"
+        ]
+      }
+      """
+      And the file "theme-test/data.json" with body:
+        """
+        {
+          "address": {
+            "city": "Berkeley"
+          },
+          "greeting": "Hai!"
+        }
+        """
+      And the file "_root/index.html" with body:
+        """
+        <name>{{ data.name }}</name>
+        <city>{{ data.address.city }}</city>
+        <greeting>{{ data.greeting }}</greeting>
+        <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|Berkeley"
+      And this file should contain the content node "li|mango"
+      And this file should contain the content node "li|kiwi"
+      And this file should contain the content node "greeting|Hai!"
+
+Scenario: Defining a basic data structure in custom data collection
+  Given a config file with values:
+    | meta | { "use" : "data" } |
+  Given the file "meta/data.json" with body:
+    """
+    {
+      "address": {
+        "city": "alhambra"
+      }, 
+      "name": "jade", 
+      "fruits": [
+        "mango", 
+        "kiwi"
+      ]
+    }
+    """
+    And the file "_root/index.html" with body:
+      """
+      <name>{{ meta.data.name }}</name>
+      <city>{{ meta.data.address.city }}</city>
+      <ul>
+      {{# meta.data.fruits }}
+        <li>{{ . }}</li>
+      {{/ meta.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/javascripts.feature

@@ -40,3 +40,39 @@ Feature: Javascripts
     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: Using javascript objects to resolve url
+    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:
+        """
+        ---
+        custom: base.js
+        ---
+        {{# page.custom?to_javascripts }}
+          <script type="text/javascript" src="{{url}}"></script>
+        {{/ page.custom?to_javascripts }}
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should have the fingerprinted javascripts "base"
+
+  Scenario: Using javascript object to resolve url and id
+    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.all }}
+          <script type="text/javascript" id="{{id}}" src="{{url}}"></script>
+        {{/ javascripts.all }}
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should have the fingerprinted javascripts "app, base, custom"
+

data/features/permalinks.feature

@@ -10,6 +10,13 @@ Feature: Page Permalinks
     When I compile my site
     Then my compiled site should have the file "essays/hello/index.html"
 
+  Scenario: Default Permalink format with nested file
+    Given some files with values:
+    | file              | body |
+    | essays/one/two/hello.md   |      |
+    When I compile my site
+    Then my compiled site should have the file "essays/one/two/hello/index.html"
+
 # in-page configuration
 
   Scenario: Custom permalink format in page metadata.
@@ -54,6 +61,13 @@ Feature: Page Permalinks
     When I compile my site
     Then my compiled site should have the file "essays/2012/1/2/hello/index.html"
 
+  Scenario: Custom permalink format in page metadata using custom metadata attributes.
+    Given some files with values:
+    | file              | permalink | title | arbitrary_name | body |
+    | essays/hello.md   | /:path/:title/:arbitrary_name | Haro World | custom data | |
+    When I compile my site
+    Then my compiled site should have the file "essays/haro-world/custom-data/index.html"
+
   Scenario: Custom permalink format in page metadata using explicit html extension
     Given some files with values:
     | file              | permalink      |
@@ -139,3 +153,12 @@ Feature: Page Permalinks
       | 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"
+
+  Scenario: Custom permalink format in collection config using custom metadata
+    Given a config file with values:
+      | essays | { "permalink" : "/legacy/:custom_id/:rank" } |
+      And some files with values:
+      | file              | custom_id | rank | body |
+      | essays/hello.md   | 12345 | medium | |
+    When I compile my site
+    Then my compiled site should have the file "legacy/12345/medium/index.html"

data/features/plugins.feature

@@ -0,0 +1,84 @@
+Feature: Plugins
+  As a content publisher
+  I want to include custom plugins
+  so I have the freedom and power to customize my website and workflow.
+
+  Scenario: Loading a pages collection plugin from the plugins folder.
+    Given the file "plugins/pages_test.rb" with body:
+      """
+      module PagesTest
+        def test_plugin_method
+          "Hi this is output from the test plugin"
+        end
+      end
+      Ruhoh::Resources::Pages::CollectionView.send(:include, PagesTest)
+      """
+      And the file "_root/index.html" with body:
+        """
+        <output>{{ _root.test_plugin_method }}</output>
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "output|Hi this is output from the test plugin"
+
+  Scenario: Loading a pages model plugin from the plugins folder.
+    Given some files with values:
+      | file | date | body |
+      | _root/index.html | 2013-12-01 | <date>{{ page.friendly_date }}</date> |
+    Given the file "plugins/paged_model_view_addons.rb" with body:
+      """
+      module PagesModelViewAddons
+        def friendly_date
+          date.strftime("%B %d, %Y")
+        end
+      end
+      Ruhoh.model('pages').send(:include, PagesModelViewAddons)
+      """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "date|December 01, 2013"
+
+  Scenario: Loading a custom converter from the plugins folder.
+    Given some files with values:
+      | file | body |
+      | _root/index.strip | <output>the quick brown fox jumps over the lazy dog</output> |
+    Given the file "plugins/strip_converter.rb" with body:
+      """
+      class Ruhoh
+        module Converter
+          module Strip
+            def self.extensions
+              ['.strip']
+            end
+            def self.convert(content)
+              content.gsub(/\s/, '')
+            end
+          end
+        end
+      end
+      """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "output|thequickbrownfoxjumpsoverthelazydog"
+
+  Scenario: Loading a custom compiler from the plugins folder.
+    Given the file "plugins/test_compiler.rb" with body:
+      """
+      class Ruhoh
+        module Compiler
+          class Test
+            def initialize(ruhoh)
+              @ruhoh = ruhoh
+            end
+            def run
+              File.open(@ruhoh.compiled_path("test-file.txt"), 'w:UTF-8') do |p|
+                p.puts "Domo's World ^_^"
+              end
+            end
+          end
+        end
+      end
+      """
+    When I compile my site
+    Then my compiled site should have the file "test-file.txt"
+      And this file should contain the content "Domo's World ^_^"

data/features/sort_order.feature

@@ -0,0 +1,121 @@
+Feature: Page Sort Order
+  As a content publisher
+  I want to sort pages by a custom criteria
+  so my content makes intuitive sense to my audience.
+
+  Scenario: Default sort order - alpha title ascending
+    Given some files with values:
+      | file | body |
+      | essays/hello.md | |
+      | essays/zebra.md | |
+      | essays/apple.md | |
+      And the file "_root/index.md" with body:
+      """
+      <essays>
+        {{# essays.all }}{{ title }}-{{/ essays.all }}
+      </essays> 
+      """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "essays|Apple-Hello-Zebra-"
+
+  Scenario: Sort order alpha title descending
+    Given a config file with value:
+      """
+      { "essays" : {"sort" : ["title", "desc"]} }
+      """
+      And some files with values:
+        | file |
+        | essays/hello.md |
+        | essays/zebra.md |
+        | essays/apple.md |
+        And the file "_root/index.md" with body:
+        """
+        <essays>
+          {{# essays.all }}{{ title }}-{{/ essays.all }}
+        </essays> 
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "essays|Zebra-Hello-Apple-"
+
+
+  Scenario: Sort order date descending
+    Given a config file with value:
+      """
+      { "essays" : { "sort" : ["date", "desc"] } }
+      """
+      And some files with values:
+        | file            | date        |
+        | essays/hello.md | 2013-12-01  |
+        | essays/zebra.md | 2013-12-10  |
+        | essays/apple.md | 2013-12-25  |
+        And the file "_root/index.md" with body:
+        """
+        <essays>
+          {{# essays.all }}{{ title }}-{{/ essays.all }}
+        </essays> 
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "essays|Apple-Zebra-Hello-"
+
+  Scenario: Sort order date ascending
+    Given a config file with value:
+      """
+      { "essays" : { "sort" : ["date", "asc"] } }
+      """
+      And some files with values:
+        | file            | date        |
+        | essays/hello.md | 2013-12-01  |
+        | essays/zebra.md | 2013-12-10  |
+        | essays/apple.md | 2013-12-25  |
+        And the file "_root/index.md" with body:
+        """
+        <essays>
+          {{# essays.all }}{{ title }}-{{/ essays.all }}
+        </essays> 
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "essays|Hello-Zebra-Apple-"
+
+  Scenario: Sort order numerically coerced custom-attribute
+    Given a config file with value:
+      """
+      { "essays" : { "sort" : ["position", "asc"] } }
+      """
+      And some files with values:
+        | file            | position    |
+        | essays/hello.md | 2  |
+        | essays/zebra.md | 1  |
+        | essays/apple.md | 3  |
+        And the file "_root/index.md" with body:
+        """
+        <essays>
+          {{# essays.all }}{{ title }}-{{/ essays.all }}
+        </essays> 
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "essays|Zebra-Hello-Apple-"
+
+  Scenario: Sort order alpha coerced custom-attribute
+    Given a config file with value:
+      """
+      { "essays" : { "sort" : ["position", "asc"] } }
+      """
+      And some files with values:
+        | file            | position |
+        | essays/hello.md | c        |
+        | essays/zebra.md | b        |
+        | essays/apple.md | a        |
+        And the file "_root/index.md" with body:
+        """
+        <essays>
+          {{# essays.all }}{{ title }}-{{/ essays.all }}
+        </essays> 
+        """
+    When I compile my site
+    Then my compiled site should have the file "index.html"
+      And this file should contain the content node "essays|Apple-Zebra-Hello-"

data/features/step_defs.rb

@@ -52,7 +52,7 @@ end
 
 Then(/^my compiled site (should|should NOT) have the file "(.*?)"$/) do |matcher, path|
   @filepath = path
-  FileUtils.cd(@ruhoh.paths.compiled) {
+  FileUtils.cd(@ruhoh.config['compiled_path']) {
     # Done this way so the error output is more informative.
     files = Dir.glob("**/*").delete_if{ |a| File.directory?(a) }
     files.__send__(matcher, include(path)) 
@@ -61,7 +61,7 @@ end
 
 Then(/^my compiled site (should|should NOT) have the (?:directory|folder) "(.*?)"$/) do |matcher, path|
   @filepath = path
-  FileUtils.cd(@ruhoh.paths.compiled) {
+  FileUtils.cd(@ruhoh.config['compiled_path']) {
     # Done this way so the error output is more informative.
     files = Dir.glob("**/*").delete_if{ |a| File.file?(a) }
     files.__send__(matcher, include(path)) 
@@ -90,7 +90,7 @@ end
 Then(/^this file (should|should NOT) have the fingerprinted (stylesheets|javascripts) "(.*)"$/) do |matcher, filetype, names|
   names = names.split(/[\s,]+/).map(&:strip)
   files = nil
-  FileUtils.cd(File.join(@ruhoh.paths.compiled, 'assets', filetype)){
+  FileUtils.cd(File.join(@ruhoh.config['compiled_path'], 'assets', filetype)){
     files = Dir['*']
   }