jekyll-asciidoc 2.1.1 → 3.0.0.beta.1

data/jekyll-asciidoc.gemspec

@@ -1,30 +1,42 @@
-require File.expand_path '../lib/jekyll-asciidoc/version', __FILE__
+require File.absolute_path 'lib/jekyll-asciidoc/version', __dir__
+require 'open3' unless defined? Open3
 
 Gem::Specification.new do |s|
   s.name = 'jekyll-asciidoc'
   s.version = Jekyll::AsciiDoc::VERSION
   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.description = s.summary
+
   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'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/asciidoctor/jekyll-asciidoc/issues',
+    'changelog_uri' => 'https://github.com/asciidoctor/jekyll-asciidoc/blob/master/CHANGELOG.adoc',
+    'mailing_list_uri' => 'http://discuss.asciidoctor.org',
+    'source_code_uri' => 'https://github.com/asciidoctor/jekyll-asciidoc',
+  }
+  # NOTE the required ruby version is informational only
+  # it tracks the minimum version required by Jekyll >= 3.0.0 (see https://jekyllrb.com/docs/installation/#requirements)
+  # we don't enforce it because it can't be overridden and can cause builds to break
+  #s.required_ruby_version = '>= 2.2.0'
 
   files = begin
-    output = IO.popen('git ls-files -z', err: File::NULL) {|io| io.read }.split %(\0)
-    $?.success? ? output : Dir['**/*']
-  rescue
+    (result = Open3.popen3('git ls-files -z') {|_, out| out.read }.split ?\0).empty? ? Dir['**/*'] : result
+  rescue ::SystemCallError
     Dir['**/*']
   end
