aspec_rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 741aaa4767d93c78ccd621de29c2190284e0d457
+  data.tar.gz: 93a60ac6decd924abb523f2c18ed2f204094b6d9
+SHA512:
+  metadata.gz: f2901681e83dc0898d7fb8906aec1b8a4487960f5a6eeaf60b838eb1e2b9a25913b1def89179ba5b54630f4037f679b9da16c586fdd76760296aca2308af6c6e
+  data.tar.gz: 3f350489c1ad995e031c9f64a596cd552ecc6960961e7e9da6f787f749d566cd3a11b1d1b7a7d2158a5988dbe0db67bb0e83e513dd5e3eb6b3a707cf096e2a6b

data/.gitignore

@@ -0,0 +1,3 @@
+.idea/
+.DS_Store
+pkg/

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

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    aspec_rb (0.0.1)
+      asciidoctor (>= 1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    asciidoctor (1.5.6.1)
+    power_assert (1.1.1)
+    rake (12.3.0)
+    test-unit (3.2.7)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aspec_rb!
+  bundler (>= 1.15.4)
+  rake (>= 12.1.0)
+  test-unit (>= 3.2.6)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,40 @@
+# aspec_rb
+
+[![Build Status](https://travis-ci.org/bsmith-n4/aspec_rb.svg?branch=master)](https://travis-ci.org/bsmith-n4/aspec_rb)
+
+## Installation
+
+```
+gem install aspec_rb
+```
+
+## Usage 
+
+```
+asciidoctor -r aspec_rb index.adoc
+```
+
+## Development
+
+To build a local copy of the gem to the `pkg` directory:
+
+```
+rake build
+``` 
+
+To install from a local build:
+
+```
+gem install pkg/aspec_rb<version>.gem 
+```
+
+To release a new version, edit the version number in `lib/aspec_rb/version.rb`, run bundle install to regenerate the `Gemfile.lock`.
+To release this version, use `rake release` command, providing all has been committed. This command builds the gem to the pkg directory in preparation for a push to Rubygems.org.
+
+### Testing
+
+Tests can be run using rake:
+
+```
+rake test
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'test/unit'
+
+task default: :test
+
+task :test do
+  ruby 'test/suite.rb'
+end
+
+task :rubocop do
+  sh 'rubocop'
+  sh 'htmlproofer test'
+end

data/aspec_rb.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aspec_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aspec_rb'
+  spec.version       = AspecRb::VERSION
+  spec.authors       = ['bsmith-n4']
+  spec.email         = ['brian.smith@numberfour.eu']
+
+  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/aspec_rb'
+  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|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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'
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'aspec_rb'
+
+require 'irb'
+IRB.start(__FILE__)
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aspec_rb/version.rb

@@ -0,0 +1,6 @@
+# Use this to set global versioning for the RubyGem
+module AspecRb
+  # After updating the version, publishing can be done by running
+  # rake release in the project root
+  VERSION = '0.0.1'.freeze
+end

data/lib/aspec_rb.rb

@@ -0,0 +1,14 @@
+require_relative 'extensions/autoxrefs'
+require_relative 'extensions/definition_block'
+require_relative 'extensions/inline_callout_macro'
+require_relative 'extensions/inline_cwiki_macro'
+require_relative 'extensions/inline_repo_macro'
+require_relative 'extensions/inline_task_macro'
+require_relative 'extensions/req_refs'
+require_relative 'extensions/requirement_block'
+require_relative 'extensions/todo_block'
+require_relative 'html_chunker'
+require 'asciidoctor-latex'
+require 'asciidoctor-bibtex'
+require_relative 'extensions/requirement_appendix'
+require_relative 'extensions/postprocessor'

data/lib/extensions/autoxrefs.rb

@@ -0,0 +1,183 @@
+require 'asciidoctor/extensions'
+require_relative 'utils/scanner'
+
+include ::Asciidoctor
+
+# Read from config file - do NOT hard code the srcdir
+$srcdir = 'chapters'
+invoc = Dir.pwd
+
+AnchorRx = /\[\[(?:|([\w+?_:][\w+?:.-]*)(?:, *(.+))?)\]\]/
+
+indexincludes, ni_includes, includes, doclinks, anchorfixes, intrachapter, interchapter, anchors, xrefs = Array.new(10) { [] }
+
+adoc_files = Dir.glob("#{$srcdir}/**/*.adoc")
+
+# From the index, create an array of the main chapters
+File.read('index.adoc').each_line do |li|
+  if li[IncludeDirectiveRx]
+    doc = li.match(/(?<=^include::).+?\.adoc(?=\[\])/).to_s
+    doc = doc.sub(/^\{find\}/, '')
+    indexincludes.push(doc) unless doc == 'config'
+  end
+end
+
+adoc_files.each do |filename|
+  main = false
+  path = Sform.trim(filename)
+  chapter = path.match(/.+?(?=\/)/).to_s
+
+  # Add a switch if the current document is an include within the index.adoc
+  indexincludes.each do |inc|
+    main = true if inc == filename
+  end
+
+  File.read(filename).each_line do |li|
+    h1 = false
+
+    if li[/\<\<(?!Req)(.+?)\>\>/]
+      # Handle multiple cross refs per line
+      li.scan(/(?=\<\<(?!Req)(.+?)\>\>)/) do |xref|
+        text = ''
+        target = ''
+        xref = xref[0].to_s
+        target = xref.gsub(/\s/, '-')
+
+        if xref[/,/]
+          target = xref.gsub(/,.+/, '')
+          text = xref.gsub(/.+,/, '').lstrip
+          xref = xref.sub(/,.+/, '')
+        else
+          text = Sform.titleify(xref).strip
+        end
+        xrefs.push([xref, path, filename, text, target, chapter])
+      end
+
+    elsif li[/^(\=+\s+?\S+.+)/]
+      h1 = true if li[/^=\s+?\S+.+/]
+      title = li.chop.match(/(?!=+\s)(\S+.+?)$/i).captures[0].strip
+      title.sub!(/\.(?=\w+?)/, '') if title[/\.(?=\w+?)/]
+      link = Sform.underscorify(title)
+      anchors.push([title, path, filename, link, chapter, main, h1])
+
+    # Handle images separately
+    elsif li[/^(\.\S\w+)/]
+      title = li.chop.match(/(?!=+\s)(\S+.+?)$/i).captures[0].strip
+      title.sub!(/\.(?=\w+?)/, '') if title[/\.(?=\w+?)/]
+      anchors.push([title, path, filename, title, chapter, main, h1])
+
+    elsif li[/\[\[(?:|([\w+?_:][\w+?:.-]*)(?:, *(.+))?)\]\]/]
+      anchor = li.chop.match(/(?<=\[\[).+?(?=\]\])/).to_s
+
+      if anchor[/,/]
+        anchor = anchor.match(/(?<=\[\[)(?:|[\w+?_:][\w+?:.-]*)(?=,.+?\]\])/).to_s
+        text = anchor.sub(/.+?,/, '')
+        text = text.sub(/\]\]$/, '')
+      else
+        text = anchor
+      end
+
+      anchors.push([anchor, path, filename, text, chapter, main, h1, true])
+
+    # Match for sub includes
+    elsif li[IncludeDirectiveRx]
+      child = li.match(/(?<=^include::).+?\.adoc(?=\[\])/).to_s
+      child = child.sub(/^\{find\}/, '')
+      childpath = "#{filename.sub(/[^\/]+?\.adoc/, '')}#{child}"
+      includes.push([filename, child, childpath])
+
+    end
+  end
+end
+
+# Create array of non-indexed includes
+adoc_files.each do |filename|
+  includes.each do |parent, child, childpath|
+    next unless childpath == filename
+    ni_includes.push([parent, child, filename])
+  end
+end
+
+# For each main include, store a target link
+anchors.each do |_anchor, full, _filename, link, chapter, main, h1|
+  next unless main && h1
+  doc = full.gsub(/^#{chapter}\//, '')
+  doclinks.push([doc, link, chapter])
+end
+
+# If a section title has an overriding anchor on the previous line, perform the following fix
+o_anchors = []
+doclinks.delete_if do |doc, _link, mchapter|
+  topleveldoc = "#{$srcdir}/#{mchapter}/#{doc}.adoc"
+  lines = File.foreach(topleveldoc).first(10).join
+  next unless lines[/(?x)\[\[.+?\]\]\n=\s{1,}.+$/]
+  overriding_anchor = lines.match(/(?x)\[\[(.+?)\]\]\n=\s{1,}.+$/).captures[0].to_s
+  o_anchors.push([doc, overriding_anchor, mchapter])
+  true
+end
+
+doclinks += o_anchors
+doclinks.uniq!
+
+# Edit the array of Anchors to point to the parent document *if* it is included.
+# TODO use a while loop, repeat until no changes made
+tempanchors = []
+3.times do
+  tempanchors.clear
+
+  # Loop through all includes, if the anchor is contained in an include,
+  # edit the anchors array to point to its parent instead
+  includes.each do |parent, _child, childpath|
+    anchors.delete_if do |anchor, path, filename, text, chapter, main, _h1|
+      next unless Sform.trim(childpath) == Sform.trim(filename)
+      tempanchors.push([anchor, path, Sform.trim(parent), text, chapter, main])
+      true
+    end
+  end
+
+  anchors += tempanchors
+  anchors.uniq!
+end
+
+tempanchors.clear
+
+anchors.delete_if do |anchor, apath, trim_parent, parent, amain, achapter|
+  doclinks.each do |doc, link, dchapter|
+    next unless apath == "#{dchapter}/#{doc}" || trim_parent == "#{dchapter}/#{doc}"
+    tempanchors.push([anchor, apath, link, parent, amain, achapter])
+    true
+  end
+end
+
+anchors += tempanchors
+anchors.uniq!
+
+# For all requirements, check which chapter they should finally be in with includes catered for
+# match with a main document name - should be a main chapter title
+xrefs.each do |xref, xpath, _xfilename, xtext, _xtarget, _xchapter|
+  anchors.each do |anchor, apath, afilename, atext, _achapter, _amain, _h1|
+    next unless xref == anchor
+    # if in same chapter, dont link to other HTML file
+    afilename = '' if xpath == apath
+    xtext = Sform.titleify(xref) if xtext.empty?
+    afilename.sub!(/^_/, '') if afilename[/^_/]
+    fix = "#{afilename}##{atext},#{xtext}"
+    anchorfixes.push([anchor, fix, xref])
+  end
+end
+
+Extensions.register do
+  preprocessor do
+    process do |_document, reader|
+      Reader.new reader.readlines.map { |line|
+        if line[/\<\<(?!Req)(.+?)\>\>/]
+          anchorfixes.each do |original, fix|
+            next unless line[/\<\<#{original}(,.+?)?\>\>/]
+            line = line.sub(/\<\<#{original}(,.+?)?\>\>/, "icon:angle-double-up[] <<#{fix}>>")
+          end
+        end
+        line
+      }
+    end
+  end
+end

data/lib/extensions/definition_block.rb

@@ -0,0 +1,49 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+
+include ::Asciidoctor
+
+Extensions.register do
+  block do
+    named :def
+    on_contexts :open, :paragraph, :example, :listing, :sidebar, :pass
+
+    process do |parent, reader, attrs|
+      # Add pass characters here to prevent html character replacements for < > tags
+      pass = '+++'
+      attrs['name'] = 'definition'
+      attrs['caption'] = 'Definition: '
+      nl = ''
+
+      begin
+        # downcase the title and replace spaces with underscores.
+        #    Also replacing special HTML entities:
+        #    &quot; = "
+        #    &amp;  = &
+        downcased_title = attrs['title'].downcase.tr(' ', '_').gsub('"', '&quot;')
+        san_title = attrs['title'].gsub(/&/, '&amp;').delete('`').delete("'").delete('*')
+      rescue Exception => msg
+        puts msg
+        # If no title exists on the Def block, throw an exception
+        puts '[ERROR] Definition block title missing'
+      end
+
+      alt = %(
+<div class=\"panel panel-primary\">
+<div class=\"panel-heading\">
+<h3 class=\"panel-title\">
+<a class=\"anchor\" href=\"##{san_title}\"></a>
+<a class=\"link\" href=\"##{san_title}\"><emphasis role=\"strong\">Definition: </emphasis> #{san_title} </a>
+</h3>
+</div>
+<div class=\"panel-body\">)
+
+      close = '</div></div>'
+
+      # concatenate all generated lines and prepend before the original content
+      concat_lines = reader.lines.unshift(pass, alt, pass, nl)
+      concat_lines.push(nl, pass, close, pass)
+
+      create_block parent, :open, concat_lines, attrs, content_model: :compound
+    end
+  end
+end

data/lib/extensions/inline_callout_macro.rb

@@ -0,0 +1,14 @@
+require 'asciidoctor/extensions'
+
+include ::Asciidoctor
+
+# @example Basic Usage
+#   See call:1[] for details
+Asciidoctor::Extensions.register do
+  inline_macro do
+    named :call
+    process do |parent, target, _attrs|
+      Asciidoctor::Inline.new(parent, :callout, target.to_i).convert
+    end
+  end
+end

data/lib/extensions/inline_cwiki_macro.rb

@@ -0,0 +1,31 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require_relative 'utils/labels'
+require_relative 'utils/block'
+
+include ::Asciidoctor
+
+# @example Basic Usage
+#   See cwiki:topic[] for details
+# @example Block Use
+#   Already documented. cwiki::topic[]
+Extensions.register do
+  inline_macro do
+    named :cwiki
+
+    process do |parent, target, attrs|
+      pattern = parent.document.attr 'cwiki-pattern'
+
+      if pattern.nil?
+        warn "asciidoctor: WARNING: Attribue 'cwiki-pattern' for inline repo macro not defined"
+        pattern = 'unknown'
+        label = 'warning'
+        target = 'cwiki-pattern missing'
+      else
+        label = Labels.getstatus(attrs)
+      end
+
+      html = Context.format(attrs, target, pattern, label)
+      (create_pass_block parent, html, attrs).render
+    end
+  end
+end

data/lib/extensions/inline_repo_macro.rb

@@ -0,0 +1,96 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+
+include ::Asciidoctor
+
+# Link to a file on GitHub.
+#
+# repo:<repository>:<file>:<line>[]
+#
+# The target should be set using document attributes prefixed by 'repo_'.
+#
+# @example Attribute configuration
+#   :repo_dockerfiles: www.github.com/exampleuser/dockerfiles/issues
+# @example Simple Use
+#   repo:dockerfiles:ansible/Dockerfile_template[]
+# @example Link to repo and line number
+#   repo:dockerfiles:ansible/Dockerfile_template:2[]
+# @example Link to repo, branch and line number
+#   repo:dockerfiles:ansible/Dockerfile_template:5[branch="AS_v0.0.10"]
+# @example Link to repo and line number (alternate use)
+#   repo:dockerfiles:ansible/Dockerfile_template[line="5",branch="AS_v0.0.10"]
+Extensions.register do
+  inline_macro 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
+
+      repo = target.match(/^.+?(?=:)/).to_s
+      file = target.match(/(?<=:).+/).to_s
+
+      text = file
+      text = file.gsub(%r{/.+\//}, '') if file[%r{/\//}]
+
+      if target[/(?<=:)\d+$/]
+        line = "#L#{target.match(/(?<=:)\d+?$/)}"
+        file = file.sub(/:\d+$/, '')
+      elsif attrs['line']
+        line = "#L#{attrs['line']}"
+      else
+        line = ''
+      end
+
+      if attrs['branch']
+        branch = "tree/#{attrs['branch']}"
+        text = "#{text} (#{branch})"
+        label = 'warning'
+      else
+        branch = 'blob/master'
+        label = 'info'
+      end
+
+      text = attrs['title'].to_s if attrs['title']
+      text.gsub!(/:(?=\d+$)/, ' line ') if text[/(?<=:)\d+$/]
+
+      parent.document.attributes.each do |key, value|
+        next unless key[/^repo_/]
+        pattern = key.sub(/^repo_/, '')
+        arr.push(pattern)
+        formattedurl = "#{value}/#{branch}/#{file}#{line}" if repo == pattern
+      end
+
+      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
+
+      (create_pass_block parent, html, attrs).render
+    end
+  end
+end

data/lib/extensions/inline_task_macro.rb

@@ -0,0 +1,47 @@
+require 'asciidoctor/extensions'
+require_relative 'utils/labels'
+require_relative 'utils/block'
+
+include ::Asciidoctor
+
+prefix = ''
+
+# @example Basic Usage
+#   See task:101[] for details
+# @example Block Use
+#   Already completed. task::101[]
+# @example Configuration
+# :task_def_OPR-: Jira;OPR Backlog;https://jira.myorg.eu/browse/OPR-{TASK_ID};images/icons/jira.png;OPR-{TASK_ID}
+# :task_def_GH-: GitHub;Project GitHub Issues;https://github.organisation.com/MyOrg/repo/issues
+Extensions.register do
+  inline_macro do
+    named :task
+
+    process do |parent, target, attrs|
+      pa = ''
+      dest = target.match(/\w+-/).to_s.downcase if target[/-/]
+      pattern = parent.document.attr 'task-pattern'
+
+      parent.document.attributes.each do |key, value|
+        next unless key[/^task_def_/]
+        prefix = key.sub(/^task_def_/, '')
+        if dest == prefix
+          type, tip, patt, icon, id = value.match(/^([^^]+)\;([^^]+)\;([^^]+)\;([^^]+)\;([^^]+)/).captures
+          patt.gsub!(/\/(\w+?-)?{.+?}/, '')
+          pattern = patt
+        end
+      end
+
+      if pattern.nil?
+        warn "asciidoctor: WARNING: Task pattern not defined for #{target.delete(':')}"
+        pattern = 'unknown'
+      end
+
+      url = pattern % target
+
+      label = Labels.getstatus(attrs)
+      html = Context.format(attrs, target, url, label)
+      (create_pass_block parent, html, attrs).render
+    end
+  end
+end

data/lib/extensions/postprocessor.rb

@@ -0,0 +1,18 @@
+require 'asciidoctor/extensions'
+
+include ::Asciidoctor
+
+jquery = '<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>'
+lt_gt = '(&gt;&gt;|&lt;&lt;)'
+
+Extensions.register do
+  postprocessor do
+    process do |_document, output|
+      # asciidoctor-latex injects an old version of jquery, causing conflicts,
+      # see https://github.com/asciidoctor/asciidoctor-latex/blob/master/lib/asciidoctor/latex/inject_html.rb#L28
+      output = output.sub(/#{jquery}/, '') if output[/#{jquery}/]
+      # Remove angle brackets, add scrollspy for bootstrap, target nav.toc
+      output.gsub(/#{lt_gt}/, '').sub(/<body class="book">/, '<body data-spy="scroll" data-target="#toc">')
+    end
+  end
+end