ascii_binder 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53fd1820d7812317c08e7b9f6546b218a6e4f446
-  data.tar.gz: 43dc2c310ecaadd51d3ff32b63b07a6c63eba03f
+  metadata.gz: 9a1c17e7e823c6e76b3bfd18786cc3a4c4d097a2
+  data.tar.gz: b667bd45eb3b75101bfceaf998ad90df7980dfa2
 SHA512:
-  metadata.gz: 26b8c93816f4b5b0a5b80862448dd18cdc9acb79e464ee7c5655e5cc14c506e5c53c32356bd2e87344d0e390433148ec0f7458733711868d31a9dbce8439a78c
-  data.tar.gz: a1ea94b2f4dd024146b9809fdb040d7c681bc7ed93bdc22e7a33f9a0c8b056ef4aad254e15e6452398bc8e8abdc1d9ff48e90eb1ad945da28b56f88c8aaa39be
+  metadata.gz: 31c88dba1a43101330cab85e0acac0fe26fe50e60d2d8aa814e1ba3cd0e8707180c1259be0ebdc047ea0765c78416c7b9d4236288bb9e664ea2febf3c091b79d
+  data.tar.gz: 800c57816abf2fa0d9fb106f9789ed84f6142ef9b52b66d97713bf4c9fc2ffcc4dae5c1c2eaebe394da97f3af18d9c62ea1c79e598e5ff904ee06512e0281c09

data/bin/asciibinder

@@ -131,6 +131,7 @@ EOF
       opt :all_branches, "Instead of building only the current working branch, build all branches", :default => false
       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'
       conflicts :distro, :page
     end
   when "create"
@@ -159,6 +160,7 @@ Options:
 EOF
       opt :branches, "Create tracking branches after cloning.", :default => true
       opt :dir, "Specify the pathname of the local directory for cloning.", :default => ''
+      opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
     end
   when "watch"
     Trollop::options do
@@ -185,6 +187,7 @@ Description:
   new version of the .adoc file, the new HTML is automatically
   regenerated and your page view is automatically refreshed.
 EOF
+      opt :log_level, "Set the logging output level for this operation.", :default => 'warn'
     end
   when "package"
     Trollop::options do
@@ -202,6 +205,7 @@ Description:
 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'
     end
   when "help"
     Trollop::educate
@@ -259,6 +263,17 @@ end
 # Set the repo root
 set_docs_root_dir(File.expand_path(docs_basedir))
 
+# Set the log level
+user_log_level = :warn
+unless cmd_opts.nil? or cmd_opts[:log_level].nil?
+  user_log_level = cmd_opts[:log_level].to_sym
+  unless log_levels.has_key?(user_log_level)
+    Trollop::die "log_level value '#{cmd_opts[:log_level]}' is not recognized. Legal values are " + log_levels.keys.map{ |lvl| "'#{lvl.to_s}'" }.join(', ')
+  end
+end
+set_log_level(user_log_level)
+
+
 # Cloning? Time to try it.
 if cmd == 'clone'
   puts "Cloning #{cmd_opts[:giturl]} to #{docs_basedir}"

data/lib/ascii_binder/engine.rb

@@ -10,7 +10,6 @@ require 'asciidoctor-diagram'
 require 'fileutils'
 require 'find'
 require 'git'
-require 'logger'
 require 'pandoc-ruby'
 require 'pathname'
 require 'sitemap_generator'
@@ -26,22 +25,6 @@ module AsciiBinder
       Time.now.utc
     end
 
-    def notice(hey,message,newline = false)
-      # TODO: (maybe) redirect everything to stderr
-      if newline
-        puts "\n"
-      end
-      puts "#{hey}: #{message}"
-    end
-
-    def warning(message,newline = false)
-      notice("WARNING",message,newline)
-    end
-
-    def nl_warning(message)
-      warning(message,true)
-    end
-
     def git
       @git ||= Git.open(git_root_dir)
     end
@@ -57,18 +40,18 @@ module AsciiBinder
       # See if there are any changes in need of stashing
       @stash_needed = `cd #{git_root_dir} && git status --porcelain` !~ /^\s*$/
       if @stash_needed
-        puts "\nNOTICE: Stashing uncommited changes and files in working branch."
+        log_unknown("Stashing uncommited changes and files in working branch.")
         `cd #{docs_root_dir} && git stash -u`
       end
     end
 
     def git_apply_and_drop
       return unless @stash_needed
-      puts "\nNOTE: Re-applying uncommitted changes and files to working branch."
+      log_unknown("Re-applying uncommitted changes and files to working branch.")
       if system("cd #{docs_root_dir} && git stash pop")
-        puts "NOTE: Stash application successful."
+        log_unknown("Stash application successful.")
       else
-        puts "ERROR: Could not apply stashed code. Run `git stash apply` manually."
+        log_error("Could not apply stashed code. Run `git stash apply` manually.")
       end
       @stash_needed = false
     end
@@ -105,7 +88,7 @@ module AsciiBinder
           # 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}'"
         end
-        warning "'#{BUILD_FILENAME}' is a deprecated filename. Rename this to '#{TOPIC_MAP_FILENAME}'."
+        log_warn("'#{BUILD_FILENAME}' is a deprecated filename. Rename this to '#{TOPIC_MAP_FILENAME}'.")
       end
       topic_file
     end
@@ -151,10 +134,7 @@ module AsciiBinder
         next if src_path.split('/').length < 3
         file_list << src_path
       end
-      file_list.map{ |path|
-        parts = path.split('/').slice(1..-1);
-        parts.slice(0..-2).join('/') + '/' + parts[-1].split('.')[0]
-      }
+      file_list.map{ |path| File.join(File.dirname(path),File.basename(path,'.adoc')) }
     end
 
     def remove_found_topic_files(branch,branch_topic_map,branch_topic_files)
@@ -166,7 +146,11 @@ module AsciiBinder
         end
       end
       if nonexistent_topics.length > 0
-        nl_warning "The #{topic_map_file} file on branch '#{branch}' references nonexistent topics:\n" + nonexistent_topics.map{ |topic| "- #{topic}" }.join("\n")
+        if AsciiBinder::LOG_LEVEL > log_levels[:debug]
+          log_warn("The #{topic_map_file} file on branch '#{branch}' references #{nonexistent_topics.length} nonexistent topics. Set logging to 'debug' for details.")
+        else
+          log_warn("The #{topic_map_file} file on branch '#{branch}' references nonexistent topics:\n" + nonexistent_topics.map{ |topic| "- #{topic}" }.join("\n"))
+        end
       end
     end
 
@@ -277,17 +261,17 @@ module AsciiBinder
       if not single_page.nil?
         single_page_path = single_page.split(':')[0].split('/')
         single_page_path << single_page.split(':')[1]
-        puts "Rebuilding '#{single_page_path.join('/')}' on branch '#{working_branch}'."
+        log_unknown("Rebuilding '#{single_page_path.join('/')}' on branch '#{working_branch}'.")
       end
 
       if not build_distro == ''
         if not distro_map.include_distro_key?(build_distro)
           exit
         else
-          puts "Building only the #{distro_map.get_distro(build_distro).name} distribution."
+          log_unknown("Building only the #{distro_map.get_distro(build_distro).name} distribution.")
         end
       elsif single_page.nil?
-        puts "Building all distributions."
+        log_unknown("Building all distributions.")
       end
 
       # Notify the user of missing local branches
@@ -297,11 +281,12 @@ module AsciiBinder
         missing_branches << dbranch
       end
       if missing_branches.length > 0 and single_page.nil?
-        puts "\nNOTE: The following branches do not exist in your local git repo:"
+        message = "The following branches do not exist in your local git repo:\n"
         missing_branches.each do |mbranch|
-          puts "- #{mbranch}"
+          message << "- #{mbranch}\n"
         end
-        puts "The build will proceed but these branches will not be generated."
+        message << "The build will proceed but these branches will not be generated."
+        log_warn(message)
       end
 
       # Generate all distros for all branches in the indicated branch group
@@ -313,7 +298,7 @@ module AsciiBinder
         if not local_branch == working_branch
           if single_page.nil?
             # Checkout the branch
-            puts "\nCHANGING TO BRANCH '#{local_branch}'"
+            log_unknown("CHANGING TO BRANCH '#{local_branch}'")
             git_checkout(local_branch)
           else
             next
@@ -337,7 +322,11 @@ module AsciiBinder
         remove_found_topic_files(local_branch,branch_topic_map,branch_orphan_files)
 
         if branch_orphan_files.length > 0 and single_page.nil?
-          nl_warning "Branch '#{local_branch}' includes the following .adoc files that are not referenced in the #{topic_map_file} file:\n" + branch_orphan_files.map{ |file| "- #{file}" }.join("\n")
+          if AsciiBinder::LOG_LEVEL > log_levels[:debug]
+            log_warn("Branch #{local_branch} includes #{branch_orphan_files.length} files that are not referenced in the #{topic_map_file} file. Set logging to 'debug' for details.")
+          else
+            log_warn("Branch '#{local_branch}' includes the following .adoc files that are not referenced in the #{topic_map_file} file:\n" + branch_orphan_files.map{ |file| "- #{file}" }.join("\n"))
+          end
         end
 
         # Run all distros.
@@ -368,7 +357,7 @@ module AsciiBinder
           end
 
           if first_branch
-            puts "\nBuilding #{distro.name} for branch '#{local_branch}'"
+            log_unknown("Building #{distro.name} for branch '#{local_branch}'")
             first_branch = false
           end
 
@@ -401,7 +390,7 @@ module AsciiBinder
         # Remove DITAA-generated images
         ditaa_image_files = Find.find(docs_root_dir).select{ |path| not path.nil? and not (path =~ /_preview/ or path =~ /_package/) and (path =~ /.*\.png$/ or path =~ /.*\.png\.cache$/) and not branch_image_files.include?(path) }
         if not ditaa_image_files.empty?
-          puts "\nRemoving ditaa-generated files from repo before changing branches."
+          log_unknown("Removing ditaa-generated files from repo before changing branches.")
           ditaa_image_files.each do |dfile|
             File.unlink(dfile)
           end
@@ -419,7 +408,7 @@ module AsciiBinder
       # If necessary, restore temporarily stashed files
       git_apply_and_drop
 
-      puts "\nAll builds completed."
+      log_unknown("All builds completed.")
     end
 
     def process_topic_entity_list(branch_config,single_page_path,navigation,topic_entity_list,preview_path='')
@@ -434,13 +423,17 @@ module AsciiBinder
           preview_path = topic_entity.preview_path(branch_config.distro.id,branch_config.dir)
           process_topic_entity_list(branch_config,single_page_path,navigation,topic_entity.subitems,preview_path)
         elsif topic_entity.is_topic?
-          if single_page_path.length == 0
-            puts "  - #{topic_entity.repo_path}"
-          end
           if topic_entity.is_alias?
             configure_and_generate_alias(topic_entity,branch_config)
           else
-            configure_and_generate_page(topic_entity,branch_config,navigation)
+            if File.exists?(topic_entity.source_path)
+              if single_page_path.length == 0
+                log_info("  - #{topic_entity.repo_path}")
+              end
+              configure_and_generate_page(topic_entity,branch_config,navigation)
+            else
+              log_warn("  - #{topic_entity.repo_path} <= Skipping nonexistent file")
+            end
           end
         end
       end
@@ -470,7 +463,7 @@ module AsciiBinder
         "repo_path=#{topic.repo_path}"
       ])
 
