avm-eac_asciidoctor_base0 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9351964d576043145fbecd87f7ec3e8284af521b5b1c8c59e0789cb4a26565a
-  data.tar.gz: 01bb632ed8c02e474d8fecf05e420a29cf2850c6a3c449a2c23d675bdb3a71b1
+  metadata.gz: eb16b5036a3115476326afa24a89bc40da17326fa76ea99f1d7df0bb021b53db
+  data.tar.gz: 4fc856b7b229420888cc496f798f0dac76681a339a9feaa319eab6759bf38be4
 SHA512:
-  metadata.gz: 7f71b5da7a78cb72738d08748f7a15eac3bda6998d9b2ed8bb6248a28cbaeda8b862bb4924f05e2a419cfa54affd0a7d76f3da773e2e18b4fd1562abd1f39f8d
-  data.tar.gz: e1ac34e3cc668e5e1c0379f1129e7e01e8a6df58dd1f54d7ab2194f40ae43f5bef14985236c41d0dd02573b8aa050177e8b2b257d9a24ab5521d16b88205b272
+  metadata.gz: 90988a7ba168f8a781121a46721eb798b5bb6429b04a0e58da80c97d48ebf4e6b8b0fbdc83d67cf993899da5bb0ac1eb20904f4098751ea019f112096997cc8e
+  data.tar.gz: 578fc517e677e5460815d7cb03eca55ab438158060aa17508d1751d180378dabf009de46aaf3db1637d796732995ba565acdc80404e09708fbf68016957f0b70

data/lib/avm/eac_asciidoctor_base0/documents_owner.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/recursive_builder'
+
+module Avm
+  module EacAsciidoctorBase0
+    module DocumentsOwner
+      common_concern
+
+      # @param subpath [Pathname]
+      # @return [Avm::EacAsciidoctorBase0::Sources::Document]
+      # @raise [KeyError]
+      def document(subpath)
+        documents.find { |d| d.subpath.to_pathname == subpath.to_pathname } ||
+          raise(::KeyError, "Document not found with subáth = \"#{subpath}\"")
+      end
+
+      # @return [Enumerable<Avm::EacAsciidoctorBase0::Sources::Document>]
+      def documents
+        ::EacRubyUtils::RecursiveBuilder.new(root_document, &:children).result
+      end
+
+      # @return [Object]
+      def root_document
+        raise "Abstract method hit: #{__method__}"
+      end
+    end
+  end
+end

data/lib/avm/eac_asciidoctor_base0/instances/build/document/body_target.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'avm/eac_asciidoctor_base0/instances/macros'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          module BodyTarget
+            common_concern
+
+            BODY_TARGET_BASENAME = 'index.html'
+
+            # Absolute path to the output of Asciidoctor's source file.
+            #
+            # @return [Pathname]
+            def body_target_path
+              build.target_directory.join(source_document.subpath).join(BODY_TARGET_BASENAME)
+            end
+
+            # @return [Asciidoctor::Document]
+            def body_target_write
+              ::Asciidoctor.convert(
+                pre_processed_body_source_content,
+                base_dir: convert_base_dir,
+                to_file: body_target_path.to_path, safe: :unsafe, mkdirs: true
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_asciidoctor_base0/instances/build/document/media.rb

@@ -17,7 +17,7 @@ module Avm
             def media_target_path
               build.target_directory.join(
                 parent_document.present? ? source_document.subpath : '',
-                ::Avm::EacAsciidoctorBase0::Sources::Base::Document::Media::MEDIA_DIRECTORY_BASENAME
+                ::Avm::EacAsciidoctorBase0::Sources::Document::Media::MEDIA_DIRECTORY_BASENAME
               )
             end
           end

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

@@ -11,11 +11,10 @@ module Avm
         class Document
           require_sub __FILE__, include_modules: true
 
-          BODY_TARGET_BASENAME = 'index.html'
-
           enable_simple_cache
           enable_speaker
           common_constructor :build, :parent_document, :source_document
+          delegate :subpath, to: :source_document
 
           # @param other [Avm::EacAsciidoctorBase0::Instances::Build::Document]
           # @return [String]
@@ -32,22 +31,6 @@ module Avm
             end
           end
 
-          # Absolute path to the output of Asciidoctor's source file.
-          #
-          # @return [Pathname]
-          def body_target_path
-            build.target_directory.join(source_document.subpath).join(BODY_TARGET_BASENAME)
-          end
-
-          # @return [Asciidoctor::Document]
-          def build_body
-            ::Asciidoctor.convert(
-              pre_processed_body_source_content,
-              base_dir: convert_base_dir,
-              to_file: body_target_path.to_path, safe: :unsafe, mkdirs: true
-            )
-          end
-
           # @param basename [String]
           # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document, nil]
           def child(basename)
@@ -85,7 +68,7 @@ module Avm
 
           def perform_self
             infov 'Building', source_document.subpath
-            build_body
+            body_target_write
             copy_media_directory
           end
 

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'avm/eac_asciidoctor_base0/documents_owner'
 require 'eac_ruby_utils/core_ext'
 require 'eac_ruby_utils/fs/clearable_directory'
 
@@ -8,6 +9,7 @@ module Avm
     module Instances
       class Build
         require_sub __FILE__
+        include ::Avm::EacAsciidoctorBase0::DocumentsOwner
         enable_speaker
         enable_simple_cache
         enable_listable

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

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'avm/eac_webapp_base0/sources/base'
+require 'avm/eac_asciidoctor_base0/documents_owner'
+require 'avm/eac_asciidoctor_base0/instances/build'
+require 'avm/eac_asciidoctor_base0/sources/document'
 require 'avm/eac_asciidoctor_base0/sources/runners'
 require 'eac_ruby_utils/core_ext'
 
@@ -9,13 +12,20 @@ module Avm
     module Sources
       class Base < ::Avm::EacWebappBase0::Sources::Base
         require_sub __FILE__, include_modules: true
+        include ::Avm::EacAsciidoctorBase0::DocumentsOwner
 
         CONTENT_DIRECTORY_SUBPATH = ::Pathname.new('content')
         CONTENT_DOCUMENT_BASENAME = ::Pathname.new('body.adoc')
         MAIN_FILE_SUBPATH = CONTENT_DIRECTORY_SUBPATH.join(
-          ::Avm::EacAsciidoctorBase0::Sources::Base::Document::TITLE_BASENAME
+          ::Avm::EacAsciidoctorBase0::Sources::Document::TITLE_BASENAME
         )
 
+        # @param options [Hash]
+        # @return [Avm::EacAsciidoctorBase0::Instances::Build]
+        def build(options = {})
+          ::Avm::EacAsciidoctorBase0::Instances::Build.new(instance_to_build, options)
+        end
+
         def content_directory
           path.join(CONTENT_DIRECTORY_SUBPATH)
         end
@@ -25,9 +35,9 @@ module Avm
           ::Avm::EacAsciidoctorBase0::Sources::Base::InstanceToBuild.new(self)
         end
 
-        # @return [Avm::EacAsciidoctorBase0::Sources::Base::Document
+        # @return [Avm::EacAsciidoctorBase0::Sources::Document
         def root_document
-          ::Avm::EacAsciidoctorBase0::Sources::Base::Document.new(self, nil, nil)
+          ::Avm::EacAsciidoctorBase0::Sources::Document.new(self, nil, nil)
         end
 
         def valid?

data/lib/avm/eac_asciidoctor_base0/sources/document/media.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      class Document
+        module Media
+          MEDIA_DIRECTORY_BASENAME = '_media'
+
+          def copy_media_directory_to(target_directory_path)
+            return unless media_directory.directory?
+
+            target_directory_path.parent.mkpath
+            ::FileUtils.copy_entry(media_directory, target_directory_path)
+          end
+
+          # @return [Pathname]
+          def media_directory
+            root_path.join(MEDIA_DIRECTORY_BASENAME)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_asciidoctor_base0/sources/document/title.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      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

data/lib/avm/eac_asciidoctor_base0/sources/document.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      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
+
+        # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document]
+        def build_document
+          source.build.document(subpath)
+        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
+
+        # @return [String]
+        def to_s
+          subpath.to_path
+        end
+
+        private
+
+        def children_uncached
+          root_path.children.select(&:directory?)
+            .reject { |path| path.basename.to_path == MEDIA_DIRECTORY_BASENAME }
+            .map { |path| self.class.new(source, self, path.basename) }
+        end
+      end
+    end
+  end
+end

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

@@ -23,11 +23,9 @@ module Avm
 
           private
 
+          # @return [Avm::EacAsciidoctorBase0::Instances::Build]
           def build_uncached
-            ::Avm::EacAsciidoctorBase0::Instances::Build.new(
-              runner_context.call(:source).instance_to_build,
-              target_directory: parsed.target_dir
-            )
+            source.build(target_directory: parsed.target_dir)
           end
 
           def default_target_directory

data/lib/avm/eac_asciidoctor_base0/sources/runners/document/build.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'os'
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Document
+          class Build
+            runner_with :help do
+              bool_opt '-O', '--open'
+            end
+
+            def run
+              %w[build open ending].each { |p| send("run_#{p}") }
+            end
+
+            private
+
+            def build_document_uncached
+              document.build_document
+            end
+
+            def run_build
+              build_document.perform_self
+            end
+
+            def run_ending
+              success 'Done'
+            end
+
+            def run_open
+              return unless parsed.open?
+
+              infov 'Opening', build_document.body_target_path
+              ::EacRubyUtils::Envs.local.command(OS.open_file_command,
+                                                 build_document.body_target_path).system!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_asciidoctor_base0/sources/runners/document.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Document
+          runner_with :help, :subcommands do
+            pos_arg :subpath
+            subcommands
+          end
+          delegate :subpath, to: :parsed
+          for_context :document, :subpath
+
+          private
+
+          # @return [Avm::EacAsciidoctorBase0::Sources::Document]
+          # @raise [KeyError]
+          def document_uncached
+            source.document(subpath)
+          end
+
+          require_sub __FILE__
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_asciidoctor_base0/sources/runners/documents.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Documents
+          runner_with :help
+
+          def run
+            infov 'Documents', documents.count
+            documents.each do |document|
+              infov '  * ', document
+            end
+          end
+
+          private
+
+          def documents_uncached
+            source.documents
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_asciidoctor_base0/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module EacAsciidoctorBase0
-    VERSION = '0.20.0'
+    VERSION = '0.21.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm-eac_asciidoctor_base0
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-19 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -56,20 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.119'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.119.2
+        version: '0.120'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.119'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.119.2
+        version: '0.120'
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +133,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/avm/eac_asciidoctor_base0.rb
+- lib/avm/eac_asciidoctor_base0/documents_owner.rb
 - lib/avm/eac_asciidoctor_base0/file_formats/base.rb
 - lib/avm/eac_asciidoctor_base0/file_formats/base/file_resource_name.rb
 - lib/avm/eac_asciidoctor_base0/instances.rb
@@ -147,6 +142,7 @@ files:
 - lib/avm/eac_asciidoctor_base0/instances/base.rb
 - lib/avm/eac_asciidoctor_base0/instances/build.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document.rb
+- lib/avm/eac_asciidoctor_base0/instances/build/document/body_target.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document/header_lines.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document/media.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document/pre_process_line.rb
@@ -161,13 +157,16 @@ files:
 - lib/avm/eac_asciidoctor_base0/source_generators/base.rb
 - lib/avm/eac_asciidoctor_base0/sources.rb
 - lib/avm/eac_asciidoctor_base0/sources/base.rb
-- lib/avm/eac_asciidoctor_base0/sources/base/document.rb
-- lib/avm/eac_asciidoctor_base0/sources/base/document/media.rb
-- lib/avm/eac_asciidoctor_base0/sources/base/document/title.rb
 - lib/avm/eac_asciidoctor_base0/sources/base/instance_to_build.rb
 - lib/avm/eac_asciidoctor_base0/sources/base/theme.rb
+- lib/avm/eac_asciidoctor_base0/sources/document.rb
+- lib/avm/eac_asciidoctor_base0/sources/document/media.rb
+- lib/avm/eac_asciidoctor_base0/sources/document/title.rb
 - lib/avm/eac_asciidoctor_base0/sources/runners.rb
 - lib/avm/eac_asciidoctor_base0/sources/runners/build.rb
+- lib/avm/eac_asciidoctor_base0/sources/runners/document.rb
+- lib/avm/eac_asciidoctor_base0/sources/runners/document/build.rb
+- lib/avm/eac_asciidoctor_base0/sources/runners/documents.rb
 - lib/avm/eac_asciidoctor_base0/version.rb
 - template/avm/eac_asciidoctor_base0/source_generators/base/content/body.adoc
 - template/avm/eac_asciidoctor_base0/source_generators/base/content/title

data/lib/avm/eac_asciidoctor_base0/sources/base/document/media.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'asciidoctor'
-require 'eac_ruby_utils/core_ext'
-
-module Avm
-  module EacAsciidoctorBase0
-    module Sources
-      class Base
-        class Document
-          module Media
-            MEDIA_DIRECTORY_BASENAME = '_media'
-
-            def copy_media_directory_to(target_directory_path)
-              return unless media_directory.directory?
-
-              target_directory_path.parent.mkpath
-              ::FileUtils.copy_entry(media_directory, target_directory_path)
-            end
-
-            # @return [Pathname]
-            def media_directory
-              root_path.join(MEDIA_DIRECTORY_BASENAME)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# 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/lib/avm/eac_asciidoctor_base0/sources/base/document.rb

@@ -1,48 +0,0 @@
-# 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?)
-              .reject { |path| path.basename.to_path == MEDIA_DIRECTORY_BASENAME }
-              .map { |path| self.class.new(source, self, path.basename) }
-          end
-        end
-      end
-    end
-  end
-end