jekyll-asciidoc 2.0.1 → 2.1.0

data/jekyll-asciidoc.gemspec

@@ -3,12 +3,13 @@ require File.expand_path '../lib/jekyll-asciidoc/version', __FILE__
 Gem::Specification.new do |s|
   s.name = 'jekyll-asciidoc'
   s.version = Jekyll::AsciiDoc::VERSION
-  s.summary = 'A Jekyll plugin that converts AsciiDoc source files in your site to HTML pages using Asciidoctor.'
-  s.description = 'A Jekyll plugin that converts AsciiDoc source files in your site to HTML pages using Asciidoctor.'
+  s.summary = 'A Jekyll plugin that converts the AsciiDoc source files in your site to HTML pages using Asciidoctor.'
+  s.description = 'A Jekyll plugin that converts the AsciiDoc source files in your site to HTML pages using Asciidoctor.'
   s.authors = ['Dan Allen', 'Paul Rayner']
   s.email = ['dan.j.allen@gmail.com']
   s.homepage = 'https://github.com/asciidoctor/jekyll-asciidoc'
   s.license = 'MIT'
+  s.required_ruby_version = '>= 1.9.3'
 
   files = begin
     output = IO.popen('git ls-files -z', err: File::NULL) {|io| io.read }.split %(\0)
@@ -16,9 +17,9 @@ Gem::Specification.new do |s|
   rescue
     Dir['**/*']
   end
