eac_tools 0.42.0 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cc7fffb0a2dc335ea8d9bb791d3aac22b783dbf2556d7812ece97708fee0be9
-  data.tar.gz: 23081d70c8762bca09ee9389b361f3b0fed45f30a09c7649f9caaf28948559f3
+  metadata.gz: b4c29f133ac7e8ea838302984ba5d8c0a947e16cc615764dae97e2b9100bd40b
+  data.tar.gz: 49926d91a7fe7fc5b3135b6910b7a8bb211a9d21bab5072a9e2a87b2f759e60c
 SHA512:
-  metadata.gz: 10510fc8717ce648a96da24ca0796ac2bc0f4b57424dc7efad470b86cd71585b3fbf8dd9df03818a6b4f2d739accc8f7758925d65f9bbfdf04dec360bf82fca4
-  data.tar.gz: 17442df47bb3b1944d1ce2a4b0b976aaf36edb54e6c13aad74655fc32295159caa5e31835a08b2853ea63b4db2f5311f6823af588ec2b649ca3d27f4a1dd0ea0
+  metadata.gz: d55a8b88951fc5b287d5f0897157129199b4d4229936e1ea31da011f66ae45a26d9a3966ae71afc595babe9da9312e5837a23c4c645702e4184bd6633d1effb3
+  data.tar.gz: b578bec6760cc52df6c9736ef4d4428f0af4460e056d3939553090b680ee7a8059ec608221867176dacacc33014c2f04434405154e4049ca9aad7125c327152b

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    eac_tools (0.42.0)
+    eac_tools (0.44.0)
       avm (~> 0.55)
-      avm-eac_asciidoctor_base0 (~> 0.10)
+      avm-eac_asciidoctor_base0 (~> 0.12)
       avm-eac_generic_base0 (~> 0.8)
       avm-eac_latex_base0 (~> 0.3)
       avm-eac_php_base0 (~> 0.3)
@@ -33,7 +33,7 @@ PATH
 PATH
   remote: sub/avm-eac_asciidoctor_base0
   specs:
-    avm-eac_asciidoctor_base0 (0.10.0)
+    avm-eac_asciidoctor_base0 (0.12.0)
       asciidoctor (~> 2.0, >= 2.0.18)
       avm-eac_webapp_base0 (~> 0.12, >= 0.12.2)
       eac_ruby_utils (~> 0.107)

data/lib/eac_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacTools
-  VERSION = '0.42.0'
+  VERSION = '0.44.0'
 end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/child_docs_macro_value.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          class ChildDocsMacroValue
+            enable_method_class
+            common_constructor :document
+
+            # @return [Array<String>]
+            def result
+              document.children.map { |child_doc| ChildDocLine.new(document, child_doc) }.sort
+                      .map(&:result)
+            end
+
+            class ChildDocLine
+              common_constructor :document, :child
+              compare_by :title, :address
+
+              # @return [Pathname]
+              def address
+                child.body_target_path.relative_path_from(
+                  document.body_target_path.dirname
+                )
+              end
+
+              # @return [String]
+              def link
+                "link:#{address}[#{title}]"
+              end
+
+              # @return [String]
+              def result
+                "* #{link}"
+              end
+
+              # @return [String]
+              def title
+                child.source_document.title
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/header_macro_value.rb

@@ -13,7 +13,7 @@ module Avm
             enable_simple_cache
             common_constructor :document
 
-            delegate :build, to: :document
+            delegate :build, :source_document, to: :document
             delegate :instance, to: :build
             delegate :author_email, :author_name, to: :instance
 
@@ -22,10 +22,13 @@ module Avm
             ICONS = ''
             NUMBERED = ''
 
+            # @return [String]
+            def attribute_line(name, value)
+              [":#{name}:", value].reject(&:blank?).join(' ')
+            end
+
             def attributes_lines
-              ATTRIBUTES.map do |attr|
-                [":#{attr}:", attribute_value(attr)].reject(&:blank?).join(' ')
-              end
+              ATTRIBUTES.map { |attr| attribute_line(attr, attribute_value(attr)) }
             end
 
             def attribute_value(attr)
@@ -40,12 +43,25 @@ module Avm
               "#{author_name} <#{author_email}>"
             end
 
+            # @return [Array<String>]
             def result
-              result_lines.join("\n")
+              [stylesheet_line, title_line, author_line] + attributes_lines
+            end
+
+            # @return [String]
+            def stylesheet_line
+              attribute_line('stylesheet', stylesheet_path)
+            end
+
+            # @return [Pathname]
+            def stylesheet_path
+              source_document.source.theme_stylesheet_path
+                             .relative_path_from(document.convert_base_dir)
             end
 
-            def result_lines
-              [author_line] + attributes_lines
+            # @return [String]
+            def title_line
+              "= #{source_document.title}"
             end
 
             def website

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/pre_process_line.rb

@@ -17,11 +17,12 @@ module Avm
 
             common_constructor :document, :line
 
+            # @return [Array<String>]
             def result
               if macro?
                 macro_value
               else
-                line
+                [line]
               end
             end
 
@@ -33,6 +34,7 @@ module Avm
               MACRO_PARSER
             end
 
+            # @return [Array<String>]
             def macro_value
               document.send("#{macro_name}_macro_value")
             end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document.rb

@@ -14,35 +14,32 @@ module Avm
 
           enable_simple_cache
           enable_speaker
-          common_constructor :build, :parent_document, :basename
-
-          # Absolute path to the Asciidoctor file.
-          #
-          # @return [Pathname]
-          def body_source_path
-            root_source_path.join(
-              ::Avm::EacAsciidoctorBase0::Sources::Base::CONTENT_DOCUMENT_BASENAME
-            )
-          end
+          common_constructor :build, :parent_document, :source_document
 
           # Absolute path to the output of Asciidoctor's source file.
           #
           # @return [Pathname]
           def body_target_path
             build.target_directory.join(
-              parent_document.present? ? subpath : ROOT_BODY_TARGET_BASENAME
+              parent_document.present? ? source_document.subpath : ROOT_BODY_TARGET_BASENAME
             ).basename_sub('.*') { |b| "#{b}.html" }
           end
 
+          # @return [Pathname]
+          def convert_base_dir
+            source_document.root_path
+          end
+
           def perform
             perform_self
             perform_children
           end
 
           def perform_self
-            infov 'Building', root_source_path
+            infov 'Building', source_document.subpath
             ::Asciidoctor.convert(
               pre_processed_body_source_content,
+              base_dir: convert_base_dir,
               to_file: body_target_path.to_path, safe: :unsafe, mkdirs: true
             )
           end
@@ -53,29 +50,20 @@ module Avm
 
           # @return [String]
           def pre_processed_body_source_content
-            body_source_path.read.each_line.map { |line| pre_process_line(line.rstrip) + "\n" }.join
+            source_document.body_path.read.each_line
+                           .flat_map { |line| pre_process_line(line.rstrip) }
+                           .map { |line| "#{line.rstrip}\n" }.join
           end
 
           def tree_documents_count
             children.inject(1) { |a, e| a + e.tree_documents_count }
           end
 
-          # Absolute path to the document's source root.
-          #
-          # @return [Pathname]
-          def root_source_path
-            build.source.content_directory.join(subpath)
-          end
-
-          def subpath
-            parent_document.if_present('.'.to_pathname) { |pd| pd.subpath.join(basename) }
-          end
-
           private
 
           def children_uncached
-            root_source_path.children.select(&:directory?)
-                            .map { |path| self.class.new(build, self, path.basename) }
+            source_document.children
+                           .map { |source_child| self.class.new(build, self, source_child) }
           end
         end
       end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build.rb

@@ -19,7 +19,7 @@ module Avm
         SOURCE_EXTNAMES = %w[.adoc .asc].freeze
 
         def perform
-          infov 'Files to build', root_document.tree_documents_count
+          infov 'Documents to build', root_document.tree_documents_count
           target_directory.clear
           root_document.perform
         end
@@ -29,7 +29,8 @@ module Avm
         end
 
         def root_document
-          ::Avm::EacAsciidoctorBase0::Instances::Build::Document.new(self, nil, nil)
+          ::Avm::EacAsciidoctorBase0::Instances::Build::Document
+            .new(self, nil, source.root_document)
         end
 
         # @return [Avm::EacAsciidoctorBase0::Sources::Base]

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/deploy.rb

@@ -10,7 +10,7 @@ module Avm
       class Deploy < ::Avm::EacWebappBase0::Instances::Deploy
         def build_content
           ::Avm::EacAsciidoctorBase0::Instances::Build.new(
-            project,
+            instance,
             ::Avm::EacAsciidoctorBase0::Instances::Build::OPTION_TARGET_DIRECTORY => build_dir
           ).perform
         end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/document/title.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      class Base
+        class Document
+          module Title
+            TITLE_BASENAME = 'title'
+
+            # @return [String]
+            def title
+              title_path.read.strip
+            end
+
+            # @return [Pathname]
+            def title_path
+              root_path.join(TITLE_BASENAME)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/document.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      class Base
+        class Document
+          enable_simple_cache
+          enable_speaker
+          require_sub __FILE__, include_modules: true
+          common_constructor :source, :parent_document, :basename
+
+          # Absolute path to the Asciidoctor file.
+          #
+          # @return [Pathname]
+          def body_path
+            root_path.join(
+              ::Avm::EacAsciidoctorBase0::Sources::Base::CONTENT_DOCUMENT_BASENAME
+            )
+          end
+
+          # Absolute path to the document's source root.
+          #
+          # @return [Pathname]
+          def root_path
+            source.content_directory.join(subpath)
+          end
+
+          # @return [Pathname]
+          def subpath
+            parent_document.if_present('.'.to_pathname) { |pd| pd.subpath.join(basename) }
+          end
+
+          private
+
+          def children_uncached
+            root_path.children.select(&:directory?)
+                     .map { |path| self.class.new(source, self, path.basename) }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/instance_to_build.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      class Base
+        class InstanceToBuild
+          AUTHOR_EMAIL = 'author@local.net'
+          AUTHOR_NAME = 'Local Author'
+          AUTHOR_NAME_INITIALS = 'L.A.'
+
+          common_constructor :source
+
+          # @return [Struct]
+          def application
+            ::Struct.new(:local_source).new(source)
+          end
+
+          # @return [String]
+          def author_email
+            AUTHOR_EMAIL
+          end
+
+          # @return [String]
+          def author_name
+            AUTHOR_NAME
+          end
+
+          # @return [String]
+          def author_name_initials
+            AUTHOR_NAME_INITIALS
+          end
+
+          # @return [String]
+          def web_url
+            "file://#{source.path.expand_path.join('build', 'index.html')}"
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/theme.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      class Base
+        module Theme
+          CONFIGURATION_THEME_KEY = 'theme'
+          DEFAULT_THEME_DIRECTORY_SUBPATH = 'theme'
+          THEME_STYLESHEET_BASENAME = 'main.css'
+
+          # @return [Pathname]
+          def default_theme_directory
+            path.join(DEFAULT_THEME_DIRECTORY_SUBPATH)
+          end
+
+          # @return [Pathname]
+          def theme_directory
+            theme_directory_by_configuration || default_theme_directory
+          end
+
+          # @return [Pathname]
+          def theme_directory_by_configuration
+            configuration_entry(CONFIGURATION_THEME_KEY).value.if_present do |v|
+              v.to_pathname.expand_path(path)
+            end
+          end
+
+          # @return [Pathname]
+          def theme_stylesheet_path
+            theme_directory.join(THEME_STYLESHEET_BASENAME)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base.rb

@@ -12,10 +12,22 @@ module Avm
         CONTENT_DOCUMENT_BASENAME = ::Pathname.new('body.adoc')
         MAIN_FILE_SUBPATH = CONTENT_DIRECTORY_SUBPATH.join(CONTENT_DOCUMENT_BASENAME)
 
+        require_sub __FILE__, include_modules: true
+
         def content_directory
           path.join(CONTENT_DIRECTORY_SUBPATH)
         end
 
+        # @return [Avm::EacAsciidoctorBase0::Sources::Base::InstanceToBuild]
+        def instance_to_build
+          ::Avm::EacAsciidoctorBase0::Sources::Base::InstanceToBuild.new(self)
+        end
+
+        # @return [Avm::EacAsciidoctorBase0::Sources::Base::Document
+        def root_document
+          ::Avm::EacAsciidoctorBase0::Sources::Base::Document.new(self, nil, nil)
+        end
+
         def valid?
           path.join(MAIN_FILE_SUBPATH).file?
         end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/build.rb

@@ -25,7 +25,7 @@ module Avm
 
           def build_uncached
             ::Avm::EacAsciidoctorBase0::Instances::Build.new(
-              runner_context.call(:source).instance,
+              runner_context.call(:source).instance_to_build,
               target_directory: parsed.target_dir
             )
           end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module EacAsciidoctorBase0
-    VERSION = '0.10.0'
+    VERSION = '0.12.0'
   end
 end

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build/document_spec_files/pre_processed_root_body.adoc

@@ -1,4 +1,5 @@
-= EacAsciidoctorBase0 Generated Source =
+:stylesheet: ../theme/main.css
+= EacAsciidoctorBase0 Generated Source
 The Author <theauthor@example.net>
 :Author Initials: T.A.
 :toc: left
@@ -6,6 +7,9 @@ The Author <theauthor@example.net>
 :numbered:
 :website: https://www.example.net
 
+== Child Documents
+
+
 == First Section
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec.rb

@@ -34,6 +34,10 @@ require 'eac_fs/comparator'
         main_document,
         target_dir.join(::Avm::EacAsciidoctorBase0::Sources::Base::CONTENT_DOCUMENT_BASENAME)
       )
+      ::FileUtils.cp(
+        source.root_document.title_path,
+        target_dir.join(::Avm::EacAsciidoctorBase0::Sources::Base::Document::TITLE_BASENAME)
+      )
     end
     instance.perform
   end

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/source_generators/base_spec_files/no_options/content/body.adoc

@@ -1,6 +1,9 @@
-= EacAsciidoctorBase0 Generated Source =
 //#header
 
+== Child Documents
+
+//#child_docs
+
 == First Section
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/source_generators/base_spec_files/no_options/content/title

@@ -0,0 +1 @@
+EacAsciidoctorBase0 Generated Source

data/sub/avm-eac_asciidoctor_base0/template/avm/eac_asciidoctor_base0/source_generators/base/content/body.adoc

@@ -1,6 +1,9 @@
-= EacAsciidoctorBase0 Generated Source =
 //#header
 
+== Child Documents
+
+//#child_docs
+
 == First Section
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.

data/sub/avm-eac_asciidoctor_base0/template/avm/eac_asciidoctor_base0/source_generators/base/content/title

@@ -0,0 +1 @@
+EacAsciidoctorBase0 Generated Source

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eac_tools
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Put here the authors
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: avm-eac_generic_base0
   requirement: !ruby/object:Gem::Requirement
@@ -307,6 +307,7 @@ files:
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/base.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document.rb
+- sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/child_docs_macro_value.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/header_macro_value.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/pre_process_line.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/deploy.rb
@@ -316,6 +317,10 @@ files:
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/source_generators/base.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base.rb
+- sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/document.rb
+- sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/document/title.rb
+- sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/instance_to_build.rb
+- sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/base/theme.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/build.rb
 - sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/version.rb
@@ -328,10 +333,14 @@ files:
 - sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/index.html
 - sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/source_generators/base_spec.rb
 - sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/source_generators/base_spec_files/no_options/content/body.adoc
+- sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/source_generators/base_spec_files/no_options/content/title
+- sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/source_generators/base_spec_files/no_options/theme/main.css
 - sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/sources/base_spec.rb
 - sub/avm-eac_asciidoctor_base0/spec/rubocop_spec.rb
 - sub/avm-eac_asciidoctor_base0/spec/spec_helper.rb
 - sub/avm-eac_asciidoctor_base0/template/avm/eac_asciidoctor_base0/source_generators/base/content/body.adoc
+- sub/avm-eac_asciidoctor_base0/template/avm/eac_asciidoctor_base0/source_generators/base/content/title
+- sub/avm-eac_asciidoctor_base0/template/avm/eac_asciidoctor_base0/source_generators/base/theme/main.css
 - sub/avm-eac_generic_base0/Gemfile
 - sub/avm-eac_generic_base0/avm-eac_generic_base0.gemspec
 - sub/avm-eac_generic_base0/lib/avm/eac_generic_base0.rb