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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5bfad3f3b343a1fd2741938d31812feac3218e8b6998d43b3614b6800874b0
-  data.tar.gz: 443bcb83342bb51cf3537b9b5cba497b7a1f5340eb7e7fb0956e85746344f917
+  metadata.gz: 30089ea8ab059ef848713ada56dd9457f4d6681c80de8028b92a9d02b21b0544
+  data.tar.gz: f38c68d1f15627a4d74fd5376fb3ec9a5b6ad29345c10ea882ff988c875922a9
 SHA512:
-  metadata.gz: b52ca3132349b059d672bab08dd1b1c5a2586d88e8f4f31eb8d2ae7f0f9891917f0ee0cd46bd63826e7127cb8a64fda650bc5a13815760d299c06c6e5181e02b
-  data.tar.gz: 6bdb49618d5adb7b1ce702d266ee8d6a229545b6ca8676931083df9362b21aaedabf539c7d1c4ea5c2fabecbb25426a9bcc140d80ffce93cd9b6da52bdc0e4cd
+  metadata.gz: a3ec843b92513164762d9647d963238073bff89c66619205166b26199a23e65d85ee5aaf23c2a60c953eae52d17ed36cbb7499dd7afb2040692912065171db12
+  data.tar.gz: df40e3f0c244ed21ea052536844df17f536c84a12252008d1c7dbdc04ad85ec00f3aabae81242550eda9a394497db386bd12b34f5110f323f61a8bdbc8ec30c6

data/CHANGELOG.adoc

@@ -4,6 +4,26 @@
 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.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)
+
 == 1.0.0.alpha.5 (2022-02-06) - @mojavelinux
 
 === Changed
@@ -36,15 +56,15 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === 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
@@ -74,3 +94,7 @@ Initial release.
 === Details
 
 {url-repo}/releases/tag/v1.0.0.alpha.5[git tag]
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.6[git tag]

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.6, 2022-02-10
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -23,14 +23,14 @@ 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.
+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 whether you have Ruby installed and to check which version:
 
  $ 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
 
@@ -75,7 +75,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
 
@@ -234,7 +236,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/lib/asciidoctor/reducer/cli.rb

@@ -7,8 +7,12 @@ 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 +23,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,28 +30,41 @@ 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'],
+          'set supported safe mode level: [unsafe, safe, server] (default: unsafe)' do |name|
+          options[:safe] = ::Asciidoctor::SafeMode.value_for_name name
         end
 
         opts.on '-v', '--version', 'display the version information and exit' do
           $stdout.write %(#{opts.program_name} #{VERSION}\n)
           return 0
         end
+
+        opts.on '-h', '--help', 'display this help text and exit' do
+          $stdout.write opts.help
+          return 0
+        end
       end
 
       args = opt_parser.parse args
@@ -61,13 +74,21 @@ module Asciidoctor::Reducer
         $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, options]
+        1
       end
     rescue ::OptionParser::InvalidOption
       $stderr.write %(#{opt_parser.program_name}: #{$!.message}\n)
@@ -76,9 +97,14 @@ module Asciidoctor::Reducer
     end
 
     def self.run args = ARGV
-      old_logger = ::Asciidoctor::LoggerManager.logger
       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
@@ -87,7 +113,7 @@ module Asciidoctor::Reducer
       if (input_file = options.delete :input_file) == '-'
         reduced = (::Asciidoctor.load $stdin, options).source + ?\n
       else
-        reduced = (::Asciidoctor.load_file input_file, (options.merge to_file: false)).source + ?\n
+        reduced = (::Asciidoctor.load_file input_file, options).source + ?\n
       end
       ::Pathname === to ? (to.write reduced, encoding: ::Encoding::UTF_8) : (to.write reduced)
       0
@@ -95,7 +121,7 @@ module Asciidoctor::Reducer
       $stderr.write %(asciidoctor-reducer: #{$!.message}\n)
       1
     ensure
-      ::Asciidoctor::LoggerManager.logger = old_logger
+      ::Asciidoctor::LoggerManager.logger = old_logger if old_logger
     end
   end
 end

data/lib/asciidoctor/reducer/preprocessor.rb

@@ -4,8 +4,8 @@ require_relative 'preprocessor_directive_tracker'
 
 module Asciidoctor::Reducer
   class Preprocessor < ::Asciidoctor::Extensions::Preprocessor
-    def process doc, reader
-      doc.options[:reduced] ? reader : (reader.extend PreprocessorDirectiveTracker)
+    def process _, reader
+      reader.extend PreprocessorDirectiveTracker
     end
   end
 end

data/lib/asciidoctor/reducer/preprocessor_directive_tracker.rb

@@ -12,7 +12,7 @@ module Asciidoctor::Reducer
     end
 
     def preprocess_conditional_directive keyword, target, delimiter, text
-      return super if (opts = @document.options)[:preserve_conditionals] || opts[:reduced]
+      return super if @document.options[:preserve_conditionals]
       skip_active = @skipping
       depth = @conditional_stack.length
       cond_lineno = @lineno - 1
@@ -38,12 +38,10 @@ module Asciidoctor::Reducer
       @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
+      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
-      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
@@ -53,8 +51,7 @@ module Asciidoctor::Reducer
       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
+      push_include_replacement inc_lineno, (@include_stack.length > prev_inc_depth ? lines : [])
       result
     end
 
@@ -65,15 +62,15 @@ module Asciidoctor::Reducer
 
     private
 
-    def push_include_replacement inc_lineno, inc_lines
+    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 || [],
+        lines: inc_lines,
         drop: [],
       }
-      @x_include_replacements.pos = @x_include_replacements.length - 1 if inc_lines
+      @x_include_replacements.pos = @x_include_replacements.length - 1 unless unresolved || inc_lines.empty?
       nil
     end
   end

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -3,7 +3,6 @@
 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?
         inc_replacements[0][:lines] = doc.source_lines.dup
         inc_replacements.reverse_each do |it|
@@ -21,7 +20,14 @@ module Asciidoctor::Reducer
         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?

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.6'
   end
 end

data/lib/asciidoctor/reducer.rb

@@ -4,6 +4,7 @@ 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

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.6
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor