resolves #187 honor layout defined in frontmatter defaults (PR #188)

mojavelinux · mojavelinux · commit 74f9cb263630 · 2018-11-08T22:13:43.000-07:00
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -5,6 +5,10 @@
 This document provides a high-level view of the changes to the {project-name} by release.
 For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
 
+== Unreleased
+
+* honor layout defined in frontmatter defaults (#187)
+
 == 2.1.0 (2017-05-21) - @mojavelinux
 
 * Add `tocify_asciidoc` Liquid filter for generating a table of contents from the parsed AsciiDoc document (Jekyll 3+ only) (#37)
diff --git a/README.adoc b/README.adoc
@@ -206,7 +206,7 @@ To review, here are the different ways to specify a layout using the AsciiDoc at
 * `:page-layout: info` -- use the layout named `info` (e.g., [.path]__layout/info.html_)
 * _not specified_, `:page-layout:` or `:page-layout: _auto` -- use the automatic layout (i.e., `page` for pages, `post` for posts, the singular form of the collection label for a document; if the auto-selected layout isn't available, the layout `default` is used)
 * `:!page-layout:` or `:page-layout: false` -- don't use a layout; instead, generate a standalone HTML document
-* `:page-layout: ~` -- don't use a layout (often results in an incomplete HTML file)
+* `:page-layout: ~` or `:page-layout: none` -- don't use a layout or create a standalone HTML document (often produces an HTML fragment); the `~` value only works when defined as an AsciiDoc page attribute; otherwise, the value `none` must be used
 
 === Implicit Page Variables
 
diff --git a/lib/jekyll-asciidoc/integrator.rb b/lib/jekyll-asciidoc/integrator.rb
@@ -56,7 +56,7 @@ def generate site
       # Returns a [Boolean] indicating whether the document should be published.
       def integrate document, collection_name = nil
         data = document.data
-        document.content = [%(:#{@page_attr_prefix}layout: _auto), document.content] * NewLine unless data.key? 'layout'
+        document.content = [%(:#{@page_attr_prefix}layout: _auto), document.content] * NewLine unless data['layout']
         return true unless (doc = @converter.load_header document)
 
         # NOTE id is already reserved in Jekyll for another purpose, so we'll map id to docid instead
@@ -93,7 +93,7 @@ def integrate document, collection_name = nil
           layout = collection_name ? (collection_name.chomp 's') : 'page'
           data['layout'] = (document.site.layouts.key? layout) ? layout : 'default'
         when false
-          data.delete 'layout'
+          data['layout'] = 'none'
           document.content = %(#{StandaloneOptionLine}#{document.content})
         end
 
diff --git a/spec/fixtures/front_matter_defaults/_config.yml b/spec/fixtures/front_matter_defaults/_config.yml
@@ -0,0 +1,10 @@
+gems:
+  - jekyll-asciidoc
+defaults:
+- values:
+    layout: general
+- scope:
+    path: docs
+    type: pages
+  values:
+    layout: docs
diff --git a/spec/fixtures/front_matter_defaults/_layouts/docs.html b/spec/fixtures/front_matter_defaults/_layouts/docs.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>{{ page.title }}</title>
+</head>
+<body>
+<div class="page-content">
+{{ content }}
+</div>
+<footer>
+<p>Footer for docs layout.</p>
+</footer>
+</body>
+</html>
diff --git a/spec/fixtures/front_matter_defaults/_layouts/general.html b/spec/fixtures/front_matter_defaults/_layouts/general.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>{{ page.title }}</title>
+</head>
+<body>
+<div class="page-content">
+{{ content }}
+</div>
+<footer>
+<p>Footer for general layout.</p>
+</footer>
+</body>
+</html>
diff --git a/spec/fixtures/front_matter_defaults/docs/page.adoc b/spec/fixtures/front_matter_defaults/docs/page.adoc
@@ -0,0 +1,3 @@
+= Docs Page
+
+Content of docs page.
diff --git a/spec/fixtures/front_matter_defaults/page.adoc b/spec/fixtures/front_matter_defaults/page.adoc
@@ -0,0 +1,3 @@
+= General Page
+
+Content of general page.
diff --git a/spec/jekyll-asciidoc_spec.rb b/spec/jekyll-asciidoc_spec.rb
@@ -633,6 +633,28 @@
     end
   end
 
+  describe 'use front matter defaults' do
+    let :name do
+      'front_matter_defaults'
+    end
+
+    before(:each) { site.process }
+
+    it 'should use the layout for the default scope when no layout is specified' do
+      file = output_file 'page.html'
+      expect(::File).to exist(file)
+      contents = ::File.read file
+      expect(contents).to include('<p>Footer for general layout.</p>')
+    end
+
+    it 'should use the layout for the matching scope when no layout is specified' do
+      file = output_file 'docs/page.html'
+      expect(::File).to exist(file)
+      contents = ::File.read file
+      expect(contents).to include('<p>Footer for docs layout.</p>')
+    end
+  end
+
   describe 'require front matter header' do
     let :name do
       'require_front_matter_header'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+= Docs Page`
	`2`	`+`
	`3`	`+Content of docs page.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+= General Page`
	`2`	`+`
	`3`	`+Content of general page.`