eac_ruby_utils 0.40.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60224aa50261e8212946f7fb3cbe3efd1bef3ee6853bf827d78ca18810d81fc9
-  data.tar.gz: 2da01ff57939fc85b13fab89241c711526726681e547d0194565cad04b9ce811
+  metadata.gz: df5cc092238557342bbb1874838b7048fa9b80101a1cfe1861f1a7493d1bd693
+  data.tar.gz: a8ba790627eb0e6c4c6f4c4790edd91e59552d8c5342ec9f07dea378504877a7
 SHA512:
-  metadata.gz: 35bd1179d9dfdaf7f741f2cf054a379ed37018318955397996bdc8acd484d53b602efc9d383d2c9ee866db00dc306843c48e5c282812f56d08439a1f286c5b78
-  data.tar.gz: 4a937089189a97671ccfa8e30499fa0ddcc69843bdfd6a96232594e48c2019f20bcc02e653c597e2f086c6990437cb5c9d13b58287c4dc87817b0ea5d2a875e9
+  metadata.gz: b07181b2af458b4c148309c6ac34e7b2d7d227b9ef39881c5d904ce7fd966a7d502597fe1228e46f1be70267c05aa6b6de6a82de8c35f32c951eca5e4d2af462
+  data.tar.gz: c1c99d47ea1640415404efe515e1844eb8614ff6806a89542188a0ccddc4ad6fccb04c4c7281903b90737969a3417de5cd8d4383ec2e011ee68303ab19e66ec9

data/lib/eac_ruby_utils/boolean.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class Boolean
+    class << self
+      def parse(value)
+        return parse_string(value) if value.is_a?(::String)
+        return parse_string(value.to_s) if value.is_a?(::Symbol)
+        return parse_number(value) if value.is_a?(::Number)
+
+        value ? true : false
+      end
+
+      private
+
+      def parse_string(value)
+        ['', 'n', 'no', 'f', 'false'].include?(value.strip.downcase) ? false : true
+      end
+
+      def parse_number(value)
+        value.zero?
+      end
+    end
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = self.class.parse(value)
+    end
+  end
+end

data/lib/eac_ruby_utils/console/docopt_runner.rb

@@ -14,6 +14,12 @@ module EacRubyUtils
     class DocoptRunner
       include ::EacRubyUtils::Contextualizable
 
+      class << self
+        def create(settings = {})
+          new(settings)
+        end
+      end
+
       attr_reader :settings
 
       def initialize(settings = {})

data/lib/eac_ruby_utils/console/docopt_runner/_class_methods.rb

@@ -3,11 +3,11 @@
 module EacRubyUtils
   module Console
     class DocoptRunner
-      DOCOPT_ERROR_EXIT_CODE = 0x22220000
+      DOCOPT_ERROR_EXIT_CODE = 0xC0
 
       class << self
         def run(options = {})
-          new(options).send(:run)
+          create(options).send(:run)
         rescue Docopt::Exit => e
           STDERR.write(e.message + "\n")
           ::Kernel.exit(DOCOPT_ERROR_EXIT_CODE) # rubocop:disable Rails/Exit

data/lib/eac_ruby_utils/console/docopt_runner/_subcommands.rb

@@ -25,6 +25,8 @@ module EacRubyUtils
       end
 
       module SubcommandsSupport
+        EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME = :extra_available_subcommands
+
         def check_subcommands_arg
           if subcommand_arg_as_list?
             singleton_class.include(SubcommandsSupport::SubcommandArgAsList)
@@ -43,7 +45,7 @@ module EacRubyUtils
         end
 
         def subcommand
-          @subcommand ||= subcommand_class_name(subcommand_name).constantize.new(
+          @subcommand ||= subcommand_class_name(subcommand_name).constantize.create(
             argv: subcommand_args,
             program_name: subcommand_program,
             parent: self
@@ -77,7 +79,11 @@ module EacRubyUtils
         end
 
         def available_subcommands
-          (setting_value(:subcommands, false) || auto_available_subcommands).sort
+          r = ::Set.new(setting_value(:subcommands, false) || auto_available_subcommands)
+          if respond_to?(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME, true)
+            r += send(EXTRA_AVAILABLE_SUBCOMMANDS_METHOD_NAME)
+          end
+          r.sort
         end
 
         def auto_available_subcommands

data/lib/eac_ruby_utils/envs/ssh_env.rb

@@ -2,12 +2,16 @@
 
 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
@@ -49,17 +53,16 @@ module EacRubyUtils
       private
 
       def ssh_command_line
-        r = %w[ssh]
-        r += ['-p', uri.port] if uri.port.present?
-        r += ssh_command_line_options
-        r << user_hostname_uri
-        r.map { |a| Shellwords.escape(a) }.join(' ')
+        (%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_options
-        r = []
-        uri.query_values&.each { |k, v| r += ['-o', "#{k}=#{v}"] }
-        r
+      def ssh_command_line_port_args
+        uri.port.if_present([]) do |v|
+          ['-p', v]
+        end
       end
 
       def user_hostname_uri

data/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/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/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/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/lib/eac_ruby_utils/immutable/array_accessor.rb

@@ -18,6 +18,10 @@ module EacRubyUtils
         end
       end
 
+      def immutable_value_get(object)
+        super || []
+      end
+
       def immutable_value_set(object, value)
         duplicate_object(object) do |old_value|
           (old_value || []) + [value]

data/lib/eac_ruby_utils/immutable/hash_accessor.rb

@@ -11,6 +11,10 @@ module EacRubyUtils
         apply_set(klass)
       end
 
+      def immutable_value_get(object)
+        super || {}
+      end
+
       def immutable_value_set(object, key, value)
         duplicate_object(object) do |old_value|
           (old_value || {}).merge(key => value)

data/lib/eac_ruby_utils/inflector.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class Inflector
+    class << self
+      VARIABLE_NAME_PATTERN = /[_a-z][_a-z0-9]*/i.freeze
+
+      def variableize(string)
+        r = string.gsub(/[^_a-z0-9]/i, '_').gsub(/_+/, '_').gsub(/_\z/, '').gsub(/\A_/, '').downcase
+        m = VARIABLE_NAME_PATTERN.match(r)
+        return r if m
+
+        raise ::ArgumentError, "Invalid variable name \"#{r}\" was generated " \
+          "from string \"#{string}\""
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/listable/list.rb

@@ -33,6 +33,11 @@ module EacRubyUtils
         find_list_by_method(name) || super
       end
 
+      def hash_keys_validate!(hash, error_class = ::StandardError)
+        hash.keys.each { |key| value_validate!(key, error_class) }
+        hash
+      end
+
       def i18n_key
         "eac_ruby_utils.listable.#{class_i18n_key}.#{item}"
       end

data/lib/eac_ruby_utils/patches/object/if_respond.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+class Object
+  # @return +block.call(self.method_name)+ if +self+ responds to +method_name+, +default_value+
+  # otherwise.
+  def if_respond(method_name, default_value = nil)
+    return default_value unless respond_to?(method_name)
+
+    value = send(method_name)
+
+    block_given? ? yield(value) : value
+  end
+
+  # @return +yield+ if +self+ is blank.
+  def if_blank
+    return yield if blank? && block_given?
+
+    self
+  end
+end

data/lib/eac_ruby_utils/patches/string.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/lib/eac_ruby_utils/patches/string/inflector.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/inflector'
+
+class String
+  def variableize
+    ::EacRubyUtils::Inflector.variableize(self)
+  end
+end

data/lib/eac_ruby_utils/require_sub.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/inflector'
+require 'eac_ruby_utils/listable'
 
 module EacRubyUtils
   class << self
@@ -10,15 +11,14 @@ module EacRubyUtils
   end
 
   class RequireSub
-    BASE_OPTION_KEY = :base
-    INCLUDE_MODULES_OPTION_KEY = :include_modules
-    REQUIRE_DEPENDENCY_OPTION_KEY = :require_dependency
+    include ::EacRubyUtils::Listable
+    lists.add_symbol :option, :base, :include_modules, :require_dependency
 
     attr_reader :file, :options
 
     def initialize(file, options = {})
       @file = file
-      @options = options
+      @options = self.class.lists.option.hash_keys_validate!(options)
     end
 
     def apply
@@ -29,7 +29,7 @@ module EacRubyUtils
     private
 
     def active_support_require(path)
-      return false unless options[REQUIRE_DEPENDENCY_OPTION_KEY]
+      return false unless options[OPTION_REQUIRE_DEPENDENCY]
 
       ::Kernel.require_dependency(path)
       true
@@ -46,7 +46,7 @@ module EacRubyUtils
     end
 
     def include_modules
-      return unless options[INCLUDE_MODULES_OPTION_KEY]
+      return unless options[OPTION_INCLUDE_MODULES]
 
       base.constants.each do |constant_name|
         constant = base.const_get(constant_name)
@@ -57,11 +57,11 @@ module EacRubyUtils
     end
 
     def base
-      options[BASE_OPTION_KEY] || raise('Option :base not setted')
+      options[OPTION_BASE] || raise('Option :base not setted')
     end
 
     def base?
-      options[BASE_OPTION_KEY] ? true : false
+      options[OPTION_BASE] ? true : false
     end
 
     def kernel_require(path)

data/lib/eac_ruby_utils/struct.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/object/blank'
+
+module EacRubyUtils
+  class Struct
+    def initialize(initial_data = {})
+      self.data = ::ActiveSupport::HashWithIndifferentAccess.new(initial_data)
+    end
+
+    def [](key)
+      key, bool = parse_key(key)
+      bool ? self[key].present? : data[key]
+    end
+
+    def fetch(key)
+      key, bool = parse_key(key)
+      bool ? fetch(key).present? : data.fetch(key)
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      property_method?(method_name) ? fetch(method_name) : super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      property_method?(method_name) || super
+    end
+
+    private
+
+    attr_accessor :data
+
+    def parse_key(key)
+      m = /\A(.+)\?\z/.match(key.to_s)
+      [(m ? m[1] : key.to_s).to_sym, m ? true : false]
+    end
+
+    def property_method?(key)
+      property_methods.include?(key.to_sym)
+    end
+
+    def property_methods
+      data.keys.flat_map { |k| [k.to_sym, "#{k}?".to_sym] }
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.45.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,6 +109,7 @@ files:
 - README.rdoc
 - lib/eac_ruby_utils.rb
 - lib/eac_ruby_utils/arguments_consumer.rb
+- lib/eac_ruby_utils/boolean.rb
 - lib/eac_ruby_utils/by_reference.rb
 - lib/eac_ruby_utils/common_concern.rb
 - lib/eac_ruby_utils/common_constructor.rb
@@ -139,6 +140,10 @@ files:
 - lib/eac_ruby_utils/envs/process.rb
 - lib/eac_ruby_utils/envs/spawn.rb
 - lib/eac_ruby_utils/envs/ssh_env.rb
+- lib/eac_ruby_utils/envs/ssh_env/dasho_options.rb
+- lib/eac_ruby_utils/envs/ssh_env/identity_file.rb
+- lib/eac_ruby_utils/envs/ssh_env/quiet.rb
+- lib/eac_ruby_utils/envs/ssh_env/terminal.rb
 - lib/eac_ruby_utils/filesystem_cache.rb
 - lib/eac_ruby_utils/fs.rb
 - lib/eac_ruby_utils/fs/extname.rb
@@ -156,6 +161,7 @@ files:
 - lib/eac_ruby_utils/immutable/common_accessor.rb
 - lib/eac_ruby_utils/immutable/hash_accessor.rb
 - lib/eac_ruby_utils/immutable/instance_methods.rb
+- lib/eac_ruby_utils/inflector.rb
 - lib/eac_ruby_utils/listable.rb
 - lib/eac_ruby_utils/listable/class_methods.rb
 - lib/eac_ruby_utils/listable/instance_methods.rb
@@ -187,12 +193,15 @@ files:
 - lib/eac_ruby_utils/patches/object.rb
 - lib/eac_ruby_utils/patches/object/asserts.rb
 - lib/eac_ruby_utils/patches/object/if_present.rb
+- lib/eac_ruby_utils/patches/object/if_respond.rb
 - lib/eac_ruby_utils/patches/object/template.rb
 - lib/eac_ruby_utils/patches/object/to_pathname.rb
 - lib/eac_ruby_utils/patches/pathname.rb
 - lib/eac_ruby_utils/patches/pathname/basename_sub.rb
 - lib/eac_ruby_utils/patches/regexp.rb
 - lib/eac_ruby_utils/patches/regexp/if_match.rb
+- lib/eac_ruby_utils/patches/string.rb
+- lib/eac_ruby_utils/patches/string/inflector.rb
 - lib/eac_ruby_utils/patches/time.rb
 - lib/eac_ruby_utils/patches/time/default_time_zone_set.rb
 - lib/eac_ruby_utils/patches/time/local_time_zone.rb
@@ -206,6 +215,7 @@ files:
 - lib/eac_ruby_utils/ruby/on_clean_environment.rb
 - lib/eac_ruby_utils/settings_provider.rb
 - lib/eac_ruby_utils/simple_cache.rb
+- lib/eac_ruby_utils/struct.rb
 - lib/eac_ruby_utils/templates.rb
 - lib/eac_ruby_utils/templates/directory.rb
 - lib/eac_ruby_utils/templates/file.rb
@@ -237,8 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Utilities for E.A.C.'s Ruby projects.