jekyll-asciidoc 1.1.2 → 2.0.0

data/Rakefile

@@ -2,6 +2,15 @@ require 'rake/clean'
 
 default_tasks = []
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['-c']
+  end
+  default_tasks << :spec
+rescue LoadError
+end
+
 begin
   require 'bundler/gem_tasks'
   default_tasks << :build
@@ -9,7 +18,7 @@ rescue LoadError
   warn 'jekyll-asciidoc: Bundler is required to build this gem.
 You can install Bundler using the `gem install` command:
 
- $ gem install bundler' + %(\n\n)
+ $ [sudo] gem install bundler' + %(\n\n)
 end
 
 task :default => default_tasks unless default_tasks.empty?

data/lib/jekyll-asciidoc.rb

@@ -1,151 +1,6 @@
-JEKYLL_MIN_VERSION_3 = Gem::Version.new(Jekyll::VERSION) >= Gem::Version.new('3.0.0') unless defined? JEKYLL_MIN_VERSION_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"
-      highlighter_suffix "\n"
-
-      def initialize(config)
-        @config = config
-        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
-      end
-
-      def setup
-        return if @setup
-        @setup = true
-        case @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
-      end
-      
-      def matches(ext)
-        ext =~ @config['asciidoc_ext_re']
-      end
-
-      def output_ext(ext)
-        '.html'
-      end
-
-      def convert(content)
-        setup
-        case @config['asciidoc']
-        when 'asciidoctor'
-          Asciidoctor.convert(content, @config['asciidoctor'])
-        else
-          warn 'Unknown AsciiDoc converter. Passing through raw content.'
-          content
-        end
-      end
-
-      def load_header(content)
-        setup
-        case @config['asciidoc']
-        when 'asciidoctor'
-          Asciidoctor.load(content, parse_header_only: true)
-        else
-          warn 'Unknown AsciiDoc converter. Cannot load document header.'
-          nil
-        end
-      end
-    end
-  end
-
-  module Generators
-    # Promotes select AsciiDoc attributes to Jekyll front matter
-    class AsciiDocPreprocessor < Generator
-      def generate(site)
-        asciidoc_converter = JEKYLL_MIN_VERSION_3 ?
-            site.find_converter_instance(Jekyll::Converters::AsciiDocConverter) :
-            site.getConverterImpl(Jekyll::Converters::AsciiDocConverter)
-        asciidoc_converter.setup
-        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)
-            next unless (doc = asciidoc_converter.load_header(page.content))
-
-            page.data['title'] = doc.doctitle if doc.header?
-            page.data['author'] = doc.author if doc.author
-
-            unless (adoc_front_matter = doc.attributes
-                .select {|name| name.start_with?(page_attr_prefix) }
-                .map {|name, val| %(#{name[page_attr_prefix_l..-1]}: #{val}) }).empty?
-              page.data.update(SafeYAML.load(adoc_front_matter * "\n"))
-            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)
-            next unless (doc = asciidoc_converter.load_header(post.content))
-
-            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 (adoc_front_matter = doc.attributes
-                .select {|name| name.start_with?(page_attr_prefix) }
-                .map {|name, val| %(#{name[page_attr_prefix_l..-1]}: #{val}) }).empty?
-              post.data.update(SafeYAML.load(adoc_front_matter * "\n"))
-            end
-
-            post.data['layout'] = 'post' unless post.data.key? 'layout'
-          end
-        end
-      end
-    end
-  end
-
-  module Filters
-    # Convert an AsciiDoc string into HTML output.
-    #
-    # input - The AsciiDoc String to convert.
-    #
-    # Returns the HTML formatted String.
-    def asciidocify(input)
-      site = @context.registers[:site]
-      converter = JEKYLL_MIN_VERSION_3 ?
-          site.find_converter_instance(Jekyll::Converters::AsciiDocConverter) :
-          site.getConverterImpl(Jekyll::Converters::AsciiDocConverter)
-      converter.convert(input)
-    end
-  end
-end
+require_relative 'jekyll-asciidoc/compat'
+require_relative 'jekyll-asciidoc/utils'
+require_relative 'jekyll-asciidoc/mixins'
+require_relative 'jekyll-asciidoc/converter'
+require_relative 'jekyll-asciidoc/integrator'
+require_relative 'jekyll-asciidoc/filters'

data/lib/jekyll-asciidoc/compat.rb

@@ -0,0 +1,14 @@
+module Jekyll
+  module AsciiDoc
+    Jekyll3Compatible = (::Gem::Version.new ::Jekyll::VERSION) >= (::Gem::Version.new '3.0.0')
+  end
+end
+
+module Jekyll
+  class Site
+    # Backport {::Jekyll::Site#find_converter_instance} to Jekyll 2.
+    def find_converter_instance klass
+      @converters.find {|candidate| klass === candidate } || raise(%(No Converters found for #{klass}))
+    end unless respond_to? :find_converter_instance
+  end
+end

data/lib/jekyll-asciidoc/converter.rb

@@ -0,0 +1,218 @@
+module Jekyll
+  module AsciiDoc
+    class Converter < ::Jekyll::Converter
+      DefaultAttributes = {
+        'idprefix' => '',
+        'idseparator' => '-',
+        'linkattrs' => '@'
+      }
+      DefaultFileExtensions = %w(asciidoc adoc ad)
+      DefaultPageAttributePrefix = 'page'
+      ImplicitAttributes = {
+        'env' => 'site',
+        'env-site' => '',
+        'site-gen' => 'jekyll',
+        'site-gen-jekyll' => '',
+        'builder' => 'jekyll',
+        'builder-jekyll' => '',
+        'jekyll-version' => ::Jekyll::VERSION
+      }
+      MessageTopic = 'Jekyll AsciiDoc:'
+      StandaloneOptionLine = Utils::StandaloneOptionLine
+
+      HeaderBoundaryRx = /(?<=\p{Graph})#{Utils::NewLine * 2}/
+
+      # Enable plugin when running in safe mode
+      # jekyll-asciidoc gem must also be declared in whitelist
+      safe true
+
+      # highlighter prefix/suffix not used by this plugin; defined only to avoid warning
+      highlighter_prefix nil
+      highlighter_suffix nil
+
+      def initialize config
+        @config = config
+        @logger = ::Jekyll.logger
+        @path_info = nil
+        @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.'
+            asciidoc_config = config['asciidoc'] = { 'processor' => asciidoc_config }
+          else
+            asciidoc_config['processor'] ||= 'asciidoctor'
+          end
+          old_asciidoc_ext = config.delete 'asciidoc_ext'
+          asciidoc_ext = (asciidoc_config['ext'] ||= (old_asciidoc_ext || (DefaultFileExtensions * ',')))
+          asciidoc_ext_re = asciidoc_config['ext_re'] = /^\.(?:#{asciidoc_ext.tr ',', '|'})$/ix
+          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)
+          end
+          asciidoc_config['page_attribute_prefix'] = page_attr_prefix.chomp '-'
+          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]
+            end
+          rescue ::NameError; end
+        end
+
+        if (@asciidoc_config = asciidoc_config)['processor'] == 'asciidoctor'
+          unless Configured === (@asciidoctor_config = (config['asciidoctor'] ||= {}))
+            asciidoctor_config = @asciidoctor_config
+            asciidoctor_config.replace Utils.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
+            else
+              asciidoctor_config[:base_dir] = ::File.expand_path base if base
+            end
+            asciidoctor_config[:safe] ||= 'safe'
+            site_attributes = {
+              'site-root' => ::Dir.pwd,
+              'site-source' => source,
+              'site-destination' => dest,
+              'site-baseurl' => config['baseurl'],
+              'site-url' => config['url']
+            }
+            attrs = asciidoctor_config[:attributes] = Utils.hashify_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
+            end
+            asciidoctor_config.extend Configured
+          end
+        end
+      end
+
+      def setup
+        return self if @setup
+        @setup = true
+        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 '', '$ [sudo] gem install asciidoctor'
+            @logger.abort_with 'Bailing out; missing required dependency: asciidoctor'
+          end
+        else
+          @logger.error MessageTopic, %(Invalid AsciiDoc processor given: #{@asciidoc_config['processor']})
+          @logger.error '', 'Valid options are: asciidoctor'
+          @logger.abort_with 'Bailing out; invalid Asciidoctor processor.'
+        end
+        self
+      end
+
+      def matches ext
+        ext =~ @asciidoc_config['ext_re']
+      end
+
+      def output_ext ext
+        '.html'
+      end
+
+      def before_render document, payload
+        record_path_info document if Document === document
+      end
+
+      def after_render document
+        clear_path_info if Document === document
+      end
+
+      def record_path_info document, opts = {}
+        @path_info = {
+          '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
+      end
+
+      def clear_path_info
+        @path_info = nil
+      end
+
+      def load_header document
+        setup
+        record_path_info 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 opts[:base_dir] == :docdir
+              opts[:base_dir] = @path_info['docdir'] # NOTE this assignment happens inside the processor anyway
+            else
+              @path_info.delete 'docdir'
+            end
+            opts[:attributes] = opts[:attributes].merge @path_info
+          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.)
+          doc = nil
+        end
+        clear_path_info if defined? ::Jekyll::Hooks
+        doc
+      end
+
+      def convert content
+        return '' if content.nil_or_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
+          if @path_info
+            if opts[:base_dir] == :docdir
+              opts[:base_dir] = @path_info['docdir'] # NOTE this assignment happens inside the processor anyway
+            else
+              @path_info.delete 'docdir'
+            end
+            opts[:attributes] = opts[:attributes].merge @path_info
+          end
+          ::Asciidoctor.convert content, opts
+        else
+          @logger.warn MessageTopic, %(Unknown AsciiDoc processor: #{@asciidoc_config['processor']}. Passing through unparsed content.)
+          content
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-asciidoc/filters.rb

@@ -0,0 +1,18 @@
+module Jekyll
+  module AsciiDoc
+    module Filters
+      # A Liquid filter for converting an AsciiDoc string to HTML.
+      #
+      # input   - The AsciiDoc String to convert.
+      # doctype - The target AsciiDoc doctype (optional, default: nil).
+      #
+      # Returns the HTML formatted String.
+      def asciidocify input, doctype = nil
+        (@context.registers[:cached_asciidoc_converter] ||= (Utils.get_converter @context.registers[:site]))
+          .convert(doctype ? %(:doctype: #{doctype}#{Utils::NewLine}#{input}) : (input || ''))
+      end
+    end
+
+    ::Liquid::Template.register_filter Filters
+  end
+end

data/lib/jekyll-asciidoc/integrator.rb

@@ -0,0 +1,119 @@
+module Jekyll
+  module AsciiDoc
+    # Registers before and after render hooks to set contextual attributes,
+    # promotes eligible AsciiDoc attributes to page variables, and applies
+    # certain page-level settings.
+    class Integrator < ::Jekyll::Generator
+      NewLine = Utils::NewLine
+      StandaloneOptionLine = Utils::StandaloneOptionLine
+
+      # Enable plugin when running in safe mode
+      # jekyll-asciidoc gem must also be declared in whitelist
+      safe true
+
+      def generate site
+        @converter = converter = (Utils.get_converter site).setup
+
+        if defined? ::Jekyll::Hooks
+          before_render_callback = converter.method :before_render
+          after_render_callback = converter.method :after_render
+          [:pages, :documents].each do |collection_name|
+            ::Jekyll::Hooks.register collection_name, :pre_render, &before_render_callback
+            ::Jekyll::Hooks.register collection_name, :post_render, &after_render_callback
+          end
+        end
+
+        unless (@page_attr_prefix = site.config['asciidoc']['page_attribute_prefix']).empty?
+          @page_attr_prefix = %(#{@page_attr_prefix}-)
+        end
+
+        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
+        end
+
+        if (attrs = site.config['asciidoctor'][:attributes]) &&
+            ((attrs['source-highlighter'] || '').chomp '@') == 'pygments' &&
+            ((attrs['pygments-css'] || '').chomp '@') != 'style' && (attrs.fetch 'pygments-stylesheet', '')
+          generate_pygments_stylesheet site, attrs
+        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}.
+      #
+      # 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).
+      #
+      # 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')
+
+        no_prefix = (prefix_size = @page_attr_prefix.length).zero?
+        unless (adoc_header_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 ? (Utils.parse_yaml_value val) : val
+              end
+            }).empty?
+          document.data.update adoc_header_data
+        end
+
+        case document.data['layout']
+        when nil
+          document.content = %(#{StandaloneOptionLine}#{document.content}) unless document.data.key? 'layout'
+        when '', '_auto'
+          layout = collection_name ? (collection_name.chomp 's') : 'page'
+          document.data['layout'] = (document.site.layouts.key? layout) ? layout : 'default'
+        when false
+          document.data.delete 'layout'
+          document.content = %(#{StandaloneOptionLine}#{document.content})
+        end
+
+        document.extend NoLiquid unless document.data['liquid']
+        document.data.fetch 'published', true
+      end
+
+      def generate_pygments_stylesheet site, attrs
+        css_base = site.source
+        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_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
+        # NOTE apply stronger CSS rule for general text color
+        css = css.sub '.listingblock .pygments  {', '.listingblock .pygments, .listingblock .pygments code {'
+        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
+          ::IO.write css_file, css
+          site.static_files << (::Jekyll::StaticFile.new site, css_base, css_dir, css_name)
+        end
+      end
+    end
+  end
+end