avm 0.44.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75da0735d17a4472beabdba8b1a848bd1df14e0e8b630885bbf2b1503d198e14
-  data.tar.gz: 4d71ad19868decc5d8eebcd01b71a1a518702345a06521edb0c27f55bd25cca5
+  metadata.gz: edce5f54d8e35b2991eca7c296980c8102a3f9de6079df2c3841660d91a5a09a
+  data.tar.gz: 1f3bb4e92e4a1d342490b54843f505c641479eec2af609dfb5c70ee81de4101f
 SHA512:
-  metadata.gz: 8e75c632a176c1f15431466cf0fe85c53fcbaccf5d914e643b7a5a51ef17bc8a41ea7c5b2d6253feb0587557d01d66a40b7073ac375115f7e07afe1ffa13d694
-  data.tar.gz: d3c82791118497839cea0c53d9e8d838dedf1db1a7f462c022ea24d82411774f86db27b9e0e8d40b844a09ad6c2f918f0b23802f58f489e03490bc52f10d526f
+  metadata.gz: 2f827370664e3b78a4808a57227b5791da8a9185522a11081a6d50f05493648135e0734a680f2abbc1fc902775249f4011cad1f669bef8f6127258edd7b357f9
+  data.tar.gz: c95a5acd8db7c9c8ceb104cd203c9a30bdd1438de79309869cac1c3ed1ab1d8178b91f42b436a63ec312a54fe6ef9166c9f7395d26b35b826633856f7d43af03

data/lib/avm/entries/auto_values/entry.rb

@@ -8,15 +8,22 @@ module Avm
     module AutoValues
       class Entry
         class << self
-          def auto_value_method_name(suffix)
-            "auto_#{suffix.to_s.gsub('.', '_')}"
+          # @param path [EacConfig::EntryPath]
+          # @return String
+          def auto_value_method_name(path)
+            "auto_#{::EacConfig::EntryPath.assert(path).to_string.gsub('.', '_')}"
           end
         end
 
-        common_constructor :entries_provider, :suffix
+        # @!method initialize(entries_provider, path)
+        #   @param entries_provider
+        #   @param path [EacConfig::EntryPath]
+        common_constructor :entries_provider, :path do
+          self.path = ::EacConfig::EntryPath.assert(path)
+        end
 
         def auto_value_method
-          self.class.auto_value_method_name(suffix)
+          self.class.auto_value_method_name(path)
         end
 
         def found?

data/lib/avm/entries/jobs/base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'avm/entries/jobs/with_variables_source'
+require 'avm/result'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Entries
+    module Jobs
+      module Base
+        common_concern do
+          include ::ActiveSupport::Callbacks
+          include ::Avm::Entries::Jobs::WithVariablesSource
+
+          enable_speaker
+          enable_simple_cache
+          enable_listable
+          common_constructor :instance, :options, default: [{}] do
+            if option_list.present?
+              self.options = option_list.hash_keys_validate!(options.symbolize_keys)
+            end
+          end
+          define_callbacks(*jobs)
+        end
+
+        module ClassMethods
+          def jobs
+            const_get('JOBS').dup
+          end
+        end
+
+        module InstanceMethods
+          def option_list
+            nil
+          end
+
+          def run
+            start_banner if respond_to?(:start_banner)
+            run_jobs
+            ::Avm::Result.success('Done!')
+          rescue ::Avm::Result::Error => e
+            e.to_result
+          end
+
+          protected
+
+          def run_jobs
+            jobs.each do |job|
+              run_callbacks job do
+                send(job)
+              end
+            end
+          end
+
+          def jobs
+            self.class.jobs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/entries/jobs/variables_source/read_entry.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Entries
+    module Jobs
+      class VariablesSource
+        class ReadEntry
+          enable_method_class
+          common_constructor :variables_source, :path, :options, default: [{}]
+          delegate :instance, :job, to: :variables_source
+
+          def result
+            return result_from_job if result_from_job?
+            return result_from_instance_method if result_from_instance_method?
+
+            result_from_instance_entry
+          end
+
+          private
+
+          def path_method_name
+            path.gsub('.', '_').underscore
+          end
+
+          def result_from_instance_entry
+            instance.read_entry(path, options)
+          end
+
+          def result_from_instance_method
+            instance.send(path_method_name)
+          end
+
+          def result_from_instance_method?
+            instance.respond_to?(path_method_name, true)
+          end
+
+          def result_from_job
+            job.send(path_method_name)
+          end
+
+          def result_from_job?
+            job.respond_to?(path_method_name, true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/entries/jobs/variables_source.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Entries
+    module Jobs
+      class VariablesSource
+        require_sub __FILE__, require_dependency: true
+        common_constructor :job
+        delegate :instance, to: :job
+      end
+    end
+  end
+end

data/lib/avm/entries/jobs/with_variables_source.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'avm/entries/jobs/variables_source'
+
+module Avm
+  module Entries
+    module Jobs
+      module WithVariablesSource
+        def variables_source
+          ::Avm::Entries::Jobs::VariablesSource.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/avm/{jobs.rb → entries/jobs.rb}

@@ -3,7 +3,9 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module Jobs
-    require_sub __FILE__
+  module Entries
+    module Jobs
+      require_sub __FILE__
+    end
   end
 end

data/lib/avm/instances/base/entry_keys.rb

@@ -13,7 +13,7 @@ module Avm
           end
 
           define_method "#{method_name}_optional" do
-            read_entry(key, required: false)
+            read_entry_optional(key)
           end
         end
       end

data/lib/avm/instances/entry_keys.rb

@@ -35,7 +35,7 @@ module Avm
           '' => %w[id from reply_to],
           smtp: URI_FIELDS + %w[address domain authentication openssl_verify_mode starttls_auto tls]
         },
