giblish 0.7.5 → 0.8.2

data/lib/giblish/cmdline.rb

@@ -8,11 +8,11 @@ require_relative "version"
 class CmdLineParser
   attr_accessor :args
 
-  USAGE = <<~ENDUSAGE.freeze
+  USAGE = <<~ENDUSAGE
     Usage:
       giblish [options] source_dir_top dest_dir_top
   ENDUSAGE
-  HELP = <<ENDHELP.freeze
+  HELP = <<ENDHELP
  Options:
   -h --help                  show this help text
   -v --version               show version nr and exit
@@ -20,7 +20,7 @@ class CmdLineParser
                              *html* is used if -f is not supplied
   -n --no-build-ref          suppress generation of a reference document at the destination
                              tree root.
-  --index-basename           set the name of the generated index file (default 'index').  
+  --index-basename           set the name of the generated index file (default 'index').
   -r --resource-dir <dir>    specify a directory where fonts, themes, css and other
                              central stuff needed for document generation are located.
                              The resources are expected to be located in a subfolder
@@ -30,7 +30,7 @@ class CmdLineParser
   -s --style <name>          The style information used when converting the documents
                              using the -r option for specifying resource directories.
                              For html this is a name of a css file, for pdf, this is
-                             the name of an yml file. You can specify only the 
+                             the name of an yml file. You can specify only the
                              basename of the file and giblish will use the suffix
                              associated with the output format (i.e specify 'mystyle'
                              and the mystyle.css and mystyle.yml will be used for html
@@ -38,20 +38,20 @@ class CmdLineParser
   -i --include <regexp>      include only files with a path that matches the supplied
                              regexp (defaults to '.*\.(?i)adoc$' meaning it matches all
                              files ending in .adoc case-insensitive). The matching is made
-                             on the full path (i.e. the regex '^.*my.*' matches the path 
+                             on the full path (i.e. the regex '^.*my.*' matches the path
                              /my/file.adoc).
   -j --exclude <regexp>      exclude files with a path that matches the supplied
                              regexp (no files are excluded by default). The matching is made
-                             on the full path (i.e. the regex '^.*my.*' matches the path 
+                             on the full path (i.e. the regex '^.*my.*' matches the path
                              /my/file.adoc).
   -w --web-path <path>       Specifies the URL path to where the generated html documents
                              will be deployed (only needed when serving the html docs via
                              a web server).
                              E.g.
-                             If the docs are deployed to 'www.example.com/site_1/blah', 
+                             If the docs are deployed to 'www.example.com/site_1/blah',
                              this flag shall be set to '/site_1/blah'. This switch is only
                              used when generating html. giblish use this to link the deployed
-                             html docs with the correct stylesheet. 
+                             html docs with the correct stylesheet.
   -g --git-branches <regExp> if the source_dir_top is located within a git repo,
                              generate docs for all _remote branches on origin_ that matches
                              the given regular expression. Each git branch will
@@ -69,10 +69,10 @@ class CmdLineParser
                              a separate subdir under the destination root dir.
   -c --local-only            do not try to fetch git info from any remotes of
                              the repo before generating documents.
-  -a --attribute <key>=<value> set a document or asciidoctor attribute. 
-                             The contents of this flag is passed directly to the 
-                             underlying asciidoctor tool, for details above the 
-                             syntax and available attributes, see the documentation for 
+  -a --attribute <key>=<value> set a document or asciidoctor attribute.
+                             The contents of this flag is passed directly to the
+                             underlying asciidoctor tool, for details above the
+                             syntax and available attributes, see the documentation for
                              asciidoctor. This option can be specified more than once.
   -d --resolve-docid         use two passes, the first to collect :docid:
                              attributes in the doc headers, the second to
@@ -107,9 +107,9 @@ class CmdLineParser
                              Set this to the file system path where the generated html
                              docs will be deployed (if different from dst_dir_top):
                              E.g.
-                             If the generated html docs will be deployed to the folder 
+                             If the generated html docs will be deployed to the folder
                              '/var/www/mysite/blah/mydocs,'
-                             this is what you shall set the path to. 
+                             this is what you shall set the path to.
   --log-level                set the log level explicitly. Must be one of
                              debug, info (default), warn, error or fatal.
 ENDHELP
@@ -144,15 +144,15 @@ ENDHELP
   def set_log_level
     log_level = @args[:logLevel] || "info"
     case log_level
-      when "debug" then Giblog.logger.sev_threshold = Logger::DEBUG
-      when "info"  then Giblog.logger.sev_threshold = Logger::INFO
-      when "warn"  then Giblog.logger.sev_threshold = Logger::WARN
-      when "error" then Giblog.logger.sev_threshold = Logger::ERROR
-      when "fatal" then Giblog.logger.sev_threshold = Logger::FATAL
-      else
-        puts "Invalid log level specified. Run with -h to see supported levels"
-        puts USAGE
-        exit 1
+    when "debug" then Giblog.logger.sev_threshold = Logger::DEBUG
+    when "info"  then Giblog.logger.sev_threshold = Logger::INFO
+    when "warn"  then Giblog.logger.sev_threshold = Logger::WARN
+    when "error" then Giblog.logger.sev_threshold = Logger::ERROR
+    when "fatal" then Giblog.logger.sev_threshold = Logger::FATAL
+    else
+      puts "Invalid log level specified. Run with -h to see supported levels"
+      puts USAGE
+      exit 1
     end
   end
 
@@ -164,21 +164,21 @@ ENDHELP
   def parse_cmdline(cmdline_args)
     # default values for cmd line switches
     @args = {
-        help: false,
-        version: false,
-        force: true,
-        format: "html",
-        # note that the single quotes are important for the regexp
-        includeRegexp: '.*\.(?i)adoc$',
-        excludeRegexp: nil,
-        flatten: false,
-        suppressBuildRef: false,
-        indexBaseName: "index",
-        localRepoOnly: false,
-        resolveDocid: false,
-        makeSearchable: false,
-        searchAssetsDeploy: nil,
-        webPath: nil
+      help: false,
+      version: false,
+      force: true,
+      format: "html",
+      # note that the single quotes are important for the regexp
+      includeRegexp: '.*\.(?i)adoc$',
+      excludeRegexp: nil,
+      flatten: false,
+      suppressBuildRef: false,
+      indexBaseName: "index",
+      localRepoOnly: false,
+      resolveDocid: false,
+      makeSearchable: false,
+      searchAssetsDeploy: nil,
+      webPath: nil
     }
 
     # set default log level
@@ -191,35 +191,35 @@ ENDHELP
     next_arg = unflagged_args.first
     cmdline_args.each do |arg|
       case arg
-        when "-h", "--help"         then @args[:help]      = true
-        when "-v", "--version"      then @args[:version]   = true
-        when "-f", "--format   "    then next_arg = :format
-        when "-r", "--resource-dir" then next_arg = :resourceDir
-        when "-n", "--no-build-ref" then @args[:suppressBuildRef] = true
-        when "--index-basename"     then next_arg = :indexBaseName
-        when "-i", "--include"      then next_arg = :includeRegexp
-        when "-j", "--exclude"      then next_arg = :excludeRegexp
-        when "-g", "--git-branches" then next_arg = :gitBranchRegexp
-        when "-t", "--git-tags"     then next_arg = :gitTagRegexp
-        when "-c", "--local-only"   then @args[:localRepoOnly] = true
-        when "-a", "--attribute"    then next_arg = :attributes
-        when "-d", "--resolve-docid" then @args[:resolveDocid] = true
-        when "-m", "--make-searchable" then @args[:makeSearchable] = true
-        when "-mp", "--search-assets-deploy" then next_arg = :searchAssetsDeploy
-        when "-s", "--style"        then next_arg = :userStyle
-        when "-w", "--web-path"     then next_arg = :webPath
-        when "--log-level"          then next_arg = :logLevel
-        else
-          if next_arg
-            if next_arg == :attributes
-              # support multiple invocations of -a
-              add_attribute arg
-            else
-              @args[next_arg] = arg
-            end
-            unflagged_args.delete(next_arg)
+      when "-h", "--help"         then @args[:help]      = true
+      when "-v", "--version"      then @args[:version]   = true
+      when "-f", "--format   "    then next_arg = :format
+      when "-r", "--resource-dir" then next_arg = :resourceDir
+      when "-n", "--no-build-ref" then @args[:suppressBuildRef] = true
+      when "--index-basename"     then next_arg = :indexBaseName
+      when "-i", "--include"      then next_arg = :includeRegexp
+      when "-j", "--exclude"      then next_arg = :excludeRegexp
+      when "-g", "--git-branches" then next_arg = :gitBranchRegexp
+      when "-t", "--git-tags"     then next_arg = :gitTagRegexp
+      when "-c", "--local-only"   then @args[:localRepoOnly] = true
+      when "-a", "--attribute"    then next_arg = :attributes
+      when "-d", "--resolve-docid" then @args[:resolveDocid] = true
+      when "-m", "--make-searchable" then @args[:makeSearchable] = true
+      when "-mp", "--search-assets-deploy" then next_arg = :searchAssetsDeploy
+      when "-s", "--style"        then next_arg = :userStyle
+      when "-w", "--web-path"     then next_arg = :webPath
+      when "--log-level"          then next_arg = :logLevel
+      else
+        if next_arg
+          if next_arg == :attributes
+            # support multiple invocations of -a
+            add_attribute arg
+          else
+            @args[next_arg] = arg
           end
-          next_arg = unflagged_args.first
+          unflagged_args.delete(next_arg)
+        end
+        next_arg = unflagged_args.first
       end
     end
   end
@@ -227,7 +227,7 @@ ENDHELP
   # adds the str (must be in key=value format) to the
   # user defined attributes
   def add_attribute(attrib_str)
-    kv = attrib_str.split('=')
+    kv = attrib_str.split("=")
     if kv.length != 2
       puts "Invalid attribute format: #{attrib_str} Must be <key>=<value>"
       exit 1
@@ -272,7 +272,7 @@ ENDHELP
     # The user wants to parse a git repo, check that the srcDirRoot is within a
     # git repo if the user wants to generate git-branch specific docs
     @args[:gitRepoRoot] = Giblish::PathManager.find_gitrepo_root(
-        @args[:srcDirRoot]
+      @args[:srcDirRoot]
     )
     return unless @args[:gitRepoRoot].nil?
 

data/lib/giblish/core.rb

@@ -11,11 +11,9 @@ require_relative "docinfo"
 require_relative "buildgraph"
 
 module Giblish
-
   # Parse a directory tree and convert all asciidoc files matching the
   # supplied critera to the supplied format
   class FileTreeConverter
-
     attr_reader :converter
 
     # Required options:
@@ -26,29 +24,29 @@ module Giblish
       @options = options.dup
 
       @paths = Giblish::PathManager.new(
-          @options[:srcDirRoot],
-          @options[:dstDirRoot],
-          @options[:resourceDir],
-          @options[:makeSearchable]
+        @options[:srcDirRoot],
+        @options[:dstDirRoot],
+        @options[:resourceDir],
+        @options[:makeSearchable]
       )
 
       # set the path to the search data that will be sent to the cgi search script
       deploy_search_path = if @options[:makeSearchable]
-                            @options[:searchAssetsDeploy].nil? ?
-                                @paths.search_assets_abs : Pathname.new(@options[:searchAssetsDeploy]).join("search_assets")
-                          else
-                            nil
-                          end
+                             if @options[:searchAssetsDeploy].nil?
+                               @paths.search_assets_abs
+                             else
+                               Pathname.new(@options[:searchAssetsDeploy]).join("search_assets")
+                             end
+                           end
 
       @deploy_info = Giblish::DeploymentPaths.new(
-          @options[:webPath],
-          deploy_search_path
+        @options[:webPath],
+        deploy_search_path
       )
       @processed_docs = []
       @converter = converter_factory
     end
 
-
     # convert all adoc files
     # return true if all conversions went ok, false if at least one
     # failed
@@ -63,17 +61,20 @@ module Giblish
       # traverse the src file tree and convert all files deemed as
       # adoc files
       conv_error = false
-      Find.find(@paths.src_root_abs) do |path|
-        p = Pathname.new(path)
-        begin
-          to_asciidoc(p) if adocfile? p
-        rescue Exception => e
-          str = "Error when converting file #{path.to_s}: #{e.message}\nBacktrace:\n"
-          e.backtrace.each { |l| str << "   #{l}\n" }
-          Giblog.logger.error { str }
-          conv_error = true
+      if @paths.src_root_abs.directory?
+        Find.find(@paths.src_root_abs) do |path|
+          p = Pathname.new(path)
+          begin
+            to_asciidoc(p) if adocfile? p
+          rescue StandardError => e
+            str = String.new("Error when converting file "\
+                             "#{path}: #{e.message}\nBacktrace:\n")
+            e.backtrace.each { |l| str << "   #{l}\n" }
+            Giblog.logger.error { str }
+            conv_error = true
+          end
         end
-      end if @paths.src_root_abs.directory?
+      end
 
       # create necessary search assets if needed
       create_search_assets if @options[:makeSearchable]
@@ -96,16 +97,14 @@ module Giblish
         adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
         gb = graph_builder_factory
         errors = @converter.convert_str(
-            gb.source(
-                @options[:makeSearchable]
-            ),
-            @paths.dst_root_abs,
-            "graph",
-            logger: adoc_logger
+          gb.source(make_searchable: @options[:makeSearchable]),
+          @paths.dst_root_abs,
+          "graph",
+          logger: adoc_logger
         )
         gb.cleanup
         !errors
-      rescue Exception => e
+      rescue StandardError => e
         Giblog.logger.warn { e.message }
         Giblog.logger.warn { "The dependency graph will not be generated !!" }
       end
@@ -117,12 +116,13 @@ module Giblish
       adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
       ib = index_factory
       @converter.convert_str(
-          ib.source(
-              dep_graph_exist, @options[:makeSearchable]
-          ),
-          @paths.dst_root_abs,
-          @options[:indexBaseName],
-          logger: adoc_logger
+        ib.source(
+          dep_graph_exists: dep_graph_exist,
+          make_searchable: @options[:makeSearchable]
+        ),
+        @paths.dst_root_abs,
+        @options[:indexBaseName],
+        logger: adoc_logger
       )
 
       # clean up cached files and adoc resources
@@ -133,6 +133,7 @@ module Giblish
     # user options
     def index_factory
       raise "Internal logic error!" if @options[:suppressBuildRef]
+
       SimpleIndexBuilder.new(@processed_docs, @converter, @paths, @deploy_info,
                              @options[:resolveDocid])
     end
@@ -145,9 +146,9 @@ module Giblish
     # get the correct converter type
     def converter_factory
       case @options[:format]
-      when "html" then
+      when "html"
         HtmlConverter.new @paths, @deploy_info, @options
-      when "pdf" then
+      when "pdf"
         PdfConverter.new @paths, @deploy_info, @options
       else
         raise ArgumentError, "Unknown conversion format: #{@options[:format]}"
@@ -184,16 +185,13 @@ module Giblish
 
     # convert a single adoc doc to whatever the user wants
     def to_asciidoc(filepath)
-      adoc = nil
-      begin
-        adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
-        adoc = @converter.convert(filepath, logger: adoc_logger)
+      adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
+      adoc = @converter.convert(filepath, logger: adoc_logger)
 
-        add_doc(adoc, adoc_logger.user_info_str.string)
-      rescue Exception => e
-        add_doc_fail(filepath, e)
-        raise
-      end
+      add_doc(adoc, adoc_logger.user_info_str.string)
+    rescue StandardError => e
+      add_doc_fail(filepath, e)
+      raise
     end
 
     # predicate that decides if a path is a asciidoc file or not
@@ -207,7 +205,7 @@ module Giblish
 
       # only include files matching the include regexp
       ir = Regexp.new @options[:includeRegexp]
-      return !ir.match(fs).nil?
+      !ir.match(fs).nil?
     end
 
     def manage_searchability(opts)
@@ -218,15 +216,12 @@ module Giblish
       IndexHeadings.clear_index
 
       # propagate user-given id attributes to the indexing class
+      # if there are any
       attr = opts[:attributes]
-      if !attr.nil?
-        if attr.has_key?("idprefix")
-          IndexHeadings.id_elements[:id_prefix] = attr["idprefix"]
-        end
-        if attr.has_key?("idseparator")
-          IndexHeadings.id_elements[:id_separator] = attr["idseparator"]
-        end
-      end
+      return if attr.nil?
+
+      IndexHeadings.id_elements[:id_prefix] = attr["idprefix"] if attr.key?("idprefix")
+      IndexHeadings.id_elements[:id_separator] = attr["idseparator"] if attr.key?("idseparator")
     end
 
     # top_dir
@@ -256,6 +251,8 @@ module Giblish
 
       # traverse the src file tree and copy all published adoc files
       # to the search_assets dir
+      return unless @paths.src_root_abs.directory?
+
       Find.find(@paths.src_root_abs) do |path|
         p = Pathname.new(path)
         next unless adocfile? p
@@ -263,7 +260,7 @@ module Giblish
         dst_dir = assets_dir.join(@paths.reldir_from_src_root(p))
         FileUtils.mkdir_p(dst_dir)
         FileUtils.cp(p.to_s, dst_dir)
-      end if @paths.src_root_abs.directory?
+      end
     end
 
     # Register the asciidoctor extension that handles doc ids and traverse
@@ -280,14 +277,17 @@ module Giblish
 
       # traverse the src file tree and collect ids from all
       # .adoc or .ADOC files
-      Find.find(@paths.src_root_abs) do |path|
-        p = Pathname.new(path)
-        idc.parse_file(p) if adocfile? p
-      end if @paths.src_root_abs.directory?
+      if @paths.src_root_abs.directory?
+        Find.find(@paths.src_root_abs) do |path|
+          p = Pathname.new(path)
+          idc.parse_file(p) if adocfile? p
+        end
+      end
       idc
     end
   end
 
+  # Converts all adoc files within a git repo
   class GitRepoConverter < FileTreeConverter
     def initialize(options)
       super(options)
@@ -308,7 +308,13 @@ module Giblish
     def convert
       conv_error = false
       (@user_branches + @user_tags).each do |co|
-        conv_error = conv_error || convert_one_checkout(co)
+        has_error = convert_one_checkout(co)
+        if has_error == true
+          conv_error = true
+        end
+      rescue
+        conv_error = true
+        next
       end
 
       # Render the summary page
@@ -316,10 +322,10 @@ module Giblish
                                                  @user_branches,
                                                  @user_tags
 
-      conv_error = conv_error || @converter.convert_str(
-          index_builder.source,
-          @master_paths.dst_root_abs,
-          "index"
+      conv_error ||= @converter.convert_str(
+        index_builder.source,
+        @master_paths.dst_root_abs,
+        "index"
       )
 
       # clean up
@@ -366,7 +372,7 @@ module Giblish
       # Connect to the git repo
       begin
         git_repo = Git.open(git_repo_root)
-      rescue Exception => e
+      rescue StandardError => e
         raise "Could not find a git repo at #{git_repo_root} !"\
             "\n\n(#{e.message})"
       end
@@ -374,7 +380,7 @@ module Giblish
       # fetch all remote refs if ok with user
       begin
         git_repo.fetch unless local_only
-      rescue Exception => e
+      rescue StandardError => e
         raise "Could not fetch from origin"\
             "(do you need '--local-only'?)!\n\n(#{e.message})"
       end
@@ -383,7 +389,7 @@ module Giblish
 
     # Get the branches/tags the user wants to parse
     def select_user_branches(checkout_regexp)
-      return unless @options[:gitBranchRegexp]
+      return [] unless @options[:gitBranchRegexp]
 
       regexp = Regexp.new checkout_regexp
       user_checkouts = @git_repo.branches.remote.select do |b|
@@ -398,30 +404,29 @@ module Giblish
       return [] unless tag_regexp
 
       regexp = Regexp.new @options[:gitTagRegexp]
-      tags = @git_repo.tags.select do |t|
+      @git_repo.tags.select do |t|
         regexp.match t.name
       end
-      tags
     end
 
     # convert all docs from one particular git commit
     # returns true if at least one doc failed to convert
     # and false if everything went ok.
-    def convert_one_checkout(co)
+    def convert_one_checkout(checkout)
       # determine if we are called with a tag or a branch
-      is_tag = (co.respond_to?(:tag?) && co.tag?)
+      is_tag = (checkout.respond_to?(:tag?) && checkout.tag?)
 
-      Giblog.logger.info { "Checking out #{co.name}" }
-      @git_repo.checkout co.name
+      Giblog.logger.info { "Checking out #{checkout.name}" }
+      @git_repo.checkout checkout.name
 
       unless is_tag
         # if this is a branch, make sure it is up-to-date
-        Giblog.logger.info { "Merging with origin/#{co.name}" }
-        @git_repo.merge "origin/#{co.name}"
+        Giblog.logger.info { "Merging with origin/#{checkout.name}" }
+        @git_repo.merge "origin/#{checkout.name}"
       end
 
       # assign a checkout-unique dst-dir
-      dir_name = co.name.tr("/", "_") << "/"
+      dir_name = checkout.name.tr("/", "_") << "/"
 
       # Update needed base class members before converting a new checkout
       @processed_docs = []
@@ -436,7 +441,11 @@ module Giblish
       # Parse and convert docs using given args
       Giblog.logger.info { "Convert docs into dir #{@paths.dst_root_abs}" }
       # parent_convert
-      FileTreeConverter.instance_method(:convert).bind(self).call
+      begin
+        FileTreeConverter.instance_method(:convert).bind_call(self)
+      rescue => e
+        raise "convert_one_checkout has a failure with #{co}!\n\n(#{e.message})"
+      end
     end
   end
-end
+end