asciidoctor-reducer 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5316a1e0a22871599401171fc8f5104e4a03cf09598eacee8670153354e6050
-  data.tar.gz: 02cc09578b9798e53f3e8a23f81b2e051ef2b6714c39bee99d043a6cbee2acc5
+  metadata.gz: '093396b7e8100e4c3c7ee3a3aadfea734195bee629fe5284c2dc7e09d6a270d7'
+  data.tar.gz: d216e0f827b3c0eeb5f80f130ef0d8200567f14babda2f42b65fb141f465d842
 SHA512:
-  metadata.gz: a2ef54d4a37f4c1f2205cb191735a1d6462ad271faa75db4ea87305c5ba25f2ba08885057f5c56006703ad745fc2c55928ac0c6db9205e9ee35284fab245f395
-  data.tar.gz: '0018183fd91c359a67ad0a6e5b60901f5f868bc4223bd9fc27c639eb5fb05a684c938480507a9ff445bdd00ad260ff385c29d68a6359c2498cc6a4d9cee0320a'
+  metadata.gz: b2d405cce7f61beae5ed35f4247892ee321bdb4efbba0c49faa325560503be3bb68d828e2018df686e95c0ddf576436c625d3b81dc87847e8ccce6642d3ecc92
+  data.tar.gz: 4454a1023fbba097f8b8227de6d0c594f215a77cc6f57d71f423141c9594f07e6fee8635e8ef61939f6551a0f6062639dc39c52a197de5b162f9300b9cc3844a

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.4 (2022-10-15) - @mojavelinux
+
+=== Changed
+
+* don't add role to link that replaces include directive if role is already present
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.4[git tag] | {url-repo}/compare/v1.0.3\...v1.0.4[full diff]
+
+== 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

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.2, 2022-05-09
+v1.0.4, 2022-10-15
 :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/asciidoctor-reducer.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.metadata = {
     'bug_tracker_uri' => 'https://github.com/asciidoctor/asciidoctor-reducer/issues',
     'changelog_uri' => 'https://github.com/asciidoctor/asciidoctor-reducer/blob/main/CHANGELOG.adoc',
-    'mailing_list_uri' => 'https://asciidoctor.zulipchat.com',
+    'mailing_list_uri' => 'https://chat.asciidoctor.org',
     'source_code_uri' => 'https://github.com/asciidoctor/asciidoctor-reducer'
   }
 

data/lib/asciidoctor/reducer/include_directive_tracker.rb

@@ -15,8 +15,8 @@ module Asciidoctor::Reducer
       result = super
       unless @x_reducer[:include_pushed]
         if ((ln = peek_line true)&.end_with? ']') && !(unresolved = ln.start_with? 'Unresolved directive in ') &&
-            directive_lineno == @lineno && (unresolved = ln.start_with? 'link:')
-          ln = %(#{ln.slice 0, (ln.length - 1)}role=include])
+            directive_lineno == @lineno && (unresolved = ln.start_with? 'link:') && (ln.end_with? '[]')
+          ln = %(#{ln.chop}role=include])
         end
         push_include_replacement directive_lineno, (unresolved ? [ln] : []), 0, unresolved
       end
@@ -30,7 +30,11 @@ module Asciidoctor::Reducer
       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 : []), offset
+      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
 

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 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.2'
+    VERSION = '1.0.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -84,7 +84,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/asciidoctor/asciidoctor-reducer/issues
   changelog_uri: https://github.com/asciidoctor/asciidoctor-reducer/blob/main/CHANGELOG.adoc
-  mailing_list_uri: https://asciidoctor.zulipchat.com
+  mailing_list_uri: https://chat.asciidoctor.org
   source_code_uri: https://github.com/asciidoctor/asciidoctor-reducer
 post_install_message: 
 rdoc_options: []