aspec_rb 0.0.1

data/lib/postprocessors/generate_toc.rb

@@ -0,0 +1,104 @@
+require 'nokogiri'
+require 'open-uri'
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+# This marker should be in the target document where the TOC will be placed.
+marker = '---TOC---'
+gendir = 'generated-docs' # TODO: - do not hardcode
+
+# Open a <ul> element
+toc = %{<input type="text" id="pagesearch" onkeyup="search()" placeholder="Filter chapters"
+style="margin-left: 18px;">
+<i class="fa fa-times" aria-hidden="true" style="display:none;" id="clear"></i>
+<ul class="nav" id="treeview">
+
+}
+
+html_files = Dir.glob("#{gendir}/**/*.html")
+anchors, sections, appendices = [], [], []
+
+html_files.each do |file|
+  next if file == "#{gendir}/search.html" || file[%r{^#{gendir}\/index}]
+  page = Nokogiri::HTML(open(file))
+  filename = file.sub(%r{^#{gendir}\/}, '')
+
+  # All Asciidoc files will have a <h2> element as the document name
+  # when sectnums attribute is enabled, this can be used for sorting
+  pagetitle = page.xpath('//h2').text
+
+  # Collect all heading elements, exclude 'panel-title' class used in Requirements
+  # TODO - check for other heading elements that are not section titles.
+  # It may be wise to search by xpath for heading elements directly after 'sect1-6' class divs
+  hs = page.xpath("//h2 | //h3[not(@class='panel-title')] | //h4 | //h5").collect
+
+  if pagetitle[/^Appendix/]
+    # Create an array of appendices
+    appendices.push([hs, pagetitle, filename])
+  elsif pagetitle[/^\d+/]
+    # Create an array of section titles by chapter number
+    sections.push([hs, pagetitle, filename])
+  end
+end
+
+# Sort Sections by number
+sections.sort_by! { |_content, title| title.scan(/^\d+/).first.to_i }
+
+# Sort Appendices Array
+appendices.sort_by! { |_content, title| title }
+
+# Push Appendices to end of Sections array
+appendices.each do |content, title, filename|
+  sections.push([content, title, filename])
+end
+
+# For each Section (HTML page), create an array of anchors
+sections.each do |sect, _title, filename|
+  sect.each do |content|
+    anchors.push([filename, content.attributes['id'].to_s, content.content.to_s, content.name.delete('h').to_i])
+  end
+end
+
+i = 0
+prev_level = 0
+
+# For each anchor, create a html list element
+anchors.each do |file, id, text, level|
+  li = "<li><a href=\"#{file}##{id}\">#{text}</a></li>\n"
+
+  # If there are subsections, add a nested <ul> element
+  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>
+      <div id=\"tocnav_#{id}\" class=\"collapse\">
+      <li><a href=\"#{file}##{id}\">#{text}</a></li>\n"
+      li = ''
+    end
+
+  # Close nested <ul> elements
+  elsif level < prev_level
+    diff = prev_level - level
+    diff.times { toc += "</div></ul>\n" }
+  end
+  i += 1
+  toc += li
+  # assign a variable with current level to compare in next iteration
+  prev_level = level
+end
+
+# Close the toc
+toc += '</ul>'
+
+html_files.each do |fi|
+  file = fi.sub(%r{#{gendir}\/}, '')
+  thistoc = toc.gsub(/#{file}/, '')
+  data = File.read(fi)
+  File.open(fi, 'w') do |f|
+    modified = data.sub(marker, thistoc)
+    f.write(modified)
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: aspec_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bsmith-n4
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.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
+                            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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- aspec_rb.gemspec
+- bin/console
+- bin/setup
+- lib/aspec_rb.rb
+- lib/aspec_rb/version.rb
+- lib/extensions/autoxrefs.rb
+- lib/extensions/definition_block.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/postprocessor.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/extensions/utils/scanner.rb
+- lib/html_chunker.rb
+- lib/postprocessors/fulltext_search.rb
+- lib/postprocessors/generate_toc.rb
+homepage: https://github.com/bsmith-n4/aspec_rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Asciidoctor extensions for use as a Jekyll plugin
+test_files: []