aspec_rb 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f014b57aa727ad15d411f27453bf4533243be7751b07e9159da96680490738f
-  data.tar.gz: 3e2cb40c81dd7cc8c7b4d6c28338e48e9925f6f952411f2f48bcac69939cefc8
+  metadata.gz: 6ceaae8abf8a8ed63c0e9d7a58b5065ad8d56a3e13a6d9b4ca43be3367ff4869
+  data.tar.gz: 456c514ec27c3e61b97ec3486415d71be01f38c8809e2c59fb20a3bf44ab823a
 SHA512:
-  metadata.gz: 3fff756036c5604ee7a5008ba1c451eb670e50cd09e5314ffa7eb42b82dc71bf8f3a3506680d520d70cf3472c98fb4211e29d471671fb927d753c73aa0b69081
-  data.tar.gz: 875e7b32dd7634e703330a42a2ca184f0d064f82c2d4bdbad309c0a3064cb403928a331a2b954b13c2aaae84422ce318fc1e59f527d46fa6bd3a528ec99e3e11
+  metadata.gz: 0a95bbc8b021c3811a318fc2e270e12dc2e61520d77dfdf5870a1d333ff68d5192a11a66c890a4de7f6f52f3ff4e1322d5442cba81eb4896573f57bed4dc087b
+  data.tar.gz: 9053d5e8942fe690eb61df5370fa76ea5191c060d18b1e7c0df390f30dbc0370b41175558cde69655f7e5092697581c89409a5061b61eb1d3105ca73f6bd3f0e

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    aspec_rb (0.0.14)
+    aspec_rb (0.0.15)
       asciidoctor
 
 GEM
   remote: https://rubygems.org/
   specs:
     asciidoctor (1.5.7.1)
-    docile (1.3.0)
+    docile (1.3.1)
     json (2.1.0)
     power_assert (1.1.1)
     rake (12.3.1)
@@ -31,4 +31,4 @@ DEPENDENCIES
   test-unit
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/lib/aspec_rb/version.rb

@@ -7,5 +7,5 @@ module AspecRb
   # For this deploy config, see https://github.com/tcob/aspec_rb/blob/master/.travis.yml
   #
   # Manual release can be performed by running 'bundle install && rake release'
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/lib/aspec_rb.rb

@@ -1,4 +1,6 @@
-# frozen_string_literal: true
+require 'asciidoctor/extensions'
+
+include ::Asciidoctor
 
 # require_relative 'extensions/css_docinfo'
 require_relative 'extensions/autoxrefs'

data/lib/extensions/autoxrefs.rb

@@ -12,6 +12,7 @@ AnchorRx = /\[\[(?:|([\w+?_:][\w+?:.-]*)(?:, *(.+))?)\]\]/
 
 ni_includes, includes, doclinks, anchorfixes, intrachapter, interchapter, anchors, xrefs = Array.new(9) { [] }
 
+# Don't do this!
 adoc_files = Dir.glob("#{$srcdir}/**/*.adoc")
 
 indexincludes = Index.includes
@@ -41,6 +42,8 @@ adoc_files.each do |filename|
           target = xref.gsub(/,.+/, '')
           text = xref.gsub(/.+,/, '').lstrip
           xref = xref.sub(/,.+/, '')
+        elsif xref[/^SC_ROPR/]
+          text = xref
         else
           text = Sform.titleify(xref).strip
         end
@@ -78,7 +81,7 @@ adoc_files.each do |filename|
       child = li.match(/(?<=^include::).+?\.adoc(?=\[\])/).to_s
       child = child.sub(/^\{find\}/, '')
       childpath = "#{filename.sub(/[^\/]+?\.adoc/, '')}#{child}"
-      includes.push([filename, child, childpath])
+      includes.push([Sform.trim(filename), child, Sform.trim(childpath)])
 
     end
   end
@@ -92,6 +95,7 @@ adoc_files.each do |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
@@ -99,8 +103,9 @@ anchors.each do |_anchor, full, _filename, link, chapter, main, h1|
   doclinks.push([doc, link, chapter])
 end
 
-# If a section title has an overriding anchor on the previous line, perform the following fix
 o_anchors = []
+
+# If a section title has an overriding anchor on the previous line, perform the following fix
 doclinks.delete_if do |doc, _link, mchapter|
   topleveldoc = "#{$srcdir}/#{mchapter}/#{doc}.adoc"
   lines = File.foreach(topleveldoc).first(10).join
@@ -113,27 +118,15 @@ 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!
+includes.each do |parent, _child, childpath|
+  anchors.map! { |anchor, path, filename, text, chapter, main, _h1|
+    filename = parent if childpath == path
+    [anchor, path, filename, text, chapter, main, _h1]
+  }
 end
 
-tempanchors.clear
+anchors.uniq!
+tempanchors = []
 
 anchors.delete_if do |anchor, apath, trim_parent, parent, amain, achapter|
   doclinks.each do |doc, link, dchapter|
@@ -143,6 +136,8 @@ anchors.delete_if do |anchor, apath, trim_parent, parent, amain, achapter|
   end
 end
 
+
+tempanchors.uniq!
 anchors += tempanchors
 anchors.uniq!
 
@@ -155,7 +150,7 @@ xrefs.each do |xref, xpath, _xfilename, _xtext, xtarget, _xchapter|
     afilename = '' if xpath == apath
     # xtext = xref if xtext.empty?
     afilename.sub!(/^_/, '') if afilename[/^_/]
-    fix = "#{afilename}##{atext},#{xtarget}"
+    fix = "#{afilename}##{atext},#{_xtext}"
     anchorfixes.push([anchor, fix, xref])
   end
 end
@@ -163,7 +158,9 @@ end
 Extensions.register do
   preprocessor do
     process do |_document, reader|
-      Reader.new reader.readlines.map { |line|
+      # return reader if reader.eof?
+      
+      replacement_lines = reader.read_lines.map do |line|
         if line[/\<\<(?!Req)(.+?)\>\>/]
           anchorfixes.each do |original, fix|
             next unless line[/\<\<#{original}(,.+?)?\>\>/]
@@ -177,7 +174,9 @@ Extensions.register do
           2.times { line.sub!(/`/, '') }
         end
         line
-      }
+      end
+      reader.unshift_lines replacement_lines
+      reader
     end
   end
 end

data/lib/extensions/definition_block.rb

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

data/lib/extensions/req_refs.rb

@@ -56,7 +56,7 @@ adoc_files.each do |filename|
       child = li.match(/(?<=^include::).+?\.adoc(?=\[\])/).to_s
       child = child.sub(/^\{find\}/, '')
       childpath = "#{filename.sub(/[^\/]+?\.adoc/, '')}#{child}"
-      includes.push([filename, child, childpath])
+      includes.push([Sform.trim(filename), child, Sform.trim(childpath)])
 
     end
   end
@@ -105,20 +105,21 @@ end
 
 # TODO: - see if editing the array in-place is better using map!
 includes += ni_includes
+tempreqs = []
 
 # Edit the array of Requirements to point to the parent document *if* it is included.
 # TODO use a while loop, repeat until no changes made
 3.times do
   # initialize an array
-  tempreqs = []
+  tempreqs.clear
 
   # Loop through all includes, if the requirement is contained in an include,
   # edit the $reqs array to point to its parent instead
   includes.each do |parent, _child, childpath|
     # Delete the child req if matched
     $reqs.delete_if do |rid, line, path, _filename, main, chapter|
-      next unless Sform.trim(childpath) == Sform.trim(path)
-      tempreqs.push([rid, line, Sform.trim(parent), parent, main, chapter])
+      next unless childpath == path
+      tempreqs.push([rid, line, parent, parent, main, chapter])
       true
     end
   end
@@ -180,4 +181,4 @@ Extensions.register do
       (create_anchor parent, final_link, type: :link, target: uri).convert
     end
   end
-end
+end

data/lib/extensions/utils/search.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Search
   # Some special handling for sanitizing the search json
   def self.sanitize_json(str)

data/lib/html_chunker.rb

@@ -87,20 +87,20 @@ class MultipageHtml5Converter
 
   def write(output, target)
     outdir = ::File.dirname target
-    puts '[CHUNKED HTML] Generating chapters:'
+    puts '[ASPEC] Generating chapters'
     @documents.each do |doc|
       filename = doc.attr 'docname'
       filename = filename.sub(/^_/, '')
       outfile = ::File.join outdir, %(#{filename}.html)
-      puts "[CHAPTER] #{outfile}"
       ::File.open(outfile, 'w') do |f|
         f.write doc.convert
       end
     end
-    puts "[HTML INDEX] Generating index at #{target}"
     ::File.open(target, 'w') do |f|
       f.write output
     end
+    puts '[ASPEC] Done'
+    puts "[ASPEC] Index generated at #{target}"
     load 'postprocessors/generate_toc.rb'
     load 'postprocessors/fulltext_search.rb'
   end

data/lib/postprocessors/fulltext_search.rb

@@ -1,19 +1,17 @@
-# frozen_string_literal: true
-
 require 'nokogiri'
 require 'fileutils'
-require 'open-uri'
 require_relative '../extensions/utils/utils'
 
 @json = ''
 gendir = 'generated-docs' # TODO: - do not hardcode
 
 html_files = Dir.glob("#{gendir}/**/*.html")
+puts "[ASPEC] Creating full-text search index."
 
 def add_heading(subsection, url, level)
   id = subsection.at(level).attr('id')
   sub_url = url + '#' + id
-  @json += Search.add_to_index(sub_url, id, subsection.at(level).text, subsection.text)
+  @json << Search.add_to_index(sub_url, id, subsection.at(level).text, subsection.text)
 end
 
 html_files.each do |file|
@@ -27,25 +25,21 @@ html_files.each do |file|
   page.xpath("//div[@class='sect1']").each do |section|
     if section.at_css('div.sect2')
 
+      # consider xpath for multiple cases - be more specific in the query, dont have so many nested ifs
       section.xpath("//div[@class='sect2' or @class='sect2 language-n4js']").each do |subsection|
         if subsection.at_css('div.sect3')
 
           section.xpath("//div[@class='sect3']").each do |subsection|
-            if subsection.at_css('div.sect4')
-              add_heading(subsection, url, 'h5')
-            else
-              add_heading(subsection, url, 'h4')
-            end
+            add_heading(subsection, url, 'h4')
           end
 
         else
           add_heading(subsection, url, 'h3')
         end
       end
-
     else
       text = section.xpath("//div[@class='sect1' or @class='sect1 language-n4js']").css('p').text
-      @json += Search.add_to_index(url, slug, title, text)
+      @json << Search.add_to_index(url, slug, title, text)
     end
   end
 end
@@ -67,3 +61,5 @@ filtered_data = data.sub(marker, jsonindex)
 File.open(searchpage, 'w') do |f|
   f.write(filtered_data)
 end
+
+puts "[ASPEC] Full-text search index built."

data/lib/postprocessors/generate_toc.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'nokogiri'
 require 'open-uri'
 
@@ -25,9 +23,8 @@ appendices = []
 
 html_files.each do |file|
   next if file == "#{gendir}/search.html" || file[%r{^#{gendir}\/index}]
-  if file == "#{gendir}/revision_history.html"
-    toc += %(<li><a href="revision_history.html">Revision History</a></li>)
-  end
+  toc << %(<li><a href="revision_history.html">Revision History</a></li>) if file == "#{gendir}/revision_history.html"
+
   page = Nokogiri::HTML(open(file))
   filename = file.sub(%r{^#{gendir}\/}, '')
 
@@ -78,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}\"><i class=\"fa fa-plus-square\" aria-hidden=\"true\"></i></a><ul>
+      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"
       li = ''
@@ -87,16 +84,17 @@ anchors.each do |file, id, text, level|
   # Close nested <ul> elements
   elsif level < prev_level
     diff = prev_level - level
-    diff.times { toc += "</div></ul>\n" }
+    diff.times { toc << "</div></ul>\n" }
   end
+
   i += 1
-  toc += li
+  toc << li
   # assign a variable with current level to compare in next iteration
   prev_level = level
 end
 
 # Close the toc
-toc += '</ul>'
+toc << '</ul>'
 
 html_files.each do |fi|
   file = fi.sub(%r{#{gendir}\/}, '')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspec_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - tcob
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Asciidoctor extensions for large HTML documents