asciidoctor-reducer 1.0.0.alpha.5 → 1.0.0.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5bfad3f3b343a1fd2741938d31812feac3218e8b6998d43b3614b6800874b0
-  data.tar.gz: 443bcb83342bb51cf3537b9b5cba497b7a1f5340eb7e7fb0956e85746344f917
+  metadata.gz: 7df897a17f1fc52a4240d6c4bfe476e9072014dae43042063485634bda01eb13
+  data.tar.gz: 5be6330e865889c0a93cf83eb6a884e5785d644d8421d962b5f33950a0da67bc
 SHA512:
-  metadata.gz: b52ca3132349b059d672bab08dd1b1c5a2586d88e8f4f31eb8d2ae7f0f9891917f0ee0cd46bd63826e7127cb8a64fda650bc5a13815760d299c06c6e5181e02b
-  data.tar.gz: 6bdb49618d5adb7b1ce702d266ee8d6a229545b6ca8676931083df9362b21aaedabf539c7d1c4ea5c2fabecbb25426a9bcc140d80ffce93cd9b6da52bdc0e4cd
+  metadata.gz: f4a788b3926a6f9bf925ec5607cc1756688de3ade791ea2178b3e893b9ad35bf0f2912cb0e23b5fc16a8834d2f28be4cc6c0bf6173a10858942522107991091b
+  data.tar.gz: 04afd98f0789e686f0328eb721c56f2c2150261209a66c90025d2dd91c10d9397a969b6a45c0060d77559df549a80cf3839f2940030e47105ca11bcd9ba02e5c

data/CHANGELOG.adoc

@@ -4,6 +4,74 @@
 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.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
+
+* Add `-S`, `--safe-mode` option to CLI to set safe mode (#13)
+* Add `-r`, `--require` option to CLI to specify additional libraries to require before running (#17)
+
+=== Changed
+
+* Sort CLI options in help text, except for the `-h`, `--help` option
+* Update CLI to always use a new logger instance
+* Defer initializing logger until run method is called
+
+=== Fixed
+
+* Replace include directives that follow an unresolved include (#19)
+* Don't activate reducer extensions on reduced document
+* 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
@@ -17,12 +85,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
@@ -32,45 +108,37 @@ 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
 
-* Add `-a` / `--attribute` option to CLI for setting an AsciiDoc document attribute at runtime (#6)
+* Add `-a`, `--attribute` option to CLI for setting an AsciiDoc document attribute at runtime (#6)
 
 === Changed
 
-* Reduce preprocessor conditionals by default; add option (`--preserve-conditionals` / `:preserve_conditionals`) to preserve them (#8)
+* Reduce preprocessor conditionals by default; add option (`--preserve-conditionals`, `:preserve_conditionals`) to preserve them (#8)
 * Don't enable sourcemap automatically (#4)
 * Don't override logger by default; instead, rely on `:logger` API option to change logger
 * Add `--log-level` option to CLI to set severity level on logger (#9)
-* Add `-q` / `--quiet` option to CLI to suppress log messages (#9)
+* Add `-q`, `--quiet` option to CLI to suppress log messages (#9)
 * Reserve zero index in include replacements for top-level document
 
 === Fixed
 
 * 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
+== 1.0.0.alpha.1 (2022-01-12) - @mojavelinux
 
-{url-repo}/releases/tag/v1.0.0.alpha.4[git tag]
+Initial release.
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.5[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.5, 2022-02-06
+v1.0.0.alpha.8, 2022-02-23
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -22,15 +22,15 @@ If the document does not contain any preprocessor directives, the tool returns t
 
 == Prerequisites
 
-{project-name} is a Ruby program that you install using Ruby packaging.
-Therefore, to install and run {project-name}, you need Ruby 2.5 or better installed.
+{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.
 
-To check whether you have Ruby installed, and which version, run the following command:
+Run the following command to check which version of Ruby you have installed, if any:
 
  $ ruby -v
 
 If Ruby is not installed, you can install it using {url-rvm}[RVM] (or, if you prefer, the package manager for your system).
-We generally recommend using RVM because it allows you to install gems without requiring elevated privileges or messing with system libraries.
+We generally recommend using RVM as it allows you to install gems without requiring elevated privileges or messing with system libraries.
 
 == Installation
 
@@ -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,9 @@ asciidoctor-reducer [OPTION]... FILE
 ....
 
 The argument `FILE` is the AsciiDoc file you want to reduce.
-To use the command, pass the AsciiDoc file as the sole argument:
+The options, represented by `+[OPTION]...+`, are optional, as the name suggestions.
+
+Thus, to use the command, pass the AsciiDoc file as the sole argument:
 
  $ asciidoctor-reducer input.adoc
 
@@ -89,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.
@@ -119,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.
@@ -189,7 +241,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
 
@@ -234,7 +286,7 @@ When running the `asciidoctor-reducer` command from source, you must prefix the
 [subs=attributes+]
  $ bundle exec asciidoctor-reducer sample.adoc
 
-To avoid having to do this, or make the `asciidoctor-reducer` command available from anywhere, you need to build the development gem and install it.
+To avoid having to do this, or to make the `asciidoctor-reducer` command available from anywhere, you need to build the development gem and install it.
 
 == Copyright and License
 

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,11 @@
 #!/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
+asciidoctor_reducer_cli = File.absolute_path '../lib/asciidoctor/reducer/cli', __dir__
+if File.exist? asciidoctor_reducer_cli
+  require asciidoctor_reducer_cli
 else
-  require 'asciidoctor/reducer'
+  require 'asciidoctor/reducer/cli'
 end
 
-require 'asciidoctor/reducer/cli'
-
 exit Asciidoctor::Reducer::Cli.run

data/lib/asciidoctor/reducer/api.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative 'extensions'
+
+module Asciidoctor::Reducer
+  autoload :VERSION, (::File.join __dir__, 'version.rb')
+
+  class << self
+    def reduce input, opts = {}
+      opts = opts.merge extension_registry: (Extensions.prepare_registry opts[:extension_registry] || opts[:extensions])
+      opts[:safe] = ::Asciidoctor::SafeMode::SAFE unless opts.key? :safe
+      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, opts[:to]
+    end
+
+    def reduce_file input_file, opts = {}
+      reduce (::Pathname.new input_file), opts
+    end
+
+    private
+
+    def write doc, to
+      if 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
+        else
+          to.write output
+        end
+      end
+      doc
+    end
+  end
+
+  LF = ?\n
+  UTF_8 = ::Encoding::UTF_8
+
+  private_constant :LF, :UTF_8
+end

data/lib/asciidoctor/reducer/cli.rb

@@ -1,14 +1,16 @@
 # 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
+
     def parse args
-      options = { attributes: {}, safe: :unsafe }
+      options = { attributes: {}, log_level: LOG_LEVELS['warn'], safe: :unsafe }
 
       opt_parser = ::OptionParser.new do |opts|
         opts.program_name = 'asciidoctor-reducer'
@@ -19,10 +21,6 @@ module Asciidoctor::Reducer
 
         EOS
 
-        opts.on '-o FILE', '--output=FILE', 'set the output filename or stream' do |file|
-          options[:output_file] = file
-        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
@@ -30,26 +28,43 @@ module Asciidoctor::Reducer
           options[:attributes][key] = val
         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 '-o FILE', '--output=FILE', 'set the output filename or stream' do |file|
+          options[:output_file] = file
+        end
+
         opts.on '--preserve-conditionals', 'preserve preprocessor conditional directives in the reduced source' do
           options[:preserve_conditionals] = true
         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[:logger] = ::Asciidoctor::Logger.new $stderr).level = level unless level == 'warn'
+        opts.on '-q', '--quiet', 'suppress all application log messages' do
+          options[:log_level] = nil
         end
 
-        opts.on '-q', '--quiet', 'suppress all application log messages' do
-          options[:logger] = ::Asciidoctor::NullLogger.new
+        opts.on '-rLIBRARY', '--require LIBRARY', 'require the specified library or libraries before running' do |path|
+          (options[:requires] ||= []).concat path.split ','
         end
 
-        opts.on '-h', '--help', 'display this help text and exit' do
-          $stdout.write opts.help
-          return 0
+        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] = ::Asciidoctor::SafeMode.value_for_name name
+        end
+
+        opts.on '--trace', 'trace the cause of application errors (default: false)' do
+          options[:trace] = true
         end
 
         opts.on '-v', '--version', 'display the version information and exit' do
-          $stdout.write %(#{opts.program_name} #{VERSION}\n)
+          print_version opts
+          return 0
+        end
+
+        opts.on '-h', '--help', 'display this help text and exit' do
+          print_help opts
           return 0
         end
       end
@@ -58,44 +73,65 @@ module Asciidoctor::Reducer
 
       if args.empty?
         opt_parser.warn 'Please specify an AsciiDoc file to reduce.'
-        $stdout.write opt_parser.help
+        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 ' '}))
-        $stdout.write opt_parser.help
-        [1, options]
+        print_help opt_parser
+        1
       end
     rescue ::OptionParser::InvalidOption
-      $stderr.write %(#{opt_parser.program_name}: #{$!.message}\n)
-      $stdout.write opt_parser.help
+      $stderr.puts %(#{opt_parser.program_name}: #{$!.message})
+      print_help opt_parser
       1
     end
 
     def self.run args = ARGV
-      old_logger = ::Asciidoctor::LoggerManager.logger
       code, options = new.parse (Array args)
       return code unless code == 0 && options
-      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
+      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
-        reduced = (::Asciidoctor.load_file input_file, (options.merge to_file: false)).source + ?\n
+        options[:logger] = nil
       end
-      ::Pathname === to ? (to.write reduced, encoding: ::Encoding::UTF_8) : (to.write reduced)
+      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
-      $stderr.write %(asciidoctor-reducer: #{$!.message}\n)
+      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
+      ::Asciidoctor::LoggerManager.logger = old_logger if old_logger
+    end
+
+    private
+
+    def print_help opt_parser
+      $stdout.puts opt_parser.help.chomp
+    end
+
+    def print_version opt_parser
+      $stdout.puts %(#{opt_parser.program_name} #{VERSION})
     end
   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 = @x_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,39 @@
 # 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 prepare_registry registry = nil
+      registry = ::Asciidoctor::Extensions.create(&registry) if ::Proc === registry
+      unless ::Asciidoctor::Extensions.groups[:reducer]
+        if registry
+          registry.groups[:reducer] = group
+        else
+          registry = ::Asciidoctor::Extensions.create :reducer, &group
+        end
+      end
+      registry
+    end
+
+    def register
+      ::Asciidoctor::Extensions.register :reducer, &group
+    end
+
+    def unregister
+      ::Asciidoctor::Extensions.unregister :reducer
+    end
+  end
+end

data/lib/asciidoctor/reducer/include_directive_tracker.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Asciidoctor::Reducer
+  module IncludeDirectiveTracker
+    attr_writer :source_lines
+    attr_reader :x_include_replacements
+
+    def self.extended instance
+      instance.instance_variable_set :@x_include_replacements, ([{}].extend CurrentPosition)
+      instance.instance_variable_set :@x_include_directive_line, nil
+      instance.instance_variable_set :@x_include_pushed, nil
+    end
+
+    def preprocess_include_directive target, attrlist
+      @x_include_directive_line = %(include::#{target}[#{attrlist}])
+      @x_include_pushed = false
+      inc_lineno = @lineno # we're currently on the include line, which is 1-based
+      result = super
+      unless @x_include_pushed
+        if (ln = peek_line true) && (ln.end_with? ']') && !(unresolved = ln.start_with? 'Unresolved directive in ')
+          if @document.safe >= ::Asciidoctor::SafeMode::SECURE && inc_lineno == @lineno && (ln.start_with? 'link:')
+            unresolved = !(ln = %(#{ln.slice 0, (ln.length - 1)}role=include])).nil?
+          end
+        end
+        push_include_replacement inc_lineno, (unresolved ? [ln] : []), 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 - 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
+      @x_include_replacements.pos = @x_include_replacements.current[:into] unless @x_include_pushed
+      super
+    end
+
+    private
+
+    def push_include_replacement lineno, lines, unresolved = false
+      (inc_replacements = @x_include_replacements) << {
+        into: inc_replacements.pos,
+        lineno: lineno,
+        line: @x_include_directive_line,
+        lines: lines,
+      }
+      inc_replacements.pos = inc_replacements.size - 1 unless unresolved || lines.empty?
+      nil
+    end
+  end
+
+  module CurrentPosition
+    attr_accessor :pos
+
+    def self.extended instance
+      instance.pos = instance.size - 1
+    end
+
+    def current
+      self[@pos]
+    end
+  end
+
+  private_constant :CurrentPosition
+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 doc, reader
-      doc.options[:reduced] ? reader : (reader.extend PreprocessorDirectiveTracker)
+      reader.extend IncludeDirectiveTracker
+      reader.extend ConditionalDirectiveTracker unless doc.options[:preserve_conditionals]
     end
   end
 end

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -3,28 +3,36 @@
 module Asciidoctor::Reducer
   class TreeProcessor < ::Asciidoctor::Extensions::TreeProcessor
     def process doc
-      return if doc.options[:reduced]
-      unless (inc_replacements = doc.reader.x_include_replacements).length == 1 && inc_replacements[0][:drop].empty?
+      if (inc_replacements = doc.reader.x_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
           logger = ::Asciidoctor::LoggerManager.logger
-          doc = ::Asciidoctor.load source_lines, (doc.options.merge logger: false, reduced: true)
+          opts = doc.options.merge logger: nil, parse: false, reduced: true
+          if (ext_reg = opts[:extension_registry])
+            opts[:extension_registry] = ::Asciidoctor::Extensions::Registry.new ext_reg.groups
+          end
+          includes = doc.catalog[:includes]
+          doc = ::Asciidoctor.load source_lines, opts
+          doc.catalog[:includes] = includes
+          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.5'
+    VERSION = '1.0.0.alpha.8'
   end
 end

data/lib/asciidoctor/reducer.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'asciidoctor'
 require_relative 'reducer/extensions'
 
-Asciidoctor::Extensions.register :reducer do
-  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.5
+  version: 1.0.0.alpha.8
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-02-23 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,12 @@ 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/preprocessor.rb
-- lib/asciidoctor/reducer/preprocessor_directive_tracker.rb
 - lib/asciidoctor/reducer/tree_processor.rb
 - lib/asciidoctor/reducer/version.rb
 homepage: https://asciidoctor.org

data/lib/asciidoctor/reducer/preprocessor_directive_tracker.rb

@@ -1,92 +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 (opts = @document.options)[:preserve_conditionals] || opts[:reduced]
-      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
-      if @x_include_pushed
-        @x_include_directive_line = @x_include_pushed = nil
-        return result
-      end
-      inc_lines = ((line = lines[0].to_s).start_with? 'Unresolved directive in ') && (line.end_with? ']') ? [line] : []
-      push_include_replacement inc_lineno, inc_lines
-      @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
-      inc_lines = lines if @include_stack.length > prev_inc_depth
-      push_include_replacement inc_lineno, inc_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
-      @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 if inc_lines
-      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