eac_tools 0.95.0 → 0.96.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a124b9d5d4a885d3d505b8fc99ece9ff1efc29abdef44b0b26eafff061b5b744
-  data.tar.gz: b3ec5c4b38557617a6b83f72315bd7a9ef37a528694d05928cb7f778bedaa6ec
+  metadata.gz: bcddc537bf7d33465c21a75bb134a6fb57009abd8e56da74595f76c6dab41245
+  data.tar.gz: d578287e68dc31506c0739e1edfe1303f4e7f528bb7e652c011f94f13cdd2180
 SHA512:
-  metadata.gz: 76bc38b3f70c766bf0cf236518c897e0fe25fe53c6a0e80b5a020c013e5a1ee68ab722c620356ba16b308f648e71c56a330554bc35d883249a0ee0e763288d69
-  data.tar.gz: 61abdd5b8b306e7218164a2e008cb9d5be0915471fd8d1c6fa40860d9c8659f4f5875b337d7080ec47b0763ee05ef38ac24cf584424322d1b225e8bb3fcda85d
+  metadata.gz: de1053a06fd859a336b9ff5d60b116239e8ba19def9e8bf6e8ed6daaea1ef4eb3a34026c89bf4fbbb0b92efbe04e9945f3c38b709d448b7dd198f829b805a3fe
+  data.tar.gz: 7d2270c0ada7eb229c8e5a2e4e6def1130e090cced5ae6237a930a7171e0c436f344ff00b5767450ebb624699c373c99397e04b20c55d44724849bc4fe03e4a8

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    eac_tools (0.95.0)
+    eac_tools (0.96.0)
       avm (~> 0.94)
-      avm-eac_asciidoctor_base0 (~> 0.23)
+      avm-eac_asciidoctor_base0 (~> 0.24)
       avm-eac_generic_base0 (~> 0.13)
       avm-eac_github_base0 (~> 0.3)
       avm-eac_gitlab_base0 (~> 0.4)
@@ -25,14 +25,16 @@ PATH
       eac_ruby_utils (~> 0.122)
 
 PATH
-  remote: sub/avm-eac_ruby_base1
+  remote: sub/avm-eac_asciidoctor_base0
   specs:
-    avm-eac_ruby_base1 (0.35.0)
-      avm (~> 0.94)
-      avm-eac_generic_base0 (~> 0.13)
-      eac_envs-http (~> 0.5, >= 0.5.1)
+    avm-eac_asciidoctor_base0 (0.24.0)
+      asciidoctor (~> 2.0, >= 2.0.23)
+      avm-eac_webapp_base0 (~> 0.20, >= 0.20.1)
+      eac_fs (~> 0.18)
       eac_ruby_gem_support (~> 0.10)
       eac_ruby_utils (~> 0.122)
+      os (~> 1.1, >= 1.1.4)
+      rouge (~> 3.30)
 
 GEM
   remote: https://rubygems.org/
@@ -56,12 +58,6 @@ GEM
       eac_templates (~> 0.7, >= 0.7.1)
       minitar (~> 0.9)
       ruby-progressbar (~> 1.13)
-    avm-eac_asciidoctor_base0 (0.23.0)
-      asciidoctor (~> 2.0, >= 2.0.22)
-      avm-eac_webapp_base0 (~> 0.19)
-      eac_ruby_utils (~> 0.121)
-      os (~> 1.1, >= 1.1.4)
-      rouge (~> 3.30)
     avm-eac_generic_base0 (0.13.0)
       avm (~> 0.90)
       eac_ruby_utils (~> 0.121)
@@ -110,6 +106,12 @@ GEM
     avm-eac_ruby_base0 (0.1.0)
       avm-eac_ruby_base1 (~> 0.34)
       eac_ruby_utils (~> 0.122)
+    avm-eac_ruby_base1 (0.35.0)
+      avm (~> 0.94)
+      avm-eac_generic_base0 (~> 0.13)
+      eac_envs-http (~> 0.5, >= 0.5.1)
+      eac_ruby_gem_support (~> 0.10)
+      eac_ruby_utils (~> 0.122)
     avm-eac_ubuntu_base0 (0.5.1)
       avm (~> 0.86, >= 0.86.2)
       eac_ruby_utils (~> 0.121)
@@ -275,10 +277,10 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.26.1)
       rubocop (~> 1.61)
-    rubocop-rails (2.25.1)
+    rubocop-rails (2.26.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.52.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
@@ -313,7 +315,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  avm-eac_ruby_base1!
+  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.95.0'
+  VERSION = '0.96.0'
 end

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

@@ -0,0 +1,26 @@
+# 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.23'
+  s.add_dependency 'avm-eac_webapp_base0', '~> 0.20', '>= 0.20.1'
+  s.add_dependency 'eac_fs', '~> 0.18'
+  s.add_dependency 'eac_ruby_gem_support', '~> 0.10'
+  s.add_dependency 'eac_ruby_utils', '~> 0.122'
+  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 subpath = \"#{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,47 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'avm/eac_asciidoctor_base0/instances/macros'
+require 'avm/eac_asciidoctor_base0/logging/catcher'
+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
+              ::Avm::EacAsciidoctorBase0::Logging::Catcher.on do
+                body_target_write_without_logging_catch
+              end
+            end
+
+            protected
+
+            # @return [Asciidoctor::Document]
+            def body_target_write_without_logging_catch
+              ::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,92 @@
+# 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 [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,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/theme.rb

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