RubyGems - middleman-asciidoc - Versions diffs - 1.0.0.rc.2 → 1.0.0.rc.3 - Mend

middleman-asciidoc 1.0.0.rc.2 → 1.0.0.rc.3

Files changed (24) hide show

checksums.yaml +5 -5
data/Gemfile +7 -1
data/LICENSE.adoc +1 -1
data/README.adoc +222 -32
data/features/asciidoc.feature +356 -16
data/fixtures/asciidoc-app/source/ignored.adoc +4 -0
data/fixtures/asciidoc-app/source/inspect-standard-page-data.html.erb +10 -0
data/fixtures/asciidoc-app/source/layouts/showdate.erb +9 -0
data/fixtures/asciidoc-app/source/link-to-page.adoc +5 -0
data/fixtures/asciidoc-app/source/page-with-date-at-zone.adoc +5 -0
data/fixtures/asciidoc-app/source/page-with-date.adoc +5 -0
data/fixtures/asciidoc-app/source/safe-mode.adoc +3 -0
data/fixtures/asciidoc-app/source/site-information.adoc +6 -0
data/fixtures/asciidoc-app/source/standard-page-data.adoc +5 -0
data/lib/middleman-asciidoc/extension.rb +183 -48
data/lib/middleman-asciidoc/version.rb +1 -1
data/middleman-asciidoc.gemspec +11 -3
metadata +25 -14
data/.bundle/config +0 -4
data/.gitignore +0 -5
data/.ruby-version +0 -1
data/.travis.yml +0 -13
data/fixtures/asciidoc-app/source/hello-no-layout.adoc +0 -2
data/fixtures/asciidoc-app/source/hello-with-layout.adoc +0 -2

data/features/asciidoc.feature CHANGED Viewed

@@ -23,12 +23,12 @@ Feature: AsciiDoc Support
       </div>
       """
-  Scenario: Rendering html with default layout
+  Scenario: Rendering html with layout defined in extension config
     Given a fixture app "asciidoc-app"
     And a file named "config.rb" with:
       """
-      activate :asciidoc
-      set :layout, :default
+      activate :asciidoc, layout: :default
+      set :layout, :global
       """
     Given the Server is running at "asciidoc-app"
     When I go to "/hello.html"
@@ -48,9 +48,49 @@ Feature: AsciiDoc Support
       </html>
       """
-  Scenario: Rendering html with explicit layout
+  Scenario: Rendering html with no layout specified
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      set :layout, :default
+      """
+    And a file named "source/no-layout.adoc" with:
+      """
+      Hello, AsciiDoc!
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/no-layout.html"
+    Then I should see:
+      """
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <title>Fallback</title>
+      </head>
+      <body>
+      <div class="paragraph">
+      <p>Hello, AsciiDoc!</p>
+      </div>
+      </body>
+      </html>
+      """
+  Scenario: Rendering html with auto layout specified
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      set :layout, :default
+      """
+    And a file named "source/auto-layout.adoc" with:
+      """
+      :page-layout: _auto_layout
+      Hello, AsciiDoc!
+      """
     Given the Server is running at "asciidoc-app"
-    When I go to "/hello-with-layout.html"
+    When I go to "/auto-layout.html"
     Then I should see:
       """
       <!DOCTYPE html>
@@ -66,17 +106,129 @@ Feature: AsciiDoc Support
       </html>
       """
-  Scenario: Rendering html with no layout
+  Scenario: Rendering html with blank layout specified
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      set :layout, :default
+      """
+    And a file named "source/blank-layout.adoc" with:
+      """
+      :page-layout:
+      Hello, AsciiDoc!
+      """
     Given the Server is running at "asciidoc-app"
-    When I go to "/hello-no-layout.html"
+    When I go to "/blank-layout.html"
     Then I should see:
       """
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <title>Fallback</title>
+      </head>
+      <body>
       <div class="paragraph">
       <p>Hello, AsciiDoc!</p>
       </div>
+      </body>
+      </html>
       """
