eac_tools 0.125.0 → 0.126.1

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

@@ -0,0 +1,51 @@
+# 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
+
+          delegate :nodasho_options, to: :class
+
+          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,26 @@
+# 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,25 @@
+# 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,36 @@
+# 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,74 @@
+# 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_-]*/
+      HOSTNAME_PATTERN = /[^@]+/
+      USER_HOSTNAME_PATTERN = /\A(?:(#{USER_PATTERN})@)?(#{HOSTNAME_PATTERN})\z/
+
+      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)
+        super()
+        @uri = self.class.parse_uri(uri).freeze
+      end
+
+      delegate :to_s, to: :uri
+
+      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,35 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/module/common_concern'
+
+module EacRubyUtils
+  module Fs
+    module Extname
+      common_concern
+      class_methods do
+        # 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
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/fs/temp/directory.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/fs/temp/file'
+
+module EacRubyUtils
+  module Fs
+    module Temp
+      class Directory < ::EacRubyUtils::Fs::Temp::File
+        def initialize(*tempfile_args)
+          super
+          mkpath
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/fs/temp/file.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'tempfile'
+
+module EacRubyUtils
+  module Fs
+    module Temp
+      class File < Pathname
+        %i[basename children cleanpath dirname each_child entries
+           expand_path realdirpath realpath sub sub_ext].each do |method_name|
+          define_method(method_name) do |*args, &block|
+            ::Pathname.new(to_path).send(method_name, *args, &block)
+          end
+        end
+
+        # Temporary file
+        def initialize(*tempfile_args)
+          file = Tempfile.new(*tempfile_args)
+          path = file.path
+          file.close
+          file.unlink
+          super(path)
+        end
+
+        def remove
+          if directory?
+            rmtree
+          elsif file?
+            unlink
+          end
+        end
+
+        def remove!
+          remove
+          raise "Tried to remove \"#{self}\", but it yet exists" if exist?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+require 'pathname'
+require 'tempfile'
+
+module EacRubyUtils
+  module Fs
+    # Utilities for temporary files.
+    module Temp
+      class << self
+        ::EacRubyUtils.require_sub __FILE__
+
+        # Shortcut to +EacRubyUtils::Fs::Temp::Directory.new(*tempfile_args)+.
+        #
+        # @return [Pathname]
+        def directory(*tempfile_args)
+          ::EacRubyUtils::Fs::Temp::Directory.new(*tempfile_args)
+        end
+
+        # Shortcut to +EacRubyUtils::Fs::Temp::File.new(*tempfile_args)+.
+        #
+        # @return [Pathname]
+        def file(*tempfile_args)
+          ::EacRubyUtils::Fs::Temp::File.new(*tempfile_args)
+        end
+
+        # Run a block while a temporary directory pathname is provided. The directory is deleted
+        # when the block is finished.
+        def on_directory(*tempfile_args)
+          temp_dir = directory(*tempfile_args)
+          begin
+            yield(temp_dir)
+          ensure
+            temp_dir.remove
+          end
+        end
+
+        # Run a block while a temporary file pathname is providade. The file is deleted when block
+        # is finished.
+        def on_file(*tempfile_args)
+          temp_file = file(*tempfile_args)
+          begin
+            yield(temp_file)
+          ensure
+            temp_file.remove
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+
+module EacRubyUtils
+  module Fs
+    include ::EacRubyUtils::Fs::Extname
+
+    ::EacRubyUtils.require_sub __FILE__
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/gems_registry/gem/dependencies.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/recursive_builder'
+require 'memoized'
+
+module EacRubyUtils
+  class GemsRegistry
+    class Gem
+      module Dependencies
+        include ::Memoized
+
+        def depend_on(gem) # rubocop:disable Naming/PredicateMethod
+          dependencies.lazy.map(&:name).include?(gem.gemspec.name)
+        end
+
+        memoize def dependencies
+          ::EacRubyUtils::RecursiveBuilder
+            .new(gemspec) { |item| gem_item_dependencies(item) }
+            .result
+        end
+
+        private
+
+        # @return [Array<Gem::Dependency>]
+        def gem_item_dependencies(item)
+          ::Gem::Specification.find_by_name(item.name).dependencies.select(&:runtime?)
+        rescue ::Gem::MissingSpecError
+          []
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/gems_registry/gem/paths_to_require.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_ruby_utils/recursive_builder'
+require 'memoized'
+
+module EacRubyUtils
+  class GemsRegistry
+    class Gem
+      module PathsToRequire
+        ROOT_MODULE_REQUIRE_PATTERNS = %w[
+          EacRubyUtils::RootModuleSetup EacRubyBase1::RootModuleSetup Zeitwerk
+        ].freeze
+
+        # @return [Enumerable<Pathname>]
+        def absolute_require_paths(lib_relative_path)
+          gemspec.require_paths.lazy.map do |e|
+            ::Pathname.new(e).expand_path(gemspec.gem_dir)
+              .join("#{lib_relative_path}.rb")
+          end
+        end
+
+        # @return [String]
+        def path_to_require
+          require_root_module? ? root_module_path_to_require : direct_path_to_require
+        end
+
+        # @return [String]
+        def to_s
+          "#{self.class.name}[#{gemspec.name}]"
+        end
+
+        protected
+
+        # @return [String]
+        def direct_path_to_require
+          "#{root_module_path_to_require}/#{registry.module_suffix.underscore}"
+        end
+
+        # @return [Boolean]
+        def require_root_module?
+          absolute_require_paths(root_module_path_to_require).find do |e|
+            next false unless e.file?
+
+            content = e.read
+            ROOT_MODULE_REQUIRE_PATTERNS.any? { |e| content.include?(e) }
+          end
+        end
+
+        # @return [String]
+        def root_module_path_to_require
+          gemspec.name.gsub('-', '/')
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/gems_registry/gem.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_ruby_utils/gems_registry/gem/dependencies'
+require 'eac_ruby_utils/gems_registry/gem/paths_to_require'
+require 'memoized'
+
+module EacRubyUtils
+  class GemsRegistry
+    class Gem
+      include ::Comparable
+      include ::EacRubyUtils::GemsRegistry::Gem::Dependencies
+      include ::EacRubyUtils::GemsRegistry::Gem::PathsToRequire
+      include ::Memoized
+
+      attr_reader :registry, :gemspec
+
+      def initialize(registry, gemspec)
+        @registry = registry
+        @gemspec = gemspec
+      end
+
+      def <=>(other)
+        sd = depend_on(other)
+        od = other.depend_on(self)
+        return 1 if sd && !od
+        return -1 if od && !sd
+
+        gemspec.name <=> other.gemspec.name
+      end
+
+      def found?
+        registered_module.is_a?(::Module)
+      end
+
+      # @return [Module, nil]
+      def registered_module
+        begin
+          require path_to_require
+        rescue ::LoadError # rubocop:disable Lint/SuppressedException
+        end
+        begin
+          direct_path_to_require.camelize.constantize
+        rescue ::LoadError, ::NameError
+          nil
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/gems_registry.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'eac_ruby_utils/gems_registry/gem'
+
+module EacRubyUtils
+  # Search in each gem for a class determined by registry and run the method "register" on each
+  # found.
+  #
+  # Example:
+  # * The module suffix is `TheClass`;
+  # * A gem with name "my-lib" is being analyzed
+  # * If a require for "my/lib/the_class" is succesful the class/module `My::Lib::TheClass` will
+  #   be collected.
+  class GemsRegistry
+    attr_reader :module_suffix
+
+    def initialize(module_suffix)
+      @module_suffix = module_suffix
+    end
+
+    # @return [Array<EacRubyUtils::GemsRegistry::Gem>]
+    def registered
+      @registered ||= all_gems.select(&:found?).sort
+    end
+
+    private
+
+    # @return [Array<EacRubyUtils::GemsRegistry::Gem>]
+    def all_gems
+      ::Gem::Specification.map { |gemspec| ::EacRubyUtils::GemsRegistry::Gem.new(self, gemspec) }
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/inflector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+module EacRubyUtils
+  class Inflector
+    class << self
+      VARIABLE_NAME_PATTERN = /[_a-z][_a-z0-9]*/i
+
+      # Convert a string to a variable format: first character as a lowercase letter or underscore
+      # and other as a lowercase letter, underscore or numbers.
+      # @param string [String] The source string.
+      # @param validate [Boolean] Affect the outcome when the result builded is not in a valid
+      #   variable format. If `true`, it raises a {ArgumentError}. If `false`, return `nil`.
+      # @return [String, nil]
+      # @raise [ArgumentError]
+      def variableize(string, validate = true) # rubocop:disable Style/OptionalBooleanParameter
+        r = ::ActiveSupport::Inflector.transliterate(string).gsub(/[^_a-z0-9]/i, '_')
+              .gsub(/_+/, '_').gsub(/_\z/, '').gsub(/\A_/, '').downcase
+        m = VARIABLE_NAME_PATTERN.match(r)
+        return r if m
+        return nil unless validate
+
+        raise ::ArgumentError, "Invalid variable name \"#{r}\" was generated " \
+                               "from string \"#{string}\""
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/listable/class_methods.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require_relative 'lists'
+
+module EacRubyUtils
+  module Listable
+    module ClassMethods
+      def lists
+        @lists ||= ::EacRubyUtils::Listable::Lists.new(self)
+      end
+    end
+  end
+end