giblish 2.2.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12e8fae50fe3b91c7a9f62946e346baf68464dacdbc8b1552837c5c0be5f530
-  data.tar.gz: 6ef06ac7fbe2e803a96c212e13ffcc0490733e177895c2ee118755c669c9caf3
+  metadata.gz: fc2d44b3987ea014fad53e2accf48aa3734e1ba68c20328506179bf19e41621e
+  data.tar.gz: 65b013e0e91895ed2b9d882ff0249111856bbee31db29d72b08242d2cef9b3e6
 SHA512:
-  metadata.gz: 10aad9daaae9551faa3913c268d8e8554ca7a52b9dddb532fd0ebbaba07dedffc549a05dfc30f96ac1e9e0a754b79b1e13784331acdd377199f809ebfd048a7f
-  data.tar.gz: 2475c49a5c37d6ced38562a0c9425863ba7ba83239375026aa8ca2a75d611b00dee9a938e6ecb55e9d311eb995b5c02bfaed4d4c45d30f8b186447442f56e3ef
+  metadata.gz: e3cbae7cfd88de2a747dfe27e82bedf52fcb270963c8388a2f1b3e41c4401bd412a536e5d87097ce715c9c5aaf380385d85ee78b0d190669e6be1ffea24f8733
+  data.tar.gz: ca512fe02b3b3a172637bfaa955682fedbde866ba943276cc81b8389ff3b40b59e0714702d56752d11d0cf4a0b8413bbf06d371f3550a04b153c286378b0cd00

data/.gitignore

@@ -1,56 +1,23 @@
+# IDE and editor files
+.vscode/
+*.swp
+*.swo
+*~
+
+# Asciidoctor cache and generated files
+.asciidoctor/
+
+# Test artifacts
+test/tmp/
+test/output/
+coverage/
+
+# Build and packaging
+pkg/
 *.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
 
-# Used by dotenv library to load environment variables.
-# .env
+# Logs
+*.log
 
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# RubyMine idea files
-/.idea/
-
-# Local playground
-sandbox.rb
+# Temporary files
+tmp/

data/.solargraph.yml

@@ -0,0 +1,15 @@
+---
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - require_not_found
+require_paths: []
+plugins: []
+max_files: 5000

data/Changelog.adoc

@@ -7,6 +7,22 @@
  ** write instructions for github webhook triggered generation
  * Update the default css for giblish html generation.
 
+== v3.0.1
+
+ * add release scripts
+ * fix some linting issues
+
+== v3.0.0
+
+ * break out the pathtree operations into a separate gem (gran)
+ * bump ruby version to >= 3.3
+ * bump all asciidoctor dependencies to the latest available
+
+== v2.2.2
+
+ * [BUGFIX] - fix a possible null ref when generating pdfs
+ * set the 'sourcemap' attribute to true by default
+
 == v2.2.1
 
  * bump dependencies to latest versions of the asciidoctor ecosystem

data/README.adoc

@@ -206,7 +206,7 @@ Pull requests must meet the following to be considered for merging:
 
 To develop on giblish, you:
 
- . Install ruby on your local machine (rbenv is a good choice for handling ruby installations)
+ . Install ruby on your local machine (rbenv could be a good choice for handling ruby installations)
  . Install necessary dependencies to install the ruby 'mathematica' gem, see eg https://github.com/gjtorikian/mathematical/blob/47041d5492cc7c5f04105031430fb44119406f49/script/install_linux_deps
  . Install graphviz
  . Clone or fork the repository

data/giblish.gemspec

@@ -6,6 +6,7 @@ end
 
 Gem::Specification.new do |spec|
   spec.name = "giblish"
+  spec.required_ruby_version = ">= 3.3"
   spec.version = Giblish::VERSION
   spec.summary = "A tool for publishing asciidoc docs stored in git repos"
   spec.description = <<~EOF
