jekyll-asciidoc 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48f6d28bbd931f1d823e06625ad68b9314cf8836
-  data.tar.gz: c59995e13e47e147624ec578d4c42cf5d187953f
+  metadata.gz: 5f0880454bf13707df6ab46db960a614e543e1d5
+  data.tar.gz: 91f7795b3722073aca1a3ab2c49a0d04f9883033
 SHA512:
-  metadata.gz: f97b51d72a92abc00d2bed80fc561ef74bb26e9022be6204af97dca38830f38bf09f54bd18fc99920e4cacbc171f86e0f238a322f7ec291f3aa0cf56752e5dd2
-  data.tar.gz: e1905e712312e6d108de8f79ad69717477d71f33f62b4baf653ca86f7988f80b203172b8e1027070a5a27b20cd23190a052996cc44a4dce3263480963b0f2551
+  metadata.gz: 4e865f7e9ef44ee8b8626b6948fa184d50bfd3bb8d799065e2f89dddbfc3a2a97ab5e54f6b98afe66aee5c3d771fab0a51703cbb92c6f8a10b715ada0c59256e
+  data.tar.gz: 8e210f65e121dd1d208e9b7492bf3f3f1af6284e0d433ee1e8c3fe844f3de64d7e27df163b899df347189d5fdb87c6d7dc4ac867c8cc11c483e10b212537844f

data/CHANGELOG.adoc

@@ -0,0 +1,91 @@
+= {project-name} Changelog
+:project-name: Jekyll AsciiDoc Plugin
+:uri-repo: https://github.com/asciidoctor/jekyll-asciidoc
+
+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.0.1 (2016-07-06) - @mojavelinux
+
+* align localtime and localdate attributes with site.time and site.timezone (#117)
+* don't register hook callbacks again when regenerating site; use static methods for hook callbacks (#121)
+* bundle CHANGELOG.adoc and test suite in gem
+* minor improvements to README
+
+== 2.0.0 (2016-07-02) - @mojavelinux
+
+* Split source into multiple files; move all classes under the `Jekyll::AsciiDoc` module
+* Avoid redundant initialization caused by the jekyll-watch plugin
+* Set docdir, docfile, docname, outfile, outdir, and outpath attributes for each file if using Jekyll 3 (#59)
+  - docdir is only set if value of `base_dir` option is `:docdir`
+  - setting outdir allows proper integration with Asciidoctor Diagram
+* Automatically set `imagesoutdir` attribute if `imagesdir` attribute is relative to root
+* Pass site information (root, source, destination, baseurl and url) through as AsciiDoc attributes
+* Automatically generate stylesheet for Pygments (#30)
+* Change default layout to match collection label (#104)
+  - page for pages, post for posts, collection label for all others; use default layout as fallback
+* Resolve attribute references in attribute values defined in config (#103)
+* Apply AsciiDoc header integration to documents in all collections (#93)
+* Document how to create and enable templates to customize the HTML that Asciidoctor generates (#73)
+* Allow `base_dir` option to track document directory by setting the value to `:docdir` (#80)
+* Add a comprehensive test suite (#77)
+* Allow site-wide Asciidoctor attributes to be specified as a Hash; convert to Hash if Array is used (#87)
+* Interpret page attribute values as YAML data
+* Use Jekyll.logger to write log messages (#85)
+* Add topic to all log messages
+* Restructure configuration keys so all general settings are under the `asciidoc` key (#82)
+* Don't enable `hardbreaks` attribute by default (#69)
+* Bump minimum version of Jekyll to 2.3.0 and document requirement in README (#76)
+* Allow layout to be disabled to create standalone document; add and document additional option values for layout (#63)
+* Make front matter header optional (#57)
+* Apply site-wide Asciidoctor configuration (options/attributes) when loading document header (#67)
+* Disable liquid processor on AsciiDoc files by default; enable using liquid page variable (#65)
+* Resolve empty page attribute value as empty string (#70)
+* Soft assign linkattrs attribute
+* Allow plugin to work in safe mode (#112)
+* Major restructure and rewrite of README
+* Document how to use plugin with GitLab Pages (#47)
+* Document asciidocify filter
+
+{uri-repo}/issues?q=milestone%3Av2.0.0[issues resolved] |
+{uri-repo}/releases/tag/v2.0.0[git tag]
+
+== 1.1.2 (2016-05-10) - @mkobit
+
+* Apply fix for documents that did not contain at least one attribute beginning with `page-` (#60)
+
+{uri-repo}/issues?q=milestone%3Av1.1.2[issues resolved] |
+{uri-repo}/releases/tag/v1.1.2[git tag]
+
+== 1.1.1 (2016-05-07) - @mkobit
+
+* The AsciiDoc document title overrides the title set in the front matter or the auto-generated title (in the case of a post) (#48)
+* The AsciiDoc page-related attributes override the matching entries in the page data (i.e., front matter)
+* The value of page-related attributes are treated as YAML values (automatic type coercion)
+* `page-` is the default prefix for page-related AsciiDoc attributes (e.g., `page-layout`) (#51)
+* The key to configure the page attribute prefix is `asciidoc_page_attribute_prefix`; the value should not contain the trailing hyphen (#51)
+* The date of a post can be set using the `revdate` AsciiDoc attribute (#53)
+* Only configure the Asciidoctor options once (previously it was being called twice in serve mode)
+* Set `env` attribute to `site` instead of `jekyll` (#55)
+
+{uri-repo}/issues?q=milestone%3Av1.1.1[issues resolved] |
+{uri-repo}/releases/tag/v1.1.1[git tag]
+
+== 1.0.1 (2016-03-19) - @mkobit
+
+Enables use with Jekyll 3.
+It is still compatible with Jekyll 2.
+
+* Jekyll 3 support (#36, #33)
+* Documentation and onboarding improvements (#25, #24)
+* Improvements to release process (#28)
+
+{uri-repo}/issues?q=milestone%3Av1.0.1[issues resolved] |
+{uri-repo}/releases/tag/v1.0.1[git tag]
+
+== 1.0.0 (2015-01-04) - @paulrayner
+
+Initial release.
+
+{uri-repo}/issues?q=milestone%3Av1.0.0[issues resolved] |
+{uri-repo}/releases/tag/v1.0.0[git tag]

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'jekyll', %(~> #{ENV['JEKYLL_VERSION']}) if ENV.key? 'JEKYLL_VERSION'
+
+if RUBY_ENGINE == 'jruby'
+  gem 'pygments.rb', github: 'mojavelinux/pygments.rb', branch: 'support-jruby'
+else
+  gem 'pygments.rb', '~> 0.6.3'
+end

data/README.adoc

@@ -1,6 +1,6 @@
 = Jekyll AsciiDoc Plugin (powered by Asciidoctor)
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Paul Rayner <https://github.com/paulrayner[@paulrayner]>
-v2.0.0, 2016-07-02
+v2.0.1, 2016-07-06
 // Settings:
 :idprefix:
 :idseparator: -
@@ -206,11 +206,15 @@ You can now build your site using:
 
  $ jekyll build
 
-and preview it using:
+or preview it using:
 
  $ jekyll serve
 
-If you're using Bundler, then prefix the commands with `bundle exec`, as in:
+You can continuously build without preview using:
+
+ $ jekyll build --watch
+
+If you're using Bundler, prefix the commands with `bundle exec`, as in:
 
  $ bundle exec jekyll build
 
@@ -439,7 +443,7 @@ Each template file corresponds to a node in the AsciiDoc document tree (aka AST)
 
 Below are the steps you need to take to configure Asciidoctor to use custom templates with your site.
 
-=== Step 1: Add Required Gems
+=== Step {counter:step}: Add Required Gems
 
 You'll first need to add the thread_safe gem as well as the gem for the templating language you plan to use.
 We'll assume that you are using Slim.
@@ -450,19 +454,19 @@ gem 'slim', '~> 3.0.7'
 gem 'thread_safe', '~> 0.3.5'
 ----
 
-=== Step 2: Install New Gems
+=== Step {counter:step}: Install New Gems
 
 Now run the `bundle` command to install the new gems.
 
  $ bundle
 
-=== Step 3: Create a Templates Folder
+=== Step {counter:step}: Create a Templates Folder
 
 Next, create a new folder in your site named [path]__templates_ to store your templates.
 
  $ mkdir _templates
 
-=== Step 4: Configure Asciidoctor to Load Templates
+=== Step {counter:step}: Configure Asciidoctor to Load Templates
 
 In your site's {path-config} file, configure Asciidoctor to load the templates by telling it the location where the templates are stored.
 
@@ -473,7 +477,7 @@ asciidoctor:
   attributes: ...
 ----
 
-=== Step 5: Compose a Template
+=== Step {counter:step}: Compose a Template
 
 The final step is to compose a template.
 We'll be customizing the unordered list node.
@@ -805,15 +809,20 @@ GitHub doesn't (yet) whitelist the AsciiDoc plugin, so you must run Jekyll eithe
 GitHub needs to hear from enough users that need this plugin to persuade them to enable it.
 Our recommendation is to https://github.com/contact[contact support] and keep asking for it.
 
-Refer to the help page https://help.github.com/articles/adding-jekyll-plugins-to-a-github-pages-site/[Adding Jekyll Plugins to a GitHub Pages site] for a list of plugins currently supported on GitHub Pages.
+Refer to the help page https://help.github.com/articles/adding-jekyll-plugins-to-a-github-pages-site[Adding Jekyll Plugins to a GitHub Pages site] for a list of plugins currently supported on GitHub Pages.
 ====
 
-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-site[Tranfuse website build^] for an example in practice.
+_But don't despair!_
+You can still automate publishing of the generated site to GitHub Pages using a continuous integration job.
+Refer to the http://eshepelyuk.github.io/2014/10/28/automate-github-pages-travisci.html[Automate GitHub Pages publishing with Jekyll and Travis CI^] tutorial to find step-by-step instructions.
+You can also refer to the https://github.com/johncarl81/transfuse-site[Transfuse website build^] for an example in practice.
 
-TIP: If you want to take a shortcut that skips all the steps in the tutorial, clone the {uri-jaq}[Jekyll AsciiDoc Quickstart (JAQ)] repository and use it as a starting point for your site.
-JAQ provides a page layout out of the box configured to fully style body content generated from AsciiDoc.
+TIP: When using this setup, don't forget to add the [path]_.nojekyll_ file to the root of the source to tell GitLab Pages not to waste time running Jekyll again on the server.
+
+=== Jekyll AsciiDoc Quickstart
+
+If you want to take a shortcut that skips all the steps in the previously mentioned tutorial, clone the {uri-jaq}[Jekyll AsciiDoc Quickstart (JAQ)] repository and use it as a starting point for your site.
+JAQ includes a Rake build that is preconfigured to deploy to GitHub Pages from Travis CI and also provides a theme (page layout and CSS) that properly styles body content generated from AsciiDoc.
 
 == Using this Plugin on GitLab Pages
 
@@ -1006,8 +1015,10 @@ The coding style is as follows:
   if key.start_with? '!'
     ...
   end
-+
-  asciidoctor_config.replace Utils.symbolize_keys asciidoctor_config
+
+* For chained method calls, wrap parentheses around nested method call.
+
+  asciidoctor_config.replace (Utils.symbolize_keys asciidoctor_config)
 
 * Use parentheses outside of a method call when parentheses are required.
 

data/jekyll-asciidoc.gemspec

@@ -0,0 +1,31 @@
+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.authors = ['Dan Allen', 'Paul Rayner']
+  s.email = ['dan.j.allen@gmail.com']
+  s.homepage = 'https://github.com/asciidoctor/jekyll-asciidoc'
+  s.license = 'MIT'
+
+  files = begin
+    output = IO.popen('git ls-files -z', err: File::NULL) {|io| io.read }.split %(\0)
+    $?.success? ? output : Dir['**/*']
+  rescue
+    Dir['**/*']
+  end
+  s.files = files.grep /^(?:lib\/.+|Gemfile|Rakefile|(CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
+  s.test_files = files.grep /^spec\//
+  
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'asciidoctor', '>= 1.5.0'
+  s.add_runtime_dependency 'jekyll', '>= 2.3.0'
+
+  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

@@ -7,8 +7,13 @@ 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}))
+    def find_converter_instance type
+      converters.find {|candidate| type === candidate } || (raise %(No Converters found for #{type}))
     end unless respond_to? :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
 end

data/lib/jekyll-asciidoc/converter.rb

@@ -17,13 +17,14 @@ module Jekyll
         'builder-jekyll' => '',
         'jekyll-version' => ::Jekyll::VERSION
       }
-      MessageTopic = 'Jekyll AsciiDoc:'
-      StandaloneOptionLine = Utils::StandaloneOptionLine
+      MessageTopic = Utils::MessageTopic
+      NewLine = Utils::NewLine
+      StandaloneOptionLine = %([%standalone]#{NewLine})
 
-      HeaderBoundaryRx = /(?<=\p{Graph})#{Utils::NewLine * 2}/
+      AttributeReferenceRx = /\\?\{(\w+(?:[\-]\w+)*)\}/
+      HeaderBoundaryRx = /(?<=\p{Graph})#{NewLine * 2}/
 
-      # Enable plugin when running in safe mode
-      # jekyll-asciidoc gem must also be declared in whitelist
+      # 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
@@ -75,7 +76,7 @@ module Jekyll
         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
+            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])
@@ -99,7 +100,7 @@ module Jekyll
               'site-baseurl' => config['baseurl'],
               'site-url' => config['url']
             }
-            attrs = asciidoctor_config[:attributes] = Utils.hashify_attributes asciidoctor_config[:attributes],
+            attrs = asciidoctor_config[:attributes] = 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
@@ -129,6 +130,10 @@ module Jekyll
         self
       end
 
+      def self.get_instance site
+        site.find_converter_instance self
+      end
+
       def matches ext
         ext =~ @asciidoc_config['ext_re']
       end
@@ -137,12 +142,20 @@ module Jekyll
         '.html'
       end
 
+      def self.before_render document, payload
+        (get_instance document.site).before_render document, payload if Document === document
+      end
+
+      def self.after_render document
+        (get_instance document.site).after_render document if Document === document
+      end
+
       def before_render document, payload
-        record_path_info document if Document === document
+        record_path_info document
       end
 
       def after_render document
-        clear_path_info if Document === document
+        clear_path_info
       end
 
       def record_path_info document, opts = {}
@@ -213,6 +226,45 @@ module Jekyll
           content
         end
       end
+
+      private
+
+      def symbolize_keys hash
+        hash.each_with_object({}) {|(key, val), accum| accum[key.to_sym] = val }
+      end
+
+      def hashify_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
+            if key.start_with? '!'
+              new_attrs[key[1..-1]] = nil
+            elsif key.end_with? '!'
+              new_attrs[key.chop] = nil
+            else
+              new_attrs[key] = val ? (resolve_attribute_refs val, new_attrs) : nil
+            end
+          }
+        else
+          initial
+        end
+      end
+
+      def resolve_attribute_refs text, attrs
+        if text.empty?
+          text
+        elsif text.include? '{'
+          text.gsub(AttributeReferenceRx) { ((m = $&).start_with? '\\') ? m[1..-1] : (attrs.fetch $1, m) }
+        else
+          text
+        end
+      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

data/lib/jekyll-asciidoc/filters.rb

@@ -8,7 +8,7 @@ module Jekyll
       #
       # Returns the HTML formatted String.
       def asciidocify input, doctype = nil
-        (@context.registers[:cached_asciidoc_converter] ||= (Utils.get_converter @context.registers[:site]))
+        (@context.registers[:cached_asciidoc_converter] ||= (Converter.get_instance @context.registers[:site]))
           .convert(doctype ? %(:doctype: #{doctype}#{Utils::NewLine}#{input}) : (input || ''))
       end
     end

data/lib/jekyll-asciidoc/integrator.rb

@@ -1,27 +1,23 @@
 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.
+    # Promotes eligible AsciiDoc attributes to page variables and applies page-level settings to all documents handled
+    # by the converter included with this plugin. It also copies the custom Pygments stylesheet if Pygments is the
+    # source highlighter and configured to use class-based styling.
     class Integrator < ::Jekyll::Generator
       NewLine = Utils::NewLine
-      StandaloneOptionLine = Utils::StandaloneOptionLine
+      StandaloneOptionLine = Converter::StandaloneOptionLine
 
-      # Enable plugin when running in safe mode
-      # jekyll-asciidoc gem must also be declared in whitelist
+      # Enable plugin when running in safe mode; jekyll-asciidoc gem must also be declared in whitelist
       safe true
 
+      def self.get_instance site
+        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).
       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
+        @converter = converter = (Converter.get_instance site).setup
 
         unless (@page_attr_prefix = site.config['asciidoc']['page_attribute_prefix']).empty?
           @page_attr_prefix = %(#{@page_attr_prefix}-)
@@ -43,8 +39,9 @@ module Jekyll
           end
         end
 
-        if (attrs = site.config['asciidoctor'][:attributes]) &&
-            ((attrs['source-highlighter'] || '').chomp '@') == 'pygments' &&
+        attrs = site.config['asciidoctor'][:attributes]
+        attrs['localdate'], attrs['localtime'] = (site.time.strftime '%Y-%m-%d %H:%M:%S %Z').split ' ', 2
+        if ((attrs['source-highlighter'] || '').chomp '@') == 'pygments' &&
             ((attrs['pygments-css'] || '').chomp '@') != 'style' && (attrs.fetch 'pygments-stylesheet', '')
           generate_pygments_stylesheet site, attrs
         end
@@ -72,7 +69,7 @@ module Jekyll
         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
+                accum[key] = ::String === val ? (parse_yaml_value val) : val
               end
             }).empty?
           document.data.update adoc_header_data
@@ -109,11 +106,39 @@ 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
       end
+
+      private
+
+      # 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.
+      #
+      # 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.
+      def parse_yaml_value val
+        if val.empty?
+          ''
+        else
+          begin
+            ::SafeYAML.load %(--- #{val})
+          rescue
+            val = val.gsub '\'', '\'\'' if val.include? '\''
+            ::SafeYAML.load %(--- \'#{val}\')
+          end
+        end
+      end
     end
   end
 end