jekyll-asciidoc 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 038ace39e983d8f6e710306e70ba7acd02af1c80
-  data.tar.gz: 81a0bed37126dce92290fb9fc8eb20369e9c27be
+  metadata.gz: a32abdc7e23fb224459ef345205b70365abfa35e
+  data.tar.gz: 396e273827b48132964fce3a118a155d53417baf
 SHA512:
-  metadata.gz: 67b47225a5f907acd69454fe83570c95192ec9b07e968ebeb23b4a192aa912f19a5025ed74cab9e73461c2a1c5d31364a67d988fae00a10ba11f4846a0cf4db1
-  data.tar.gz: 02bb49e0c9b2a1943ab637fd9e8def0d6e06cf490fc7af444b80feccdfccb1ec9b93463652e52c7428c7cd25812c12c408099d599cc5afaed3e443620ea434b4
+  metadata.gz: 5ea1217c030007a8ec10bfb3d8d8ddfcaff910da7918ee9b7f2a30082d8463ae5ef2cd4ba2741d924a9c131f1623382eaf532ee8eb8dedf25c0bc50202dfb28e
+  data.tar.gz: fc37dfdb7ed1bbd2c4af2302fae3b6837757cb2bf901b56f8ce8279e1e3cea98388a6b856041c50570e848567403aeef2f875221fda7128dbb82a0f37312df2e

data/README.adoc

@@ -1,12 +1,30 @@
 = Jekyll AsciiDoc Plugin (powered by Asciidoctor)
 Paul Rayner <https://github.com/paulrayner[@paulrayner]>; Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
+// Settings:
+:idprefix:
+:idseparator: -
+ifndef::env-github[:icons: font]
+ifdef::env-github,env-browser[]
 :toc: preamble
 :toclevels: 1
-
-image:https://badge.fury.io/rb/jekyll-asciidoc.svg["Gem Version", link="https://badge.fury.io/rb/jekyll-asciidoc"]
+endif::[]
+ifdef::env-github[]
+:status:
+:outfilesuffix: .adoc
+:!toc-title:
+:caution-caption: :fire:
+:important-caption: :exclamation:
+:note-caption: :paperclip:
+:tip-caption: :bulb:
+:warning-caption: :warning:
+endif::[]
 
 A plugin for http://jekyllrb.com[Jekyll] that converts http://asciidoc.org[AsciiDoc] files in your site source to HTML pages using http://asciidoctor.org[Asciidoctor].
 
+ifdef::status[]
+image::https://img.shields.io/gem/v/jekyll-asciidoc.svg?label=gem%20version[Gem Version, link=https://rubygems.org/gems/jekyll-asciidoc]
+endif::[]
+
 == Overview
 
 The plugin consists of three extensions:
@@ -92,7 +110,7 @@ To add a page composed in AsciiDoc, simply add an AsciiDoc file to the root of t
 ---
 ---
 = Sample Page
-:layout: page
+:page-layout: page
 :permalink: /page/
 
 This is a sample page composed in AsciiDoc.
@@ -107,6 +125,9 @@ puts "Hello, World!"
 IMPORTANT: The AsciiDoc file must have a http://jekyllrb.com/docs/frontmatter/[YAML front matter] header or else it won't be recognized as a page.
 You can use an empty front matter header, as shown above, or you can define all your document metadata (e.g., document title) in the front matter instead of AsciiDoc attributes.
 
+NOTE: AsciiDoc attributes defined in the document header whose names begin with `page-` are promoted to Jekyll front matter.
+The part of the name after the `page-` prefix is used as the key (e.g., page-layout becomes layout).
+
 You can now build your site using:
 
  $ jekyll build
@@ -138,6 +159,15 @@ asciidoc_ext: asciidoc,adoc,ad
 
 The extensions shown in the previous listing are the default values, so you don't need to specify this option if those defaults are sufficient.
 
+AsciiDoc attributes defined in the document header whose names begin with `page-` are promoted to Jekyll front matter.
+The part of the name after the `page-` prefix is used as the key (e.g., page-layout becomes layout).
+If you want to change this attribute prefix, add the following line to your [path]_{empty}_config.yml_:
+
+[source,yaml]
+asciidoc_page_attribute_prefix: jekyll
+
+A hyphen is automatically added to the value of this configuration setting if the value is non-empty.
+
 To pass additional attributes to AsciiDoc, or override the default attributes defined in the plugin, add the following lines to your [path]_{empty}_config.yml_:
 
 [source,yaml]
@@ -347,7 +377,7 @@ Our recommendation is to keep lobbying for them to enable it.
 
 You can automate publishing of the generated site to GitHub Pages using a continuous integration job.
 Refer to the tutorial http://eshepelyuk.github.io/2014/10/28/automate-github-pages-travisci.html[Automate GitHub Pages publishing with Jekyll and Travis CI^] to find step-by-step instructions to setup this job.
