asciidoctor-reducer 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8618df3cfe6cc9e6ed5d93fd1cc9a29c6026f2fa9b8fd017098c37cebff3eb05
-  data.tar.gz: c1bba0fcd19f6c09176c91caf72f46c338d8116b802c1992b10629e0e776f09a
+  metadata.gz: 3aad6e916f11307d608d015b5befc14567f71638ed6baf9023416846ee8d2136
+  data.tar.gz: e51e12a72a7b4acaa6335e69cf489a356e109d57640dff8b1c7f4bfdfedaed53
 SHA512:
-  metadata.gz: 52e0007d74c7495f44b89bc12ba4c0ab7e378d9050ce069f28655d580deae8268b162e8e223fc21bf05e9d2583355493abb654a781ae22768b8c3e762fb32d7f
-  data.tar.gz: 01125c00be7703eaeefe0e2b160c5df2cda937111444b986a6f86df4f02ec36f431e0cdf22b48aa8ea808c2094ccb482dcb22ff26999899d87ef0f49686bcd5c
+  metadata.gz: 46f16ea6198d0aa04dc00c890522b8014a2f5e9bad8c684acf7a39dc275bc339ddc587409c8bc34bee1227aa976ba7f4d25c3a08e2412070a7963219483acec8
+  data.tar.gz: b5c42486dcccd3e178d1cbda2b09f1c7656746a830087f64a9ece7d79ab99ef9e67e40bacd19b9310063915a3bf76ea26af73b6ba18e957edc9580cdbc13773b

data/CHANGELOG.adoc

@@ -4,11 +4,32 @@
 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
+
+* Reduce single line conditionals inside file included by include directive with `leveloffset` attribute (#53)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.6[git tag] | {url-repo}/compare/v1.0.5\...v1.0.6[full diff]
+
 == 1.0.5 (2022-10-15) - @mojavelinux
 
 === Changed
 
-* insert `role=include` into link macro that replaces include directive more carefully
+* Insert `role=include` into link macro that replaces include directive more carefully
 
 === Details
 
@@ -18,7 +39,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Changed
 
-* don't add role to link that replaces include directive if role is already present
+* Don't add role to link that replaces include directive if role is already present
 
 === Details
 

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.5, 2022-10-15
+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.
@@ -83,6 +86,10 @@ Thus, to use the command, pass the AsciiDoc file as the sole argument:
 
  $ asciidoctor-reducer input.adoc
 
+If you only want AsciiDoctor Reducer to process include directives, leaving preprocessor conditional directives untouched, add the `--preserve-conditionals` option:
+
+ $ asciidoctor-reducer --preserve-conditionals 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:
 
@@ -108,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]
 ----
@@ -124,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]
@@ -186,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
 
@@ -217,7 +233,7 @@ To use the include mapper when using the API, first require the extension:
 
 [,ruby]
 ----
-require 'asciidocotor/reducer/include_mapper/extension'
+require 'asciidoctor/reducer/include_mapper/extension'
 ----
 
 You then need to register the extension when reducing the document:
@@ -243,7 +259,7 @@ You can also register the extension globally:
 
 [,ruby]
 ----
-require 'asciidocotor/reducer/include_mapper'
+require 'asciidoctor/reducer/include_mapper'
 ----
 
 In this case, you don't have to pass it to the API explicitly.
@@ -284,10 +300,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout Repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Install Asciidoctor Reducer
       run: sudo gem install asciidoctor-reducer
     - name: Reduce README
+      # to preserve preprocessor conditionals, add the --preserve-conditionals option
       run: asciidoctor-reducer -o README.adoc README-source.adoc
     - name: Commit and Push README
       uses: EndBug/add-and-commit@v9
@@ -335,7 +352,7 @@ The tests are based on RSpec.
 
 You can run all of the tests using Rake:
 
- $ bundle exec spec
+ $ bundle exec rake spec
 
 For more fine-grained control, you can also run the tests directly using RSpec:
 
@@ -376,7 +393,7 @@ RSpec will only run the specifications that have a description containing the te
 
 To generate a code coverage report when running tests using simplecov, set the `COVERAGE` environment variable as follows when running the tests:
 
- $ COVERAGE=deep bundle exec rake
+ $ COVERAGE=deep bundle exec rake spec
 
 You'll see a total coverage score, a detailed coverage report, and a link to HTML report in the output.
 The HTML report helps you understand which lines and branches were missed, if any.

data/asciidoctor-reducer.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
 
-  s.add_development_dependency 'rake', '~> 13.0.0'
-  s.add_development_dependency 'rspec', '~> 3.11.0'
+  s.add_development_dependency 'rake', '~> 13.1.0'
+  s.add_development_dependency 'rspec', '~> 3.13.0'
 end

data/lib/asciidoctor/reducer/conditional_directive_tracker.rb

@@ -10,17 +10,17 @@ module Asciidoctor::Reducer
       return result if @skipping && skip_active
       curr_inc_replacement = @include_replacements.current
       drop = curr_inc_replacement[:drop] ||= []
-      directive_lineno -= (curr_inc_replacement[:offset] ||= 0)
+      adjusted_directive_lineno = directive_lineno - (curr_inc_replacement[:offset] ||= 0)
       if (depth_change = @conditional_stack.size - depth) < 0
         if skip_active
-          drop.push(*(drop.pop..directive_lineno))
+          drop.push(*(drop.pop..adjusted_directive_lineno))
         else
-          drop << directive_lineno
+          drop << adjusted_directive_lineno
         end
       elsif depth_change > 0 || directive_lineno == @lineno
-        drop << directive_lineno
+        drop << adjusted_directive_lineno
       else
-        drop << [directive_lineno, text]
+        drop << [adjusted_directive_lineno, text]
       end
       result
     end

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

@@ -38,13 +38,13 @@ module Asciidoctor::Reducer
       result
     end
 
+    private
+
     def pop_include
       @include_replacements.up unless @x_reducer[:include_pushed]
       super
     end
 
-    private
-
     def push_include_replacement lineno, lines, offset, unresolved = false
       (inc_replacements = @include_replacements) << {
         into: inc_replacements.pointer,

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.5'
+    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.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2024-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.13.0
 description: A tool that reduces an AsciiDoc document containing preprocessor directives
   (includes and conditionals) to a single AsciiDoc document by expanding all includes
   and evaluating all conditionals.
@@ -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.7
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Reduces an AsciiDoc document containing includes and conditionals to a single