ascii_binder 0.2.0 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f0c681a484a802db17a50ebbbd8813c8398d4d79cf7b6f91a53cdfb1f460a4
-  data.tar.gz: fdf32199cf71677ae3ca7ff5b8962bde144b03f07feec8686df567c953c48aed
+  metadata.gz: 26f9de41f109228dfa1478976e8d1b8f08a178300d092e3250dcca610e4e70b6
+  data.tar.gz: 4cf902ff6c38a7a9ce622cdfaef927ed3943c750bcf71051a0bf00d430fce603
 SHA512:
-  metadata.gz: 759f9f9df03df35eaf06e104a62f01aac906860b8e3ee83b3160ea46def33a16a249034482dcbd37007568c75975fd4ea1e33127fc7b2c51e988bf41d2626332
-  data.tar.gz: 6e3d69dc9de3af08151615a57bf501a61501a0c3d1fee5c43c4b4f874861efb131b82f783ea8df7c3a953ff6a06ef0dc4cf4020555842f74093ff3678bc7b7f6
+  metadata.gz: d978b66122655791fcefc86a04741b94940fdfffab86e2ace9dd2454bef63849bda46b8776b90bad9bf7f9a87a7cce42ca4115bb2650fd0ee7836f23ed5ca7cb
+  data.tar.gz: e8b18ebdb1a1fbc8114645692e91342f6d48b8bb42b63f5c763a18550fbf45d7c3cac73c6ebd164910400448e3a0a2babcf0faa51a5cf06e98def1d66f9bae76

data/bin/asciibinder

@@ -31,9 +31,9 @@ def repo_check(docs_basedir)
     end
   end
   # Either of these must be present
-  unless File.exist?(File.join(docs_basedir, '_build_cfg.yml')) or File.exist?(File.join(docs_basedir, '_topic_map.yml'))
-    missing_files = true
-  end
+#  unless File.exist?(File.join("#{docs_basedir}/#{TOPIC_MAP_FOLDER}", '_topic_map.yml'))
+#    missing_files = true
+#  end
   if missing_files or not in_git_repo(docs_basedir)
     Trollop::die "The specified docs base directory '#{docs_basedir}' does not appear to be part of an AsciiBinder-compatible repo."
   end
@@ -183,11 +183,9 @@ Description:
   ...except that the Guardfile automatically detects and runs this as
   you work.
 
-  This is meant to be used in conjunction with a web browser that is
-  running a LiveReload plugin. If you are viewing the output HTML page
-  in a browser where LiveReload is active, then every time you save a
-  new version of the .adoc file, the new HTML is automatically
-  regenerated and your page view is automatically refreshed.
+  This is meant to be used in conjunction with a web browser that is viewing the
+  output HTML page. Every time you save a new version of the .adoc file, you can
+  manually refresh your page to view the newly-generated HTML.
 EOF
       opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
     end
@@ -302,7 +300,7 @@ if cmd == 'clone'
     Dir.chdir(docs_basedir)
     puts "Tracking branch setup:"
     cloned_map.distro_branches.each do |doc_branch|
-      next if doc_branch == 'master'
+      next if doc_branch == 'main'
       puts "- #{doc_branch}"
       system("git branch #{doc_branch} origin/#{doc_branch}")
     end

data/features/support/env.rb

@@ -299,9 +299,9 @@ module Helpers
       end
       system("cd #{working_dir} && git add . > /dev/null && git commit -am 'test commit' > /dev/null")
       if multiple_distros
-        system("cd #{working_dir} && git checkout -b branch1 > /dev/null 2>&1 && git checkout -b branch2 > /dev/null 2>&1 && git checkout master > /dev/null 2>&1")
+        system("cd #{working_dir} && git checkout -b branch1 > /dev/null 2>&1 && git checkout -b branch2 > /dev/null 2>&1 && git checkout main > /dev/null 2>&1")
       end
-      set_initial_working_branch('master')
+      set_initial_working_branch('main')
     end
     working_dir
   end
@@ -325,7 +325,7 @@ module Helpers
     if run_command('create',[],remote_dir)[:status].exitstatus == 0
       clone_map = File.join(gem_root,'features','support','_clone_distro_map.yml')
       FileUtils.cp(clone_map,File.join(remote_dir,'_distro_map.yml'))
-      system("cd #{remote_dir} && git add . > /dev/null && git commit -am 'remote commit' > /dev/null && git checkout -b branch1 > /dev/null 2>&1 && git checkout master > /dev/null 2>&1")
+      system("cd #{remote_dir} && git add . > /dev/null && git commit -am 'remote commit' > /dev/null && git checkout -b branch1 > /dev/null 2>&1 && git checkout main > /dev/null 2>&1")
     else
       puts "ERROR: Could not initialize remote repo"
       exit 1

data/lib/ascii_binder/engine.rb

@@ -78,18 +78,50 @@ module AsciiBinder
 
     # Protip: Don't cache these! The topic map needs to be reread every time we change branches.
     def topic_map_file
+
+      # new stuff 1/Nov/2021
+      # allow users to break up the topic map into multiple topic maps
+      # load topic maps from a single folder called _topic_maps.
+      # we assume that all files in this folder are correctly formatted topic maps. If not, you will get normal asciibinder errors
+      topic_map_folder = TOPIC_MAP_FOLDER
       topic_file = TOPIC_MAP_FILENAME
-      unless File.exist?(File.join(docs_root_dir,topic_file))
-        # The new filename '_topic_map.yml' couldn't be found;
-        # switch to the old one and warn the user.
-        topic_file = BUILD_FILENAME
-        unless File.exist?(File.join(docs_root_dir,topic_file))
-          # Critical error - no topic map file at all.
-          Trollop::die "Could not find any topic map file ('#{TOPIC_MAP_FILENAME}' or '#{BUILD_FILENAME}') at #{docs_root_dir} in branch '#{git.branch}'"
+
+      if !Dir.exist?(File.join(docs_root_dir, topic_map_folder))
+        # if the _topic_maps directory doesn't exist or is empty, see if we can find the topic map in the root folder to maintain backward compatibility
+
+        if !File.exist?(File.join(docs_root_dir, topic_file))
+          # fall back to looking for a _topic_map in the root directory
+
+          topic_file = BUILD_FILENAME # old folders use build_config.yml
+
+          if !File.exist?(File.join(docs_root_dir, topic_file))
+            # Critical error - no topic map file at all.
+            Trollop::die "Could not find a valid topic map file. There is no #{TOPIC_MAP_FOLDER} folder and the fall back files #{TOPIC_MAP_FILENAME} or #{BUILD_FILENAME} in branch '#{git.branch}' were also not found."
+          else
+            t = File.join(docs_root_dir, topic_file) # found build_config
+          end
+        else
+          t = File.join(docs_root_dir, topic_file) # found topic_map in root
         end
-        log_warn("'#{BUILD_FILENAME}' is a deprecated filename. Rename this to '#{TOPIC_MAP_FILENAME}'.")
+
+      else
+
+        # topic map files are in the _topic_maps folder
+
+        # create a combined temp file with all topic maps
+        tf = Tempfile.new("#{TOPIC_MAP_FILENAME}")
+
+        Dir.glob("#{topic_map_folder}/*.yml").each do |filename|
+          lines = IO.read(filename)
+          tf << lines
+        end
+
+        t = tf.path
       end
-      topic_file
+
+      # returns the path to the final file
+      t
+
     end
 
     def topic_map
@@ -451,7 +483,7 @@ module AsciiBinder
 
     def configure_and_generate_page(topic,branch_config,navigation)
       distro = branch_config.distro
-      topic_adoc = File.open(topic.source_path,'r').read
+      # topic_adoc = File.open(topic.source_path,'r').read
 
       page_attrs = asciidoctor_page_attrs([
         "imagesdir=#{File.join(topic.parent.source_path,'images')}",
@@ -459,61 +491,71 @@ module AsciiBinder
         "product-title=#{branch_config.distro_name}",
         "product-version=#{branch_config.name}",
         "product-author=#{branch_config.distro_author}",
-        "repo_path=#{topic.repo_path}"
+        "repo_path=#{topic.repo_path}",
+        "allow-uri-read="
       ])
 
-      doc = without_warnings { Asciidoctor.load topic_adoc, :header_footer => false, :safe => :unsafe, :attributes => page_attrs }
-      article_title = doc.doctitle || topic.name
-
-      topic_html = doc.render
-
-      # This is logic bridges newer arbitrary-depth-tolerant code to
-      # older depth-limited code. Truly removing depth limitations will
-      # require changes to page templates in user docs repos.
-      breadcrumb     = topic.breadcrumb
-      group_title    = breadcrumb[0][:name]
-      group_id       = breadcrumb[0][:id]
-      topic_title    = breadcrumb[-1][:name]
-      topic_id       = breadcrumb[-1][:id]
-      subgroup_title = nil
-      subgroup_id    = nil
-      if breadcrumb.length == 3
-        subgroup_title = breadcrumb[1][:name]
-        subgroup_id    = breadcrumb[1][:id]
-      end
-      dir_depth = '../' * topic.breadcrumb[-1][:id].split('::').length
-      dir_depth = '' if dir_depth.nil?
+      File.open topic.source_path, 'r' do |topic_file|
+
+        doc = without_warnings { Asciidoctor.load topic_file, :header_footer => false, :safe => :unsafe, :attributes => page_attrs, :base_dir => "." }
+        article_title = doc.doctitle || topic.name
+
+        topic_html = doc.render
+
+        # This is logic bridges newer arbitrary-depth-tolerant code to
+        # older depth-limited code. Truly removing depth limitations will
+        # require changes to page templates in user docs repos.
+        breadcrumb     = topic.breadcrumb
+        group_title    = breadcrumb[0][:name]
+        group_id       = breadcrumb[0][:id]
+        topic_title    = breadcrumb[-1][:name]
+        topic_id       = breadcrumb[-1][:id]
+        subgroup_title = nil
+        subgroup_id    = nil
+        if breadcrumb.length == 3
+          subgroup_title = breadcrumb[1][:name]
+          subgroup_id    = breadcrumb[1][:id]
+        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)
+
+        page_args = {
+          :distro_key        => distro.id,
+          :distro            => branch_config.distro_name,
+          :branch            => branch_config.id,
+          :site_name         => distro.site.name,
+          :site_url          => distro.site.url,
+          :topic_url         => preview_path,
+          :topic_publish_url => topic_publish_url,
+          :version           => branch_config.name,
+          :group_title       => group_title,
+          :subgroup_title    => subgroup_title,
+          :topic_title       => topic_title,
+          :article_title     => article_title,
+          :content           => topic_html,
+          :navigation        => navigation,
+          :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",
+          :template_path     => template_dir,
+          :repo_path         => topic.repo_path,
+        }
+        full_file_text = page(page_args)
+
+
+        File.open(preview_path, 'w') { |file| file.write(full_file_text) }
+
+
+        # File.write(preview_path,full_file_text)
 
-      preview_path = topic.preview_path(distro.id,branch_config.dir)
-      topic_publish_url = topic.topic_publish_url(distro.site.url,branch_config.dir)
-
-      page_args = {
-        :distro_key        => distro.id,
-        :distro            => branch_config.distro_name,
-        :branch            => branch_config.id,
-        :site_name         => distro.site.name,
-        :site_url          => distro.site.url,
-        :topic_url         => preview_path,
-        :topic_publish_url => topic_publish_url,
-        :version           => branch_config.name,
-        :group_title       => group_title,
-        :subgroup_title    => subgroup_title,
-        :topic_title       => topic_title,
-        :article_title     => article_title,
-        :content           => topic_html,
-        :navigation        => navigation,
-        :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",
-        :template_path     => template_dir,
-        :repo_path         => topic.repo_path,
-      }
-      full_file_text = page(page_args)
-      File.write(preview_path,full_file_text)
+      end
     end
 
     # package_docs

data/lib/ascii_binder/helpers.rb

@@ -4,6 +4,7 @@ require 'stringio'
 module AsciiBinder
   module Helpers
     BUILD_FILENAME      = '_build_cfg.yml'
+    TOPIC_MAP_FOLDER    = '_topic_maps'
     TOPIC_MAP_FILENAME  = '_topic_map.yml'
     DISTRO_MAP_FILENAME = '_distro_map.yml'
     PREVIEW_DIRNAME     = '_preview'

data/lib/ascii_binder/site_info.rb

@@ -7,7 +7,7 @@ module AsciiBinder
       @name     = distro.site.name
       @url      = distro.site.url
       @distros  = {}
-      @branches = ['master']
+      @branches = ['main']
       add_distro(distro)
     end
 

data/lib/ascii_binder/topic_map.rb

@@ -10,12 +10,13 @@ module AsciiBinder
     attr_reader :list
 
     def initialize(topic_file,distro_keys)
-      @topic_yaml  = YAML.load_stream(open(File.join(docs_root_dir,topic_file)))
+      @topic_yaml  = YAML.load_stream(open(topic_file))
       @distro_keys = distro_keys
       @list        = []
       @topic_yaml.each do |topic_entity|
         @list << AsciiBinder::TopicEntity.new(topic_entity,distro_keys)
       end
+
     end
 
     def filepaths

data/lib/ascii_binder/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '1.0'
 platform: ruby
 authors:
 - N. Harrison Ripps
@@ -9,10 +9,10 @@ authors:
 - Carlos Munoz
 - Brian Exelbierd
 - Vikram Goyal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-14 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -351,7 +351,7 @@ homepage: https://github.com/redhataccess/ascii_binder
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -366,8 +366,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: AsciiBinder is an AsciiDoc-based system for authoring and publishing closely
   related documentation sets from a single source.