giblish 2.2.2 → 3.0.0

data/lib/giblish/node_data_provider.rb

@@ -0,0 +1,137 @@
+module Giblish
+  # Provides a unified interface for node data by explicitly composing
+  # multiple providers into a single object.
+  #
+  # Supports dynamic composition - providers can be added after initialization.
+  # Each method explicitly delegates to the first provider that responds to it.
+  class NodeDataProvider
+    def initialize(*providers)
+      @providers = Array(providers).compact
+    end
+
+    def add_provider(provider)
+      @providers << provider
+      self
+    end
+
+    # === Source Node Interface (DocAttrBuilder + AdocSrcProvider) ===
+
+    def document_attributes(src_node, dst_node, dst_top)
+      provider = find_provider(:document_attributes)
+      provider.document_attributes(src_node, dst_node, dst_top)
+    end
+
+    def adoc_source(src_node, dst_node, dst_top)
+      provider = find_provider(:adoc_source)
+      provider.adoc_source(src_node, dst_node, dst_top)
+    end
+
+    def api_options(src_node, dst_node, dst_top)
+      provider = find_provider(:api_options, raise_on_missing: false)
+      return {} unless provider
+      provider.api_options(src_node, dst_node, dst_top)
+    end
+
+    # === Conversion Info Interface (SuccessfulConversion / FailedConversion) ===
+
+    def src_node
+      provider = find_provider(:src_node)
+      provider.src_node
+    end
+
+    def dst_node
+      provider = find_provider(:dst_node)
+      provider.dst_node
+    end
+
+    def dst_top
+      provider = find_provider(:dst_top)
+      provider.dst_top
+    end
+
+    def converted
+      provider = find_provider(:converted)
+      provider.converted
+    end
+
+    def src_rel_path
+      provider = find_provider(:src_rel_path)
+      provider.src_rel_path
+    end
+
+    def src_basename
+      provider = find_provider(:src_basename)
+      provider.src_basename
+    end
+
+    def title
+      provider = find_provider(:title)
+      provider.title
+    end
+
+    def docid
+      provider = find_provider(:docid)
+      provider.docid
+    end
+
+    def to_s
+      provider = find_provider(:to_s)
+      provider.to_s
+    end
+
+    # SuccessfulConversion specific
+    def stderr
+      provider = find_provider(:stderr)
+      provider.stderr
+    end
+
+    def adoc
+      provider = find_provider(:adoc)
+      provider.adoc
+    end
+
+    def dst_rel_path
+      provider = find_provider(:dst_rel_path)
+      provider.dst_rel_path
+    end
+
+    def purpose_str
+      provider = find_provider(:purpose_str)
+      provider.purpose_str
+    end
+
+    # FailedConversion specific
+    def error_msg
+      provider = find_provider(:error_msg)
+      provider.error_msg
+    end
+
+    # === History Interface (FileHistory) ===
+
+    def history
+      provider = find_provider(:history, raise_on_missing: false)
+      return nil unless provider
+      provider.history
+    end
+
+    def branch
+      provider = find_provider(:branch, raise_on_missing: false)
+      return nil unless provider
+      provider.branch
+    end
+
+    def respond_to?(method_name, include_private = false)
+      find_provider(method_name, raise_on_missing: false) ? true : super
+    end
+
+    private
+
+    def find_provider(method_name, raise_on_missing: true)
+      provider = @providers.find { |p| p.respond_to?(method_name) }
+      if provider.nil? && raise_on_missing
+        raise NoMethodError, "None of the providers respond to '#{method_name}'"
+      end
+      provider
+    end
+  end
+end

data/lib/giblish/resourcepaths.rb

@@ -1,4 +1,5 @@
 require "pathname"
+require "gran"
 
 module Giblish
   # Provides relevant paths for layout resources based on the given options
@@ -54,7 +55,7 @@ module Giblish
       return if @src_resource_dir_abs.nil?
 
       # Tweak paths based on the content of a given resource dir
-      file_tree = PathTree.build_from_fs(@src_resource_dir_abs)
+      file_tree = Gran::PathTree.build_from_fs(@src_resource_dir_abs)
 
       @src_style_path_rel = find_style_file(file_tree, cmd_opts.format, cmd_opts.style_name)
       @src_style_path_abs = @src_resource_dir_abs / @src_style_path_rel if @src_style_path_rel
@@ -186,7 +187,7 @@ module Giblish
       return if @asset_regex.nil?
 
       # build a tree with all dirs matching the given regexp
-      st = PathTree.build_from_fs(@srcdir, prune: true) do |p|
+      st = Gran::PathTree.build_from_fs(@srcdir, prune: true) do |p|
         p.directory? && @asset_regex =~ p.to_s
       end
 

data/lib/giblish/search/searchquery.rb

@@ -17,7 +17,7 @@ module Giblish
     end
 
     def css_path
-      @parameters.key?("css-path") && !@parameters["css-path"].empty? ? Pathname.new(@parameters["css-path"]) : nil
+      (@parameters.key?("css-path") && !@parameters["css-path"].empty?) ? Pathname.new(@parameters["css-path"]) : nil
     end
 
     def search_assets_top_rel
@@ -33,9 +33,9 @@ module Giblish
       @parameters.key?("as-regexp")
     end
 
-    def method_missing(meth, *args, &block)
+    def method_missing(meth, ...)
       unless respond_to_missing?(meth)
-        super(meth, *args, &block)
+        super
         return
       end
 

data/lib/giblish/search/textsearcher.rb

@@ -1,7 +1,7 @@
 require "pathname"
 require "json"
+require "gran"
 require_relative "searchquery"
-require_relative "../pathtree"
 
 module Giblish
   # reads all lines in the given file at instantiation and
@@ -21,7 +21,7 @@ module Giblish
     def wash_line(line)
       # remove some asciidoctor format sequences
       # '::', '^|===', '^==', '^--, ':myvar: ...'
-      r = Regexp.new(/(::+|^[=|]+|^--+|^:\w+:.*$)/)
+      r = /(::+|^[=|]+|^--+|^:\w+:.*$)/
       line.gsub(r, "")
     end
   end
@@ -205,7 +205,7 @@ module Giblish
     def build_src_tree
       # setup the tree of source files and pro-actively read in all text
       # into memory
-      src_tree = PathTree.build_from_fs(@assets_fs_path, prune: false) do |p|
+      src_tree = Gran::PathTree.build_from_fs(@assets_fs_path, prune: false) do |p|
         p.extname.downcase == ".adoc"
       end
       src_tree.traverse_preorder do |level, node|

data/lib/giblish/subtreeinfobuilder.rb

@@ -1,5 +1,5 @@
 require "pathname"
-require_relative "pathtree"
+require "gran"
 
 module Giblish
   class SubtreeSrcItf
@@ -75,7 +75,7 @@ module Giblish
         # with this object as source for conversion options
         # and adoc_source
         v_path = Pathname.new("/virtual") / index_dir / "#{@basename}.adoc"
-        v_tree = PathTree.new(v_path, self)
+        v_tree = Gran::PathTree.new(v_path, self)
         src_node = v_tree.node(v_path, from_root: true)
 
         # add the destination node where the converted file will be stored

data/lib/giblish/treeconverter.rb

@@ -1,7 +1,8 @@
 require "asciidoctor"
 require "asciidoctor-pdf"
-require_relative "pathtree"
+require "gran"
 require_relative "conversion_info"
+require_relative "node_data_provider"
 require_relative "utils"
 
 module Giblish
@@ -70,7 +71,7 @@ module Giblish
 
       # get the top-most node of the source and destination trees
       @src_tree = src_top
-      @dst_tree = PathTree.new(dst_top).node(dst_top, from_root: true)
+      @dst_tree = Gran::PathTree.new(dst_top).node(dst_top, from_root: true)
 
       # setup build-phase callback objects
       @pre_builders = Array(opts.fetch(:pre_builders, []))
@@ -127,20 +128,24 @@ module Giblish
     end
 
     # the default callback will tie a 'SuccessfulConversion' instance
-    # to the destination node as its data
+    # to the destination node as its data, wrapped in NodeDataProvider
+    # to allow dynamic addition of other providers (e.g., history)
     def self.on_success(src_node, dst_node, dst_tree, doc, adoc_log_str)
