avm 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 280fbe10e4f6675e6477b280f96ffb9bd5caf5df609ff08bec8cfe8600dada5a
-  data.tar.gz: a84ce459a88b027da9e777de1113a43d0606b5da74735e4201910cb8b24d492e
+  metadata.gz: 47ace344eec41bb800789fa179273a83a4c0e321436c2535aa5e2fe21ed88ef2
+  data.tar.gz: 79a810126ba2b8fcd0596ec87c6094bd6d2f26b0f26d508a1d8dd5c75a0e5a2e
 SHA512:
-  metadata.gz: 1a331ef08d2d6323b65655c2dda06f43c6a2c28102c070ffa73c32b190b1bd257eddf1ff1ea5809c52d983fc4669e61dffd128a91345ac151948a6b79f5cafbe
-  data.tar.gz: a43e4b01aaa402821e241cdf1d95d184b165f9b4322bae204a99b627de28275e239c4ac45197b0c25e32d0903033461725cf57256cd7a7f79030ed48f28e1879
+  metadata.gz: 859a74c8cd03ae21dcdf5bf77d8da05ee00ed41b0562ee4c080c5eab7cd17a234cf96aaeb66848496a1139c0d2a1618c4eeca40b6332440bceacae0a160f4c3e
+  data.tar.gz: f042f3e2be9b952d2d088407431b41514628bb4caa66381330393310bf13d96ad4a19e78682e41cabffd0347b54dd6f7750c5ba4c541932c882efaa33a8491b7

data/lib/avm/data/instance/files_unit.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'avm/data/instance/unit'
+
+module Avm
+  module Data
+    module Instance
+      class FilesUnit < ::Avm::Data::Instance::Unit
+        EXTENSION = '.tar.gz'
+
+        attr_reader :fs_path_subpath
+
+        def initialize(instance, fs_path_subpath)
+          super(instance)
+          @fs_path_subpath = fs_path_subpath
+        end
+
+        before_load :clear_files
+
+        def files_path
+          ::File.join(instance.read_entry(::Avm::Instances::EntryKeys::FS_PATH), fs_path_subpath)
+        end
+
+        def dump_command
+          instance.host_env.command('tar', '-czf', '-', '-C', files_path, '.')
+        end
+
+        def load_command
+          instance.host_env.command('tar', '-xzf', '-', '-C', files_path)
+        end
+
+        def clear_files
+          infom "Removing all files under #{files_path}..."
+          instance.host_env.command('mkdir', '-p', files_path).execute!
+          instance.host_env.command('find', files_path, '-mindepth', 1, '-delete').execute!
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/instance/package.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'avm/data/package'
+
+module Avm
+  module Data
+    module Instance
+      class Package < ::Avm::Data::Package
+        attr_reader :instance
+
+        def initialize(instance, options = {})
+          @instance = instance
+          super options
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/instance/unit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'avm/data/unit'
+
+module Avm
+  module Data
+    module Instance
+      class Unit < ::Avm::Data::Unit
+        attr_reader :instance
+
+        def initialize(instance)
+          @instance = instance
+        end
+      end
+    end
+  end
+end

data/lib/avm/{git/issue.rb → data/instance.rb}

@@ -4,8 +4,8 @@ require 'eac_ruby_utils/require_sub'
 ::EacRubyUtils.require_sub(__FILE__)
 
 module Avm
-  module Git
-    module Issue
+  module Data
+    module Instance
     end
   end
 end

data/lib/avm/data/package/dump.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'avm/tools/core_ext'
+require 'avm/files/rotate'
+require 'minitar'
+
+module Avm
+  module Data
+    class Package
+      class Dump
+        enable_speaker
+        enable_listable
+
+        DEFAULT_EXPIRE_TIME = 1.day
+        DEFAULT_FILE_EXTENSION = '.tar'
+
+        attr_reader :package, :data_file_path, :existing
+
+        lists.add_string :existing, :denied, :overwrite, :rotate, :rotate_expired
+
+        def initialize(package, data_file_path, options = {})
+          @package = package
+          @data_file_path = data_file_path
+          options = options.to_options_consumer
+          @existing, @expire_time = options.consume(:existing, :expire_time)
+          options.validate
+          self.class.lists.existing.value_validate!(@existing)
+        end
+
+        def runnable?
+          cannot_run_reason.blank?
+        end
+
+        def cannot_run_reason
+          return nil if !data_file_exist? ||
+                        [EXISTING_OVERWRITE, EXISTING_ROTATE].include?(existing)
+
+          if existing == EXISTING_DENIED
+            'Data exist and overwriting is denied'
+          elsif existing == EXISTING_ROTATE_EXPIRED && !data_file_expired?
+            'Data exist and yet is not expired'
+          end
+        end
+
+        def run
+          raise "Cannot run: #{cannot_run_reason}" unless runnable?
+
+          build_dir = dump_units_to_build_directory
+          package_file = create_package_file(build_dir)
+          rotate
+          move_download_to_final_dest(package_file)
+        end
+
+        def data_file_exist?
+          ::File.exist?(data_file_path)
+        end
+
+        def data_file_time
+          data_file_exist? ? ::Time.now - ::File.mtime(data_file_path) : nil
+        end
+
+        def data_file_expired?
+          data_file_time.if_present(false) { |v| v >= expire_time }
+        end
+
+        def expire_time
+          @expire_time || DEFAULT_EXPIRE_TIME
+        end
+
+        private
+
+        def download
+          infom 'Downloading dump...'
+          download_path = find_download_path
+          dump_command.system!(output_file: download_path)
+          fatal_error "File \"#{download_path}\" not saved" unless ::File.exist?(download_path)
+          fatal_error "File \"#{download_path}\" is empty" if ::File.zero?(download_path)
+          download_path
+        end
+
+        def move_download_to_final_dest(download_path)
+          ::FileUtils.mkdir_p(::File.dirname(data_file_path))
+          ::FileUtils.mv(download_path, data_file_path)
+        end
+
+        def rotate
+          return unless data_file_exist?
+          return unless existing == EXISTING_ROTATE
+
+          infom "Rotating \"#{data_file_path}\"..."
+          ::Avm::Files::Rotate.new(data_file_path).run
+        end
+
+        def new_build_path
+          f = ::Tempfile.new(self.class.name.parameterize + '-download')
+          path = f.path
+          f.close
+          f.unlink
+          path
+        end
+
+        def dump_units_to_build_directory
+          dir = ::Dir.mktmpdir
+          package.dump_units_to_directory(dir)
+          dir
+        end
+
+        def create_package_file(build_dir)
+          package_path = new_build_path
+          infom "Creating package \"#{package_path}\" from \"#{build_dir}\"..."
+          Dir.chdir(build_dir) do
+            ::Minitar.pack('.', File.open(::File.expand_path(package_path), 'wb'))
+          end
+          package_path
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/package/load.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'minitar'
+
+module Avm
+  module Data
+    class Package
+      class Load
+        enable_speaker
+
+        attr_reader :package, :data_file_path
+
+        def initialize(package, data_file_path)
+          @package = package
+          @data_file_path = data_file_path
+        end
+
+        def runnable?
+          cannot_run_reason.blank?
+        end
+
+        def cannot_run_reason
+          return nil if data_file_exist?
+
+          "Data file \"#{data_file_path}\" does not exist"
+        end
+
+        def run
+          raise "Cannot run: #{cannot_run_reason}" unless runnable?
+
+          build_dir = extract_packages_to_build_directory
+          package.load_units_from_directory(build_dir)
+        end
+
+        def data_file_exist?
+          ::File.exist?(data_file_path)
+        end
+
+        def extract_packages_to_build_directory
+          dir = ::Dir.mktmpdir
+          ::Minitar.unpack(data_file_path, dir)
+          dir
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/package.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'avm/data/package/dump'
+require 'avm/data/package/load'
+
+module Avm
+  module Data
+    class Package
+      attr_reader :units
+
+      def initialize(options)
+        @units = {}
+        options = options.to_options_consumer
+        units = options.consume(:units)
+        options.validate
+        units.if_present do |v|
+          v.each { |identifier, unit| add_unit(identifier, unit) }
+        end
+      end
+
+      def add_unit(identifier, unit)
+        @units[identifier.to_sym] = unit
+      end
+
+      def dump(data_path, options = {})
+        ::Avm::Data::Package::Dump.new(self, data_path, options)
+      end
+
+      def load(data_path)
+        ::Avm::Data::Package::Load.new(self, data_path)
+      end
+
+      def dump_units_to_directory(directory)
+        @units.each { |identifier, unit| unit.dump_to_directory(directory, identifier) }
+      end
+
+      def load_units_from_directory(directory)
+        @units.each { |identifier, unit| unit.load_from_directory(directory, identifier) }
+      end
+    end
+  end
+end

data/lib/avm/data/unit.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'active_support/callbacks'
+
+module Avm
+  module Data
+    class Unit
+      include ::ActiveSupport::Callbacks
+
+      define_callbacks :dump, :load
+      enable_speaker
+
+      %w[dump load].each do |action|
+        method_name = "#{action}_command"
+        class_eval <<~CODE, __FILE__, __LINE__ + 1
+          # Should be overrided.
+          # @return [EacRubyUtils::Envs::Command]
+          def #{method_name}
+            fail "\\"#{method_name}\\" is a abstract method. Override in #{singleton_class}."
+          end
+        CODE
+
+        # Callbacks
+        %w[before after].each do |callback|
+          method = "#{callback}_#{action}"
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
+            def self.#{method}(callback_method = nil, &block)
+              if callback_method
+                set_callback :#{action}, :#{callback}, callback_method
+              else
+                set_callback :#{action}, :#{callback}, &block
+              end
+              self
+            end
+
+            def #{method}(callback_method = nil, &block)
+              singleton_class.#{method}(callback_method, &block)
+              self
+            end
+          CODE
+        end
+      end
+
+      def extension
+        singleton_class.const_get('EXTENSION')
+      rescue NameError
+        ''
+      end
+
+      def name
+        self.class
+      end
+
+      def load_from_directory(directory, identifier)
+        load(unit_on_directory_path(directory, identifier))
+      end
+
+      def dump_to_directory(directory, identifier)
+        dump(unit_on_directory_path(directory, identifier))
+      end
+
+      def dump(data_path)
+        run_callbacks :dump do
+          infom "Dumping unit \"#{name}\" to \"#{data_path}\"..."
+          do_dump(data_path)
+        end
+      end
+
+      def load(data_path)
+        run_callbacks :load do
+          infom "Loading unit \"#{name}\" from \"#{data_path}\"..."
+          do_load(data_path)
+        end
+      end
+
+      protected
+
+      def do_dump(data_path)
+        dump_command.execute!(output_file: data_path)
+      end
+
+      def do_load(data_path)
+        load_command.execute!(input_file: data_path)
+      end
+
+      private
+
+      def unit_on_directory_path(directory, identifier)
+        ::File.join(directory, "#{identifier}#{extension}")
+      end
+    end
+  end
+end

data/lib/avm/jobs/base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'avm/jobs/variables_source'
+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

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

data/lib/avm/{git/organize.rb → jobs.rb}

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

data/lib/avm/path_string.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+module Avm
+  # String with paths like PATH variable.
+  # Note: the separator is not system dependent.
+  class PathString < String
+    SEPARATOR = ':'
+
+    class << self
+      # Shortcut for [Avm::Paths.new(string).paths].
+      def paths(string)
+        new(string).paths
+      end
+    end
+
+    def initialize(string = nil)
+      super(string.to_s)
+    end
+
+    # @return [Array] List of paths. Blank paths are rejected.
+    def paths
+      split(SEPARATOR).reject(&:blank?)
+    end
+  end
+end

data/lib/avm/registry/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/gems_registry'
+
+module Avm
+  module Registry
+    class Base
+      enable_simple_cache
+      common_constructor :module_suffix
+
+      def detect(*registered_initialize_args)
+        detect_optional(*registered_initialize_args) ||
+          raise("No registered module valid for #{registered_initialize_args}" \
+            " (Module suffix: #{module_suffix})")
+      end
+
+      def detect_optional(*registered_initialize_args)
+        registered_modules.lazy.map { |klass| klass.new(*registered_initialize_args) }
+                          .find(&:valid?)
+      end
+
+      def provider_module_suffix
+        "#{module_suffix}::Provider"
+      end
+
+      def single_module_suffix
+        "#{module_suffix}::Base"
+      end
+
+      def to_s
+        "#{self.class}[#{module_suffix}]"
+      end
+
+      def valid_registered_module?(a_module)
+        a_module.is_a?(::Class) && !a_module.abstract?
+      end
+
+      private
+
+      def registered_modules_uncached
+        (single_registered_modules + provider_registered_modules)
+          .select { |v| valid_registered_module?(v) }.uniq.sort_by { |s| [s.name] }
+      end
+
+      def single_registered_modules
+        single_instance_registry.registered.map(&:registered_module)
+      end
+
+      def provider_registered_modules
+        provider_registry.registered.map(&:registered_module).flat_map do |provider_class|
+          provider_class.new.all
+        end
+      end
+
+      def single_instance_registry_uncached
+        ::EacRubyUtils::GemsRegistry.new(single_module_suffix)
+      end
+
+      def provider_registry_uncached
+        ::EacRubyUtils::GemsRegistry.new(provider_module_suffix)
+      end
+    end
+  end
+end

data/lib/avm/registry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/gems_registry'
+
+module Avm
+  module Registry
+    require_sub __FILE__
+    enable_listable
+    lists.add_symbol :category, :instance_stereotypes, :scms, :source_stereotypes
+
+    class << self
+      enable_simple_cache
+
+      # @return [Array<Avm::Registry::Base>]
+      def registries
+        lists.category.values.map { |c| send(c) }
+      end
+
+      private
+
+      ::Avm::Registry.lists.category.each_value do |category|
+        define_method "#{category}_uncached" do
+          ::Avm::Registry::Base.new(category.to_s.camelize)
+        end
+      end
+    end
+  end
+end

data/lib/avm/rspec/setup.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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
+
+      def setup_in_avm_registry_example
+        require 'avm/rspec/shared_examples/in_avm_registry'
+      end
+
+      def setup_not_in_avm_registry_example
+        require 'avm/rspec/shared_examples/not_in_avm_registry'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+
+::RSpec.shared_examples 'in_avm_registry' do |registry_method|
+  let(:avm_registry) { ::Avm::Registry.send(registry_method) }
+
+  it 'is in the avm registry' do
+    expect(avm_registry.registered_modules).to include(described_class)
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+
+::RSpec.shared_examples 'not_in_avm_registry' do |registry_method = nil|
+  registry_method.if_present(::Avm::Registry.registries) { |v| [::Avm::Registry.send(v)] }
+                 .each do |registry|
+    context "when registry is #{registry}" do
+      it 'is not in the avm registry' do
+        expect(registry.registered_modules).not_to include(described_class)
+      end
+    end
+  end
+end

data/lib/avm/rspec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Rspec
+    require_sub __FILE__
+  end
+end