avm 0.21.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3439e5be72641bfbb2057567b3066ee5a9fa0bb230ac4b755e541a501b2f51af
-  data.tar.gz: 47d2db526602f0054663417bf5e3d519408df59ba1e03c0fb16c9dc5ef23871e
+  metadata.gz: 937c532ad108fabe2301a9e6a32048f0f0d8afd771d384d7079650c09a96f9c4
+  data.tar.gz: f76e3a10f12fa40c99bc1374039133f544e7d8757e771b581b27f5e85029c46e
 SHA512:
-  metadata.gz: f50e41ecf763e2901de01276d03dffb24c4b1322ab28cca1c7d19a0860bddeef3433b42667209b480481c24e074bcbe05fb1148f13f6206427db1be33c160ca7
-  data.tar.gz: 6d93ed47691853ae5a56c0577de8606ab72126fe4a83eefbf9d68ca6a88f1c6960369e8a183671fefdeb235b3a23550bbe5271d2d03382c7030de549948b0619
+  metadata.gz: 3c9e645ab258c0a24d70cde2b6ba74e0af37f1fd3d8c1390e60416862b9d6cb47b8c109776243da88447204a0bb13c90ab9ea3c27aa7dddd93cb9814aa0829ee
+  data.tar.gz: 8bf8b0fe97dd546a96af5abb7124d7740b66f1ce585613589281bee8aadb81075e7a0c8a305ae81e2dc7e50c2aa31ed1a3401cae7804664dfe592929fbb357b2

data/lib/avm/registry/base.rb

@@ -11,8 +11,7 @@ module Avm
 
       def detect(*registered_initialize_args)
         detect_optional(*registered_initialize_args) ||
-          raise("No registered module valid for #{registered_initialize_args}" \
-            " (Module suffix: #{module_suffix}, Available: #{registered_modules.join(', ')})")
+          raise_not_found(*registered_initialize_args)
       end
 
       def detect_optional(*registered_initialize_args)
@@ -38,6 +37,11 @@ module Avm
 
       private
 
+      def raise_not_found(*args)
+        raise("No registered module valid for #{args}" \
+            " (Module suffix: #{module_suffix}, Available: #{registered_modules.join(', ')})")
+      end
+
       def registered_modules_uncached
         registered_gems.flat_map { |registry| modules_from_registry(registry) }
           .select { |v| valid_registered_module?(v) }.uniq

data/lib/avm/registry/with_path.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'avm/registry/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Registry
+    class WithPath < ::Avm::Registry::Base
+      def detect_by_path(path)
+        detect_by_path_optional(path) || raise_not_found(path)
+      end
+
+      def detect_by_path_optional(path)
+        current_path = path.to_pathname.expand_path
+        until current_path.root?
+          detect_optional(current_path).if_present { |v| return v }
+          current_path = current_path.parent
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/avm/registry.rb

@@ -9,6 +9,8 @@ module Avm
     enable_listable
     lists.add_symbol :category, :instance_stereotypes, :runners, :scms, :sources
 
+    WITH_PATH = [CATEGORY_SCMS, CATEGORY_SOURCES].freeze
+
     class << self
       enable_simple_cache
 
@@ -21,7 +23,15 @@ module Avm
 
       ::Avm::Registry.lists.category.each_value do |category|
         define_method "#{category}_uncached" do
-          ::Avm::Registry::Base.new(category.to_s.camelize)
+          registry_class(category).new(category.to_s.camelize)
+        end
+      end
+
+      def registry_class(category)
+        if WITH_PATH.include?(category)
+          ::Avm::Registry::WithPath
+        else
+          ::Avm::Registry::Base
         end
       end
     end

data/lib/avm/scms/base.rb

@@ -33,13 +33,8 @@ module Avm
       private
 
       # @return [Avm::Scms::Base]
-      def parent_scm
-        parent_path = path.parent
-        until parent_path.root?
-          ::Avm::Registry.scms.detect_optional(parent_path).if_present { |v| return v }
-          parent_path = parent_path.parent
-        end
-        nil
+      def parent_scm_uncached
+        ::Avm::Registry.scms.detect_by_path_optional(path.parent)
       end
     end
   end

data/lib/avm/scms/null.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'avm/scms/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Scms
+    class Null < ::Avm::Scms::Base
+      def update
+        # Do nothing
+      end
+    end
+  end
+end

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

@@ -9,21 +9,39 @@ module Avm
   module Sources
     class Base
       module Configuration
+        CONFIGURATION_FILENAMES = %w[.avm.yml .avm.yaml].freeze
+
+        # @return [EacRubyUtils::Envs::Command, nil]
+        def configuration_value_to_env_command(value)
+          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.entry(key).value.if_present do |v|
-            v.is_a?(::Enumerable) ? v.map(&:to_s) : ::Shellwords.split(v.to_s)
-          end
+          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
-          ::Avm::Sources::Configuration::FILENAMES.each do |filename|
+          CONFIGURATION_FILENAMES.each do |filename|
             configuration_with_filename(filename, true)
           end
-          configuration_with_filename(::Avm::Sources::Configuration::FILENAMES.first, false)
+          configuration_with_filename(CONFIGURATION_FILENAMES.first, false)
         end
 
         # @return [EacConfig::YamlFileNode, nil]

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

@@ -0,0 +1,26 @@
+# 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'avm/sources/base/subs_paths'
+require 'eac_cli/runner_with/subcommands'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Sources
+    class Base
+      module Runners
+        # @return [Hash<String, EacCli::Runner>]
+        def extra_available_subcommands
+          extra_available_subcommands_from_runners_module
+        end
+
+        # @return [Hash<String, EacCli::Runner>]
+        def extra_available_subcommands_from_runners_module
+          self.class.ancestors.reverse.inject({}) do |a, e|
+            a.merge(RunnersFromModule.new(e).result)
+          end
+        end
+
+        class RunnersFromModule
+          enable_simple_cache
+          common_constructor :the_module
+
+          # @return [Hash<String, EacCli::Runner>]
+          def result
+            return {} if runners_module.blank?
+
+            ::EacCli::RunnerWith::Subcommands.subcommands_from_module(runners_module)
+          end
+
+          def runners_module_uncached
+            return nil if the_module.module_parent.blank?
+
+            begin
+              the_module.module_parent.const_get('Runners')
+            rescue ::NameError
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,19 +1,68 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs/command'
 
 module Avm
   module Sources
     class Base
       module Testing
-        # @return [Avm::Sources::Tester]
-        def tester
-          tester_class.new(self)
+        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.blank?
+
+          [::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.map { |v| ["test_#{v[1]}", v[0]] }.to_h
+          )
         end
 
-        # @return [Class<Avm::Sources::Tester>
-        def tester_class
-          Avm::Sources::Tester
+        def configured_hash_value_as_test_commands(value)
+          value.map { |k, v| [k.to_s.strip, configuration_value_to_env_command(v)] }.to_h
         end
       end
     end

data/lib/avm/sources/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'avm/registry'
+require 'avm/scms/null'
 require 'eac_git'
 require 'eac_ruby_utils/core_ext'
 
@@ -20,18 +21,11 @@ module Avm
 
       abstract_methods :update, :valid?
 
-      delegate :locale, to: :old_configuration
-
       # @return [EacRubyUtils::Envs::LocalEnv]
       def env
         ::EacRubyUtils::Envs::LocalEnv.new
       end
 
-      # @return [Hash<String, Class>]
-      def extra_available_subcommands
-        {}
-      end
-
       # @return [Pathname]
       def relative_path
         return path if parent.blank?
@@ -47,7 +41,7 @@ module Avm
 
       # @return [Avm::Scms::Base]
       def scm_uncached
-        ::Avm::Registry.scms.detect(path)
+        ::Avm::Registry.scms.detect_optional(path) || ::Avm::Scms::Null.new(path)
       end
     end
   end

data/lib/avm/sources/tests/builder.rb

@@ -44,6 +44,13 @@ module Avm
           create_units(main_source.subs)
         end
 
+        # @return [Array<Avm::Sources::Tests::Single>]
+        def create_source_units(source)
+          source.test_commands.map do |test_name, test_command|
+            ::Avm::Sources::Tests::Single.new(self, source, test_name, test_command)
+          end
+        end
+
         # @return [Avm::Sources::Tests::Single]
         def create_unit(source)
           ::Avm::Sources::Tests::Single.new(self, source)
@@ -51,7 +58,7 @@ module Avm
 
         # @return [Array<Avm::Sources::Tests::Single>]
         def create_units(sources)
-          sources.map { |a_source| create_unit(a_source) }
+          sources.flat_map { |a_source| create_source_units(a_source) }
         end
 
         # @return [Avm::Sources::Tests::Single]

data/lib/avm/sources/tests/single.rb

@@ -14,9 +14,8 @@ module Avm
         enable_simple_cache
         enable_speaker
 
-        common_constructor :builder, :source
+        common_constructor :builder, :source, :test_name, :test_command
 
-        delegate :logs, :result, to: :tester
         delegate :to_s, to: :id
 
         def failed?
@@ -25,11 +24,7 @@ module Avm
 
         # @return [String]
         def id
