eac_tools 0.105.1 → 0.105.2

data/sub/eac_cli/spec/lib/eac_cli/parser/alternative/subcommands_spec.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/definition/alternative'
-require 'eac_cli/parser/alternative'
-
 RSpec.describe EacCli::Parser::Alternative, '#subcommands' do
   let(:instance) { described_class.new(alternative, argv) }
   let(:actual_parsed) { instance.parsed.to_h.symbolize_keys }

data/sub/eac_cli/spec/lib/eac_cli/parser/alternative_spec.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/definition/alternative'
-require 'eac_cli/parser/alternative'
-
 RSpec.describe EacCli::Parser::Alternative do
   let(:instance) { described_class.new(alternative, argv) }
   let(:actual_parsed) { instance.parsed.to_h.symbolize_keys }

data/sub/eac_cli/spec/lib/eac_cli/runner/for_context_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner'
-
 RSpec.describe EacCli::Runner, '#for_context' do
   let(:parent_runner_class) do
     example = self

data/sub/eac_cli/spec/lib/eac_cli/runner_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner'
-
 RSpec.describe EacCli::Runner do
   let(:runner_class) do
     the_module = described_class

data/sub/eac_cli/spec/lib/eac_cli/runner_with/confirmation/input_result_spec.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner_with/confirmation/input_result'
-require 'eac_cli/speaker'
-require 'eac_ruby_utils'
-
 RSpec.describe EacCli::RunnerWith::Confirmation::InputResult do
   let(:speaker) { EacCli::Speaker.new }
 
@@ -21,7 +17,7 @@ RSpec.describe EacCli::RunnerWith::Confirmation::InputResult do
     ['y', true, false],
     ['Y', true, true]
   ].each do |test_values|
-    user_input, confirm, for_all = test_values
+    user_input, confirm, for_all = test_values # rubocop:disable RSpec/LeakyLocalVariable
     context "when user input is \"#{user_input}\"" do
       let(:instance) { described_class.by_message('A message') }
 

data/sub/eac_cli/spec/lib/eac_cli/runner_with/confirmation_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner_with/confirmation'
-
 RSpec.describe EacCli::RunnerWith::Confirmation do
   let(:runner) do
     the_module = described_class

data/sub/eac_cli/spec/lib/eac_cli/runner_with/help/layout_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner_with/help/layout'
-
 RSpec.describe EacCli::RunnerWith::Help::Layout do
   describe '#list_section' do
     {

data/sub/eac_cli/spec/lib/eac_cli/runner_with/help_spec.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner_with/help'
-require 'eac_ruby_utils'
-
 RSpec.describe EacCli::RunnerWith::Help do
   let(:runner) do
     the_module = described_class
@@ -14,9 +11,7 @@ RSpec.describe EacCli::RunnerWith::Help do
         pos_arg :a_argument
       end
 
-      def run
-        puts 'Runner run'
-      end
+      def run; end
     end
   end
 

data/sub/eac_cli/spec/lib/eac_cli/runner_with/output_list_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner_with/output_list'
-
 RSpec.describe EacCli::RunnerWith::OutputList do
   let(:runner) do
     the_module = described_class

data/sub/eac_cli/spec/lib/eac_cli/runner_with/output_spec.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner_with/output'
-require 'eac_ruby_utils'
-
 RSpec.describe EacCli::RunnerWith::Output do
   let(:runner) do
     the_module = described_class

data/sub/eac_cli/spec/lib/eac_cli/runner_with/subcommands_spec.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/runner'
-require 'eac_cli/runner_with/help'
-require 'eac_cli/runner_with/subcommands'
-
 RSpec.describe EacCli::RunnerWith::Subcommands do
   let(:parent_runner) do
     the_module = described_class

data/sub/eac_cli/spec/lib/eac_cli/speaker_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'eac_cli/speaker'
-
 RSpec.describe EacCli::Speaker do
   let(:instance) { described_class.new }
 

data/sub/eac_ruby_utils/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if File.exist?(local_gemfile)

data/sub/eac_ruby_utils/MIT-LICENCE

@@ -0,0 +1,16 @@
+Copyright 2018 Eduardo Henrique Bogoni <eduardobogoni@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/sub/eac_ruby_utils/README.rdoc

@@ -0,0 +1,3 @@
+= E.A.C. Ruby Utilities
+
+Utilities for E.A.C.'s Ruby projects.

data/sub/eac_ruby_utils/eac_ruby_utils.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+# Maintain your gem's version:
+require 'eac_ruby_utils/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'eac_ruby_utils'
+  s.version     = EacRubyUtils::VERSION
+  s.authors     = ['Esquilo Azul Company']
+  s.summary     = 'Utilities for E.A.C.\'s Ruby projects.'
+  s.license     = 'MIT'
+
+  s.files = Dir['{lib}/**/*', 'MIT-LICENSE', 'README.rdoc']
+  s.required_ruby_version = '>= 2.7'
+
+  s.add_dependency 'activesupport', '>= 4', '< 7'
+  s.add_dependency 'addressable', '~> 2.8', '>= 2.8.8'
+  s.add_dependency 'bundler'
+  s.add_dependency 'filesize', '~> 0.2'
+  s.add_dependency 'net-ssh', '~> 4.2'
+  s.add_dependency 'zeitwerk', '~> 2.7', '>= 2.7.4'
+  s.add_development_dependency 'avm-eac_ubuntu_base0', '~> 0.6'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.12'
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_abstract.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/module_ancestors_variable/hash'
+require 'eac_ruby_utils/patches/class/self_included_modules'
+require 'eac_ruby_utils/patches/module/common_concern'
+require 'eac_ruby_utils/unimplemented_method_error'
+
+module EacRubyUtils
+  # Support to abstract methods.
+  #
+  # Usage:
+  #
+  #   require 'eac_ruby_utils/acts_as_abstract'
+  #
+  #   class BaseClass
+  #     include EacRubyUtils::ActsAsAbstract
+  #
+  #     abstract_methods :mymethod
+  #   end
+  #
+  #   BaseClass.new.mymethod # raise "Abstract method: mymethod"
+  #
+  #   class SubClass
+  #     def mymethod
+  #       "Implemented"
+  #     end
+  #   end
+  #
+  #   SubClass.new.mymethod # return "Implemented"
+  module ActsAsAbstract
+    common_concern
+
+    class << self
+      def abstract?(a_class)
+        a_class.self_included_modules.include?(::EacRubyUtils::ActsAsAbstract)
+      end
+    end
+
+    module ClassMethods
+      # @param name [Symbol]
+      # @param arguments [Enumerable<Symbol>]
+      # @return [void]
+      def abstract_method(name, *arguments)
+        abstract_methods_hash[name.to_sym] = arguments
+      end
+
+      # @param methods_names [Enumerable<Object>] Each item can be a symbolizable or a hash.
+      # @return [void]
+      def abstract_methods(*methods_names)
+        methods_names.each do |method_name|
+          if method_name.is_a?(::Hash)
+            abstract_methods_from_hash(method_name)
+          else
+            abstract_method(method_name)
+          end
+        end
+      end
+
+      private
+
+      # @param hash [Hash]
+      # @return [void]
+      def abstract_methods_from_hash(hash)
+        hash.each { |name, arguments| abstract_method(name, *arguments) }
+      end
+
+      # @return [Hash<Symbol, Array]
+      def abstract_methods_hash
+        @abstract_methods_hash ||=
+          ::EacRubyUtils::ModuleAncestorsVariable::Hash.new(self, __method__)
+      end
+    end
+
+    module InstanceMethods
+      def respond_to_missing?(method_name, include_private = false)
+        super || abstract_method?(method_name)
+      end
+
+      def method_missing(method_name, *arguments, &block)
+        raise_abstract_method(method_name) if abstract_method?(method_name)
+
+        super
+      end
+
+      # @param method_name [Symbol]
+      # @return [Boolean]
+      def abstract_method?(method_name)
+        return false if self.class.method_defined?(method_name)
+
+        self.class.send(:abstract_methods_hash).key?(method_name.to_sym)
+      end
+
+      def raise_abstract_method(method_name, arguments = [])
+        raise ::EacRubyUtils::UnimplementedMethodError,
+              "Abstract method #{method_name}(#{arguments.join(', ')}) hit in " \
+              "#{self}\" (Class: #{self.class})"
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/array_accessor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/acts_as_immutable/enumerable_accessor'
+
+module EacRubyUtils
+  module ActsAsImmutable
+    class ArrayAccessor < ::EacRubyUtils::ActsAsImmutable::EnumerableAccessor
+      INITIAL_VALUE = [].freeze
+
+      # @param value [Object]
+      # @return [Array]
+      def immutable_value_set_assert(value)
+        return value if value.is_a?(::Array)
+        return value.to_a if value.respond_to?(:to_a)
+
+        Array(value)
+      end
+
+      # @return [Array] A empty array.
+      def initial_value
+        INITIAL_VALUE
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/base_accessor.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/object/if_respond'
+
+module EacRubyUtils
+  module ActsAsImmutable
+    class BaseAccessor
+      FILTER_GET_METHOD_NAME_FORMAT = '%s_get_filter'
+      FILTER_SET_METHOD_NAME_FORMAT = '%s_set_filter'
+
+      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
+
+      # @param object [Object]
+      # @return [Object]
+      def immutable_value_get_filtered(object)
+        r = immutable_value_get(object)
+        if object.respond_to?(immutable_value_get_filtered_method_name, true)
+          r = object.send(immutable_value_get_filtered_method_name, r)
+        end
+        r
+      end
+
+      # @return [Symbol]
+      def immutable_value_get_filtered_method_name
+        format(FILTER_GET_METHOD_NAME_FORMAT, name)
+      end
+
+      # @param object [Object]
+      # @return [Object]
+      def immutable_value_set_filtered(object, value)
+        if object.respond_to?(immutable_value_set_filtered_method_name, true)
+          value = object.send(immutable_value_set_filtered_method_name, value)
+        end
+        immutable_value_set(object, value)
+      end
+
+      # @return [Symbol]
+      def immutable_value_set_filtered_method_name
+        format(FILTER_SET_METHOD_NAME_FORMAT, name)
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/boolean_accessor.rb

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module ActsAsImmutable
+    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::ActsAsImmutable.const_get(class_name).new(name).apply(self)
+        end
+      end
+
+      private
+
+      def imutable_single_accessor(name, options); end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/common_accessor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/acts_as_immutable/base_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module ActsAsImmutable
+    class CommonAccessor < ::EacRubyUtils::ActsAsImmutable::BaseAccessor
+      def apply(klass)
+        accessor = self
+        klass.send(:define_method, name) do |*args|
+          case args.count
+          when 0 then next accessor.immutable_value_get_filtered(self)
+          when 1 then next accessor.immutable_value_set_filtered(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/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/enumerable_accessor.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'eac_ruby_utils/acts_as_immutable/base_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module ActsAsImmutable
+    # Should implement in concrect classes:
+    # * immutable_value_set_assert(value)
+    # * initial_value()
+    class EnumerableAccessor < ::EacRubyUtils::ActsAsImmutable::BaseAccessor
+      def apply(klass)
+        apply_singular(klass)
+        apply_plural(klass)
+      end
+
+      def apply_plural(klass)
+        accessor = self
+        klass.send(:define_method, ::ActiveSupport::Inflector.pluralize(name)) do |*args|
+          case args.count
+          when 0 then next accessor.immutable_value_get_filtered(self)
+          when 1 then next accessor.immutable_value_set_filtered(self, args.first)
+          else
+            raise ::ArgumentError, "wrong number of arguments (given #{args.count}, expected 0..1)"
+          end
+        end
+      end
+
+      def apply_singular(klass)
+        accessor = self
+        klass.send(:define_method, name) do |value|
+          accessor.immutable_value_push(self, value)
+        end
+      end
+
+      def immutable_value_get(object)
+        super || initial_value.dup
+      end
+
+      def immutable_value_push(object, value)
+        duplicate_object(object) do |old_value|
+          (old_value || initial_value.dup) + [value]
+        end
+      end
+
+      def immutable_value_set(object, value)
+        duplicate_object(object) { |_old_value| immutable_value_set_assert(value) }
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/hash_accessor.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/acts_as_immutable/base_accessor'
+require 'eac_ruby_utils/patches/class/common_constructor'
+
+module EacRubyUtils
+  module ActsAsImmutable
+    class HashAccessor < ::EacRubyUtils::ActsAsImmutable::BaseAccessor
+      def apply(klass)
+        apply_plural(klass)
+        apply_singular(klass)
+      end
+
+      def immutable_value_get(object)
+        super || {}
+      end
+
+      def immutable_value_get_single(object, key)
+        immutable_value_get(object)[key]
+      end
+
+      def immutable_value_set(object, new_hash)
+        duplicate_object(object) { |_old_value| new_hash }
+      end
+
+      def immutable_value_set_single(object, key, value)
+        immutable_value_set(object, immutable_value_get(object).merge(key => value))
+      end
+
+      private
+
+      def apply_plural(klass)
+        accessor = self
+        klass.send(:define_method, ::ActiveSupport::Inflector.pluralize(name)) do |*args|
+          case args.count
+          when 0 then next accessor.immutable_value_get_filtered(self)
+          when 1 then next accessor.immutable_value_set_filtered(self, args[0])
+          else
+            raise ::ArgumentError, "wrong number of arguments (given #{args.count}, expected 0..1)"
+          end
+        end
+      end
+
+      def apply_singular(klass)
+        accessor = self
+        klass.send(:define_method, name) do |*args|
+          case args.count
+          when 1 then next accessor.immutable_value_get_single(self, args[0])
+          when 2 then next accessor.immutable_value_set_single(self, *args[0..1])
+          else
+            raise ::ArgumentError, "wrong number of arguments (given #{args.count}, expected 1..2)"
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/instance_methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module ActsAsImmutable
+    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/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable/set_accessor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/acts_as_immutable/enumerable_accessor'
+
+module EacRubyUtils
+  module ActsAsImmutable
+    class SetAccessor < ::EacRubyUtils::ActsAsImmutable::EnumerableAccessor
+      INITIAL_VALUE = ::Set.new.freeze
+
+      # @param value [Object]
+      # @return [Set]
+      def immutable_value_set_assert(value)
+        return value if value.is_a?(::Set)
+        return value.to_set if value.respond_to?(:to_set)
+
+        ::Set.new(value)
+      end
+
+      # @return [Set] A empty Set.
+      def initial_value
+        INITIAL_VALUE
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_immutable.rb

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

data/sub/eac_ruby_utils/lib/eac_ruby_utils/acts_as_instance_method.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/introspection'
+require 'eac_ruby_utils/patches/class/common_constructor'
+require 'eac_ruby_utils/patches/module/module_parent'
+require 'eac_ruby_utils/patches/string/inflector'
+
+module EacRubyUtils
+  class ActsAsInstanceMethod
+    common_constructor :method_class
+
+    # @param sender_module [Module, nil]
+    # @return [self]
+    def setup(sender_module = nil)
+      sender_module ||= default_sender_module
+      the_setup = self
+      sender_module.define_method(method_name) do |*args, &block|
+        the_setup.method_class.new(self, *args, &block).result
+      end
+
+      self
+    end
+
+    # @return [String]
+    def method_name
+      method_class.name.demodulize.underscore.variableize
+    end
+
+    # @return [Module]
+    def default_sender_module
+      method_class.module_parent
+    end
+  end
+end