-  s.files = files.grep %r/^(?:lib\/.+|Gemfile|Rakefile|(?:CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
-  s.test_files = files.grep %r/^spec\//
+  s.files = files.grep %r/^(?:lib\/.+|Gemfile|(?:CHANGELOG|LICENSE|README)\.adoc|jekyll-asciidoc\.gemspec)$/
+  #s.test_files = files.grep %r/^spec\/./
 
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'asciidoctor', '>= 1.5.0'
-  s.add_runtime_dependency 'jekyll', '>= 2.3.0'
+  s.add_runtime_dependency 'jekyll', '>= 3.0.0'
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 3.5.0'
+  s.add_development_dependency 'deep-cover-core', '~> 0.7.0'
+  s.add_development_dependency 'rake', '~> 12.3.2'
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+  s.add_development_dependency 'simplecov', '~> 0.16.1'
 end

data/lib/jekyll-asciidoc/compat.rb

@@ -1,20 +1,16 @@
 module Jekyll
   module AsciiDoc
-    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
+    Jekyll3_1 = (::Gem::Requirement.new '~> 3.1.0').satisfied_by? ::Gem::Version.new ::Jekyll::VERSION
   end
-end
 
-module Jekyll
   class Site
-    # 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 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 method_defined? :find_generator_instance
   end
 end
+
+class Regexp
+  alias match? ===
+end unless Regexp.method_defined? :match?

data/lib/jekyll-asciidoc/converter.rb

@@ -4,7 +4,7 @@ module Jekyll
       DefaultAttributes = {
         'idprefix' => '',
         'idseparator' => '-',
-        'linkattrs' => '@'
+        'linkattrs' => '@',
       }
       DefaultFileExtensions = %w(asciidoc adoc ad)
       DefaultPageAttributePrefix = 'page'
@@ -15,14 +15,13 @@ module Jekyll
         'site-gen-jekyll' => '',
         'builder' => 'jekyll',
         'builder-jekyll' => '',
-        'jekyll-version' => ::Jekyll::VERSION
+        'jekyll-version' => ::Jekyll::VERSION,
       }
       MessageTopic = Utils::MessageTopic
       NewLine = Utils::NewLine
-      StandaloneOptionLine = %([%standalone]#{NewLine})
 
       AttributeReferenceRx = /\\?\{(\w+(?:[\-]\w+)*)\}/
-      HeaderBoundaryRx = /(?<=\p{Graph})#{NewLine * 2}/
+      HeaderBoundaryRx = /(?<=\p{Graph}#{NewLine * 2})/
 
       # Enable plugin when running in safe mode; jekyll-asciidoc gem must also be declared in whitelist
       safe true
@@ -35,13 +34,13 @@ module Jekyll
         @config = config
         @logger = ::Jekyll.logger
         @page_context = {}
-        @setup = false
 
         # NOTE jekyll-watch reinitializes plugins using a shallow clone of config, so no need to reconfigure
         # NOTE check for Configured only works if value of key is defined in _config.yml as Hash
         unless Configured === (asciidoc_config = (config['asciidoc'] ||= {}))
           if ::String === asciidoc_config
-            @logger.warn MessageTopic, 'The AsciiDoc configuration should be defined as Hash under asciidoc key instead of as discrete entries.'
+            @logger.warn MessageTopic,
+                'The AsciiDoc configuration should be defined using Hash on asciidoc key instead of discrete entries.'
             asciidoc_config = config['asciidoc'] = { 'processor' => asciidoc_config }
           else
             asciidoc_config['processor'] ||= 'asciidoctor'
@@ -52,43 +51,40 @@ module Jekyll
           old_page_attr_prefix_def = config.key? 'asciidoc_page_attribute_prefix'
           old_page_attr_prefix_val = config.delete 'asciidoc_page_attribute_prefix'
           unless (page_attr_prefix = asciidoc_config['page_attribute_prefix'])
-            page_attr_prefix = old_page_attr_prefix_def ? (old_page_attr_prefix_val || '') :
-                ((asciidoc_config.key? 'page_attribute_prefix') ? '' : DefaultPageAttributePrefix)
+            page_attr_prefix = old_page_attr_prefix_def ? old_page_attr_prefix_val || '' :
+                (asciidoc_config.key? 'page_attribute_prefix') ? '' : DefaultPageAttributePrefix
           end
-          asciidoc_config['page_attribute_prefix'] = page_attr_prefix.chomp '-'
+          asciidoc_config['page_attribute_prefix'] = (page_attr_prefix = page_attr_prefix.chomp '-').empty? ?
+              '' : %(#{page_attr_prefix}-)
           asciidoc_config['require_front_matter_header'] = !!asciidoc_config['require_front_matter_header']
           asciidoc_config.extend Configured
 
-          begin
-            if (dlg_method = Utils.method :has_yaml_header?) && asciidoc_config['require_front_matter_header']
-              if (::Jekyll::Utils.method dlg_method.name).arity == -1 # not original method
-                ::Jekyll::Utils.define_singleton_method dlg_method.name, &dlg_method
-              end
-            else
-              unless (new_method = dlg_method.owner.method :has_front_matter?).respond_to? :curry
-                new_method = new_method.to_proc # Ruby < 2.2
-              end
-              ::Jekyll::Utils.define_singleton_method dlg_method.name, new_method.curry[dlg_method][asciidoc_ext_re]
+          if asciidoc_config['require_front_matter_header']
+            unless (::Jekyll::Utils.method :has_yaml_header?).owner == ::Jekyll::Utils
+              # NOTE restore original method
+              ::Jekyll::Utils.extend (::Module.new do
+                define_method :has_yaml_header?, &(Utils.method :has_yaml_header?)
+              end)
             end
-          rescue ::NameError; end
+          else
+            ::Jekyll::Utils.extend (::Module.new do
+              define_method :has_yaml_header?,
+                  (Utils.method :has_front_matter?).curry[Utils.method :has_yaml_header?][asciidoc_ext_re]
+            end)
+          end
         end
 
         if (@asciidoc_config = asciidoc_config)['processor'] == 'asciidoctor'
           unless Configured === (@asciidoctor_config = (config['asciidoctor'] ||= {}))
             asciidoctor_config = @asciidoctor_config
-            asciidoctor_config.replace (symbolize_keys asciidoctor_config)
+            asciidoctor_config.replace symbolize_keys asciidoctor_config
             source = ::File.expand_path config['source']
             dest = ::File.expand_path config['destination']
             case (base = asciidoctor_config[:base_dir])
             when ':source'
               asciidoctor_config[:base_dir] = source
             when ':docdir'
-              if defined? ::Jekyll::Hooks
-                asciidoctor_config[:base_dir] = :docdir
-              else
-                @logger.warn MessageTopic, 'Using :docdir as value of base_dir option requires Jekyll 3. Falling back to source directory.'
-                asciidoctor_config[:base_dir] = source
-              end
+              asciidoctor_config[:base_dir] = :docdir
             else
               asciidoctor_config[:base_dir] = ::File.expand_path base if base
             end
@@ -98,9 +94,9 @@ module Jekyll
               'site-source' => source,
               'site-destination' => dest,
               'site-baseurl' => config['baseurl'],
-              'site-url' => config['url']
+              'site-url' => config['url'],
             }
-            attrs = asciidoctor_config[:attributes] = assemble_attributes asciidoctor_config[:attributes],
+            attrs = asciidoctor_config[:attributes] = compile_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.chomp '@')
@@ -108,17 +104,17 @@ module Jekyll
             asciidoctor_config.extend Configured
           end
         end
+
+        load_processor
       end
 
-      def setup
-        return self if @setup
-        @setup = true
+      def load_processor
         case @asciidoc_config['processor']
         when 'asciidoctor'
           begin
             require 'asciidoctor' unless defined? ::Asciidoctor::VERSION
           rescue ::LoadError
-            @logger.error MessageTopic, 'You are missing a library required to convert AsciiDoc files. Please install using:'
+            @logger.error MessageTopic, 'You\'re missing a library required to convert AsciiDoc files. Install using:'
             @logger.error '', '$ [sudo] gem install asciidoctor'
             @logger.abort_with 'Bailing out; missing required dependency: asciidoctor'
           end
@@ -127,7 +123,7 @@ module Jekyll
           @logger.error '', 'Valid options are: asciidoctor'
           @logger.abort_with 'Bailing out; invalid Asciidoctor processor.'
         end
-        self
+        nil
       end
 
       def self.get_instance site
@@ -135,10 +131,10 @@ module Jekyll
       end
 
       def matches ext
-        ext =~ @asciidoc_config['ext_re']
+        @asciidoc_config['ext_re'].match? ext
       end
 
-      def output_ext ext
+      def output_ext _ext
         '.html'
       end
 
@@ -156,7 +152,7 @@ module Jekyll
         record_paths document
       end
 
-      def after_render document
+      def after_render _document
         @page_context.clear
       end
 
@@ -164,13 +160,13 @@ module Jekyll
         @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))
+          'docname' => (::File.basename docfile, (::File.extname docfile)),
         }
-        paths.update({
+        paths.update(
           'outfile' => (outfile = document.destination document.site.dest),
           'outdir' => (::File.dirname outfile),
           'outpath' => document.url
-        }) unless opts[:source_only]
+        ) unless opts[:source_only]
       end
 
       def clear_paths
@@ -178,10 +174,9 @@ module Jekyll
       end
 
       def load_header document
-        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] || ''
+        record_paths document, source_only: true
+        # NOTE merely an optimization; if this doesn't match, the header still gets extracted by the processor
+        header = (content = document.content) ? (HeaderBoundaryRx =~ content ? $` : content) : ''
         case @asciidoc_config['processor']
         when 'asciidoctor'
           opts = @asciidoctor_config.merge parse_header_only: true
@@ -193,26 +188,27 @@ module Jekyll
             end
             opts[:attributes] = opts[:attributes].merge paths
           end
+          if (layout_attr = resolve_default_layout document, opts[:attributes])
+            opts[:attributes] = opts[:attributes].merge layout_attr
+          end
           # NOTE return instance even if header is empty since attributes may be inherited from config
           doc = ::Asciidoctor.load header, opts
         else
-          @logger.warn MessageTopic, %(Unknown AsciiDoc processor: #{@asciidoc_config['processor']}. Cannot load document header.)
+          @logger.warn MessageTopic,
+              %(Unknown AsciiDoc processor: #{@asciidoc_config['processor']}. Cannot load document header.)
           doc = nil
         end
-        clear_paths if defined? ::Jekyll::Hooks
+        clear_paths
         doc
       end
 
       def convert content
         # 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]
-        end
+
         case @asciidoc_config['processor']
         when 'asciidoctor'
-          opts = @asciidoctor_config.merge header_footer: standalone
+          opts = @asciidoctor_config.merge header_footer: (@page_context[:data] || {})['standalone']
           if (paths = @page_context[:paths])
             if opts[:base_dir] == :docdir
               opts[:base_dir] = paths['docdir'] # NOTE this assignment happens inside the processor anyway
@@ -226,7 +222,8 @@ module Jekyll
           end
           ((@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.)
+          @logger.warn MessageTopic,
+              %(Unknown AsciiDoc processor: #{@asciidoc_config['processor']}. Passing through unparsed content.)
           content
         end
       end
@@ -237,9 +234,9 @@ module Jekyll
         hash.each_with_object({}) {|(key, val), accum| accum[key.to_sym] = val }
       end
 
-      def assemble_attributes attrs, initial = {}
+      def compile_attributes attrs, initial = {}
         if (is_array = ::Array === attrs) || ::Hash === attrs
-          attrs.each_with_object(initial) {|entry, new_attrs|
+          attrs.each_with_object(initial) do |entry, new_attrs|
             key, val = is_array ? ((entry.split '=', 2) + ['', ''])[0..1] : entry
             if key.start_with? '!'
               new_attrs[key[1..-1]] = nil
@@ -249,23 +246,22 @@ module Jekyll
             elsif key.start_with? '-'
               new_attrs.delete key[1..-1]
             else
-              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
+              case val
+              when ::String
+                new_attrs[key] = resolve_attribute_refs val, new_attrs
+              when ::Numeric
+                new_attrs[key] = val.to_s
+              when true
+                new_attrs[key] = ''
+              when nil, false
                 # we may preserve false in the future to mean "unset implicit value but allow doc to override"
-                nil
+                # false already has special meaning for page-layout, so don't coerce it
+                new_attrs[key] = key == 'page-layout' ? val : nil
+              else
+                new_attrs[key] = val
               end
             end
-          }
+          end
         else
           initial
         end
@@ -281,11 +277,35 @@ module Jekyll
         end
       end
 
+      def resolve_default_layout document, attributes
+        layout_attr_name = %(#{document.site.config['asciidoc']['page_attribute_prefix']}layout)
+        if attributes.key? layout_attr_name
+          if ::String === (layout = attributes[layout_attr_name])
+            if layout == '~@'
+              layout = 'none@'
+            elsif (layout.end_with? '@') && ((document.data.key? 'layout') || document.data['layout'])
+              layout = %(#{(layout = document.data['layout']).nil? ? 'none' : layout}@)
+            else
+              layout = nil
+            end
+          elsif layout.nil?
+            layout = 'none'
+          else
+            layout = layout.to_s
+          end
+        elsif (document.data.key? 'layout') || document.data['layout']
+          layout = %(#{(layout = document.data['layout']).nil? ? 'none' : layout}@)
+        else
+          layout = '@'
+        end
+        layout ? { layout_attr_name => layout } : nil
+      end
+
       # Register pre and post render callbacks for saving and clearing contextual AsciiDoc attributes, respectively.
       ::Jekyll::Hooks.tap do |hooks|
         hooks.register [:pages, :documents], :pre_render, &(method :before_render)
         hooks.register [:pages, :documents], :post_render, &(method :after_render)
-      end if defined? ::Jekyll::Hooks
+      end
     end
   end
 end

data/lib/jekyll-asciidoc/filters.rb

@@ -27,9 +27,8 @@ module Jekyll
       #
       # 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
+        ::Asciidoctor::Document === document ?
+          (document.converter.convert document, 'outline', toclevels: (levels.nil_or_empty? ? nil : levels.to_i)) : nil
       end
     end
 

data/lib/jekyll-asciidoc/integrator.rb

@@ -5,7 +5,6 @@ module Jekyll
     # source highlighter and configured to use class-based styling.
     class Integrator < ::Jekyll::Generator
       NewLine = Utils::NewLine
-      StandaloneOptionLine = Converter::StandaloneOptionLine
 
       # Enable plugin when running in safe mode; jekyll-asciidoc gem must also be declared in whitelist
       safe true
@@ -17,23 +16,13 @@ module Jekyll
       # 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
-
-        unless (@page_attr_prefix = site.config['asciidoc']['page_attribute_prefix']).empty?
-          @page_attr_prefix = %(#{@page_attr_prefix}-)
-        end
+        @converter = converter = Converter.get_instance site
 
         site.pages.select! do |page|
           (converter.matches page.ext) ? (integrate page) : true
         end
 
-        # NOTE posts were migrated to a collection named 'posts' in Jekyll 3
-        site.posts.select! do |post|
-          (converter.matches post.ext) ? (integrate post, 'posts') : true
-        end if site.respond_to? :posts=
-
         site.collections.each do |name, collection|
-          next unless collection.write?
           collection.docs.select! do |doc|
             (converter.matches doc.extname) ? (integrate doc, name) : true
           end
@@ -55,10 +44,10 @@ 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['layout']
         return true unless (doc = @converter.load_header document)
 
+        data = document.data
+        data['asciidoc'] = true
         # 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?
@@ -66,35 +55,35 @@ module Jekyll
         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) == 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?
-          data.update adoc_data
+        page_attr_prefix = document.site.config['asciidoc']['page_attribute_prefix']
+        no_prefix = (prefix_size = page_attr_prefix.length) == 0
+        adoc_data = doc.attributes.each_with_object({}) do |(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
         end
+        data.update adoc_data unless adoc_data.empty?
 
         { '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 
+          if (sole_val = data[sole_key])
+            (coll_val = data[coll_key] ||= []).delete sole_val
+            coll_val.unshift sole_val
+          elsif (coll_val = data[coll_key])
+            data[sole_key] = coll_val[0]
           end
         end
 
         case data['layout']
         when nil
-          document.content = %(#{StandaloneOptionLine}#{document.content}) unless data.key? 'layout'
+          data['standalone'] = true unless data.key? 'layout'
         when '', '_auto'
           layout = collection_name ? (collection_name.chomp 's') : 'page'
           data['layout'] = (document.site.layouts.key? layout) ? layout : 'default'
         when false
           data['layout'] = 'none'
-          document.content = %(#{StandaloneOptionLine}#{document.content})
+          data['standalone'] = true
         end
 
         document.extend Document
@@ -116,7 +105,7 @@ module Jekyll
         if site.static_files.any? {|f| f.path == css_file }
           ::IO.write css_file, css unless css == (::IO.read css_file)
         else
-          ::Asciidoctor::Helpers.mkdir_p (::File.dirname css_file)
+          ::Asciidoctor::Helpers.mkdir_p ::File.dirname css_file
           ::IO.write css_file, css
           site.static_files << (::Jekyll::StaticFile.new site, css_base, css_dir, css_name)
         end