asciidoctor-reducer 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '042939f0b251163208b57a67bed8a7b16d15d0972a616e67c171b8462a5ae61b'
-  data.tar.gz: 9065fc1b7a742f057441f873956883e6c87ba88afb1984496c821f378e666e2b
+  metadata.gz: 61484f3684d8fdfc67590e300484c52e9a2bdf14cd9e46a7a59c8bd7926836ba
+  data.tar.gz: 5a7327b41a1c2a33ecbec9288e7eb155d2757e9a94cbd64da3497caaab89e3b8
 SHA512:
-  metadata.gz: 53e3e2cd52cf60ff810b93c5409cf521c1e5509106c8cece15ac89262d5a7d0ac998b2369ebb1cd8854675de930ea3a2f10c762bf072f758db663f3b6e7aa0ed
-  data.tar.gz: 1785df7825bd0fb902dd619bf42b2de90360acdf975f3356ca5ad8ed7b65a32c71c8824b51b966aecce774078d14d5c6dcdf281d899eb6f54e61307dbec0b0ce
+  metadata.gz: de7ead3ed1f79256653758038bc1b313a01deaeeba2295f042ba21c7af9d8125581a938dbeceebe6caaec952412a1e84dfbe2eb6f1f8aecfbc45d87a38d69de1
+  data.tar.gz: 979950581b012e1c46c035bcf30941502800e6c921ba0612167d60accec9ba1efd25cce729877d85f1944d1336f4bb6290fa1581096e9a4f73f66250547bac88

data/CHANGELOG.adoc

@@ -4,6 +4,30 @@
 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.0.3 (2022-09-22) - @mojavelinux
+
+=== Changed
+
+* Log error message if program cannot locate include directive to reduce (indicates a probable logic error in the program)
+
+=== Fixed
+
+* Reduce preprocessor directives in file included by include directive with `leveloffset` attribute (#45)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.3[git tag] | {url-repo}/compare/v1.0.2\...v1.0.3[full diff]
+
+== 1.0.2 (2022-05-09) - @mojavelinux
+
+=== Fixed
+
+* Replace include and conditional directives inside a file that has been included partially (i.e., has an offset) (#43)
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.2[git tag] | {url-repo}/compare/v1.0.1\...v1.0.2[full diff]
+
 == 1.0.1 (2022-05-08) - @mojavelinux
 
 === Changed

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.1, 2022-05-08
+v1.0.3, 2022-09-22
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -260,6 +260,45 @@ Here's an example of that comment:
 
 When a document that contains the magic comment is converted, the include mapper reads the comma-separated paths in the value and loads them into the includes table of the document catalog.
 
+== Reduce files in a GitHub repository
+
+It's well known that the AsciiDoc preview on GitHub does not support the include directive.
+With the help of GitHub Actions, Asciidoctor Reducer is ready-made to solve this problem.
+
+In order to set up this automated process, you need to first rename the source file to make room for the reduced file.
+Let's call the source file [.path]_README-source.adoc_ and the reduced file [.path]_README.adoc_.
+
+Next, create a GitHub Actions workflow file named [.path]_.github/workflows/reduce-readme.yml_ and populate it with the following contents:
+
+..github/workflows/reduce-readme.yml
+[,yaml]
+----
+name: Reduce README
+on:
+  push:
+    paths:
+    - README-source.adoc
+    branches: ['**']
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+    - name: Install Asciidoctor Reducer
+      run: sudo gem install asciidoctor-reducer
+    - name: Reduce README
+      run: asciidoctor-reducer -o README.adoc README-source.adoc
+    - name: Commit and Push README
+      uses: EndBug/add-and-commit@v9
+      with:
+        add: README.adoc
+----
+
+Now, each time you modify, commit, and push the [.path]_README-source.adoc_ file, the GitHub Action workflow will run, reduce that file, and push the reduced file back to the repository as [.path]_README.adoc_.
+
+If you want to trigger the workflow on changes to other files as well, add those paths or path patterns to the value of the `paths` key.
+
 == Development
 
 Follow the instructions below to learn how to help develop the project or test-drive the development version.

data/lib/asciidoctor/reducer/conditional_directive_tracker.rb

@@ -8,7 +8,9 @@ module Asciidoctor::Reducer
       directive_lineno = @lineno
       result = super
       return result if @skipping && skip_active
-      drop = @include_replacements.current[:drop] ||= []
+      curr_inc_replacement = @include_replacements.current
+      drop = curr_inc_replacement[:drop] ||= []
+      directive_lineno -= (curr_inc_replacement[:offset] ||= 0)
       if (depth_change = @conditional_stack.size - depth) < 0
         if skip_active
           drop.push(*(drop.pop..directive_lineno))

data/lib/asciidoctor/reducer/include_directive_tracker.rb

@@ -18,7 +18,7 @@ module Asciidoctor::Reducer
             directive_lineno == @lineno && (unresolved = ln.start_with? 'link:')
           ln = %(#{ln.slice 0, (ln.length - 1)}role=include])
         end
-        push_include_replacement directive_lineno, (unresolved ? [ln] : []), unresolved
+        push_include_replacement directive_lineno, (unresolved ? [ln] : []), 0, unresolved
       end
       @x_reducer.clear
       result
@@ -28,8 +28,13 @@ module Asciidoctor::Reducer
       @x_reducer[:include_pushed] = true
       directive_lineno = @lineno - 1 # we're below the include line, which is 1-based
       prev_inc_depth = @include_stack.size
+      offset = lineno > 1 ? lineno - 1 : 0
       result = super
-      push_include_replacement directive_lineno, (@include_stack.size > prev_inc_depth ? lines : [])
+      if @include_stack.size > prev_inc_depth
+        inc_lines = lines
+        offset -= 2 if (attrs.key? 'leveloffset') && (inc_lines[0].start_with? ':leveloffset: ') && inc_lines[1]&.empty?
+      end
+      push_include_replacement directive_lineno, inc_lines || [], offset
       result
     end
 
@@ -40,12 +45,13 @@ module Asciidoctor::Reducer
 
     private
 
-    def push_include_replacement lineno, lines, unresolved = false
+    def push_include_replacement lineno, lines, offset, unresolved = false
       (inc_replacements = @include_replacements) << {
         into: inc_replacements.pointer,
-        lineno: lineno,
+        lineno: lineno - (inc_replacements.current[:offset] ||= 0),
         line: @x_reducer[:include_directive_line],
         lines: lines,
+        offset: offset,
       }
       inc_replacements.to_end unless unresolved || lines.empty?
       nil

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -8,8 +8,12 @@ module Asciidoctor::Reducer
         inc_replacements.reverse_each do |it|
           if (into = it[:into])
             target_lines = inc_replacements[into][:lines]
-            # adds extra bit of assurance that we're replacing the correct line
-            next unless target_lines[(idx = it[:lineno] - 1)] == it[:line]
+            # adds extra assurance that the program is replacing the correct line
+            unless target_lines[(idx = it[:lineno] - 1)] == it[:line]
+              msg = %(include directive to reduce not found; expected: "#{it[:line]}"; got: "#{target_lines[idx]}")
+              doc.logger.error msg
+              next
+            end
           end
           lines = it[:lines]
           unless (drop = it[:drop] || []).empty?
@@ -21,7 +25,7 @@ module Asciidoctor::Reducer
         end
         reduced_source_lines = inc_replacements[0][:lines].flatten
         if doc.sourcemap
-          logger = ::Asciidoctor::LoggerManager.logger
+          logger = doc.logger
           opts = doc.options.merge logger: nil, parse: false, reduced: true
           if (ext_reg = opts[:extension_registry])
             opts[:extension_registry] = ::Asciidoctor::Extensions::Registry.new ext_reg.groups

data/lib/asciidoctor/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.0.1'
+    VERSION = '1.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor