eac_tools 0.91.1 → 0.92.0

data/sub/avm/lib/avm/sources/base/configuration.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'eac_config/yaml_file_node'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/yaml'
+require 'shellwords'
+
+module Avm
+  module Sources
+    class Base
+      module Configuration
+        PARENT_CONFIGURATION_SUFFIX = %w[subs at].freeze
+        CONFIGURATION_FILENAMES = %w[.avm.yml .avm.yaml].freeze
+
+        # @return [EacConfig::NodeEntry]
+        def configuration_entry(*entry_args)
+          parent_configuration.if_present do |v|
+            parent_entry = v.entry(*entry_args)
+            return parent_entry if parent_entry.found?
+          end
+
+          configuration.entry(*entry_args)
+        end
+
+        # The possible absolute paths for configuration files.
+        #
+        # @return [Array<Pathname>]
+        def configuration_paths
+          CONFIGURATION_FILENAMES.map { |filename| path.join(filename) }
+        end
+
+        # @return [EacRubyUtils::Envs::Command, nil]
+        def configuration_value_to_env_command(value)
+          return value if value.is_a?(::EacRubyUtils::Envs::Command)
+
+          configuration_value_to_shell_words(value).if_present { |v| env.command(v).chdir(path) }
+        end
+
+        # @return [Array<String>, nil]
+        def configuration_value_to_shell_words(value)
+          return nil if value.blank?
+
+          value.is_a?(::Enumerable) ? value.map(&:to_s) : ::Shellwords.split(value.to_s)
+        end
+
+        # @return [Array<String>, nil]
+        def read_configuration_as_shell_words(key)
+          configuration_value_to_shell_words(configuration_entry(key).value)
+        end
+
+        # Utility to read a configuration as a [EacRubyUtils::Envs::Command].
+        # @return [EacRubyUtils::Envs::Command]
+        def read_configuration_as_env_command(key)
+          configuration_value_to_env_command(configuration_entry(key).value)
+        end
+
+        private
+
+        # @return [EacConfig::YamlFileNode]
+        def configuration_uncached
+          configuration_paths.each do |config_path|
+            configuration_with_filename(config_path, true)
+          end
+          configuration_with_filename(configuration_paths.first, false)
+        end
+
+        # @return [String]
+        def parent_configuration_prefix
+          PARENT_CONFIGURATION_SUFFIX + [relative_path]
+        end
+
+        # @return [EacConfig::PrefixedPathNode]
+        def parent_configuration_uncached
+          parent.if_present { |v| v.configuration.with_prefix(parent_configuration_prefix) }
+        end
+
+        # @return [EacConfig::YamlFileNode, nil]
+        def configuration_with_filename(config_path, needs_exist)
+          return ::EacConfig::YamlFileNode.new(config_path) if !needs_exist || config_path.exist?
+
+          nil
+        end
+
+        # @return [Avm::Sources::Configuration]
+        def old_configuration_uncached
+          ::Avm::Sources::Configuration.find_in_path(path) ||
+            ::Avm::Sources::Configuration.temp_instance
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/instance.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'avm/applications/base'
+require 'avm/instances/base'
+
+module Avm
+  module Sources
+    class Base
+      module Instance
+        def instance
+          application.local_instance
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/locale.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'i18n'
+
+module Avm
+  module Sources
+    class Base
+      module Locale
+        LOCALE_KEY = 'locale'
+
+        def locale
+          configured_locale || default_locale
+        end
+
+        def configured_locale
+          configuration_entry(LOCALE_KEY).value
+        end
+
+        def default_locale
+          ::I18n.default_locale
+        end
+
+        # @param entry_suffix [String]
+        # @param values [Hash]
+        # @return [String]
+        def i18n_translate(entry_suffix, values = {})
+          self.class.i18n_translate(entry_suffix, values.merge(__locale: locale))
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/organizational.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module Organizational
+        DEFAULT_ORGANIZATIONAL = false
+        ORGANIZATIONAL_KEY = 'organizational'
+
+        # @return [Boolean]
+        def organizational?
+          if organizational_entry.found?
+            organizational_entry.value.to_bool
+          else
+            default_organizational
+          end
+        end
+
+        def organizational_entry
+          configuration.entry(ORGANIZATIONAL_KEY)
+        end
+
+        # @return [Boolean]
+        def default_organizational
+          DEFAULT_ORGANIZATIONAL
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/parent.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module Parent
+        # @return [Avm::Sources::Base]
+        def parent_by_option
+          options[OPTION_PARENT]
+        end
+
+        # @return [Avm::Sources::Base]
+        def parent_by_search
+          ::Avm::Registry.sources.detect_by_path_optional(path.parent)
+        end
+
+        private
+
+        # @return [Avm::Sources::Base]
+        def parent_uncached
+          parent_by_option || parent_by_search
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/stereotype.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module Stereotype
+        STEREOTYPE_NAME_KEY = 'stereotype'
+
+        # @return [String, nil]
+        def stereotype_name_by_configuration
+          configuration.entry(STEREOTYPE_NAME_KEY).value
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/sub/remove.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      class Sub
+        class Remove
+          acts_as_instance_method
+
+          # !method initialize(sub)
+          # @param sub [Avm::Sources::Base::Sub]
+          common_constructor :sub
+          delegate :source, to: :sub
+
+          # @return [void]
+          def result
+            source.scm.commit_if_change(commit_message) { do_changes }
+          end
+
+          private
+
+          # @return [String]
+          def commit_message
+            sub.i18n_translate(:remove_commit_message, sub_path: sub.sub_path)
+          end
+
+          # @return [void]
+          def do_changes
+            ::FileUtils.rm_rf(sub.absolute_path)
+            source.on_sub_updated
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'avm/sources/base/subs_paths'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      class Sub
+        # !method initialize(source, sub_path)
+        # @param source [Avm::Sources::Base]
+        # @param sub_path [Pathname]
+        common_constructor :source, :sub_path do
+          self.sub_path = sub_path.to_pathname
+        end
+
+        # @return [Pathname]
+        def absolute_path
+          sub_path.expand_path(source.path)
+        end
+
+        require_sub __FILE__, require_mode: :kernel
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/subs.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'avm/sources/base/sub'
+require 'avm/sources/base/subs_paths'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module Subs
+        CONFIGURATION_SUBS_EXCLUDE_PATHS_KEY = 'subs.exclude_path'
+        CONFIGURATION_SUBS_INCLUDE_PATHS_KEY = 'subs.include_path'
+        SUBS_EXCLUDE_PATHS_DEFAULT = [].freeze
+        SUBS_INCLUDE_PATHS_DEFAULT = ['sub/*'].freeze
+
+        # @return [Avm::Sources::Base, nil]
+        def sub_for_path(path)
+          subs.lazy.map { |sub| path.expand_path.child_of?(sub.path) ? sub : nil }.find(&:present?)
+        end
+
+        # @param sub_path [Pathname]
+        # @return [Avm::Sources::Base::Sub]
+        def sub(sub_path)
+          ::Avm::Sources::Base::Sub.new(self, sub_path)
+        end
+
+        # @return [Enumerable<Avm::Sources::Base>]
+        def subs
+          subs_paths_to_search
+            .map { |sub_path| ::Avm::Registry.sources.detect_optional(sub_path, parent: self) }
+            .compact_blank
+            .sort_by { |sub| [sub.path] }
+        end
+
+        def subs_paths_to_search
+          subs_include_paths.flat_map do |subs_include_path|
+            ::Pathname.glob(path.join(subs_include_path)).reject do |sub_path|
+              subs_exclude_paths.any? do |subs_exclude_path|
+                sub_path.fnmatch?(path.join(subs_exclude_path).to_path)
+              end
+            end
+          end
+        end
+
+        %i[include exclude].each do |type|
+          %i[path paths configured_paths default_paths].each do |method_suffix|
+            obj_method_name = "subs_#{type}_path_obj"
+
+            define_method "subs_#{type}_#{method_suffix}" do
+              send(obj_method_name).send(method_suffix)
+            end
+
+            define_method "#{obj_method_name}_uncached" do
+              ::Avm::Sources::Base::SubsPaths.new(
+                self,
+                self.class.const_get("CONFIGURATION_SUBS_#{type}_PATHS_KEY".upcase),
+                self.class.const_get("SUBS_#{type}_PATHS_DEFAULT".upcase)
+              )
+            end
+
+            private "#{obj_method_name}_uncached" # rubocop:disable Style/AccessModifierDeclarations
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/subs_paths.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      class SubsPaths
+        SUBS_PATH_SEPARATOR = ':'
+
+        common_constructor :source, :configuration_key, :default_paths
+
+        # @return [String]
+        def path
+          paths.join(SUBS_PATH_SEPARATOR)
+        end
+
+        # @return [Array<String>]
+        def paths
+          configured_paths || default_paths
+        end
+
+        # @return [Array<String>]
+        def configured_paths
+          source.configuration_entry(configuration_key).value.if_present do |v|
+            v.split(SUBS_PATH_SEPARATOR)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/testing.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs/command'
+
+module Avm
+  module Sources
+    class Base
+      module Testing
+        DEFAULT_TEST_COMMANDS = {}.freeze
+        TEST_KEY = 'test'
+        TEST_COMMAND_KEY = "#{TEST_KEY}.command"
+        TEST_COMMANDS_KEY = "#{TEST_KEY}.commands"
+
+        def configured_test_command
+          read_configuration_as_env_command(TEST_COMMAND_KEY)
+        end
+
+        # @return [Hash<String, EacRubyUtils::Envs::Command>, nil]
+        def configured_test_commands
+          configured_value_as_test_commands(configuration_entry(TEST_COMMANDS_KEY).value)
+        end
+
+        # @return [Hash<String, EacRubyUtils::Envs::Command>, nil]
+        def configured_value_as_test_commands(value)
+          return nil if value.nil?
+
+          [::EacRubyUtils::Envs::Command, ::Hash, ::Enumerable].each do |type|
+            next unless value.is_a?(type)
+
+            return send(
+              "configured_#{type.name.demodulize.variableize}_value_as_test_commands",
+              value
+            )
+          end
+
+          raise "Value for test commands should be a Hash or a Enumerable (Actual: #{value})"
+        end
+
+        # @return [Hash<String, EacRubyUtils::Envs::Command>]
+        def default_test_commands
+          DEFAULT_TEST_COMMANDS
+        end
+
+        # @return [Enumerable<EacRubyUtils::Envs::Command>]
+        def test_commands
+          configured_test_commands ||
+            configured_value_as_test_commands(configured_test_command) ||
+            default_test_commands
+        end
+
+        protected
+
+        def configured_command_value_as_test_commands(value)
+          configured_enumerable_value_as_test_commands([value])
+        end
+
+        def configured_enumerable_value_as_test_commands(value)
+          configured_hash_value_as_test_commands(
+            value.each_with_index.to_h { |v, i| ["test_#{i}", v] }
+          )
+        end
+
+        def configured_hash_value_as_test_commands(value)
+          value.to_h { |k, v| [k.to_s.strip, configuration_value_to_env_command(v)] }
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/update.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module Update
+        # To override in subclasses.
+        def on_sub_updated
+          # Do nothing
+        end
+
+        def update
+          update_self
+          update_subs
+        end
+
+        def update_self
+          scm.commit_if_change(-> { update_self_commit_message }) do
+            update_self_content
+            parent.if_present(&:on_sub_updated)
+          end
+        end
+
+        # Update source self content.
+        #
+        # To override in subclasses.
+        def update_self_content
+          # Do nothing
+        end
+
+        def update_self_commit_message
+          i18n_translate(__method__)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/update_sub.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      class UpdateSub
+        enable_method_class
+
+        common_constructor :source, :sub
+
+        def result
+          update_version
+          return unless sub.organizational?
+
+          sub.update
+        end
+
+        private
+
+        def update_version
+          base_commit = source.scm.head_commit
+          sub.scm.update
+          on_update_version_commit_change(base_commit) unless base_commit == source.scm.head_commit
+        end
+
+        def on_update_version_commit_change(base_commit)
+          source.on_sub_updated if no_scm_updated?
+          source.scm.reset_and_commit(base_commit, update_version_commit_info)
+        end
+
+        def no_scm_updated?
+          source.scm.head_commit.no_scm_changed_files.any?
+        end
+
+        # @param commit_info [Avm::Scms::CommitInfo]
+        def update_version_commit_info
+          Avm::Scms::CommitInfo.new.message(
+            no_scm_updated? ? update_version_no_scm_message : update_version_scm_message
+          )
+        end
+
+        # @return [String]
+        def update_version_no_scm_message
+          source.i18n_translate(__method__, application_id: sub.application_id,
+                                            path: sub.relative_path, version: sub.version)
+        end
+
+        # @return [String]
+        def update_version_scm_message
+          sub.scm.i18n_translate(__method__)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/update_subs.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      class UpdateSubs
+        enable_method_class
+
+        common_constructor :source
+
+        def result
+          source.subs.each { |sub| source.update_sub(sub) }
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/base/version_bump.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'avm/sources/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module VersionBump
+        # @return [Avm::Scms::Commit, nil]
+        def version_bump(target_version)
+          scm.commit_if_change(version_bump_commit_message(target_version)) do
+            version_bump_do_changes(target_version)
+            parent.if_present(&:on_sub_updated)
+          end
+        end
+
+        # @return [String]
+        def version_bump_commit_message(target_version)
+          i18n_translate(__method__, version: target_version, __locale: locale)
+        end
+
+        def version_bump_do_changes(_target_version)
+          raise_abstract_method(__METHOD__)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+require 'avm/scms/null'
+require 'avm/with/application_stereotype'
+require 'avm/with/extra_subcommands'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      require_sub __FILE__, include_modules: true
+      include ::Avm::With::ApplicationStereotype
+      include ::Avm::With::ExtraSubcommands
+      compare_by :path
+      enable_abstract_methods
+      enable_simple_cache
+      enable_listable
+      lists.add_symbol :option, :parent
+      common_constructor :path, :options, default: [{}] do
+        self.path = path.to_pathname.expand_path
+        self.options = ::Avm::Sources::Base.lists.option.hash_keys_validate!(options)
+      end
+
+      abstract_methods :valid?
+
+      # @param options [Hash<Symbol, Object>]
+      def completer(options = {})
+        scm.completer(options)
+      end
+
+      # @return [EacRubyUtils::Envs::LocalEnv]
+      def env
+        ::EacRubyUtils::Envs::LocalEnv.new
+      end
+
+      # @return [Pathname]
+      def relative_path
+        return path if parent.blank?
+
+        path.relative_path_from(parent.path)
+      end
+
+      def to_s
+        "#{self.class}[#{path}]"
+      end
+
+      # @return [Avm::VersionNumber, nil]
+      def version
+        raise_abstract __method__, 'Should return a Avm::VersionNumber or nil'
+      end
+
+      private
+
+      # @return [Avm::Scms::Base]
+      def scm_uncached
+        ::Avm::Registry.scms.detect_optional(path) || ::Avm::Scms::Null.new(path)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/sources/configuration/rubocop.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Avm
+  module Sources
+    class Configuration < ::EacConfig::OldConfigs
+      module Rubocop
+        RUBOCOP_COMMAND_KEY = 'ruby.rubocop.command'
+        RUBOCOP_GEMFILE_KEY = 'ruby.rubocop.gemfile'
+
+        def rubocop_command
+          read_command(RUBOCOP_COMMAND_KEY)
+        end
+
+        def rubocop_gemfile
+          gemfile_path = read_entry(RUBOCOP_GEMFILE_KEY)
+          return nil if gemfile_path.blank?
+
+          gemfile_path = gemfile_path.to_pathname.expand_path(storage_path.parent)
+          return gemfile_path if gemfile_path.file?
+
+          raise "Gemfile path \"#{gemfile_path}\" does not exist or is not a file"
+        end
+      end
+    end
+  end
+end