-        web: URI_FIELDS + %w[authority userinfo]
+        web: URI_FIELDS
       }.each { |prefix, suffixes| keys_consts_set(prefix, suffixes) }
     end
   end

data/lib/avm/rspec/setup.rb

@@ -5,17 +5,16 @@ require 'eac_ruby_utils/core_ext'
 module Avm
   module Rspec
     module Setup
-      def self.extended(obj)
-        obj.setup_in_avm_registry_example
-        obj.setup_not_in_avm_registry_example
-      end
+      EXAMPLES = %w[entries_values in_avm_registry not_in_avm_registry].freeze
 
-      def setup_in_avm_registry_example
-        require 'avm/rspec/shared_examples/in_avm_registry'
+      def self.extended(obj)
+        obj.setup_examples
       end
 
-      def setup_not_in_avm_registry_example
-        require 'avm/rspec/shared_examples/not_in_avm_registry'
+      def setup_examples
+        EXAMPLES.each do |example|
+          require "avm/rspec/shared_examples/#{example}"
+        end
       end
     end
   end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+::RSpec.shared_examples 'entries_values' do |spec_file, expected_values|
+  describe '#read_entry' do
+    config_path = spec_file.to_pathname
+    config_path = config_path.dirname.join("#{config_path.basename_noext}_files", 'config.yml')
+    ::EacRubyUtils::Rspec.default_setup.stub_eac_config_node(self, config_path)
+
+    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 ".read_entry should return \"#{expected}\"" do
+            expect(instance.read_entry(input)).to eq(expected)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.45.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_cli
@@ -73,7 +73,7 @@ dependencies:
         version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,7 +83,7 @@ dependencies:
         version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
   requirement: !ruby/object:Gem::Requirement
@@ -241,6 +241,11 @@ files:
 - lib/avm/entries/base/uri_components_entries_values/path_component.rb
 - lib/avm/entries/base/uri_components_entries_values/url_component.rb
 - lib/avm/entries/entry.rb
+- lib/avm/entries/jobs.rb
+- lib/avm/entries/jobs/base.rb
+- lib/avm/entries/jobs/variables_source.rb
+- lib/avm/entries/jobs/variables_source/read_entry.rb
+- lib/avm/entries/jobs/with_variables_source.rb
 - lib/avm/entries/keys_constants_set.rb
 - lib/avm/entries/uri_builder.rb
 - lib/avm/executables.rb
@@ -259,9 +264,6 @@ files:
 - lib/avm/instances/docker_image.rb
 - lib/avm/instances/entry_keys.rb
 - lib/avm/instances/runner.rb
-- lib/avm/jobs.rb
-- lib/avm/jobs/base.rb
-- lib/avm/jobs/variables_source.rb
 - lib/avm/launcher/errors/base.rb
 - lib/avm/launcher/errors/non_project.rb
 - lib/avm/launcher/paths/real.rb
@@ -282,6 +284,7 @@ files:
 - lib/avm/result.rb
 - lib/avm/rspec.rb
 - lib/avm/rspec/setup.rb
+- lib/avm/rspec/shared_examples/entries_values.rb
 - lib/avm/rspec/shared_examples/in_avm_registry.rb
 - lib/avm/rspec/shared_examples/not_in_avm_registry.rb
 - lib/avm/runners/base.rb

data/lib/avm/jobs/base.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'avm/jobs/variables_source'
-require 'avm/result'
-require 'eac_cli/core_ext'
-
-module Avm
-  module Jobs
-    module Base
-      common_concern do
-        include ::ActiveSupport::Callbacks
-
-        enable_speaker
-        enable_simple_cache
-        enable_listable
-        common_constructor :instance, :options, default: [{}] do
-          if option_list.present?
-            self.options = option_list.hash_keys_validate!(options.symbolize_keys)
-          end
-        end
-        define_callbacks(*jobs)
-      end
-
-      module ClassMethods
-        def jobs
-          const_get('JOBS').dup
-        end
-      end
-
-      module InstanceMethods
-        def option_list
-          nil
-        end
-
-        def run
-          start_banner if respond_to?(:start_banner)
-          run_jobs
-          ::Avm::Result.success('Done!')
-        rescue ::Avm::Result::Error => e
-          e.to_result
-        end
-
-        def variables_source
-          ::Avm::Jobs::VariablesSource.new(self, instance)
-        end
-
-        protected
-
-        def run_jobs
-          jobs.each do |job|
-            run_callbacks job do
-              send(job)
-            end
-          end
-        end
-
-        def jobs
-          self.class.jobs
-        end
-      end
-    end
-  end
-end

data/lib/avm/jobs/variables_source.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module Avm
-  module Jobs
-    class VariablesSource
-      common_constructor :job, :instance
-
-      def read_entry(path, options = {})
-        entry_from_job(path) || instance.read_entry(path, options)
-      end
-
-      private
-
-      def entry_from_job(path)
-        method = path.gsub('.', '_').underscore
-        return job.send(method) if job.respond_to?(method, true)
-      end
-    end
-  end
-end