asciidoctor-reducer 1.0.0.alpha.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 425f7379b4e69cb9487a2c2affcd77bd7cc548bd7818b073334f45a64f853f9c
-  data.tar.gz: b3a85d94ee64d2ecee967a3a88a7ce4295af83eda84c76f852df24fcb312b9ee
+  metadata.gz: 28901fa8f69c6cffe25cac501f7242980cd50dce1ad0586ccff44ed66c4eee30
+  data.tar.gz: a8c80c18c767ba36a0c3642b69e166532c191d0f5772e884fb86d3341dc1889b
 SHA512:
-  metadata.gz: f48fffea4f5dd09c1cec0d375a1fe1050144c5e723802413e2de3191c57e221f0482f210addb533d4b7ddac23a7142ee5b75721e9d5b1269e001d17da97d5726
-  data.tar.gz: a4538dc754a1f4b82aa0fd4bb8b89ed848da9b3932430dbb2c51c3b443d08c0d5a4c345925be75cbbee0c0fa1cf8dce08e60d42d9a27d3b2ddb2b5ad9c30f5c6
+  metadata.gz: b00cbaa7e4d145ed571dfe282f4b440dd61472feabdd79338ca27e2ceaf795593e0efb7e3f86cb05d021176328d4a20a37adf4f6ffdefb3b30fad480672e2821
+  data.tar.gz: a923404fe5ed452e3a4145ba15f8512a441c6d8b47986a22bc1485edc6c8672f28f31dba30ad2e224ae2a3f98d7b383b1d5cefa81ae70af7779205ea300d6d1a

data/CHANGELOG.adoc

@@ -1,9 +1,35 @@
 = Asciidoctor Reducer Changelog
 :url-repo: https://github.com/asciidoctor/asciidoctor-reducer
 
-This document provides a high-level view of the changes to the Asciidoctor Reducer by release.
+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.0 (2022-04-22) - @mojavelinux
+
+_No changes since previous release._
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0[git tag] | {url-repo}/compare/v1.0.0-rc.1\...v1.0.0[full diff]
+
+== 1.0.0-rc.1 (2022-04-22) - @mojavelinux
+
+_No changes since previous release._
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-rc.1[git tag] | {url-repo}/compare/v1.0.0-beta.1\...v1.0.0-rc.1[full diff]
+
+== 1.0.0-beta.1 (2022-04-21) - @mojavelinux
+
+=== Changed
+
+* Add names of include files which have been included partially in include mapping comment and prefix names with ~
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.0-beta.1[git tag] | {url-repo}/compare/v1.0.0.alpha.10\...v1.0.0-beta.1[full diff]
+
 == 1.0.0.alpha.10 (2022-04-21) - @mojavelinux
 
 === Changed
@@ -59,7 +85,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.8[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.8[git tag] | {url-repo}/compare/v1.0.0.alpha.7\...v1.0.0.alpha.8[full diff]
 
 == 1.0.0.alpha.7 (2022-02-14) - @mojavelinux
 
@@ -82,7 +108,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.7[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.7[git tag] | {url-repo}/compare/v1.0.0.alpha.6\...v1.0.0.alpha.7[full diff]
 
 == 1.0.0.alpha.6 (2022-02-10) - @mojavelinux
 
@@ -106,7 +132,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.6[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.6[git tag] | {url-repo}/compare/v1.0.0.alpha.5\...v1.0.0.alpha.6[full diff]
 
 == 1.0.0.alpha.5 (2022-02-06) - @mojavelinux
 
@@ -123,7 +149,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.5[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.5[git tag] | {url-repo}/compare/v1.0.0.alpha.4\...v1.0.0.alpha.5[full diff]
 
 == 1.0.0.alpha.4 (2022-02-03) - @mojavelinux
 
@@ -133,7 +159,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.4[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.4[git tag] | {url-repo}/compare/v1.0.0.alpha.3\...v1.0.0.alpha.4[full diff]
 
 == 1.0.0.alpha.3 (2022-02-02) - @mojavelinux
 
@@ -146,7 +172,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.3[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.3[git tag] | {url-repo}/compare/v1.0.0.alpha.2\...v1.0.0.alpha.3[full diff]
 
 == 1.0.0.alpha.2 (2022-01-27) - @mojavelinux
 
@@ -169,7 +195,7 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co
 
 === Details
 
-{url-repo}/releases/tag/v1.0.0.alpha.2[git tag]
+{url-repo}/releases/tag/v1.0.0.alpha.2[git tag] | {url-repo}/compare/v1.0.0.alpha.1\...v1.0.0.alpha.2[full diff]
 
 == 1.0.0.alpha.1 (2022-01-12) - @mojavelinux
 

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0.alpha.10, 2022-04-21
+v1.0.0, 2022-04-22
 :idprefix:
 :idseparator: -
 ifndef::env-github[:icons: font]
@@ -16,9 +16,9 @@ endif::[]
 :url-rvm: https://rvm.io
 :url-repo: https://github.com/asciidoctor/{project-handle}
 
-{project-name} is a tool that reduces an AsciiDoc document that contains includes to a single AsciiDoc document by expanding any includes reachable from the parent document.
-The tool also applies preprocessor conditionals (unless the option to preserve them is specified), leaving behind only the selected lines.
-If the document does not contain any preprocessor directives, the tool returns the original source.
+{project-name} is a tool that reduces an AsciiDoc document containing include directives to a single AsciiDoc document by expanding the includes reachable from the parent document.
+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.
 
 == Prerequisites
 
@@ -38,7 +38,7 @@ We generally recommend using RVM as it allows you to install gems without requir
 
 You can install the latest version of the gem using the following command:
 
- $ gem install asciidoctor-reducer --pre
+ $ gem install asciidoctor-reducer
 
 Installing this gem makes the `asciidoctor-reducer` command available on your $PATH.
 You can also require the gem into the Ruby runtime to use it as a library or Asciidoctor extension.

data/asciidoctor-reducer.gemspec

@@ -7,8 +7,8 @@ end
 Gem::Specification.new do |s|
   s.name = 'asciidoctor-reducer'
   s.version = Asciidoctor::Reducer::VERSION
-  s.summary = 'Reduces a composite AsciiDoc document containing includes and conditionals to a single AsciiDoc document.'
-  s.description = 'A tool that reduces a composite AsciiDoc document containing preprocessor directives (includes and conditionals) to a single AsciiDoc document by expanding the includes and applying the conditionals.'
+  s.summary = 'Reduces an AsciiDoc document containing includes and conditionals to a single AsciiDoc document.'
+  s.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.'
   s.authors = ['Dan Allen']
   s.email = 'dan.j.allen@gmail.com'
   s.homepage = 'https://asciidoctor.org'

data/lib/asciidoctor/reducer/api.rb

@@ -7,6 +7,15 @@ module Asciidoctor::Reducer
   autoload :VERSION, (::File.join __dir__, 'version.rb')
 
   class << self
+    # Reduces the AsciiDoc source and either returns the reduced Asciidoctor::Document or writes the source to a file.
+    #
+    # This method accepts all the options supported by Asciidoctor.load.
+    #
+    # @param input [String, File, Pathname] the AsciiDoc source to reduce.
+    # @param opts [Hash] additional options to configure the behavior of the reducer.
+    # @option opts [File, Pathname, Class] :to (nil) the target to which to write the reduced source.
+    #
+    # @return [Asciidoctor::Document, nil] the reduced document object or nil if the :to option is specified.
     def reduce input, opts = {}
       opts = opts&.merge || {}
       if (extension_registry = Extensions.prepare_registry opts[:extension_registry] || opts[:extensions])
@@ -25,6 +34,15 @@ module Asciidoctor::Reducer
       write doc, to
     end
 
+    # Reduces the AsciiDoc file and either returns the reduced Asciidoctor::Document or writes the source to a file.
+    #
+    # This method accepts all the options supported by Asciidoctor.load.
+    #
+    # @param input_file [String] the path of the AsciiDoc file to reduce.
+    # @param opts [Hash] additional options to configure the behavior of the reducer.
+    # @option opts [File, Pathname, Class] :to (nil) the target to which to write the reduced source.
+    #
+    # @return [Asciidoctor::Document, nil] the reduced document object or nil if the :to option is specified.
     def reduce_file input_file, opts = {}
       reduce (::Pathname.new input_file), opts
     end

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

@@ -4,11 +4,12 @@ module Asciidoctor::Reducer
   class IncludeMapper < ::Asciidoctor::Extensions::TreeProcessor
     def process doc
       if doc.extensions.groups[:reducer]
-        unless (includes = doc.catalog[:includes].select {|_, v| v }.keys).empty?
+        unless (includes = doc.catalog[:includes].map {|name, val| val ? name : %(~#{name}) }).empty?
           doc.source_lines.concat ['', %(//# 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 ',').map {|it| [it, true] }.to_h
+        doc.catalog[:includes].update ((last_line.slice 13, last_line.length).split ',')
+          .map {|it| [(fragment = it.chr == '~') ? (it.slice 1, it.length) : it, !fragment] }.to_h
       end
       doc
     end

data/lib/asciidoctor/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.0.0.alpha.10'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.10
+  version: 1.0.0
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -52,9 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.11.0
-description: A tool that reduces a composite AsciiDoc document containing preprocessor
-  directives (includes and conditionals) to a single AsciiDoc document by expanding
-  the includes and applying the conditionals.
+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.
 email: dan.j.allen@gmail.com
 executables:
 - asciidoctor-reducer
@@ -97,13 +97,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: Reduces a composite AsciiDoc document containing includes and conditionals
-  to a single AsciiDoc document.
+summary: Reduces an AsciiDoc document containing includes and conditionals to a single
+  AsciiDoc document.
 test_files: []