ascii_binder 0.2.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c935f5c56bc709a5a8029622f7ffce6afb66018806e02c1b08e683c65d90849
-  data.tar.gz: 115f035401017e838117d4fa446d3715bb6913aacf9276894c1bebf6cbe59278
+  metadata.gz: 63f08f84ab342165234ea73cf2b25d443b5a4962cdeea861a7f0080b6322153c
+  data.tar.gz: ed6d54234440073f2721ea648d8b1f045cf34d1bf3a2444f93d2ea47b36256e2
 SHA512:
-  metadata.gz: ca4f6bb99b3db8d89d093797f78e0a53b57cfb3c6ec23451f868391360f758079f2bfeb20560f0347ab2ddf9b75d9ebe2efc42c208c4c60b0e3a34b6251a933a
-  data.tar.gz: 8b788a889bad12e435cb08f7b3bd6e771e1a0fd5d1866ac2c5f0cfa2d6f82ff9deadf4741cae18e01f2c411581015a0d9eb4a73aaa186c0850682f3261edc61b
+  metadata.gz: 00435a0b0ed5ff4c32aef83030793be785eb8ade1112f47ca6279be17cc0701b8b46ae0f0f5fcb05b9bc74e1f10d30aeed6529f94baa0a029765402f1e413ac7
+  data.tar.gz: cb56f37d5ab0eae8da6f48a0b68f490429dd7bac79ad529057c85893ac5cf91b53aec6c26b4e8e1d42848f0ed4e7561211529de80d4f562cfda1fdc5fdcc6551

data/Dockerfile

@@ -1,7 +1,7 @@
-FROM centos/ruby-22-centos7
+FROM centos/ruby-23-centos7
 
-RUN scl enable rh-ruby22 -- gem install listen -v 3.0.8
-RUN scl enable rh-ruby22 -- gem install ascii_binder
+RUN scl enable rh-ruby23 -- gem install listen -v 3.0.8
+RUN scl enable rh-ruby23 -- gem install ascii_binder
 USER root
 RUN yum install -y java-1.7.0-openjdk && \
     yum clean all

data/ascii_binder.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json'
   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 "yajl-ruby", ">= 1.4.2"
   spec.add_dependency 'tilt'
 
 end

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
@@ -300,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
@@ -270,7 +302,7 @@ module AsciiBinder
           log_unknown("Building only the #{distro_map.get_distro(build_distro).name} distribution.")
         end
       elsif single_page.nil?
-        log_unknown("Building all distributions.")
+        log_unknown("Building every distribution.")
       end
 
       # Notify the user of missing local branches

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.2"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.1
 platform: ruby
 authors:
 - N. Harrison Ripps
@@ -9,10 +9,10 @@ authors:
 - Carlos Munoz
 - Brian Exelbierd
 - Vikram Goyal
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -228,16 +228,16 @@ dependencies:
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -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.2.3
-signing_key:
+rubygems_version: 3.0.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.