aspec_rb 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 453678159e0accca0120e8ae4a0a2884bcab73dfafe5e3729e0e643a6f7bf9b6
-  data.tar.gz: 1e8b92e29ef39dbda5e32c7e09f7f4eca62c1d1100cfdaaf754e3d9827e684d3
+SHA1:
+  metadata.gz: 761010f19d7ad3485c65f72edc6b9e438777e680
+  data.tar.gz: fef2e1403570de7dba974e48bad1bfe02b15f3f2
 SHA512:
-  metadata.gz: 9c8515990723467d246b8fd22f6bd5633ccbbbdd94500d98d0a454482c1c3c24b24e5b183ffbaf6bfa51d7fae5e68312b22d5fb3ccee0321ec153dff19eab78f
-  data.tar.gz: 185215194e2b523ab2017e8ecf052e935392be39a394abad1338af323eba8b4b5d7a1fa4bcd8b4ba3ccf42b96ec6cbe9c8e5584b6a124e07ebf5876ebaeec17c
+  metadata.gz: f4f3f05739378fad8e1add57de8cacc4d67a483a6fdc58c80cf8df28d0bb37426c3c52f3ab27aacd586b129510af133ad5148afbcdfba28d366b9146a1dbae86
+  data.tar.gz: d0e4421826c674162dd886ee7fd33b132f8064e517bbe33aea451bfcd95c73dd606a8a20f8d7280a693b77c02446f573cc2ea0c624c7cb1ea4164a09233737c1

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.3.0
+  Exclude:
+    - 'test/**/*'
 Metrics/LineLength:
   # This will disable the rule completely, regardless what other options you put
   Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    aspec_rb (0.0.5)
-      asciidoctor (>= 1.5.0)
+    aspec_rb (0.0.6)
+      asciidoctor
 
 GEM
   remote: https://rubygems.org/
@@ -25,10 +25,10 @@ PLATFORMS
 
 DEPENDENCIES
   aspec_rb!
-  bundler (>= 1.15.4)
-  rake (>= 12.1.0)
+  bundler
+  rake
   simplecov
-  test-unit (>= 3.2.6)
+  test-unit
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,8 +1,9 @@
 # aspec_rb
 
-[![Gem Version](https://badge.fury.io/rb/aspec_rb.svg)](https://badge.fury.io/rb/aspec_rb)
 [![Build Status](https://travis-ci.org/tcob/aspec_rb.svg?branch=master)](https://travis-ci.org/tcob/aspec_rb)
-
+[![Gem Version](https://badge.fury.io/rb/aspec_rb.svg)](https://badge.fury.io/rb/aspec_rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/11ef540aabef88117720/maintainability)](https://codeclimate.com/github/tcob/aspec_rb/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/11ef540aabef88117720/test_coverage)](https://codeclimate.com/github/tcob/aspec_rb/test_coverage)
 ## Installation
 
 ```

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'test/unit'
 

data/aspec_rb.gemspec

@@ -1,5 +1,7 @@
 
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'aspec_rb/version'
 
@@ -17,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/tcob/aspec_rb'
   spec.license       = 'MIT'
 
-  # This gem will work with 2.0 or greater.
-  spec.required_ruby_version = '>= 2.0'
+  # This gem will work with 2.3 or greater.
+  spec.required_ruby_version = '>= 2.3'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -27,8 +29,8 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+  spec.add_runtime_dependency 'asciidoctor'
 end

data/bin/console

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

data/lib/aspec_rb/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # 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.5'.freeze
+  VERSION = '0.0.6'
 end

data/lib/aspec_rb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'extensions/autoxrefs'
 require_relative 'extensions/definition_block'
 require_relative 'extensions/inline_callout_macro'

data/lib/extensions/autoxrefs.rb

@@ -1,26 +1,20 @@
+# frozen_string_literal: true
+
 require 'asciidoctor/extensions'
-require_relative 'utils/scanner'
+require_relative 'utils/utils'
 
 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) { [] }
+ni_includes, includes, doclinks, anchorfixes, intrachapter, interchapter, anchors, xrefs = Array.new(9) { [] }
 
 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
+indexincludes = Index.includes
 
 adoc_files.each do |filename|
   main = false

data/lib/extensions/definition_block.rb

@@ -1,6 +1,6 @@
-require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+# frozen_string_literal: true
 
-include ::Asciidoctor
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 Extensions.register do
   block do
@@ -19,9 +19,8 @@ Extensions.register do
         #    Also replacing special HTML entities:
         #    " = "
         #    &  = &
-        downcased_title = attrs['title'].downcase.tr(' ', '_').gsub('"', '"')
         san_title = attrs['title'].gsub(/&/, '&').delete('`').delete("'").delete('*')
-      rescue Exception => msg
+      rescue StandardError => msg
         puts msg
         # If no title exists on the Def block, throw an exception
         puts '[ERROR] Definition block title missing'

data/lib/extensions/inline_callout_macro.rb

@@ -1,6 +1,6 @@
-require 'asciidoctor/extensions'
+# frozen_string_literal: true
 
-include ::Asciidoctor
+require 'asciidoctor/extensions'
 
 # @example Basic Usage
 #   See call:1[] for details

data/lib/extensions/inline_cwiki_macro.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 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

data/lib/extensions/inline_repo_macro.rb

@@ -1,6 +1,6 @@
-require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+# frozen_string_literal: true
 
-include ::Asciidoctor
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 # Link to a file on GitHub.
 #
@@ -24,15 +24,11 @@ Extensions.register do
 
     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

data/lib/extensions/inline_task_macro.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'asciidoctor/extensions'
 require_relative 'utils/labels'
 require_relative 'utils/block'
@@ -25,11 +27,10 @@ Extensions.register do
       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
+        next unless dest == prefix
+        type, tip, patt, icon, id = value.match(/^([^^]+)\;([^^]+)\;([^^]+)\;([^^]+)\;([^^]+)/).captures
+        patt.gsub!(/\/(\w+?-)?{.+?}/, '')
+        pattern = patt
       end
 
       if pattern.nil?

data/lib/extensions/postprocessor.rb

@@ -1,6 +1,6 @@
-require 'asciidoctor/extensions'
+# frozen_string_literal: true
 
-include ::Asciidoctor
+require 'asciidoctor/extensions'
 
 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;)'

data/lib/extensions/req_refs.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'asciidoctor/extensions'
-require_relative 'utils/scanner'
+require_relative 'utils/utils'
 
 # test using ruby benchmark
 
@@ -13,17 +15,11 @@ $doclinks = []
 adoc_files = Dir.glob("#{$srcdir}/**/*.adoc")
 
 # Find a nicer way to initialize some arrays:
-ssincs, ni_includes, includes, doclinksfix, docs, titles, mainchaps, indexincludes, xrefs = Array.new(10) { [] }
+ni_includes, includes, doclinksfix, docs, titles, mainchaps, xrefs = Array.new(8) { [] }
+
 $reqfixes = []
 
-# 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
+indexincludes = Index.includes
 
 adoc_files.sort!
 adoc_files.each do |filename|
@@ -138,8 +134,8 @@ $reqs.sort_by!(&:first)
 # 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
 $reqs.each do |rid, _line, path, _filename, _main, _chapter|
-  $doclinks.each do |_doc, link, chapter|
-    next unless path == "#{chapter}/#{_doc}"
+  $doclinks.each do |doc, link, chapter|
+    next unless path == "#{chapter}/#{doc}"
     $reqfixes.push([rid, link])
     break
   end

data/lib/extensions/requirement_appendix.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'asciidoctor'
 require 'asciidoctor/extensions'
 
@@ -82,7 +84,7 @@ reqs.each do |req, f, title, chapter, doctitle|
 
   link = link.sub(/^_/, '') if link[/^_/]
   f = f.sub(/^chapters\//, '')
-  icon = "<i class=\"fa fa-external-link-square\" aria-hidden=\"true\"></i>"
+  icon = '<i class="fa fa-external-link-square" aria-hidden="true"></i>'
   ref = "<a class=\"link\" href=\"#{link}\"><emphasis role=\"strong\">#{icon} #{title}</emphasis>  </a>"
   breadcrumb = "<a href=\"#{f}\">#{chapter} / #{doctitle}</a>"
   anchor = "<a class=\"link\" href=\"#Req-#{rid}\">#{rid}</a>"

data/lib/extensions/requirement_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 include ::Asciidoctor

data/lib/extensions/todo_block.rb

@@ -1,6 +1,6 @@
-require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+# frozen_string_literal: true
 
-include ::Asciidoctor
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
 
 Extensions.register do
   block do

data/lib/extensions/utils/block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Helper methods handling whether to output inline content or a block.
 # Will read the attributes of the current macro and output a HTML string that is either
 # inline or a block (float-right).
@@ -23,14 +25,14 @@ module Context
                "<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
+             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
+             end
+            end
     html
   end
 end

data/lib/extensions/utils/index.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Index
+  def self.includes
+    # From the index, create an array of the main chapters
+    @indexincludes = []
+    File.read('index.adoc').each_line do |line|
+      @indexincludes.push(match_include(line).sub(/^\{find\}/, '')) if line[IncludeDirectiveRx]
+    end
+    @indexincludes
+  end
+
+  def self.match_include(line)
+    line.match(/(?<=^include::).+?\.adoc(?=\[\])/).to_s
+  end
+end

data/lib/extensions/utils/labels.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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.

data/lib/extensions/utils/scanner.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Sform
-  def self.trim(s)
-    s = s.gsub(/^#{$srcdir}\//, '') unless s.nil?
-    s = s.gsub(/(\.adoc)/, '') unless s.nil?
+  def self.trim(string)
+    string = string.gsub(/^#{$srcdir}\//, '') unless string.nil?
+    string = string.gsub(/(\.adoc)/, '') unless string.nil?
   end
 
-  def self.underscorify(t)
-    t = t.downcase.gsub(/(\s|-)/, '_')
+  def self.underscorify(title)
+    title = title.downcase.gsub(/(\s|-)/, '_')
     # document attribute idprefix must be seet to empty, if not
     # the default value is an underscore and the following line is required
     # t = t.prepend('_') unless t.match(/^_/)
-    t = t.gsub(/___/, '_').delete('`')
+    title = title.gsub(/___/, '_').delete('`')
   end
 
-  def self.titleify(t)
-    t = t.tr('_', ' ')
-    t = t.lstrip
-    t = t.split.map(&:capitalize).join(' ')
+  def self.titleify(title)
+    title = title.tr('_', ' ')
+    title = title.lstrip
+    title = title.split.map(&:capitalize).join(' ')
   end
 end

data/lib/extensions/utils/utils.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'block'
+require_relative 'index'
+require_relative 'labels'
+require_relative 'scanner'

data/lib/html_chunker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'asciidoctor'
 
 # Chunks the HTML output generated by the HTML5 converter by chapter.
@@ -7,7 +9,7 @@ class MultipageHtml5Converter
   include Asciidoctor::Writer
 
   register_for 'multipage'
-  EOL = "\n".freeze
+  EOL = "\n"
 
   def initialize(backend, opts)
     super
@@ -33,13 +35,6 @@ class MultipageHtml5Converter
     master_content << %(= #{node.doctitle})
     master_content << (node.attr 'author') if node.attr? 'author'
     master_content << ''
-    # @documents.each do |doc|
-    #   sect = doc.blocks[0]
-    #   sectnum = sect.numbered && !sect.caption ? %(#{sect.sectnum} ) : nil
-    #   filename = doc.attr 'docname'
-    #   filename = filename.sub(/^_/, '')
-    #   master_content << %(== <<#{filename}#,#{sectnum}#{sect.captioned_title}>> +)
-    # end
     master_content << ''
     master_content << 'requirements::[]'
     Asciidoctor.convert master_content, doctype: node.doctype, header_footer: true, safe: node.safe, attributes: indexconfigs
@@ -70,9 +65,14 @@ class MultipageHtml5Converter
         block.columns.each do |col|
           col.parent = col.parent
         end
-        block.rows.body.each do |row|
-          row.each do |cell|
-            cell.parent = cell.parent
+        block.rows.body = block.rows.body.map do |row|
+          row.map do |cell|
+            if cell.attributes['style'] == :asciidoc
+              text = cell.instance_variable_get(:@text)
+              Asciidoctor::Table::Cell.new cell.column, text, cell.attributes
+            else
+              cell
+            end
           end
         end
       elsif block.context == :dlist
@@ -100,7 +100,7 @@ class MultipageHtml5Converter
     ::File.open(target, 'w') do |f|
       f.write output
     end
-    load "postprocessors/generate_toc.rb"
-    load "postprocessors/fulltext_search.rb"
+    load 'postprocessors/generate_toc.rb'
+    load 'postprocessors/fulltext_search.rb'
   end
 end

data/lib/postprocessors/fulltext_search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 require 'fileutils'
 require 'open-uri'

data/lib/postprocessors/generate_toc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 require 'open-uri'
 
@@ -17,7 +19,9 @@ style="margin-left: 18px;">
 }
 
 html_files = Dir.glob("#{gendir}/**/*.html")
-anchors, sections, appendices = [], [], []
+anchors = []
+sections = []
+appendices = []
 
 html_files.each do |file|
   next if file == "#{gendir}/search.html" || file[%r{^#{gendir}\/index}]
@@ -71,7 +75,7 @@ anchors.each do |file, id, text, level|
   if level > prev_level
     if i != 0
       toc = toc.chomp("</li>\n")
-      toc += " <a href=\"#\" data-toggle=\"collapse\" data-target=\"#tocnav_#{id}\"></a>
+      toc += " <a href=\"#\" data-toggle=\"collapse\" data-target=\"#tocnav_#{id}\"><i class=\"fa fa-plus-square\" aria-hidden=\"true\"></i></a>
       <ul>
       <div id=\"tocnav_#{id}\" class=\"collapse\">
       <li><a href=\"#{file}##{id}\">#{text}</a></li>\n"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspec_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - tcob
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 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
@@ -101,8 +101,10 @@ files:
 - lib/extensions/requirement_block.rb
 - lib/extensions/todo_block.rb
 - lib/extensions/utils/block.rb
+- lib/extensions/utils/index.rb
 - lib/extensions/utils/labels.rb
 - lib/extensions/utils/scanner.rb
+- lib/extensions/utils/utils.rb
 - lib/html_chunker.rb
 - lib/postprocessors/fulltext_search.rb
 - lib/postprocessors/generate_toc.rb
@@ -118,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -126,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Asciidoctor extensions for large HTML documents