asciidoctor-reducer 1.0.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0315811ef24fa88a755aa6973e86aca45929a43416020d2f82afa7ef1e664fd9'
-  data.tar.gz: 745ee8bc00aba042843abb05bb22a8ad93a50dc9de7090bd946c82b3333b19d3
+  metadata.gz: 5a1fcd2f167e66e18a7876694575d92c1d4cda20b0f1191d6f029d32c888c03d
+  data.tar.gz: 9dd7507a5fe67295f51590f890196cc3b98cb32dbf5cdb61e1d15396caf34143
 SHA512:
-  metadata.gz: a0eca70526db73201588d3b9154207b7ec1bdf30f41c8799ee6a88a36091e4906b4ce00ef183939be46c3ed8cd78778119e206585e01648fa20eff48c16cd6e9
-  data.tar.gz: 3c97e30588293c5e599cf26d6dff4b142936582bf8544f9d6f577a5ae6a000e1b4e1a835fd33dbaa22f044c863f51e827aa42f56ab6d758a1acf3b5485bc938d
+  metadata.gz: efd6d82a88c4d6b1fdb4abd2f5b72b3a03df186a3cac990736ad5e199d9eb4a2e42360caff8cd40c3d71c5ad24bf2b44ae4a64187e38e837298380656fb8128b
+  data.tar.gz: 7a365765f4685d936f2f7b06aaf015261a25a7910a5a6f3773cb01a6c2a90210a79586aa39546578dfd4971cd66b27c01e7016af6aa7cd264e88282069cc5421

data/CHANGELOG.adoc

@@ -4,6 +4,27 @@
 This document provides a curated view of the changes to Asciidoctor Reducer in each release.
 For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
 
+== 1.1.1 (2025-03-27) - @mojavelinux
+
+=== Fixed
+
+* Fall back to iteration-based strategy in compiled JavaScript if built-in Array#flatten method throws RangeError (#63)
+
+=== Details
+
+{url-repo}/releases/tag/v1.1.1[git tag] | {url-repo}/compare/v1.1.0\...v1.1.1[full diff]
+
+== 1.1.0 (2024-11-24) - @mojavelinux
+
+=== Added
+
+* Track header attributes in source document and assign to `source_header_attributes` attr reader on Document instance (#59)
+* Add JavaScript build that publishes the `@antora/reducer` an npm package (#57)
+
+=== Details
+
+{url-repo}/releases/tag/v1.1.0[git tag] | {url-repo}/compare/v1.0.6\...v1.1.0[full diff]
+
 == 1.0.6 (2024-02-12) - @mojavelinux
 
 === Fixed

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.6, 2024-02-12
+v1.1.1, 2025-03-27
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -20,6 +20,9 @@ endif::[]
 Additionally, the tool evaluates preprocessor conditionals (unless the option to preserve them is enabled), only keeping those lines from conditions which are true.
 If the document does not contain any preprocessor directives, the tool returns the unmodified source.
 
+TIP: This extension is also published as an npm package named `@asciidoctor/reducer` for use with Asciidoctor.js, and hence, with Antora.
+See the xref:js/README.adoc[README] to find instructions on how to use this package.
+
 == Prerequisites
 
 {project-name} is a Ruby application that you install using Ruby packaging.
@@ -112,21 +115,37 @@ require 'asciidoctor/reducer/api'
 ----
 
 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::Reducer.reduce_file 'sample.adoc'
 ----
 
-Finally, you can retrieve the reduced source from the returned document.
+NOTE: The previous call works without having to specify the safe mode since the default safe mode when using this API is `:safe`.
+However, if any include target points to a file in an ancestor directory of `docdir`, you'll need to set the safe mode to `:unsafe` by passing the option `safe: :unsafe`.
+The options that the `reduce_file` method accepts are a superset of the Asciidoctor API options.
+
+The benefit of this return value is that you can access the reduced source as well as the parsed document that corresponds to it.
+Use the following call to retrieve the reduced source from the returned document.
 
 [,ruby]
 ----
 puts doc.source
 ----
 
-The benefit of this approach is that you can access the reduced source and the parsed document that corresponds to it.
+If you want to retrieve the source split into an array of lines, use the following call instead.
+
+[,ruby]
+----
+puts doc.source_lines
+----
+
+If you only want AsciiDoctor Reducer to process include directives, leaving preprocessor conditional directives untouched, set the `:preserve_conditionals` option:
+
+[,ruby]
+----
+doc = Asciidoctor::Reducer.reduce_file 'sample.adoc', preserve_conditionals: true
+----
 
 If you don't need the parsed document, you can retrieve the reduced source directly by passing the `String` type to the `:to` option:
 
@@ -142,7 +161,37 @@ You can write the reduced source directly to a file by passing a file path to th
 Asciidoctor::Reducer.reduce_file 'sample.adoc', to: 'sample-reduced.adoc'
 ----
 
-== Extension
+=== In Preprocessor
+
+It's generally not safe to read the lines from the reader in an Asciidoctor preprocessor extension because it introduces side effects.
+However, Asciidoctor Reducer offers a workaround for that problem.
+You can use Asciidoctor Reducer to safely retrieve the source lines of the document (with or without resolving preprocessor directives) in order to analyze them or even modify and replace the lines on the reader.
+
+Let's look at how we can retrieve the source lines in an Asciidoctor preprocessor.
+What you do with those lines is then up to you.
+
+[,ruby]
+----
+require 'asciidoctor/reducer/api'
+
+Asciidoctor::Extensions.register do
+  preprocessor do
+    process do |doc, reader|
+      unless doc.options[:extension_registry]&.groups&.include? :reducer
+        reducer_opts = { safe: doc.options[:safe], attributes: doc.options[:attributes].dup }
+        reduced_doc = Asciidoctor::Reducer.reduce_file reader.file, reducer_opts
+        reduced_source_lines = reduced_doc.source_lines
+        ...
+      end
+      reader
+    end
+  end
+end
+----
+
+Since the extension is registered globally, it's necessary to short-circuit it when called by reducer.
+
+=== 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:
@@ -190,8 +239,10 @@ The reducer then uses a tree processor extension to fold the include stack into
 It does so by working from the end of the stack and inserting the lines into the parent until the stack has been flattened.
 As it goes, it also removes lines that have been excluded by the preprocessor conditionals as well as the directive lines themselves (unless the option to preserve conditionals has been specified).
 
-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`).
+If the sourcemap is enabled, it loads the document again.
+Finally, it returns the document.
+The reduced source is available on the reconstructed document via `Document#source` or `Document#source_lines`.
+The source header attributes (those defined in the header of the document) are available via `Document#source_header_attributes`.
 
 === Impact on Extensions
 
@@ -395,6 +446,10 @@ When running the `asciidoctor-reducer` command from source, you must prefix the
 
 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.
 
+== Authors
+
+Asciidoctor Reducer was written by Dan Allen of OpenDevise Inc. and contributed to the Asciidoctor project.
+
 == Copyright and License
 
 Copyright (C) 2021-present Dan Allen.

data/lib/asciidoctor/reducer/extensions.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
-require 'asciidoctor' unless defined? Asciidoctor.load
-require_relative 'preprocessor'
-require_relative 'tree_processor'
+unless RUBY_ENGINE == 'opal'
+  require 'asciidoctor' unless defined? Asciidoctor.load
+  require_relative 'header_attribute_tracker'
+  require_relative 'preprocessor'
+  require_relative 'tree_processor'
+end
 
 module Asciidoctor::Reducer
   module Extensions
@@ -10,9 +13,11 @@ module Asciidoctor::Reducer
 
     def group
       proc do
-        next if document.options[:reduced]
+        document.extend HeaderAttributeTracker
+        next if document.options[:reduced] # group invoked again if includes are found and sourcemap option is true
         preprocessor Preprocessor
         tree_processor TreeProcessor
+        nil
       end
     end
 
@@ -31,12 +36,13 @@ module Asciidoctor::Reducer
       end
     end
 
-    def register
-      ::Asciidoctor::Extensions.register key, &group
+    def register registry = nil
+      (registry || ::Asciidoctor::Extensions).groups[key] ||= group
     end
 
-    def unregister
-      ::Asciidoctor::Extensions.groups.delete key # NOTE `Extensions.unregister key` fails if groups is not initialized
+    def unregister registry = nil
+      (registry || ::Asciidoctor::Extensions).groups.delete key
+      nil
     end
   end
 end

data/lib/asciidoctor/reducer/header_attribute_tracker.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Asciidoctor::Reducer
+  module HeaderAttributeTracker
+    def self.extended instance
+      instance.singleton_class.send :attr_reader, :source_header_attributes
+    end
+
+    def finalize_header(*) # rubocop:disable Style/MethodDefParentheses
+      @source_header_attributes = @attributes_modified.each_with_object({}) do |name, accum|
+        accum[name] = @attributes[name]
+      end
+      super
+    end
+  end
+end

data/lib/asciidoctor/reducer/preprocessor.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'include_directive_tracker'
-require_relative 'conditional_directive_tracker'
+unless RUBY_ENGINE == 'opal'
+  require_relative 'include_directive_tracker'
+  require_relative 'conditional_directive_tracker'
+end
 
 module Asciidoctor::Reducer
   class Preprocessor < ::Asciidoctor::Extensions::Preprocessor

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -23,7 +23,11 @@ module Asciidoctor::Reducer
           end
           target_lines[idx] = lines if target_lines
         end
-        reduced_source_lines = inc_replacements[0][:lines].flatten
+        if RUBY_ENGINE == 'opal'
+          reduced_source_lines = flatten inc_replacements[0][:lines]
+        else
+          reduced_source_lines = inc_replacements[0][:lines].flatten
+        end
         if doc.sourcemap
           logger = doc.logger
           opts = doc.options.merge logger: nil, parse: false, reduced: true
@@ -42,5 +46,31 @@ module Asciidoctor::Reducer
       end
       doc
     end
+
+    private
+
+    def flatten input_list
+      input_list.flatten
+    rescue ::Exception => e # rubocop:disable Lint/RescueException,Lint/UselessAssignment
+      raise unless %x(e.name) == 'RangeError'
+      result = []
+      stack = [[0, input_list, input_list.length]]
+      until stack.empty?
+        idx, list, len = stack.pop
+        while idx < len
+          if Array === (item = list[idx])
+            if (next_idx = idx + 1) < len
+              stack << [next_idx, list, len]
+            end
+            idx = 0
+            len = (list = item).length
+          else
+            result << item
+            idx += 1
+          end
+        end
+      end
+      result
+    end
   end
 end

data/lib/asciidoctor/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.0.6'
+    VERSION = '1.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.1
 platform: ruby
 authors:
 - Dan Allen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -72,6 +72,7 @@ files:
 - lib/asciidoctor/reducer/cli.rb
 - lib/asciidoctor/reducer/conditional_directive_tracker.rb
 - lib/asciidoctor/reducer/extensions.rb
+- lib/asciidoctor/reducer/header_attribute_tracker.rb
 - lib/asciidoctor/reducer/include_directive_tracker.rb
 - lib/asciidoctor/reducer/include_mapper.rb
 - lib/asciidoctor/reducer/include_mapper/extension.rb
@@ -86,7 +87,7 @@ metadata:
   changelog_uri: https://github.com/asciidoctor/asciidoctor-reducer/blob/main/CHANGELOG.adoc
   mailing_list_uri: https://chat.asciidoctor.org
   source_code_uri: https://github.com/asciidoctor/asciidoctor-reducer
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Reduces an AsciiDoc document containing includes and conditionals to a single
   AsciiDoc document.