jekyll-asciidoc 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c4135124b7d7842c3e199e5208d4c267e87a259d
-  data.tar.gz: 0d4051c81249eb6259e97bab4a0dc3c91c1e881b
+SHA256:
+  metadata.gz: 700e623dddf15c30365dc58b3a9c59edaba9d852682d03436e10442e1edc8627
+  data.tar.gz: 3a3daa57c865884b73bf6dfdc4002381954adb3d284905d67dea1840d9597806
 SHA512:
-  metadata.gz: f18fd97d2472bec92a0ddecaaca4fd6d31a10f5620ade52f81e6f20fc00e1adf4c4d4410c06864cbb1bdffab4dcb2a64f6762db4363c0d5b678f8f3c5a7e680c
-  data.tar.gz: f377c0cfc83c0ca2edd23009011412aacbd7f302d6d636e064d9699a867ec4681b82eed07fadc1ba6982a6b7608f2a9eb6178153c781063fdf4da19c9a7c722e
+  metadata.gz: 9307232a92356f4a83f73b0b40f2ab919dabf3c7c05351ba6f27e9f7fda2e9ba3e5d2d012d7531dd9d4282c5d8360619bd915aa44217fc63e1b0dee54167b9fd
+  data.tar.gz: 431a2f10d4871ed4db7465620a25eb617e90196d5ff481ba9a7676df462ac0772be216222db05dc67ad5f3412a7658869f0c55701b82c45bdd0b53006d1d07a0

data/CHANGELOG.adoc

@@ -5,6 +5,12 @@
 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.
 