-You can also refer to the https://github.com/johncarl81/transfuse/tree/transfuse-jeykll-site[Tranfuse website build^] for an example in practice.
+You can also refer to the https://github.com/johncarl81/transfuse-site[Tranfuse website build^] for an example in practice.
 
 Refer to the https://help.github.com/articles/using-jekyll-plugins-with-github-pages[Jekyll Plugins on GitHub Pages] for a list of the plugins currently supported on the server-side (in addition to Markdown, which isn't listed).
 

data/lib/jekyll-asciidoc.rb

@@ -3,6 +3,10 @@ JEKYLL_MIN_VERSION_3 = Gem::Version.new(Jekyll::VERSION) >= Gem::Version.new('3.
 module Jekyll
   module Converters
     class AsciiDocConverter < Converter
+      IMPLICIT_ATTRIBUTES = %W(
+        env=site env-site site-gen=jekyll site-gen-jekyll builder=jekyll builder-jekyll jekyll-version=#{Jekyll::VERSION}
+      )
+
       safe true
 
       highlighter_prefix "\n"
@@ -10,45 +14,45 @@ module Jekyll
 
       def initialize(config)
         @config = config
-        @config['asciidoc'] ||= 'asciidoctor'
-        @config['asciidoc_ext'] ||= 'asciidoc,adoc,ad'
-        @asciidoctor_config = (@config['asciidoctor'] ||= {})
-        # convert keys to symbols
-        @asciidoctor_config.keys.each do |key|
-          @asciidoctor_config[key.to_sym] = @asciidoctor_config.delete(key)
-        end
-        @asciidoctor_config[:safe] ||= 'safe'
-        user_defined_attributes = @asciidoctor_config[:attributes]
-        @asciidoctor_config[:attributes] = %w(notitle hardbreaks idprefix= idseparator=- linkattrs)
-        unless user_defined_attributes.nil?
-          @asciidoctor_config[:attributes].concat(user_defined_attributes)
+        config['asciidoc'] ||= 'asciidoctor'
+        asciidoc_ext = (config['asciidoc_ext'] ||= 'asciidoc,adoc,ad')
+        config['asciidoc_ext_re'] = Regexp.new("\.(#{asciidoc_ext.tr ',', '|'})$", Regexp::IGNORECASE)
+        config['asciidoc_page_attribute_prefix'] ||= 'page'
+        unless (asciidoctor_config = (config['asciidoctor'] ||= {})).frozen?
+          # NOTE convert keys to symbols
+          asciidoctor_config.keys.each do |key|
+            asciidoctor_config[key.to_sym] = asciidoctor_config.delete(key)
+          end
+          asciidoctor_config[:safe] ||= 'safe'
+          (asciidoctor_config[:attributes] ||= []).tap do |attributes|
+            attributes.unshift('notitle', 'hardbreaks', 'idprefix', 'idseparator=-', 'linkattrs')
+            attributes.concat(IMPLICIT_ATTRIBUTES)
+          end
+          asciidoctor_config.freeze
         end
-        @asciidoctor_config[:attributes].push('env-jekyll')
       end
 
       def setup
         return if @setup
+        @setup = true
         case @config['asciidoc']
-          when 'asciidoctor'
-            begin
-              require 'asciidoctor'
-              @setup = true
-            rescue LoadError
-              STDERR.puts 'You are missing a library required to convert AsciiDoc files. Please run:'
-              STDERR.puts '  $ [sudo] gem install asciidoctor'
-              raise FatalException.new("Missing dependency: asciidoctor")
-            end
-          else
-            STDERR.puts "Invalid AsciiDoc processor: #{@config['asciidoc']}"
-            STDERR.puts "  Valid options are [ asciidoctor ]"
-            raise FatalException.new("Invalid AsciiDoc process: #{@config['asciidoc']}")
+        when 'asciidoctor'
+          begin
+            require 'asciidoctor' unless defined? ::Asciidoctor
+          rescue LoadError
+            STDERR.puts 'You are missing a library required to convert AsciiDoc files. Please run:'
+            STDERR.puts '  $ [sudo] gem install asciidoctor'
+            raise FatalException.new('Missing dependency: asciidoctor')
+          end
+        else
+          STDERR.puts "Invalid AsciiDoc processor: #{@config['asciidoc']}"
+          STDERR.puts '  Valid options are [ asciidoctor ]'
+          raise FatalException.new("Invalid AsciiDoc processor: #{@config['asciidoc']}")
         end
-        @setup = true
       end
       
       def matches(ext)
-        rgx = "\.(#{@config['asciidoc_ext'].tr ',', '|'})$"
-        ext =~ Regexp.new(rgx, Regexp::IGNORECASE)
+        ext =~ @config['asciidoc_ext_re']
       end
 
       def output_ext(ext)
@@ -59,18 +63,18 @@ module Jekyll
         setup
         case @config['asciidoc']
         when 'asciidoctor'
-          Asciidoctor.render(content, @config['asciidoctor'])
+          Asciidoctor.convert(content, @config['asciidoctor'])
         else
           warn 'Unknown AsciiDoc converter. Passing through raw content.'
           content
         end
       end
 
-      def load(content)
+      def load_header(content)
         setup
         case @config['asciidoc']
         when 'asciidoctor'
-          Asciidoctor.load(content, :parse_header_only => true)
+          Asciidoctor.load(content, parse_header_only: true)
         else
           warn 'Unknown AsciiDoc converter. Cannot load document header.'
           nil
@@ -87,55 +91,45 @@ module Jekyll
             site.find_converter_instance(Jekyll::Converters::AsciiDocConverter) :
             site.getConverterImpl(Jekyll::Converters::AsciiDocConverter)
         asciidoc_converter.setup
-        key_prefix = (site.config['asciidoc_key_prefix'] || 'jekyll-')
-        key_prefix_len = key_prefix.length
+        unless (page_attr_prefix = site.config['asciidoc_page_attribute_prefix']).empty?
+          page_attr_prefix = %(#{page_attr_prefix}-)
+        end
+        page_attr_prefix_l = page_attr_prefix.length
+
         site.pages.each do |page|
           if asciidoc_converter.matches(page.ext)
-            doc = asciidoc_converter.load(page.content)
-            next if doc.nil?
+            next unless (doc = asciidoc_converter.load_header(page.content))
 
-            page.data['title'] ||= doc.doctitle
-            page.data['author'] = doc.author unless doc.author.nil?
+            page.data['title'] = doc.doctitle if doc.header?
+            page.data['author'] = doc.author if doc.author
 
-            doc.attributes.each do |key, val|
-              if key.start_with?(key_prefix)
-                page.data[key[key_prefix_len..-1]] ||= val
-              end
+            unless (additional_page_data = SafeYAML.load(doc.attributes
+                .select {|name| name.start_with?(page_attr_prefix) }
+                .map {|name, val| %(#{name[page_attr_prefix_l..-1]}: #{val}) }
+                .join("\n"))).empty?
+              page.data.update(additional_page_data)
             end
 
-            unless page.data.has_key? 'layout'
-              if doc.attr? 'page-layout'
-                page.data['layout'] ||= doc.attr 'page-layout'
-              else
-                page.data['layout'] ||= 'default'
-              end
-            end
+            page.data['layout'] = 'default' unless page.data.key? 'layout'
           end
         end
+
         (JEKYLL_MIN_VERSION_3 ? site.posts.docs : site.posts).each do |post|
           if asciidoc_converter.matches(JEKYLL_MIN_VERSION_3 ? post.data['ext'] : post.ext)
-            doc = asciidoc_converter.load(post.content)
-            next if doc.nil?
-
-            post.data['title'] ||= doc.doctitle
-            post.data['author'] = doc.author unless doc.author.nil?
-            # TODO carry over date
-            # setting categories doesn't work here, we lose the post
-            #post.data['categories'] ||= (doc.attr 'categories') if (doc.attr? 'categories')
-
-            doc.attributes.each do |key, val|
-              if key.start_with?(key_prefix)
-                post.data[key[key_prefix_len..-1]] ||= val
-              end
-            end
+            next unless (doc = asciidoc_converter.load_header(post.content))
 
-            unless post.data.has_key? 'layout'
-              if doc.attr? 'page-layout'
-                post.data['layout'] ||= doc.attr 'page-layout'
-              else
-                post.data['layout'] ||= 'post'
-              end
+            post.data['title'] = doc.doctitle if doc.header?
+            post.data['author'] = doc.author if doc.author
+            post.data['date'] = DateTime.parse(doc.revdate).to_time if doc.attr? 'revdate'
+
+            unless (additional_page_data = SafeYAML.load(doc.attributes
+                .select {|name| name.start_with?(page_attr_prefix) }
+                .map {|name, val| %(#{name[page_attr_prefix_l..-1]}: #{val}) }
+                .join("\n"))).empty?
+              post.data.update(additional_page_data)
             end
+
+            post.data['layout'] = 'post' unless post.data.key? 'layout'
           end
         end
       end

data/lib/jekyll-asciidoc/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module AsciiDoc
-    VERSION = '1.0.1'
+    VERSION = '1.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-19 00:00:00.000000000 Z
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor