jekyll_aspec 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c39d61a6498f5af8f4d8ed4e5845a9f5ad0fac87
-  data.tar.gz: bdd6191dcd9382f9804ded987609672fb343b0ef
+  metadata.gz: 5c606a844a3e7cc86b1a1dc7d5734d331e56c125
+  data.tar.gz: eed7882c3018c18c4a8ed11fd5f69f64a0c92bcd
 SHA512:
-  metadata.gz: b07a3e61eb8a373aea89fd6f526528dddd6875b671dfa8defd1cb9812f9ad7c4145be1bdd783ecc983e0d06ec9665cd6861bb5351c89556958776367d79fa5b7
-  data.tar.gz: ba7f2af116019673c1a3c9f2876ca047ba8039e4b8e9e660456bb6b8d2a5599d57323b4628b0e7c4cdf501b8cf859172c0782a2668ee38281519628ce6557509
+  metadata.gz: 43fcafd2d451abc45f987b1123db14f83dd6fbb917187b850f27ae2dfd1537e84162f8c2dda14bd83a1292ae4cea12a3048dd015619c294ef2134e831c5b6531
+  data.tar.gz: ebd58cbb80e998e1d644d0e967b09ca5a953613f03eedb80b2de0de33bd842577a5af2553488cb3299ba2ea0dfc0917ec09d4bea167dd0b1c76a05be4c3cd5b6

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/LineLength:
+  # This will disable the rule completely, regardless what other options you put
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.3
+  - 2.3.0

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jekyll-aspec.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll_aspec (1.0.1)
+    jekyll_aspec (1.0.2)
       asciidoctor (>= 1.5.0)
 
 GEM

data/README.md

@@ -2,26 +2,26 @@
 
 [![Gem Version](https://badge.fury.io/rb/jekyll_aspec.svg)](https://badge.fury.io/rb/jekyll_aspec) [![Build Status](https://travis-ci.org/bsmith-n4/jekyll_aspec.svg?branch=master)](https://travis-ci.org/bsmith-n4/jekyll_aspec)
 
-A selection of Asciidoctor extensions designed to used to write some AsciiSpec with Jekyll. 
+A selection of Asciidoctor extensions for use with Jekyll and [jekyll-asciidoc](https://github.com/asciidoctor/jekyll-asciidoc). 
 
 These extensions add custom blocks for Requirements and attempts to smartly handle inter-document auto-linking functionality.
 
 ## Motivation
 
 Jekyll is a very flexible and speedy tool for generating static HTML pages. 
-The `jekyl-asciidoc` gem adds Asciidoctor functionality but it lacks a few features due to the way it handles multiple source files. As each `.adoc` file is consumed individually, we lose the ability to automatically format inter-document cross-references. This plugin is a group of extensions that performs some directory walking, stores the location of titles and anchors so that cross references in a Jekyll project are resolved automatically. 
+The [jekyll-asciidoc](https://github.com/asciidoctor/jekyll-asciidoc) gem adds Asciidoctor functionality but it lacks a few features due to the way it handles multiple source files. As each `.adoc` file is consumed individually, we lose the ability to automatically format inter-document cross-references. This plugin is a group of extensions that performs some directory walking, stores the location of titles and anchors so that cross references in a Jekyll project are resolved automatically. 
 
 Additional features are
 
 * Custom block for ``TODO``s
 * Requirements Block with versioning
-* Requirements block macro that creates a Table of Contents of declared Requirements
+* Requirements block macro that creates an appendix-style Table of Contents for Requirements
 * Inline Callout macro to arbitrarily add callouts
 * Inline Task macro to link to Jira tickets or Github Issues
 * Inline Repo Macro to link to specific files or lines on GitHub
 * A HTML postprocessor to correct some minor fixes and invalid tags created by Asciidoctor
 
-When these custom extensions are combined with other recommended gems such as `asciidoctor-bibtex` and `asciidoctor-latex`, you can achieve quite high quality, speedy HTML documentation for technical projects with the benefits of a Jekyll build. It's recommended to use the `html-proofer` gem which will validate all links created with these extensions.
+When these custom extensions are combined with other recommended gems such as `asciidoctor-bibtex` and `asciidoctor-latex`, you can achieve quite high quality, speedy HTML documentation for technical projects with the benefits of a Jekyll build. It's recommended to use the [html-proofer](https://github.com/gjtorikian/html-proofer) gem which will validate all links created with these extensions.
 
 ## Installation
 
@@ -36,18 +36,18 @@ end
 
 Or install it yourself as:
 
- $ gem install jekyll_aspec
+```
+$ gem install jekyll_aspec
+```
 
 ## Docs
 
-Yard documentation is generation automatically at http://www.rubydoc.info/gems/jekyll_aspec/
-
-Also refer to the `docs` directory for some basic documentation on extended Asciidoctor features.
+Yard documentation is generation automatically at [RubyDoc.info](http://www.rubydoc.info/gems/jekyll_aspec/)
 
 ## Contributing
 
-This gem is under heavy initial development and there are still many kinks to work out. The areas to be improved upon include performance enhancements, proper handling of file IO / directory walking and, of course, documentation. Bug reports and pull requests are welcome on GitHub at https://github.com/bsmith-n4/jekyll_aspec.
+This gem is under heavy initial development and there are still many kinks to work out. The areas to be improved upon include performance enhancements, proper handling of file IO / directory walking and, of course, documentation. Bug reports and pull requests are welcome on [GitHub](https://github.com/bsmith-n4/jekyll_aspec).
 
 ## License
 
-The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,8 +1,15 @@
 require 'bundler/gem_tasks'
 require 'test/unit'
 
-task :default => :test
+task default: :test
 
 task :test do
   ruby 'test/suite.rb'
+  ruby 'test/html_postprocessor.rb'
+  ruby 'test/convert_doc.rb'
+end
+
+task :rubocop do
+  sh 'rubocop'
+  sh 'htmlproofer test'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "jekyll-aspec"
+require 'bundler/setup'
+require 'jekyll-aspec'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "jekyll-aspec"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/jekyll_aspec.gemspec

@@ -1,34 +1,34 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jekyll_aspec/version"
+require 'jekyll_aspec/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jekyll_aspec"
+  spec.name          = 'jekyll_aspec'
   spec.version       = JekyllAspec::VERSION
-  spec.authors       = ["bsmith-n4"]
-  spec.email         = ["brian.smith@numberfour.eu"]
+  spec.authors       = ['bsmith-n4']
+  spec.email         = ['brian.smith@numberfour.eu']
 
-  spec.summary       = %q{Asciidoctor extensions for use as a Jekyll plugin}
-  spec.description   = %q{This plugin is a group of Asciidoctor extensions that perform directory walking, 
+  spec.summary       = 'Asciidoctor extensions for use as a Jekyll plugin'
+  spec.description   = 'This plugin is a group of Asciidoctor extensions that perform directory walking,
                           resolving the location of titles and anchors in all adoc files so that inter-document
-                          cross-references in a Jekyll project are resolved automatically. Also included are some 
-                          custom macros and blocks that are useful for techinical writing.}
-  spec.homepage      = "https://github.com/bsmith-n4/jekyll_aspec"
-  spec.license       = "MIT"
+                          cross-references in a Jekyll project are resolved automatically. Also included are some
+                          custom macros and blocks that are useful for techinical writing.'
+  spec.homepage      = 'https://github.com/bsmith-n4/jekyll_aspec'
+  spec.license       = 'MIT'
 
   # This gem will work with 2.0 or greater.
   spec.required_ruby_version = '>= 2.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", ">= 1.15.4"
-  spec.add_development_dependency "rake", ">= 12.1.0"
-  spec.add_development_dependency "test-unit", ">=3.2.6"
-  spec.add_runtime_dependency "asciidoctor", ">= 1.5.0"
+  spec.add_development_dependency 'bundler', '>= 1.15.4'
+  spec.add_development_dependency 'rake', '>= 12.1.0'
+  spec.add_development_dependency 'test-unit', '>=3.2.6'
+  spec.add_runtime_dependency 'asciidoctor', '>= 1.5.0'
 end

data/lib/extensions/autoxrefs.rb

@@ -1,23 +1,118 @@
 require 'asciidoctor/extensions'
 require 'pathname'
-require_relative 'utils/xref_helper'
 
 include ::Asciidoctor
 
-mismatches = Xrefs.list_xrefs
+# Find all Adoc Files
+adoc_files = Dir.glob('**/*.adoc')
 invoc = Dir.pwd
 
+# Make some arrays available
+titles = []
+anchors = []
+xrefs = []
+mismatches = []
+
+replacement = ''
+
+def trim(s)
+  s.gsub!(/_docs\//, '')
+  s.gsub!(/(\.adoc|\.md|\.html)/, '')
+end
+
+def targetify(t)
+  # make all chars lowercase and substitute spaces with hyphens
+  t.downcase.gsub(/\s/, '-')
+end
+
+adoc_files.each do |file_name|
+  lc = 0
+
+  File.read(file_name).each_line do |li|
+    lc += 1
+
+    # Match all <<xrefs>> exluding Requirements
+    if li[/\<\<(?!Req)(.+?)\>\>/]
+
+      text = ''
+      target = ''
+      path = trim(file_name)
+      xref = li.chop.match(/\<\<(?!Req)(\S.+?)\>\>/i).captures[0].to_s
+
+      if xref[/,/]
+        target = xref.downcase.gsub(/,.+/, '').gsub(/\s/, '-')
+        text = xref.gsub(/.+,/, '').lstrip!
+        xref = xref.sub(/,.+/, '')
+        path = file_name
+      else
+        target = xref.downcase.gsub(/\s/, '-')
+        text = xref
+      end
+
+      item = [xref, path, file_name, text, target]
+      xrefs.push item
+
+      # Match .Titles and = Section Titles
+    elsif li[/(^(\.\S\w+)|^(\=+\s+?\S+.+))/]
+
+      # Add check if none found (captures nil)
+      title = li.chop.match(/(?!=+\s)(\S+.+?)$/i).captures[0]
+      title.sub!(/\.(?=\w+?)/, '') if title[/\.(?=\w+?)/]
+      path = trim(file_name)
+      item = [title, path, file_name]
+      titles.push item
+
+    # Match [[anchors]]
+    elsif li[/\[\[(?:|([\w+?_:][\w+?:.-]*)(?:, *(.+))?)\]\]/]
+
+      # Add check if none found (captures nil)
+      anchor = li.chop.match(/(?<=\[\[).+?(?=\]\])/).to_s
+
+      if anchor[/,/]
+        anchor = anchor.match(/(?<=\[\[)(?:|[\w+?_:][\w+?:.-]*)(?=,.+?\]\])/).to_s
+        text = anchor.sub(/.+?,/, '')
+        text = text.sub(/\]\]$/, '')
+      end
+      path = trim(file_name)
+      item = [anchor, path, file_name, text]
+      titles.push item
+
+    end
+  end
+end
+
+# Run through each xref and check for matching titles
+xrefs.each do |xref, xpath, xfile, xtext, xtarget|
+  # check xrefs against titles
+  titles.each do |ttext, tpath, tfile, _tdisp|
+    # puts "checking #{ttext} against #{xref}"
+    next unless ttext == xref
+    # puts "MATCHED #{ttext} with #{xref}"
+
+    # If the paths are not the same (xref and title not the same document) do the following
+    next unless tpath != xpath
+    tpath = 'index' if tpath.to_s.empty?
+    # puts "Title \"#{ttext}\" in #{tfile} - mismatched xref \"#{xref}\" to different doc - #{xpath}"
+
+    xtform = targetify(xtarget)
+    detail = [xref, xtarget, xtext, xpath, xfile, ttext, tpath, tfile, xtform]
+    mismatches.push detail
+  end
+end
+
 Extensions.register do
   preprocessor do
     process do |document, reader|
       fixes = []
       i = 0
 
-      # TODO - remove unused elements (prepended with _) from the helper method in utils/xref_helper
+      # Block is loaded once per document!!!
+      # for each malformed xref
       mismatches.each do |_xref, _xtarget, xtext, _xpath, xfile, _ttext, _tpath, tfile, xtform|
+        # FIXME: This directory is empty in POSTS - breaks conversion
         docfile = document.attributes['docfile'].sub(/^#{invoc}\//, '')
-        Xrefs.trim(docfile)
-        
+        trim(docfile)
+
         next unless docfile.to_s == xfile
 
         # calculate the relative path between source and target
@@ -35,6 +130,8 @@ Extensions.register do
         if li[/\<\<(?!Req)(.+?)\>\>/]
 
           mismatches.each do |xref, xtarget, xtext, _xpath, _xfile, _ttext, _tpath, _tfile, _relpath|
+            # check if the line contains the original xref
+
             next unless li[/\<\<#{xref}(,.+)?\>\>/]
             fixes.each do |x|
               if x[/#{xtarget}/]
@@ -44,6 +141,7 @@ Extensions.register do
             end
             i += 1
           end
+
         else
           replacement = ''
         end

data/lib/extensions/html_postprocessor.rb

@@ -2,11 +2,10 @@ require 'asciidoctor/extensions'
 
 include ::Asciidoctor
 
-# Strip bogus tags generated by Asciidoctor
 Extensions.register do
   postprocessor do
     process do |document, output|
-      output = output.gsub(/<\/p>/, '')
+      output = output.gsub(/<\/p>/, '') if document.basebackend? 'html'
       output
     end
   end

data/lib/extensions/inline_callout_macro.rb

@@ -7,7 +7,7 @@ include ::Asciidoctor
 Asciidoctor::Extensions.register do
   inline_macro do
     named :call
-    process do |parent, target, attrs|
+    process do |parent, target, _attrs|
       Asciidoctor::Inline.new(parent, :callout, target.to_i).convert
     end
   end

data/lib/extensions/inline_cwiki_macro.rb

@@ -14,14 +14,17 @@ Extensions.register do
 
     process do |parent, target, attrs|
       pattern = parent.document.attr 'cwiki-pattern'
-      if pattern.nil? 
+
+      if pattern.nil?
         warn "asciidoctor: WARNING: Attribue 'cwiki-pattern' for inline repo macro not defined"
-        pattern = "unknown"
+        pattern = 'unknown'
+        label = 'warning'
+        target = 'cwiki-pattern missing'
+      else
+        label = Labels.getstatus(attrs)
       end
-      url = pattern % target
 
-      label = Labels.getstatus(attrs)
-      html = Context.format(attrs, target, url, label)
+      html = Context.format(attrs, target, pattern, label)
       (create_pass_block parent, html, attrs).render
     end
   end

data/lib/extensions/inline_repo_macro.rb

@@ -2,12 +2,6 @@ require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 include ::Asciidoctor
 
-url = ''
-file = ''
-line = ''
-formattedurl = ''
-text = ''
-
 # Link to a file on GitHub.
 #
 # repo:<repository>:<file>:<line>[]
@@ -15,7 +9,7 @@ text = ''
 # The target should be set using document attributes prefixed by 'repo_'.
 #
 # @example Attribute configuration
-#   :repo_dockerfiles: www.github.com/exampleuser/dockerfiles/issues 
+#   :repo_dockerfiles: www.github.com/exampleuser/dockerfiles/issues
 # @example Simple Use
 #   repo:dockerfiles:ansible/Dockerfile_template[]
 # @example Link to repo and line number
@@ -29,7 +23,16 @@ Extensions.register do
     named :repo
 
     process do |parent, target, attrs|
+      html = ''
+      url = ''
+      file = ''
+      line = ''
+      formattedurl = ''
+      text = ''
+      arr = []
+
       # @todo fix handling of use within cells. This is done using the context.
+
       if parent.context.to_s == 'cell'
         warn %([Hell in a cell] cell with repo link must have 'asciidoc format')
       end
@@ -64,26 +67,29 @@ Extensions.register do
       parent.document.attributes.each do |key, value|
         next unless key[/^repo_/]
         pattern = key.sub(/^repo_/, '')
-        if repo == pattern
-          formattedurl = "#{value}/#{branch}/#{file}#{line}"
-        else
-          url = ''
-        end
+        arr.push(pattern)
+        formattedurl = "#{value}/#{branch}/#{file}#{line}" if repo == pattern
       end
 
-      if formattedurl.nil? 
-        warn "asciidoctor: WARNING: Attribue 'repo_...' for inline repo macro not defined"
-        pattern = "unknown"
+      if arr.include? repo
+        html = %(<a href=\"#{formattedurl}\" style=\"padding-right:2px;\">
+<span class=\"label label-#{label}\" style=\"font-weight: 400;
+font-size:smaller;\">
+<i class=\"fa fa-github fa-lg\"></i>
+#{text}
+</span>
+</a>)
+      else
+        warn "asciidoctor: WARNING: Inline Repo Macro missing config for '#{target}'"
+        html = %(<a href=\"#\" style=\"padding-right:2px;\">
+<span class=\"label label-warning\" style=\"font-weight: 400;
+font-size:smaller;\">
+<i class=\"fa fa-github fa-lg\"></i>
+Missing repo config for '#{target}'
+</span>
+</a>)
       end
 
-      html = %(<a href=\"#{formattedurl}\" style=\"padding-right:2px;\">
-                  <span class=\"label label-#{label}\" style=\"font-weight: 400;
-                  font-size:smaller;\">
-                    <i class=\"fa fa-github fa-lg\"></i>
-                    #{text}
-                  </span>
-                </a>)
-
       (create_pass_block parent, html, attrs).render
     end
   end