awestruct 0.4.8 → 0.5.0.cr

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rspec'
+require 'logger'
+require 'fileutils'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before :all do
+    FileUtils.mkdir('.awestruct') unless File.exists? '.awestruct'
+    $LOG = Logger.new('.awestruct/test.log')
+  end
+  config.mock_framework = :rspec
+  config.include NokogiriMatchers
+  config.after :all do
+    FileUtils.rm_rf '.awestruct' if File.exists? '.awestruct'
+  end
+end

data/spec/support/nokogiri_matchers.rb

@@ -0,0 +1,21 @@
+require 'nokogiri'
+
+module NokogiriMatchers
+  class HtmlMatchers
+    def initialize(tag)
+      @tag = tag.to_s
+    end
+    def matches?(document)
+      @document = Nokogiri::HTML.fragment document
+      !@document.search(@tag).nil?
+    end
+
+    def failure_message_for_should
+      "expected to find #{@tag} within #{@document.to_s} but was not found"
+    end
+  end
+
+  def have_tag(expect)
+    HtmlMatchers.new(expect)
+  end
+end

data/spec/support/shared_handler_example.rb

@@ -0,0 +1,98 @@
+require 'awestruct/engine'
+require 'awestruct/config'
+require 'rspec'
+
+require 'hashery/open_cascade'
+
+REQUIRED_VARIABLES = [:page, :simple_name, :syntax, :extension]
+ALL_VARIABLES = REQUIRED_VARIABLES + [:format, :matcher, :unless]
+
+shared_examples "a handler" do |theories|
+
+  def handler_file(path)
+    "#{@site.config.dir}/#{path}"
+  end
+
+  def create_context
+    OpenCascade.new :site=>@site
+  end
+
+  describe Awestruct::Handlers do
+
+    before :all do
+
+      @engine = Awestruct::Engine.new(
+                    Awestruct::Config.new( File.expand_path(File.dirname(__FILE__) + '/../') + '/test-data/handlers' ))
+      @engine.load_default_site_yaml
+      @site = @engine.site
+
+      @site.merge! additional_config if respond_to?("additional_config")
+    end
+
+    def create_handler(page)
+      @engine.load_page File.join(@engine.config.dir, page)
+    end
+
+    theories.each do |theory|
+
+      # Validate input
+      missing = []
+      REQUIRED_VARIABLES.each do |key|
+        missing << key unless theory.has_key? key
+      end
+      raise "Missing required variable(s) '#{missing.join(', ')}'. Requires all '#{REQUIRED_VARIABLES.join(', ')}'" if missing.size > 0
+
+      unknown = theory.keys-ALL_VARIABLES
+      raise "Unknown theory variable(s) '#{unknown.join(', ')}'. Supported variables '#{ALL_VARIABLES.join(', ')}'" if unknown.size > 0
+
+      # Prove the theory
+
+      it "should provide simple name '#{theory[:simple_name]}' for page '#{theory[:page]}'" do
+        handler = create_handler theory[:page]
+        handler.simple_name.should == theory[:simple_name]
+      end
+
+      it "should provide content syntax '#{theory[:syntax]}' for page '#{theory[:page]}'" do
+        handler = create_handler theory[:page]
+        handler.content_syntax.should == theory[:syntax]
+      end
+
+      it "should provide output extension '#{theory[:extension]}' for page '#{theory[:page]}'" do
+        handler = create_handler theory[:page]
+        handler.output_extension.should == theory[:extension]
+      end
+
+      if !theory[:format].nil?
+        it "should set the engine format '#{theory[:format]}' for page '#{theory[:page]}'" do
+          page = create_handler theory[:page]
+          handler = page.handler
+          begin
+            handler = handler.delegate
+          end while handler.delegate and !handler.kind_of?(Awestruct::Handlers::TiltHandler)
+          handler.should_not be_nil
+          handler.options[:format].should == theory[:format]
+        end
+      end
+
+      if !theory[:matcher].nil?
+
+        it "should render page '#{theory[:page]}'" do
+          if theory[:unless].nil? or !theory[:unless][:exp].call()
+            handler = create_handler theory[:page]
+            handler.merge! additional_config_page if respond_to?("additional_config_page")
+
+            output = handler.rendered_content( handler.create_context )
+            output.should_not be_nil
+
+            theory[:matcher].call(output, handler) if theory[:matcher].arity == 2
+            theory[:matcher].call(output) if theory[:matcher].arity == 1
+          else
+            pending theory[:unless][:message]
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/test-data/engine/_config/arbitrary.yml

