giblish 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 536fb7fa58df4bca2bfa5b73f68ebec0dd32bff797c3401cd20e6ccb20450db7
-  data.tar.gz: 3f6f51691b25f64cf80da13d9467f5ea8f1ee296390efd7f77cd0ce49d7195c7
+  metadata.gz: 8408ee3c107d81b67183f08d1da4b5e4aa5edc0cb0050bab222be0c2bc7f2d2e
+  data.tar.gz: d98a66177b686af3f20a46b57c2425ab0c1462296ca27455a1f79c426fd2958d
 SHA512:
-  metadata.gz: 855851b721c005724dd76daeafeb43945bda104f0edc3628530efa4b1a87bece735547be67f9ac584fbae8b1b640f36b19cc98112864e22ff1edd775be23a9a6
-  data.tar.gz: ef6c403e03b3abf628ddd896e935f3dbaf096a4368bb1702d665f269de1eddbccd2a2efeb2647e00dfa18888a7b82d47be711b39e4cddedcd7006ede4d96d471
+  metadata.gz: 72b392c42daaef6cd52224eaf43687463a0750934ac995d67e529bdb16b2be7498f31fc8dcd2112756873894adf6314a965231e6325460e7458f214c987419fa
+  data.tar.gz: 61afa2acbf3ec664fc289e673e8c5faac55bf1f1d564b0955a1d2eb541e7764333f9ef326d82c4da1fc4db83386c8aa2b0d7024fddbc9962b048d87645baf020

data/.github/workflows/unit_tests.yml

@@ -17,9 +17,9 @@ jobs:
           sudo apt -y install binutils
       - name: Install needed packages
         run: |
-          sudo apt-get -y install libpango1.0-dev graphviz
+          sudo apt-get -y install libpango1.0-dev graphviz libwebp-dev libzstd-dev
       - name: Checkout Giblish
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.gitignore

@@ -9,7 +9,6 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-/.vscode/
 
 # Used by dotenv library to load environment variables.
 # .env

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.1.3

data/Changelog.adoc

@@ -1,12 +1,27 @@
 = giblish changelog
 :docid: G-006
 
-== Not yet in place
+== Some of the things Not yet in place
 
  * Investigate how to remove tmp/cache files and dirs during graph generation
  * Update docs for giblish.
  ** write instructions for github webhook triggered generation
  * Update the default css for giblish html generation.
+ * Implement a way for a user to customize the index page
+
+== v2.1.0
+
+Changes/New functionality::
+ * asciidoctor-diagram is required if it exists, this makes diagrams in documents render.
+ * giblish now complies with these precedence rules for document attributes:
+ .. An attribute passed to the API or CLI whose value does not end in @
+ .. (giblish specific) An attribute defined in an attribute provider for a specific source node
+ .. An attribute defined in the document
+ .. An attribute passed to the API or CLI whose value or name ends in @
+ .. (giblish specific) The default value set by giblish, if applicable
+ .. The default value set by asciidoctor, if applicable
++
+this is an augumentation of the ones found here: https://docs.asciidoctor.org/asciidoc/latest/attributes/assignment-precedence/
 
 == v2.0.0
 
@@ -21,7 +36,7 @@ Breaking changes::
 This release includes a complete refactoring of almost the entire code base.
 
 Breaking changes::
- * The '-w' flag is removed  
+ * The '-w' flag is removed
  * The text search parameters interface has changed completely. A written specification of this interface is included in the docs.
  * The '-r' flag will, for html generation, *copy everything* under the given directory to the target location.
  ** the previous restriction on folder names has been removed.
@@ -46,7 +61,7 @@ Changes/New functionality::
  ** the implementation of the server-side search tools are written completely in ruby and does no longer depend on an external 'grep' tool.
  ** almost all needed infrastructure for implementing a server-side search script has been implemented within the 'giblish' gem.
  * The asciidoctor toolchain dependencies are updated to the latest versions (at the time of release).
- 
+
 
 == v0.8.0
 

data/giblish.gemspec

@@ -49,7 +49,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "standard", "~> 1.16"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "oga", "~> 3.3"
-  # spec.add_development_dependency "thor", "~> 0.20.3"
   spec.add_development_dependency "thor", "~> 1.2"
   spec.add_development_dependency "asciidoctor-mathematical", "~> 0.3.5"
   # needed for the sinatra-based apps
@@ -61,6 +60,7 @@ Gem::Specification.new do |spec|
   # Run-time deps
   # 'matrix' needed because of incompatibilities between prawn v2.4
   # and ruby 3.1
+  # sorbet-runtime
   spec.add_runtime_dependency "matrix", "~>0.4"
   spec.add_runtime_dependency "warning", "~>1.2"
   spec.add_runtime_dependency "asciidoctor", "~>2.0", ">= 2.0.17"

data/lib/giblish/application.rb

@@ -5,54 +5,54 @@ require_relative "gitrepos/checkoutmanager"
 
 module Giblish
   # The app class for the giblish application
-  class Application
-    # returns on success, raises otherwise
-    def run(args)
-      # force immediate output
-      $stdout.sync = true
-
-      # setup logging
-      Giblog.setup
-      Giblog.logger.level = Logger::INFO
-
-      # Parse cmd line
-      cmdline = CmdLine.new.parse(args)
-      Giblog.logger.level = cmdline.log_level
-
-      Giblog.logger.debug { "cmd line args: #{cmdline.inspect}" }
-
-      # build a tree of files matching user's regexp selection
-      src_tree = PathTree.build_from_fs(cmdline.srcdir) do |p|
-        if cmdline.exclude_regex&.match(p.to_s)
-          false
-        else
-          (cmdline.include_regex =~ p.to_s)
-        end
-      end
-      if src_tree.nil?
-        Giblog.logger.warn { "Did not find any files to convert" }
-        return
-      end
-
-      app = Configurator.new(cmdline, src_tree)
-      app.tree_converter.run
-
-      Giblog.logger.info { "Giblish is done!" }
-    end
-
-    # does not return, exits with status code
-    def run_from_cmd_line
-      begin
-        run(ARGV)
-        exit_code = 0
-      rescue => exc
-        Giblog.logger.error { exc.message }
-        Giblog.logger.error { exc.backtrace }
-        exit_code = 1
-      end
-      exit(exit_code)
-    end
-  end
+  # class Application
+  #   # returns on success, raises otherwise
+  #   def run(args)
+  #     # force immediate output
+  #     $stdout.sync = true
+
+  #     # setup logging
+  #     Giblog.setup
+  #     Giblog.logger.level = Logger::INFO
+
+  #     # Parse cmd line
+  #     cmdline = CmdLine.new.parse(args)
+  #     Giblog.logger.level = cmdline.log_level
+
+  #     Giblog.logger.debug { "cmd line args: #{cmdline.inspect}" }
+
+  #     # build a tree of files matching user's regexp selection
+  #     src_tree = PathTree.build_from_fs(cmdline.srcdir) do |p|
+  #       if cmdline.exclude_regex&.match(p.to_s)
+  #         false
+  #       else
+  #         (cmdline.include_regex =~ p.to_s)
+  #       end
+  #     end
+  #     if src_tree.nil?
+  #       Giblog.logger.warn { "Did not find any files to convert" }
+  #       return
+  #     end
+
+  #     app = Configurator.new(cmdline, src_tree)
+  #     app.tree_converter.run
+
+  #     Giblog.logger.info { "Giblish is done!" }
+  #   end
+
+  #   # does not return, exits with status code
+  #   def run_from_cmd_line
+  #     begin
+  #       run(ARGV)
+  #       exit_code = 0
+  #     rescue => exc
+  #       Giblog.logger.error { exc.message }
+  #       Giblog.logger.error { exc.backtrace }
+  #       exit_code = 1
+  #     end
+  #     exit(exit_code)
+  #   end
+  # end
 
   class DirTreeConvert
     # This class provides a file as the source for the asciidoc info and
