jekyll_aspec 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01f45e1bf4e7cac463fa045dab24998acf30bf0d
+  data.tar.gz: 011c516de7e397f5d4f55b70edacbb2a0214cdf0
+SHA512:
+  metadata.gz: 417e6fc6ba196a25f75a318ac2b4ea889481fdbf325472b5513bd4e28cfb6d94afc04e1c2bbc268856b1d1160a44bf8e1fe54f723be342bfa27be9b2717ba6f4
+  data.tar.gz: 6bb4fd91bfd8a420b5c83d00911c7ae51e97513cc46b3ab2bae45887049e4257ac66aa852d4a96f62d9d5667f90c66a36405980f48fb68a3ae56674ae0161d8c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**/*.html

data/.travis.yml

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

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 jekyll-aspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    jekyll_aspec (0.0.1.pre)
+      asciidoctor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    asciidoctor (1.5.6.1)
+    power_assert (1.0.2)
+    rake (10.5.0)
+    test-unit (3.2.4)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jekyll_aspec!
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 bsmith-n4
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# 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 with Jekyll. 
+
+These extensions add custom blocks for Requirements, Definitions and inter-document auto-linking functionality for these blocks.
+
+## Installation
+
+Add `jekyll_aspec` to your Jekyll Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-asciidoc'
+  gem 'jekyll_aspec'
+end
+```
+
+Or install it yourself as:
+
+    $ gem install jekyll_aspec
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bsmith-n4/jekyll_aspec.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'test/unit'
+
+task :default => :test
+
+task :test do
+  ruby "test/suite.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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/jekyll_aspec.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll_aspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_aspec"
+  spec.version       = JekyllAspec::VERSION
+  spec.authors       = ["bsmith-n4"]
+  spec.email         = ["brian.smith@numberfour.eu"]
+
+  spec.summary       = %q{Asciidoctor extensions for use as a Jekyll plugin}
+  spec.homepage      = "https://github.com/bsmith-n4/jekyll_aspec"
+  spec.license       = "MIT"
+
+  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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_runtime_dependency "asciidoctor"
+end

data/lib/extensions/autoxrefs.rb

@@ -0,0 +1,156 @@
+require 'asciidoctor/extensions'
+require 'pathname'
+
+include ::Asciidoctor
+
+# 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[/\[\[.+?\]\]/]
+
+      # 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
+    tpath = 'index' if tpath.to_s.empty?
+    # If the paths are not the same (xref and title not the same document) do the following
+    next unless tpath != xpath
+
+    # 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
+
+      # 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}\//, '')
+        trim(docfile)
+
+        next unless docfile.to_s == xfile
+
+        # calculate the relative path between source and target
+        first = Pathname.new xfile.to_s
+        second = Pathname.new tfile.to_s
+        relpath = second.relative_path_from first
+
+        relpath = relpath.sub(/^\.\.\//, '') if docfile == 'index'
+        fix = "#{relpath}/index##{xtform},#{xtext}"
+        fixes.push fix
+      end
+
+      Reader.new reader.readlines.map { |li|
+        # If the line contains an xref (not to requirements)
+        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}/]
+                t = xref if xtext.to_s.empty?
+                replacement = li.sub(/\<\<#{xref}(,.+)?\>\>/, "icon:expand[] <<#{x}#{t}>> ")
+              end
+            end
+            i += 1
+          end
+
+        else
+          replacement = ''
+        end
+
+        if replacement.to_s.empty?
+          li
+        else
+          replacement
+        end
+      }
+    end # each document
+  end
+end

data/lib/extensions/html_postprocessor.rb

@@ -0,0 +1,12 @@
+require 'asciidoctor/extensions'
+
+include ::Asciidoctor
+
+Extensions.register do
+  postprocessor do
+    process do |document, output|
+      output = output.gsub(/<\/p>/, '')
+      output
+    end
+  end
+end

data/lib/extensions/inline_callout_macro.rb

@@ -0,0 +1,12 @@
+require 'asciidoctor/extensions'
+
+include ::Asciidoctor
+
+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,22 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require_relative 'utils/labels'
+require_relative 'utils/block'
+
+include ::Asciidoctor
+
+Extensions.register do
+  inline_macro do
+    named :cwiki
+
+    process do |parent, target, attrs|
+      pattern =
+        (parent.document.attr 'cwiki-pattern') ||
+        'https://confluence.numberfour.eu/display/%s'
+      url = pattern % target
+
+      label = Labels.getstatus(attrs)
+      html = Context.form(attrs, target, url, label)
+      (create_pass_block parent, html, attrs).render
+    end
+  end
+end

data/lib/extensions/inline_repo_macro.rb

@@ -0,0 +1,80 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+
+include ::Asciidoctor
+
+# Link to a file on GitHub.
+#
+# repo:<repository>:<file>:<line>[]
+#
+#   Examples:
+#
+#   repo:dockerfiles:ansible/Dockerfile_template[]
+#   repo:dockerfiles:ansible/Dockerfile_template:2[]
+#   repo:dockerfiles:ansible/Dockerfile_template:5[branch="AS_v0.0.10"]
+#   repo:dockerfiles:ansible/Dockerfile_template[line="5",branch="AS_v0.0.10"]
+#
+
+url = ''
+file = ''
+line = ''
+formattedurl = ''
+text = ''
+
+Extensions.register do
+  inline_macro do
+    named :repo
+
+    process do |parent, target, attrs|
+      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_/, '')
+        if repo == pattern
+          formattedurl = "#{value}/#{branch}/#{file}#{line}"
+        else
+          url = ''
+        end
+      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
+end

data/lib/extensions/inline_task_macro.rb

@@ -0,0 +1,22 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require_relative 'utils/labels'
+require_relative 'utils/block'
+
+include ::Asciidoctor
+
+Extensions.register do
+  inline_macro do
+    named :task
+
+    process do |parent, target, attrs|
+      pattern =
+        (parent.document.attr 'task-pattern') ||
+        'https://jira.numberfour.eu/browse/%s'
+      url = pattern % target
+      # Some utility functions used by similar inline macros
+      label = Labels.getstatus(attrs)
+      html = Context.form(attrs, target, url, label)
+      (create_pass_block parent, html, attrs).render
+    end
+  end
+end

data/lib/extensions/replace_regex.rb

@@ -0,0 +1,11 @@
+module Jekyll
+  # A Liquid Template Filter for using regular expressions
+  module RegexFilter
+    def replace_regex(input, regex_string, replace_string)
+      regex = Regexp.new regex_string
+      input.gsub regex, replace_string
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::RegexFilter)

data/lib/extensions/req_preprocessor.rb

@@ -0,0 +1,22 @@
+require 'asciidoctor/extensions'
+
+include ::Asciidoctor
+# Preprocessor that strips the << tags
+# FIXME: may break conversion if line ends with >>
+
+req = '<<req-'
+brackets = /<<|>>/
+repl = ''
+
+Extensions.register do
+  preprocessor do
+    process do |_document, reader|
+      return reader if reader.eof?
+      replacement_lines = reader.read_lines.map do |line|
+        (line.include? req) ? (line.grepl brackets, repl) : line
+      end
+      reader.unshift_lines replacement_lines
+      reader
+    end
+  end
+end

data/lib/extensions/req_refs.rb

@@ -0,0 +1,136 @@
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+
+include ::Asciidoctor
+
+adoc_files = Dir.glob('**/*.adoc')
+exts = '(\.adoc|\.md|\.html)'
+
+rpath = nil
+rtext = nil
+reqs = []
+inc_reqs = []
+com_reqs = []
+incs = []
+xrefs = []
+xref_base = ''
+
+blockrx = %r(^\/{4,}$)
+linerx = %r{^//(?=[^/]|$)}
+
+orphan = false
+
+# Retrieve this via document attribute
+docsdir = '_docs'
+
+def trim(s)
+  s.gsub!(/_docs\//, '')
+  s.gsub!(/(\.adoc|\.md|\.html)/, '')
+end
+
+adoc_files.each do |file_name|
+  lc = 0
+  inc = false
+
+  File.read(file_name).each_line do |li|
+    lc += 1
+
+    incommentblock ^= true if li[blockrx]
+    commented = true if li[linerx]
+    inc = true if li[/published: false/]
+
+    # Match Requirement Blocks [req,ABC-123,version=n]
+    if li[/\[\s*req\s*,\s*id\s*=\s*(\w+-?[0-9]+)\s*,.*/]
+
+      rid = li.chop.match(/id\s*=\s*\w+-?([0-9]+)/i).captures[0]
+      path = file_name.sub(/^#{docsdir}\//, '')
+      path = path.sub!(/#{exts}/, '')
+      item = [rid, li.chop, path, file_name, lc]
+
+      if commented || incommentblock
+        com_reqs.push item
+      elsif inc
+        inc_reqs.push item
+      else
+        reqs.push item
+      end
+
+    # Match all <<xrefs>>
+    elsif li[/\<\<\S.+?(\,\S)?\>\>/]
+
+      xref = li.chop.match(/\<\<(\S.+?)(\,\S)?\>\>/i).captures[0]
+      path = file_name.sub(/^#{docsdir}\//, '')
+      path = path.sub!(/#{exts}/, '')
+      item = [xref, path, file_name, lc]
+      xrefs.push item
+
+    # Collect all includes
+    elsif li[/^include::.+.adoc\[\]/]
+
+      inc_file = li.chop.match(/(?<=^include::).+.adoc(?=\[\])/i).to_s
+      path = inc_file.sub(/^#{docsdir}\//, '')
+      path = path.sub(/#{exts}/, '')
+      parent = file_name
+      item = [inc_file, path, parent, lc]
+      incs.push item
+
+    end
+  end
+end
+
+# Sort included reqs and correct the path to the include parent
+inc_reqs.each do |rid, rli, rpath, _rfile, _rline|
+  incs.each do |incfile, incpath, parent, lc|
+    next unless rpath == incpath
+    trim(parent)
+    item = [rid, rli, parent, incfile, lc]
+    reqs.push item
+  end
+end
+
+# Sort (in-place) by numberic ID
+reqs.sort_by!(&:first)
+
+Extensions.register do
+  inline_macro do
+    named :requirement_autoxref
+
+    # Regex-based, will match "See Req-ROPR-123 for..."
+    match /(Req-\w+-?\d+)/
+
+    # match id with  Req-\w+-?(\d+)
+    process do |parent, target|
+      t = target.sub(/^Req-\w+-?/, '')
+
+      orphan = true if reqs.empty?
+
+      reqs.each do |id, text, path, _file_name, _line|
+        orphan = false
+
+        if id == t
+          rpath = path
+          rtext = text.gsub(/\A\[req,id=/, '')
+          rtext = rtext.gsub(/,version=\d\]$/, '')
+          break
+        else
+          orphan = true
+        end
+      end
+
+      link = target.sub(/^Req-/, '')
+      xref_base = (parent.document.attr 'xref-base')
+      uri = "#{xref_base}/#{rpath}/index.html##{link}"
+      o = ' <span class=\"label label-info\">'
+      c = ' </span>'
+
+      if orphan
+        # docfile = parent.document.attr 'docname'
+        # warn %(asciidoctor: WARNING: #{name || node.node_name} orphaned #{target} in #{docfile})
+        (create_pass_block parent, %(<strong>#{target}</strong>), {},
+                           content_model: :raw).convert
+      else
+        (create_anchor parent, %(#{o} Req. #{rtext} #{c}),
+                       type: :link, target: uri).convert
+      end
+    end
+  end
+end

data/lib/extensions/requirement_appendix.rb

@@ -0,0 +1,115 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+exts = "(\.adoc|\.md|\.html)"
+docsdir = '_docs'
+
+title = nil
+chapter = nil
+doctitle = nil
+
+reqs = []
+rows = []
+# For commented requirements
+coms = []
+
+# For includes
+inc_reqs = []
+incs = []
+
+CommentBlockRx = %r(^\/{4,}$)
+CommentLineRx = %r{^//(?=[^/]|$)}
+
+def trim(s)
+  s.gsub!(/_docs\//, '')
+  s.gsub!(/(\.adoc|\.md|\.html)/, '')
+end
+
+adoc_files = Dir.glob('**/*.adoc')
+adoc_files.each do |f|
+  inc = false
+  commented = false
+
+  File.read(f).each_line do |li|
+    incommentblock ^= true if li[CommentBlockRx]
+    commented = true if li[CommentLineRx]
+    inc = true if li[/published: false/]
+
+    doctitle = /(?<=title:\s).+/.match(li) if li[/^title:\s+\w.+/]
+    chapter = /(?<=chapter:\s).+/.match(li) if li[/^chapter:\s+\w.+/]
+
+    if li[/\[\s*req\s*,\s*id\s*=\s*\w+-?[0-9]+\s*,.*/]
+      title.sub!(/^\./, '')
+      req = [li.chop, f, title, chapter, doctitle]
+
+      if commented || incommentblock
+        coms.push(req)
+      elsif inc
+        inc_reqs.push(req)
+      else
+        reqs.push(req)
+      end
+
+    # Collect all includes
+    elsif li[/^include::.+.adoc\[\]/]
+
+      inc_file = li.chop.match(/(?<=^include::).+.adoc(?=\[\])/i).to_s
+      path = inc_file.sub(/^#{docsdir}\//, '')
+      path = path.sub(/#{exts}/, '')
+      parent = f
+      item = [inc_file, path, parent]
+      incs.push item
+
+    end
+    title = li
+  end
+end
+
+# Sort included reqs and correct the path to the parent (including doc)
+# Push this back into 'normal' requirements array for regular processing
+inc_reqs.each do |l, f, title, chapter, doctitle|
+  incs.each do |incfile, _incpath, parent|
+    if f == incfile
+      item = [l, parent, title, chapter, doctitle]
+      reqs.push item
+    end
+  end
+end
+
+reqs.uniq!
+
+i = 0
+reqs.each do |req, f, title, chapter, doctitle|
+  i += 1
+
+  id = /[^,]*\s*id\s*=\s*(\w+-?[0-9]+)\s*,.*/.match(req)[1]
+  version = /(?<=version=)\d+/.match(req)
+
+  f.gsub!(/^_docs\//, '')
+  f.gsub!(/.adoc$/, '')
+
+  link = "#{f}/index##{id}"
+  ref = "<a class=\"link\" href=\"#{link}\"><emphasis role=\"strong\">#{title}</emphasis>  </a>"
+  breadcrumb = "<a href=\"#{f}\">#{chapter} / #{doctitle}</a>"
+  row = "<tr> <th scope=\"row\">#{i}</th> <td>#{id}</td><td>#{version}</td> <td>#{ref}</td> <td>#{breadcrumb}</td> </tr>"
+
+  rows.push(row)
+end
+
+Asciidoctor::Extensions.register do
+  block_macro :requirements do
+    process do |parent, _target, _attrs|
+      content = %(<h2 id="requirements"><a class="anchor" href="#requirements"></a><a class="link" href="#requirements">Requirements</a></h2>
+      <div class="panel panel-default"> <div class="panel-heading"><h4>Requirements</h4></div>
+        <table class="table"> <thead> <tr>
+          <th>#</th> <th>ID</th><th>Version</th> <th>Title</th> <th>Document</th>
+        </tr> </thead>
+        <tbody>
+          #{rows.join}
+        </tbody>
+        </table> </div>)
+
+      create_pass_block parent, content, {}
+    end
+  end
+end

data/lib/extensions/requirement_block.rb

@@ -0,0 +1,51 @@
+require "asciidoctor/extensions" unless RUBY_ENGINE == "opal"
+
+include ::Asciidoctor
+
+Extensions.register do
+  block do
+    named :req
+    on_contexts :open, :paragraph, :example, :listing, :sidebar, :pass
+    name_positional_attributes "number", "version"
+
+    process do |parent, reader, attrs|
+      # Add pass characters here to prevent html character replacements for < > tags
+      pass = "+++"
+      attrs["name"] = "requirement"
+      attrs["caption"] = "Requirement: "
+      id = attrs["id"]
+      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;")
+      rescue Exception => msg
+        puts msg
+        # If no title exists on the Req block, throw an exception
+        puts "[ERROR] Requirement block title missing"
+      end
+
+      alt = %(
+      <div class=\"panel panel-primary\">
+        <div class=\"panel-heading\">
+          <h3 class=\"panel-title\">
+            <a class=\"anchor\" href=\"##{id}\"></a>
+            <a class=\"link\" href=\"##{id}\"><emphasis role=\"strong\">Requirement: #{id}:</emphasis> #{san_title} </a> (ver. #{attrs['version']})
+          </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, :admonition, concat_lines, attrs, content_model: :compound
+    end
+  end
+end

data/lib/extensions/todo_block.rb

@@ -0,0 +1,15 @@
+require "asciidoctor/extensions" unless RUBY_ENGINE == "opal"
+
+include ::Asciidoctor
+
+class TodoBlock < Extensions::BlockProcessor
+  use_dsl
+  named :TODO
+  on_contexts :open, :paragraph, :example, :listing, :sidebar, :pass
+
+  def process parent, reader, attrs
+    attrs['name'] = 'todo'
+    attrs['caption'] = 'Todo'
+    create_block parent, :admonition, reader.lines, attrs, content_model: :compound
+  end
+end

data/lib/extensions/utils/block.rb

@@ -0,0 +1,18 @@
+module Context
+  def self.form(attributes, target, url, label)
+    block = false
+    block = true if attributes.key? "block"
+
+    if target[0] == "\:"
+      block = true
+      target[0] = ""
+    end
+
+    if block
+      html = "<div style=\"float:right;padding-left:0.1em;\"><a href=\"#{url}\"><span class=\"label label-#{label}\">#{target}</span></a></div>"
+    else
+      html = "<a href=\"#{url}\"><span class=\"label label-#{label}\">#{target}</span></a>"
+    end
+    return html
+  end
+end

data/lib/extensions/utils/labels.rb

@@ -0,0 +1,13 @@
+module Labels
+  def self.getstatus(attrs)
+    status = attrs["status"]
+    if status == ("done" || "closed")
+      label = "success"
+    elsif status == "open"
+      label = "warning"
+    else
+      status = "unknown"
+      label = "default"
+    end
+  end
+end

data/lib/jekyll_aspec/version.rb

@@ -0,0 +1,3 @@
+module JekyllAspec
+  VERSION = "0.0.1.pre"
+end

data/lib/jekyll_aspec.rb

@@ -0,0 +1,17 @@
+require_relative "extensions/html_postprocessor"
+require_relative "extensions/autoxrefs"
+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_preprocessor"
+require_relative "extensions/req_refs"
+require_relative "extensions/requirement_appendix"
+require_relative "extensions/requirement_block"
+require_relative "extensions/todo_block"
+
+require "jekyll_aspec/version"
+
+Extensions.register do
+  block TodoBlock
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_aspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- bsmith-n4
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brian.smith@numberfour.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll_aspec.gemspec
+- lib/extensions/autoxrefs.rb
+- lib/extensions/html_postprocessor.rb
+- lib/extensions/inline_callout_macro.rb
+- lib/extensions/inline_cwiki_macro.rb
+- lib/extensions/inline_repo_macro.rb
+- lib/extensions/inline_task_macro.rb
+- lib/extensions/replace_regex.rb
+- lib/extensions/req_preprocessor.rb
+- lib/extensions/req_refs.rb
+- lib/extensions/requirement_appendix.rb
+- lib/extensions/requirement_block.rb
+- lib/extensions/todo_block.rb
+- lib/extensions/utils/block.rb
+- lib/extensions/utils/labels.rb
+- lib/jekyll_aspec.rb
+- lib/jekyll_aspec/version.rb
+homepage: https://github.com/bsmith-n4/jekyll_aspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Asciidoctor extensions for use as a Jekyll plugin
+test_files: []