asciidoctor-reducer 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0315811ef24fa88a755aa6973e86aca45929a43416020d2f82afa7ef1e664fd9'
-  data.tar.gz: 745ee8bc00aba042843abb05bb22a8ad93a50dc9de7090bd946c82b3333b19d3
+  metadata.gz: 3aad6e916f11307d608d015b5befc14567f71638ed6baf9023416846ee8d2136
+  data.tar.gz: e51e12a72a7b4acaa6335e69cf489a356e109d57640dff8b1c7f4bfdfedaed53
 SHA512:
-  metadata.gz: a0eca70526db73201588d3b9154207b7ec1bdf30f41c8799ee6a88a36091e4906b4ce00ef183939be46c3ed8cd78778119e206585e01648fa20eff48c16cd6e9
-  data.tar.gz: 3c97e30588293c5e599cf26d6dff4b142936582bf8544f9d6f577a5ae6a000e1b4e1a835fd33dbaa22f044c863f51e827aa42f56ab6d758a1acf3b5485bc938d
+  metadata.gz: 46f16ea6198d0aa04dc00c890522b8014a2f5e9bad8c684acf7a39dc275bc339ddc587409c8bc34bee1227aa976ba7f4d25c3a08e2412070a7963219483acec8
+  data.tar.gz: b5c42486dcccd3e178d1cbda2b09f1c7656746a830087f64a9ece7d79ab99ef9e67e40bacd19b9310063915a3bf76ea26af73b6ba18e957edc9580cdbc13773b

data/CHANGELOG.adoc

@@ -4,6 +4,17 @@
 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.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.0, 2024-11-24
 :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,7 +115,7 @@ 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`.
+(This works without having to specify the safe mode since the default safe mode when using this API is `:safe`).
 
 [,ruby]
 ----
@@ -128,6 +131,13 @@ 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 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:
 
 [,ruby]
@@ -190,8 +200,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
 

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/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.0.6'
+    VERSION = '1.1.0'
   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.0
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-11-24 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
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Reduces an AsciiDoc document containing includes and conditionals to a single