jekyll_aspec 1.0.1 → 1.0.2

data/lib/extensions/utils/labels.rb

@@ -1,18 +1,18 @@
-# A simple helper method handles the status of the target text. 
-# This is used to display whether a GitHub issue or a Jira ticket 
+# A simple helper method handles the status of the target text.
+# This is used to display whether a GitHub issue or a Jira ticket
 # is open or closed etc.
 module Labels
   # @param attrs [Array] attributes passed by the inline macro
   # @return [String] the status and/or label to be displayed
   def self.getstatus(attrs)
-    status = attrs["status"]
-    if status == ("done" || "closed")
-      label = "success"
-    elsif status == "open"
-      label = "warning"
+    status = attrs['status']
+    if status == ('done' || 'closed')
+      label = 'success'
+    elsif status == 'open'
+      label = 'warning'
     else
-      status = "unknown"
-      label = "default"
+      status = 'unknown'
+      label = 'default'
     end
   end
 end

data/lib/jekyll_aspec.rb

@@ -1,20 +1,11 @@
-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_block"
-require_relative "extensions/requirement_block_macro"
-require_relative "extensions/todo_block"
-
-require "jekyll_aspec/version"
-
-# Load Asciidoctor extensions
-Extensions.register do
-  block TodoBlock
-  block RequirementBlock
-  block_macro RequirementBlockMacro
-end
+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_refs'
+require_relative 'extensions/requirement_block'
+require_relative 'extensions/requirement_appendix'
+require_relative 'extensions/todo_block'
+require_relative 'jekyll_aspec/version'

data/lib/jekyll_aspec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_aspec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - bsmith-n4
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,11 +66,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-description: "This plugin is a group of Asciidoctor extensions that perform directory
-  walking, \n                          resolving the location of titles and anchors
-  in all adoc files so that inter-document\n                          cross-references
-  in a Jekyll project are resolved automatically. Also included are some \n                          custom
-  macros and blocks that are useful for techinical writing."
+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.
 email:
 - brian.smith@numberfour.eu
 executables: []
@@ -78,6 +78,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -86,9 +87,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/inline-task.adoc
-- docs/requirement-block.adoc
-- docs/todo-block.adoc
 - jekyll_aspec.gemspec
 - lib/extensions/autoxrefs.rb
 - lib/extensions/html_postprocessor.rb
@@ -97,15 +95,12 @@ files:
 - 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/requirement_block_macro.rb
 - lib/extensions/todo_block.rb
 - lib/extensions/utils/block.rb
 - lib/extensions/utils/labels.rb
-- lib/extensions/utils/req_macro_walker.rb
-- lib/extensions/utils/xref_helper.rb
 - lib/jekyll_aspec.rb
 - lib/jekyll_aspec/version.rb
 homepage: https://github.com/bsmith-n4/jekyll_aspec

data/docs/inline-task.adoc

@@ -1,34 +0,0 @@
-= Inline Task Macro
-:toc:
-
-Usage::
-[source,asciidoc]
-task:target[title]
-
-The `inline task macro` creates hyperlinks to Jira task management and GitHub issue-tracking systems.
-Optionally, it will render the links differently to reflect the status of the tasks if a task info file is provided.
-
-Note that in case two colons are given instead of only one after `task`, the task link will be moved to the sidebar.
-
-Attributes::
-* *target:* The project prefix followed by a hyphen and the task number or ID (e.g. `23`).
-* *title:* (optional) The text that will be displayed as an anchor in the generated hyperlink.
-
-== Configuration
-
-The target pattern needs to be specified in a document attribute:
-
-`:task-pattern: http://www.myorg.github.com/myrepo/issues/`
-
-For a Jekyll build, this can be added in the Jekyll `pass:[_config.yml]` to be passed to all documents:
-
-```yaml
-asciidoctor:
-  attributes:
-    task-pattern: http://www.myorg.github.com/myrepo/issues/
-```
-
-== Examples
-
-A bug has already ``+++task:35[]+++`` been filed...
-

data/docs/requirement-block.adoc

