eac_tools 0.86.12 → 0.87.0

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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+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,55 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/macros/base'
+require 'eac_ruby_utils/core_ext'
+
+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,63 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/macros/base'
+require 'eac_ruby_utils/core_ext'
+
+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,35 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/macros/base'
+require 'eac_ruby_utils/core_ext'
+
+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
+
+          require_sub __FILE__
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/macros/base'
+require 'eac_ruby_utils/core_ext'
+
+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.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      module Macros
+        require_sub __FILE__
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Instances
+      require_sub __FILE__
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'avm/source_generators/base'
+require 'eac_templates/core_ext'
+require 'eac_ruby_utils/core_ext'
+
+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
+          template.apply(self, target_path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module SourceGenerators
+      require_sub __FILE__
+    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

@@ -0,0 +1,49 @@
+# 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'
+
+module Avm
+  module EacAsciidoctorBase0
+    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::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
+
+        # @return [Avm::EacAsciidoctorBase0::Sources::Base::InstanceToBuild]
+        def instance_to_build
+          ::Avm::EacAsciidoctorBase0::Sources::Base::InstanceToBuild.new(self)
+        end
+
+        # @return [Avm::EacAsciidoctorBase0::Sources::Document
+        def root_document
+          ::Avm::EacAsciidoctorBase0::Sources::Document.new(self, nil, nil)
+        end
+
+        def valid?
+          path.join(MAIN_FILE_SUBPATH).file?
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/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/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/document/title.rb

@@ -0,0 +1,31 @@
+# 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 default_title
+            root_path.basename.to_s.humanize.split(/\s+/).map(&:upcase_first).join(' ')
+          end
+
+          # @return [String]
+          def title
+            title_path.exist? ? title_path.read.strip : default_title
+          end
+
+          # @return [Pathname]
+          def title_path
+            root_path.join(TITLE_BASENAME)
+          end
+        end
+      end
+    end
+  end
+end