eac_tools 0.115.0 → 0.116.0

data/sub/avm/lib/avm/registry.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Avm
+  module Registry
+    enable_listable
+    lists.add_symbol :category, :applications, :application_scms, :application_stereotypes,
+                     :config_objects, :file_formats, :instances, :launcher_stereotypes, :runners,
+                     :scms, :source_generators, :sources
+
+    class << self
+      enable_simple_cache
+
+      # @return [Array<Avm::Registry::FromGems>]
+      def registries
+        lists.category.values.map { |c| send(c) }
+      end
+
+      private
+
+      ::Avm::Registry.lists.category.each_value do |category|
+        define_method "#{category}_uncached" do
+          registry_class(category).new(category.to_s.camelize)
+        end
+      end
+
+      def registry_class(category)
+        ::Avm::Registry.const_get(category.to_s.camelize)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/result.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'colorized_string'
+
+module Avm
+  class Result < ::SimpleDelegator
+    include ::EacRubyUtils::Listable
+
+    lists.add_string :type, :success, :error, :neutral, :pending, :outdated
+
+    lists.type.values.each do |type| # rubocop:disable Style/HashEachMethods
+      singleton_class.define_method type do |value|
+        new(value, type)
+      end
+    end
+
+    TYPE_SUCCESS_COLOR = 'green'
+    TYPE_ERROR_COLOR = 'red'
+    TYPE_NEUTRAL_COLOR = 'light_black'
+    TYPE_PENDING_COLOR = 'yellow'
+    TYPE_OUTDATED_COLOR = 'blue'
+
+    class << self
+      # Return Avm::Result.success(success_value) if +success+ is truthy.
+      # Return Avm::Result.error(error_value || success_value) if +success+ is falsely.
+      # @return [Avm::Result]
+      def success_or_error(success, success_value, error_value = nil)
+        if success
+          self.success(success_value)
+        else
+          error(error_value.presence || success_value)
+        end
+      end
+    end
+
+    attr_reader :type
+
+    def initialize(value, type)
+      super(value)
+      validate_type(type)
+      @type = type
+    end
+
+    def label
+      label_fg
+    end
+
+    def label_fg
+      ColorizedString.new(to_s).send(type_color)
+    end
+
+    def label_bg
+      ColorizedString.new(to_s).light_white.send("on_#{type_color}")
+    end
+
+    def type_color
+      self.class.const_get("type_#{type}_color".upcase)
+    end
+
+    lists.type.values.each do |type| # rubocop:disable Style/HashEachMethods
+      define_method "#{type}?" do
+        @type == type
+      end
+    end
+
+    private
+
+    def validate_type(type)
+      return if self.class.lists.type.values.include?(type)
+
+      raise "Tipo desconhecido: \"#{type}\" (Válido: #{self.class.lists.type.values.join(', ')})"
+    end
+
+    class Error < StandardError
+      def to_result
+        ::Avm::Result.error(message)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/launcher_controller.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'ruby-progressbar'
+require 'tmpdir'
+
+module Avm
+  module Rspec
+    class LauncherController
+      attr_accessor :remotes_dir
+
+      # @param application_id [String]
+      # @param path [Pathname]
+      # @return void
+      def application_source_path(application_id, path)
+        EacConfig::Node.context.current.entry("#{application_id}_dev.install.path").value =
+          path.to_pathname.to_path
+      end
+
+      # @param repos [Avm::Git::Launcher::Base]
+      # @param subpath [String]
+      # @param content [String]
+      def commit_file(repos, subpath, content)
+        require 'fileutils'
+        repos.subpath(subpath).then do |file_path|
+          FileUtils.mkdir_p(File.dirname(file_path))
+          ::File.write(file_path, content)
+          repos.execute!('add', file_path)
+          repos.execute!('commit', '-m', subpath)
+        end
+      end
+
+      # @param settings_path [Pathname]
+      # @param projects_root [Pathname]
+      def context_set(settings_path, projects_root)
+        Avm::Launcher::Context.current = Avm::Launcher::Context.new(
+          settings_file: settings_path.to_pathname.to_path,
+          cache_root: Dir.mktmpdir
+        )
+        self.projects_root = projects_root
+      end
+
+      # @return [Pathname]
+      def default_settings_path
+        templates_directory.join('settings.yml')
+      end
+
+      # @return [Pathname]
+      def dummy_directory
+        templates_directory.join('dummy')
+      end
+
+      # @param settings_path [Pathname]
+      def temp_context(settings_path)
+        context_set(settings_path, Dir.mktmpdir)
+      end
+
+      def init_remote(name)
+        r = Avm::Git::Launcher::Base.new(File.join(remotes_dir, name))
+        r.init_bare
+        r
+      end
+
+      def init_git(subdir)
+        r = Avm::Git::Launcher::Base.new(File.join(projects_root, subdir))
+        r.git
+        r.execute!('config', 'user.email', 'theuser@example.net')
+        r.execute!('config', 'user.name', 'The User')
+        r
+      end
+
+      # @return [Avm::Launcher::Context]
+      def new_context
+        Avm::Launcher::Context.new(
+          settings_file: default_settings_path,
+          cache_root: Dir.mktmpdir
+        )
+      end
+
+      # @param path [String]
+      def projects_root
+        @projects_root ||= Dir.mktmpdir
+      end
+
+      # @param path [Pathname]
+      def projects_root=(path)
+        @projects_root = path.to_pathname.to_path
+      end
+
+      # @return [Pathname]
+      def templates_directory
+        '../../../template/avm/rspec/launcher_controller'.to_pathname.expand_path(__dir__)
+      end
+
+      # @param repos [Avm::Git::Launcher::Base]
+      # @param subpath [String]
+      def touch_commit(repos, subpath)
+        commit_file(repos, subpath, '')
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup/launcher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+
+module Avm
+  module Rspec
+    module Setup
+      module Launcher
+        def temp_launcher_context(settings_file = nil)
+          settings_file ||= temp_file
+          ::Avm::Launcher::Context.current = ::Avm::Launcher::Context.new(
+            projects_root: ::Dir.mktmpdir, settings_file: settings_file, cache_root: ::Dir.mktmpdir
+          )
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup/source_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Avm
+  module Rspec
+    module Setup
+      module SourceGenerator
+        DEFAULT_TARGET_BASENAME = 'generated_app'
+
+        # @return [Avm::Sources::Base]
+        def avm_source(stereotype_name, options = {})
+          options = options.dup
+          target_basename ||= options.delete(:target_basename) || DEFAULT_TARGET_BASENAME
+          target_path ||= options.delete(:target_path) || temp_dir.join(target_basename)
+          ::Avm::Registry.source_generators.detect(stereotype_name, target_path, options).perform
+          ::Avm::Registry.sources.detect(target_path)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Avm
+  module Rspec
+    module Setup
+      EXAMPLES = %w[avm_file_formats_with_fixtures avm_file_format_file_resource_name
+                    avm_source_generated entries_values in_avm_registry not_in_avm_registry
+                    with_config with_launcher].freeze
+
+      def self.extended(obj)
+        obj.setup_examples
+        obj.rspec_config.include(::Avm::Rspec::Setup::Launcher)
+        obj.rspec_config.include(::Avm::Rspec::Setup::SourceGenerator)
+      end
+
+      def setup_examples
+        EXAMPLES.each do |example|
+          require "avm/rspec/shared_examples/#{example}"
+        end
+      end
+
+      # @return [self]
+      def stub_avm_contexts
+        stub_eac_config_node
+        stub_eac_fs_contexts
+        stub_eac_speaker
+
+        self
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/avm_file_format_file_resource_name.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'avm_file_format_file_resource_name' do |input_expected|
+  describe '#file_resource_name' do
+    input_expected.each do |path, expected_resource_name|
+      context "when path is \"#{path}\"" do
+        let(:instance) { described_class.new }
+
+        it { expect(instance.file_resource_name(path)).to eq(expected_resource_name) }
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/avm_file_formats_with_fixtures.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'avm_file_formats_with_fixtures' do |the_spec_file|
+  include_examples 'source_target_fixtures', the_spec_file
+
+  def format_files_in_directory(target_dir)
+    Avm::FileFormats::SearchFormatter
+      .new([target_dir], recursive: true, apply: true, verbose: false)
+      .run
+  end
+
+  def source_data(source_file)
+    dir = temp_dir
+    source_basename = source_file_basename_without_source_extname(source_file)
+    source_path = dir.join(source_basename)
+    FileUtils.cp(source_file, source_path)
+    format_files_in_directory(dir)
+    source_path.read
+  end
+
+  def source_file_basename_without_source_extname(source_file)
+    source_file.to_pathname.basename_sub { |b| b.to_path.gsub('.source', '') }.basename
+  end
+
+  def target_data(target_file)
+    File.read(target_file)
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/avm_source_generated.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'avm_source_generated' do |spec_file, stereotype, options = {}|
+  include_context 'spec_paths', spec_file
+  block_on_each_source = options.delete(:block_on_each_source)
+
+  spec_paths_controller.fixtures_directory.children.select(&:directory?).each do |target_dir|
+    context "when target is \"#{target_dir.basename}\"" do
+      let(:source) { avm_source(stereotype, options.merge(target_basename: target_dir.basename)) }
+
+      it do
+        if ENV['WRITE_TARGET_FIXTURES'].to_bool
+          FileUtils.rm_rf(target_dir)
+          FileUtils.cp_r(source.path, target_dir)
+        end
+        expect(fs_comparator.build(source.path)).to eq(fs_comparator.build(target_dir))
+      end
+
+      instance_exec(&block_on_each_source) if block_on_each_source
+    end
+  end
+
+  # @return [EacFs::Comparato]
+  def fs_comparator
+    EacFs::Comparator.new.rename_file('.gitignore', '_gitignore')
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/entries_values.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'entries_values' do |spec_file, expected_values|
+  describe '#read_entry' do
+    include_examples 'with_config', spec_file
+
+    expected_values.each do |instance_id, values|
+      values.each do |input, expected|
+        context "when a auto value is requested for \"#{instance_id}.#{input}\"" do
+          let(:instance) { described_class.by_id(instance_id) }
+
+          it ".entry('#{input}').value should return \"#{expected}\"" do
+            expect(instance.entry(input).value).to eq(expected)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/in_avm_registry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'in_avm_registry' do |registry_method|
+  let(:avm_registry) { Avm::Registry.send(registry_method) }
+
+  it 'is in the avm registry' do
+    expect(avm_registry.registered_modules).to include(described_class)
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/not_in_avm_registry.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'not_in_avm_registry' do |registry_method = nil|
+  registry_method.if_present(Avm::Registry.registries) { |v| [Avm::Registry.send(v)] }
+    .each do |registry|
+    context "when registry is #{registry}" do
+      it 'is not in the avm registry' do
+        expect(registry.available).not_to include(described_class)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/with_config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'with_config' do |spec_file|
+  config_path = spec_file.to_pathname
+  config_path = config_path.dirname.join("#{config_path.basename_noext}_files", 'config.yml')
+  temp_config_path = EacRubyUtils::Fs::Temp.file
+  FileUtils.cp(config_path, temp_config_path)
+  EacRubyUtils::Rspec.default_setup.stub_eac_config_node(self, temp_config_path)
+end

data/sub/avm/lib/avm/rspec/shared_examples/with_launcher.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'with_launcher' do
+  let(:launcher_controller) { Avm::Rspec::LauncherController.new }
+
+  before do
+    Avm::Launcher::Context.current = launcher_controller.new_context
+    launcher_controller.remotes_dir = temp_dir
+  end
+
+  delegate :application_source_path, :commit_file, :context_set, :init_git, :init_remote,
+           :temp_context, :projects_root, :projects_root=, :touch_commit, to: :launcher_controller
+end

data/sub/avm/lib/avm/runner_with/file_replacer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Avm
+  module RunnerWith
+    module FileReplacer
+      common_concern do
+        include ::Avm::RunnerWith::FilesystemTraverser
+        include TopMethods
+      end
+
+      module TopMethods
+        def text_replacer
+          ::Avm::Files::TextReplacer.new
+        end
+
+        def replace_file?(_file)
+          true
+        end
+
+        def traverser_check_file(file)
+          return unless replace_file?(file)
+
+          infov 'Changed', file if text_replacer.file_apply(file)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/runner_with/filesystem_renamer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Avm
+  module RunnerWith
+    module FilesystemRenamer
+      common_concern do
+        runner_with :confirmation, :filesystem_traverser
+        prepend PrependMethods
+      end
+
+      class RenameFile
+        enable_speaker
+        common_constructor :runner, :file
+        delegate :path, :target_path, :valid?, to: :file
+
+        CONFIRM_MESSAGE = 'Rename?'
+
+        def show
+          if rename?
+            puts [target_path_to_s, '<='.green, path_to_s].join(' ')
+          else
+            puts path_to_s
+          end
+        end
+
+        def rename
+          return unless rename?
+
+          show
+          do_rename if runner.confirm?(CONFIRM_MESSAGE)
+        end
+
+        # @return [Boolean]
+        def rename?
+          path.to_pathname != target_path.to_pathname
+        end
+
+        private
+
+        def do_rename
+          ::FileUtils.mv(path, target_path)
+        end
+
+        # @return [String]
+        def path_to_s
+          path.basename.to_path.light_black
+        end
+
+        # @return [String]
+        def target_path_to_s
+          target_path.relative_path_from(path.dirname).to_path
+        end
+      end
+
+      module PrependMethods
+        # @param path [Pathname]
+        # @return [void]
+        def traverser_check_file(path)
+          file = RenameFile.new(self, file_class.new(path))
+          files << file if file.valid?
+        end
+      end
+
+      FILE_WRAPPER_CLASS_BASENAME = 'FileWrapper'
+
+      # @return [Class]
+      def file_class
+        self.class.const_get(FILE_WRAPPER_CLASS_BASENAME)
+      end
+
+      # @return [void]
+      def run_filesystem_renamer
+        self.files = []
+        run_filesystem_traverser
+        show_files
+        rename_files
+        success 'Done'
+      end
+
+      # @return [void]
+      def show_files
+        infov 'Files found', files.count
+        files.each(&:show)
+      end
+
+      # @return [void]
+      def rename_files
+        return if parsed.no? || files.none?(&:rename?)
+
+        infom 'Renaming files...'
+        files.each(&:rename)
+      end
+
+      private
+
+      attr_accessor :files
+    end
+  end
+end

data/sub/avm/lib/avm/runner_with/filesystem_traverser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Avm
+  module RunnerWith
+    module FilesystemTraverser
+      DEFAULT_DEFAULT_TRAVERSER_RECURSIVE = false
+
+      common_concern do
+        include ::EacCli::Runner
+        include ::EacFs::Traversable
+
+        enable_settings_provider
+        include TopMethods
+
+        runner_definition do
+          bool_opt '-R', '--recursive', 'Recursive.'
+          bool_opt '--no-recursive', 'No recursive.'
+          pos_arg :paths, optional: true, repeat: true
+        end
+      end
+
+      module TopMethods
+        def on_none_path_informed
+          infom 'Warning: none path informed'
+        end
+
+        def paths
+          parsed.paths.map(&:to_pathname)
+        end
+
+        def run_filesystem_traverser
+          if paths.any?
+            paths.each { |path| traverser_check_path(path) }
+          else
+            on_none_path_informed
+          end
+        end
+
+        def traverser_recursive
+          return false if parsed.no_recursive?
+          return true if parsed.recursive?
+
+          setting_value(:default_traverser_recursive, required: false)
+            .if_not_nil(DEFAULT_DEFAULT_TRAVERSER_RECURSIVE)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/runners/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avm
+  module Runners
+    class Base
+      enable_abstract_methods
+
+      class << self
+        def command_argument
+          stereotype_name.underscore.dasherize
+        end
+
+        def stereotype_name
+          name.split('::')[-3]
+        end
+      end
+
+      delegate :command_argument, :stereotype_name, to: :class
+
+      def to_s
+        stereotype_name
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/file_resource_name.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Avm
+  module Scms
+    module AutoCommit
+      class FileResourceName
+        require_sub __FILE__, include_modules: true
+        enable_simple_cache
+        common_constructor :scm, :path do
+          self.path = path.to_pathname
+        end
+
+        def class_name
+          file_format.file_resource_name(relative_path)
+        end
+
+        def commit_message
+          r = class_name
+          r += ': *' if modified?
+          r += ': remove' unless path.file?
+          "#{r}."
+        end
+
+        # @return [Boolean]
+        def modified?
+          dirty_file.if_present(false, &:modify?)
+        end
+
+        # @return [Pathname]
+        def relative_path
+          path.expand_path.relative_path_from(scm.path.expand_path)
+        end
+
+        private
+
+        def dirty_file_uncached
+          scm.changed_files.find { |e| e.absolute_path == path.expand_path }
+        end
+
+        # @return [Avm::FileFormats::Base]
+        def file_format_uncached
+          ::Avm::Registry.file_formats.detect(path)
+        end
+      end
+    end
+  end
+end