-  Scenario: Rendering html using title from document
+  Scenario: Rendering html with explicit layout specified
+    Given a fixture app "asciidoc-app"
+    And a file named "source/explicit-layout.adoc" with:
+      """
+      :page-layout: default
+      Hello, AsciiDoc!
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/explicit-layout.html"
+    Then I should see:
+      """
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <title>Fallback</title>
+      </head>
+      <body>
+      <div class="paragraph">
+      <p>Hello, AsciiDoc!</p>
+      </div>
+      </body>
+      </html>
+      """
+  Scenario: Rendering html with layout unset
+    Given a fixture app "asciidoc-app"
+    And a file named "source/unset-layout.adoc" with:
+      """
+      :!page-layout:
+      Hello, AsciiDoc!
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/unset-layout.html"
+    Then I should see:
+      """
+      <meta name="generator" content="Asciidoctor
+      """
+    Then I should see:
+      """
+      <div class="paragraph">
+      <p>Hello, AsciiDoc!</p>
+      </div>
+      """
+  Scenario: Rendering html with false layout specified
+    Given a fixture app "asciidoc-app"
+    And a file named "source/false-layout.adoc" with:
+      """
+      :page-layout: false
+      Hello, AsciiDoc!
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/false-layout.html"
+    Then I should see:
+      """
+      <meta name="generator" content="Asciidoctor
+      """
+    Then I should see:
+      """
+      <div class="paragraph">
+      <p>Hello, AsciiDoc!</p>
+      </div>
+      """
+  Scenario: Rendering html with ~ layout specified
+    Given a fixture app "asciidoc-app"
+    And a file named "source/minus-layout.adoc" with:
+      """
+      :page-layout: -
+      Hello, AsciiDoc!
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/minus-layout.html"
+    Then I should not see:
+      """
+      <!DOCTYPE html>
+      """
+    Then I should not see:
+      """
+      <meta name="generator" content="Asciidoctor
+      """
+    Then I should see:
+      """
+      <div class="paragraph">
+      <p>Hello, AsciiDoc!</p>
+      </div>
+      """
+  Scenario: Rendering html using title and tags from document
     Given the Server is running at "asciidoc-app"
     When I go to "/hello-with-title.html"
     Then I should see:
@@ -96,6 +248,54 @@ Feature: AsciiDoc Support
       </html>
       """
+  Scenario: Default safe mode for AsciiDoc processor
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      set :layout, :default
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/safe-mode.html"
+    Then I should see:
+      """
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <title>Safe Mode</title>
+      </head>
+      <body>
+      <div class="paragraph">
+      <p>safe</p>
+      </div>
+      </body>
+      </html>
+      """
+  Scenario: Setting safe mode on AsciiDoc processor
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc, safe: :unsafe
+      set :layout, :default
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/safe-mode.html"
+    Then I should see:
+      """
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <title>Safe Mode</title>
+      </head>
+      <body>
+      <div class="paragraph">
+      <p>unsafe</p>
+      </div>
+      </body>
+      </html>
+      """
   Scenario: Rendering html with title and layout from front matter
     Given the Server is running at "asciidoc-app"
     When I go to "/hello-with-front-matter.html"
@@ -114,7 +314,23 @@ Feature: AsciiDoc Support
       </html>
       """
-  Scenario: Merges page data in front matter and AsciiDoc header
+  Scenario: Ignoring files marked as ignored
+    Given the Server is running at "asciidoc-app"
+    When I go to "/ignored.html"
+    Then I should see:
+      """
+      <h1>File Not Found</h1>
+      """
+  Scenario: Publishing site information as AsciiDoc attributes
+    Given the Server is running at "asciidoc-app"
+    When I go to "/site-information.html"
+    Then I should see content matching %r{<p>site-root=.+/tmp/aruba/asciidoc-app</p>}
+    Then I should see content matching %r{<p>site-source=.+/tmp/aruba/asciidoc-app/source</p>}
+    Then I should see content matching %r{<p>site-destination=.+/tmp/aruba/asciidoc-app/build</p>}
+    Then I should see content matching %r{<p>site-environment=development</p>}
+  Scenario: Merging page data in front matter and AsciiDoc header
     Given the Server is running at "asciidoc-app"
     When I go to "/hello-with-mixed-page-data.html"
     Then I should see:
@@ -133,6 +349,41 @@ Feature: AsciiDoc Support
       </html>
       """
+  Scenario: Promoting standard AsciiDoc attributes to page data
+    Given the Server is running at "asciidoc-app"
+    When I go to "/inspect-standard-page-data.html"
+    Then I should see:
+      """
+      <p>Page Title</p>
+      <p>Doc Writer</p>
+      <p>Doc Writer | Junior Writer</p>
+      <p>doc.writer@example.com</p>
+      <p>This is a sample page.</p>
+      <p>meta, AsciiDoc, Middleman</p>
+      """
+  Scenario: Honor time zone specified in revdate
+    Given the Server is running at "asciidoc-app"
+    When I go to "/page-with-date-at-zone.html"
+    Then I should see:
+      """
+      <html data-date="2017-01-01T16:00:00Z">
+      """
+  Scenario: Add application time zone to revdate when none specified
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      set :time_zone, 'MST'
+      activate :asciidoc
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/page-with-date.html"
+    Then I should see:
+      """
+      <html data-date="2017-01-01T16:00:00Z">
+      """
   Scenario: Including a file relative to source root
     Given the Server is running at "asciidoc-app"
     When I go to "/master.html"
@@ -160,11 +411,24 @@ Feature: AsciiDoc Support
       </div>
       """
-  Scenario: Including a file relative to document in subdirectory when base_dir is set
+  Scenario: Including a file relative to document in subdirectory when base_dir is set to :source
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc, base_dir: :source
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/manual/index.html"
+    Then I should see:
+      """
+      <p>Unresolved directive in &lt;stdin&gt; - include::_chapters/ch01.adoc[]</p>
+      """
+  Scenario: Including a file relative to document in subdirectory when base_dir is set to app.source_dir
     Given a fixture app "asciidoc-app"
     And a file named "config.rb" with:
       """
-      activate :asciidoc, base_dir: app.source_dir.expand_path
+      activate :asciidoc, base_dir: app.source_dir
       """
     Given the Server is running at "asciidoc-app"
     When I go to "/manual/index.html"
@@ -173,6 +437,50 @@ Feature: AsciiDoc Support
       <p>Unresolved directive in &lt;stdin&gt; - include::_chapters/ch01.adoc[]</p>
       """
+  Scenario: Linking to a sibling page with directory indexes activated
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      activate :directory_indexes
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/link-to-page/"
+    Then I should see:
+      """
+      <p>See <a href="../code/">code</a> run.</p>
+      """
+  Scenario: Linking to a sibling page with directory indexes activated and trailing slash disabled
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      activate :directory_indexes
+      set :trailing_slash, false
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/link-to-page/"
+    Then I should see:
+      """
+      <p>See <a href="../code">code</a> run.</p>
+      """
+  Scenario: Linking to a sibling page with directory indexes activated and strip index file disabled
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc
+      activate :directory_indexes
+      set :strip_index_file, false
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/link-to-page/"
+    Then I should see:
+      """
+      <p>See <a href="../code/index.html">code</a> run.</p>
+      """
   Scenario: Linking to an image
     Given the Server is running at "asciidoc-app"
     When I go to "/gallery.html"
@@ -195,7 +503,39 @@ Feature: AsciiDoc Support
       </div>
       """
-  Scenario: imagesdir configuration should override imagesdir defined in page
+  Scenario: Restoring imagesdir to value defined in page
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc, attributes: %w(imagesdir=@)
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/custom-imagesdir.html"
+    Then I should see:
+      """
+      <div class="imageblock">
+      <div class="content">
+      <img src="img/tiger.gif" alt="tiger">
+      </div>
+      """
+  Scenario: Restoring imagesdir to default value
+    Given a fixture app "asciidoc-app"
+    And a file named "config.rb" with:
+      """
+      activate :asciidoc, attributes: %w(imagesdir!)
+      """
+    Given the Server is running at "asciidoc-app"
+    When I go to "/custom-imagesdir.html"
+    Then I should see:
+      """
+      <div class="imageblock">
+      <div class="content">
+      <img src="tiger.gif" alt="tiger">
+      </div>
+      """
+  Scenario: Overriding imagesdir attribute in page with imagesdir configuration
     Given a fixture app "asciidoc-app"
     And a file named "config.rb" with:
       """
@@ -215,21 +555,21 @@ Feature: AsciiDoc Support
     Given a fixture app "asciidoc-app"
     And a file named "config.rb" with:
       """
-      activate :asciidoc, attributes: %w(foo=bar)
+      activate :asciidoc, attributes: %w(bar=bar@ foo={bar}{baz})
       """
     Given the Server is running at "asciidoc-app"
     When I go to "/custom-attribute.html"
-    Then I should see "bar"
+    Then I should see "bar{baz}"
   Scenario: Configuring custom AsciiDoc attributes as Hash
     Given a fixture app "asciidoc-app"
     And a file named "config.rb" with:
       """
-      activate :asciidoc, attributes: { 'foo' => 'bar' }
+      activate :asciidoc, attributes: { 'bar' => 'bar@', 'foo' => '{bar}{baz}' }
       """
     Given the Server is running at "asciidoc-app"
     When I go to "/custom-attribute.html"
-    Then I should see "bar"
+    Then I should see "bar{baz}"
   Scenario: Highlighting source code
     Given a fixture app "asciidoc-app"

data/fixtures/asciidoc-app/source/ignored.adoc ADDED Viewed

@@ -0,0 +1,4 @@
+= Ignored
+:page-ignored:
+This page is not included in the generated site.

data/fixtures/asciidoc-app/source/inspect-standard-page-data.html.erb ADDED Viewed

@@ -0,0 +1,10 @@
+---
+layout: false
+---
+<% page_data = ((sitemap.find_resource_by_page_id 'standard-page-data') || (sitemap.find_resource_by_page_id 'standard-page-data.html')).data %>
+<p><%= page_data.title %></p>
+<p><%= page_data.author %></p>
+<p><%= (page_data.authors || []) * ' | ' %></p>
+<p><%= page_data.email %></p>
+<p><%= page_data.description %></p>
+<p><%= page_data.keywords %></p>

data/fixtures/asciidoc-app/source/layouts/showdate.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html data-date="<%= current_resource.data.date.getutc.iso8601 %>">
+<head>
+<title><%= current_resource.data.title || 'Fallback' %></title>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/fixtures/asciidoc-app/source/link-to-page.adoc ADDED Viewed

@@ -0,0 +1,5 @@
+= Code
+ifdef::relfilesuffix[:outfilesuffix: {relfilesuffix}]
+See <<code.adoc#,code>> run.

data/fixtures/asciidoc-app/source/page-with-date-at-zone.adoc ADDED Viewed

@@ -0,0 +1,5 @@
+= Time Zone Sensitive
+:revdate: 2017-01-01 09:00 MST
+:page-layout: showdate
+content

data/fixtures/asciidoc-app/source/page-with-date.adoc ADDED Viewed

@@ -0,0 +1,5 @@
+= Time Sensitive
+:revdate: 2017-01-01 09:00
+:page-layout: showdate
+content

data/fixtures/asciidoc-app/source/safe-mode.adoc ADDED Viewed

@@ -0,0 +1,3 @@
+= Safe Mode
+{safe-mode-name}

data/fixtures/asciidoc-app/source/site-information.adoc ADDED Viewed

@@ -0,0 +1,6 @@
+= Site Information
+* site-root={site-root}
+* site-source={site-source}
+* site-destination={site-destination}
+* site-environment={site-environment}

data/fixtures/asciidoc-app/source/standard-page-data.adoc ADDED Viewed

@@ -0,0 +1,5 @@
+= Page Title
+Doc Writer <doc.writer@example.com>; Junior Writer
+:showtitle:
+:description: This is a sample page.
+:keywords: meta, AsciiDoc, Middleman