asciidoctor-reducer 1.0.0.alpha.6 → 1.0.0.alpha.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30089ea8ab059ef848713ada56dd9457f4d6681c80de8028b92a9d02b21b0544
-  data.tar.gz: f38c68d1f15627a4d74fd5376fb3ec9a5b6ad29345c10ea882ff988c875922a9
+  metadata.gz: 80723a5097c54761a2bee3b3ea88f827c88614b7a5572a6b5f1b10cb7af60c8c
+  data.tar.gz: d6f23a15e6dae8db02f5810d22018f537af9d6e67ac8362dbc2fe3155417df2d
 SHA512:
-  metadata.gz: a3ec843b92513164762d9647d963238073bff89c66619205166b26199a23e65d85ee5aaf23c2a60c953eae52d17ed36cbb7499dd7afb2040692912065171db12
-  data.tar.gz: df40e3f0c244ed21ea052536844df17f536c84a12252008d1c7dbdc04ad85ec00f3aabae81242550eda9a394497db386bd12b34f5110f323f61a8bdbc8ec30c6
+  metadata.gz: db4173fd2899008fec759e9d76f2732a7f5f7ca0a284f5c66a93040b9fca81dba22cf151e77e86b2b73c535545cec4b3a54c88407324514811260832b8ed1c7d
+  data.tar.gz: ec7a7d27cb1b87dcb0772af642f185002f7348e0a540c40bf3a6e98334d7be0b088b8b00312ca10dd5470cdaff60007e70c2d27708d97c4677c7a3302694473e

data/CHANGELOG.adoc

@@ -4,6 +4,76 @@
 This document provides a high-level view of the changes to the Asciidoctor Reducer by release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 1.0.0.alpha.9 (2022-04-21) - @mojavelinux
+
+=== Added
+
+* Add `Asciidoctor::Reducer::IncludeMapper` auxiliary extension, required by `asciidoctor/reducer/include_mapper/extension` (#26)
+* Register `Asciidoctor::Reducer::IncludeMapper` extension when `asciidoctor/reducer/include_mapper` is required (#26)
+* Add `Asciidoctor::Reducer::Extensions.key` method that returns key for registering extension group
+* Update help text to note that the `-a` and `-r` CLI options may be specified multiple times
+* Automate the release process
+
+=== Changed
+
+* Rename x_include_replacements attr on reader to include_replacements since it's public
+* Don't pass `:to` option to `Asciidoctor.load_file`
+* Make `Asciidoctor::Reducer::Cli` a module instead of a class
+
+=== Fixed
+
+* Replace remote include with link if `allow-uri-read` attribute is not set
+* Don't raise error if `Asciidoctor::Reducer::Extensions.unregister` is called when extensions are not registered globally
+* Ensure output is written to file with universal newlines (\n) on Windows
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.9[git tag] | {url-repo}/compare/v1.0.0.alpha.8\...v1.0.0.alpha.9[full diff]
+
+== 1.0.0.alpha.8 (2022-02-23) - @mojavelinux
+
+=== Added
+
+* Add secure mode as value of `-S` CLI option (#31)
+* Add `--trace` option to CLI to trace cause of application errors (#29)
+
+=== Changed
+
+* Replace include directive with link macro if safe mode is secure (#31)
+* Track line numbers in include replacements using 1-based index
+* Only mix in preprocessor conditional tracker if `:preserve_conditionals` option is not set (#36)
+
+=== Fixed
+
+* Handle signals gracefully (#33)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.8[git tag]
+
+== 1.0.0.alpha.7 (2022-02-14) - @mojavelinux
+
+=== Added
+
+* Add asciidoctor/reducer/api to require main API (#3)
+* Add `Asciidoctor::Reducer.reduce` and `Asciidoctor::Reducer.reduce_file` API methods (#3)
+* Add asciidoctor/reducer/extensions to require extensions API (#3)
+* Add `Asciidoctor::Reducer::Extensions` API (#3)
+
+=== Changed
+
+* Scope extensions to single call instead of registering them globally (#3)
+* Use `:safe` as the default safe mode when using the API
+* Make `CurrentPosition` module private to the `PreprocessorDirectiveTracker` module
+
+=== Fixed
+
+* Require asciidoctor/reducer/version automatically when `Asciidoctor::Reducer::VERSION` is accessed
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.7[git tag]
+
 == 1.0.0.alpha.6 (2022-02-10) - @mojavelinux
 
 === Added
@@ -24,6 +94,10 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 * Prevent custom extension registry from activating extensions twice during reload (#21)
 * Retain includes table in document catalog when reloading document (#23)
 
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.6[git tag]
+
 == 1.0.0.alpha.5 (2022-02-06) - @mojavelinux
 
 === Changed
@@ -37,12 +111,20 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 * Suppress log messages when reloading document (#14)
 
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.5[git tag]
+
 == 1.0.0.alpha.4 (2022-02-03) - @mojavelinux
 
 === Fixed
 
 * Fix replacement of nested empty and unresolved includes
 
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.4[git tag]
+
 == 1.0.0.alpha.3 (2022-02-02) - @mojavelinux
 
 === Changed
@@ -52,6 +134,10 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 * Only reload document if source lines have changed; otherwise, update source lines on reader directly
 * Change default safe mode for CLI to :unsafe
 
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.3[git tag]
+
 == 1.0.0.alpha.2 (2022-01-27) - @mojavelinux
 
 === Added
@@ -71,30 +157,14 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 * Preserve return value when overridding `preprocess_include_directive` method
 
-== 1.0.0.alpha.1 (2022-01-12) - @mojavelinux
-
-Initial release.
-
-=== Details
-
-{url-repo}/releases/tag/v1.0.0.alpha.1[git tag]
-
 === Details
 
 {url-repo}/releases/tag/v1.0.0.alpha.2[git tag]
 
-=== Details
-
-{url-repo}/releases/tag/v1.0.0.alpha.3[git tag]
-
-=== Details
-
-{url-repo}/releases/tag/v1.0.0.alpha.4[git tag]
-
-=== Details
+== 1.0.0.alpha.1 (2022-01-12) - @mojavelinux
 
-{url-repo}/releases/tag/v1.0.0.alpha.5[git tag]
+Initial release.
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.6[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.1[git tag]

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2021 Dan Allen
+Copyright (C) 2021-present Dan Allen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0.alpha.6, 2022-02-10
+v1.0.0.alpha.9, 2022-04-21
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -16,16 +16,16 @@ endif::[]
 :url-rvm: https://rvm.io
 :url-repo: https://github.com/asciidoctor/{project-handle}
 
-{project-name} is a tool that reduces a composite AsciiDoc document containing includes to a single AsciiDoc document by expanding any includes reachable from the parent document.
-The tool also applies preprocessor conditionals (unless the option to preserve them is specified), leaving behind only the enabled lines.
+{project-name} is a tool that reduces an AsciiDoc document that contains includes to a single AsciiDoc document by expanding any includes reachable from the parent document.
+The tool also applies preprocessor conditionals (unless the option to preserve them is specified), leaving behind only the selected lines.
 If the document does not contain any preprocessor directives, the tool returns the original source.
 
 == Prerequisites
 
-{project-name} is a Ruby program that you install using Ruby packaging.
+{project-name} is a Ruby application that you install using Ruby packaging.
 To install and run {project-name}, you need Ruby 2.5 or better.
 
-Run the following command to check whether you have Ruby installed and to check which version:
+Run the following command to check which version of Ruby you have installed, if any:
 
  $ ruby -v
 
@@ -41,7 +41,9 @@ You can install the latest version of the gem using the following command:
  $ gem install asciidoctor-reducer --pre
 
 Installing this gem makes the `asciidoctor-reducer` command available on your $PATH.
-You can also require the gem into the Ruby runtime to use it as an Asciidoctor extension.
+You can also require the gem into the Ruby runtime to use it as a library or Asciidoctor extension.
+
+=== Project-scoped
 
 If you prefer to manage the application as a project-scoped dependency, you can declare the gem in the project's [.path]_Gemfile_:
 
@@ -61,7 +63,7 @@ Installing the gem this way makes the `bundle exec asciidoctor-reducer` command
 
 == Usage
 
-=== As command
+=== Command
 
 You can run this tool using the provided command (i.e., CLI), named `asciidoctor-reducer`.
 To learn how to use the command, and to verify it's available, run the command with the `-h` option:
@@ -75,7 +77,7 @@ asciidoctor-reducer [OPTION]... FILE
 ....
 
 The argument `FILE` is the AsciiDoc file you want to reduce.
-The options, represented by `[OPTION]...`, are optional, as the name suggestions.
+The options, represented by `+[OPTION]...+`, are optional, as the name suggestions.
 
 Thus, to use the command, pass the AsciiDoc file as the sole argument:
 
@@ -91,27 +93,26 @@ To use the command in this way, pass `-` as the first argument:
 
  $ cat input.adoc | asciidoctor-reducer -
 
-To write the output to a file instead of stdout, also specify an output file using the `-o` option:
+To write the output to a file in this case, specify an output file using the `-o` option:
 
  $ cat input.adoc | asciidoctor-reducer -o output.adoc -
 
-Note that top-level include files in the input AsciiDoc document are resolved relative to current working directory.
-
-=== As extension
+=== API
 
-You can use this tool as an Asciidoctor extension when using the Asciidoctor API.
-To do so, require it before calling the `Asciidoctor.load` method.
+You can also use this tool from a Ruby application using the provided API.
+To begin, require the API for this library.
 
 [,ruby]
 ----
-require 'asciidoctor/reducer'
+require 'asciidoctor/reducer/api'
 ----
 
-Next, load a parent document that contains includes.
+Next, reduce a parent document that contains includes.
+This works without having to specify the safe mode since the default safe mode when using the API is `:safe`.
 
 [,ruby]
 ----
-doc = Asciidoctor.load_file 'sample.adoc', safe: :safe
+doc = Asciidoctor::Reducer.reduce_file 'sample.adoc'
 ----
 
 Finally, you can retrieve the reduced source from the returned document.
@@ -121,11 +122,60 @@ Finally, you can retrieve the reduced source from the returned document.
 puts doc.source
 ----
 
-You can write this source to a file to save the reduced document.
+The benefit of this approach is that you can access the reduced source and the parsed document that corresponds to it.
+
+If you don't need the parsed document, you can retrieve the reduced source directly by passing the `String` type to the `:to` option:
+
+[,ruby]
+----
+puts Asciidoctor::Reducer.reduce_file 'sample.adoc', to: String
+----
+
+You can write the reduced source directly to a file by passing a file path to the `:to` option:
+
+[,ruby]
+----
+Asciidoctor::Reducer.reduce_file 'sample.adoc', to: 'sample-reduced.adoc'
+----
+
+== Extension
+
+Instead of using the API for this library, you can use the load API provided by Asciidoctor.
+If you want to register the extension globally, require the library as follows:
+
+[,ruby]
+----
+require 'asciidoctor/reducer'
+----
+
+When you use the Asciidoctor load API, the document will automatically be reduced.
+
+[,ruby]
+----
+puts (Asciidoctor.load_file 'sample.adoc', safe: :safe).source
+----
+
+If you want to keep the extension scoped to the call, require the library as follows:
+
+[,ruby]
+----
+require 'asciidoctor/reducer/extensions'
+----
+
+Next, use the extensions API to prepare an extension registry and pass it to the Asciidoctor load API:
+
+[,ruby]
+----
+puts (Asciidoctor.load_file 'sample.adoc', safe: :safe, extension_registry: Asciidoctor::Reducer.prepare_registry).source
+----
+
+Working with the extension directly is intended for low-level operations.
+Most of the time, you should use the API provided by this library.
 
 == How it Works
 
 {project-name} uses a collection of Asciidoctor extensions to rebuild the AsciiDoc source as a single document.
+Top-level include files in the input AsciiDoc document are resolved relative to current working directory.
 
 It starts by using a preprocessor extension to enhance the PreprocessorReader class to be notified each time an include is entered (pushed) or exited (popped).
 When an include directive is encountered, the enhanced reader stores the resolved lines and location of the include directive, thus keeping track of where those lines should be inserted in the original source.
@@ -147,6 +197,69 @@ This call will cause extensions that run during the load phase to be invoked aga
 An extension can check for this secondary load by checking for the `:reduced` option in the `Document#options` hash.
 If this option is set (the value of which will be `true`), then Asciidoctor is loading the reduced document.
 
+== Include Mapper (Experimental)
+
+One of the challenges of reducing a document is that interdocument xrefs that rely on the includes being registered in the document catalog no longer work.
+That's because when the reduced document is converted, it has no includes and thus all interdocument xrefs are colocated in the same source file.
+To work around this shortcoming, {project-name} provides a utility extension named the include mapper that will carry over the includes in the document catalog to the reduced document so they can be imported during conversion.
+
+CAUTION: The include mapper is experimental and thus subject to change.
+
+To use the include mapper when using the CLI to reduce the document, require it using the `-r` option as follows:
+
+ $ asciidoctor-reducer -r asciidoctor/reducer/include_mapper -o input-reduced.adoc input.adoc
+
+To use the include mapper when converting the reduced document, again require it using the `-r` option as follows:
+
+ $ asciidoctor -r asciidoctor/reducer/include_mapper input-reduced.adoc
+
+To use the include mapper when using the API, first require the extension:
+
+[,ruby]
+----
+require 'asciidocotor/reducer/include_mapper/extension'
+----
+
+You then need to register the extension when reducing the document:
+
+[,ruby]
+----
+Asciidoctor::Reducer.reduce_file 'sample.adoc', to: 'sample-reduced.adoc', extensions: proc {
+  next if document.options[:reduced]
+  tree_processor Asciidoctor::Reducer::IncludeMapper
+}
+----
+
+Then register it again when converting the reduced document:
+
+[,ruby]
+----
+Asciidoctor.convert_file 'sample-reduced.adoc', safe: :safe, extensions: proc {
+  tree_processor Asciidoctor::Reducer::IncludeMapper
+}
+----
+
+You can also register the extension globally:
+
+[,ruby]
+----
+require 'asciidocotor/reducer/include_mapper'
+----
+
+In this case, you don't have to pass it to the API explicitly.
+
+=== How it Works
+
+The include mapper works by adding a magic comment to the bottom of the reduced file.
+Here's an example of that comment:
+
+[,asciidoc]
+----
+//# includes=chapters/chapter-a,chapters/chapter-b
+----
+
+When a document that contains the magic comment is converted, the include mapper reads the comma-separated paths in the value and loads them into the includes table of the document catalog.
+
 == Development
 
 Follow the instructions below to learn how to help develop the project or test-drive the development version.
@@ -191,7 +304,7 @@ For more fine-grained control, you can also run the tests directly using RSpec:
 
 To run all tests in a single spec, point RSpec at the spec file:
 
- $ bundle exec rspec spec/asciidoctor_reducer_spec.rb
+ $ bundle exec rspec spec/reducer_spec.rb
 
 ==== Run specific tests
 

data/asciidoctor-reducer.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
 
   s.add_development_dependency 'rake', '~> 13.0.0'
-  s.add_development_dependency 'rspec', '~> 3.10.0'
+  s.add_development_dependency 'rspec', '~> 3.11.0'
 end

data/bin/asciidoctor-reducer

@@ -1,13 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-asciidoctor_reducer = File.absolute_path '../lib/asciidoctor/reducer', __dir__
-if File.exist? asciidoctor_reducer
-  require asciidoctor_reducer
-else
-  require 'asciidoctor/reducer'
-end
-
-require 'asciidoctor/reducer/cli'
-
+asciidoctor_reducer_cli = File.join (File.dirname __dir__), 'lib/asciidoctor/reducer/cli.rb'
+require (File.file? asciidoctor_reducer_cli) ? asciidoctor_reducer_cli : 'asciidoctor/reducer/cli'
 exit Asciidoctor::Reducer::Cli.run

data/lib/asciidoctor/reducer/api.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+autoload :Pathname, 'pathname'
+require_relative 'extensions'
+
+module Asciidoctor::Reducer
+  autoload :VERSION, (::File.join __dir__, 'version.rb')
+
+  class << self
+    def reduce input, opts = {}
+      opts = opts&.merge || {}
+      if (extension_registry = Extensions.prepare_registry opts[:extension_registry] || opts[:extensions])
+        opts[:extension_registry] = extension_registry
+      end
+      opts[:safe] ||= :safe
+      to = opts.delete :to
+      case input
+      when ::File
+        doc = ::Asciidoctor.load_file input, opts
+      when ::Pathname
+        doc = ::Asciidoctor.load_file input.to_path, opts
+      else
+        doc = ::Asciidoctor.load input, opts
+      end
+      write doc, to
+    end
+
+    def reduce_file input_file, opts = {}
+      reduce (::Pathname.new input_file), opts
+    end
+
+    private
+
+    def write doc, to
+      return doc unless to && to != '/dev/null'
+      output = doc.source
+      return output if to == ::String
+      output += LF unless output.empty?
+      if ::Pathname === to || (!(to.respond_to? :write) && (to = ::Pathname.new to.to_s))
+        to.dirname.mkpath
+        to.write output, encoding: UTF_8, newline: :universal
+      else
+        to.write output
+      end
+      doc
+    end
+  end
+
+  LF = ?\n
+  UTF_8 = ::Encoding::UTF_8
+
+  private_constant :LF, :UTF_8
+end

data/lib/asciidoctor/reducer/cli.rb

@@ -1,127 +1,141 @@
 # frozen_string_literal: true
 
+require_relative 'api'
 autoload :OptionParser, 'optparse'
-autoload :Pathname, 'pathname'
 
 module Asciidoctor::Reducer
-  autoload :VERSION, (::File.join __dir__, 'version.rb')
-
-  class Cli
-    LOG_LEVELS = (::Logger::Severity.constants false).each_with_object({}) do |level, accum|
-      accum[level.to_s.downcase] = (::Logger::Severity.const_get level) unless level == :UNKNOWN
-    end
+  module Cli
+    class << self
+      def parse args
+        options = { attributes: {}, log_level: LOG_LEVELS['warn'], safe: :unsafe }
+
+        opt_parser = ::OptionParser.new do |opts|
+          opts.program_name = 'asciidoctor-reducer'
+          opts.banner = <<~END
+          Usage: #{opts.program_name} [OPTION]... FILE
+
+          Reduces a composite AsciiDoc document containing includes and conditionals to a single AsciiDoc document.
+
+          END
+
+          opts.on '-a KEY[=VALUE]', '--attribute=KEY[=VALUE]',
+            'set a document attribute in the AsciiDoc document: [key, key!, key=value]',
+            'may be specified multiple times' do |attr|
+            key, val = attr.split '=', 2
+            val ||= ''
+            options[:attributes][key] = val
+          end
 
-    def parse args
-      options = { attributes: {}, log_level: LOG_LEVELS['warn'], safe: :unsafe }
+          opts.on '--log-level LEVEL', %w(debug info warn error fatal),
+            'set the minimum level of messages to log: [debug, info, warn, error, fatal] (default: warn)' do |level|
+            options[:log_level] = level
+          end
 
-      opt_parser = ::OptionParser.new do |opts|
-        opts.program_name = 'asciidoctor-reducer'
-        opts.banner = <<~EOS
-        Usage: #{opts.program_name} [OPTION]... FILE
+          opts.on '-o FILE', '--output=FILE', 'set the output filename or stream' do |file|
+            options[:output_file] = file
+          end
 
-        Reduces a composite AsciiDoc document containing includes and conditionals to a single AsciiDoc document.
+          opts.on '--preserve-conditionals', 'preserve preprocessor conditional directives in the reduced source' do
+            options[:preserve_conditionals] = true
+          end
 
-        EOS
+          opts.on '-q', '--quiet', 'suppress all application log messages' do
+            options[:log_level] = nil
+          end
 
-        opts.on '-a KEY[=VALUE]', '--attribute=KEY[=VALUE]',
-          'set a document attribute in the AsciiDoc document: [key, key!, key=value]' do |attr|
-          key, val = attr.split '=', 2
-          val ||= ''
-          options[:attributes][key] = val
-        end
+          opts.on '-rLIBRARY', '--require LIBRARY', 'require the specified library or libraries before reducing',
+            'may be specified multiple times' do |path|
+            (options[:requires] ||= []).concat path.split ','
+          end
 
-        opts.on '--log-level LEVEL', %w(debug info warn error fatal),
-          'set the minimum level of messages to log: [debug, info, warn, error, fatal] (default: warn)' do |level|
-          options[:log_level] = level
-        end
+          opts.on '-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'server', 'secure'],
+            'set safe mode level: [unsafe, safe, server, secure] (default: unsafe)' do |name|
+            options[:safe] = name.to_sym
+          end
 
-        opts.on '-o FILE', '--output=FILE', 'set the output filename or stream' do |file|
-          options[:output_file] = file
-        end
+          opts.on '--trace', 'trace the cause of application errors (default: false)' do
+            options[:trace] = true
+          end
 
-        opts.on '--preserve-conditionals', 'preserve preprocessor conditional directives in the reduced source' do
-          options[:preserve_conditionals] = true
-        end
+          opts.on '-v', '--version', 'display the version information and exit' do
+            print_version opts
+            return 0
+          end
 
-        opts.on '-q', '--quiet', 'suppress all application log messages' do
-          options[:log_level] = nil
+          opts.on '-h', '--help', 'display this help text and exit' do
+            print_help opts
+            return 0
+          end
         end
 
-        opts.on '-rLIBRARY', '--require LIBRARY', 'require the specified library or libraries before running' do |path|
-          (options[:requires] ||= []).concat path.split ','
+        if (args = opt_parser.parse args).empty?
+          opt_parser.warn 'Please specify an AsciiDoc file to reduce.'
+          print_help opt_parser
+          1
+        elsif args.size == 1
+          if (requires = options.delete :requires)
+            requires.uniq.each do |path|
+              require path
+            rescue ::LoadError
+              $stderr.puts %(#{opt_parser.program_name}: '#{path}' could not be required (reason: #{$!.message}))
+              return 1
+            end
+          end
+          options[:input_file] = args[0]
+          options[:output_file] = '-' unless options[:output_file]
+          [0, options]
+        else
+          opt_parser.warn %(extra arguments detected (unparsed arguments: #{(args.drop 1).join ' '}))
+          print_help opt_parser
+          1
         end
+      rescue ::OptionParser::InvalidOption
+        $stderr.puts %(#{opt_parser.program_name}: #{$!.message})
+        print_help opt_parser
+        1
+      end
 
-        opts.on '-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'server'],
-          'set supported safe mode level: [unsafe, safe, server] (default: unsafe)' do |name|
-          options[:safe] = ::Asciidoctor::SafeMode.value_for_name name
+      def run args = ARGV
+        code, options = parse (Array args)
+        return code unless code == 0 && options
+        trace = options.delete :trace
+        old_logger = ::Asciidoctor::LoggerManager.logger
+        if (log_level = options.delete :log_level)
+          (options[:logger] = ::Asciidoctor::Logger.new $stderr).level = log_level
+        else
+          options[:logger] = nil
         end
+        options[:to] = (output_file = options.delete :output_file) == '-' ? $stdout : (::Pathname.new output_file)
+        input = (input_file = options.delete :input_file) == '-' ? $stdin : (::Pathname.new input_file)
+        ::Asciidoctor::Reducer.reduce input, options
+        0
+      rescue ::SignalException
+        $stderr.puts if ::Interrupt === $!
+        $!.signo
+      rescue
+        raise $! if trace
+        $stderr.puts %(asciidoctor-reducer: #{$!.message.delete_prefix 'asciidoctor: '})
+        $stderr.puts '  Use --trace to show backtrace'
+        1
+      ensure
+        ::Asciidoctor::LoggerManager.logger = old_logger if old_logger
+      end
 
-        opts.on '-v', '--version', 'display the version information and exit' do
-          $stdout.write %(#{opts.program_name} #{VERSION}\n)
-          return 0
-        end
+      private
 
-        opts.on '-h', '--help', 'display this help text and exit' do
-          $stdout.write opts.help
-          return 0
-        end
+      def print_help opt_parser
+        $stdout.puts opt_parser.help.chomp
       end
 
-      args = opt_parser.parse args
-
-      if args.empty?
-        opt_parser.warn 'Please specify an AsciiDoc file to reduce.'
-        $stdout.write opt_parser.help
-        1
-      elsif args.size == 1
-        if (requires = options.delete :requires)
-          requires.uniq.each do |path|
-            require path
-          rescue ::LoadError
-            $stderr.write %(#{opt_parser.program_name}: '#{path}' could not be required (reason: #{$!.message})\n)
-            return 1
-          end
-        end
-        options[:input_file] = args[0]
-        options[:output_file] = '-' unless options[:output_file]
-        [0, options]
-      else
-        opt_parser.warn %(extra arguments detected (unparsed arguments: #{(args.drop 1).join ' '}))
-        $stdout.write opt_parser.help
-        1
+      def print_version opt_parser
+        $stdout.puts %(#{opt_parser.program_name} #{VERSION})
       end
-    rescue ::OptionParser::InvalidOption
-      $stderr.write %(#{opt_parser.program_name}: #{$!.message}\n)
-      $stdout.write opt_parser.help
-      1
     end
 
-    def self.run args = ARGV
-      code, options = new.parse (Array args)
-      return code unless code == 0 && options
-      old_logger = ::Asciidoctor::LoggerManager.logger
-      if (log_level = options.delete :log_level)
-        (options[:logger] = ::Asciidoctor::Logger.new $stderr).level = log_level
-      else
-        options[:logger] = nil
-      end
-      if (output_file = options.delete :output_file) == '-'
-        to = $stdout
-      else
-        (to = ::Pathname.new output_file).dirname.mkpath
-      end
-      if (input_file = options.delete :input_file) == '-'
-        reduced = (::Asciidoctor.load $stdin, options).source + ?\n
-      else
-        reduced = (::Asciidoctor.load_file input_file, options).source + ?\n
-      end
-      ::Pathname === to ? (to.write reduced, encoding: ::Encoding::UTF_8) : (to.write reduced)
-      0
-    rescue
-      $stderr.write %(asciidoctor-reducer: #{$!.message}\n)
-      1
-    ensure
-      ::Asciidoctor::LoggerManager.logger = old_logger if old_logger
+    LOG_LEVELS = (::Logger::Severity.constants false).each_with_object({}) do |level, accum|
+      accum[level.to_s.downcase] = (::Logger::Severity.const_get level) unless level == :UNKNOWN
     end
+
+    private_constant :LOG_LEVELS
   end
 end

data/lib/asciidoctor/reducer/conditional_directive_tracker.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Asciidoctor::Reducer
+  module ConditionalDirectiveTracker
+    def preprocess_conditional_directive keyword, target, delimiter, text
+      skip_active = @skipping
+      depth = @conditional_stack.size
+      cond_lineno = @lineno
+      result = super
+      return result if @skipping && skip_active
+      drop = @include_replacements.current[:drop] ||= []
+      if (depth_change = @conditional_stack.size - depth) < 0
+        if skip_active
+          drop.push(*(drop.pop..cond_lineno))
+        else
+          drop << cond_lineno
+        end
+      elsif depth_change > 0 || cond_lineno == @lineno
+        drop << cond_lineno
+      else
+        drop << [cond_lineno, text]
+      end
+      result
+    end
+  end
+end

data/lib/asciidoctor/reducer/extensions.rb

@@ -1,4 +1,42 @@
 # frozen_string_literal: true
 
+require 'asciidoctor' unless defined? Asciidoctor.load
 require_relative 'preprocessor'
 require_relative 'tree_processor'
+
+module Asciidoctor::Reducer
+  module Extensions
+    module_function
+
+    def group
+      proc do
+        next if document.options[:reduced]
+        preprocessor Preprocessor
+        tree_processor TreeProcessor
+      end
+    end
+
+    def key
+      :reducer
+    end
+
+    def prepare_registry registry = nil
+      registry = ::Asciidoctor::Extensions.create(&registry) if ::Proc === registry
+      return registry if ::Asciidoctor::Extensions.groups[key]
+      if registry
+        registry.groups[key] = group
+        registry
+      else
+        ::Asciidoctor::Extensions.create key, &group
+      end
+    end
+
+    def register
+      ::Asciidoctor::Extensions.register key, &group
+    end
+
+    def unregister
+      ::Asciidoctor::Extensions.groups.delete key # NOTE `Extensions.unregister key` fails if groups is not initialized
+    end
+  end
+end

data/lib/asciidoctor/reducer/include_directive_tracker.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Asciidoctor::Reducer
+  module IncludeDirectiveTracker
+    attr_reader :include_replacements
+    attr_writer :source_lines
+
+    def self.extended instance
+      instance.instance_variable_set :@include_replacements, ([{}].extend CurrentPosition)
+      instance.instance_variable_set :@x_reducer, {}
+    end
+
+    def preprocess_include_directive target, attrlist
+      @x_reducer[:include_directive_line] = %(include::#{target}[#{attrlist}])
+      @x_reducer[:include_pushed] = false
+      inc_lineno = @lineno # we're currently on the include line, which is 1-based
+      result = super
+      unless @x_reducer[:include_pushed]
+        if ((ln = peek_line true)&.end_with? ']') && !(unresolved = ln.start_with? 'Unresolved directive in ') &&
+            inc_lineno == @lineno && (unresolved = ln.start_with? 'link:')
+          ln = %(#{ln.slice 0, (ln.length - 1)}role=include])
+        end
+        push_include_replacement inc_lineno, (unresolved ? [ln] : []), unresolved
+      end
+      @x_reducer.clear
+      result
+    end
+
+    def push_include data, file, path, lineno, attrs
+      @x_reducer[:include_pushed] = true
+      inc_lineno = @lineno - 1 # we're below the include line, which is 1-based
+      prev_inc_depth = @include_stack.size
+      result = super
+      push_include_replacement inc_lineno, (@include_stack.size > prev_inc_depth ? lines : [])
+      result
+    end
+
+    def pop_include
+      @include_replacements.up unless @x_reducer[:include_pushed]
+      super
+    end
+
+    private
+
+    def push_include_replacement lineno, lines, unresolved = false
+      (inc_replacements = @include_replacements) << {
+        into: inc_replacements.pointer,
+        lineno: lineno,
+        line: @x_reducer[:include_directive_line],
+        lines: lines,
+      }
+      inc_replacements.to_end unless unresolved || lines.empty?
+      nil
+    end
+  end
+
+  module CurrentPosition
+    attr_reader :pointer
+
+    def self.extended instance
+      instance.to_end
+    end
+
+    def current
+      self[@pointer]
+    end
+
+    def to_end
+      @pointer = size - 1
+    end
+
+    def up
+      @pointer = current[:into]
+    end
+  end
+
+  private_constant :CurrentPosition
+end

data/lib/asciidoctor/reducer/include_mapper/extension.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Asciidoctor::Reducer
+  class IncludeMapper < ::Asciidoctor::Extensions::TreeProcessor
+    def process doc
+      if doc.extensions.groups[:reducer]
+        unless (includes = doc.catalog[:includes].select {|_, v| v }.keys).empty?
+          doc.source_lines.concat ['', %(//# includes=#{includes.join ','})]
+        end
+      elsif (last_line = doc.source_lines[-1])&.start_with? '//# includes='
+        doc.catalog[:includes].update ((last_line.slice 13, last_line.length).split ',').map {|it| [it, true] }.to_h
+      end
+      doc
+    end
+  end
+end

data/lib/asciidoctor/reducer/include_mapper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'include_mapper/extension'
+
+Asciidoctor::Extensions.register do
+  next if document.options[:reduced]
+  tree_processor Asciidoctor::Reducer::IncludeMapper
+end

data/lib/asciidoctor/reducer/preprocessor.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'preprocessor_directive_tracker'
+require_relative 'include_directive_tracker'
+require_relative 'conditional_directive_tracker'
 
 module Asciidoctor::Reducer
   class Preprocessor < ::Asciidoctor::Extensions::Preprocessor
-    def process _, reader
-      reader.extend PreprocessorDirectiveTracker
+    def process doc, reader
+      doc.options[:preserve_conditionals] ?
+        (reader.extend IncludeDirectiveTracker) : (reader.extend ConditionalDirectiveTracker, IncludeDirectiveTracker)
     end
   end
 end

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -3,19 +3,21 @@
 module Asciidoctor::Reducer
   class TreeProcessor < ::Asciidoctor::Extensions::TreeProcessor
     def process doc
-      unless (inc_replacements = doc.reader.x_include_replacements).length == 1 && inc_replacements[0][:drop].empty?
+      if (inc_replacements = doc.reader.include_replacements).size > 1 || !(inc_replacements[0][:drop] || []).empty?
         inc_replacements[0][:lines] = doc.source_lines.dup
         inc_replacements.reverse_each do |it|
           if (into = it[:into])
             target_lines = inc_replacements[into][:lines]
             # adds extra bit of assurance that we're replacing the correct line
-            next unless target_lines[(index = it[:lineno])] == it[:line]
+            next unless target_lines[(idx = it[:lineno] - 1)] == it[:line]
           end
           lines = it[:lines]
-          unless (drop = it[:drop]).empty?
-            drop.reverse_each {|idx| ::Array === idx ? (lines[idx[0]] = idx[1]) : (lines.delete_at idx) }
+          unless (drop = it[:drop] || []).empty?
+            drop.reverse_each do |drop_it|
+              ::Array === drop_it ? (lines[drop_it[0] - 1] = drop_it[1]) : (lines.delete_at drop_it - 1)
+            end
           end
-          target_lines[index] = lines if target_lines
+          target_lines[idx] = lines if target_lines
         end
         source_lines = inc_replacements[0][:lines].flatten
         if doc.sourcemap
@@ -30,7 +32,7 @@ module Asciidoctor::Reducer
           doc.parse
           ::Asciidoctor::LoggerManager.logger = logger
         else
-          source_lines.pop while (last = source_lines[-1]) && last.empty?
+          source_lines.pop while (source_lines[-1] || :eof).empty?
           doc.reader.source_lines = source_lines
         end
       end

data/lib/asciidoctor/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.0.0.alpha.6'
+    VERSION = '1.0.0.alpha.9'
   end
 end

data/lib/asciidoctor/reducer.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'asciidoctor'
 require_relative 'reducer/extensions'
 
-Asciidoctor::Extensions.register :reducer do
-  next if document.options[:reduced]
-  preprocessor Asciidoctor::Reducer::Preprocessor
-  tree_processor Asciidoctor::Reducer::TreeProcessor
-end
+Asciidoctor::Reducer::Extensions.register

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.6
+  version: 1.0.0.alpha.9
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
 description: A tool that reduces a composite AsciiDoc document containing preprocessor
   directives (includes and conditionals) to a single AsciiDoc document by expanding
   the includes and applying the conditionals.
@@ -68,10 +68,14 @@ files:
 - bin/asciidoctor-reducer
 - lib/asciidoctor-reducer.rb
 - lib/asciidoctor/reducer.rb
+- lib/asciidoctor/reducer/api.rb
 - lib/asciidoctor/reducer/cli.rb
+- lib/asciidoctor/reducer/conditional_directive_tracker.rb
 - lib/asciidoctor/reducer/extensions.rb
+- lib/asciidoctor/reducer/include_directive_tracker.rb
+- lib/asciidoctor/reducer/include_mapper.rb
+- lib/asciidoctor/reducer/include_mapper/extension.rb
 - lib/asciidoctor/reducer/preprocessor.rb
-- lib/asciidoctor/reducer/preprocessor_directive_tracker.rb
 - lib/asciidoctor/reducer/tree_processor.rb
 - lib/asciidoctor/reducer/version.rb
 homepage: https://asciidoctor.org
@@ -97,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Reduces a composite AsciiDoc document containing includes and conditionals

data/lib/asciidoctor/reducer/preprocessor_directive_tracker.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module Asciidoctor::Reducer
-  module PreprocessorDirectiveTracker
-    attr_writer :source_lines
-    attr_reader :x_include_replacements
-
-    def self.extended instance
-      instance.instance_variable_set :@x_include_replacements, ([{ drop: [] }].extend CurrentPosition)
-      instance.instance_variable_set :@x_include_directive_line, nil
-      instance.instance_variable_set :@x_include_pushed, nil
-    end
-
-    def preprocess_conditional_directive keyword, target, delimiter, text
-      return super if @document.options[:preserve_conditionals]
-      skip_active = @skipping
-      depth = @conditional_stack.length
-      cond_lineno = @lineno - 1
-      result = super
-      return result if @skipping && skip_active
-      drop = @x_include_replacements.current[:drop]
-      if (depth_change = @conditional_stack.length - depth) < 0
-        if skip_active
-          drop.push(*(drop.pop..cond_lineno))
-        else
-          drop << cond_lineno
-        end
-      elsif depth_change > 0 || cond_lineno == @lineno - 1
-        drop << cond_lineno
-      else
-        drop << [cond_lineno, text]
-      end
-      result
-    end
-
-    def preprocess_include_directive target, attrlist
-      @x_include_directive_line = %(include::#{target}[#{attrlist}])
-      @x_include_pushed = false
-      inc_lineno = @lineno - 1 # we're currently on the include line, which is 1-based
-      result = super
-      unless @x_include_pushed
-        unresolved = (l = peek_line true) && (l.start_with? 'Unresolved directive in ') && (l.end_with? ']') || nil
-        push_include_replacement inc_lineno, (unresolved ? [l] : []), unresolved
-      end
-      @x_include_directive_line = @x_include_pushed = nil
-      result
-    end
-
-    def push_include data, file, path, lineno, attrs
-      @x_include_pushed = true
-      inc_lineno = @lineno - 2 # we're below the include line, which is 1-based
-      prev_inc_depth = @include_stack.length
-      result = super
-      push_include_replacement inc_lineno, (@include_stack.length > prev_inc_depth ? lines : [])
-      result
-    end
-
-    def pop_include
-      @x_include_replacements.pos = @x_include_replacements.current[:into] unless @x_include_pushed
-      super
-    end
-
-    private
-
-    def push_include_replacement inc_lineno, inc_lines, unresolved = false
-      @x_include_replacements << {
-        into: @x_include_replacements.pos,
-        lineno: inc_lineno,
-        line: @x_include_directive_line,
-        lines: inc_lines,
-        drop: [],
-      }
-      @x_include_replacements.pos = @x_include_replacements.length - 1 unless unresolved || inc_lines.empty?
-      nil
-    end
-  end
-
-  module CurrentPosition
-    attr_accessor :pos
-
-    def self.extended instance
-      instance.pos = instance.length - 1
-    end
-
-    def current
-      self[@pos]
-    end
-  end
-end