-  s.files = files.grep /^(?:lib\/.+|Gemfile|Rakefile|(CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
-  s.test_files = files.grep /^spec\//
-  
+  s.files = files.grep %r/^(?:lib\/.+|Gemfile|Rakefile|(?:CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
+  s.test_files = files.grep %r/^spec\//
+
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'asciidoctor', '>= 1.5.0'
@@ -26,6 +27,4 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.5.0'
-  # enable pygments.rb dependency here once https://github.com/tmm1/pygments.rb/pull/162 is merged & released
-  #s.add_development_dependency 'pygments.rb', '~> 0.6.3'
 end

data/lib/jekyll-asciidoc/compat.rb

@@ -1,6 +1,7 @@
 module Jekyll
   module AsciiDoc
-    Jekyll3Compatible = (::Gem::Version.new ::Jekyll::VERSION) >= (::Gem::Version.new '3.0.0')
+    Jekyll3Compatible = (jekyll_version = ::Gem::Version.new ::Jekyll::VERSION) >= (::Gem::Version.new '3.0.0')
+    Jekyll3_1 = (::Gem::Requirement.new '~> 3.1.0').satisfied_by? jekyll_version
   end
 end
 
@@ -9,11 +10,11 @@ module Jekyll
     # Backport {::Jekyll::Site#find_converter_instance} to Jekyll 2.
     def find_converter_instance type
       converters.find {|candidate| type === candidate } || (raise %(No Converters found for #{type}))
-    end unless respond_to? :find_converter_instance
+    end unless method_defined? :find_converter_instance
 
     # Introduce complement to {::Jekyll::Site#find_converter_instance} for generators.
     def find_generator_instance type
       generators.find {|candidate| type === candidate } || (raise %(No Generators found for #{type}))
-    end unless respond_to? :find_generator_instance
+    end unless method_defined? :find_generator_instance
   end
 end

data/lib/jekyll-asciidoc/converter.rb

@@ -34,7 +34,7 @@ module Jekyll
       def initialize config
         @config = config
         @logger = ::Jekyll.logger
-        @path_info = nil
+        @page_context = {}
         @setup = false
 
         # NOTE jekyll-watch reinitializes plugins using a shallow clone of config, so no need to reconfigure
@@ -100,10 +100,10 @@ module Jekyll
               'site-baseurl' => config['baseurl'],
               'site-url' => config['url']
             }
-            attrs = asciidoctor_config[:attributes] = hashify_attributes asciidoctor_config[:attributes],
+            attrs = asciidoctor_config[:attributes] = assemble_attributes asciidoctor_config[:attributes],
                 ((site_attributes.merge ImplicitAttributes).merge DefaultAttributes)
             if (imagesdir = attrs['imagesdir']) && !(attrs.key? 'imagesoutdir') && (imagesdir.start_with? '/')
-              attrs['imagesoutdir'] = ::File.join dest, imagesdir
+              attrs['imagesoutdir'] = ::File.join dest, (imagesdir.chomp '@')
             end
             asciidoctor_config.extend Configured
           end
@@ -151,47 +151,47 @@ module Jekyll
       end
 
       def before_render document, payload
-        record_path_info document
+        # NOTE Jekyll 3.1 incorrectly mapped the page payload to document.data instead of payload['page']
+        @page_context[:data] = ::Jekyll::AsciiDoc::Jekyll3_1 ? document.data : payload['page']
+        record_paths document
       end
 
       def after_render document
-        clear_path_info
+        @page_context.clear
       end
 
-      def record_path_info document, opts = {}
-        @path_info = {
+      def record_paths document, opts = {}
+        @page_context[:paths] = paths = {
           'docfile' => (docfile = ::File.join document.site.source, document.relative_path),
           'docdir' => (::File.dirname docfile),
           'docname' => (::File.basename docfile, (::File.extname docfile))
         }
-        unless opts[:source_only]
-          @path_info.update({
-            'outfile' => (outfile = document.destination document.site.dest),
-            'outdir' => (::File.dirname outfile),
-            'outpath' => document.url
-          })
-        end
+        paths.update({
+          'outfile' => (outfile = document.destination document.site.dest),
+          'outdir' => (::File.dirname outfile),
+          'outpath' => document.url
+        }) unless opts[:source_only]
       end
 
-      def clear_path_info
-        @path_info = nil
+      def clear_paths
+        @page_context.delete :paths
       end
 
       def load_header document
         setup
-        record_path_info document, source_only: true if defined? ::Jekyll::Hooks
+        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]
         case @asciidoc_config['processor']
         when 'asciidoctor'
           opts = @asciidoctor_config.merge parse_header_only: true
-          if @path_info
+          if (paths = @page_context[:paths])
             if opts[:base_dir] == :docdir
-              opts[:base_dir] = @path_info['docdir'] # NOTE this assignment happens inside the processor anyway
+              opts[:base_dir] = paths['docdir'] # NOTE this assignment happens inside the processor anyway
             else
-              @path_info.delete 'docdir'
+              paths.delete 'docdir'
             end
-            opts[:attributes] = opts[:attributes].merge @path_info
+            opts[:attributes] = opts[:attributes].merge paths
           end
           # NOTE return instance even if header is empty since attributes may be inherited from config
           doc = ::Asciidoctor.load header, opts
@@ -199,7 +199,7 @@ module Jekyll
           @logger.warn MessageTopic, %(Unknown AsciiDoc processor: #{@asciidoc_config['processor']}. Cannot load document header.)
           doc = nil
         end
-        clear_path_info if defined? ::Jekyll::Hooks
+        clear_paths if defined? ::Jekyll::Hooks
         doc
       end
 
@@ -212,15 +212,18 @@ module Jekyll
         case @asciidoc_config['processor']
         when 'asciidoctor'
           opts = @asciidoctor_config.merge header_footer: standalone
-          if @path_info
+          if (paths = @page_context[:paths])
             if opts[:base_dir] == :docdir
-              opts[:base_dir] = @path_info['docdir'] # NOTE this assignment happens inside the processor anyway
+              opts[:base_dir] = paths['docdir'] # NOTE this assignment happens inside the processor anyway
             else
-              @path_info.delete 'docdir'
+              paths.delete 'docdir'
             end
-            opts[:attributes] = opts[:attributes].merge @path_info
+            opts[:attributes] = opts[:attributes].merge paths
+          # for auto-extracted excerpt, paths are't available since hooks don't get triggered
+          elsif opts[:base_dir] == :docdir
+            opts.delete :base_dir
           end
-          ::Asciidoctor.convert content, opts
+          ((@page_context[:data] || {})['document'] = ::Asciidoctor.load content, opts).extend(Liquidable).convert
         else
           @logger.warn MessageTopic, %(Unknown AsciiDoc processor: #{@asciidoc_config['processor']}. Passing through unparsed content.)
           content
@@ -233,7 +236,7 @@ module Jekyll
         hash.each_with_object({}) {|(key, val), accum| accum[key.to_sym] = val }
       end
 
-      def hashify_attributes attrs, initial = {}
+      def assemble_attributes attrs, initial = {}
         if (is_array = ::Array === attrs) || ::Hash === attrs
           attrs.each_with_object(initial) {|entry, new_attrs|
             key, val = is_array ? ((entry.split '=', 2) + ['', ''])[0..1] : entry
@@ -241,8 +244,25 @@ module Jekyll
               new_attrs[key[1..-1]] = nil
             elsif key.end_with? '!'
               new_attrs[key.chop] = nil
+            # we're reserving -name to mean "unset implicit value but allow doc to override"
+            elsif key.start_with? '-'
+              new_attrs.delete key[1..-1]
             else
-              new_attrs[key] = val ? (resolve_attribute_refs val, new_attrs) : nil
+              new_attrs[key] = if val
+                case val
+                when ::String
+                  resolve_attribute_refs val, new_attrs
+                when ::Numeric
+                  val.to_s
+                when true
+                  ''
+                else
+                  val
+                end
+              else
+                # we may preserve false in the future to mean "unset implicit value but allow doc to override"
+                nil
+              end
             end
           }
         else
@@ -254,7 +274,7 @@ module Jekyll
         if text.empty?
           text
         elsif text.include? '{'
-          text.gsub(AttributeReferenceRx) { ((m = $&).start_with? '\\') ? m[1..-1] : (attrs.fetch $1, m) }
+          text.gsub(AttributeReferenceRx) { ($&.start_with? '\\') ? $&[1..-1] : ((attrs.fetch $1, $&).to_s.chomp '@') }
         else
           text
         end

data/lib/jekyll-asciidoc/filters.rb

@@ -6,11 +6,31 @@ module Jekyll
       # input   - The AsciiDoc String to convert.
       # doctype - The target AsciiDoc doctype (optional, default: nil).
       #
-      # Returns the HTML formatted String.
+      # Examples
+      #
+      #   {{ page.excerpt | asciidocify: 'inline' }}
+      #
+      # Returns the converted result as an HTML-formatted String.
       def asciidocify input, doctype = nil
         (@context.registers[:cached_asciidoc_converter] ||= (Converter.get_instance @context.registers[:site]))
           .convert(doctype ? %(:doctype: #{doctype}#{Utils::NewLine}#{input}) : (input || ''))
       end
+
+      # A Liquid filter for generating a table of contents in HTML from a parsed AsciiDoc document.
+      #
+      # document      - The parsed AsciiDoc document from which to generate a table of contents in HTML.
+      # levels        - The max section depth to include (optional, default: value of toclevels document attribute).
+      #
+      # Examples
+      #
+      #   {{ page.document | tocify_asciidoc: 3 }}
+      #
+      # Returns the table of contents as an HTML-formatted String.
+      def tocify_asciidoc document, levels = nil
+        if ::Asciidoctor::Document === document
+          document.converter.convert document, 'outline', toclevels: (levels.nil_or_empty? ? nil : levels.to_i)
+        end
+      end
     end
 
     ::Liquid::Template.register_filter Filters

data/lib/jekyll-asciidoc/integrator.rb

@@ -14,8 +14,8 @@ module Jekyll
         site.find_generator_instance self
       end
 
-      # This method is triggered each time the site is generated, including after any file has changed when
-      # running in watch mode (regardless of incremental setting).
+      # This method is triggered each time the site is generated, including after any file has changed when running in
+      # watch mode (regardless of incremental setting).
       def generate site
         @converter = converter = (Converter.get_instance site).setup
 
@@ -47,47 +47,59 @@ module Jekyll
         end
       end
 
-      # Integrate the page-related attributes from the AsciiDoc document header
-      # into the data Array of the specified {::Jekyll::Page}, {::Jekyll::Post}
-      # or {::Jekyll::Document}.
+      # Integrate the page-related attributes from the AsciiDoc document header into the data Array of the specified
+      # {::Jekyll::Page}, {::Jekyll::Post} or {::Jekyll::Document}.
       #
       # document        - the Page, Post or Document instance to integrate.
-      # collection_name - the String name of the collection to which this
-      #                   document belongs (optional, default: nil).
+      # collection_name - the String name of the collection to which this document belongs (optional, default: nil).
       #
       # Returns a [Boolean] indicating whether the document should be published.
       def integrate document, collection_name = nil
-        document.extend Document
-        document.content = [%(:#{@page_attr_prefix}layout: _auto), document.content] * NewLine unless document.data.key? 'layout'
-        return unless (doc = @converter.load_header document)
-
-        document.data['title'] = doc.doctitle if doc.header?
-        document.data['author'] = doc.author if doc.author
-        document.data['date'] = (::DateTime.parse doc.revdate).to_time if collection_name == 'posts' && (doc.attr? 'revdate')
+        data = document.data
+        document.content = [%(:#{@page_attr_prefix}layout: _auto), document.content] * NewLine unless data.key? '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
+        data['docid'] = doc.id if doc.id
+        data['title'] = doc.doctitle if doc.header?
+        data['author'] = doc.author if doc.author
+        if collection_name == 'posts' && (doc.attr? 'revdate')
+          data['date'] = ::Jekyll::Utils.parse_date doc.revdate,
+              %(Document '#{document.relative_path}' does not have a valid revdate in the AsciiDoc header.)
+          # NOTE Jekyll 2.3 requires date field to be set explicitly
+          document.date = data['date'] if document.respond_to? :date=
+        end
 
-        no_prefix = (prefix_size = @page_attr_prefix.length).zero?
-        unless (adoc_header_data = doc.attributes
-            .each_with_object({}) {|(key, val), accum|
+        no_prefix = (prefix_size = @page_attr_prefix.length) == 0
+        unless (adoc_data = doc.attributes.each_with_object({}) {|(key, val), accum|
               if no_prefix || ((key.start_with? @page_attr_prefix) && key = key[prefix_size..-1])
                 accum[key] = ::String === val ? (parse_yaml_value val) : val
               end
             }).empty?
-          document.data.update adoc_header_data
+          data.update adoc_data
         end
 
-        case document.data['layout']
+        { 'category' => 'categories', 'tag' => 'tags' }.each do |sole_key, coll_key|
+          if (sole_val = data.delete sole_key) &&
+              !((coll_val = (data[coll_key] ||= [])).include? sole_val)
+            coll_val << sole_val 
+          end
+        end
+
+        case data['layout']
         when nil
-          document.content = %(#{StandaloneOptionLine}#{document.content}) unless document.data.key? 'layout'
+          document.content = %(#{StandaloneOptionLine}#{document.content}) unless data.key? 'layout'
         when '', '_auto'
           layout = collection_name ? (collection_name.chomp 's') : 'page'
-          document.data['layout'] = (document.site.layouts.key? layout) ? layout : 'default'
+          data['layout'] = (document.site.layouts.key? layout) ? layout : 'default'
         when false
-          document.data.delete 'layout'
+          data.delete 'layout'
           document.content = %(#{StandaloneOptionLine}#{document.content})
         end
 
-        document.extend NoLiquid unless document.data['liquid']
-        document.data.fetch 'published', true
+        document.extend Document
+        document.extend NoLiquid unless data['liquid']
+        data.fetch 'published', true
       end
 
       def generate_pygments_stylesheet site, attrs
@@ -114,26 +126,22 @@ module Jekyll
 
       private
 
-      # Parse the specified value as though it is a single-line value part of a
-      # YAML key/value pair.
+      # Parse the specified value as though it is a single-line value part of a YAML key/value pair.
       #
-      # Attempt to parse the specified String value as though it is a
-      # single-line value part of a YAML key/value pair. If the value fails to
-      # parse, wrap the value in single quotes (after escaping any single
-      # quotes in the value) and parse it as a character sequence. If the value
-      # is empty, return an empty String.
+      # Attempt to parse the specified String value as though it is a single-line value part of a YAML key/value pair.
+      # If the value fails to parse, wrap the value in single quotes (after escaping any single quotes in the value) and
+      # parse it as a character sequence. If the value is empty, return an empty String.
       #
       # val - The String value to parse.
       #
-      # Returns an [Object] parsed from the string-based YAML value or empty
-      # [String] if the specified value is empty.
+      # Returns an [Object] parsed from the string-based YAML value or empty [String] if the specified value is empty.
       def parse_yaml_value val
         if val.empty?
           ''
         else
           begin
             ::SafeYAML.load %(--- #{val})
-          rescue
+          rescue ::StandardError, ::SyntaxError
             val = val.gsub '\'', '\'\'' if val.include? '\''
             ::SafeYAML.load %(--- \'#{val}\')
           end

data/lib/jekyll-asciidoc/mixins.rb

@@ -3,6 +3,12 @@ module Jekyll
     Configured = ::Module.new
     Document = ::Module.new
 
+    module Liquidable
+      def to_liquid
+        self
+      end
+    end
+
     module NoLiquid
       def render_with_liquid?
         false

data/lib/jekyll-asciidoc/version.rb

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

data/spec/fixtures/basic_site/docid.adoc

@@ -0,0 +1,4 @@
+[#page-id]
+= Page Title
+
+content

data/spec/fixtures/basic_site/section-with-id-and-role.adoc

@@ -0,0 +1,6 @@
+= Page Title
+
+[#section-id.section-role]
+== Section Title
+
+content

data/spec/fixtures/imagesdir_relative_to_root/_config.yml

@@ -2,4 +2,4 @@ gems:
   - jekyll-asciidoc
 asciidoctor:
   attributes:
-    imagesdir: /images
+    imagesdir: /images@

data/spec/fixtures/include_relative_to_root/source/_config.yml

@@ -0,0 +1,2 @@
+gems:
+  - jekyll-asciidoc

data/spec/fixtures/include_relative_to_root/source/_layouts/default.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>{{ page.title }}</title>
+</head>
+<body>
+<div class="page-content">
+{{ content }}
+</div>
+</body>
+</html>

data/spec/fixtures/include_relative_to_root/source/about/_people.adoc

@@ -0,0 +1,2 @@
+* Doc Writer
+* Word Smith