ascii_binder 0.1.14 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 212faa11c6800de991285d33ab3e538a3dda1e19
-  data.tar.gz: 22ea55e36faa743586e736de2c8eb862a6ee04b8
+SHA256:
+  metadata.gz: f2f0c681a484a802db17a50ebbbd8813c8398d4d79cf7b6f91a53cdfb1f460a4
+  data.tar.gz: fdf32199cf71677ae3ca7ff5b8962bde144b03f07feec8686df567c953c48aed
 SHA512:
-  metadata.gz: '076619a219d12c97890f8dfee5ee97574b78d9cab9af8979a75b93061df651a53752ecff217ee69f037ec2759efc5aa5f6ad5d7f43e8fc398a18e8fd1fa72375'
-  data.tar.gz: 6fbffc6bc4aa5be720e995fdce8cd7e72ea5afef70da9362c0b129c9ea48ba4295139ebd413c64e73841541de196269ec2406949aa70bdc0c45bcd750bc5ab1b
+  metadata.gz: 759f9f9df03df35eaf06e104a62f01aac906860b8e3ee83b3160ea46def33a16a249034482dcbd37007568c75975fd4ea1e33127fc7b2c51e988bf41d2626332
+  data.tar.gz: 6e3d69dc9de3af08151615a57bf501a61501a0c3d1fee5c43c4b4f874861efb131b82f783ea8df7c3a953ff6a06ef0dc4cf4020555842f74093ff3678bc7b7f6

data/README.adoc

@@ -4,17 +4,17 @@ image:https://badge.fury.io/rb/ascii_binder.svg["Gem Version", link="https://bad
 
 AsciiBinder is an AsciiDoc-based system for authoring and publishing closely related documentation sets from a single source.
 
+This product is no longer actively maintained.
+
 == Learn More
 
-* See the http://www.asciibinder.org[homepage].
-* Have a gander at the http://www.asciibinder.org/latest/welcome/[AsciiBinder documentation].
-* Or just take the https://rubygems.org/gems/ascii_binder[ascii_binder Ruby Gem] for a spin.
+* Take the https://rubygems.org/gems/ascii_binder[ascii_binder Ruby Gem] for a spin.
 
 The AsciiBinder system was initially developed for https://github.com/openshift/openshift-docs[OpenShift documentation], but has been revised to work for documenting a wide variety of complex, multi-versioned software projects.
 
 == Contributing
 
-We are using the https://github.com/redhataccess/ascii_binder/issues[Issues] page to track bugs and feature ideas on the code, so have a look and feel free to ask questions there. You can also chat with us on IRC at FreeNode, http://webchat.freenode.net/?randomnick=1&channels=asciibinder&uio=d4[#asciibinder] channel, or on Twitter - https://twitter.com/AsciiBinder[@AsciiBinder].
+We are using the https://github.com/redhataccess/ascii_binder/issues[Issues] page to track bugs and feature ideas on the code, so have a look and feel free to ask questions there.
 
 == License
 

data/ascii_binder.gemspec

@@ -6,11 +6,11 @@ require 'ascii_binder/version'
 Gem::Specification.new do |spec|
   spec.name          = "ascii_binder"
   spec.version       = AsciiBinder::VERSION
-  spec.authors       = ["N. Harrison Ripps", "Jason Frey", "Carlos Munoz", "Brian Exelbierd"]
-  spec.email         = ["nhr@redhat.com", "jfrey@redhat.com", "chavo16@hotmail.com", "bex@pobox.com"]
+  spec.authors       = ["N. Harrison Ripps", "Jason Frey", "Carlos Munoz", "Brian Exelbierd", "Vikram Goyal"]
+  spec.email         = ["nhr@redhat.com", "jfrey@redhat.com", "chavo16@hotmail.com", "bex@pobox.com", "vigoyal@redhat.com"]
   spec.summary       = %q{AsciiBinder is an AsciiDoc-based system for authoring and publishing closely related documentation sets from a single source.}
   spec.description   = spec.summary
-  spec.homepage      = "http://asciibinder.org/"
+  spec.homepage      = "https://github.com/redhataccess/ascii_binder"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,21 +18,23 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "cucumber", "~> 2.3.3"
   spec.add_development_dependency "diff_dirs", "~> 0.1.2"
-  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "rake", "~> 12.3.3"
 
-  spec.add_dependency 'asciidoctor', '~> 1.5.6'
-  spec.add_dependency 'asciidoctor-diagram', '~> 1.5.5'
+  spec.add_dependency 'asciidoctor', '~> 2.0.10'
+  spec.add_dependency 'asciidoctor-diagram', '~> 2.0.2'
+  spec.add_dependency 'rouge', '~> 3.18.0'
   spec.add_dependency 'git'
   spec.add_dependency 'guard'
   spec.add_dependency 'guard-shell'
   spec.add_dependency 'guard-livereload'
   spec.add_dependency 'haml'
   spec.add_dependency 'json'
-  spec.add_dependency 'sitemap_generator', '~> 5.1.0'
+  spec.add_dependency 'sitemap_generator', '~> 6.0.1'
   spec.add_dependency 'trollop', '~> 2.1.2'
   spec.add_dependency 'yajl-ruby', '~> 1.3.0'
   spec.add_dependency 'tilt'
+
 end

data/bin/asciibinder

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'ascii_binder/distro_map'
 require 'ascii_binder/engine'
 require 'ascii_binder/helpers'
 require 'ascii_binder/version'
@@ -132,6 +133,7 @@ EOF
       opt :distro, "Instead of building all distros, build branches only for the specified distro.", :default => ''
       opt :page, "Build only the specified page for all distros and only the current working branch.", :default => ''
       opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
+      opt :toc_depth, "Maximum depth of topics allowed.  Use 0 for infinite depth.", :default => 3
       conflicts :distro, :page
     end
   when "create"
@@ -206,6 +208,7 @@ Options:
 EOF
       opt :site, "Instead of packaging every docs site, package the specified site only.", :default => ''
       opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
+      opt :toc_depth, "Maximum depth of topics allowed.  Use 0 for infinite depth.", :default => 3
     end
   when "help"
     Trollop::educate
@@ -273,6 +276,13 @@ unless cmd_opts.nil? or cmd_opts[:log_level].nil?
 end
 set_log_level(user_log_level)
 
+# Set the depth level
+user_depth = 3
+unless cmd_opts.nil? or cmd_opts[:toc_depth].nil?
+  user_depth = cmd_opts[:toc_depth].to_i
+end
+set_depth(user_depth)
+
 
 # Cloning? Time to try it.
 if cmd == 'clone'
@@ -284,9 +294,14 @@ if cmd == 'clone'
   repo_check(docs_basedir)
 
   if cmd_opts[:branches]
+    cloned_map = AsciiBinder::DistroMap.new(File.join(docs_basedir,DISTRO_MAP_FILENAME))
+    unless cloned_map.is_valid?
+      error_info = cloned_map.errors.join("\n")
+      Trollop::die "The distro map in the newly cloned repo is invalid, with the following errors:\n#{error_info}"
+    end
     Dir.chdir(docs_basedir)
     puts "Tracking branch setup:"
-    distro_branches.each do |doc_branch|
+    cloned_map.distro_branches.each do |doc_branch|
       next if doc_branch == 'master'
       puts "- #{doc_branch}"
       system("git branch #{doc_branch} origin/#{doc_branch}")

data/lib/ascii_binder/engine.rb

@@ -188,12 +188,13 @@ module AsciiBinder
       args[:breadcrumb_root], args[:breadcrumb_group], args[:breadcrumb_subgroup], args[:breadcrumb_topic] = extract_breadcrumbs(args)
 
       args[:breadcrumb_subgroup_block] = ''
-      args[:subtopic_shim]             = ''
       if args[:breadcrumb_subgroup]
         args[:breadcrumb_subgroup_block] = "<li class=\"hidden-xs active\">#{args[:breadcrumb_subgroup]}</li>"
-        args[:subtopic_shim]             = '../'
       end
 
+      args[:subtopic_shim] = '../' * (args[:topic_id].split('::').length - 2)
+      args[:subtopic_shim] = '' if args[:subtopic_shim].nil?
+
       template_path = File.expand_path("#{docs_root_dir}/_templates/page.html.erb")
       template_renderer.render(template_path, args)
     end
@@ -237,8 +238,7 @@ module AsciiBinder
 
     def asciidoctor_page_attrs(more_attrs=[])
       [
-        'source-highlighter=coderay',
-        'coderay-css=style',
+        'source-highlighter=rouge',
         'linkcss!',
         'icons=font',
         'idprefix=',
@@ -466,10 +466,6 @@ module AsciiBinder
       article_title = doc.doctitle || topic.name
 
       topic_html = doc.render
-      dir_depth  = ''
-      if branch_config.dir.split('/').length > 1
-        dir_depth = '../' * (branch_config.dir.split('/').length - 1)
-      end
 
       # This is logic bridges newer arbitrary-depth-tolerant code to
       # older depth-limited code. Truly removing depth limitations will
@@ -484,8 +480,9 @@ module AsciiBinder
       if breadcrumb.length == 3
         subgroup_title = breadcrumb[1][:name]
         subgroup_id    = breadcrumb[1][:id]
-        dir_depth      = '../' + dir_depth
       end
+      dir_depth = '../' * topic.breadcrumb[-1][:id].split('::').length
+      dir_depth = '' if dir_depth.nil?
 
       preview_path = topic.preview_path(distro.id,branch_config.dir)
       topic_publish_url = topic.topic_publish_url(distro.site.url,branch_config.dir)
@@ -508,10 +505,10 @@ module AsciiBinder
         :group_id          => group_id,
         :subgroup_id       => subgroup_id,
         :topic_id          => topic_id,
-        :css_path          => "../../#{dir_depth}#{branch_config.dir}/#{STYLESHEET_DIRNAME}/",
-        :javascripts_path  => "../../#{dir_depth}#{branch_config.dir}/#{JAVASCRIPT_DIRNAME}/",
-        :images_path       => "../../#{dir_depth}#{branch_config.dir}/#{IMAGE_DIRNAME}/",
-        :site_home_path    => "../../#{dir_depth}index.html",
+        :css_path          => "#{dir_depth}#{branch_config.dir}/#{STYLESHEET_DIRNAME}/",
+        :javascripts_path  => "#{dir_depth}#{branch_config.dir}/#{JAVASCRIPT_DIRNAME}/",
+        :images_path       => "#{dir_depth}#{branch_config.dir}/#{IMAGE_DIRNAME}/",
+        :site_home_path    => "#{dir_depth}index.html",
         :template_path     => template_dir,
         :repo_path         => topic.repo_path,
       }

data/lib/ascii_binder/helpers.rb

@@ -54,6 +54,10 @@ module AsciiBinder
       AsciiBinder::DOCS_ROOT_DIR
     end
 
+    def set_depth(user_depth)
+      AsciiBinder.const_set("DEPTH", user_depth)
+    end
+
     def set_log_level(user_log_level)
       AsciiBinder.const_set("LOG_LEVEL", log_levels[user_log_level])
     end

data/lib/ascii_binder/topic_entity.rb

@@ -239,12 +239,8 @@ module AsciiBinder
         end
       end
 
-      # Check the depth. For now, max depth is '2':
-      #
-      # [<group>,<subgroup>,<topic>]
-      #
-      # But this limit will be lifted in the next major version
-      if depth > 2
+      # Check the depth.
+      if (depth > AsciiBinder::DEPTH) and (AsciiBinder::DEPTH != 0)
         if verbose
           errors << "#{entity_id} exceeds the maximum nested depth."
         else

data/lib/ascii_binder/version.rb

@@ -1,3 +1,3 @@
 module AsciiBinder
-  VERSION = "0.1.14"
+  VERSION = "0.2.0"
 end

data/templates/_templates/_breadcrumb.html.erb

@@ -0,0 +1,14 @@
+<%- navigation.each do |topic_group| -%>
+  <%- if topic_id.start_with?(topic_group[:id]) %>
+    <li class="hidden-xs active">
+      <%- if topic_group.has_key?(:topics) -%>
+        <a href="<%= subtopic_shim %><%= topic_group[:path] %>"><%= topic_group[:name] %></a>
+      <%- else -%>
+        <%= topic_group[:name] %>
+      <%- end -%>
+    </li>
+  <%- end -%>
+  <%- if topic_group.has_key?(:topics) -%>
+    <%= render("_templates/_breadcrumb.html.erb", :navigation => topic_group[:topics], :topic_id => topic_id, :subtopic_shim => subtopic_shim) %>
+  <%- end -%>
+<%- end -%>

data/templates/_templates/_nav.html.erb

@@ -1,31 +1,14 @@
-<ul class="nav nav-sidebar">
-  <%- navigation.each.with_index do |topic_group, groupidx| -%>
-    <%- current_group = topic_group[:id] == group_id -%>
+<%- navigation.each do |topic_group| -%>
+  <%- if not topic_group.has_key?(:topics) -%>
+      <li><a class="<%= topic_id.start_with?(topic_group[:id]) ? ' active' : '' %>" href="<%= subtopic_shim %><%= topic_group[:path] %>"><%= topic_group[:name] %></a></li>
+  <%- else -%>
     <li class="nav-header">
-      <a class="" href="#" data-toggle="collapse" data-target="#topicGroup<%= groupidx %>">
-        <span id="tgSpan<%= groupidx %>" class="fa <%= current_group ? 'fa-angle-down' : 'fa-angle-right' %>"></span><%= topic_group[:name] %>
+      <a class="" href="#" data-toggle="collapse" data-target="#topicGroup-<%= topic_group[:id].hash %>">
+        <span id="sgSpan-<%= topic_group[:id].hash %>" class="fa <%= topic_id.start_with?(topic_group[:id]) ? 'fa-caret-down' : 'fa-caret-right' %>"></span>&nbsp;<%= topic_group[:name] %>
       </a>
-      <ul id="topicGroup<%= groupidx %>" class="collapse <%= current_group ? 'in' : '' %> list-unstyled">
-        <%- topic_group[:topics].each.with_index do |topic, topicidx| -%>
-          <%- if not topic.has_key?(:topics) -%>
-            <%- current_topic = current_group && (topic[:id] == topic_id) -%>
-            <li><a class="<%= current_topic ? ' active' : '' %>" href="<%= subtopic_shim %><%= topic[:path] %>"><%= topic[:name] %></a></li>
-          <%- else -%>
-            <%- current_subgroup = topic[:id] == subgroup_id -%>
-            <li class="nav-header">
-              <a class="" href="#" data-toggle="collapse" data-target="#topicSubGroup-<%= groupidx %>-<%= topicidx %>">
-                <span id="sgSpan-<%= groupidx %>-<%= topicidx %>" class="fa <%= current_subgroup ? 'fa-caret-down' : 'fa-caret-right' %>"></span>&nbsp;<%= topic[:name] %>
-              </a>
-              <ul id="topicSubGroup-<%= groupidx %>-<%= topicidx %>" class="nav-tertiary list-unstyled collapse<%= current_subgroup ? ' in' : '' %>">
-                <%- topic[:topics].each do |subtopic| -%>
-                  <%- current_subtopic = current_group && current_subgroup && (subtopic[:id] == topic_id) %>
-                  <li><a class="<%= current_subtopic ? ' active' : '' %>" href="<%= subtopic_shim %><%= subtopic[:path] %>"><%= subtopic[:name] %></a></li>
-                <%- end -%>
-              </ul>
-            </li>
-          <%- end -%>
-        <%- end -%>
-      </ul>
+    <ul id="topicGroup-<%= topic_group[:id].hash %>" class="collapse <%= topic_id.start_with?(topic_group[:id]) ? 'in' : '' %> list-unstyled">
+      <%= render("_templates/_nav.html.erb", :navigation => topic_group[:topics], :topic_id => topic_id, :subtopic_shim => subtopic_shim) %>
+    </ul>
     </li>
   <%- end -%>
