eac_tools 0.125.0 → 0.126.1

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Build
+        class Document
+          class HeaderLines
+            enable_memoized
+            enable_method_class
+            enable_settings_provider
+            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
+              docinfo_lines + [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 title_line
+              "= #{source_document.title}"
+            end
+
+            def website
+              instance.web_url
+            end
+
+            require_sub __FILE__, require_mode: :kernel
+          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, :source, :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
+          options[OPTION_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,18 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      class Deploy < ::Avm::EacWebappBase0::Instances::Deploy
+        # @return [void]
+        def build_content
+          ::Avm::EacAsciidoctorBase0::Instances::Build.new(
+            instance,
+            ::Avm::EacAsciidoctorBase0::Instances::Build::OPTION_SOURCE => source,
+            ::Avm::EacAsciidoctorBase0::Instances::Build::OPTION_TARGET_DIRECTORY => build_dir
+          ).perform
+        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

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/instances/macros/child_docs/document_builder.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        class ChildDocs < ::Avm::EacAsciidoctorBase0::Instances::Macros::Base
+          class DocumentBuilder
+            common_constructor :child_docs, :document, :depth, default: [0]
+            compare_by :title, :address
+
+            # @return [Pathname]
+            def address
+              root_document.href_to_other_body(document)
+            end
+
+            # @return [Array] Document's children mapped to document builders.
+            def children
+              document.children.map { |c| self.class.new(child_docs, c, depth + 1) }.sort
+            end
+
+            # @return [Boolean]
+            def lines_for_children?
+              child_docs.maximum_depth.negative? || child_docs.maximum_depth <= depth
+            end
+
+            # @return [String]
+            def link
+              "link:#{address}[#{title}]"
+            end
+
+            # @return [Array<String>]
+            def result
+              children.flat_map do |child|
+                r = [child.self_line]
+                r += child.result if lines_for_children?
+                r
+              end
+            end
+
+            # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document]
+            def root_document
+              child_docs.document
+            end
+
+            # @return [String]
+            def self_line
+              "#{'*' * depth} #{link}"
+            end
+
+            # @return [String]
+            def title
+              document.source_document.title
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        class ChildDocs < ::Avm::EacAsciidoctorBase0::Instances::Macros::Base
+          DEFAULT_MAXIMUM_DEPTH = -1
+
+          # @return [Array<String>]
+          def result
+            document_builder_class.new(self, document).result
+          end
+
+          # @return [Integer]
+          def maximum_depth
+            arguments[0].if_present(DEFAULT_MAXIMUM_DEPTH, &:to_i)
+          end
+
+          private
+
+          # @return [Class]
+          def document_builder_class
+            ::Avm::EacAsciidoctorBase0::Instances::Macros::ChildDocs::DocumentBuilder
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        class DefaultBody < ::Avm::EacAsciidoctorBase0::Instances::Macros::Base
+          RESULT_LINES = ['== Índice', '', '//#child_docs'].freeze
+
+          # @return [Array<String>]
+          def result
+            RESULT_LINES
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        class Todo < ::Avm::EacAsciidoctorBase0::Instances::Macros::Base
+          RESULT_LINES = ['[.todo]#TODO#'].freeze
+
+          # @return [Array<String>]
+          def result
+            RESULT_LINES
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/logging/catcher.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Logging
+      class Catcher < ::SimpleDelegator
+        CATCH_LEVEL = ::Logger::ERROR
+        LOGGER_METHODS = %i[unknown fatal error warn info debug].freeze
+
+        class << self
+          # @param [String]
+          # @return [Integer]
+          def level_by_method(method_name)
+            ::Logger.const_get(method_name.to_s.underscore.upcase)
+          end
+
+          # @return [Hash<Symbol, Integer]
+          def methods_levels
+            LOGGER_METHODS.to_h { |method_name| [method_name, level_by_method(method_name)] } # rubocop:disable Rails/IndexWith
+          end
+
+          def on
+            real_logger = ::Asciidoctor::LoggerManager.logger
+            begin
+              ::Asciidoctor::LoggerManager.logger = new(real_logger)
+              yield
+            ensure
+              ::Asciidoctor::LoggerManager.logger = real_logger
+            end
+          end
+        end
+
+        methods_levels.each do |method_name, level|
+          define_method method_name do |*args, &block|
+            __getobj__.send(method_name, *args, &block)
+            return unless level >= CATCH_LEVEL
+
+            raise ::Avm::EacAsciidoctorBase0::Logging::Error.new(level, *args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/logging/error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module Logging
+      class Error < ::RuntimeError
+        attr_reader :level
+
+        def initialize(level, *)
+          @level = level
+          super(*)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacAsciidoctorBase0
+    module SourceGenerators
+      class Base < ::Avm::SourceGenerators::Base
+        OPTIONS = {}.freeze
+
+        enable_speaker
+        enable_simple_cache
+
+        class << self
+          def option_list
+            OPTIONS.inject(super) { |a, e| a.option(*e) }
+          end
+        end
+
+        def perform
+          eac_template.apply(self, target_path)
+        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,44 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+
+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