eac_ruby_utils 0.39.0 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2a4b0d92b253248df0a2e7ec093f1056a822602cfcce7376d2b91e28b9f2d22
-  data.tar.gz: b0590f577360628d7f399981270a2a46914e3398ffb8af511a36ac40f67a9494
+  metadata.gz: 9bfd8e12446b005875a4071e96d64bce7d841a5459537c846632d303f4d89e05
+  data.tar.gz: cce1b321a2aa297cddc211d646ef8b471fdfda3d7ed4eac3eb690e69ce8772e0
 SHA512:
-  metadata.gz: c42cfcbfb7bcc6a0ed2d6df02959de8496e131cbe1d2448e1ebeffa8b2dab284dcb4cdc535605eeaff9efdae0134aa473458b570ab511db4e1e41b6fe9d6af5b
-  data.tar.gz: d989ccc189773585f71ad08f42f41400d3bddd8caf4914f452abffb28e0640f7bc64359c8374dfe20af115ecbbc48317ce623d3533ca1be947344d5b4c43db03
+  metadata.gz: e02f7e7aeb5cb1b1cf54f92abcfe46dfad970c7d637e412d0bb3bb35872dcbb8f4104e8cf7275dc071fb00fd5b29b9a292f9849f2c2ede1239deaec2b32c7f09
+  data.tar.gz: bd1af262c50b1205e15a9e63d70f2929132b7c89c6036b5ddb0f3d25f94590ff6cf05f82151dd7cb3f4e7c8ccad3cd1b5f4878a271f3ab471d59b85d2f73f7f5

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/_class_methods.rb

@@ -3,7 +3,7 @@
 module EacRubyUtils
   module Console
     class DocoptRunner
-      DOCOPT_ERROR_EXIT_CODE = 0x22220000
+      DOCOPT_ERROR_EXIT_CODE = 0xC0
 
       class << self
         def run(options = {})

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/fs_cache.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/filesystem_cache'
+require 'tmpdir'
 
 module EacRubyUtils
   class << self

data/lib/eac_ruby_utils/immutable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/module/common_concern'
+require 'eac_ruby_utils/require_sub'
+
+module EacRubyUtils
+  module Immutable
+    ::EacRubyUtils.require_sub __FILE__
+
+    common_concern do
+      include ::EacRubyUtils::Listable
+      lists.add_symbol :type, :array, :boolean, :common, :hash
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/array_accessor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'eac_ruby_utils/immutable/base_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module Immutable
+    class ArrayAccessor < ::EacRubyUtils::Immutable::BaseAccessor
+      def apply(klass)
+        accessor = self
+        klass.send(:define_method, name) do |value|
+          accessor.immutable_value_set(self, value)
+        end
+
+        klass.send(:define_method, ::ActiveSupport::Inflector.pluralize(name)) do
+          accessor.immutable_value_get(self)
+        end
+      end
+
+      def immutable_value_get(object)
+        super || []
+      end
+
+      def immutable_value_set(object, value)
+        duplicate_object(object) do |old_value|
+          (old_value || []) + [value]
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/base_accessor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Immutable
+    class BaseAccessor
+      common_constructor :name do
+        self.name = name.to_sym
+      end
+
+      def duplicate_object(object)
+        accessor_new_value = yield(immutable_value_get(object))
+        new_values = object.send(:immutable_values_get).merge(name => accessor_new_value)
+        r = object.class.new(*object.immutable_constructor_args)
+        r.send(:immutable_values_set, new_values)
+        r
+      end
+
+      def immutable_value_get(object)
+        object.send(:immutable_values_get)[name]
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/boolean_accessor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/immutable/common_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module Immutable
+    class BooleanAccessor < ::EacRubyUtils::Immutable::CommonAccessor
+      def apply(klass)
+        super
+        accessor = self
+        klass.send(:define_method, "#{name}?") { send(accessor.name) }
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/class_methods.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Immutable
+    module ClassMethods
+      def immutable_accessor(*accessors)
+        options = accessors.extract_options!
+        options[:type] ||= const_get('TYPE_COMMON')
+        accessors.each do |name|
+          class_name = options.fetch(:type).to_s.camelize + 'Accessor'
+          ::EacRubyUtils::Immutable.const_get(class_name).new(name).apply(self)
+        end
+      end
+
+      private
+
+      def imutable_single_accessor(name, options); end
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/common_accessor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/immutable/base_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module Immutable
+    class CommonAccessor < ::EacRubyUtils::Immutable::BaseAccessor
+      def apply(klass)
+        accessor = self
+        klass.send(:define_method, name) do |*args|
+          case args.count
+          when 0 then next accessor.immutable_value_get(self)
+          when 1 then next accessor.immutable_value_set(self, args.first)
+          else
+            raise ::ArgumentError, "wrong number of arguments (given #{args.count}, expected 0..1)"
+          end
+        end
+      end
+
+      def immutable_value_get(object)
+        object.send(:immutable_values_get)[name]
+      end
+
+      def immutable_value_set(object, value)
+        duplicate_object(object) { |_old_value| value }
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/hash_accessor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/immutable/base_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module Immutable
+    class HashAccessor < ::EacRubyUtils::Immutable::BaseAccessor
+      def apply(klass)
+        apply_get(klass)
+        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)
+        end
+      end
+
+      private
+
+      def apply_get(klass)
+        accessor = self
+        klass.send(:define_method, ::ActiveSupport::Inflector.pluralize(name)) do
+          accessor.immutable_value_get(self)
+        end
+      end
+
+      def apply_set(klass)
+        accessor = self
+        klass.send(:define_method, name) do |*args|
+          case args.count
+          when 1 then next accessor.immutable_value_get(self, args[0])
+          when 2 then next accessor.immutable_value_set(self, *args[0..1])
+          else
+            raise ::ArgumentError, "wrong number of arguments (given #{args.count}, expected 1..2)"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/immutable/instance_methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Immutable
+    module InstanceMethods
+      def immutable_constructor_args
+        []
+      end
+
+      private
+
+      def immutable_values_get
+        @immutable_values || {}
+      end
+
+      def immutable_values_set(new_values)
+        @immutable_values = new_values
+      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/module/immutable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patch'
+require 'eac_ruby_utils/immutable'
+
+class Module
+  def enable_immutable
+    ::EacRubyUtils.patch(self, ::EacRubyUtils::Immutable)
+  end
+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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-09-02 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
@@ -148,6 +153,14 @@ files:
 - lib/eac_ruby_utils/fs/traversable.rb
 - lib/eac_ruby_utils/fs/traverser.rb
 - lib/eac_ruby_utils/fs_cache.rb
+- lib/eac_ruby_utils/immutable.rb
+- lib/eac_ruby_utils/immutable/array_accessor.rb
+- lib/eac_ruby_utils/immutable/base_accessor.rb
+- lib/eac_ruby_utils/immutable/boolean_accessor.rb
+- lib/eac_ruby_utils/immutable/class_methods.rb
+- 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/listable.rb
 - lib/eac_ruby_utils/listable/class_methods.rb
 - lib/eac_ruby_utils/listable/instance_methods.rb
@@ -171,6 +184,7 @@ files:
 - lib/eac_ruby_utils/patches/module.rb
 - lib/eac_ruby_utils/patches/module/common_concern.rb
 - lib/eac_ruby_utils/patches/module/console_speaker.rb
+- lib/eac_ruby_utils/patches/module/immutable.rb
 - lib/eac_ruby_utils/patches/module/listable.rb
 - lib/eac_ruby_utils/patches/module/patch.rb
 - lib/eac_ruby_utils/patches/module/require_sub.rb
@@ -178,6 +192,7 @@ 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
@@ -228,8 +243,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.