-</ul>
+<%- end -%>

data/templates/_templates/_title.html.erb

@@ -0,0 +1,8 @@
+<%- navigation.each do |topic_group| -%>
+  <%- if topic_id.start_with?(topic_group[:id]) %>
+    | <%= topic_group[:name] %>
+  <%- end -%>
+  <%- if topic_group.has_key?(:topics) -%>
+    <%= render("_templates/_title.html.erb", :navigation => topic_group[:topics], :topic_id => topic_id) %>
+  <%- end -%>
+<%- end -%>

data/templates/_templates/page.html.erb

@@ -4,7 +4,9 @@
   <meta charset="utf-8">
   <meta content="IE=edge" http-equiv="X-UA-Compatible">
   <meta content="width=device-width, initial-scale=1.0" name="viewport">
-  <title><%= distro %> <%= version %> | <%= [group_title, subgroup_title, topic_title].compact.join(' | ') %></title>
+  <title><%= distro %> <%= version %>
+      <%= render("_templates/_title.html.erb", :navigation => navigation, :topic_id => topic_id) %>
+  </title>
 
   <!-- Bootstrap -->
   <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
@@ -39,20 +41,13 @@
       <li class="sitename">
         <a href="<%= site_home_path %>"><%= site_name %></a>
       </li>
-      <li class="hidden-xs active">
-        <%= breadcrumb_root %>
-      </li>
-      <li class="hidden-xs active">
-        <%= breadcrumb_group %>
-      </li>
-      <%= breadcrumb_subgroup_block %>
-      <li class="hidden-xs active">
-        <%= breadcrumb_topic %>
-      </li>
+      <%= render("_templates/_breadcrumb.html.erb", :navigation => navigation, :topic_id => topic_id, :subtopic_shim => subtopic_shim) %>
     </ol>
     <div class="row row-offcanvas row-offcanvas-left">
       <div class="col-xs-8 col-sm-3 col-md-3 sidebar sidebar-offcanvas">
-        <%= render("_templates/_nav.html.erb", :navigation => navigation, :group_id => group_id, :topic_id => topic_id, :subgroup_id => subgroup_id, :subtopic_shim => subtopic_shim) %>
+        <ul class="nav nav-sidebar">
+          <%= render("_templates/_nav.html.erb", :navigation => navigation, :topic_id => topic_id, :subtopic_shim => subtopic_shim) %>
+        </ul>
       </div>
       <div class="col-xs-12 col-sm-9 col-md-9 main">
         <div class="page-header">

metadata

@@ -1,32 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.2.0
 platform: ruby
 authors:
 - N. Harrison Ripps
 - Jason Frey
 - Carlos Munoz
 - Brian Exelbierd
+- Vikram Goyal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -61,42 +62,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 2.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 2.0.10
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: 3.18.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -187,14 +202,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.0.1
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +259,7 @@ email:
 - jfrey@redhat.com
 - chavo16@hotmail.com
 - bex@pobox.com
+- vigoyal@redhat.com
 executables:
 - ascii_binder
 - asciibinder
@@ -323,13 +339,15 @@ files:
 - templates/_javascripts/.gitkeep
 - templates/_javascripts/bootstrap-offcanvas.js
 - templates/_stylesheets/asciibinder.css
+- templates/_templates/_breadcrumb.html.erb
 - templates/_templates/_css.html.erb
 - templates/_templates/_nav.html.erb
+- templates/_templates/_title.html.erb
 - templates/_templates/page.html.erb
 - templates/_topic_map.yml
 - templates/index-main.html
 - templates/welcome/index.adoc
-homepage: http://asciibinder.org/
+homepage: https://github.com/redhataccess/ascii_binder
 licenses:
 - MIT
 metadata: {}
@@ -348,8 +366,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: AsciiBinder is an AsciiDoc-based system for authoring and publishing closely