eac_tools 0.117.2 → 0.117.4

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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,14 @@
+# frozen_string_literal: true
+
+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,17 @@
+# frozen_string_literal: true
+
+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,10 @@
+# frozen_string_literal: true
+
+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,28 @@
+# frozen_string_literal: true
+
+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_source.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          module BodySource
+            common_concern
+
+            # @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
+
+            # @return [Enumerable<String>]
+            def default_body_source_lines
+              macro_lines(:default_body)
+            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
+
+            protected
+
+            # @return [Pathname]
+            def pre_processed_body_source_path_uncached
+              r = build.pre_processed_directory.join("#{source_document.subpath}.adoc")
+                    .assert_parent
+              r.write(pre_processed_body_source_content)
+              r
+            end
+          end
+        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,35 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+
+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_file(
+                pre_processed_body_source_path,
+                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/children.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          module Children
+            common_concern
+
+            # @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 [void]
+            def perform_children
+              children.each(&:perform)
+            end
+
+            # @return [Integer]
+            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
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+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 [Pathname]
+            def relative_path_to_stylesheet
+              build.theme.target_stylesheet_path
+                .relative_path_from(document.body_target_path.dirname)
+            end
+
+            # @return [String]
+            def stylesheet_line
+              attribute_line('stylesheet', stylesheet_path)
+            end
+
+            # @return [String]
+            def title_line
+              "= #{source_document.title}"
+            end
+
+            def website
+              instance.web_url
+            end
+
+            protected
+
+            # @return [Pathname]
+            def stylesheet_path_uncached
+              temp = ::EacRubyUtils::Fs::Temp.file
+              temp.write("@import '#{relative_path_to_stylesheet}'\n")
+              temp.to_pathname
+            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,27 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+
+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,62 @@
+# frozen_string_literal: true
+
+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,49 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+
+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 [Pathname]
+          def convert_base_dir
+            source_document.root_path
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Theme
+          TARGET_SUBPATH = '_theme'
+
+          common_constructor :build
+
+          # @return [void]
+          def perform
+            copy_theme_to_target
+          end
+
+          # @return [Pathname]
+          def target_path
+            build.target_directory.join(TARGET_SUBPATH)
+          end
+
+          # @return [Pathname]
+          def target_stylesheet_path
+            target_path
+              .join(Avm::EacAsciidoctorBase0::Sources::Base::Theme::THEME_STYLESHEET_BASENAME)
+          end
+
+          protected
+
+          # @return [void]
+          def copy_theme_to_target
+            build.source.copy_theme_directory_to(target_path)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        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
+          theme.perform
+          root_document.perform
+        end
+
+        # @return [Pathname]
+        def default_target_directory
+          source.path.join('build/site')
+        end
+
+        # @return [EacRubyUtils::Fs::ClearableDirectory]
+        def pre_processed_directory
+          ::EacRubyUtils::Fs::ClearableDirectory.new(source.path.join('build/pre_processed'))
+        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
+
+        private
+
+        # @return [Avm::EacAsciidoctorBase0::Instances::Build::Theme]
+        def theme_uncached
+          ::Avm::EacAsciidoctorBase0::Instances::Build::Theme.new(self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        class Base
+          enable_abstract_methods
+          common_constructor :document, :arguments, default: [[]]
+
+          # @return [Array<String>]
+          def result
+            raise_abstract_method __method__
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/macros/breadcrumbs.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        class Breadcrumbs < ::Avm::EacAsciidoctorBase0::Instances::Macros::Base
+          NODE_SEPARATOR = ' » '
+          ROOT_DOCUMENT_TITLE = 'Home'
+
+          # @return [Array<String>]
+          def result
+            trail_nodes.join(NODE_SEPARATOR)
+          end
+
+          def trail_nodes
+            r = []
+            current = document
+            while current.present?
+              r.unshift(Node.new(document, current))
+              current = current.parent_document
+            end
+            r
+          end
+
+          class Node
+            common_constructor :current, :document
+
+            # @return [String]
+            def address
+              current.href_to_other_body(document)
+            end
+
+            # @return [String]
+            def title
+              if document.parent_document.present?
+                document.source_document.title
+              else
+                ROOT_DOCUMENT_TITLE
+              end
+            end
+
+            # @return [String]
+            def to_s
+              "link:#{address}[#{title}]"
+            end
+          end
+        end
+      end
+    end
+  end
+end