@@ -197,15 +197,20 @@ module Giblish
       Giblog.logger.level = Logger::INFO
 
       # Parse cmd line
-      user_opts = CmdLine.new.parse(args)
-      Giblog.logger.level = user_opts.log_level
-      Giblog.logger.debug { "cmd line args: #{user_opts.inspect}" }
+      @user_opts = CmdLine.new.parse(args)
+      Giblog.logger.level = @user_opts.log_level
+      Giblog.logger.debug { "cmd line args: #{@user_opts.inspect}" }
 
       # Select the coversion instance to use
-      @converter = select_conversion(user_opts)
+      @converter = select_conversion(@user_opts)
     end
 
     def run
+      begin
+        require "asciidoctor-diagram"
+      rescue LoadError
+        Giblog.logger.warn { "Did not find asciidoctor-diagram installed, diagrams will not be rendered." }
+      end
       # do the conversion
       @converter.run
     end

data/lib/giblish/treeconverter.rb

@@ -156,20 +156,20 @@ module Giblish
     }
 
     # see https://docs.asciidoctor.org/asciidoctor/latest/api/options/
-    DEFAULT_ADOC_OPTS = {
-      backend: "html5",
+    DEFAULT_ADOC_API_OPTS = {
+      # backend: "html5",
       # base_dir:
-      catalog_assets: false,
+      # catalog_assets: false,
       # converter:
-      doctype: "article",
+      # doctype: "article",
       # eruby:
       # ignore extention stuff
-      header_only: false,
+      # header_only: false,
       # logger:
-      mkdirs: false,
-      parse: true,
+      # mkdirs: false,
+      # parse: true,
       safe: :unsafe,
-      sourcemap: false,
+      # sourcemap: false,
       # template stuff TBD,
       # to_file:
       # to_dir:
@@ -192,12 +192,67 @@ module Giblish
         failure: ->(src, dst, dst_rel_path, ex, logstr) { TreeConverter.on_failure(src, dst, dst_rel_path, ex, logstr) }
       })
 
-      # merge user's options with the default, giving preference
-      # to the user
-      @adoc_api_opts = DEFAULT_ADOC_OPTS.dup
-        .merge!(opts.fetch(:adoc_api_opts, {}))
-      @adoc_api_opts[:attributes] = DEFAULT_ADOC_DOC_ATTRIBS.dup
-        .merge!(opts.fetch(:adoc_doc_attribs, {}))
+      # cache external configuration
+      @config_opts = opts.dup
+    end
+
+    # Resolve the document attributes according to the precedence.
+    #
+    # According to https://docs.asciidoctor.org/asciidoc/latest/attributes/assignment-precedence/
+    # The attribute precedence is:
+    # 1. An attribute passed to the API or CLI whose value does not end in @
+    # 2. An attribute defined in the document
+    # 3. An attribute passed to the API or CLI whose value or name ends in @
+    # 4. The default value of the attribute, if applicable
+    #
+    # giblish adds the following rules:
+    # 1.5 An attribute defined in an attribute provider for a specific source node
+    # 3.5 The default value set by giblish, if applicable
+    def resolve_doc_attributes(doc_src, node_attr)
+      # rule 3.5
+      doc_attr = DEFAULT_ADOC_DOC_ATTRIBS.dup
+
+      # sort attribs into soft and hard (rule 1 and 3)
+      soft_attr = {}
+      hard_attr = {}
+      @config_opts.fetch(:adoc_doc_attribs, {}).each do |k, v|
+        ks = k.to_s.strip
+        vs = v.to_s.strip
+
+        if ks.end_with?("@")
+          soft_attr[ks[0..]] = vs
+          next
+        end
+        if vs.end_with?("@")
+          soft_attr[ks] = vs[0..]
+          next
+        end
+        hard_attr[ks] = vs
+      end
+
+      # rule 3.
+      doc_attr.merge!(soft_attr)
+
+      # rule 2
+      Giblish.process_header_lines(doc_src.lines) do |line|
+        a = /^:(.+):(.*)$/.match(line)
+        next unless a
+        @logger.debug { "got header attr from doc: #{a[1]} : #{a[2]}" }
+        doc_attr[a[1].strip] = a[2].strip
+      end
+
+      @logger.debug { "idprefix before: #{doc_attr["idprefix"]}" }
+
+      # rule 1.5
+      doc_attr.merge!(node_attr)
+
+      # rule 1.
+      doc_attr.merge!(hard_attr)
+
+      @logger.debug { "idprefix after: #{doc_attr["idprefix"]}" }
+
+      # @logger&.debug { "Header attribs: #{doc_attr}" }
+      doc_attr
     end
 
     # require the following methods to be available from the src node:
