asciidoctor-reducer 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aad6e916f11307d608d015b5befc14567f71638ed6baf9023416846ee8d2136
-  data.tar.gz: e51e12a72a7b4acaa6335e69cf489a356e109d57640dff8b1c7f4bfdfedaed53
+  metadata.gz: d79dee7d3fe04a10fac4e4ea7ff50a564bc915cd20be9ccc9bfa21b41e2ab836
+  data.tar.gz: a830fd2dd521f0e2154a8d46917278254eec564d6ede76ba07d147581a2a7414
 SHA512:
-  metadata.gz: 46f16ea6198d0aa04dc00c890522b8014a2f5e9bad8c684acf7a39dc275bc339ddc587409c8bc34bee1227aa976ba7f4d25c3a08e2412070a7963219483acec8
-  data.tar.gz: b5c42486dcccd3e178d1cbda2b09f1c7656746a830087f64a9ece7d79ab99ef9e67e40bacd19b9310063915a3bf76ea26af73b6ba18e957edc9580cdbc13773b
+  metadata.gz: 77dbc3cd2f39503f85093edce50bb32d9da44c700de3c61558ddfbd9c2d3b7bfc5e0cb4e05d9705e460d92d4da30555c1bbf9d90a54cb19176ffdceb2711cf8c
+  data.tar.gz: 3228ea887ee92bf585258dae1ec3dc120309f3d1274c8ddc90558a25473a72e1bfa2c20074fdb8b1033db90730f558c45967457279660d6782b6fa4567d7e1ee

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.2 (2025-05-09) - @mojavelinux
+
+=== Fixed
+
+* Don't define reader for source_header_attributes instance variable if already defined
+* Only catch RangeError when flattening list when using Opal runtime
+
+=== Details
+
+{url-repo}/releases/tag/v1.1.2[git tag] | {url-repo}/compare/v1.1.1\...v1.1.2[full diff]
+
+== 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

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.1.0, 2024-11-24
+v1.1.2, 2025-05-09
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -115,21 +115,30 @@ 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 this 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:
 
@@ -152,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:
@@ -407,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/api.rb

@@ -50,7 +50,7 @@ module Asciidoctor::Reducer
     private
 
     def write doc, to
-      return doc unless to && to != '/dev/null'
+      return doc unless to && to != ::File::NULL
       output = doc.source
       return output if to == ::String
       output += LF unless output.empty?

data/lib/asciidoctor/reducer/header_attribute_tracker.rb

@@ -3,10 +3,11 @@
 module Asciidoctor::Reducer
   module HeaderAttributeTracker
     def self.extended instance
+      return if instance.singleton_class.method_defined? :source_header_attributes
       instance.singleton_class.send :attr_reader, :source_header_attributes
     end
 
-    def finalize_header(*) # rubocop:disable Style/MethodDefParentheses
+    def finalize_header(*)
       @source_header_attributes = @attributes_modified.each_with_object({}) do |name, accum|
         accum[name] = @attributes[name]
       end

data/lib/asciidoctor/reducer/include_mapper/extension.rb

@@ -5,7 +5,7 @@ module Asciidoctor::Reducer
     def process doc
       if doc.extensions.groups[:reducer]
         unless (includes = doc.catalog[:includes].map {|name, val| val ? name : %(~#{name}) }).empty?
-          doc.source_lines.concat ['', %(//# includes=#{includes.join ','})]
+          doc.source_lines.push '', %(//# includes=#{includes.join ','})
         end
       elsif (last_line = doc.source_lines[-1])&.start_with? '//# includes='
         doc.catalog[:includes].update ((last_line.slice 13, last_line.length).split ',')

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,37 @@ module Asciidoctor::Reducer
       end
       doc
     end
+
+    private
+
+    if RUBY_ENGINE == 'opal'
+      def flatten input_list
+        input_list.flatten
+      rescue ::Exception => e # rubocop:disable Lint/RescueException
+        raise unless e && %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
+    else
+      def flatten input_list
+        input_list.flatten
+      end
+    end
   end
 end

data/lib/asciidoctor/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.1.0'
+    VERSION = '1.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Dan Allen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-24 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -87,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
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Reduces an AsciiDoc document containing includes and conditionals to a single
   AsciiDoc document.