-          if main?
-            MAIN_SOURCE_ID
-          else
-            relative_path_from_main_source.to_s
-          end
+          "#{main? ? MAIN_SOURCE_ID : relative_path_from_main_source}\##{test_name}"
         end
 
         def main?
@@ -47,8 +42,32 @@ module Avm
 
         private
 
-        def tester_uncached
-          source.tester
+        # @return [EacFs::Logs]
+        def logs_uncached
+          ::EacFs::Logs.new.add(:stdout).add(:stderr)
+        end
+
+        # @return [Avm::Sources::Tests::Result]
+        def result_uncached
+          if test_command.blank?
+            ::Avm::Sources::Tests::Result::NONEXISTENT
+          elsif run_test_command
+            ::Avm::Sources::Tests::Result::SUCESSFUL
+          else
+            ::Avm::Sources::Tests::Result::FAILED
+          end
+        end
+
+        def run_test_command
+          execute_command_and_log(test_command)
+        end
+
+        # @return [true, false]
+        def execute_command_and_log(command)
+          r = command.execute
+          logs[:stdout].write(r[:stdout])
+          logs[:stderr].write(r[:stderr])
+          r[:exit_code].zero?
         end
       end
     end

data/lib/avm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avm
-  VERSION = '0.21.0'
+  VERSION = '0.24.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_cli
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0.27'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.27.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '0.27'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.27.6
 - !ruby/object:Gem::Dependency
   name: eac_docker
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +226,7 @@ files:
 - lib/avm/path_string.rb
 - lib/avm/registry.rb
 - lib/avm/registry/base.rb
+- lib/avm/registry/with_path.rb
 - lib/avm/result.rb
 - lib/avm/rspec.rb
 - lib/avm/rspec/setup.rb
@@ -235,6 +236,7 @@ files:
 - lib/avm/scms/base.rb
 - lib/avm/scms/commit.rb
 - lib/avm/scms/inflector.rb
+- lib/avm/scms/null.rb
 - lib/avm/self/docker_image.rb
 - lib/avm/self/instance.rb
 - lib/avm/self/instance/entry_keys.rb
@@ -242,15 +244,14 @@ files:
 - lib/avm/sources/base.rb
 - lib/avm/sources/base/configuration.rb
 - lib/avm/sources/base/instance.rb
+- lib/avm/sources/base/locale.rb
 - lib/avm/sources/base/parent.rb
+- lib/avm/sources/base/runners.rb
 - lib/avm/sources/base/subs.rb
 - lib/avm/sources/base/subs_paths.rb
 - lib/avm/sources/base/testing.rb
 - lib/avm/sources/configuration.rb
-- lib/avm/sources/configuration/locale.rb
 - lib/avm/sources/configuration/rubocop.rb
-- lib/avm/sources/configuration/tests.rb
-- lib/avm/sources/tester.rb
 - lib/avm/sources/tests.rb
 - lib/avm/sources/tests/builder.rb
 - lib/avm/sources/tests/performer.rb

data/lib/avm/sources/configuration/locale.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'avm/patches/eac_ruby_gems_utils/gem'
-require 'i18n'
-
-module Avm
-  module Sources
-    class Configuration < ::EacConfig::OldConfigs
-      module Locale
-        LOCALE_KEY = :locale
-
-        def locale
-          read_entry(LOCALE_KEY) || ::I18n.default_locale
-        end
-      end
-    end
-  end
-end

data/lib/avm/sources/configuration/tests.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'avm/patches/eac_ruby_gems_utils/gem'
-
-module Avm
-  module Sources
-    class Configuration < ::EacConfig::OldConfigs
-      module Tests
-        BUNDLE_TEST_COMMAND_KEY = 'test.bundle_command'
-        TEST_COMMAND_KEY = 'test.command'
-
-        def any_test_command
-          bundle_test_command || test_command
-        end
-
-        def test_command
-          read_command(TEST_COMMAND_KEY)
-        end
-
-        def bundle_test_command
-          read_entry(BUNDLE_TEST_COMMAND_KEY).if_present do |v|
-            args = v.is_a?(::Enumerable) ? v.map(&:to_s) : ::Shellwords.split(v)
-            ::EacRubyGemsUtils::Gem.new(::File.dirname(storage_path)).bundle(*args).chdir_root
-          end
-        end
-      end
-    end
-  end
-end

data/lib/avm/sources/tester.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module Avm
-  module Sources
-    class Tester
-      enable_abstract_methods
-      common_constructor :source
-
-      abstract_methods :result, :logs
-
-      # @return [EacFs::Logs]
-      def logs
-        raise_abstract_method __method__
-      end
-
-      # @return [Avm::Sources::Tests::Result]
-      def result
-        raise_abstract_method __method__
-      end
-    end
-  end
-end