ascii_binder 0.2.3 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea737534633232eae04d4210d6898488aa16833da1b6e0300ee7bd5a343bcdad
-  data.tar.gz: 6b14f4acc528b4bfb7d3170c0b80831ffb8475f7c8a7f5f41f9fb0aa78ef3ff1
+  metadata.gz: 26f9de41f109228dfa1478976e8d1b8f08a178300d092e3250dcca610e4e70b6
+  data.tar.gz: 4cf902ff6c38a7a9ce622cdfaef927ed3943c750bcf71051a0bf00d430fce603
 SHA512:
-  metadata.gz: ff840bec755cf9124dfc6c16845b92ac2af3cb3bebd6fe812adae4b1888b2bb31af577d797f41f326c3511b79dd4f5f1f80e06b133e000167c8b50c137384573
-  data.tar.gz: 74c3b5c8e7c03073473987bba0607974299fd3e243c292e7e6c4371a6c8e0d9c5c71664574ac820c63c51aeb6d9af8f1d95bfa46165cd755606b326542efd4d7
+  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

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
+
+      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
-        log_warn("'#{BUILD_FILENAME}' is a deprecated filename. Rename this to '#{TOPIC_MAP_FILENAME}'.")
+
+        t = tf.path
       end
-      topic_file
+
+      # returns the path to the final file
+      t
+
     end
 
     def topic_map
@@ -467,7 +499,7 @@ module AsciiBinder
 
         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

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/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.3"
+  VERSION = "1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '1.0'
 platform: ruby
 authors:
 - N. Harrison Ripps
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler