eac_ruby_utils 0.36.1 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d0ecee9144c68997a1ce006b3888d4ca47d5f3e0fbbcebb1510f1c7729f6ab
-  data.tar.gz: 1fef17107a1604d0e8bdab9cc20d5066a86957340573319f758763294d461da2
+  metadata.gz: 8e04909bde0d65f8b8615601194b4fb9c1fb3b6b56f6bf02cd98103fe0510e7b
+  data.tar.gz: 902d0c69a54f0a0330c4e47afa498501b02beec6367c6d952f6d72f8388b74c5
 SHA512:
-  metadata.gz: 5389243ea1b2c4cd7c9dc433821d390e6202d42177d422a482b8efb7f73b06311d7351d43feedad9396c3551273e6ade1f4ce539915483c5271e5590cc134b2f
-  data.tar.gz: 19b375a5056cb8fd70914bfe029e780a20066ba558c84b7a934ef3b82e118139bfe62f54b4b8285ad8a46ff643431ad1e06e494912d483559dbfb5524f7f098e
+  metadata.gz: cbaf478b74fbb77fff8682b733685773ad8c3de4eac8e5fc9c2adcca81fbeac56a5e4df330c0ffb60097f1c3d75b371270814b52ca1bd54ef77fa417adf55284
+  data.tar.gz: 947edd1f4ba4f942ba78ed5e17f99b95d1d89f456426437efa6c3eb35128c12b312fb628f962f0e123a38d8ea37c6fa7a135d1c4c4d7d1b6f9b6449e465458ed

data/lib/eac_ruby_utils/envs/command.rb

@@ -54,6 +54,7 @@ module EacRubyUtils
       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?
 

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

@@ -16,6 +16,10 @@ module EacRubyUtils
           duplicate_by_extra_options(envvars: envvars.merge(name => value))
         end
 
+        def status_result(status_code, result)
+          duplicate_by_extra_options(status_results: status_results.merge(status_code => result))
+        end
+
         def pipe(other_command)
           duplicate_by_extra_options(pipe: other_command)
         end
@@ -28,6 +32,10 @@ module EacRubyUtils
           extra_options[:envvars] ||= {}.with_indifferent_access
         end
 
+        def status_results
+          extra_options[:status_results] ||= {}.with_indifferent_access
+        end
+
         def append_envvars(command)
           e = envvars.map { |k, v| "#{Shellwords.escape(k)}=#{Shellwords.escape(v)}" }.join(' ')
           e.present? ? "#{e} #{command}" : command

data/lib/eac_ruby_utils/envs/ssh_env.rb

@@ -2,12 +2,14 @@
 
 require 'addressable'
 require 'eac_ruby_utils/envs/base_env'
+require 'eac_ruby_utils/patches/object/if_present'
 require 'net/ssh'
 require 'shellwords'
 
 module EacRubyUtils
   module Envs
     class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      IDENTITITY_FILE_OPTION = 'IdentityFile'
       USER_PATTERN = /[a-z_][a-z0-9_-]*/.freeze
       HOSTNAME_PATTERN = /[^@]+/.freeze
       USER_HOSTNAME_PATTERN = /\A(?:(#{USER_PATTERN})@)?(#{HOSTNAME_PATTERN})\z/.freeze
@@ -51,6 +53,7 @@ module EacRubyUtils
       def ssh_command_line
         r = %w[ssh]
         r += ['-p', uri.port] if uri.port.present?
+        ssh_identity_file.if_present { |v| r += ['-i', v] }
         r += ssh_command_line_options
         r << user_hostname_uri
         r.map { |a| Shellwords.escape(a) }.join(' ')
@@ -58,7 +61,9 @@ module EacRubyUtils
 
       def ssh_command_line_options
         r = []
-        uri.query_values&.each { |k, v| r += ['-o', "#{k}=#{v}"] }
+        uri.query_values&.each do |k, v|
+          r += ['-o', "#{k}=#{v}"] unless k == IDENTITITY_FILE_OPTION
+        end
         r
       end
 
@@ -67,6 +72,12 @@ module EacRubyUtils
         r = "#{uri.user}@#{r}" if uri.user.present?
         r
       end
+
+      def ssh_identity_file
+        uri.query_values.if_present do |v|
+          v[IDENTITITY_FILE_OPTION]
+        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/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/require_sub.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/inflector'
+
 module EacRubyUtils
   class << self
     def require_sub(file, options = {})
@@ -26,6 +28,23 @@ module EacRubyUtils
 
     private
 
+    def active_support_require(path)
+      return false unless options[REQUIRE_DEPENDENCY_OPTION_KEY]
+
+      ::Kernel.require_dependency(path)
+      true
+    end
+
+    def autoload_require(path)
+      return false unless base?
+
+      basename = ::File.basename(path, '.*')
+      return false if basename.start_with?('_')
+
+      base.autoload ::ActiveSupport::Inflector.camelize(basename), path
+      true
+    end
+
     def include_modules
       return unless options[INCLUDE_MODULES_OPTION_KEY]
 
@@ -41,14 +60,22 @@ module EacRubyUtils
       options[BASE_OPTION_KEY] || raise('Option :base not setted')
     end
 
+    def base?
+      options[BASE_OPTION_KEY] ? true : false
+    end
+
+    def kernel_require(path)
+      ::Kernel.require(path)
+    end
+
     def require_sub_files
       Dir["#{File.dirname(file)}/#{::File.basename(file, '.*')}/*.rb"].sort.each do |path|
-        if options[REQUIRE_DEPENDENCY_OPTION_KEY]
-          require_dependency path
-        else
-          require path
-        end
+        require_sub_file(path)
       end
     end
+
+    def require_sub_file(path)
+      active_support_require(path) || autoload_require(path) || kernel_require(path)
+    end
   end
 end

data/lib/eac_ruby_utils/templates/directory.rb

@@ -10,7 +10,7 @@ module EacRubyUtils
       attr_reader :path
 
       def initialize(path)
-        @path = path
+        @path = path.is_a?(::Pathname) ? path : ::Pathname.new(path.to_s)
       end
 
       def apply(variables_source, directory)
@@ -25,6 +25,12 @@ module EacRubyUtils
         raise "Child \"#{subpath}\" from \"#{path}\" not found"
       end
 
+      def children
+        path.children.map do |path_child|
+          child(path_child.basename.to_path)
+        end
+      end
+
       private
 
       def apply_fs_object(source_relative, target)

data/lib/eac_ruby_utils/templates/file.rb

@@ -1,32 +1,29 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/hash/indifferent_access'
-require 'eac_ruby_utils/simple_cache'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/templates/variable_providers'
 
 module EacRubyUtils
   module Templates
     class File
-      include ::EacRubyUtils::SimpleCache
-
       VARIABLE_DELIMITER = ::Regexp.quote('%%')
       VARIABLE_PATTERN = /#{VARIABLE_DELIMITER}([a-z0-9\._]*)#{VARIABLE_DELIMITER}/i.freeze
 
-      attr_reader :path
-
-      def initialize(path)
-        @path = path
+      enable_simple_cache
+      common_constructor :path do
+        self.path = path.to_pathname
       end
 
       # +variables_provider+ A [Hash] or object which responds to +read_entry(entry_name)+.
       def apply(variables_source)
-        variables_provider = build_variables_provider(variables_source)
+        variables_provider = ::EacRubyUtils::Templates::VariableProviders.build(variables_source)
         variables.inject(content) do |a, e|
           a.gsub(variable_pattern(e), variables_provider.variable_value(e).to_s)
         end
       end
 
       def apply_to_file(variables_source, output_file_path)
-        ::File.write(output_file_path, apply(variables_source))
+        output_file_path.to_pathname.write(apply(variables_source))
       end
 
       private
@@ -38,64 +35,16 @@ module EacRubyUtils
       end
 
       def content_uncached
-        ::File.read(path)
+        path.read
       end
 
       def sanitize_variable_name(variable_name)
         variable_name.to_s.downcase
       end
 
-      def build_variables_provider(variables_source)
-        return HashVariablesProvider.new(variables_source) if variables_source.is_a?(::Hash)
-        return EntriesReaderVariablesProvider.new(variables_source) if
-        variables_source.respond_to?(:read_entry)
-
-        raise "Variables provider not found for #{variables_source}"
-      end
-
       def variable_pattern(name)
         /#{VARIABLE_DELIMITER}#{::Regexp.quote(name)}#{VARIABLE_DELIMITER}/i
       end
-
-      class BaseVariablesProvider
-        attr_reader :source
-
-        def initialize(source)
-          @source = source
-        end
-
-        def variable_value(name)
-          return variable_fetch(name) if variable_exist?(name)
-
-          raise VariableNotFoundError, "Variable \"#{name}\" not found in #{source}"
-        end
-      end
-
-      class HashVariablesProvider < BaseVariablesProvider
-        def initialize(source)
-          super(source.with_indifferent_access)
-        end
-
-        def variable_exist?(name)
-          source.key?(name)
-        end
-
-        def variable_fetch(name)
-          source.fetch(name)
-        end
-      end
-
-      class EntriesReaderVariablesProvider < BaseVariablesProvider
-        def variable_exist?(_name)
-          true
-        end
-
-        def variable_fetch(name)
-          source.read_entry(name)
-        end
-      end
-
-      class VariableNotFoundError < StandardError; end
     end
   end
 end

data/lib/eac_ruby_utils/templates/variable_not_found_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Templates
+    class VariableNotFoundError < StandardError; end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      require_sub __FILE__
+
+      PROVIDERS = %w[entries_reader hash generic].map do |name|
+        "eac_ruby_utils/templates/variable_providers/#{name}".camelize.constantize
+      end
+
+      class << self
+        def build(variables_source)
+          PROVIDERS.each do |provider|
+            return provider.new(variables_source) if provider.accept?(variables_source)
+          end
+
+          raise "Variables provider not found for #{variables_source}"
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_not_found_error'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class Base
+        attr_reader :source
+
+        def initialize(source)
+          @source = source
+        end
+
+        def variable_value(name)
+          return variable_fetch(name) if variable_exist?(name)
+
+          raise VariableNotFoundError, "Variable \"#{name}\" not found in #{source}"
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/entries_reader.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_providers/base'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class EntriesReader < ::EacRubyUtils::Templates::VariableProviders::Base
+        class << self
+          def accept?(variables_source)
+            variables_source.respond_to?(:read_entry)
+          end
+        end
+
+        def variable_exist?(_name)
+          true
+        end
+
+        def variable_fetch(name)
+          source.read_entry(name)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/generic.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_providers/base'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class Generic < ::EacRubyUtils::Templates::VariableProviders::Base
+        class << self
+          def accept?(variables_source)
+            variables_source.is_a?(::Object)
+          end
+        end
+
+        def variable_exist?(name)
+          source.respond_to?(name)
+        end
+
+        def variable_fetch(name)
+          source.send(name)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/variable_providers/hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/variable_providers/base'
+
+module EacRubyUtils
+  module Templates
+    module VariableProviders
+      class Hash < ::EacRubyUtils::Templates::VariableProviders::Base
+        class << self
+          def accept?(variables_source)
+            variables_source.is_a?(::Hash)
+          end
+        end
+
+        def initialize(source)
+          super(source.with_indifferent_access)
+        end
+
+        def variable_exist?(name)
+          source.key?(name)
+        end
+
+        def variable_fetch(name)
+          source.fetch(name)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.36.1
+  version: 0.41.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-14 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -148,6 +148,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 +179,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
@@ -201,6 +210,12 @@ files:
 - lib/eac_ruby_utils/templates/directory.rb
 - lib/eac_ruby_utils/templates/file.rb
 - lib/eac_ruby_utils/templates/searcher.rb
+- lib/eac_ruby_utils/templates/variable_not_found_error.rb
+- lib/eac_ruby_utils/templates/variable_providers.rb
+- lib/eac_ruby_utils/templates/variable_providers/base.rb
+- lib/eac_ruby_utils/templates/variable_providers/entries_reader.rb
+- lib/eac_ruby_utils/templates/variable_providers/generic.rb
+- lib/eac_ruby_utils/templates/variable_providers/hash.rb
 - lib/eac_ruby_utils/version.rb
 - lib/eac_ruby_utils/yaml.rb
 homepage: