jekyll_aspec 1.0.1 → 1.0.2

data/lib/extensions/inline_task_macro.rb

@@ -14,9 +14,9 @@ Extensions.register do
 
     process do |parent, target, attrs|
       pattern = parent.document.attr 'task-pattern'
-      if pattern.nil? 
+      if pattern.nil?
         warn "asciidoctor: WARNING: Attribue 'task-pattern' for inline task macro not defined"
-        pattern = "unknown"
+        pattern = 'unknown'
       end
       url = pattern % target
 

data/lib/extensions/replace_regex.rb

@@ -1,8 +1,5 @@
-# Used by Jekyll during conversion
 module Jekyll
-  # A Liquid Template Filter for using regular expressions
   module RegexFilter
-    # Simple replacement
     def replace_regex(input, regex_string, replace_string)
       regex = Regexp.new regex_string
       input.gsub regex, replace_string

data/lib/extensions/req_refs.rb

@@ -2,30 +2,21 @@ require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 include ::Asciidoctor
 
-# @todo check if all code before the macro can be moved into util directory as helper methods
-
-# @todo Don't do this
+# Find all Adoc Files
 adoc_files = Dir.glob('**/*.adoc')
-# @todo Retrieve these via document attributes, should not be hardcoded
-docsdir = '_docs'
-exts = '(\.adoc|\.md|\.html)'
-
+exts = "(\.adoc|\.md|\.html)"
+# make some empty vars globally available
 rpath = nil
 rtext = nil
-orphan = false
-
 reqs = []
 inc_reqs = []
-com_reqs = []
 incs = []
 xrefs = []
-
 xref_base = ''
 
-blockrx = %r{^\/{4,}$}
-linerx = %r{^//(?=[^/]|$)}
+# Retrieve this via document attribute
+docsdir = '_docs'
 
-# @todo called helper method here
 def trim(s)
   s.gsub!(/_docs\//, '')
   s.gsub!(/(\.adoc|\.md|\.html)/, '')
@@ -38,8 +29,6 @@ adoc_files.each do |file_name|
   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]
@@ -50,9 +39,7 @@ adoc_files.each do |file_name|
       path = path.sub!(/#{exts}/, '')
       item = [rid, li.chop, path, file_name, lc]
 
-      if commented || incommentblock
-        com_reqs.push item
-      elsif inc
+      if inc
         inc_reqs.push item
       else
         reqs.push item
@@ -94,52 +81,50 @@ end
 # Sort (in-place) by numberic ID
 reqs.sort_by!(&:first)
 
-# @todo convert to formal 
+# Preprocessor that strips the << tags - NOTE: may break conversion if line ends with >>
+Extensions.register do
+  preprocessor do
+    process do |_document, reader|
+      Reader.new reader.readlines.map { |li|
+        if li[/\<\<Req-.+?\>\>/]
+          openb = li.match(/(\<\<)Req-.+?\>\>/).captures[0]
+          closeb = li.match(/\<\<Req-.+?(\>\>)/).captures[0]
+          li.gsub!(/#{openb}/, ' ')
+          li.gsub!(/#{closeb}/, ' ')
+        else
+          li
+        end
+      }
+    end
+  end
+end
+
 Extensions.register do
   inline_macro do
-    named :requirement_autoxref
+    named :reqlink
 
     # Regex-based, will match "See Req-ROPR-123 for..."
-    # Will also match <<Req-ROPR-123>>
-    # @todo this is a heavy-handed approach to matching all 
-    # xrefs. Find a better way to autolink xrefs that doesn't involved the
-    # use of the req-preprocessor
     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
+        next unless id == t
+        rpath = path
+        rtext = text.gsub(/\A\[req,id=/, '')
+        rtext = rtext.gsub(/,version=\d\]$/, '')
+        break
       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\">'
+      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
+      (create_anchor parent, %(#{o} Req. #{rtext} #{c}), type: :link, target: uri).convert
     end
   end
 end

data/lib/extensions/requirement_appendix.rb

@@ -0,0 +1,116 @@
+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.sort!
+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

@@ -1,56 +1,51 @@
-require "asciidoctor/extensions" unless RUBY_ENGINE == "opal"
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 include ::Asciidoctor
 
-# @example Delimited Requirement Block with Title
-#   .My Requirement
-#   [req,id=RA-1,version=1]
-#   --
-#   Contents of the requirement
-#   --
-class RequirementBlock < Extensions::BlockProcessor
-  use_dsl
-  named :req
-  on_contexts :open, :paragraph, :example, :listing, :sidebar, :pass
-  name_positional_attributes "number", "version"
-
-  # Read the parent attributes and create a Requirement Admonition block
-  def process 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.
-      # @todo use utility methods here?
-      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
-      warn %(asciidoctor: WARNING: Requirement block title missing)
+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
-
-    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)
-
-    # @todo use a regular pass block in this instance
-    create_block parent, :admonition, concat_lines, attrs, content_model: :compound
   end
 end

data/lib/extensions/todo_block.rb

@@ -1,22 +1,16 @@
-require "asciidoctor/extensions" unless RUBY_ENGINE == "opal"
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 include ::Asciidoctor
 
-# @example A delimited TODO block
-#   [TODO]
-#   --
-#   Don't Forget!
-#   --
-class TodoBlock < Extensions::BlockProcessor
-  use_dsl
-  named :TODO
-  on_contexts :open, :paragraph, :example, :listing, :sidebar, :pass
+Extensions.register do
+  block do
+    named :TODO
+    on_contexts :open, :paragraph, :example, :listing, :sidebar, :pass
 
-  # Read the parent attributes and create a TODO 
-  # admonition block
-  def process parent, reader, attrs
-    attrs['name'] = 'todo'
-    attrs['caption'] = 'Todo'
-    create_block parent, :admonition, reader.lines, attrs, content_model: :compound
+    process do |parent, reader, attrs|
+      attrs['name'] = 'todo'
+      attrs['caption'] = 'Todo'
+      create_block parent, :admonition, reader.lines, attrs, content_model: :compound
+    end
   end
 end

data/lib/extensions/utils/block.rb

@@ -4,23 +4,33 @@
 module Context
   # @param attributes [Array] attributes passed by the inline macro
   # @param target [String] the target text
-  # @param url [String] the target url
+  # @param pattern [String] the target url
   # @param label [String] an optional status label, used to display if a task/issue is open or closed
-  # @return [String] the raw HTML to be included in the target document 
-  def self.format(attributes, target, url, label)
+  # @return [String] the raw HTML to be included in the target document
+  def self.format(attributes, target, pattern, label)
     block = false
-    block = true if attributes.key? "block"
+    block = true if attributes.key? 'block'
 
     if target[0] == "\:"
       block = true
-      target[0] = ""
+      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
+    url = "#{pattern}/#{target}"
+
+    html = if block
+             if pattern == 'unknown'
+               "<div style=\"float:right;padding-left:0.1em;\"><span class=\"label label-#{label}\" data-toggle=\"tooltip\" title=\"Missing config\">#{target}</span></div>"
+             else
+               "<div style=\"float:right;padding-left:0.1em;\"><a href=\"#{url}\"><span class=\"label label-#{label}\">#{target}</span></a></div>"
+                    end
+           else
+             if pattern == 'unknown'
+               "<span class=\"label label-#{label}\" data-toggle=\"tooltip\" title=\"Missing config\">#{target}</span>"
+             else
+               "<a href=\"#{url}\"><span class=\"label label-#{label}\">#{target}</span></a>"
+                    end
+           end
+    html
   end
 end