eac_tools 0.96.1 → 0.97.0

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

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/document.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      class Document
+        enable_simple_cache
+        enable_speaker
+        require_sub __FILE__, include_modules: true
+        common_constructor :source, :parent_document, :basename
+
+        # Absolute path to the Asciidoctor file.
+        #
+        # @return [Pathname]
+        def body_path
+          root_path.join(
+            ::Avm::EacAsciidoctorBase0::Sources::Base::CONTENT_DOCUMENT_BASENAME
+          )
+        end
+
+        # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document]
+        def build_document
+          source.build.document(subpath)
+        end
+
+        # Absolute path to the document's source root.
+        #
+        # @return [Pathname]
+        def root_path
+          source.content_directory.join(subpath)
+        end
+
+        # @return [Pathname]
+        def subpath
+          parent_document.if_present('.'.to_pathname) { |pd| pd.subpath.join(basename) }
+        end
+
+        # @return [String]
+        def to_s
+          subpath.to_path
+        end
+
+        private
+
+        def children_uncached
+          root_path.children.select(&:directory?)
+            .reject { |path| path.basename.to_path == MEDIA_DIRECTORY_BASENAME }
+            .map { |path| self.class.new(source, self, path.basename) }
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/build.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/build'
+require 'avm/eac_asciidoctor_base0/sources/runners/ignore_errors_option'
+require 'eac_cli/core_ext'
+require 'os'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Build
+          include ::Avm::EacAsciidoctorBase0::Sources::Runners::IgnoreErrorsOption
+
+          runner_with :help do
+            desc 'Build the project'
+            arg_opt '-d', '--target-dir', 'Directory to build'
+            bool_opt '--open', 'Show the result.'
+          end
+
+          private
+
+          # @return [Avm::EacAsciidoctorBase0::Instances::Build]
+          def build_uncached
+            source.build(target_directory: parsed.target_dir)
+          end
+
+          def default_target_directory
+            runner_context.call(:project).root.join('build')
+          end
+
+          def open
+            return unless parsed.open?
+
+            infom "Opening \"#{open_path}\"..."
+            ::EacRubyUtils::Envs.local.command(OS.open_file_command, open_path).system!
+          end
+
+          def open_path
+            build.root_document.body_target_path
+          end
+
+          # @return [void]
+          def run_without_rescue
+            start_banner
+            build.perform
+            open
+          end
+
+          def start_banner
+            runner_context.call(:source_banner)
+            infov 'Target directory', build.target_directory
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/document/build.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/sources/runners/ignore_errors_option'
+require 'os'
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Document
+          class Build
+            include ::Avm::EacAsciidoctorBase0::Sources::Runners::IgnoreErrorsOption
+
+            runner_with :help do
+              bool_opt '-O', '--open'
+            end
+
+            protected
+
+            def run_without_rescue
+              %w[build open ending].each { |p| send("run_#{p}") }
+            end
+
+            private
+
+            def build_document_uncached
+              document.build_document
+            end
+
+            def run_build
+              build_document.perform_self
+            end
+
+            def run_ending
+              success 'Done'
+            end
+
+            def run_open
+              return unless parsed.open?
+
+              infov 'Opening', build_document.body_target_path
+              ::EacRubyUtils::Envs.local.command(OS.open_file_command,
+                                                 build_document.body_target_path).system!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/document.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Document
+          runner_with :help, :subcommands do
+            pos_arg :subpath
+            subcommands
+          end
+          delegate :subpath, to: :parsed
+          for_context :document, :subpath
+
+          private
+
+          # @return [Avm::EacAsciidoctorBase0::Sources::Document]
+          # @raise [KeyError]
+          def document_uncached
+            source.document(subpath)
+          end
+
+          require_sub __FILE__
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/documents.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        class Documents
+          runner_with :help
+
+          def run
+            infov 'Documents', documents.count
+            documents.each do |document|
+              infov '  * ', document
+            end
+          end
+
+          private
+
+          def documents_uncached
+            source.documents
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0/sources/runners/ignore_errors_option.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/logging/catcher'
+require 'eac_cli/core_ext'
+
+module Avm
+  module EacAsciidoctorBase0
+    module Sources
+      module Runners
+        module IgnoreErrorsOption
+          common_concern do
+            acts_as_abstract :run_without_rescue
+
+            include ::EacCli::Runner
+            runner_definition do
+              bool_opt '-g', '--ignore-errors'
+            end
+          end
+
+          # @return [Boolean]
+          delegate :ignore_errors?, to: :parsed
+
+          # @return [void]
+          def run
+            catcher_send { run_without_rescue }
+          rescue ::Avm::EacAsciidoctorBase0::Logging::Error => e
+            fatal_error e
+          end
+
+          protected
+
+          # @return [Proc]
+          def catcher_send(&block)
+            if ignore_errors?
+              block.call
+            else
+              ::Avm::EacAsciidoctorBase0::Logging::Catcher.on(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/{avm-eac_ruby_base1/lib/avm/eac_ruby_base1 → avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0}/sources/runners.rb

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module EacRubyBase1
+  module EacAsciidoctorBase0
     module Sources
       module Runners
         require_sub __FILE__

data/sub/{avm-eac_ruby_base1/lib/avm/eac_ruby_base1 → avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0}/sources.rb

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module EacRubyBase1
+  module EacAsciidoctorBase0
     module Sources
       require_sub __FILE__
     end

data/sub/{avm-eac_ruby_base1/lib/avm/eac_ruby_base1 → avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0}/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Avm
-  module EacRubyBase1
-    VERSION = '0.35.1'
+  module EacAsciidoctorBase0
+    VERSION = '0.25.0'
   end
 end

data/sub/{avm-eac_ruby_base1/lib/avm/eac_ruby_base1.rb → avm-eac_asciidoctor_base0/lib/avm/eac_asciidoctor_base0.rb}

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module EacRubyBase1
+  module EacAsciidoctorBase0
     require_sub __FILE__
   end
 end

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/file_formats/base_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/file_formats/base'
+
+RSpec.describe Avm::EacAsciidoctorBase0::FileFormats::Base do
+  include_examples 'avm_file_format_file_resource_name', {
+    'content/title' => 'Content[/]',
+    'content/body.adoc' => 'Content[/]',
+    'content/abc/title' => 'Content[/abc]',
+    'content/abc/body.adoc' => 'Content[/abc]',
+    'content/abc/sub/body.adoc' => 'Content[/abc/sub]'
+  }
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/build'
+
+RSpec.describe Avm::EacAsciidoctorBase0::Instances::Build::Document do
+  let(:app_director) { eac_asciidoctor_base0_stubs }
+  let(:build) { Avm::EacAsciidoctorBase0::Instances::Build.new(app_director.instance) }
+  let(:fixtures_dir) { __dir__.to_pathname.join('document_spec_files') }
+  let(:instance) { build_doc_child(build.root_document, :c1, :c1_1, :c1_1_1) } # rubocop:disable Naming/VariableNumber
+  let(:target_file) { fixtures_dir.join('pre_processed_root_body.adoc') }
+  let(:source) { app_director.source }
+  let(:doc_template) do
+    r = temp_dir
+    FileUtils.copy_entry(source.root_document.root_path, r)
+    r
+  end
+  let(:pre_processed_body_source_content) do
+    sanitize_body_source(instance.pre_processed_body_source_content)
+  end
+
+  before do
+    copy_template_hash(
+      source.root_document,
+      c1: {
+        c1_1: { # rubocop:disable Naming/VariableNumber
+          c1_1_1: { # rubocop:disable Naming/VariableNumber
+            c1_1_1_1: {}, # rubocop:disable Naming/VariableNumber
+            c1_1_1_2: {} # rubocop:disable Naming/VariableNumber
+          },
+          c1_1_2: { # rubocop:disable Naming/VariableNumber
+            c1_1_2_1: {}, # rubocop:disable Naming/VariableNumber
+            c1_1_2_2: {} # rubocop:disable Naming/VariableNumber
+          }
+        }
+      },
+      c2: {
+        c2_1: {} # rubocop:disable Naming/VariableNumber
+      }
+    )
+  end
+
+  it do
+    expect(pre_processed_body_source_content).to eq(target_file.read)
+  end
+
+  # @return [Avm::EacAsciidoctorBase0::Sources::Document]
+  def copy_template_doc(parent, basename)
+    parent.assert_argument(Avm::EacAsciidoctorBase0::Sources::Document, 'parent')
+
+    root_target = parent.root_path.join(basename.to_s)
+    FileUtils.copy_entry(doc_template, root_target)
+    root_target.join('title').write(root_target.basename.to_path)
+    Avm::EacAsciidoctorBase0::Sources::Document.new(parent.source, parent,
+                                                    root_target.basename)
+  end
+
+  # @return [Array<Avm::EacAsciidoctorBase0::Sources::Document>]
+  def copy_template_hash(parent, hash)
+    parent.assert_argument(Avm::EacAsciidoctorBase0::Sources::Document, 'parent')
+    hash.assert_argument(Hash, 'hash')
+
+    hash.map do |k, v|
+      r = copy_template_doc(parent, k)
+      copy_template_hash(r, v)
+      r
+    end
+  end
+
+  # @return [Avm::EacAsciidoctorBase0::Instances::Build::Document]
+  def build_doc_child(build_doc, *path)
+    basename = path.shift.to_s
+    r = build_doc.child!(basename)
+    path.any? ? build_doc_child(r, *path) : r
+  end
+
+  # @param source [String]
+  # @return [String]
+  def sanitize_body_source(source)
+    source.gsub(/^:stylesheet:\s*.+\s*$/, ':stylesheet: ../../../../theme/main.css')
+  end
+end

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build/document_spec_files/pre_processed_root_body.adoc

@@ -0,0 +1,25 @@
+:stylesheet: ../../../../theme/main.css
+= c1_1_1
+The Author <theauthor@example.net>
+:Author Initials: T.A.
+:toc: left
+:icons:
+:numbered:
+:source-highlighter: rouge
+:website: https://www.example.net
+
+[.normal]
+link:../../../index.html[Home] » link:../../index.html[c1] » link:../index.html[c1_1] » link:index.html[c1_1_1]
+
+== Child Documents
+
+* link:c1_1_1_1/index.html[c1_1_1_1]
+* link:c1_1_1_2/index.html[c1_1_1_2]
+
+== First Section
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.
+
+== Second Section
+
+Nam faucibus quis dui at laoreet. Pellentesque ut sapien est.

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/instances/build'
+require 'eac_fs/comparator'
+
+RSpec.describe Avm::EacAsciidoctorBase0::Instances::Build do
+  let(:app_director) { eac_asciidoctor_base0_stubs }
+  let(:fs_comparator) { EacFs::Comparator.new.truncate_file('*.html') }
+  let(:instance) { described_class.new(app_director.instance) }
+
+  include_examples 'source_target_fixtures', __FILE__ do
+    def source_data(source_file)
+      FileUtils.copy_entry(source_file, app_director.source.path)
+      instance.perform
+      fs_comparator.build(instance.target_directory)
+    end
+
+    def target_data(target_file)
+      fs_comparator.build(target_file.to_pathname)
+    end
+  end
+end

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/_media/a_media_file

@@ -0,0 +1 @@
+<DATA>

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc1/_media/a_media_file

@@ -0,0 +1 @@
+<DATA>

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc1/body.adoc

@@ -0,0 +1,11 @@
+== Child Documents
+
+//#child_docs
+
+== First Section
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.
+
+== Second Section
+
+Nam faucibus quis dui at laoreet. Pellentesque ut sapien est.

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc1/title

@@ -0,0 +1 @@
+EacAsciidoctorBase0 Generated Source

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc2/body.adoc

@@ -0,0 +1,11 @@
+== Child Documents
+
+//#child_docs
+
+== First Section
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.
+
+== Second Section
+
+Nam faucibus quis dui at laoreet. Pellentesque ut sapien est.

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc2/doc2_1/_media/a_media_file

@@ -0,0 +1 @@
+<DATA>

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc2/doc2_1/body.adoc

@@ -0,0 +1,11 @@
+== Child Documents
+
+//#child_docs
+
+== First Section
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean sapien.
+
+== Second Section
+
+Nam faucibus quis dui at laoreet. Pellentesque ut sapien est.

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc2/doc2_1/title

@@ -0,0 +1 @@
+EacAsciidoctorBase0 Generated Source

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.source/content/doc2/title

@@ -0,0 +1 @@
+EacAsciidoctorBase0 Generated Source

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/_media/a_media_file

@@ -0,0 +1 @@
+<DATA>

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/_theme/main.css

@@ -0,0 +1 @@
+@import "https://darshandsoni.com/asciidoctor-skins/css/adoc-colony.css";

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/doc1/_media/a_media_file

@@ -0,0 +1 @@
+<DATA>

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/doc1/index.html

@@ -0,0 +1 @@
+__TRUNCATED__

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/doc2/doc2_1/_media/a_media_file

@@ -0,0 +1 @@
+<DATA>

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/doc2/doc2_1/index.html

@@ -0,0 +1 @@
+__TRUNCATED__

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/doc2/index.html

@@ -0,0 +1 @@
+__TRUNCATED__

data/sub/avm-eac_asciidoctor_base0/spec/lib/avm/eac_asciidoctor_base0/instances/build_spec_files/first.target/index.html

@@ -0,0 +1 @@
+__TRUNCATED__

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'avm/eac_asciidoctor_base0/source_generators/base'
+require 'avm/source_generators/runner'
+
+RSpec.describe Avm::EacAsciidoctorBase0::SourceGenerators::Base do
+  include_examples 'avm_source_generated', __FILE__, 'EacAsciidoctorBase0'
+end