avm 0.19.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60254779c64e435b8f853ab931907a47eefb974428e2298dc82b2f6d308d642a
-  data.tar.gz: 8c054b755c9882ed5b1faaa0c521031edf3551139d04259e0e11895844b4ef63
+  metadata.gz: '0165809370dba684b9d456d8d28447e0d8cf625b9abe8f15a6b2d47aae905518'
+  data.tar.gz: f8f75c35fd20364008a777023f542cb505c4ee0774c093c1069d452a2656becf
 SHA512:
-  metadata.gz: 3b7aadec66e69a23688c07dffd62f05d1579a1b14c90f57f2e5e6b2caf460e59b394ac62fe60178428100caf5359ab04ae21fecf958748dd01553129cb7d3304
-  data.tar.gz: c7eddaff6582abdbbb12d6b09a919b199505c1d4189fc8a6696eec61c39f5c41d3b4670d92278b9d30e049b49a99271b0826cb4d079c1b6ab2190424029d0274
+  metadata.gz: ba30dc2ecb69636de16b65c6b2dc2b51e2e7014dec33f7958d9b8451cf515435868176d40570693e7f61b7e56a9896e0c40da3e98ce9e2c770acb2d06c339661
+  data.tar.gz: d54c9c0ba6c1fcbcd2f2dba2eff4fc360a300c0eccf6d801989a1f11eb44dd32ae740a6dc122768292dbc1a59e0c51773d2bf78770503d7ce51ccfa7bf91fe91

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'eac_config/yaml_file_node'
 require 'eac_ruby_utils/core_ext'
 require 'eac_ruby_utils/yaml'
 require 'shellwords'
@@ -8,23 +9,39 @@ module Avm
   module Sources
     class Base
       module Configuration
+        CONFIGURATION_FILENAMES = %w[.avm.yml .avm.yaml].freeze
+
         # @return [Array<String>, nil]
         def read_configuration_as_shell_words(key)
-          configuration[key].if_present do |v|
+          configuration.entry(key).value.if_present do |v|
             v.is_a?(::Enumerable) ? v.map(&:to_s) : ::Shellwords.split(v.to_s)
           end
         end
 
+        # Utility to read a configuration as a [EacRubyUtils::Envs::Command].
+        # @return [EacRubyUtils::Envs::Command]
+        def read_configuration_as_env_command(key)
+          read_configuration_as_shell_words(key).if_present do |v|
+            env.command(v).chdir(path)
+          end
+        end
+
         private
 
-        # @return [Hash]
+        # @return [EacConfig::YamlFileNode]
         def configuration_uncached
-          ::Avm::Sources::Configuration::FILENAMES.each do |filename|
-            file_path = path.join(filename)
-            return ::EacRubyUtils::Yaml.load_file(file_path).with_indifferent_access if
-            file_path.exist?
+          CONFIGURATION_FILENAMES.each do |filename|
+            configuration_with_filename(filename, true)
           end
-          {}
+          configuration_with_filename(CONFIGURATION_FILENAMES.first, false)
+        end
+
+        # @return [EacConfig::YamlFileNode, nil]
+        def configuration_with_filename(filename, needs_exist)
+          file_path = path.join(filename)
+          return ::EacConfig::YamlFileNode.new(file_path) if !needs_exist || file_path.exist?
+
+          nil
         end
 
         # @return [Avm::Sources::Configuration]

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/subs.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+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 [Enumerable<Avm::Sources::Base>]
+        def subs
+          subs_paths_to_search
+            .map { |sub_path| ::Avm::Registry.sources.detect_optional(sub_path, parent: self) }
+            .reject(&: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/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/lib/avm/sources/base/testing.rb

@@ -6,6 +6,12 @@ module Avm
   module Sources
     class Base
       module Testing
+        TEST_COMMAND_KEY = 'test.command'
+
+        def configured_test_command
+          read_configuration_as_env_command(TEST_COMMAND_KEY)
+        end
+
         # @return [Avm::Sources::Tester]
         def tester
           tester_class.new(self)

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,7 +21,15 @@ 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
@@ -33,16 +42,11 @@ module Avm
         "#{self.class}[#{path}]"
       end
 
-      # @return [Enumerable<Avm::Sources::Base>]
-      def subs
-        scm.subs.map { |subrepo| ::Avm::Registry.sources.detect(subrepo.path, parent: self) }
-      end
-
       private
 
       # @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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
+date: 2022-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_cli
@@ -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,12 +244,13 @@ 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/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

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