eac_tools 0.99.1 → 0.101.0

data/sub/eac_ruby_gem_support/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end
+
+require 'eac_ruby_gem_support'
+EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__))

data/sub/eac_templates/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if File.exist?(local_gemfile)

data/sub/eac_templates/README.textile

@@ -0,0 +1,59 @@
+h1. E.A.C. Templates
+
+Seja a árvore fonte:
+
+<pre><code class="shell">
+./
+├── path1/
+│   ├── a_module/
+│   │   ├── a/
+│   │   │   └── a_a
+│   │   └── b
+│   ├── sub_class/
+│   │   └── a/
+│   │       └── a_c
+│   └── super_class/
+│       ├── a/
+│       │   └── a_b
+│       └── b
+└── path2/
+    ├── a_module/
+    │   ├── a/
+    │   │   └── a_b
+    │   ├── b
+    │   └── c
+    ├── prepended_module/
+    │   └── c
+    ├── sub_class/
+    │   └── b
+    └── super_class/
+        ├── a/
+        │   └── a_b
+        └── b
+</code></pre>
+
+Com caminhos de busca @./path1/@ e @./path2/@, nessa ordem. E os módulos:
+
+<pre><code class="ruby">
+module AModule; end
+
+class SuperClass
+  include AModule
+end
+
+module PrependedModule; end
+
+class SubClass < SuperClass
+  prepend PrependedModule
+end
+</code></pre>
+
+O resultado da busca deve ser:
+
+|_. Caminho buscado |_. AModule |_. SuperClass |_. PrependedModule |_. SubClass |
+|_. a | @[a_a, a_b]@ | @[a_a, a_b]@ | @[a_a, a_b]@ |  @[a_a, a_b, a_c]@ |
+|_. a/a_a | @path1/a_module/a/a_a@ | @path1/a_module/a/a_a@ | _Não encontra_ | @path1/a_module/a/a_a@  |
+|_. a/a_b | @path2/a_module/a/a_b@ | @path1/super_class/a/a_b@| _Não encontra_ | @path1/super_class/a/a_b@ |
+|_. a/a_c | _Não encontra_ | _Não encontra_  | _Não encontra_ |  @path1/a_module/a/a_c@ |
+|_. b | @path1/a_module/b@ | @path1/super_class/b@ | _Não encontra_ | @path1/sub_class/b@ |
+|_. c | @path2/a_module/c@ | @path2/a_module/c@ |@path2/prepended_module/c@ | @path2/prepended_module/c@ |

data/sub/eac_templates/eac_templates.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'eac_templates/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'eac_templates'
+  s.version     = EacTemplates::VERSION
+  s.authors     = ['Put here the authors']
+  s.summary     = 'Put here de description.'
+
+  s.files = Dir['{lib}/**/*']
+  s.required_ruby_version = '>= 2.7'
+
+  s.add_dependency 'eac_config', '~> 0.15'
+  s.add_dependency 'eac_ruby_utils', '~> 0.127'
+
+  s.add_development_dependency 'eac_fs', '~> 0.18', '>= 0.18.1'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.12'
+end

data/sub/eac_templates/lib/eac_templates/abstract/directory.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/fs_object'
+require 'eac_templates/variables/directory'
+
+module EacTemplates
+  module Abstract
+    class Directory < ::EacTemplates::Abstract::FsObject
+      enable_abstract_methods
+      delegate(*::EacTemplates::InterfaceMethods::DIRECTORY - %i[child chidren], to: :applier)
+
+      # @param basename [Pathname]
+      # @return [EacTemplates::Abstract::FsObject]
+      def build_child(child_basename, child_type)
+        child_basename = child_basename.to_pathname
+        child_type = type_list.value_validate!(child_type)
+        category_module.const_get(child_type.to_s.camelize)
+          .new(owner, self, child_basename, options)
+      end
+
+      # @param basename [Pathname]
+      # @return [EacTemplates::Abstract::FsObject]
+      def child(basename)
+        basename = basename.to_pathname
+        children.find { |c| c.basename == basename } ||
+          raise_not_found("No child found with basename \"#{basename}\" in \"#{self}\"")
+      end
+
+      # @return [Enumerable<EacTemplates::Abstract::FsObject>]
+      def children
+        children_basenames.map { |c_basename, c_type| build_child(c_basename, c_type) }
+      end
+
+      # @return [Hash<Pathname, Symbol>]
+      def children_basenames
+        raise_abstract_method __method__
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/abstract/file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/fs_object'
+require 'eac_templates/variables/file'
+
+module EacTemplates
+  module Abstract
+    class File < ::EacTemplates::Abstract::FsObject
+      enable_abstract_methods
+      delegate(*::EacTemplates::InterfaceMethods::FILE - %i[content path], to: :applier)
+
+      # @return [String]
+      def content
+        path.read
+      end
+
+      # @return [Pathname]
+      def path
+        raise_abstract_method __method__
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/abstract/fs_object.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/abstract/fs_object_by_pathname'
+require 'eac_templates/errors/not_found'
+
+module EacTemplates
+  module Abstract
+    class FsObject
+      class << self
+        # @param obj [Object]
+        # @return [EacTemplates::Abstract::FsObject, EacTemplates::Abstracts::FsObjectByPathname]
+        def assert(obj)
+          if obj.is_a?(self)
+            obj
+          else
+            ::EacTemplates::Abstract::FsObjectByPathname.new(obj)
+          end
+        end
+
+        # @param owner [Object]
+        # @param parent_object [Object, nil]
+        # @param subpath [Pathname]
+        # @return [EacTemplates::Abstract::FsObject]
+        def by_subpath(owner, parent_object, subpath, options = {})
+          r = new(owner, parent_object, nil, options)
+          subpath.if_present(::Pathname.new(''), &:to_pathname).each_filename do |basename|
+            parent_object = r
+            r = new(owner, parent_object, basename, options)
+          end
+          r
+        end
+      end
+
+      enable_abstract_methods
+      enable_simple_cache
+      enable_listable
+      lists.add_symbol :option, :source_set
+      lists.add_symbol :type, :directory, :file
+      common_constructor :owner, :parent_object, :basename, :options, default: [{}] do
+        self.basename = basename.present? ? basename.to_pathname : ::Pathname.new('')
+        self.options = ::EacTemplates::Abstract::FsObject.lists.option.hash_keys_validate!(options)
+      end
+
+      # @return [EacTemplates::Variables::Directory, EacTemplates::Variables::File]
+      def applier
+        applier_class.new(self)
+      end
+
+      # @return [Class]
+      def applier_class
+        ::EacTemplates::Variables.const_get(type.to_s.camelize)
+      end
+
+      # @return [Module]
+      def category_module
+        self.class.module_parent
+      end
+
+      # @return [Pathname]
+      def path_for_search
+        if parent_object.present?
+          parent_object.path_for_search.join(basename)
+        else
+          path_for_search_prefix.join(basename)
+        end
+      end
+
+      # @return [Pathname]
+      def path_for_search_prefix
+        raise_abstract_method __method__
+      end
+
+      def raise_not_found(message)
+        raise ::EacTemplates::Errors::NotFound, message
+      end
+
+      # @return [EacTemplates::Sources::Set]
+      def source_set
+        options[OPTION_SOURCE_SET] || ::EacTemplates::Sources::Set.default
+      end
+
+      # @return [Symbol]
+      def type
+        type_list.value_validate!(self.class.name.demodulize.underscore.to_sym)
+      end
+
+      # @return [EacRubyUtils::Listable::SymbolList]
+      def type_list
+        ::EacTemplates::Abstract::FsObject.lists.type
+      end
+
+      def to_s
+        source_set = options.if_key(:source_set, '-', &:included_paths)
+        "#{self.class}[Basename: #{basename}, Source Set: #{source_set}]"
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/abstract/fs_object_by_pathname.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+
+module EacTemplates
+  module Abstract
+    class FsObjectByPathname
+      common_constructor :path do
+        self.path = path.to_pathname
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/abstract/with_directory_file_methods.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'eac_templates/errors/not_found'
+
+module EacTemplates
+  module Abstract
+    module WithDirectoryFileMethods
+      common_concern do
+        enable_simple_cache
+      end
+
+      def build_fs_object(type)
+        fs_object_class(type).by_subpath(self, nil, subpath, source_set: source_set)
+      end
+
+      # @param child_basename [Pathname
+      # @return [Pathname]
+      def child_subpath(child_basename)
+        subpath.if_present(child_basename) { |v| v.join(child_basename) }.to_pathname
+      end
+
+      # @return [Boolean]
+      def directory?
+        directory.found?
+      end
+
+      # @return [Boolean]
+      def file?
+        file.found?
+      end
+
+      # @return [Boolean]
+      def file_template?
+        file? && file.template?
+      end
+
+      # @return [Boolean]
+      def found?
+        directory? || file?
+      end
+
+      # @param type [Symbol]
+      # @return [Class]
+      def fs_object_class(type)
+        self.class.const_get(type.to_s.camelize)
+      end
+
+      # @return [EacTemplates::Abstract::Directory, EacTemplates::Abstract::File]
+      def sub_fs_object
+        return file if file.found?
+        return directory if directory.found?
+
+        raise ::EacTemplates::Errors::NotFound, "No template found: #{self}"
+      end
+
+      # @return [String]
+      def to_s
+        v = 'NOT_FOUND'
+        v = directory.to_s if directory?
+        v = file.to_s if file?
+        "#{self.class.name}[#{v}]"
+      end
+
+      private
+
+      # @return [EacTemplates::Abstract::Directory]
+      def directory_uncached
+        build_fs_object(:directory)
+      end
+
+      # @return [EacTemplates::Abstract::File]
+      def file_uncached
+        build_fs_object(:file)
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/core_ext.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_templates/patches'
+require 'eac_templates/sources/from_all_gems'

