avm-tools 0.113.1 → 0.113.5

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/command/extra_options.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    class Command
+      module ExtraOptions
+        def chdir(dir)
+          duplicate_by_extra_options(chdir: dir)
+        end
+
+        def status_result(status_code, result)
+          duplicate_by_extra_options(status_results: status_results.merge(status_code => result))
+        end
+
+        private
+
+        attr_reader :extra_options
+
+        def status_results
+          extra_options[:status_results] ||= {}.with_indifferent_access
+        end
+
+        def append_chdir(command)
+          extra_options[:chdir].present? ? "(cd '#{extra_options[:chdir]}' ; #{command} )" : command
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/command.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs/process'
+require 'eac_ruby_utils/envs/spawn'
+require 'pp'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    class Command
+      require_sub __FILE__, include_modules: true
+
+      def initialize(env, command, extra_options = {})
+        @env = env
+        @extra_options = extra_options.with_indifferent_access
+        if command.count == 1 && command.first.is_a?(Array)
+          @command = command.first
+        elsif command.is_a?(Array)
+          @command = command
+        else
+          raise "Invalid argument command: #{command}|#{command.class}"
+        end
+      end
+
+      def args
+        @command
+      end
+
+      def append(args)
+        duplicate_by_command(@command + args)
+      end
+
+      def prepend(args)
+        duplicate_by_command(args + @command)
+      end
+
+      def to_s
+        "#{@command} [ENV: #{@env}]"
+      end
+
+      def command(options = {})
+        c = @command
+        c = c.map { |x| escape(x) }.join(' ') if c.is_a?(Enumerable)
+        append_command_options(
+          @env.command_line(
+            append_chdir(append_concat(append_envvars(c)))
+          ),
+          options
+        )
+      end
+
+      def execute!(options = {})
+        options[:exit_outputs] = status_results.merge(options[:exit_outputs].presence || {})
+        er = ExecuteResult.new(execute(options), options)
+        return er.result if er.success?
+
+        raise "execute! command failed: #{self}\n#{er.r.pretty_inspect}"
+      end
+
+      def execute(options = {})
+        c = command(options)
+        debug_print("BEFORE: #{c}")
+        t1 = Time.now
+        r = ::EacRubyUtils::Envs::Process.new(c).to_h
+        i = Time.now - t1
+        debug_print("AFTER [#{i}]: #{c}")
+        r
+      end
+
+      def spawn(options = {})
+        c = command(options)
+        debug_print("SPAWN: #{c}")
+        ::EacRubyUtils::Envs::Spawn.new(c)
+      end
+
+      def system!(options = {})
+        return if system(options)
+
+        raise "system! command failed: #{self}"
+      end
+
+      def system(options = {})
+        c = command(options)
+        debug_print(c)
+        Kernel.system(c)
+      end
+
+      protected
+
+      def duplicate(command, extra_options)
+        self.class.new(@env, command, extra_options)
+      end
+
+      private
+
+      attr_reader :extra_options
+
+      def duplicate_by_command(new_command)
+        duplicate(new_command, @extra_options)
+      end
+
+      def duplicate_by_extra_options(set_extra_options)
+        duplicate(@command, @extra_options.merge(set_extra_options))
+      end
+
+      def debug?
+        ENV['DEBUG'].to_s.strip != ''
+      end
+
+      # Print a message if debugging is enabled.
+      def debug_print(message)
+        message = message.to_s
+        puts message.if_respond(:light_red, message) if debug?
+      end
+
+      def append_command_options(command, options)
+        command = options[:input].command + ' | ' + command if options[:input]
+        if options[:input_file]
+          command = "cat #{Shellwords.escape(options[:input_file])}" \
+            " | #{command}"
+        end
+        command += ' > ' + Shellwords.escape(options[:output_file]) if options[:output_file]
+        command
+      end
+
+      def escape(arg)
+        arg = arg.to_s
+        m = /^\@ESC_(.+)$/.match(arg)
+        m ? m[1] : Shellwords.escape(arg)
+      end
+
+      class ExecuteResult
+        attr_reader :r, :options
+
+        def initialize(result, options)
+          @r = result
+          @options = options
+        end
+
+        def result
+          return exit_code_zero_result if exit_code_zero?
+          return expected_error_result if expected_error?
+
+          raise 'Failed!'
+        end
+
+        def success?
+          exit_code_zero? || expected_error?
+        end
+
+        private
+
+        def exit_code_zero?
+          r[:exit_code]&.zero?
+        end
+
+        def exit_code_zero_result
+          r[options[:output] || :stdout]
+        end
+
+        def expected_error_result
+          options[:exit_outputs][r[:exit_code]]
+        end
+
+        def expected_error?
+          options[:exit_outputs].is_a?(Hash) && options[:exit_outputs].key?(r[:exit_code])
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/executable.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/simple_cache'
+
+module EacRubyUtils
+  module Envs
+    class Executable
+      include ::EacRubyUtils::SimpleCache
+
+      attr_reader :env, :name, :check_args
+
+      def initialize(env, name, *check_args)
+        @env = env
+        @name = name
+        @check_args = check_args
+      end
+
+      def exist?
+        exist
+      end
+
+      def validate
+        return nil if exist?
+
+        "Program \"#{::Shellwords.join(executable_args)}\" not found in environment #{env}"
+      end
+
+      def validate!
+        message = validate
+
+        raise ProgramNotFoundError, message if message
+      end
+
+      def command(*command_args)
+        validate!
+        env.command(*executable_args, *command_args)
+      end
+
+      def executable_args
+        executable_args_from_envvar || [name]
+      end
+
+      def executable_args_envvar
+        "#{name}_command".variableize.upcase
+      end
+
+      def executable_args_from_envvar
+        ENV[executable_args_envvar].if_present { |v| ::Shellwords.split(v) }
+      end
+
+      private
+
+      def exist_uncached
+        env.command(*executable_args, *check_args).execute!
+        true
+      rescue Errno::ENOENT
+        false
+      end
+
+      class ProgramNotFoundError < ::StandardError; end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/file.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Envs
+    class File
+      attr_reader :env, :path
+
+      def initialize(env, path)
+        @env = env
+        @path = path
+      end
+
+      def exist?
+        env.command('stat', path).execute[:exit_code].zero?
+      end
+
+      def read
+        env.command('cat', path).execute!
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/local_env.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/envs/base_env'
+
+module EacRubyUtils
+  module Envs
+    class LocalEnv < ::EacRubyUtils::Envs::BaseEnv
+      def to_s
+        'LOCAL'
+      end
+
+      def command_line(line)
+        line
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/process.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module EacRubyUtils
+  module Envs
+    class Process
+      def initialize(command)
+        @data = { command: command }
+        @data[:stdout], @data[:stderr], @data[:exit_code] = Open3.capture3(command)
+        @data[:exit_code] = @data[:exit_code].to_i
+      end
+
+      def to_h
+        @data.dup
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/spawn.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Envs
+    class Spawn
+      attr_reader :command, :pid
+
+      def initialize(command)
+        @command = command
+        @pid = ::Process.spawn(command)
+      end
+
+      def kill(signal)
+        ::Process.kill(signal, pid)
+      end
+
+      def kill_at_end(&block)
+        block.call(self)
+      ensure
+        kill('KILL')
+      end
+
+      def to_h
+        { command: command, pid: pid }
+      end
+
+      def wait
+        ::Process.wait pid
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/ssh_env/dasho_options.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/module/common_concern'
+require 'eac_ruby_utils/patches/module/simple_cache'
+
+module EacRubyUtils
+  module Envs
+    class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      module DashoOptions
+        common_concern
+
+        module ClassMethods
+          def add_nodasho_option(name)
+            return if nodasho_options.include?(name)
+
+            nodasho_options << name
+            const_set("#{name.underscore}_option".upcase, name)
+          end
+
+          def nodasho_options
+            @nodasho_options ||= []
+          end
+        end
+
+        module InstanceMethods
+          def ssh_command_line_dasho_args
+            r = []
+            uri.query_values&.each do |k, v|
+              r += ['-o', "#{k}=#{v}"] unless nodasho_options.include?(k)
+            end
+            r
+          end
+
+          def ssh_command_line_nodasho_args
+            nodasho_options.flat_map do |option_name|
+              uri_query_value(option_name).if_present([]) do |option_value|
+                send("ssh_command_line_#{option_name.underscore}_args", option_value)
+              end
+            end
+          end
+
+          def nodasho_options
+            self.class.nodasho_options
+          end
+
+          def uri_query_value(name)
+            uri.query_values.if_present { |v| v[name] }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/ssh_env/identity_file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'eac_ruby_utils/envs/ssh_env/dasho_options'
+require 'eac_ruby_utils/listable'
+require 'eac_ruby_utils/patches/object/if_present'
+
+module EacRubyUtils
+  module Envs
+    class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      module IdentityFile
+        extend ::ActiveSupport::Concern
+
+        included do
+          include ::EacRubyUtils::Envs::SshEnv::DashoOptions
+          add_nodasho_option('IdentityFile')
+        end
+
+        def ssh_command_line_identity_file_args(value)
+          ['-i', value]
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/ssh_env/quiet.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'eac_ruby_utils/boolean'
+require 'eac_ruby_utils/envs/ssh_env/dasho_options'
+
+module EacRubyUtils
+  module Envs
+    class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      module Quiet
+        extend ::ActiveSupport::Concern
+
+        included do
+          include ::EacRubyUtils::Envs::SshEnv::DashoOptions
+          add_nodasho_option('Quiet')
+        end
+
+        def ssh_command_line_quiet_args(value)
+          ::EacRubyUtils::Boolean.parse(value) ? ['-q'] : []
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/ssh_env/terminal.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'eac_ruby_utils/envs/ssh_env/dasho_options'
+require 'eac_ruby_utils/listable'
+require 'eac_ruby_utils/patches/object/if_present'
+
+module EacRubyUtils
+  module Envs
+    class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      module Terminal
+        extend ::ActiveSupport::Concern
+
+        included do
+          include ::EacRubyUtils::Envs::SshEnv::DashoOptions
+          add_nodasho_option('Terminal')
+          include ::EacRubyUtils::Listable
+          lists.add_string :terminal_option, :auto, :disable, :enable, :force
+        end
+
+        def ssh_command_line_terminal_args(value)
+          self.class.lists.terminal_option.value_validate!(value)
+          case value
+          when TERMINAL_OPTION_AUTO then ENV['TERM'].present? ? %w[-t] : []
+          when TERMINAL_OPTION_DISABLE then ['-T']
+          when TERMINAL_OPTION_ENABLE then ['-t']
+          when TERMINAL_OPTION_FORCE then ['-tt']
+          else raise "Invalid conditional branch: #{value}"
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs/ssh_env.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'eac_ruby_utils/envs/base_env'
+require 'eac_ruby_utils/patches/object/if_present'
+require 'eac_ruby_utils/patches/module/require_sub'
+require 'net/ssh'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      require_sub __FILE__, include_modules: true
+
+      USER_PATTERN = /[a-z_][a-z0-9_-]*/.freeze
+      HOSTNAME_PATTERN = /[^@]+/.freeze
+      USER_HOSTNAME_PATTERN = /\A(?:(#{USER_PATTERN})@)?(#{HOSTNAME_PATTERN})\z/.freeze
+
+      class << self
+        def parse_uri(uri)
+          uri_by_url(uri) || uri_by_user_hostname(uri) || raise("URI has no SSH scheme: #{uri}")
+        end
+
+        private
+
+        def uri_by_url(url)
+          r = ::Addressable::URI.parse(url)
+          r.scheme == 'ssh' && r.host.present? ? r : nil
+        end
+
+        def uri_by_user_hostname(user_hostname)
+          m = USER_HOSTNAME_PATTERN.match(user_hostname)
+          m ? ::Addressable::URI.new(scheme: 'ssh', host: m[2], user: m[1]) : nil
+        rescue Addressable::URI::InvalidURIError
+          nil
+        end
+      end
+
+      attr_reader :uri
+
+      def initialize(uri)
+        @uri = self.class.parse_uri(uri).freeze
+      end
+
+      def to_s
+        uri.to_s
+      end
+
+      def command_line(line)
+        "#{ssh_command_line} #{Shellwords.escape(line)}"
+      end
+
+      private
+
+      def ssh_command_line
+        (%w[ssh] +
+          %w[nodasho dasho port].flat_map { |m| send("ssh_command_line_#{m}_args") } +
+          [user_hostname_uri])
+          .map { |a| Shellwords.escape(a) }.join(' ')
+      end
+
+      def ssh_command_line_port_args
+        uri.port.if_present([]) do |v|
+          ['-p', v]
+        end
+      end
+
+      def user_hostname_uri
+        r = uri.host
+        r = "#{uri.user}@#{r}" if uri.user.present?
+        r
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/envs.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/envs/base_env'
+require 'eac_ruby_utils/envs/command'
+require 'eac_ruby_utils/envs/file'
+require 'eac_ruby_utils/envs/local_env'
+require 'eac_ruby_utils/envs/process'
+require 'eac_ruby_utils/envs/ssh_env'
+require 'eac_ruby_utils/envs/executable'
+
+module EacRubyUtils
+  module Envs
+    class << self
+      def local
+        @local ||= ::EacRubyUtils::Envs::LocalEnv.new
+      end
+
+      def ssh(user_hostname)
+        ::EacRubyUtils::Envs::SshEnv.new(user_hostname)
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/fs/clearable_directory.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+module EacRubyUtils
+  module Fs
+    class ClearableDirectory < ::Pathname
+      CLEARABLE_BASENAME = '.clearable_directory'
+
+      def clear
+        validate_clearable
+        directory? ? clear_directory : clear_no_directory
+        mkpath
+        ::FileUtils.touch(clearable_note_file.to_path)
+        self
+      end
+
+      def clearable?
+        clearable_negate_message ? true : false
+      end
+
+      def clearable_negate_message
+        return if !exist? || empty?
+        return "Path \"#{self}\" exists, is not empty and is not a directory" unless directory?
+        return if clearable_note_file.exist?
+
+        "Directory \"#{self}\" is not empty and does not have a #{CLEARABLE_BASENAME} file"
+      end
+
+      def clearable_note_file
+        join(CLEARABLE_BASENAME)
+      end
+
+      def validate_clearable
+        message = clearable_negate_message
+        raise message if message
+      end
+
+      private
+
+      def clear_directory
+        children.each do |child|
+          if child.directory?
+            child.rmtree
+          elsif child.file?
+            child.unlink
+          end
+        end
+      end
+
+      def clear_no_directory
+        ::FileUtils.rm_rf(to_path)
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/fs/extname.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Fs
+    class << self
+      # A [File.extname] which find multiple extensions (Ex.: .tar.gz).
+      def extname(path, limit = -1)
+        recursive_extension(::File.basename(path), limit)
+      end
+
+      # Shortcut to +extname(2)+.
+      def extname2(path)
+        extname(path, 2)
+      end
+
+      private
+
+      def recursive_extension(basename, limit)
+        return '' if limit.zero?
+
+        m = /\A(.+)(\.[a-z][a-z0-9]*)\z/i.match(basename)
+        if m
+          "#{recursive_extension(m[1], limit - 1)}#{m[2]}"
+        else
+          ''
+        end
+      end
+    end
+  end
+end