-      doc = Asciidoctor.load topic_adoc, :header_footer => false, :safe => :unsafe, :attributes => page_attrs
+      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
@@ -547,7 +540,7 @@ module AsciiBinder
           end
           site_dir = File.join(package_dir,site.id)
           if File.directory?(site_dir)
-            puts "\nPackaging #{distro_id} for #{site.id} site."
+            log_unknown("Packaging #{distro_id} for #{site.id} site.")
 
             # Any files in the root of the docs repo with names ending in:
             #     *-#{site}.html
@@ -591,7 +584,7 @@ module AsciiBinder
 
     def clean_up
       if not system("rm -rf #{docs_root_dir}/_preview/* #{docs_root_dir}/_package/*")
-        puts "Nothing to clean."
+        log_unknown("Nothing to clean.")
       end
     end
   end

data/lib/ascii_binder/helpers.rb

@@ -1,3 +1,6 @@
+require 'logger'
+require 'stringio'
+
 module AsciiBinder
   module Helpers
     BUILD_FILENAME      = '_build_cfg.yml'
@@ -51,6 +54,72 @@ module AsciiBinder
       AsciiBinder::DOCS_ROOT_DIR
     end
 
+    def set_log_level(user_log_level)
+      AsciiBinder.const_set("LOG_LEVEL", log_levels[user_log_level])
+    end
+
+    def log_levels
+      @log_levels ||= {
+        :debug => Logger::DEBUG.to_i,
+        :error => Logger::ERROR.to_i,
+        :fatal => Logger::FATAL.to_i,
+        :info  => Logger::INFO.to_i,
+        :warn  => Logger::WARN.to_i,
+      }
+    end
+
+    def logerr
+      @logerr ||= begin
+        logger = Logger.new(STDERR, level: AsciiBinder::LOG_LEVEL)
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          "#{severity}: #{msg}\n"
+        end
+        logger
+      end
+    end
+
+    def logstd
+      @logstd ||= begin
+        logger = Logger.new(STDOUT, level: AsciiBinder::LOG_LEVEL)
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          severity == 'ANY' ? "#{msg}\n" : "#{severity}: #{msg}\n"
+        end
+        logger
+      end
+    end
+
+    def log_info(text)
+      logstd.info(text)
+    end
+
+    def log_warn(text)
+      logstd.warn(text)
+    end
+
+    def log_error(text)
+      logerr.error(text)
+    end
+
+    def log_fatal(text)
+      logerr.fatal(text)
+    end
+
+    def log_debug(text)
+      logstd.debug(text)
+    end
+
+    def log_unknown(text)
+      logstd.unknown(text)
+    end
+
+    def without_warnings
+      verboseness_level = $VERBOSE
+      $VERBOSE = nil
+      yield
+    ensure
+      $VERBOSE = verboseness_level
+    end
+
     def template_renderer
       @template_renderer ||= TemplateRenderer.new(docs_root_dir, template_dir)
     end

data/lib/ascii_binder/tasks/tasks.rb

@@ -9,6 +9,7 @@ task :build, :build_distro do |task,args|
   # Figure out which distros we are building.
   # A blank value here == all distros
   set_docs_root_dir(git_root_dir)
+  set_log_level(:warn)
   build_distro = args[:build_distro] || ''
   generate_docs(:all,build_distro,nil)
 end
@@ -16,6 +17,7 @@ end
 desc "Package the documentation"
 task :package, :package_site do |task,args|
   set_docs_root_dir(git_root_dir)
+  set_log_level(:warn)
   package_site = args[:package_site] || ''
   Rake::Task["clean"].invoke
   Rake::Task["build"].invoke
@@ -25,6 +27,7 @@ end
 desc "Build the documentation and refresh the page"
 task :refresh_page, :single_page do |task,args|
   set_docs_root_dir(git_root_dir)
+  set_log_level(:warn)
   generate_docs(:working_only,'',args[:single_page])
 end
 

data/lib/ascii_binder/version.rb

@@ -1,3 +1,3 @@
 module AsciiBinder
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ascii_binder
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - N. Harrison Ripps
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler