eac_tools 0.86.12 → 0.86.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87d471c6fc124da8d27fc58453ae3bd6782de5fbe705bce665eb1cdc6e5caecc
-  data.tar.gz: dc76e1b94a0d7e1fb51c237d459ed2e2dddfbc591fa03850d6696beb40b4b1ed
+  metadata.gz: d3d31ea54c7ebbc2baa7b2d6787a953cea462707e0c10d96b783161a8c9add1e
+  data.tar.gz: f1758d006599ab52a5b51f2373af6c478d34b3bcc30b4ee4f499f75e83dc3223
 SHA512:
-  metadata.gz: 3b615dcbea89c0e7122796520cc7779184e470f36c59bc88ad23738220f7e8df2edc006b5a34fd345d4993614388f70569ffb9df0da63b705ca6415b7e3c7ac3
-  data.tar.gz: 8a96ea51c8c4da6f46a4df2382a6a398d4a46d0ccf025159c86e897d1f630602681875187827d89c7b3bdeb2ec0e6df359c29d1411a5ef57cb158b61670f9eb0
+  metadata.gz: 7052e935dfd53fe1f927e7f6c8d55ac83f60a0101d0569f03119455f5415725993a74699f8fae34aaf9ca6ec933cf69a1fa6768b3653ef1d2ddee633825a6615
+  data.tar.gz: 637de0843b89738e0bcf404060ea7807841ad50ce848c8cf4e53f638c23e010a4a86ce8c749efcbf8d6cd986a5a621563acc5d29dcda04c2d5f00e392f3f1a0d

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    eac_tools (0.86.12)
+    eac_tools (0.86.13)
       avm (~> 0.89)
-      avm-eac_asciidoctor_base0 (~> 0.22)
+      avm-eac_asciidoctor_base0 (~> 0.22, >= 0.22.1)
       avm-eac_generic_base0 (~> 0.12, >= 0.12.2)
       avm-eac_github_base0 (~> 0.3)
       avm-eac_gitlab_base0 (~> 0.4)
@@ -23,17 +23,14 @@ PATH
       eac_ruby_utils (~> 0.121)
 
 PATH
-  remote: sub/avm
+  remote: sub/avm-eac_asciidoctor_base0
   specs:
-    avm (0.89.0)
-      eac_cli (~> 0.40, >= 0.40.1)
-      eac_config (~> 0.14, >= 0.14.2)
-      eac_docker (~> 0.7)
-      eac_fs (~> 0.17)
+    avm-eac_asciidoctor_base0 (0.22.1)
+      asciidoctor (~> 2.0, >= 2.0.22)
+      avm-eac_webapp_base0 (~> 0.18, >= 0.18.4)
       eac_ruby_utils (~> 0.121)
-      eac_templates (~> 0.5, >= 0.5.1)
-      minitar (~> 0.9)
-      ruby-progressbar (~> 1.13)
+      os (~> 1.1, >= 1.1.4)
+      rouge (~> 3.30)
 
 GEM
   remote: https://rubygems.org/
@@ -55,12 +52,15 @@ GEM
       ofx-parser (~> 1.1)
     asciidoctor (2.0.22)
     ast (2.4.2)
-    avm-eac_asciidoctor_base0 (0.22.0)
-      asciidoctor (~> 2.0, >= 2.0.20)
-      avm-eac_webapp_base0 (~> 0.18, >= 0.18.3)
+    avm (0.89.0)
+      eac_cli (~> 0.40, >= 0.40.1)
+      eac_config (~> 0.14, >= 0.14.2)
+      eac_docker (~> 0.7)
+      eac_fs (~> 0.17)
       eac_ruby_utils (~> 0.121)
-      os (~> 1.1, >= 1.1.4)
-      rouge (~> 3.30)
+      eac_templates (~> 0.5, >= 0.5.1)
+      minitar (~> 0.9)
+      ruby-progressbar (~> 1.13)
     avm-eac_generic_base0 (0.12.2)
       avm (~> 0.84, >= 0.84.2)
       eac_ruby_utils (~> 0.120)
@@ -243,7 +243,7 @@ GEM
     parslet (2.0.0)
     pastel (0.8.0)
       tty-color (~> 0.5)
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
     rack (3.0.10)
     rainbow (3.1.1)
@@ -318,7 +318,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  avm!
+  avm-eac_asciidoctor_base0!
   eac_ruby_gem_support (~> 0.10)
   eac_tools!
 

data/lib/eac_tools/version.rb

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

data/sub/avm-eac_asciidoctor_base0/avm-eac_asciidoctor_base0.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'avm/eac_asciidoctor_base0/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'avm-eac_asciidoctor_base0'
+  s.version     = Avm::EacAsciidoctorBase0::VERSION
+  s.authors     = ['Put here the authors']
+  s.summary     = 'Put here de description.'
+
+  s.files = Dir['{lib,template}/**/*', 'template/avm/eac_asciidoctor_base0/instances/deploy/.keep']
+  s.required_ruby_version = '>= 2.7'
+
+  s.add_dependency 'asciidoctor', '~> 2.0', '>= 2.0.22'
+  s.add_dependency 'avm-eac_webapp_base0', '~> 0.18', '>= 0.18.4'
+  s.add_dependency 'eac_ruby_utils', '~> 0.121'
+  s.add_dependency 'os', '~> 1.1', '>= 1.1.4'
+  s.add_dependency 'rouge', '~> 3.30'
+
+  s.add_development_dependency 'eac_fs', '~> 0.16'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.9'
+end

data/sub/avm-eac_asciidoctor_base0/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/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/file_formats/base/file_resource_name.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'avm/eac_generic_base0/file_formats/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module FileFormats
+      class Base < ::Avm::EacGenericBase0::FileFormats::Base
+        class FileResourceName
+          enable_method_class
+          common_constructor :file_format, :path do
+            self.path = path.to_pathname
+          end
+
+          CONTENT_PATTERNS = [%r{content/(.+)\z}].freeze
+
+          # @param path [Pathname]
+          # @return [Avm::FileFormats::FileWith]
+          def result
+            result_from_content || file_format.result_from_superclass(path)
+          end
+
+          private
+
+          def result_from_content
+            file_format.result_from_patterns(CONTENT_PATTERNS, path) do |m|
+              r = ::File.dirname(m[1])
+              r = '' if r == '.'
+              "Content[/#{r}]"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'avm/eac_generic_base0/file_formats/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module FileFormats
+      class Base < ::Avm::EacGenericBase0::FileFormats::Base
+        require_sub __FILE__
+
+        VALID_BASENAMES = %w[*.adoc title].freeze
+        VALID_TYPES = %w[].freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'avm/eac_webapp_base0/instances/apache_host'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class ApacheHost < ::Avm::EacWebappBase0::Instances::ApacheHost
+        def document_root
+          instance.read_entry(::Avm::Instances::EntryKeys::INSTALL_PATH)
+        end
+
+        def extra_content
+          ''
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'avm/eac_webapp_base0/instances/apache_path'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class ApachePath < ::Avm::EacWebappBase0::Instances::ApachePath
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/apache_host'
+require 'avm/eac_asciidoctor_base0/instances/apache_path'
+require 'avm/eac_asciidoctor_base0/instances/deploy'
+require 'avm/eac_webapp_base0/instances/base'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Base < ::Avm::EacWebappBase0::Instances::Base
+        AUTHOR_EMAIL_ENTRY_PATH = 'install.email'
+        AUTHOR_NAME_ENTRY_PATH = 'install.name'
+        AUTHOR_NAME_INITIALS_ENTRY_PATH = 'install.name_initials'
+
+        # @return [String]
+        def author_email
+          entry(AUTHOR_EMAIL_ENTRY_PATH).value!
+        end
+
+        # @return [String]
+        def author_name
+          entry(AUTHOR_NAME_ENTRY_PATH).value!
+        end
+
+        # @return [String]
+        def author_name_initials
+          entry(AUTHOR_NAME_INITIALS_ENTRY_PATH).value!
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/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/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/build/document/header_lines.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          class HeaderLines
+            enable_method_class
+            enable_settings_provider
+            enable_simple_cache
+            common_constructor :document
+
+            delegate :build, :source_document, to: :document
+            delegate :instance, to: :build
+            delegate :author_email, :author_name, to: :instance
+
+            ATTRIBUTES = ['Author Initials', 'toc', 'icons', 'numbered', 'source-highlighter',
+                          'website'].freeze
+            TOC = 'left'
+            ICONS = ''
+            NUMBERED = ''
+            SOURCE_HIGHLIGHTER = 'rouge'
+
+            # @return [String]
+            def attribute_line(name, value)
+              [":#{name}:", value].compact_blank.join(' ')
+            end
+
+            def attributes_lines
+              ATTRIBUTES.map { |attr| attribute_line(attr, attribute_value(attr)) }
+            end
+
+            def attribute_value(attr)
+              setting_value(attr.variableize)
+            end
+
+            def author_initials
+              instance.author_name_initials
+            end
+
+            def author_line
+              "#{author_name} <#{author_email}>"
+            end
+
+            # @return [String]
+            def breadcrumbs_lines
+              ['[.normal]', document.macro_lines(:breadcrumbs)]
+            end
+
+            # @return [Array<String>]
+            def result
+              [stylesheet_line, title_line, author_line] + attributes_lines + [''] +
+                breadcrumbs_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
+
+            # @return [String]
+            def title_line
+              "= #{source_document.title}"
+            end
+
+            def website
+              instance.web_url
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          module Media
+            def copy_media_directory
+              source_document.copy_media_directory_to(media_target_path)
+            end
+
+            # @return [Pathname]
+            def media_target_path
+              build.target_directory.join(
+                parent_document.present? ? source_document.subpath : '',
+                ::Avm::EacAsciidoctorBase0::Sources::Document::Media::MEDIA_DIRECTORY_BASENAME
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          class PreProcessLine
+            enable_method_class
+            enable_simple_cache
+
+            ARGUMENT_SEPARATOR = ','
+            MACRO_PARSER = %r{\A\s*//\#(\S+)(?:\s+(.+))?\s*?\z}.to_parser do |m|
+              ::Struct.new(:name, :arguments).new(m[1],
+                                                  m[2].to_s.split(ARGUMENT_SEPARATOR).map(&:strip))
+            end
+
+            common_constructor :document, :line
+
+            # @return [Array<String>]
+            def result
+              if macro?
+                macro_value
+              else
+                [line]
+              end
+            end
+
+            def macro?
+              macro_name.present?
+            end
+
+            # @return [Array<String>, nil]
+            def macro_arguments
+              parsed_macro.if_present(&:arguments)
+            end
+
+            # @return [String, nil]
+            def macro_name
+              parsed_macro.if_present(&:name)
+            end
+
+            def macro_parser
+              MACRO_PARSER
+            end
+
+            # @return [Array<String>]
+            def macro_value
+              document.macro_lines(macro_name, macro_arguments)
+            end
+
+            private
+
+            def parsed_macro_uncached
+              macro_parser.parse(line)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# 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
+          require_sub __FILE__, include_modules: true
+
+          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]
+          def href_to_other_body(other)
+            other.body_target_path.relative_path_from(body_target_path.dirname)
+          end
+
+          # @return [Enumerable<String>]
+          def body_source_lines
+            if source_document.body_path.file?
+              source_document.body_path.read.each_line
+            else
+              default_body_source_lines
+            end
+          end
+
+          # @param basename [String]
+          # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document, nil]
+          def child(basename)
+            basename = basename.to_s
+            children.find { |c| c.source_document.root_path.basename.to_path == basename }
+          end
+
+          # @param basename [String]
+          # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document]
+          def child!(basename)
+            child(basename) || raise("Child not found with basename \"#{basename}\"")
+          end
+
+          # @return [Pathname]
+          def convert_base_dir
+            source_document.root_path
+          end
+
+          # @return [Enumerable<String>]
+          def default_body_source_lines
+            macro_lines(:default_body)
+          end
+
+          # @param name [String]
+          # @return [Array<String>]
+          def macro_lines(name, arguments = [])
+            ::Avm::EacAsciidoctorBase0::Instances::Macros.const_get(name.to_s.camelize)
+              .new(self, arguments).result
+          end
+
+          def perform
+            perform_self
+            perform_children
+          end
+
+          def perform_self
+            infov 'Building', source_document.subpath
+            body_target_write
+            copy_media_directory
+          end
+
+          def perform_children
+            children.each(&:perform)
+          end
+
+          # @return [String]
+          def pre_processed_body_source_content
+            (
+              header_lines + [''] + body_source_lines
+              .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
+
+          private
+
+          def children_uncached
+            source_document.children
+              .map { |source_child| self.class.new(build, self, source_child) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/documents_owner'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/fs/clearable_directory'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        require_sub __FILE__
+        include ::Avm::EacAsciidoctorBase0::DocumentsOwner
+        enable_speaker
+        enable_simple_cache
+        enable_listable
+        lists.add_symbol :option, :target_directory
+        common_constructor :instance, :options, default: [{}] do
+          self.options = self.class.lists.option.hash_keys_validate!(options.symbolize_keys)
+        end
+
+        SOURCE_EXTNAMES = %w[.adoc .asc].freeze
+
+        def perform
+          infov 'Documents to build', root_document.tree_documents_count
+          target_directory.clear
+          root_document.perform
+        end
+
+        def default_target_directory
+          source.path.join('build')
+        end
+
+        def root_document
+          ::Avm::EacAsciidoctorBase0::Instances::Build::Document
+            .new(self, nil, source.root_document)
+        end
+
+        # @return [Avm::EacAsciidoctorBase0::Sources::Base]
+        def source
+          instance.application.local_source
+        end
+
+        def target_directory
+          ::EacRubyUtils::Fs::ClearableDirectory.new(
+            options[OPTION_TARGET_DIRECTORY] || default_target_directory
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'avm/eac_webapp_base0/instances/deploy'
+require 'avm/eac_asciidoctor_base0/sources/base'
+require 'avm/eac_asciidoctor_base0/instances/build'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Deploy < ::Avm::EacWebappBase0::Instances::Deploy
+        def build_content
+          ::Avm::EacAsciidoctorBase0::Instances::Build.new(
+            instance,
+            ::Avm::EacAsciidoctorBase0::Instances::Build::OPTION_TARGET_DIRECTORY => build_dir
+          ).perform
+        end
+
+        private
+
+        def project_uncached
+          ::Avm::EacAsciidoctorBase0::Sources::Base.new(
+            instance.source_instance.read_entry(::Avm::Instances::EntryKeys::INSTALL_PATH)
+          )
+        end
+      end
+    end
+  end
+end