asciidoctor-reducer 1.0.0-beta.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba34a52b145d4aec9db42e4149f7bbdf29897657f99d6b446d05510e0d193835
-  data.tar.gz: 71c60fcd5c4a1b1dc403885c3b47816b23917c755a9c4c3e6d40d0305fdae35a
+  metadata.gz: '042939f0b251163208b57a67bed8a7b16d15d0972a616e67c171b8462a5ae61b'
+  data.tar.gz: 9065fc1b7a742f057441f873956883e6c87ba88afb1984496c821f378e666e2b
 SHA512:
-  metadata.gz: 31c60803245045f362a162771cba785a2b11e2d65e504b0a06a220c9b22b9376a6c0f2e1b26ad580af9db2bff2c94d99502b7c4a065032a006dc0f409bb737c2
-  data.tar.gz: c1e960d7705de5cbb26fdb4cadd54fdbefaaf77617f9f4ac9f43ffbefb5089a2ae96af2d34be3333d43b404bba158e029e678d889c8410b7548e7eebbf343e4b
+  metadata.gz: 53e3e2cd52cf60ff810b93c5409cf521c1e5509106c8cece15ac89262d5a7d0ac998b2369ebb1cd8854675de930ea3a2f10c762bf072f758db663f3b6e7aa0ed
+  data.tar.gz: 1785df7825bd0fb902dd619bf42b2de90360acdf975f3356ca5ad8ed7b65a32c71c8824b51b966aecce774078d14d5c6dcdf281d899eb6f54e61307dbec0b0ce

data/CHANGELOG.adoc

@@ -1,9 +1,36 @@
 = 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.1 (2022-05-08) - @mojavelinux
+
+=== Changed
+
+* Use summary from gemspec in help text for `asciidoctor-reducer` command
+* Consistently access `source_lines` from document; use `#replace` to update
+
+=== Details
+
+{url-repo}/releases/tag/v1.0.1[git tag] | {url-repo}/compare/v1.0.0\...v1.0.1[full diff]
+
+== 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

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0-beta.1, 2022-04-21
+v1.0.1, 2022-05-08
 :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/cli.rb

@@ -14,7 +14,7 @@ module Asciidoctor::Reducer
           opts.banner = <<~END
           Usage: #{opts.program_name} [OPTION]... FILE
 
-          Reduces a composite AsciiDoc document containing includes and conditionals to a single AsciiDoc document.
+          #{::Gem.loaded_specs['asciidoctor-reducer'].summary}
 
           END
 

data/lib/asciidoctor/reducer/conditional_directive_tracker.rb

@@ -5,20 +5,20 @@ module Asciidoctor::Reducer
     def preprocess_conditional_directive keyword, target, delimiter, text
       skip_active = @skipping
       depth = @conditional_stack.size
-      cond_lineno = @lineno
+      directive_lineno = @lineno
       result = super
       return result if @skipping && skip_active
       drop = @include_replacements.current[:drop] ||= []
       if (depth_change = @conditional_stack.size - depth) < 0
         if skip_active
-          drop.push(*(drop.pop..cond_lineno))
+          drop.push(*(drop.pop..directive_lineno))
         else
-          drop << cond_lineno
+          drop << directive_lineno
         end
-      elsif depth_change > 0 || cond_lineno == @lineno
-        drop << cond_lineno
+      elsif depth_change > 0 || directive_lineno == @lineno
+        drop << directive_lineno
       else
-        drop << [cond_lineno, text]
+        drop << [directive_lineno, text]
       end
       result
     end

data/lib/asciidoctor/reducer/include_directive_tracker.rb

@@ -2,10 +2,8 @@
 
 module Asciidoctor::Reducer
   module IncludeDirectiveTracker
-    attr_reader :include_replacements
-    attr_writer :source_lines
-
     def self.extended instance
+      instance.singleton_class.send :attr_reader, :include_replacements
       instance.instance_variable_set :@include_replacements, ([{}].extend CurrentPosition)
       instance.instance_variable_set :@x_reducer, {}
     end
@@ -13,14 +11,14 @@ module Asciidoctor::Reducer
     def preprocess_include_directive target, attrlist
       @x_reducer[:include_directive_line] = %(include::#{target}[#{attrlist}])
       @x_reducer[:include_pushed] = false
-      inc_lineno = @lineno # we're currently on the include line, which is 1-based
+      directive_lineno = @lineno # we're currently on the include line, which is 1-based
       result = super
       unless @x_reducer[:include_pushed]
         if ((ln = peek_line true)&.end_with? ']') && !(unresolved = ln.start_with? 'Unresolved directive in ') &&
-            inc_lineno == @lineno && (unresolved = ln.start_with? 'link:')
+            directive_lineno == @lineno && (unresolved = ln.start_with? 'link:')
           ln = %(#{ln.slice 0, (ln.length - 1)}role=include])
         end
-        push_include_replacement inc_lineno, (unresolved ? [ln] : []), unresolved
+        push_include_replacement directive_lineno, (unresolved ? [ln] : []), unresolved
       end
       @x_reducer.clear
       result
@@ -28,10 +26,10 @@ module Asciidoctor::Reducer
 
     def push_include data, file, path, lineno, attrs
       @x_reducer[:include_pushed] = true
-      inc_lineno = @lineno - 1 # we're below the include line, which is 1-based
+      directive_lineno = @lineno - 1 # we're below the include line, which is 1-based
       prev_inc_depth = @include_stack.size
       result = super
-      push_include_replacement inc_lineno, (@include_stack.size > prev_inc_depth ? lines : [])
+      push_include_replacement directive_lineno, (@include_stack.size > prev_inc_depth ? lines : [])
       result
     end
 
@@ -55,9 +53,8 @@ module Asciidoctor::Reducer
   end
 
   module CurrentPosition
-    attr_reader :pointer
-
     def self.extended instance
+      instance.singleton_class.send :attr_reader, :pointer
       instance.to_end
     end
 

data/lib/asciidoctor/reducer/preprocessor.rb

@@ -7,7 +7,8 @@ module Asciidoctor::Reducer
   class Preprocessor < ::Asciidoctor::Extensions::Preprocessor
     def process doc, reader
       doc.options[:preserve_conditionals] ?
-        (reader.extend IncludeDirectiveTracker) : (reader.extend ConditionalDirectiveTracker, IncludeDirectiveTracker)
+        (reader.extend IncludeDirectiveTracker) :
+        (reader.extend ConditionalDirectiveTracker, IncludeDirectiveTracker)
     end
   end
 end

data/lib/asciidoctor/reducer/tree_processor.rb

@@ -19,7 +19,7 @@ module Asciidoctor::Reducer
           end
           target_lines[idx] = lines if target_lines
         end
-        source_lines = inc_replacements[0][:lines].flatten
+        reduced_source_lines = inc_replacements[0][:lines].flatten
         if doc.sourcemap
           logger = ::Asciidoctor::LoggerManager.logger
           opts = doc.options.merge logger: nil, parse: false, reduced: true
@@ -27,13 +27,13 @@ module Asciidoctor::Reducer
             opts[:extension_registry] = ::Asciidoctor::Extensions::Registry.new ext_reg.groups
           end
           includes = doc.catalog[:includes]
-          doc = ::Asciidoctor.load source_lines, opts
+          doc = ::Asciidoctor.load reduced_source_lines, opts
           doc.catalog[:includes] = includes
           doc.parse
           ::Asciidoctor::LoggerManager.logger = logger
         else
-          source_lines.pop while (source_lines[-1] || :eof).empty?
-          doc.reader.source_lines = source_lines
+          reduced_source_lines.pop while reduced_source_lines[-1] == ''
+          doc.source_lines.replace reduced_source_lines
         end
       end
       doc

data/lib/asciidoctor/reducer/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Reducer
-    VERSION = '1.0.0-beta.1'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-reducer
 version: !ruby/object:Gem::Version
-  version: 1.0.0-beta.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-05-08 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: []