avm 0.45.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edce5f54d8e35b2991eca7c296980c8102a3f9de6079df2c3841660d91a5a09a
-  data.tar.gz: 1f3bb4e92e4a1d342490b54843f505c641479eec2af609dfb5c70ee81de4101f
+  metadata.gz: 3de16327c43ae558d30a57324fcbaa23da1546da8110c4de0ba502003d6ac42c
+  data.tar.gz: 1bc7005ac83d1191579db59161d656fb4054e35f23c611a46c563df5351c6213
 SHA512:
-  metadata.gz: 2f827370664e3b78a4808a57227b5791da8a9185522a11081a6d50f05493648135e0734a680f2abbc1fc902775249f4011cad1f669bef8f6127258edd7b357f9
-  data.tar.gz: c95a5acd8db7c9c8ceb104cd203c9a30bdd1438de79309869cac1c3ed1ab1d8178b91f42b436a63ec312a54fe6ef9166c9f7395d26b35b826633856f7d43af03
+  metadata.gz: 893701096abafe979997222cce3150766e944369ad8cb089f4022acfe1673d4651529dfa9b63e8b585028c8cac2f1a394aba20627b8b1b37d73f3ee0b4089d34
+  data.tar.gz: 5c042ea77b1f9daf6b29ea86484ecf24b9ac4eef274eb4c1999a612ae8f92dc3173b3b492c62fb364bb76c89fd8c6406fc46104a8ec652e00803e1dc631ed4a5

