avm 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a5a8832847c76afcae4e76ef3e8f7d1391d7cfb0b13788c3dc7273f9ef879f1
-  data.tar.gz: 0b89bd147edb92e0e3e4d158d16f0995ef41f0544a680beb053f9fa55b96a282
+  metadata.gz: c21e54d17440b61336b3345c8c6f2db32b0d2d31f6f9d56f78894d4f01bbb3c7
+  data.tar.gz: 29604235a823f781751eaf5031b967a1cf01c5d6c14e194c09e7bfaaba8c2043
 SHA512:
-  metadata.gz: a70af189af9aee66a693706ba031e5eb7c6d4c8533144099f325dfe2b88b9ef08daae16de8d2f09857f194816d653d3669527d6bc9c07d173566c9ab9121c3f6
-  data.tar.gz: d66a1741ec6295f54166a2007a4d168eddd4e7de30f538f87329067b580faf2572514d99302bb467e0b408dfe1a44dd54a9e4e2abaaed0292b3a7ba69bb02b95
+  metadata.gz: a3240b4fafbfedcd68581fec71de2099906e599df3adb4f64d4bd66b4ced66582a02ced5db16d47c91ed78eb580daea910c44554d9abfef10ab3b308ff160ab2
+  data.tar.gz: 1104ec38c87bc15499ad0cd3d37ddd9c6ad0075d1c286ecb514a142d62f329e9c83035f23223788a5d5acb41a769e13f394180d84b80591a5035e347107de153

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/data/instance.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module Avm
+  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/git/issue/complete/test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'avm/app_src/configuration'
+require 'avm/sources/configuration'
 require 'avm/result'
 require 'eac_ruby_utils/fs/temp'
 
@@ -36,7 +36,7 @@ module Avm
           end
 
           def configuration_uncached
-            ::Avm::AppSrc::Configuration.find_by_path(@git)
+            ::Avm::Sources::Configuration.find_by_path(@git)
           end
         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/{app_src → sources}/base.rb

@@ -4,7 +4,7 @@ require 'eac_git'
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module AppSrc
+  module Sources
     class Base
       enable_simple_cache
       enable_listable
@@ -16,7 +16,7 @@ module Avm
 
       delegate :to_s, to: :path
 
-      # @return [Avm::AppSrc::Base]
+      # @return [Avm::Sources::Base]
       def parent
         options[OPTION_PARENT]
       end
@@ -28,7 +28,7 @@ module Avm
         path.relative_path_from(parent.path)
       end
 
-      # @return [Enumerable<Avm::AppSrc::Base>]
+      # @return [Enumerable<Avm::Sources::Base>]
       def subs
         git_repo.subrepos
                 .map { |subrepo| self.class.new(subrepo.subpath.expand_path(path), parent: self) }

data/lib/avm/{app_src → sources}/configuration/_locale.rb

@@ -4,7 +4,7 @@ require 'avm/patches/eac_ruby_gems_utils/gem'
 require 'i18n'
 
 module Avm
-  module AppSrc
+  module Sources
     class Configuration < ::EacConfig::OldConfigs
       LOCALE_KEY = :locale
 

data/lib/avm/{app_src → sources}/configuration/_rubocop.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Avm
-  module AppSrc
+  module Sources
     class Configuration < ::EacConfig::OldConfigs
       RUBOCOP_COMMAND_KEY = 'ruby.rubocop.command'
       RUBOCOP_GEMFILE_KEY = 'ruby.rubocop.gemfile'

data/lib/avm/{app_src → sources}/configuration/_tests.rb

@@ -3,7 +3,7 @@
 require 'avm/patches/eac_ruby_gems_utils/gem'
 
 module Avm
-  module AppSrc
+  module Sources
     class Configuration < ::EacConfig::OldConfigs
       BUNDLE_TEST_COMMAND_KEY = 'test.bundle_command'
       TEST_COMMAND_KEY = 'test.command'

data/lib/avm/{app_src → sources}/configuration.rb

@@ -5,7 +5,7 @@ require 'eac_ruby_utils/core_ext'
 require 'yaml'
 
 module Avm
-  module AppSrc
+  module Sources
     class Configuration < ::EacConfig::OldConfigs
       require_sub __FILE__
 

data/lib/avm/{app_src.rb → sources.rb}

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module AppSrc
+  module Sources
     require_sub __FILE__
   end
 end

data/lib/avm/sync.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  class Sync
+    attr_reader :excludes, :includes
+
+    common_constructor :source_path, :target_path do
+      self.source_path = source_path.to_pathname
+      self.target_path = target_path.to_pathname
+      @excludes = []
+      @includes = []
+    end
+
+    def run
+      clear_target
+      copy
+    end
+
+    def add_exclude(exclude)
+      excludes << exclude
+
+      self
+    end
+
+    def add_excludes(*excludes)
+      excludes.each { |exclude| add_exclude(exclude) }
+
+      self
+    end
+
+    def add_include(include)
+      includes << include
+
+      self
+    end
+
+    def add_includes(*includes)
+      includes.each { |include| add_include(include) }
+
+      self
+    end
+
+    def move_mode(value)
+      @move_mode = value
+
+      self
+    end
+
+    def move_mode?
+      @move_mode ? true : false
+    end
+
+    private
+
+    def clear_target
+      target_remove(target_path)
+      target_path.children.each { |tchild| target_remove(tchild) }
+    end
+
+    def copy
+      source_path.children.each do |schild|
+        ::FileUtils.cp_r(schild.to_path, target_path.to_path)
+        schild.rmtree if move_mode?
+      end
+    end
+
+    def source_to_target_path(source_path)
+      source_path.relative_path_from(self.source_path).expand_path(target_path)
+    end
+
+    def target_remove(tpath)
+      return if skip_target_path?(tpath)
+
+      if tpath.directory?
+        tpath.children.each { |tchild| target_remove(tchild) }
+        tpath.rmdir if tpath.children.empty?
+      elsif tpath.file?
+        tpath.unlink
+      end
+    end
+
+    def skip_target_path?(tpath)
+      skip_path?(tpath.relative_path_from(target_path))
+    end
+
+    def skip_path?(relpath)
+      relpath = relpath.expand_path('/')
+      excludes.any? { |exclude| relpath.fnmatch?(exclude) } &&
+        includes.none? { |include| relpath.fnmatch?(include) }
+    end
+  end
+end

data/lib/avm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eduardo H. Bogoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_docker
@@ -161,12 +161,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/avm.rb
-- lib/avm/app_src.rb
-- lib/avm/app_src/base.rb
-- lib/avm/app_src/configuration.rb
-- lib/avm/app_src/configuration/_locale.rb
-- lib/avm/app_src/configuration/_rubocop.rb
-- lib/avm/app_src/configuration/_tests.rb
+- lib/avm/data/instance.rb
+- lib/avm/data/instance/files_unit.rb
+- lib/avm/data/instance/package.rb
+- lib/avm/data/instance/unit.rb
+- lib/avm/data/package.rb
+- lib/avm/data/package/dump.rb
+- lib/avm/data/package/load.rb
+- lib/avm/data/unit.rb
 - lib/avm/docker.rb
 - lib/avm/docker/container.rb
 - lib/avm/docker/image.rb
@@ -239,7 +241,15 @@ files:
 - lib/avm/jobs.rb
 - lib/avm/jobs/base.rb
 - lib/avm/jobs/variables_source.rb
+- lib/avm/path_string.rb
 - lib/avm/result.rb
+- lib/avm/sources.rb
+- lib/avm/sources/base.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/sync.rb
 - lib/avm/version.rb
 - lib/avm/version_number.rb
 homepage: