asciidoctor-reducer 1.0.0.alpha.2 → 1.0.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4345ff2d6a81a560e1ed5bca19109d14ae5b230e087021876377ad4ded4e80e6
-  data.tar.gz: 2c52ac147e3388f7f04fb2adfa89b1653b890e4a208f2eac698821853e6a0648
+  metadata.gz: 4b0c9530e403be351428ec664c9a5d763a0f27686505e8328d831f46f9ad580b
+  data.tar.gz: ea5116a19ea8e1199415f5e50ee9339dcec66b87b2c574f60306c8b68e9083b8
 SHA512:
-  metadata.gz: 35cbaa540aa6b5a01b830f3e7a687718ae48cdc005321d0a90025427c32a5e06d5d6a9ff6c1b670d659508a95e16bce58550b0d90b8f844dd435c044fd14a309
-  data.tar.gz: 42808122280abc28294df1c0498e4a33fd2943c638202fa5fa4978a762b58cdb05d5d029b555826009ac89c507ed793925368fee0c287eddfdfd5d4799a7d51d
+  metadata.gz: c3f8025d47b14f4701c4883151403e7fc1aa498cb3d82b9180f7935e14e2aa95a149517e9b037f92d4086d01bd1133aae3088158018ecd088de8f0dc221d5602
+  data.tar.gz: 79ee7b026d7de3f74b2423e193b85c3e0d8d1e1a783e27af4e838522f13c7712871c1379556757ebc432999a0625590d8e03c80d6ef5259104c088a412fa8d25

data/CHANGELOG.adoc

@@ -4,6 +4,15 @@
 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.3 (2022-02-02) - @mojavelinux
+
+=== Changed
+
+* Rename PreprocessorReader ext module to PreprocessorReaderTracker
+* Encapsulate logic to enhance PreprocessorReader inside PreprocessorReaderTracker module
+* Only reload document if source lines have changed; otherwise, update source lines on reader directly
+* Change default safe mode for CLI to :unsafe
+
 == 1.0.0.alpha.2 (2022-01-27) - @mojavelinux
 
 === Added
@@ -34,3 +43,7 @@ Initial release.
 === Details
 
 {url-repo}/releases/tag/v1.0.0.alpha.2[git tag]
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0.alpha.3[git tag]

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0.alpha.2, 2022-01-27
+v1.0.0.alpha.3, 2022-02-02
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -80,7 +80,7 @@ To use the command, pass the AsciiDoc file as the sole argument:
  $ asciidoctor-reducer input.adoc
 
 By default, the command will output the reduced AsciiDoc document to the terminal (via stdout).
-To write the output to a file, specify an output file using the `-o` option.
+To write the output to a file, specify an output file using the `-o` option:
 
  $ asciidoctor-reducer -o output.adoc input.adoc
 
@@ -89,7 +89,7 @@ To use the command in this way, pass `-` as the first argument:
 
  $ cat input.adoc | asciidoctor-reducer -
 
-To write the output to a file, also specify the `-o` option:
+To write the output to a file instead of stdout, also specify an output file using the `-o` option:
 
  $ cat input.adoc | asciidoctor-reducer -o output.adoc -
 
@@ -137,6 +137,14 @@ As it goes, it also removes lines that have been excluded by the preprocessor co
 Finally, it loads the document again and returns it.
 The reduced source is available on the reconstructed document (via `Document#source` or `Document#source_lines`).
 
+=== Impact on Extensions
+
+If the sourcemap is enabled, and the reducer finds lines to replace or filter, the reducer will load the document again using `Asciidoctor.load`.
+This step is necessary to synchronize the sourcemap with the reduced source.
+This call will cause extensions that run during the load phase to be invoked again.
+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.
+
 == Development
 
 Follow the instructions below to learn how to help develop the project or test-drive the development version.

data/lib/asciidoctor/reducer/cli.rb

@@ -8,7 +8,7 @@ module Asciidoctor::Reducer
 
   class Cli
     def parse args
-      options = { attributes: {}, safe: :safe }
+      options = { attributes: {}, safe: :unsafe }
 
       opt_parser = ::OptionParser.new do |opts|
         opts.program_name = 'asciidoctor-reducer'
@@ -91,7 +91,7 @@ module Asciidoctor::Reducer
       end
       ::Pathname === to ? (to.write reduced, encoding: ::Encoding::UTF_8) : (to.write reduced)
       0
-    rescue ::IOError
+    rescue
       $stderr.write %(asciidoctor-reducer: #{$!.message}\n)
       1
     ensure

data/lib/asciidoctor/reducer/preprocessor.rb

@@ -1,23 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'ext/asciidoctor/preprocessor_reader'
+require_relative 'preprocessor_directive_tracker'
 
 module Asciidoctor::Reducer
   class Preprocessor < ::Asciidoctor::Extensions::Preprocessor
     def process doc, reader
-      return if doc.options[:reduced]
-      reader.singleton_class.prepend AsciidoctorExt::PreprocessorReader
-      reader.instance_variable_set :@x_include_replacements, ([{ drop: [] }].extend Current)
-      reader.instance_variable_set :@x_parents, [0]
-      nil
-    end
-  end
-
-  module Current
-    attr_accessor :current
-
-    def self.extended obj
-      obj.current = obj[-1]
+      doc.options[:reduced] ? reader : (reader.extend PreprocessorDirectiveTracker)
     end
   end
 end

data/lib/asciidoctor/reducer/preprocessor_directive_tracker.rb

@@ -0,0 +1,103 @@
+# 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 CurrentPointer)
+      instance.instance_variable_set :@x_parents, [0]
+    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_push_include_called = false
+      inc_lineno = @lineno - 1 # we're currently on the include line, which is 1-based
+      result = super
+      return result if @x_push_include_called
+      parent_depth = (parents = @x_parents).length
+      if (depth_change = @include_stack.length - (parent_depth - 1)) < 0
+        parent_depth -= (parents.slice! parent_depth + depth_change, -depth_change).length
+      end
+      inc_lines = ((line = lines[0].to_s).start_with? 'Unresolved directive in ') && (line.end_with? ']') ? [line] : []
+      push_include_replacement inc_lines, parent_depth, inc_lineno
+      result
+    end
+
+    def push_include data, file, path, lineno, attrs
+      @x_push_include_called = true
+      inc_lineno = @lineno - 2 # we're below the include line, which is 1-based
+      prev_inc_depth = @include_stack.length
+      # Q: can we do this without resetting the lineno?
+      lineno = 1 # rubocop:disable Lint/ShadowedArgument
+      super
+      parent_depth = (parents = @x_parents).length
+      # push_include did not push to the stack
+      if (inc_depth = @include_stack.length) == prev_inc_depth
+        if (depth_change = inc_depth - (parent_depth - 1)) < 0
+          parent_depth -= (parents.slice! parent_depth + depth_change, -depth_change).length
+        end
+      else
+        if (depth_change = inc_depth - parent_depth) > 0
+          parents << @x_include_replacements.length.pred
+          parent_depth += 1
+        elsif depth_change < 0
+          parent_depth -= (parents.slice! parent_depth + depth_change, -depth_change).length
+        end
+        inc_lines = lines
+      end
+      push_include_replacement inc_lines, parent_depth, inc_lineno
+      self
+    end
+
+    def pop_include
+      @x_include_replacements.current = @x_include_replacements[@x_include_replacements.current[:into] || 0]
+      super
+    end
+
+    private
+
+    def push_include_replacement inc_lines, parent_depth, inc_lineno
+      @x_include_replacements << {
+        lines: inc_lines || [],
+        drop: [],
+        into: @x_parents[parent_depth - 1],
+        index: inc_lineno,
+        replace: @x_include_directive_line,
+      }
+      @x_include_replacements.current = @x_include_replacements[-1] if inc_lines
+      nil
+    end
+  end
+
+  module CurrentPointer
+    attr_accessor :current
+
+    def self.extended instance
+      instance.current = instance[-1]
+    end
+  end
+end

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -4,7 +4,7 @@ module Asciidoctor::Reducer
   class TreeProcessor < ::Asciidoctor::Extensions::TreeProcessor
     def process doc
       return if doc.options[:reduced]
-      inc_replacements = doc.reader.instance_variable_get :@x_include_replacements
+      inc_replacements = doc.reader.x_include_replacements
       unless inc_replacements.length == 1 && inc_replacements[0][:drop].empty?
         inc_replacements[0][:lines] = doc.source_lines.dup
         inc_replacements.reverse_each do |it|
@@ -19,8 +19,13 @@ module Asciidoctor::Reducer
           end
           target_lines[index] = lines if target_lines
         end
-        # WARNING: if include directives remain that can still be resolved, the sourcemap won't match the source lines
-        doc = ::Asciidoctor.load inc_replacements[0][:lines].flatten, (doc.options.merge reduced: true)
+        source_lines = inc_replacements[0][:lines].flatten
+        if doc.sourcemap
+          # WARNING: if include directives remain that can still be resolved, the sourcemap won't match the source lines
+          doc = ::Asciidoctor.load source_lines, (doc.options.merge reduced: true)
+        else
+          doc.reader.source_lines = source_lines
+        end
       end
       doc
     end

data/lib/asciidoctor/reducer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.2
+  version: 1.0.0.alpha.3
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -69,9 +69,9 @@ files:
 - lib/asciidoctor-reducer.rb
 - lib/asciidoctor/reducer.rb
 - lib/asciidoctor/reducer/cli.rb
-- lib/asciidoctor/reducer/ext/asciidoctor/preprocessor_reader.rb
 - lib/asciidoctor/reducer/extensions.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/ext/asciidoctor/preprocessor_reader.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module Asciidoctor::Reducer
-  module AsciidoctorExt
-    module PreprocessorReader
-      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_push_include_called = false
-        inc_lineno = @lineno - 1 # we're currently on the include line, which is 1-based
-        result = super
-        return result if @x_push_include_called
-        parent_depth = (parents = @x_parents).length
-        if (depth_change = @include_stack.length - (parent_depth - 1)) < 0
-          parent_depth -= (parents.slice! parent_depth + depth_change, -depth_change).length
-        end
-        lines = ((line = @lines[-1].to_s).start_with? 'Unresolved directive in ') && (line.end_with? ']') ? [line] : []
-        push_include_replacement lines, parent_depth, inc_lineno
-        result
-      end
-
-      def push_include data, file, path, lineno, attrs
-        @x_push_include_called = true
-        inc_lineno = @lineno - 2 # we're below the include line, which is 1-based
-        prev_inc_depth = @include_stack.length
-        # Q: can we do this without resetting the lineno?
-        lineno = 1 # rubocop:disable Lint/ShadowedArgument
-        super
-        parent_depth = (parents = @x_parents).length
-        # push_include did not push to the stack
-        if (inc_depth = @include_stack.length) == prev_inc_depth
-          if (depth_change = inc_depth - (parent_depth - 1)) < 0
-            parent_depth -= (parents.slice! parent_depth + depth_change, -depth_change).length
-          end
-        else
-          if (depth_change = inc_depth - parent_depth) > 0
-            parents << @x_include_replacements.length.pred
-            parent_depth += 1
-          elsif depth_change < 0
-            parent_depth -= (parents.slice! parent_depth + depth_change, -depth_change).length
-          end
-          lines = @lines.reverse
-        end
-        push_include_replacement lines, parent_depth, inc_lineno
-        self
-      end
-
-      def pop_include
-        @x_include_replacements.current = @x_include_replacements[@x_include_replacements.current[:into] || 0]
-        super
-      end
-
-      private
-
-      def push_include_replacement lines, parent_depth, inc_lineno
-        @x_include_replacements << {
-          lines: lines || [],
-          drop: [],
-          into: @x_parents[parent_depth - 1],
-          index: inc_lineno,
-          replace: @x_include_directive_line,
-        }
-        @x_include_replacements.current = @x_include_replacements[-1] if lines
-        nil
-      end
-    end
-  end
-end