@@ -44,30 +45,17 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Development deps
-  spec.add_development_dependency "ruby-lsp", "~> 0.11"
-  spec.add_development_dependency "minitest", "~> 5.16"
-  spec.add_development_dependency "standard", "~> 1.24.3"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "oga", "~> 3.3"
-  spec.add_development_dependency "thor", "~> 1.2"
-  spec.add_development_dependency "asciidoctor-mathematical", "~> 0.3.5"
-  # needed for the sinatra-based apps
-  spec.add_development_dependency "sinatra", "~>2.1"
-  spec.add_development_dependency "thin", "~>1.8"
-  spec.add_development_dependency "rack", "2.2.3"
-  spec.add_development_dependency "rack-test", "1.1"
-
   # 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.20"
-  spec.add_runtime_dependency "asciidoctor-diagram", ["~> 2.2"]
-  spec.add_runtime_dependency "asciidoctor-pdf", ["~> 2.3"]
-  spec.add_runtime_dependency "git", "~> 1.12"
-  spec.add_runtime_dependency "rouge", "~> 3.30"
-  spec.add_runtime_dependency "prawn-svg", "~> 0.32.0"
+  spec.add_runtime_dependency "gran", "~> 0.1", ">= 0.1.1"
+  #  spec.add_runtime_dependency "matrix", "~>0.4"
+  spec.add_runtime_dependency "warning", "~>1.0"
+  spec.add_runtime_dependency "asciidoctor", "~>2.0", ">= 2.0.25"
+  spec.add_runtime_dependency "asciidoctor-diagram", ["~> 3.0"]
+  spec.add_runtime_dependency "asciidoctor-pdf", "~> 2.3"
+  spec.add_runtime_dependency "git", "~> 4.0"
+  spec.add_runtime_dependency "rouge", "~> 4.6"
+  spec.add_runtime_dependency "prawn-svg", "~> 0.34"
 end

data/lib/giblish/application.rb

@@ -1,59 +1,12 @@
+require "gran"
+require_relative "adocsrc_providers"
 require_relative "cmdline"
 require_relative "configurator"
+require_relative "node_data_provider"
 require_relative "treeconverter"
 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 DirTreeConvert
     # This class provides a file as the source for the asciidoc info and
     # sets the document attributes required by Asciidoctor to resolve
@@ -96,7 +49,7 @@ module Giblish
 
     # build a tree of files matching user's regexp selection
     def build_src_tree(srcdir, include_regex, exclude_regex)
-      pt = PathTree.build_from_fs(srcdir) do |p|
+      pt = Gran::PathTree.build_from_fs(srcdir) do |p|
         if exclude_regex&.match(p.to_s)
           false
         else
@@ -113,8 +66,8 @@ module Giblish
     def setup_converter(src_tree, adoc_src_provider, configurator)
       # compose the doc attribute provider.
       configurator.doc_attr.add_doc_attr_providers(adoc_src_provider)
-      # NOTE: The order in the line below is important!
-      data_provider = DataDelegator.new(configurator.doc_attr, adoc_src_provider)
+      # compose the data provider for the source nodes
+      data_provider = NodeDataProvider.new(configurator.doc_attr, adoc_src_provider)
 
       # associate the data providers with each source node in the tree
       src_tree.traverse_preorder do |level, node|
@@ -178,15 +131,16 @@ module Giblish
       conf = Configurator.new(@user_opts)
       s = @gm.summary_provider
       s.index_basename = conf.config_opts.index_basename
-      data_provider = DataDelegator.new(
-        SrcFromString.new(s.source),
-        conf.doc_attr
+      data_provider = NodeDataProvider.new(
+        conf.doc_attr,
+        SrcFromString.new(s.source)
       )
-      srctree = PathTree.new("/" + conf.config_opts.index_basename + ".adoc", data_provider)
+      srctree = Gran::PathTree.new("/" + conf.config_opts.index_basename + ".adoc", data_provider)
       TreeConverter.new(srctree, @dst_topdir, conf.build_options).run
     end
   end
 
+  # The main entry point to the giblish application
   class EntryPoint
     def initialize(args, logger = nil)
       # force immediate output

data/lib/giblish/config_builders/docid_config_builder.rb

@@ -0,0 +1,84 @@
+require_relative "../docid/docid"
+require_relative "../indexbuilders/depgraphbuilder"
+
+module Giblish
+  # AIDEV-NOTE: Immutable value object for DocId configuration
+  class DocIdConfig
+    # @return [Array<DocIdExtension::DocidPreBuilder>] Pre-build processors
+    attr_reader :pre_builders
+
+    # @return [Array<DocIdExtension::DocidProcessor>] Asciidoctor preprocessors
+    attr_reader :preprocessors
+
+    # @return [Array<DependencyGraphPostBuilder>] Post-build processors
+    attr_reader :post_builders
+
+    # Creates immutable DocId configuration.
+    #
+    # @param pre_builders [Array<DocIdExtension::DocidPreBuilder>]
+    # @param preprocessors [Array<DocIdExtension::DocidProcessor>]
+    # @param post_builders [Array<DependencyGraphPostBuilder>]
+    def initialize(pre_builders:, preprocessors:, post_builders:)
+      @pre_builders = pre_builders.freeze
+      @preprocessors = preprocessors.freeze
+      @post_builders = post_builders.freeze
+      freeze
+    end
+  end
+
+  # AIDEV-NOTE: Builder for DocId configuration following established provider pattern
+  class DocIdConfigBuilder
+    # Builds complete DocId configuration based on user options.
+    # Returns a null configuration if DocId resolution is disabled.
+    #
+    # @param config_opts [CmdLine::Options] User configuration with resolve_docid flag
+    # @return [DocIdConfig] Configuration with pre-builders, preprocessors, and post-builders
+    def self.build(config_opts)
+      return null_config unless config_opts.resolve_docid
+
+      docid_prebuilder = DocIdExtension::DocidPreBuilder.new
+      docid_processor = DocIdExtension::DocidProcessor.new({id_2_node: docid_prebuilder.id_2_node})
+
+      post_builders = build_post_builders(config_opts, docid_processor)
+
+      DocIdConfig.new(
+        pre_builders: [docid_prebuilder],
+        preprocessors: [docid_processor],
+        post_builders: post_builders
+      )
+    end
+
+    # @param config_opts [CmdLine::Options]
+    # @param docid_processor [DocIdExtension::DocidProcessor]
+    # @return [Array<DependencyGraphPostBuilder>]
+    def self.build_post_builders(config_opts, docid_processor)
+      builders = []
+
+      # Add dependency graph if not disabled and graphviz is available
+      unless config_opts.no_index
+        if DependencyGraphPostBuilder.dot_supported
+          builders << DependencyGraphPostBuilder.new(
+            docid_processor.node_2_ids,
+            nil,
+            nil,
+            nil,
+            config_opts.graph_basename
+          )
+        end
+      end
+
+      builders
+    end
+
+    # @return [DocIdConfig]
+    def self.null_config
+      DocIdConfig.new(
+        pre_builders: [],
+        preprocessors: [],
+        post_builders: []
+      )
+    end
+
+    private_class_method :build_post_builders, :null_config
+  end
+end

data/lib/giblish/config_builders/git_index_config_builder.rb

@@ -0,0 +1,37 @@
+require_relative "index_config_builder"
+require_relative "../gitrepos/history_pb"
+require_relative "../indexbuilders/subtree_indices"
+
+module Giblish
+  # AIDEV-NOTE: Builder for git-specific Index configuration with history support
+  class GitIndexConfigBuilder
+    # Builds complete Index configuration with git history support.
+    # Returns a null configuration if index generation is disabled.
+    #
+    # @param config_opts [CmdLine::Options] User configuration with no_index flag
+    # @param resource_paths [ResourcePaths] Resolved paths for templates
+    # @param doc_attr [DocAttrBuilder] Document attribute builder
+    # @param git_repo_dir [Pathname] Path to git repository root
+    # @return [IndexConfig] Configuration with index generation and git history support
+    def self.build(config_opts, resource_paths, doc_attr, git_repo_dir)
+      return IndexConfigBuilder.null_config if config_opts.no_index
+
+      post_builders = []
+      post_builders << AddHistoryPostBuilder.new(git_repo_dir)
+
+      adoc_src_provider = SubtreeIndexGit.new(
+        {erb_template_path: resource_paths.idx_erb_template_abs}
+      )
+
+      idx = SubtreeInfoBuilder.new(
+        doc_attr,
+        nil,
+        adoc_src_provider,
+        config_opts.index_basename
+      )
+      post_builders << idx
+
+      IndexConfig.new(post_builders: post_builders)
+    end
+  end
+end

data/lib/giblish/config_builders/index_config_builder.rb

@@ -0,0 +1,53 @@
+require_relative "../subtreeinfobuilder"
+require_relative "../indexbuilders/subtree_indices"
+
+module Giblish
+  # AIDEV-NOTE: Immutable value object for Index configuration
+  class IndexConfig
+    # @return [Array<SubtreeInfoBuilder>] Post-build processors for index generation
+    attr_reader :post_builders
+
+    # Creates immutable Index configuration.
+    #
+    # @param post_builders [Array<SubtreeInfoBuilder>]
+    def initialize(post_builders:)
+      @post_builders = post_builders.freeze
+      freeze
+    end
+  end
+
+  # AIDEV-NOTE: Builder for Index configuration following established provider pattern
+  class IndexConfigBuilder
+    # Builds complete Index configuration with index generation support.
+    # Returns a null configuration if index generation is disabled.
+    #
+    # @param config_opts [CmdLine::Options] User configuration with no_index flag
+    # @param resource_paths [ResourcePaths] Resolved paths for templates
+    # @param doc_attr [DocAttrBuilder] Document attribute builder
+    # @param adoc_src_provider_class [Class] Class for generating index source (defaults to SubtreeIndexBase)
+    # @return [IndexConfig] Configuration with index generation post-builders
+    def self.build(config_opts, resource_paths, doc_attr, adoc_src_provider_class = SubtreeIndexBase)
+      return null_config if config_opts.no_index
+
+      adoc_src_provider = adoc_src_provider_class.new(
+        {erb_template_path: resource_paths.idx_erb_template_abs}
+      )
+
+      idx = SubtreeInfoBuilder.new(
+        doc_attr,
+        nil,
+        adoc_src_provider,
+        config_opts.index_basename
+      )
+
+      IndexConfig.new(post_builders: [idx])
+    end
+
+    # @return [IndexConfig]
+    def self.null_config
+      IndexConfig.new(post_builders: [])
+    end
+
+    private_class_method :null_config
+  end
+end

data/lib/giblish/config_utils.rb

@@ -1,44 +1,2 @@
 module Giblish
-  # delegates all method calls to the first supplied delegate that
-  # implements it.
-  class DataDelegator
-    attr_reader :delegates
-
-    def initialize(*delegate_arr)
-      @delegates = Array(delegate_arr)
-    end
-
-    def add(delegate)
-      @delegates << delegate
-    end
-
-    # define this to short-cut circular references
-    #
-    # TODO: This should probably be avoided by refactoring the SuccessfulConversion
-    # class which, as of this writing, is part of a circular ref to a PathTree which
-    # throws 'inspect' calls into an eternal loop instead of implementing a custom 'inspect'
-    # method.
-    def inspect
-      @delegates.map do |d|
-        "<#{d.class}:#{d.object_id}>"
-      end.join(",")
-    end
-
-    def method_missing(m, *args, &block)
-      del = @delegates&.find { |d| d.respond_to?(m) }
-      if del.nil?
-        Giblog.logger.warn { "Did not find method '#{m}' in any delegate (#{@delegates}"}
-      end
-
-      del.nil? ? super : del.send(m, *args, &block)
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      ok = @delegates.find { |d|
-        d.respond_to?(method_name)
-      }
-
-      ok || super(method_name, include_private)
-    end
-  end
 end