-      dst_node.data = DataDelegator.new(SuccessfulConversion.new(
+      conversion_info = SuccessfulConversion.new(
         src_node: src_node, dst_node: dst_node, dst_top: dst_tree, adoc: doc, adoc_stderr: adoc_log_str
-      ))
+      )
+      dst_node.data = NodeDataProvider.new(conversion_info)
     end
 
     # the default callback will tie a 'FailedConversion' instance
-    # to the destination node as its data
+    # to the destination node as its data, wrapped in NodeDataProvider
+    # to allow dynamic addition of other providers (e.g., history)
     def self.on_failure(src_node, dst_node, dst_tree, ex, adoc_log_str)
       Giblog.logger.error { ex.message }
-      dst_node.data = DataDelegator.new(FailedConversion.new(
+      conversion_info = FailedConversion.new(
         src_node: src_node, dst_node: dst_node, dst_top: dst_tree, error_msg: ex.message
-      ))
+      )
+      dst_node.data = NodeDataProvider.new(conversion_info)
     end
   end
 

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "2.2.2".freeze
+  VERSION = "3.0.0".freeze
 end

metadata

@@ -1,197 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Anders Rillbert
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-07 00:00:00.000000000 Z
+date: 2025-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-lsp
+  name: gran
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.24.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.24.3
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: oga
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: asciidoctor-mathematical
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.5
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: thin
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.2.3
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: matrix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
@@ -201,7 +47,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.20
+        version: 2.0.25
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -211,21 +57,21 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.20
+        version: 2.0.25
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
@@ -246,42 +92,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.30'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.30'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: prawn-svg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: '0.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: '0.34'
 description: |
   giblish generates indexed and searchable documents from a tree of
   asciidoc files.
@@ -292,12 +138,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/unit_tests.yml"
 - ".gitignore"
-- ".ruby-version"
+- ".solargraph.yml"
 - Changelog.adoc
 - LICENSE
 - README.adoc
+- diagram-classes.png
 - docs/concepts/text_search.adoc
 - docs/concepts/text_search_im/cgi-search_request.puml
 - docs/concepts/text_search_im/cgi-search_request.svg
@@ -322,6 +168,9 @@ files:
 - lib/giblish/adocsrc_providers.rb
 - lib/giblish/application.rb
 - lib/giblish/cmdline.rb
+- lib/giblish/config_builders/docid_config_builder.rb
+- lib/giblish/config_builders/git_index_config_builder.rb
+- lib/giblish/config_builders/index_config_builder.rb
 - lib/giblish/config_utils.rb
 - lib/giblish/configurator.rb
 - lib/giblish/conversion_info.rb
@@ -343,7 +192,10 @@ files:
 - lib/giblish/indexbuilders/templates/tree.html.erb
 - lib/giblish/indexbuilders/templates/treemap.html.erb
 - lib/giblish/indexbuilders/verbatimtree.rb
-- lib/giblish/pathtree.rb
+- lib/giblish/layout_config/html_layout_config.rb
+- lib/giblish/layout_config/layout_config_result.rb
+- lib/giblish/layout_config/pdf_layout_config.rb
+- lib/giblish/node_data_provider.rb
 - lib/giblish/resourcepaths.rb
 - lib/giblish/search/expand_adoc.rb
 - lib/giblish/search/headingindexer.rb
@@ -382,7 +234,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/rillbert/giblish/issues
   source_code_uri: https://github.com/rillbert/giblish
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -390,15 +242,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.5.22
+signing_key: 
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos
 test_files: []

data/.github/workflows/unit_tests.yml

@@ -1,30 +0,0 @@
-name: Giblish CI checks
-
-on:
-  push:
-    branches: [personal/rillbert/*, main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ["2.7", "3.0", "3.1"]
-
-    steps:
-      - name: Install binutils
-        run: |
-          sudo apt -y install binutils
-      - name: Install needed packages
-        run: |
-          sudo apt-get -y install libpango1.0-dev graphviz libwebp-dev libzstd-dev
-      - name: Checkout Giblish
-        uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-      - name: Run tests
-        run: |
-          bundle exec rake

data/.ruby-version

@@ -1 +0,0 @@
-3.1.3