data/sub/eac_templates/lib/eac_templates/errors/not_found.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  module Errors
+    class NotFound < ::RuntimeError
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/errors/type_mismatch.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  module Errors
+    class TypeMismatch < ::RuntimeError
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+
+module EacTemplates
+  module Errors
+    require_sub __FILE__
+  end
+end

data/sub/eac_templates/lib/eac_templates/interface_methods.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  module InterfaceMethods
+    COMMON = %i[apply path].freeze
+    ONLY_DIRECTORY = %i[child children].freeze
+    DIRECTORY = COMMON + ONLY_DIRECTORY
+    ONLY_FILE = %i[apply_to_file content variables].freeze
+    FILE = COMMON + ONLY_FILE
+    ALL = COMMON + ONLY_DIRECTORY + ONLY_FILE
+  end
+end

data/sub/eac_templates/lib/eac_templates/modules/ancestor/directory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/abstract/directory'
+require 'eac_templates/interface_methods'
+require 'eac_templates/modules/ancestor/fs_object'
+
+module EacTemplates
+  module Modules
+    class Ancestor
+      class Directory < ::EacTemplates::Abstract::Directory
+        include ::EacTemplates::Modules::Ancestor::FsObject
+        delegate :found?, :path, to: :source_object
+
+        # @return [Hash<Pathname, Symbol>]
+        def children_basenames
+          source_object.children_basenames.to_h { |k, v| parse_child_basename(k, v) }
+        end
+
+        protected
+
+        # @param basename [Pathname]
+        # @param type [Symbol]
+        # @return [Array]
+        def parse_child_basename(basename, type)
+          return [basename, type] unless type == :file
+
+          new_basename = ::EacTemplates::Modules::Ancestor::File.parse_basename(basename)
+
+          return [basename, type] if new_basename == basename
+
+          [new_basename, :file_template]
+        end
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/modules/ancestor/file.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/abstract/file'
+require 'eac_templates/interface_methods'
+require 'eac_templates/modules/ancestor/fs_object'
+
+module EacTemplates
+  module Modules
+    class Ancestor
+      class File < ::EacTemplates::Abstract::File
+        include ::EacTemplates::Modules::Ancestor::FsObject
+
+        TEMPLATE_EXTNAME_PATTERN =
+          /#{::Regexp.quote(::EacTemplates::Variables::FsObject::TEMPLATE_EXTNAME)}\z/.freeze
+
+        class << self
+          def parse_basename(basename)
+            basename.if_present do |v|
+              v.to_pathname
+                .to_path
+                .gsub(TEMPLATE_EXTNAME_PATTERN, '')
+                .to_pathname
+            end
+          end
+        end
+
+        # @return [Boolean]
+        def found?
+          source_object.found? || template?
+        end
+
+        # @return [Pathname]
+        def path
+          template? ? template_source_object.path : source_object.path
+        end
+
+        # @return [Pathname]
+        def basename
+          self.class.parse_basename(super)
+        end
+
+        # @return [Boolean]
+        def template?
+          template_source_object.found?
+        end
+
+        protected
+
+        # @return [EacTemplates::Sources::File]
+        def template_source_object_uncached
+          owner.source_set.send(type, template_source_object_path_for_search)
+        end
+
+        # @return [Pathname]
+        def template_source_object_path_for_search
+          path_for_search.basename_sub do |b|
+            "#{b}#{::EacTemplates::Variables::FsObject::TEMPLATE_EXTNAME}"
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/modules/ancestor/fs_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/interface_methods'
+
+module EacTemplates
+  module Modules
+    class Ancestor
+      module FsObject
+        # @return [Pathname]
+        delegate :path_for_search, to: :owner
+
+        # @return [String]
+        def to_s
+          "#{self.class.name}[#{path_for_search}]"
+        end
+
+        private
+
+        def source_object_uncached
+          owner.source_set.send(type, path_for_search)
+        end
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/modules/ancestor.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/with_directory_file_methods'
+
+module EacTemplates
+  module Modules
+    class Ancestor
+      include ::EacTemplates::Abstract::WithDirectoryFileMethods
+
+      class << self
+        # @param a_module [Module]
+        # @return [Pathname]
+        def path_for_search(a_module)
+          a_module.name.underscore.to_pathname
+        end
+      end
+
+      common_constructor :base, :ancestor
+      delegate :subpath, :source_set, to: :base
+      delegate(*::EacTemplates::InterfaceMethods::ALL + [:children_basenames], to: :sub_fs_object)
+
+      def ancestor_path_for_search
+        self.class.path_for_search(ancestor)
+      end
+
+      # @return [Pathname]
+      def path_for_search
+        r = ancestor_path_for_search
+        subpath.if_present(r) { |v| r.join(v) }
+      end
+
+      require_sub __FILE__
+    end
+  end
+end