+== 2.1.1 (2018-11-08) - @mojavelinux
+
+* honor layout defined in frontmatter defaults (#187)
+* don't call nil_or_empty? outside of an Asciidoctor context (#142)
+* handle case when document body is empty (#179)
+
 == 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)

data/README.adoc

@@ -1,5 +1,6 @@
 = Jekyll AsciiDoc Plugin (powered by Asciidoctor)
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Paul Rayner <https://github.com/paulrayner[@paulrayner]>
+v2.1.1, 2018-11-08
 v2.1.0, 2017-05-21
 // Settings:
 :idprefix:
@@ -206,7 +207,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
 

data/lib/jekyll-asciidoc/converter.rb

@@ -181,7 +181,7 @@ module Jekyll
         setup
         record_paths document, source_only: true if defined? ::Jekyll::Hooks
         # NOTE merely an optimization; if this doesn't match, the header still gets isolated by the processor
-        header = (document.content.split HeaderBoundaryRx, 2)[0]
+        header = (document.content.split HeaderBoundaryRx, 2)[0] || ''
         case @asciidoc_config['processor']
         when 'asciidoctor'
           opts = @asciidoctor_config.merge parse_header_only: true
@@ -204,7 +204,8 @@ module Jekyll
       end
 
       def convert content
-        return '' if content.nil_or_empty?
+        # NOTE don't use nil_or_empty? since that's only provided only by Asciidoctor
+        return '' unless content && !content.empty?
         setup
         if (standalone = content.start_with? StandaloneOptionLine)
           content = content[StandaloneOptionLine.length..-1]

data/lib/jekyll-asciidoc/integrator.rb

@@ -56,7 +56,7 @@ module Jekyll
       # 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 @@ module Jekyll
           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
 
@@ -107,9 +107,7 @@ module Jekyll
         unless (css_dir = (attrs['stylesdir'] || '').chomp '@').empty? || (css_dir.start_with? '/')
           css_dir = %(/#{css_dir})
         end
-        if (css_name = attrs['pygments-stylesheet']).nil_or_empty?
-          css_name = 'asciidoc-pygments.css'
-        end
+        css_name = attrs['pygments-stylesheet'] || 'asciidoc-pygments.css'
         css_file = ::File.join css_base, css_dir, css_name
         css_style = (attrs['pygments-style'] || 'vs').chomp '@'
         css = ::Asciidoctor::Stylesheets.instance.pygments_stylesheet_data css_style

data/lib/jekyll-asciidoc/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AsciiDoc
-    VERSION = '2.1.0'
+    VERSION = '2.1.1'
   end
 end

data/spec/fixtures/basic_site/with-front-matter-header-only.adoc

@@ -0,0 +1,4 @@
+---
+title: Front Matter Only
+layout: page
+---

data/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

data/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>

data/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>

data/spec/fixtures/front_matter_defaults/docs/page.adoc

@@ -0,0 +1,3 @@
+= Docs Page
+
+Content of docs page.

data/spec/fixtures/front_matter_defaults/page.adoc

@@ -0,0 +1,3 @@
+= General Page
+
+Content of general page.

data/spec/jekyll-asciidoc_spec.rb

@@ -446,6 +446,14 @@ describe 'Jekyll::AsciiDoc' do
       expect(contents).to include('<p>Lorem ipsum.</p>')
     end
 
+    it 'should convert an AsciiDoc file with only a front matter header' do
+      file = output_file 'with-front-matter-header-only.html'
+      expect(::File).to exist(file)
+      contents = ::File.read file
+      expect(contents).to include('<title>Front Matter Only</title>')
+      expect(contents).to include(%(<div class="page-content">\n\n</div>))
+    end
+
     it 'should apply explicit id and role attributes on section titles' do
       file = output_file 'section-with-id-and-role.html'
       expect(::File).to exist(file)
@@ -633,6 +641,28 @@ describe 'Jekyll::AsciiDoc' do
     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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-asciidoc
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -112,6 +112,7 @@ files:
 - spec/fixtures/basic_site/standalone-a.adoc
 - spec/fixtures/basic_site/standalone-b.adoc
 - spec/fixtures/basic_site/subdir/page-in-subdir.adoc
+- spec/fixtures/basic_site/with-front-matter-header-only.adoc
 - spec/fixtures/basic_site/with-front-matter-header.adoc
 - spec/fixtures/basic_site/without-front-matter-header.adoc
 - spec/fixtures/blank_page_attribute_prefix/_config.yml
@@ -126,6 +127,11 @@ files:
 - spec/fixtures/fallback_to_default_layout/_layouts/default.html
 - spec/fixtures/fallback_to_default_layout/_posts/2016-01-01-post.adoc
 - spec/fixtures/fallback_to_default_layout/home.adoc
+- spec/fixtures/front_matter_defaults/_config.yml
+- spec/fixtures/front_matter_defaults/_layouts/docs.html
+- spec/fixtures/front_matter_defaults/_layouts/general.html
+- spec/fixtures/front_matter_defaults/docs/page.adoc
+- spec/fixtures/front_matter_defaults/page.adoc
 - spec/fixtures/hybrid_config/_config.yml
 - spec/fixtures/imagesdir_relative_to_root/_config.yml
 - spec/fixtures/include_relative_to_docdir/_config.yml
@@ -204,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin that converts the AsciiDoc source files in your site to HTML
@@ -233,6 +239,7 @@ test_files:
 - spec/fixtures/basic_site/standalone-a.adoc
 - spec/fixtures/basic_site/standalone-b.adoc
 - spec/fixtures/basic_site/subdir/page-in-subdir.adoc
+- spec/fixtures/basic_site/with-front-matter-header-only.adoc
 - spec/fixtures/basic_site/with-front-matter-header.adoc
 - spec/fixtures/basic_site/without-front-matter-header.adoc
 - spec/fixtures/blank_page_attribute_prefix/_config.yml
@@ -247,6 +254,11 @@ test_files:
 - spec/fixtures/fallback_to_default_layout/_layouts/default.html
 - spec/fixtures/fallback_to_default_layout/_posts/2016-01-01-post.adoc
 - spec/fixtures/fallback_to_default_layout/home.adoc
+- spec/fixtures/front_matter_defaults/_config.yml
+- spec/fixtures/front_matter_defaults/_layouts/docs.html
+- spec/fixtures/front_matter_defaults/_layouts/general.html
+- spec/fixtures/front_matter_defaults/docs/page.adoc
+- spec/fixtures/front_matter_defaults/page.adoc
 - spec/fixtures/hybrid_config/_config.yml
 - spec/fixtures/imagesdir_relative_to_root/_config.yml
 - spec/fixtures/include_relative_to_docdir/_config.yml