avm-eac_asciidoctor_base0 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021fd6f878871685f09ddf9a6291e376dbfb9f0e997af81bb3c84bd18784ddbc
-  data.tar.gz: 94efd0244876163b1aed499104d478b2db2b08d02cbe9b188051f6af027ec687
+  metadata.gz: '08d54410639bf33a3d49c53953341593aef7bac0f6a084b5fa51cc24b7568db9'
+  data.tar.gz: a125b573c40d09ddd3a75fb9c62219f388ef3c5ea5b945f5ffc9071aab0de6b2
 SHA512:
-  metadata.gz: eca196f816d71af8b31d867203d625f39b37a6f12951824c0f1dc6b4e82d7b2d26fbd27726a77b73760f5fe43f43d17ddf114ee79fd47484440cce532ff705d0
-  data.tar.gz: 00c9d5370fed88552193b3c07fd11fa3f25ba730aac0592cde6cddb5dc57fef60f694d37005e73046faa7cd6d821e6bc6bdaa17e4760f75d0ee43cf52068c410
+  metadata.gz: fb225948a215039af7d9038847b6ef291de2e381c2726d18c50d8c2250f737ca71dbc559021816657d173ce319deee2882f170699ddcee6c34ab58bd5aa2401c
+  data.tar.gz: 1192b9d3c374377cadc04377bea50dda13d7dcb0915d3f34835b058eb94f4554f7aaa8eab69087cc3222dec68295aee6cb554c4175eb66b61403ef5b83d7b141

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

@@ -45,7 +45,7 @@ module Avm
 
             # @return [String]
             def breadcrumbs_lines
-              ['[.normal]', document.breadcrumbs_macro_value]
+              ['[.normal]', document.macro_lines(:breadcrumbs)]
             end
 
             # @return [Array<String>]

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

@@ -11,8 +11,10 @@ module Avm
             enable_method_class
             enable_simple_cache
 
-            MACRO_PARSER = %r{\A\s*//\#(\S+.*)}.to_parser do |m|
-              m[1]
+            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
@@ -30,18 +32,28 @@ module Avm
               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.send("#{macro_name}_macro_value")
+              document.macro_lines(macro_name, macro_arguments)
             end
 
             private
 
-            def macro_name_uncached
+            def parsed_macro_uncached
               macro_parser.parse(line)
             end
           end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'asciidoctor'
+require 'avm/eac_asciidoctor_base0/instances/macros'
 require 'eac_ruby_utils/core_ext'
 
 module Avm
@@ -22,6 +23,15 @@ module Avm
             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
+
           # Absolute path to the output of Asciidoctor's source file.
           #
           # @return [Pathname]
@@ -56,6 +66,18 @@ module Avm
             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
@@ -74,7 +96,7 @@ module Avm
           # @return [String]
           def pre_processed_body_source_content
             (
-              header_lines + [''] + source_document.body_path.read.each_line
+              header_lines + [''] + body_source_lines
               .flat_map { |line| pre_process_line(line.rstrip) }
             ).map { |line| "#{line.rstrip}\n" }.join
           end

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

@@ -8,9 +8,13 @@ module Avm
   module EacAsciidoctorBase0
     module Sources
       class Base < ::Avm::EacWebappBase0::Sources::Base
+        require_sub __FILE__
+
         CONTENT_DIRECTORY_SUBPATH = ::Pathname.new('content')
         CONTENT_DOCUMENT_BASENAME = ::Pathname.new('body.adoc')
-        MAIN_FILE_SUBPATH = CONTENT_DIRECTORY_SUBPATH.join(CONTENT_DOCUMENT_BASENAME)
+        MAIN_FILE_SUBPATH = CONTENT_DIRECTORY_SUBPATH.join(
+          ::Avm::EacAsciidoctorBase0::Sources::Base::Document::TITLE_BASENAME
+        )
 
         require_sub __FILE__, include_modules: true
 

data/lib/avm/eac_asciidoctor_base0/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module EacAsciidoctorBase0
-    VERSION = '0.18.1'
+    VERSION = '0.19.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm-eac_asciidoctor_base0
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -135,12 +135,16 @@ files:
 - lib/avm/eac_asciidoctor_base0/instances/base.rb
 - lib/avm/eac_asciidoctor_base0/instances/build.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document.rb
-- lib/avm/eac_asciidoctor_base0/instances/build/document/breadcrumbs_macro_value.rb
-- lib/avm/eac_asciidoctor_base0/instances/build/document/child_docs_macro_value.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document/header_lines.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document/media.rb
 - lib/avm/eac_asciidoctor_base0/instances/build/document/pre_process_line.rb
 - lib/avm/eac_asciidoctor_base0/instances/deploy.rb
+- lib/avm/eac_asciidoctor_base0/instances/macros.rb
+- lib/avm/eac_asciidoctor_base0/instances/macros/base.rb
+- lib/avm/eac_asciidoctor_base0/instances/macros/breadcrumbs.rb
+- lib/avm/eac_asciidoctor_base0/instances/macros/child_docs.rb
+- lib/avm/eac_asciidoctor_base0/instances/macros/child_docs/document_builder.rb
+- lib/avm/eac_asciidoctor_base0/instances/macros/default_body.rb
 - lib/avm/eac_asciidoctor_base0/source_generators.rb
 - lib/avm/eac_asciidoctor_base0/source_generators/base.rb
 - lib/avm/eac_asciidoctor_base0/sources.rb

data/lib/avm/eac_asciidoctor_base0/instances/build/document/breadcrumbs_macro_value.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module Avm
-  module EacAsciidoctorBase0
-    module Instances
-      class Build
-        class Document
-          class BreadcrumbsMacroValue
-            enable_method_class
-            common_constructor :document
-
-            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
-end

data/lib/avm/eac_asciidoctor_base0/instances/build/document/child_docs_macro_value.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module Avm
-  module EacAsciidoctorBase0
-    module Instances
-      class Build
-        class Document
-          class ChildDocsMacroValue
-            enable_method_class
-            common_constructor :document
-
-            # @return [Array<String>]
-            def result
-              document.children.map { |child_doc| ChildDocLine.new(document, child_doc) }.sort
-                      .map(&:result)
-            end
-
-            class ChildDocLine
-              common_constructor :document, :child
-              compare_by :title, :address
-
-              # @return [Pathname]
-              def address
-                document.href_to_other_body(child)
-              end
-
-              # @return [String]
-              def link
-                "link:#{address}[#{title}]"
-              end
-
-              # @return [String]
-              def result
-                "* #{link}"
-              end
-
-              # @return [String]
-              def title
-                child.source_document.title
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end