@@ -0,0 +1,2 @@
+
+name: randomness

data/spec/test-data/engine/_config/other.yml

@@ -0,0 +1 @@
+tags: [ 'a', 'b', 'c' ]

data/spec/test-data/engine/_config/site.yml

@@ -0,0 +1,14 @@
+
+profiles:
+  development:
+    cook: microwave
+  production:
+    cook: oven
+  staging:
+    compass_line_comments: off
+
+title: Awestruction!
+
+asciidoctor:
+  :attributes:
+    backend: html4

data/spec/test-data/front-matter-file-no-content.txt

@@ -0,0 +1,2 @@
+---
+foo: bar

data/spec/test-data/front-matter-file-no-front.txt

@@ -0,0 +1 @@
+This is some content

data/spec/test-data/front-matter-file.txt

@@ -0,0 +1,4 @@
+---
+foo: bar
+---
+This is some content

data/spec/test-data/handlers/asciidoc-page.ad

@@ -0,0 +1,3 @@
+= Title
+
+This is *AsciiDoc* in Awestruct.

data/spec/test-data/handlers/asciidoc-page.adoc

@@ -0,0 +1,3 @@
+= Title
+
+This is *AsciiDoc* in Awestruct.

data/spec/test-data/handlers/asciidoc-page.asciidoc

@@ -0,0 +1,3 @@
+= Title
+
+This is *AsciiDoc* in Awestruct.

data/spec/test-data/handlers/asciidoctor_with_front_matter.ad

@@ -0,0 +1,6 @@
+---
+title: AwestructAsciiDoc
+---
+= AsciiDoc
+
+This is *AsciiDoc* in Awestruct.

data/spec/test-data/handlers/asciidoctor_with_headers.ad

@@ -0,0 +1,8 @@
+= AsciiDoc
+Stuart Rackham
+2013-02-06
+:awestruct-tags: [a, b, c]
+:name: NOT_HANDLED
+
+This is *AsciiDoc* in {name}.
+{awestruct-version}

data/spec/test-data/handlers/coffeescript-page.coffee

@@ -0,0 +1,8 @@
+# Assignment:
+number   = 42
+opposite = true
+
+# Conditions:
+number = -42 if opposite
+
+print number

data/spec/test-data/handlers/erb-page.html.erb

@@ -0,0 +1,6 @@
+<%# @encoding:UTF-8 %>
+<h1>This is an ERB page</h1>
+<h2>The fruit of the day is: <%= "apples" %></h2>
+<h3><%=site.crunchy%></h3>
+
+<p>Besøg fra Danmark</p>

data/spec/test-data/handlers/erb-page.xml.erb

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<h><%=site.crunchy%></h>

data/spec/test-data/handlers/erb-utf-page.html.erb

@@ -0,0 +1,2 @@
+<%# @encoding:UTF-8 %>
+Besøg fra Danmark

data/spec/test-data/handlers/haml-layout-two.html.haml

@@ -0,0 +1,7 @@
+---
+layout: haml-layout
+---
+
+%h1 Welcome to Awestruct
+
+= content

data/spec/test-data/handlers/haml-layout.html.haml

@@ -0,0 +1,4 @@
+
+%h1 This is a haml layout
+
+%h2= content

data/spec/test-data/handlers/haml-page.atom.haml

@@ -0,0 +1,4 @@
+!!! XML
+%feed(xmlns='http://www.w3.org/2005/Atom')
+  %id http://example.com
+  %title A News Feed

data/spec/test-data/handlers/haml-page.html.haml

@@ -0,0 +1,2 @@
+
+%h1 This is a HAML page

data/spec/test-data/handlers/haml-page.xml.haml

@@ -0,0 +1 @@
+%h1 This is a HAML page

data/spec/test-data/handlers/haml-with-markdown-page.html.haml

@@ -0,0 +1,6 @@
+---
+title: A Sample Page With Markdown
+---
+:markdown
+  # Hello From Markdown
+

data/spec/test-data/handlers/haml-with-textile-page.html.haml

@@ -0,0 +1,6 @@
+---
+title: A Sample Page With Textile
+---
+:textile
+  h1. Hello From Textile
+

data/spec/test-data/handlers/haml-with-utf.html.haml

@@ -0,0 +1,2 @@
+-# coding: utf-8
+%h1 Besøg fra Danmark

data/spec/test-data/handlers/haml-with-variables.html.haml

@@ -0,0 +1,2 @@
+%h1 #{site.crunchy}
+

data/spec/test-data/handlers/inner-page.html.haml

@@ -0,0 +1,4 @@
+---
+layout: haml-layout
+---
+This is the inner page

data/spec/test-data/handlers/javascript-page.js

@@ -0,0 +1 @@
+var crunchy = "#{site.crunchy}"

data/spec/test-data/handlers/less-page-include.less

@@ -0,0 +1 @@
+@variable: 1;

data/spec/test-data/handlers/less-page-with-import.less

@@ -0,0 +1,4 @@
+@import "less-page-include.less";
+.class {
+  width: 1 + @variable;
+}

data/spec/test-data/handlers/less-page.less

@@ -0,0 +1,4 @@
+@variable: 1;
+.class {
+  width: 1 + @variable;
+}

data/spec/test-data/handlers/markdown-page.markdown

@@ -0,0 +1,2 @@
+
+# This is a Markdown page

data/spec/test-data/handlers/markdown-page.md

@@ -0,0 +1,2 @@
+
+# This is a Markdown page

data/spec/test-data/handlers/markdown-page.mkd

@@ -0,0 +1,2 @@
+
+# This is a Markdown page

data/spec/test-data/handlers/mustache-page.html.mustache

@@ -0,0 +1,2 @@
+
+<h1>This is a {{site.markup_type}} page</h1>

data/spec/test-data/handlers/mustache-page.xml.mustache

@@ -0,0 +1 @@
+<h1>This is a {{site.markup_type}} page</h1>

data/spec/test-data/handlers/orgmode-page.org

@@ -0,0 +1,6 @@
+* Fruit 
+** Apples 
+Apples are red 
+** Oranges 
+Oranges are orange 
+*Vegetables

data/spec/test-data/handlers/outer-layout.html.haml

@@ -0,0 +1,2 @@
+%b
+  = content

data/spec/test-data/handlers/outside_relative/git_keep

@@ -0,0 +1,3 @@
+Just here to keep the directory for git
+
+Used in tilt_handler_spec.rb to test relative_source_path nil handling

data/spec/test-data/handlers/redirect-page.redirect

@@ -0,0 +1 @@
+http://#{site.crunchy}.com

data/spec/test-data/handlers/restructuredtext-page.rst

@@ -0,0 +1,8 @@
+
+This is a paragraph.  It's quite
+short.
+
+   This paragraph will result in an indented block of
+   text, typically used for quoting other text.
+
+This is another one.

data/spec/test-data/handlers/sass-page-include.sass

@@ -0,0 +1 @@
+$main-color: #ce4dd6

data/spec/test-data/handlers/sass-page.sass

@@ -0,0 +1,4 @@
+@import "sass-page-include"
+
+#test
+	background-color: $main-color

data/spec/test-data/handlers/scss-page-include.scss

@@ -0,0 +1 @@
+$main-color: #ce4dd6;

data/spec/test-data/handlers/scss-page.scss

@@ -0,0 +1,5 @@
+@import "scss-page-include";
+
+#test {
+	background-color: $main-color;
+}

data/spec/test-data/handlers/simple-redirect-page.redirect

@@ -0,0 +1 @@
+http://google.com

data/spec/test-data/handlers/slim-page.atom.slim

@@ -0,0 +1,4 @@
+doctype xml
+feed xmlns='http://www.w3.org/2005/Atom'
+  id http://example.com
+  title A News Feed

data/spec/test-data/handlers/slim-page.html.slim

@@ -0,0 +1 @@
+h1 This is a Slim page

data/spec/test-data/handlers/slim-page.xml.slim

@@ -0,0 +1 @@
+h1 This is a Slim page

data/spec/test-data/handlers/slim-with-markdown-page.html.slim

@@ -0,0 +1,5 @@
+---
+title: A Sample Page With Markdown
+---
+markdown:
+  # Hello From Markdown

data/spec/test-data/handlers/slim-with-utf.html.slim

@@ -0,0 +1,2 @@
+-# coding: utf-8
+h1 Besøg fra Danmark

data/spec/test-data/handlers/slim-with-variables.html.slim

@@ -0,0 +1 @@
+h1 #{site.crunchy}

data/spec/test-data/handlers/textile-page.textile

@@ -0,0 +1 @@
+h3. Test

data/spec/test-data/index.html

@@ -0,0 +1,242 @@
+<html>
+  <head>
+    <meta charset='utf-8' />
+    <title>awestruct: home</title>
+    <link href='/news.atom' rel='alternate' type='application/atom+xml' />
+    <meta content='width=device-width, initial-scale=1.0' name='viewport' />
+    <style type='text/css'>
+      /*<![CDATA[*/
+        body {
+          padding-top: 60px;
+        }
+      /*]]>*/
+    </style>
+    <script src='http://code.jquery.com/jquery-1.7.2.min.js' type='text/javascript'></script>
+    <link href='http://staging.awestruct.org/stylesheets/styles.css' rel='stylesheet' type='text/css' />
+    <link href='http://yandex.st/highlightjs/7.0/styles/default.min.css' rel='stylesheet' />
+    <script src='http://yandex.st/highlightjs/7.0/highlight.min.js'></script>
+    <!--[if lt IE 9]>
+      <script src='http://html5shim.googlecode.com/svn/trunk/html5.js' type='text/javascript'></script>
+    <![endif]-->
+    <script type='text/javascript'>
+      //<![CDATA[
+        $.getJSON("https://rubygems.org/api/v1/versions/awestruct.json?callback=?", function(data) { alert( data.number ); });
+        hljs.initHighlightingOnLoad();
+      //]]>
+    </script>
+  </head>
+  <body>
+    <div class='navbar navbar-fixed-top'>
+      <div class='navbar-inner'>
+        <div class='container'>
+          <div class='github-banner'>
+            <a href='https://github.com/awestruct/awestruct'>
+              <img alt='Fork me on GitHub' src='https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png' style='position: absolute; top: 0; right: 0; border: 0;z-index: 900;' />
+            </a>
+          </div>
+          <a class='brand' href='http://staging.awestruct.org'>{:awestruct}</a>
+          <ul class='nav'>
+            <li>
+              <a href='http://staging.awestruct.org'>Home</a>
+            </li>
+            <li>
+              <a href='http://staging.awestruct.org/news/'>News</a>
+            </li>
+            <li class='dropdown' id='getting-started-menu'>
+              <a class='dropdown-toggle' data-toggle='dropdown' href='#getting-started-menu'>
+                Documentation
+                <b class='caret'></b>
+              </a>
+              <ul class='dropdown-menu'>
+                <li>
+                  <a href='http://staging.awestruct.org/getting_started/'>Getting Started</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/layout/'>Project Layout</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/profiles/'>Site Profiles</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/file_types/'>File Types</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/skins/'>Skins</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/template_context/'>Template Context</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/deployment/'>Site Deployment</a>
+                </li>
+              </ul>
+            </li>
+            <li class='dropdown' id='extensions-menu'>
+              <a class='dropdown-toggle' data-toggle='dropdown' href='#extensions-menu'>
+                Extensions
+                <b class='caret'></b>
+              </a>
+              <ul class='dropdown-menu'>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/'>Overview</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/atomizer/'>Atomizer</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/data_dir/'>DataDir</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/disqus/'>Disqus</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/flattr/'>Flattr</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/indexifier/'>Indexifier</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/intense_debate/'>IntenseDebate</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/paginator/'>Paginator</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/posts/'>Posts</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/sitemap/'>Sitemap</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/tag_cloud/'>TagCloud</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/tagger/'>Tagger</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/extensions/textile/'>Textile</a>
+                </li>
+              </ul>
+            </li>
+            <li class='dropdown' id='helpers-menu'>
+              <a class='dropdown-toggle' data-toggle='dropdown' href='#helpers-menu'>
+                Helpers
+                <b class='caret'></b>
+              </a>
+              <ul class='dropdown-menu'>
+                <li>
+                  <a href='http://staging.awestruct.org/helpers/'>Overview</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/helpers/partial/'>Partial</a>
+                </li>
+                <li>
+                  <a href='http://staging.awestruct.org/helpers/google_analytics/'>Google Analytics</a>
+                </li>
+              </ul>
+            </li>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <div class='container'>
+      <div class='row'>
+        <div class='span3'>
+          <div class='well'>
+            <h2>Build Status</h2>
+            <p>
+              Travis-CI
+              <a href='http://travis-ci.org/awestruct/awestruct'>
+                <img src='https://secure.travis-ci.org/awestruct/awestruct.png' />
+              </a>
+            </p>
+            <p>
+              CloudBees
+              <a href='https://buildhive.cloudbees.com/job/awestruct/job/awestruct/'>
+                <img src='https://buildhive.cloudbees.com/job/awestruct/job/awestruct/badge/icon' />
+              </a>
+            </p>
+          </div>
+          <div id='sidebar'>
+            <ul class='nav nav-tabs nav-stacked'>
+              <li>
+                <a href='http://staging.awestruct.org/gallery/'>Gallery</a>
+              </li>
+              <li>
+                <a href='http://staging.awestruct.org/source/'>Source Code</a>
+              </li>
+              <li>
+                <a href='http://staging.awestruct.org/yardoc/'>API Documentation</a>
+              </li>
+              <li>
+                <a href='mailto:talk-subscribe@awestruct.org?subject=subscribe'>Mailing List</a>
+              </li>
+              <li>
+                <a href='http://talk-archive.awestruct.org/'>List Archives</a>
+              </li>
+              <li>
+                <a href='http://twitter.com/awestructed'>Twitter</a>
+              </li>
+            </ul>
+          </div>
+        </div>
+        <div class='span8'>
+          <div class='page-header'>
+  <h1>
+    { :awestruct }
+    <small>A static site-baking tool</small>
+  </h1>
+</div>
+<p>
+  Awestruct is a framework for creating static HTML sites, inspired by the
+  <a href='http://github.com/mojombo/jekyll'>Jekyll</a>
+  utility in the same genre.
+</p>
+<p>
+  Awestruct makes it trivially easy to create non-trivial static websites using
+  tools like
+  <a href='http://compass-style.org'>Compass,</a>
+  <a href='http://daringfireball.net/projects/markdown/syntax'>Markdown,</a>
+  and
+  <a href='http://haml-lang.com'>Haml,</a>
+  as well as common frameworks like Twitter Bootstrap and Blueprint.
+</p>
+<p>
+  The core concept of Awestruct is that of structures, specifically Ruby
+  `OpenStruct` structures. The struct aspect allows arbitrary, schema-less data
+  to be associated with a specific page or the entire site.
+</p>
+<p>
+  Site-specific data is automatically loaded from simple YAML files, while data
+  can be provided on pages using a front-matter prolog.
+</p>
+<div class='row'>
+  <div class='span4'>
+    <div class='well'>
+      <h2>
+        Install
+        <small>Version 0.4.5</small>
+      </h2>
+      <pre><code class='bash'>$ gem install awestruct</code></pre>
+    </div>
+  </div>
+  <div class='span4'>
+    <div class='well'>
+      <h2>Getting Started</h2>
+      <pre><code class='bash'>$ awestruct -i -f bootstrap</code></pre>
+    </div>
+  </div>
+</div>
+        </div>
+      </div>
+      <div class='row'>
+        <hr />
+        <footer>
+          <p>&copy; Bob McWhirter 2012</p>
+          <script src='http://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.1/jquery.min.js' type='text/javascript'></script>
+          <script src='http://staging.awestruct.org/javascript/bootstrap-dropdown.js' type='text/javascript'></script>
+        </footer>
+      </div>
+    </div>
+  </body>
+</html>