@@ -216,34 +271,44 @@ module Giblish
       @logger&.info { "Converting #{src_node.pathname} and store result under #{dst_node.parent.pathname}" }
 
       # merge the common api opts with node specific
-      api_opts = @adoc_api_opts.dup
+      api_opts = DEFAULT_ADOC_API_OPTS.dup
+      api_opts.merge!(@config_opts.fetch(:adoc_api_opts, {}))
       api_opts.merge!(src_node.api_options(src_node, dst_node, dst_top)) if src_node.respond_to?(:api_options)
-      api_opts[:attributes].merge!(src_node.document_attributes(src_node, dst_node, dst_top)) if src_node.respond_to?(:document_attributes)
 
       # use a new logger instance for each conversion
       adoc_logger = Giblish::AsciidoctorLogger.new(@logger, @adoc_log_level)
 
       begin
-        # load the source to enable access to doc properties
+        doc_src = src_node.adoc_source(src_node, dst_node, dst_top)
+
+        node_attr = src_node.respond_to?(:document_attributes) ?
+          src_node.document_attributes(src_node, dst_node, dst_top) : {}
+        doc_attr = resolve_doc_attributes(doc_src, node_attr)
+        # piggy-back our own info on the doc attributes hash so that
+        # asciidoctor extensions can use this info later on
+        doc_attr["giblish-info"] = {
+          src_node: src_node,
+          dst_node: dst_node,
+          dst_top: dst_top
+        }
+
+        # load the source to enable access to doc attributes and properties
         #
-        # NOTE: the 'parse: false' is needed to prevent preprocessor extensions to be run as part
+        # NOTE: 'parse' is set to false to prevent preprocessor extensions to be run as part
         # of loading the document. We want them to run during the 'convert' call later when
         # doc attribs have been amended.
-        doc = Asciidoctor.load(src_node.adoc_source(src_node, dst_node, dst_top), api_opts.merge(
+        #
+        # NOTE2: by trial-and-error, it seems that some document attributes must be set when
+        # calling 'load' and not added after the call and before the 'convert' call to have
+        # the expected effect (e.g. idprefix).
+        doc = Asciidoctor.load(doc_src, api_opts.merge(
           {
+            attributes: doc_attr,
             parse: false,
             logger: adoc_logger
           }
         ))
 
-        # piggy-back our own info on the doc attributes hash so that
-        # asciidoctor extensions can use this info later on
-        doc.attributes["giblish-info"] = {
-          src_node: src_node,
-          dst_node: dst_node,
-          dst_top: dst_top
-        }
-
         # update the destination node with the correct file suffix. This is dependent
         # on the type of conversion performed
         dst_node.name = dst_node.name.sub_ext(doc.attributes["outfilesuffix"])
@@ -252,11 +317,11 @@ module Giblish
         # make sure the dst dir exists
         d.dirname.mkpath
 
-        # write the converted doc to the file
-        output = doc.convert(api_opts.merge({logger: adoc_logger}))
+        # do the conversion and write the converted doc to file
+        output = doc.convert(api_opts)
         doc.write(output, d.to_s)
 
-        # give user the opportunity to eg store the result of the conversion
+        # give the user the opportunity to eg store the result of the conversion
         # as data in the destination node
         @conv_cb[:success]&.call(src_node, dst_node, dst_top, doc, adoc_logger.in_mem_storage.string)
         true

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -383,7 +383,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos