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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a685ae408de9db32a7ec96055b70120ea6f7476436dca071cc37155cc680d56
-  data.tar.gz: 39d783c66481423417d64a232ee01bdaa88bef517474d22e8ec9fdeb670d09d9
+  metadata.gz: 7df897a17f1fc52a4240d6c4bfe476e9072014dae43042063485634bda01eb13
+  data.tar.gz: 5be6330e865889c0a93cf83eb6a884e5785d644d8421d962b5f33950a0da67bc
 SHA512:
-  metadata.gz: a3376645764a9d608f3e3aad5f29f2080748d9ecd20d90a06e2335263cdd7c88c0450a72ea061f8f36c17fa19af0f985a89002ee70e12ce950f4320c483b8140
-  data.tar.gz: a7899259cf2ff2daf619d13b97d88dd460a013b0bc85d2c8402e1283f1b3d6fff3780bc3c112e4c281463ad06e0bcb035385998771528a01e3aac487dd7c6e09
+  metadata.gz: f4a788b3926a6f9bf925ec5607cc1756688de3ade791ea2178b3e893b9ad35bf0f2912cb0e23b5fc16a8834d2f28be4cc6c0bf6173a10858942522107991091b
+  data.tar.gz: 04afd98f0789e686f0328eb721c56f2c2150261209a66c90025d2dd91c10d9397a969b6a45c0060d77559df549a80cf3839f2940030e47105ca11bcd9ba02e5c

data/CHANGELOG.adoc

@@ -4,6 +4,27 @@
 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
@@ -23,6 +44,10 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 * 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
@@ -43,6 +68,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
@@ -56,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
@@ -71,6 +108,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
@@ -90,34 +131,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
-
-{url-repo}/releases/tag/v1.0.0.alpha.5[git tag]
-
-=== Details
+== 1.0.0.alpha.1 (2022-01-12) - @mojavelinux
 
-{url-repo}/releases/tag/v1.0.0.alpha.6[git tag]
+Initial release.
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.7[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.7, 2022-02-14
+v1.0.0.alpha.8, 2022-02-23
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]

data/lib/asciidoctor/reducer/cli.rb

@@ -49,18 +49,22 @@ module Asciidoctor::Reducer
           (options[:requires] ||= []).concat path.split ','
         end
 
-        opts.on '-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'server'],
-          'set supported safe mode level: [unsafe, safe, server] (default: unsafe)' do |name|
+        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
-          $stdout.write opts.help
+          print_help opts
           return 0
         end
       end
@@ -69,14 +73,14 @@ 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.write %(#{opt_parser.program_name}: '#{path}' could not be required (reason: #{$!.message})\n)
+            $stderr.puts %(#{opt_parser.program_name}: '#{path}' could not be required (reason: #{$!.message}))
             return 1
           end
         end
@@ -85,18 +89,19 @@ module Asciidoctor::Reducer
         [0, options]
       else
         opt_parser.warn %(extra arguments detected (unparsed arguments: #{(args.drop 1).join ' '}))
-        $stdout.write opt_parser.help
+        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
       code, options = new.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
@@ -107,11 +112,26 @@ module Asciidoctor::Reducer
       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 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/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 _, reader
-      reader.extend PreprocessorDirectiveTracker
+    def process doc, reader
+      reader.extend IncludeDirectiveTracker
+      reader.extend ConditionalDirectiveTracker unless doc.options[:preserve_conditionals]
     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.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
@@ -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.7'
+    VERSION = '1.0.0.alpha.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.7
+  version: 1.0.0.alpha.8
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -70,9 +70,10 @@ files:
 - 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,91 +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
-
-  private_constant :CurrentPosition
-end