data/lib/avm/launcher/context/instance_collector.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Launcher
+    class Context
+      class InstanceCollector
+        common_constructor :context
+
+        def add_all
+          instances_set.merge(context.instances)
+          self
+        end
+
+        def add_path(path)
+          instances_set.merge(instances_on_path(path))
+          self
+        end
+
+        def add_pending
+          instances_set.merge(context.pending_instances)
+          self
+        end
+
+        def instances
+          instances_set.sort
+        end
+
+        private
+
+        def instance_match?(instance, instance_name)
+          ::File.fnmatch?(instance_name, instance.name)
+        end
+
+        def instances_on_path(path)
+          context.instances.select { |instance| instance_match?(instance, path) }
+        end
+
+        def instances_set
+          @instances_set ||= ::Set.new
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/context/instance_discovery.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'ruby-progressbar'
+require 'avm/launcher/instances/base'
+
+module Avm
+  module Launcher
+    class Context
+      class InstanceDiscovery
+        attr_reader :instances
+
+        def initialize(context)
+          @context = context
+          @progress = ::ProgressBar.create(title: 'Instance discovery', total: 1)
+          @instances = path_instances(@context.root, nil)
+        ensure
+          @progress&.finish
+        end
+
+        private
+
+        def path_instances(path, parent_instance)
+          update_progress_format(path)
+          on_rescued_path_instances(path) do |r|
+            if path.project?
+              parent_instance = ::Avm::Launcher::Instances::Base.instanciate(path, parent_instance)
+              r << path
+            end
+            children = path.children
+            update_progress_count(children)
+            r.concat(children.flat_map { |c| path_instances(c, parent_instance) })
+          end
+        end
+
+        def on_rescued_path_instances(path)
+          r = []
+          begin
+            yield(r) if path.included?
+          rescue StandardError => e
+            warn("#{path}: #{e}")
+          end
+          r
+        end
+
+        def update_progress_format(path)
+          @progress.format = "%t (Paths: %c/%C, Current: #{path.logical}) |%B| %a"
+        end
+
+        def update_progress_count(children)
+          @progress.total += children.count
+          @progress.increment
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/context/instance_manager/cached_instance.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/instances/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Launcher
+    class Context
+      class InstanceManager
+        class CachedInstance
+          enable_speaker
+          enable_simple_cache
+          common_constructor :cached_instances, :data
+
+          private
+
+          def instance_uncached
+            ::Avm::Launcher::Instances::Base.instanciate(path, parent_instance)
+          rescue ::Avm::Launcher::Errors::NonProject
+            warn "Cached instance \"#{data[:logical]}\" not found"
+            nil
+          end
+
+          def parent_instance_uncached
+            data[:parent]
+              .if_present { |v| cached_instances.by_logical_path(v) }
+              .if_present(&:instance)
+          end
+
+          def path_uncached
+            ::Avm::Launcher::Paths::Logical.from_h(cached_instances.context, data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/context/instance_manager/cached_instances.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/context/instance_manager/cached_instance'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Launcher
+    class Context
+      class InstanceManager
+        class CachedInstances
+          enable_simple_cache
+          common_constructor :context, :content
+
+          def instances
+            content.keys.map { |k| by_logical_path(k).instance }.reject(&:blank?)
+          end
+
+          def by_logical_path(key)
+            cached_instances[key].if_blank do
+              cached_instances[key] = ::Avm::Launcher::Context::InstanceManager::CachedInstance.new(
+                self, content.fetch(key)
+              )
+            end
+          end
+
+          private
+
+          def cached_instances_uncached
+            {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/context/instance_manager.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'avm/launcher/publish/check_result'
+require('yaml')
+
+module Avm
+  module Launcher
+    class Context
+      class InstanceManager
+        require_sub __FILE__
+        enable_simple_cache
+        common_constructor :context
+
+        def publish_state_set(instance, stereotype_name, check_status)
+          data = cached_instances_file_content_uncached
+          data[instance.logical] ||= {}
+          data[instance.logical][:publish_state] ||= {}
+          data[instance.logical][:publish_state][stereotype_name] = check_status
+          write_cache_file(data)
+        end
+
+        def pending_instances
+          instances.select { |instance| pending_instance?(instance) }
+        end
+
+        private
+
+        def instances_uncached
+          (cached_instances || search_instances).select(&:included?)
+        end
+
+        def search_instances
+          cache_instances(::Avm::Launcher::Context::InstanceDiscovery.new(context).instances)
+        end
+
+        def cached_instances
+          return nil if context.recache
+          return nil unless cached_instances_file_content
+
+          CachedInstances.new(self, cached_instances_file_content).instances
+        end
+
+        def cached_instances_file_content_uncached
+          r = YAML.load_file(cache_file_path)
+          r.is_a?(::Hash) ? r : nil
+        rescue Errno::ENOENT
+          nil
+        end
+
+        def cache_instances(instances)
+          write_cache_file(Hash[instances.map { |i| [i.logical, i.to_h] }])
+          instances
+        end
+
+        def write_cache_file(data)
+          ::File.write(cache_file_path, data.to_yaml)
+        end
+
+        def cache_file_path
+          ::File.join(context.cache_root, 'instances.yml')
+        end
+
+        def pending_instance?(instance)
+          data = cached_instances_file_content
+          return false unless data[instance.logical]
+          return false unless data[instance.logical][:publish_state].is_a?(Hash)
+
+          data[instance.logical][:publish_state].any? do |_k, v|
+            ::Avm::Launcher::Publish::CheckResult.pending_status?(v)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/context/settings.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/instances/settings'
+require 'eac_ruby_utils/simple_cache'
+require 'yaml'
+
+module Avm
+  module Launcher
+    class Context
+      class Settings
+        include ::EacRubyUtils::SimpleCache
+
+        def initialize(file)
+          unless ::File.exist?(file)
+            ::FileUtils.mkdir_p(::File.dirname(file))
+            ::File.write(file, {}.to_yaml)
+          end
+          @data = YAML.load_file(file)
+        end
+
+        def instance_settings(instance)
+          ::Avm::Launcher::Instances::Settings.new(value(['Instances', instance.name]))
+        end
+
+        private
+
+        def excluded_projects_uncached
+          enum_value(%w[Projects Exclude])
+        end
+
+        def excluded_paths_uncached
+          enum_value(%w[Paths Exclude])
+        end
+
+        def enum_value(path)
+          r = value(path)
+          r.is_a?(Enumerable) ? r : []
+        end
+
+        def value(path)
+          node_value(@data, path)
+        end
+
+        def node_value(data, path)
+          return data if path.empty?
+          return nil unless data.is_a?(Hash)
+
+          node_value(data[path.first], path.drop(1))
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/context.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'avm/launcher/context/instance_manager'
+require 'eac_ruby_utils/simple_cache'
+require 'eac_cli/speaker'
+require 'avm/launcher/context/instance_discovery'
+require 'avm/launcher/context/settings'
+require 'avm/launcher/paths/logical'
+require 'avm/launcher/project'
+require 'avm/tools/self'
+
+module Avm
+  module Launcher
+    class Context
+      include ::EacRubyUtils::SimpleCache
+      enable_speaker
+
+      class << self
+        attr_writer :current
+
+        def current
+          @current ||= default
+        end
+
+        def default
+          @default ||= Context.new
+        end
+      end
+
+      attr_reader :root, :settings, :cache_root
+      attr_accessor :publish_options, :recache, :instance_manager
+
+      CONFIG_PATH_PREFIX = 'launcher'
+
+      def initialize(options = {})
+        @options = options.with_indifferent_access
+        @root = ::Avm::Launcher::Paths::Logical.new(self, nil, build_option(:projects_root), '/')
+        @settings = ::Avm::Launcher::Context::Settings.new(build_option(:settings_file))
+        @cache_root = build_option(:cache_root)
+        @publish_options = { new: false, confirm: false, stereotype: nil }
+        @instance_manager = ::Avm::Launcher::Context::InstanceManager.new(self)
+        @recache = false
+      end
+
+      def instance(name)
+        instances.find { |i| i.name == name }
+      end
+
+      def instances
+        @instance_manager.instances
+      end
+
+      def pending_instances
+        @instance_manager.pending_instances
+      end
+
+      private
+
+      def build_option(key)
+        @options[key] || config_option(key) || default_option(key)
+      end
+
+      def config_option(key)
+        ::Avm::Self::Instance.default.entry([CONFIG_PATH_PREFIX, key].join('.')).optional_value
+      end
+
+      def default_cache_root
+        ::Avm::Tools::Self.application.cache_dir.join('launcher')
+      end
+
+      def default_option(key)
+        send("default_#{key}".underscore)
+      end
+
+      def default_projects_root
+        '.'
+      end
+
+      def default_settings_file
+        ::Avm::Tools::Self.application.config_dir.join('launcher.yaml')
+      end
+
+      def projects_uncached
+        r = {}
+        instances.each do |i|
+          r[i.project_name] ||= []
+          r[i.project_name] << i
+        end
+        r.map { |name, instances| ::Avm::Launcher::Project.new(name, instances) }
+      end
+    end
+  end
+end

data/lib/avm/launcher/instances/base/cache.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Avm
+  module Launcher
+    module Instances
+      module Base
+        module Cache
+          def cache_path(subpath)
+            File.join(cache_root, subpath)
+          end
+
+          def cache_key(key, &block)
+            v = cache_key_get(key)
+            return v if v.present? || block.nil?
+
+            v = yield
+            cache_key_write(key, v)
+            v
+          end
+
+          private
+
+          def cache_key_get(key)
+            File.file?(cache_key_path(key)) ? File.read(cache_key_path(key)) : nil
+          end
+
+          def cache_key_write(key, value)
+            FileUtils.mkdir_p(File.dirname(cache_key_path(key)))
+            File.write(cache_key_path(key), value)
+          end
+
+          def cache_key_path(key)
+            File.join(cache_root, 'keys', key.parameterize)
+          end
+
+          def cache_root
+            File.join(::Avm::Launcher::Context.current.cache_root, name.parameterize)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative 'base/cache'
+require 'avm/launcher/errors/non_project'
+require 'eac_ruby_utils/speaker/sender'
+
+module Avm
+  module Launcher
+    module Instances
+      module Base
+        class << self
+          def extend_object(object)
+            object.extend ::EacRubyUtils::SimpleCache
+            object.extend ::EacRubyUtils::Speaker::Sender
+            object.extend ::Avm::Launcher::Instances::Base::Cache
+            super
+          end
+
+          def instanciate(path, parent)
+            unless path.is_a?(::Avm::Launcher::Instances::Base)
+              raise ::Avm::Launcher::Errors::NonProject, path unless path.project?
+
+              path.extend(::Avm::Launcher::Instances::Base)
+              path.parent = parent
+            end
+            path
+          end
+        end
+
+        attr_accessor :parent
+
+        def name
+          logical
+        end
+
+        def stereotype?(stereotype)
+          stereotypes.include?(stereotype)
+        end
+
+        def to_parent_path
+          return self unless @parent
+
+          logical.gsub(/\A#{Regexp.quote(@parent.logical)}/, '')
+        end
+
+        def project?
+          stereotypes.any?
+        end
+
+        def publish_run
+          stereotypes.each do |s|
+            next unless publish?(s)
+
+            infov(name, "publishing #{s.label}")
+            s.publish_class.new(self).run
+          end
+        end
+
+        def publish_check
+          stereotypes.each do |s|
+            next unless publish?(s)
+
+            puts "#{name.to_s.cyan}|#{s.label}|" \
+              "#{s.publish_class.new(self).check}"
+          end
+        end
+
+        def project_name
+          ::File.basename(logical)
+        end
+
+        def included?
+          !::Avm::Launcher::Context.current.settings.excluded_projects.include?(project_name)
+        end
+
+        def to_h
+          super.to_h.merge(parent: parent ? parent.logical : nil)
+        end
+
+        private
+
+        def publish?(stereotype)
+          return false unless stereotype.publish_class
+          return false unless options.stereotype_publishable?(stereotype)
+
+          filter = ::Avm::Launcher::Context.current.publish_options[:stereotype]
+          filter.blank? ? true : filter == stereotype.name.demodulize
+        end
+
+        def options_uncached
+          ::Avm::Launcher::Context.current.settings.instance_settings(self)
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/instances/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Avm
+  module Launcher
+    module Instances
+      class Error < StandardError
+      end
+    end
+  end
+end

data/lib/avm/launcher/instances/runner_helper.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/context'
+require 'avm/tools/core_ext'
+require 'avm/launcher/context/instance_collector'
+
+module Avm
+  module Launcher
+    module Instances
+      module RunnerHelper
+        common_concern do
+          runner_definition do
+            bool_opt '--all', 'Select all instances.'
+            bool_opt '--pending', 'Select pending instances.'
+            bool_opt '--recache', 'Rewrite instances cache.'
+          end
+
+          set_callback :run, :before, :setup_cache
+        end
+
+        def context
+          @context ||= ::Avm::Launcher::Context.current
+        end
+
+        def instances
+          collector = ::Avm::Launcher::Context::InstanceCollector.new(context)
+          collector.add_all if parsed.all?
+          collector.add_pending if parsed.pending?
+          parsed.instance_path.flat_map { |p| collector.add_path(p) }
+          collector.instances
+        end
+
+        def instance_stereotypes(instance)
+          instance.stereotypes.map(&:label).join(', ')
+        end
+
+        def instance_label(instance)
+          "#{instance.name} [#{instance_stereotypes(instance)}]"
+        end
+
+        def setup_cache
+          ::Avm::Launcher::Context.current.recache = parsed.recache?
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/instances/settings.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Launcher
+    module Instances
+      class Settings
+        DEFAULT_CURRENT_REVISION = 'origin/master'
+        DEFAULT_PUBLISH_REMOTE = 'publish'
+        PUBLISHABLE_KEY = :publishable
+
+        common_constructor :data do
+          self.data = (data.is_a?(Hash) ? data : {}).with_indifferent_access
+        end
+
+        def git_current_revision
+          data[__method__] || DEFAULT_CURRENT_REVISION
+        end
+
+        def git_publish_remote
+          data[__method__] || DEFAULT_PUBLISH_REMOTE
+        end
+
+        def publishable?
+          publishable_value ? true : false
+        end
+
+        def stereotype_publishable?(stereotype)
+          return publishable? unless publishable_value.is_a?(::Hash)
+
+          parse_publishable_value(publishable_value[stereotype.stereotype_name], true)
+        end
+
+        private
+
+        def publishable_value
+          parse_publishable_value(data[PUBLISHABLE_KEY], false)
+        end
+
+        def parse_publishable_value(value, hash_to_true)
+          return value.with_indifferent_access if parse_publishable_value_hash?(value, hash_to_true)
+          return true if value.nil? || value == true
+          return false if value == false
+
+          value ? true : false
+        end
+
+        def parse_publishable_value_hash?(value, hash_to_true)
+          !hash_to_true && value.is_a?(::Hash)
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/paths/logical.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'avm/projects/stereotypes'
+require 'avm/launcher/paths/real'
+
+module Avm
+  module Launcher
+    module Paths
+      class Logical
+        include ::Comparable
+        include ::EacRubyUtils::SimpleCache
+
+        class << self
+          def from_h(context, hash)
+            parent_path = hash[:parent_path] ? from_h(context, hash[:parent_path]) : nil
+            new(context, parent_path, hash[:real], hash[:logical])
+          end
+        end
+
+        attr_reader :context, :real, :logical, :parent_path
+
+        def initialize(context, parent_path, real, logical)
+          @context = context
+          @parent_path = parent_path
+          @real = ::Avm::Launcher::Paths::Real.new(real)
+          @logical = logical
+        end
+
+        def <=>(other)
+          [logical, real] <=> [other.logical, other.real]
+        end
+
+        def to_s
+          logical
+        end
+
+        def to_h
+          { logical: logical, real: real.to_s, parent_path: parent_path ? parent_path.to_h : nil }
+        end
+
+        def project?
+          stereotypes.any?
+        end
+
+        def children
+          r = []
+          Dir.entries(warped).each do |c|
+            c_path = ::File.join(warped, c)
+            next unless ::File.directory?(c_path)
+            next if c.start_with?('.')
+
+            r << build_child(c)
+          end
+          r
+        end
+
+        def included?
+          !context.settings.excluded_paths.include?(logical)
+        end
+
+        private
+
+        def stereotypes_uncached
+          ::Avm::Projects::Stereotype.stereotypes.select { |s| s.match?(self) }
+        end
+
+        def build_child(name)
+          ::Avm::Launcher::Paths::Logical.new(
+            context,
+            self,
+            ::File.join(warped, name),
+            ::File.join(logical, name)
+          )
+        end
+
+        def warped_uncached
+          if is_a?(::Avm::Launcher::Instances::Base)
+            stereotypes.each do |s|
+              return s.warp_class.new(self) if s.warp_class
+            end
+          end
+          real
+        end
+      end
+    end
+  end
+end

data/lib/avm/launcher/publish/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/errors/base'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Launcher
+    module Publish
+      class Base
+        common_constructor :instance
+
+        def run
+          s = check
+          info("Check: #{s}")
+          return unless s.status == ::Avm::Launcher::Publish::CheckResult::STATUS_PENDING
+
+          publish
+        end
+
+        def check
+          s = check_with_rescue
+          ::Avm::Launcher::Context.current.instance_manager.publish_state_set(
+            instance, stereotype.stereotype_name, s.status
+          )
+          s
+        end
+
+        private
+
+        def stereotype
+          self.class.name.deconstantize.constantize
+        end
+
+        def check_with_rescue
+          internal_check
+        rescue ::Avm::Launcher::Errors::Base => e
+          ::Avm::Launcher::Publish::CheckResult.blocked("Error: #{e}")
+        rescue ::Avm::Launcher::Git::Error => e
+          ::Avm::Launcher::Publish::CheckResult.blocked("Git error: #{e}")
+        end
+      end
+    end
+  end
+end

data/lib/avm/registry.rb

@@ -10,8 +10,6 @@ module Avm
     lists.add_symbol :category, :application_stereotypes, :instances, :runners, :scms,
                      :source_generators, :sources
 
-    WITH_PATH = [CATEGORY_SCMS, CATEGORY_SOURCES].freeze
-
     class << self
       enable_simple_cache
 

data/lib/avm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.46.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_cli
@@ -50,20 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: eac_git
   requirement: !ruby/object:Gem::Requirement
@@ -264,9 +258,23 @@ files:
 - lib/avm/instances/docker_image.rb
 - lib/avm/instances/entry_keys.rb
 - lib/avm/instances/runner.rb
+- lib/avm/launcher/context.rb
+- lib/avm/launcher/context/instance_collector.rb
+- lib/avm/launcher/context/instance_discovery.rb
+- lib/avm/launcher/context/instance_manager.rb
+- lib/avm/launcher/context/instance_manager/cached_instance.rb
+- lib/avm/launcher/context/instance_manager/cached_instances.rb
+- lib/avm/launcher/context/settings.rb
 - lib/avm/launcher/errors/base.rb
 - lib/avm/launcher/errors/non_project.rb
+- lib/avm/launcher/instances/base.rb
+- lib/avm/launcher/instances/base/cache.rb
+- lib/avm/launcher/instances/error.rb
+- lib/avm/launcher/instances/runner_helper.rb
+- lib/avm/launcher/instances/settings.rb
+- lib/avm/launcher/paths/logical.rb
 - lib/avm/launcher/paths/real.rb
+- lib/avm/launcher/publish/base.rb
 - lib/avm/launcher/publish/check_result.rb
 - lib/avm/path_string.rb
 - lib/avm/registry.rb