giblish 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6a7fc123856a6321bbad8b7f8f527490a09faa9df0ebeeb1a984bbda4b22d78
-  data.tar.gz: 2788cc7789ed4046307d9d4a7ad75be7f7b0f12c30a1b559500b18166602e966
+  metadata.gz: d917c8b6c513f7759aecbbdb5a93a7cb13cb5774d66ccf0d602a615248723f76
+  data.tar.gz: b94be771b19dd5890e238ffc0ee0ee5af361919c0e526d63ac4f380b4f6698a0
 SHA512:
-  metadata.gz: 2ea03abe46dd0e23c06266e8b1a9bc444811931825a2155e9545ae911d9527fd7ad993d18287fd2ad5b7ce6a0e51ce40421d2c01454ec357161300969d7bdf57
-  data.tar.gz: 308d7306d39641442e17fa7b5a1687e8f7ae473e438c6eabf3ffbb3650521b091e15a8b0ed36700cb41cad917fbcd9c3f95646b38d2d4199c112eaa75b00ca7b
+  metadata.gz: 4c9f6b75a6266c65baf0e7876016139703b7b46677fea2dcee54b9ad95b23c04756c8b9383398cdd8055c91e78ea3d275c7968eeabf1154478a44b76faf6c27c
+  data.tar.gz: c7cb03e7fe95cdf3a13a74c36f0d5efbb06e49828ff04db05b5d231f098bb411ab34584067e03b7a3b93c025224d3d93ccd13366e951fe93826cfdafeaae1bd9

data/.gitignore

@@ -48,3 +48,6 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# RubyMine idea files
+/.idea/

data/README.adoc

@@ -1,7 +1,7 @@
 = giblish
 Generate docs from asciidoc files in a git repo
 
-image::https://travis-ci.com/rillbert/giblish.svg?branch=master[build status]
+image::https://travis-ci.org/rillbert/giblish.svg?branch=master["Build Status", link="https://travis-ci.org/rillbert/giblish"]
 
 == Purpose
 

data/Rakefile

@@ -10,9 +10,7 @@ end
 Rake::TestTask.new(:current) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/docid_test.rb"]
-#  t.test_files = FileList["test/**/index_heading_test.rb"]
-#  t.test_files = FileList["test/**/depgraph_test.rb"]
+  t.test_files = FileList["test/**/index_heading_test.rb"]
 end
 
 Rake::TestTask.new(:sandbox) do |t|

data/data/testdocs/wellformed/docidtest/docid_1.adoc

@@ -5,14 +5,13 @@
 == Purpose
 
 To test the basic functionality of document id references.
-This paragraph can be referenced as <<:docid:WF-013#Purpose,This paragraph>>.
 
 Other valid docid references::
 
-  * << :docid:WF-013,Using space before>>
-  * << :docid: WF-013,Using space and tabs>>
-  * <<:docid:WF-013#Testing Document ids>> No title but hash and section.
-  * <<:docid:WF-013>> No title and no hash
+  * << :docid:WF-022,Using space before>>
+  * << :docid: WF-022,Using space and tabs>>
+  * <<:docid:WF-022#Testing Document ids>> No title but hash and section.
+  * <<:docid:WF-022>> No title and no hash
   * <<:docid:WF-022,docid_2 adoc>> Another document within the tree.
   * <<:docid:WF-022#Purpose, Purpose in WF-022>> Reference a section in another document
   * <<:docid:WF-022>> Two references on the same line <<:docid:WF-013>>.

data/giblish.gemspec

@@ -30,17 +30,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "oga", "~> 2.15"
 
   # Usage: spec.add_runtime_dependency "[gem name]", [[version]]
-  spec.add_runtime_dependency "asciidoctor", "~>1.5", ">= 1.5.8"
+  spec.add_runtime_dependency "asciidoctor", "~>2.0", ">= 2.0.10"
   spec.add_runtime_dependency "asciidoctor-diagram", ["~> 1.5"]
-  spec.add_runtime_dependency "asciidoctor-pdf", [">= 1.5.0.alpha.16"]
-  spec.add_runtime_dependency "asciidoctor-rouge", ["~> 0.3"]
+  spec.add_runtime_dependency "asciidoctor-pdf", [">= 1.5.0.alpha.18"]
   spec.add_runtime_dependency "git", "~> 1.3"
+  spec.add_runtime_dependency "rouge", "~> 3.3"
   # needed by asciidoctor-pdf, see instructions at
   # https://github.com/asciidoctor/asciidoctor-pdf/releases
-  spec.add_runtime_dependency "prawn-svg", "~> 0.27.1"
+#  spec.add_runtime_dependency "prawn-svg", "~> 0.27.1"
+ spec.add_runtime_dependency "prawn-svg", "~> 0.29.1"
 end

data/lib/giblish/application.rb

@@ -31,21 +31,22 @@ module Giblish
       Giblog.logger.debug { "cmd line args: #{cmdline.args}" }
 
       # Convert using given args
+      conv_error = false
       begin
         if cmdline.args[:gitRepoRoot]
           Giblog.logger.info { "User asked to parse a git repo" }
           gc = GitRepoConverter.new cmdline.args
-          gc.convert
+          conv_error = gc.convert
         else
           tc = FileTreeConverter.new cmdline.args
-          tc.convert
+          conv_error = tc.convert
         end
         Giblog.logger.info { "Giblish is done!" }
-        0
       rescue Exception => e
         log_error e
-        1
+        conv_error = true
       end
+      conv_error ? 1 : 0
     end
 
     private

data/lib/giblish/buildindex.rb

@@ -172,12 +172,11 @@ module Giblish
     def generate_conversion_info(d)
       return "" if d.stderr.empty?
       # extract conversion warnings from asciddoctor std err
-      conv_warnings = d.stderr.gsub("asciidoctor:", "\n * asciidoctor:")
-      Giblog.logger.warn {"Conversion warnings: #{conv_warnings}"}
+      conv_warnings = d.stderr.gsub(/^/, " * ")
 
       # assemble info to index page
       <<~CONV_INFO
-        Conversion info::
+        Conversion issues::
 
         #{conv_warnings}
       CONV_INFO
@@ -205,15 +204,15 @@ module Giblish
     end
 
     # Generate an adoc string that will display as
-    # DocTitle         (warn)  details
+    # DocTitle         (conv issues)  details
     # Where the DocTitle and details are links to the doc itself and a section
     # identified with the doc's title respectively.
     def tree_entry_converted(prefix_str, doc_info)
       # Get the elements of the entry
       doc_title, doc_link, doc_details = format_title_and_ref doc_info
-      warning_label = doc_info.stderr.empty? ? "" : "(warn)"
+      warning_label = doc_info.stderr.empty? ? "" : "(conv issues)"
 
-      # Calculate padding to get (warn) and details aligned between entries
+      # Calculate padding to get (conv issues) and details aligned between entries
       padding = 70
       [doc_title, prefix_str, warning_label].each {|p| padding -= p.length}
       padding = 0 unless padding.positive?

data/lib/giblish/cmdline.rb

@@ -34,11 +34,11 @@ class CmdLineParser
   -i --include <regexp>      include only files with a filename 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 _file name only_, not the full path (i.e. for the full 
+                             on the _file name only_, not the full path (i.e. for the full
                              path /my/file.adoc, only file.adoc is used in the matching).
-  -j --exclude <regexp>      exclude files with filenames matching the supplied 
+  -j --exclude <regexp>      exclude files with filenames matching the supplied
                              regexp (no files are excluded by default). The matching is made
-                             on the _file name only_, not the full path (i.e. for the full 
+                             on the _file name only_, not the full path (i.e. for the full
                              path /my/file.adoc, only file.adoc is used in the matching).
   -w --web-root <path>       Specifies the top dir (DirectoryRoot) of a file system
                              tree published by a web server. This switch is only used
@@ -57,13 +57,18 @@ class CmdLineParser
                              branch on origin_.
                              NOTE 2: In bash, use double quotes around your regexp if
                              you need to quote it. Single quotes are treated as part
-                             of the regexp itself. 
+                             of the regexp itself.
   -t --git-tags <regExp>     if the source_dir_top is located within a git repo,
                              generate docs for all tags that matches the given
                              regular expression. Each tag will be generated to
                              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.
+  -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 
+                             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
                              generate the documents and use the collected
@@ -71,26 +76,26 @@ class CmdLineParser
                              generated documents
   -m --make-searchable       (only supported for html generation)
                              take steps to make it possible to
-                             search the published content via a cgi-script. This 
+                             search the published content via a cgi-script. This
                              flag will do the following:
                                1. index all headings in all source files and store
                                   the result in a JSON file
                                2. copy the JSON file and all source (adoc) files to
                                   a 'search_assets' folder in the top-level dir of
                                   the destination.
-                               3. add html code that displays a search field in the 
+                               3. add html code that displays a search field in the
                                   index page that will try to call the cgi-script
-                                  'giblish-search' when the user inputs some text. 
-                             To actually provide search functionality for a user, you 
+                                  'giblish-search' when the user inputs some text.
+                             To actually provide search functionality for a user, you
                              need to provide the cgi-script and configure your web-server
-                             to invoke it when needed. NOTE: The generated search box cgi 
-                             is currently hard-coded to look for the cgi script at the URL: 
+                             to invoke it when needed. NOTE: The generated search box cgi
+                             is currently hard-coded to look for the cgi script at the URL:
                              http://<your-web-domain>/cgi-bin/giblish-search.cgi
                              E.g.
                              http://example.com/cgi-bin/giblish-search.cgi
                              An implementation of the giblish-search cgi-script is found
-                             within the lib folder of this gem, you can copy that to your 
-                             cgi-bin dir in your webserver and rename it from .rb to .cgi 
+                             within the lib folder of this gem, you can copy that to your
+                             cgi-bin dir in your webserver and rename it from .rb to .cgi
   --log-level                set the log level explicitly. Must be one of
                              debug, info (default), warn, error or fatal.
 ENDHELP
@@ -110,15 +115,10 @@ ENDHELP
       exit 0
     end
 
-    # set log level
+    # act on the parsed cmd line args
     set_log_level
     sanity_check_input
     set_gitrepo_root
-    # if @args[:logfile]
-    #   $stdout.reopen( ARGS[:logfile], "w" )
-    #   $stdout.sync = true
-    #   $stderr.reopen( $stdout )
-    # end
   end
 
   def usage
@@ -185,6 +185,7 @@ ENDHELP
         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[:make_searchable] = true
         when "-s", "--style"        then next_arg = :userStyle
@@ -192,7 +193,12 @@ ENDHELP
         when "--log-level"          then next_arg = :logLevel
         else
           if next_arg
-            @args[next_arg] = arg
+            if next_arg == :attributes
+              # support multiple invocations of -a
+              add_attribute arg
+            else
+              @args[next_arg] = arg
+            end
             unflagged_args.delete(next_arg)
           end
           next_arg = unflagged_args.first
@@ -200,6 +206,19 @@ ENDHELP
     end
   end
 
+  # adds the str (must be in key=value format) to the
+  # user defined attributes
+  def add_attribute(attrib_str)
+    kv = attrib_str.split('=')
+    if kv.length != 2
+      puts "Invalid attribute format: #{attrib_str} Must be <key>=<value>"
+      exit 1
+    end
+
+    @args[:attributes] ||= {}
+    @args[:attributes][kv[0]] = kv[1]
+  end
+
   def prevent_invalid_combos
     # Prevent contradicting options
     if !@args[:resourceDir] && @args[:userStyle]

data/lib/giblish/core.rb

@@ -36,6 +36,10 @@ module Giblish
       @search_assets_path = @paths.dst_root_abs.realpath.join("search_assets")
     end
 
+
+    # convert all adoc files
+    # return true if all conversions went ok, false if at least one
+    # failed
     def convert
       # collect all doc ids and enable replacement of known doc ids with
       # valid references to adoc files
@@ -46,38 +50,53 @@ 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)
-        to_asciidoc(p) if adocfile? p
+        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
+        end
       end if @paths.src_root_abs.directory?
 
       # create necessary search assets if needed
       create_search_assets if @options[:make_searchable]
 
-      # check if we shall build index or not
-      return if @options[:suppressBuildRef]
-
-      # build a dependency graph (only if we resolve docids...)
-      dep_graph_exist = if @options[:resolveDocid]
-        if Giblish::GraphBuilderGraphviz.supported
-          gb = Giblish::GraphBuilderGraphviz.new @processed_docs, @paths, {extension: @converter.converter_options[:fileext]}
-          @converter.convert_str gb.source, @paths.dst_root_abs, "graph"
+      # build index and other fancy stuff if not suppressed
+      unless @options[:suppressBuildRef]
+        # build a dependency graph (only if we resolve docids...)
+        dep_graph_exist = if @options[:resolveDocid]
+          if Giblish::GraphBuilderGraphviz.supported
+            gb = Giblish::GraphBuilderGraphviz.new @processed_docs, @paths, {extension: @converter.converter_options[:fileext]}
+            @converter.convert_str(gb.source, @paths.dst_root_abs, "graph")
+          else
+            Giblog.logger.warn { "Lacking access to needed tools for generating a visual dependency graph." }
+            Giblog.logger.warn { "The dependency graph will not be generated !!" }
+            false
+          end
         else
-          Giblog.logger.warn { "Lacking access to needed tools for generating a visual dependency graph." }
-          Giblog.logger.warn { "The dependency graph will not be generated !!" }
           false
         end
-      else
-        false
-      end
 
-      # build a reference index
-      ib = index_factory
-      @converter.convert_str ib.source(dep_graph_exist,@options[:make_searchable]), @paths.dst_root_abs, "index"
-
-      # clean up cached files and adoc resources
-      remove_diagram_temps if dep_graph_exist
-      GC.start
+        # build a reference index
+        adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
+        ib = index_factory
+        @converter.convert_str(
+            ib.source(
+                dep_graph_exist,@options[:make_searchable]
+            ),
+            @paths.dst_root_abs, "index",
+            logger: adoc_logger)
+
+        # clean up cached files and adoc resources
+        remove_diagram_temps if dep_graph_exist
+        GC.start
+      end
+      conv_error
     end
 
     protected
@@ -148,19 +167,13 @@ module Giblish
     def to_asciidoc(filepath)
       adoc = nil
       begin
-        # do the conversion and capture eventual errors that
-        # the asciidoctor lib writes to stderr
-        adoc_stderr = Giblish.with_captured_stderr do
-          adoc = @converter.convert filepath
-        end
+        adoc_logger = Giblish::AsciidoctorLogger.new Logger::Severity::WARN
+        adoc = @converter.convert(filepath,logger: adoc_logger)
 
-        add_doc(adoc, adoc_stderr)
+        add_doc(adoc, adoc_logger.user_info_str.string)
       rescue Exception => e
-        str = "Error when converting doc: #{e.message}\n"
-        e.backtrace.each {|l| str << "#{l}\n"}
-        Giblog.logger.error {str}
-
         add_doc_fail(filepath, e)
+        raise
       end
     end
 
@@ -258,20 +271,31 @@ module Giblish
       @user_tags = select_user_tags(options[:gitTagRegexp])
     end
 
-    # Render the docs from each branch/tag and add info to the
-    # summary page
+    # Convert the docs from each branch/tag and add info to the
+    # summary page.
+    # return true if all conversions went ok, false if at least one
+    # failed
     def convert
+      conv_error = false
       (@user_branches + @user_tags).each do |co|
-        convert_one_checkout co
+        conv_error = conv_error || convert_one_checkout(co)
       end
 
       # Render the summary page
       index_builder = GitSummaryIndexBuilder.new @git_repo,
                                                  @user_branches,
                                                  @user_tags
-      @converter.convert_str index_builder.source, @master_paths.dst_root_abs, "index"
+
+      conv_error = conv_error || @converter.convert_str(
+          index_builder.source,
+          @master_paths.dst_root_abs,
+          "index"
+      )
+
       # clean up
       GC.start
+
+      conv_error
     end
 
     protected
@@ -345,6 +369,9 @@ module Giblish
       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)
       # determine if we are called with a tag or a branch
       is_tag = (co.respond_to?(:tag?) && co.tag?)

data/lib/giblish/docconverter.rb

@@ -31,13 +31,15 @@ module Giblish
     attr_accessor :paths
 
     def initialize(paths, options)
-      # access the source highlight module
-      require "asciidoctor-rouge"
-
       @paths = paths
       @user_style = options[:userStyle]
       @converter_options = COMMON_CONVERTER_OPTS.dup
+
+      # use the default options and override them with options set by
+      # the user if applicable
       @converter_options[:attributes] = DEFAULT_ATTRIBUTES.dup
+      @converter_options[:attributes].merge!(options[:attributes]) unless options[:attributes].nil?
+
       @converter_options[:backend] = options[:backend]
     end
 
@@ -47,7 +49,7 @@ module Giblish
     # filepath - a pathname with the absolute path to the input file to convert
     #
     # Returns: The resulting Asciidoctor::Document object
-    def convert(filepath)
+    def convert(filepath, logger: nil)
       unless filepath.is_a?(Pathname)
         raise ArgumentError, "Trying to invoke convert with non-pathname!"
       end
@@ -63,10 +65,18 @@ module Giblish
           Giblish::PathManager.get_new_basename(filepath,
                                                 @converter_options[:fileext])
 
+      # set a specific logger instance to-be-used by asciidoctor
+      @converter_options[:logger] = logger unless logger.nil?
+
       Giblog.logger.debug {"converter_options: #{@converter_options}"}
 
       # do the actual conversion
-      Asciidoctor.convert_file filepath, @converter_options
+      doc = Asciidoctor.convert_file filepath, @converter_options
+
+      if logger && logger.max_severity && logger.max_severity > Logger::Severity::WARN
+        raise RuntimeError, "Failed to convert the file #{filepath}"
+      end
+      doc
     end
 
     # converts the supplied string to the file
@@ -75,8 +85,9 @@ module Giblish
     # the supplied string must pass asciidoctor without
     # any error to stderr, otherwise, nothing will be written
     # to disk.
-    # returns 'true' if a file was written, 'false' if not
-    def convert_str(src_str, dst_dir, basename)
+    # Returns: whether any errors occured during conversion (true) or
+    # not (false).
+    def convert_str(src_str, dst_dir, basename,logger: nil)
       index_opts = @converter_options.dup
 
       # use the same options as when converting all docs
@@ -89,27 +100,29 @@ module Giblish
 
       # load and convert the document using the converter options
       doc = nil, output = nil
-      adoc_stderr = Giblish.with_captured_stderr do
+
+      begin
+        conv_error = false
+        # set a specific logger instance to-be-used by asciidoctor
+        index_opts[:logger] = logger unless logger.nil?
         doc = Asciidoctor.load src_str, index_opts
         output = doc.convert index_opts
-      end
 
-      index_filepath = dst_dir + "#{basename}.#{index_opts[:fileext]}"
+        index_filepath = dst_dir + "#{basename}.#{index_opts[:fileext]}"
 
-      # if we get anything from asciidoctor to stderr,
-      # consider this a failure and do not emit a file.
-      if !adoc_stderr.length.zero?
-        Giblog.logger.error {"Errors when converting string to asciidoc!!"}
-        Giblog.logger.error {"Will _not_ generate file #{index_filepath.to_s}"}
-        Giblog.logger.error {"Got following warnings/errors from asciidoc conversion:"}
-        Giblog.logger.error {adoc_stderr}
-        return false
+        if logger && logger.max_severity && logger.max_severity > Logger::Severity::WARN
+          raise RuntimeError, "Failed to convert string to asciidoc!! Will _not_ generate #{index_filepath.to_s}"
+        end
+      rescue Exception => e
+        Giblog.logger.error(e)
+        conv_error = true
       end
 
+
       # write the converted document to an index file located at the
       # destination root
       doc.write output, index_filepath.to_s
-      true
+      conv_error
     end
 
     protected

data/lib/giblish/indexheadings.rb

@@ -10,7 +10,7 @@ module Giblish
   # Asciidoctor processes the adoc content.
   #
   # It indexes all headings found in all documents in the tree.
-  # The resulting index can be serialized to a JSON file file
+  # The resulting index can be serialized to a JSON file
   # with the following format:
   #
   # {
@@ -96,27 +96,66 @@ module Giblish
           "sections" => sections
       }
 
-      # build the 'sections' array
-      line_no = 1
-      regex = Regexp.new(/^=+\s+(.*)$/)
+      index_sections(reader,file_info_hash)
+
+      heading_index["file_infos"] << file_info_hash
+      reader
+    end
+
+    private
+
+    # build the 'sections' array
+    def index_sections(reader, file_info_hash)
+      sections = file_info_hash["sections"]
+
+      heading_regex = Regexp.new(/^=+\s+(.*)$/)
+      anchor_regex = Regexp.new(/^\[\[(\w+)\]\]\s*$/)
+
+      line_no = 0
+      m = nil
+      match_str = ""
+      state = :text
       reader.lines.each do |line|
-        m = regex.match(line)
-        if m
-          # We found a heading, index it
-          section = { "id" => get_unique_id(file_info_hash, m[1]) }
+        line_no += 1
+        # implement a state machine that supports both custom
+        # anchors for a heading and the default heading ids generated
+        # by asciidoctor
+        case state
+        when :text
+          m = heading_regex.match(line)
+          if m
+            state = :heading
+            match_str = m[1]
+          else
+            m = anchor_regex.match(line)
+            if m
+              state = :expecting_heading
+              match_str = m[1]
+            end
+          end
+        when :expecting_heading
+          m = heading_regex.match(line)
+          if m
+            # we have an anchor and got a heading as expected, index it
+            section = { "id" => match_str }
+            section["title"] = m[1].strip
+            section["line_no"] = line_no
+            sections << section
+          else
+            Giblog.logger.debug {"Did not index the anchor: #{match_str} at line #{line_no}, probably not associated with a heading."}
+          end
+          state = :text
+        when :heading
+          # we got a heading without an accompanying anchor, index it
+          section = { "id" => get_unique_id(file_info_hash, match_str) }
           section["title"] = m[1].strip
           section["line_no"] = line_no
           sections << section
+          state = :text
         end
-        line_no += 1
       end
-
-      heading_index["file_infos"] << file_info_hash
-      reader
     end
 
-    private
-
     def find_title(lines)
       title = "No title Found!"
       Giblish.process_header_lines(lines) do |line|

data/lib/giblish/utils.rb

@@ -2,13 +2,20 @@ require "logger"
 require "pathname"
 require "fileutils"
 
+class GiblogFormatter
+  def call severity, datetime, progname, msg
+    "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
+  end
+end
+
 class Giblog
   def self.setup
     return if defined? @logger
     @logger = Logger.new(STDOUT)
-    @logger.formatter = proc do |severity, datetime, _progname, msg|
-      "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
-    end
+    @logger.formatter = GiblogFormatter.new
+    # @logger.formatter = proc do |severity, datetime, _progname, msg|
+    #   "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
+    # end
   end
 
   def self.logger
@@ -21,8 +28,58 @@ class Giblog
   end
 end
 
+
+
 # Public: Contains a number of generic utility methods.
 module Giblish
+
+  class UserInfoFormatter
+    SEVERITY_LABELS = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
+
+    # {:text=>"...",
+    #  :source_location=>#<Asciidoctor::Reader::Cursor:0x000055e65a8729e0
+    #          @file="<full adoc filename>",
+    #          @dir="<full src dir>",
+    #          @path="<only file name>",
+    #          @lineno=<src line no>
+    # }
+    def call severity, datetime, progname, msg
+      message = case msg
+                when ::String
+                  msg
+                when ::Hash
+                  # asciidoctor seem to emit a hash with error text and source location info
+                  # for warnings and errors
+                  str = ""
+                  str << "Line #{msg[:source_location].lineno.to_s} - " if msg[:source_location]
+                  str << "#{msg[:text].to_s}" if msg[:text]
+                  str
+                else
+                  msg.inspect
+                end
+      %(#{datetime.strftime('%H:%M:%S')} #{progname}: #{SEVERITY_LABELS[severity] || severity}: #{message}\n)
+    end
+  end
+  class AsciidoctorLogger < ::Logger
+
+    attr_reader :max_severity
+    attr_reader :user_info_str
+
+    def initialize user_info_log_level
+      super(STDOUT,progname: "(from asciidoctor)", formatter: UserInfoFormatter.new)
+      @user_info_str = StringIO.new
+      @user_info_logger = ::Logger.new(@user_info_str, formatter: UserInfoFormatter.new, level: user_info_log_level)
+    end
+
+    def add severity, message = nil, progname = nil
+      if (severity ||= UNKNOWN) > (@max_severity ||= severity)
+        @max_severity = severity
+      end
+      @user_info_logger.add(severity,message,progname)
+      super
+    end
+  end
+
   # Helper class to ease construction of different paths for input and output
   # files and directories
   class PathManager
@@ -161,7 +218,7 @@ module Giblish
         return p if git_dir.directory?
       end
     end
-  end
+  end # end of PathManager
 
   # Helper method that provides the user with a way of processing only the
   # lines within the asciidoc header block.

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -44,34 +44,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.8
+        version: 2.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.8
+        version: 2.0.10
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
@@ -92,56 +106,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0.alpha.16
+        version: 1.5.0.alpha.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0.alpha.16
+        version: 1.5.0.alpha.18
 - !ruby/object:Gem::Dependency
-  name: asciidoctor-rouge
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: prawn-svg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.29.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.29.1
 description: A tool for publishing asciidoc docs stored in git repos
 email:
 - anders.rillbert@kutso.se