@@ -1,56 +0,0 @@
-= Requirements Block
-
-Usage::
-
- .title
- [req,id=RSL-3,version=1]
- --
- Contents of the requirement
- --
-
-
-Attributes::
-* *title* (required):  An anchor is derived from the requirement title and embedded at the beginning of the rendered output.
-* *ID:* (required) The ID in the form *<Prefix>-<Number>*, used to generate an anchor
-* *version*: (required) value is a non-negative integer.
-
-NOTE: Omitting any of the above attributes will print an error to the console and insert a warning text in the generated document.
-* *delimiter*: Lines containing only two hyphens `--` delimit the block. This is required if the block contains empty lines or nested formatting.
-
-== ID Pattern
-
-The purpose of the `<Prefix>-<Number>` ID is to ensure that Requirements are both unique and easily referenceable.
-Currently, the ID may be any string, but should conform to the following conventions:
-
-*<Prefix>*: :: `R` (requirement) followed by the project prefix (i.e. `SL` for `stdlib`)
-*<Number>*: :: The requirement number, currently not validated.
-A validation stage for requirement IDs (detecting duplicates, for instance) is planned.
-
-Example::
-
-The following example demonstrates how to document Requirement pass:[#]3 for stdlib Version 1;
-
- .This is the title
- [req,id=RSL-3,version=1]
- --
- My Super Requirement
- --
-
-
-*Req. RSL-3: <<This_is_the_title,This is the title>> (ver. 1)* +
-My Super Requirement
-
-
-== Xrefs
-
-Cross-referencing requirements is done using the syntax `\<<Req-ID,Optional Link Text>>`, e.g. for the following requirement:
-
- [req,id=ROPR-14603,version=1]
- --
- ...
- --
-
-
-can be cross-referenced using the following syntax
-
- See <<Req-ROPR-14603>>, or see also <<Req-ROPR-14603,confirm the booking>>.

data/docs/todo-block.adoc

@@ -1,48 +0,0 @@
-= TODO Block
-
-== Usage
-
-[source,asciidoc]
-----
-// Simple use
-
-[TODO]
-Don't forget
-----
-
-===  Delimiters 
-
-Delimiters are required if the block contains empty lines or nested blocks. +
-The following delimiters may be used:
-
-[source,subs=macros]
-----
-====
---
-pass:[++++]
-****
-pass:[----]
-----
-
-Examples:: 
-[source,asciidoc]
-----
-.Block Title (optional)
-[TODO]
---
-Don't Forget!
-
-. Resolve an issue
-.. Don't break anything
---
-
-// or 
-
-[TODO]
-++++
-Don't divide by zero.
-
-* Add 1 to infinity.
-++++
-
-----

data/lib/extensions/req_preprocessor.rb

@@ -1,23 +0,0 @@
-require 'asciidoctor/extensions'
-
-include ::Asciidoctor
-
-# Preprocessor that strips the << tags
-# @todo 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/requirement_block_macro.rb

@@ -1,28 +0,0 @@
-require 'asciidoctor'
-require 'asciidoctor/extensions'
-require_relative 'utils/req_macro_walker'
-
-include ::Asciidoctor
-
-# @example Requirement Block Macro Use
-#   requirements::[]
-class RequirementBlockMacro < Extensions::BlockMacroProcessor
-  use_dsl
-  named :requirements
-
-  # Read the parent attributes and create a list of requirements in an appendix style
-  def process(parent, target, attrs)
-    rows = Reqs.list_reqs
-    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

data/lib/extensions/utils/req_macro_walker.rb

@@ -1,110 +0,0 @@
-# Special handling for linking to Requirements.
-# These are mainly used by the Requirement Appendix (requirement_block_macro)
-#
-module Reqs
-  # Recursively globs all files with the .adoc extension and matches cross-references
-  # to Requirements. The special handling here is that we detect if the target 
-  # requirement is commented, in a source block or included.
-  #
-  # @return [Array] An array of the IDs and paths to requirements in generated HTML files
-  def self.list_reqs
-    # @todo This should be configurable, or at least not hardcoded
-    exts = "(\.adoc|\.md|\.html)"
-    docsdir = '_docs'
-
-    title = nil
-    chapter = nil
-    doctitle = nil
-
-    reqs = []
-    rows = []
-    # For commented requirements
-    coms = []
-    # For includes
-    inc_reqs = []
-    incs = []
-
-    commentblockrx = '/^\/{4,}$/'
-    commentlinerx = '/^//(?=[^/]|$)/'
-
-    # @todo Already defined in Xref util?
-    def trim(s)
-      s.gsub!(/_docs\//, '')
-      s.gsub!(/(\.adoc|\.md|\.html)/, '')
-    end
-
-    # @todo Dont do this? Find a better way of handling all source adoc files.
-    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
-
-    # Remove dupes
-    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
-  end
-end