ehbrs-tools 0.11.0 → 0.12.0

data/vendor/eac_ruby_utils/lib/eac_ruby_utils/require_sub.rb

@@ -2,9 +2,52 @@
 
 module EacRubyUtils
   class << self
-    def require_sub(file)
+    def require_sub(file, options = {})
+      ::EacRubyUtils::RequireSub.new(file, options).apply
+    end
+  end
+
+  class RequireSub
+    BASE_OPTION_KEY = :base
+    INCLUDE_MODULES_OPTION_KEY = :include_modules
+    REQUIRE_DEPENDENCY_OPTION_KEY = :require_dependency
+
+    attr_reader :file, :options
+
+    def initialize(file, options = {})
+      @file = file
+      @options = options
+    end
+
+    def apply
+      require_sub_files
+      include_modules
+    end
+
+    private
+
+    def include_modules
+      return unless options[INCLUDE_MODULES_OPTION_KEY]
+
+      base.constants.each do |constant_name|
+        constant = base.const_get(constant_name)
+        next unless constant.is_a?(::Module) && !constant.is_a?(::Class)
+
+        base.include(constant)
+      end
+    end
+
+    def base
+      options[BASE_OPTION_KEY] || raise('Option :base not setted')
+    end
+
+    def require_sub_files
       Dir["#{File.dirname(file)}/#{::File.basename(file, '.*')}/*.rb"].sort.each do |path|
-        require path
+        if options[REQUIRE_DEPENDENCY_OPTION_KEY]
+          require_dependency path
+        else
+          require path
+        end
       end
     end
   end

data/vendor/eac_ruby_utils/lib/eac_ruby_utils/version.rb

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

data/vendor/eac_ruby_utils/lib/eac_ruby_utils/yaml.rb

@@ -3,10 +3,93 @@
 require 'yaml'
 
 module EacRubyUtils
+  # A safe YAML loader/dumper with common types included.
   class Yaml
     class << self
-      def load_common(string)
-        ::YAML.safe_load(string, [::Symbol, ::Date])
+      DEFAULT_PERMITTED_CLASSES = [::Array, ::Date, ::FalseClass, ::Hash, ::NilClass, ::Numeric,
+                                   ::String, ::Symbol, ::Time, ::TrueClass].freeze
+
+      def dump(object)
+        ::YAML.dump(sanitize(object))
+      end
+
+      def load(string)
+        ::YAML.safe_load(string, permitted_classes)
+      end
+
+      def permitted_classes
+        DEFAULT_PERMITTED_CLASSES
+      end
+
+      def sanitize(object)
+        Sanitizer.new(object).result
+      end
+
+      def yaml?(object)
+        return false unless object.is_a?(::String)
+        return false unless object.start_with?('---')
+
+        load(object)
+        true
+      rescue ::Psych::SyntaxError
+        false
+      end
+
+      class Sanitizer
+        attr_reader :source
+
+        RESULT_TYPES = %w[permitted enumerableable hashable].freeze
+
+        def initialize(source)
+          @source = source
+        end
+
+        def result
+          RESULT_TYPES.each do |type|
+            return send("result_#{type}") if send("result_#{type}?")
+          end
+
+          source.to_s
+        end
+
+        private
+
+        def result_enumerableable?
+          source.respond_to?(:to_a) && !source.is_a?(::Hash)
+        end
+
+        def result_enumerableable
+          source.to_a.map { |child| sanitize_value(child) }
+        end
+
+        def result_hashable?
+          source.respond_to?(:to_h)
+        end
+
+        def result_hashable
+          source.to_h.map { |k, v| [k.to_sym, sanitize_value(v)] }.to_h
+        end
+
+        def result_nil?
+          source.nil?
+        end
+
+        def result_nil
+          nil
+        end
+
+        def result_permitted?
+          (::EacRubyUtils::Yaml.permitted_classes - [::Array, ::Hash])
+            .any? { |klass| source.is_a?(klass) }
+        end
+
+        def result_permitted
+          source
+        end
+
+        def sanitize_value(value)
+          self.class.new(value).result
+        end
       end
     end
   end

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/common_concern_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/common_concern'
+
+RSpec.describe ::EacRubyUtils::CommonConcern do
+  let(:instance) do
+    described_class.new do
+      self.valor = 'changed'
+    end
+  end
+
+  module MyModule
+    module ClassMethods
+      def my_class_method
+        'class'
+      end
+    end
+
+    module InstanceMethods
+      def my_instance_method
+        'instance'
+      end
+    end
+  end
+
+  class MyClass
+    class << self
+      attr_accessor :valor
+    end
+  end
+
+  let(:subject) { MyClass.new }
+
+  before do
+    instance.setup(MyModule)
+    MyClass.include MyModule
+  end
+
+  it { expect(subject.my_instance_method).to eq('instance') }
+  it { expect(subject.class.my_class_method).to eq('class') }
+  it { expect(subject.class.valor).to eq('changed') }
+end

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/common_constructor_spec.rb

@@ -27,6 +27,7 @@ RSpec.describe ::EacRubyUtils::CommonConstructor do
     it "attribute \"#{attr}\" equal to \"#{expected_value}\"" do
       expect(subject.send(attr)).to eq(expected_value)
     end
+
     [false, true].each do |include_all|
       it "respond_to?('#{attr}', #{include_all}) == #{include_all}" do
         expect(subject.respond_to?("#{attr}=", include_all)).to eq(include_all)

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/console/docopt_runner_spec.rb

@@ -66,7 +66,7 @@ RSpec.describe ::EacRubyUtils::Console::DocoptRunner do
 
     let(:instance) { RunnerWithSubcommands.new }
 
-    context '#subcommands?' do
+    describe '#subcommands?' do
       it 'returns true' do
         expect(instance.subcommands?).to eq(true)
       end
@@ -85,19 +85,19 @@ RSpec.describe ::EacRubyUtils::Console::DocoptRunner do
         it { expect(instance.target_doc).to include('Subcommands:') }
       end
 
-      context '#subcommand' do
+      describe '#subcommand' do
         it 'is of subcommand class' do
           expect(instance.subcommand).to be_a(RunnerWithSubcommands::MySubCommand)
         end
       end
 
-      context '#context' do
+      describe '#context' do
         it 'accesses instance methods by subcommand' do
           expect(instance.subcommand.context(:parent_arg)).to eq('value0')
         end
       end
 
-      context '#run' do
+      describe '#run' do
         it 'calls subcommand' do
           instance.run
           expect(instance.subarg_value).to eq('value1')
@@ -109,7 +109,7 @@ RSpec.describe ::EacRubyUtils::Console::DocoptRunner do
     context 'when subcommand is invalid' do
       let(:instance) { RunnerWithSubcommands.new(argv: %w[value0 invalid-subcommand]) }
 
-      context '#run' do
+      describe '#run' do
         it 'raises Docopt::Exit' do
           expect { instance.run }.to raise_error(::Docopt::Exit)
         end

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/console/speaker_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe ::EacRubyUtils::Console::Speaker do
     r
   end
 
-  context '#request_input' do
+  describe '#request_input' do
     it 'recover value from hash list' do
       allow(instance).to receive(:request_string).and_return('opt1')
       list = { opt1: 'value1', opt2: 'value2' }

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/envs/executable_spec.rb

@@ -5,6 +5,7 @@ require 'eac_ruby_utils/envs/local_env'
 
 RSpec.describe ::EacRubyUtils::Envs::Executable do
   let(:env) { ::EacRubyUtils::Envs::LocalEnv.new }
+
   context 'when program exist' do
     let(:instance) { described_class.new(env, 'cat', '--version') }
 
@@ -18,12 +19,15 @@ RSpec.describe ::EacRubyUtils::Envs::Executable do
     let(:instance) { described_class.new(env, 'this_cannot_exist', '--version') }
 
     it { expect(instance.exist?).to eq(false) }
+
     it {
       expect { instance.validate! }.to raise_error(
         described_class.const_get('ProgramNotFoundError')
       )
     }
+
     it { expect(instance.validate).to be_present }
+
     it {
       expect { instance.command }.to raise_error(
         described_class.const_get('ProgramNotFoundError')

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/fs/temp/temp_spec.rb

@@ -7,6 +7,6 @@ RSpec.describe ::EacRubyUtils::Fs::Temp::Directory do
     let(:instance) { described_class.new }
 
     it { expect(instance).to be_directory }
-    it { expect { instance.remove! }.to_not raise_error }
+    it { expect { instance.remove! }.not_to raise_error }
   end
 end

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/listable_spec.rb

@@ -11,6 +11,8 @@ class Stub
   lists.add_integer :code, 7 => :a, 13 => :b
   lists.add_string :cadeia, :a, :b, :c
   lists.add_string :type, 'Namespace::ClazzA' => :a, 'Namespace::ClazzB' => :b
+  lists.add_symbol :simbolo, :a, :b, :c
+  lists.add_symbol :tipado, :tipo_aaa => :a, 'tipo_bbb' => :b
 end
 
 RSpec.describe ::EacRubyUtils::Listable do
@@ -19,6 +21,8 @@ RSpec.describe ::EacRubyUtils::Listable do
     it { expect(Stub.lists.code.values).to eq([7, 13]) }
     it { expect(Stub.lists.cadeia.values).to eq(%w[a b c]) }
     it { expect(Stub.lists.type.values).to eq(%w[Namespace::ClazzA Namespace::ClazzB]) }
+    it { expect(Stub.lists.simbolo.values).to eq(%i[a b c]) }
+    it { expect(Stub.lists.tipado.values).to eq(%i[tipo_aaa tipo_bbb]) }
   end
 
   context 'value instance options' do
@@ -26,18 +30,31 @@ RSpec.describe ::EacRubyUtils::Listable do
       expect(Stub.lists.inteiro.options)
         .to eq([['Inteiro A', 1], ['Inteiro BB', 2], ['Inteiro CCC', 3]])
     }
+
     it {
       expect(Stub.lists.code.options)
         .to eq([['Código A', 7], ['Código B', 13]])
     }
+
     it {
       expect(Stub.lists.cadeia.options)
         .to eq([['Cadeia AAA', 'a'], ['Cadeia BB', 'b'], ['Cadeia C', 'c']])
     }
+
     it {
       expect(Stub.lists.type.options)
         .to eq([['Tipo A', 'Namespace::ClazzA'], ['Tipo B', 'Namespace::ClazzB']])
     }
+
+    it {
+      expect(Stub.lists.simbolo.options)
+        .to eq([['Simbolo A', :a], ['Simbolo B', :b], ['Simbolo C', :c]])
+    }
+
+    it {
+      expect(Stub.lists.tipado.options)
+        .to eq([['Tipado A', :tipo_aaa], ['Tipado B', :tipo_bbb]])
+    }
   end
 
   context 'constants' do
@@ -50,6 +67,11 @@ RSpec.describe ::EacRubyUtils::Listable do
     it { expect(Stub::CADEIA_C).to eq('c') }
     it { expect(Stub::TYPE_A).to eq('Namespace::ClazzA') }
     it { expect(Stub::TYPE_B).to eq('Namespace::ClazzB') }
+    it { expect(Stub::SIMBOLO_A).to eq(:a) }
+    it { expect(Stub::SIMBOLO_B).to eq(:b) }
+    it { expect(Stub::SIMBOLO_C).to eq(:c) }
+    it { expect(Stub::TIPADO_A).to eq(:tipo_aaa) }
+    it { expect(Stub::TIPADO_B).to eq(:tipo_bbb) }
   end
 
   context 'values instances' do
@@ -110,60 +132,70 @@ RSpec.describe ::EacRubyUtils::Listable do
 
     context 'when inteiro value is A' do
       before { instance.inteiro = Stub::INTEIRO_A }
+
       it { expect(instance.inteiro_label).to eq('Inteiro A') }
       it { expect(instance.inteiro_description).to eq('Inteiro A Descr.') }
     end
 
     context 'when inteiro value is A' do
       before { instance.inteiro = Stub::INTEIRO_B }
+
       it { expect(instance.inteiro_label).to eq('Inteiro BB') }
       it { expect(instance.inteiro_description).to eq('Inteiro BB Descr.') }
     end
 
     context 'when inteiro value is C' do
       before { instance.inteiro = Stub::INTEIRO_C }
+
       it { expect(instance.inteiro_label).to eq('Inteiro CCC') }
       it { expect(instance.inteiro_description).to eq('Inteiro CCC Descr.') }
     end
 
     context 'when code value is A' do
       before { instance.code = Stub::CODE_A }
+
       it { expect(instance.code_label).to eq('Código A') }
       it { expect(instance.code_description).to eq('Código A Descr.') }
     end
 
     context 'when code value is B' do
       before { instance.code = Stub::CODE_B }
+
       it { expect(instance.code_label).to eq('Código B') }
       it { expect(instance.code_description).to eq('Código B Descr.') }
     end
 
     context 'when cadeia value is A' do
       before { instance.cadeia = Stub::CADEIA_A }
+
       it { expect(instance.cadeia_label).to eq('Cadeia AAA') }
       it { expect(instance.cadeia_description).to eq('Cadeia AAA Descr.') }
     end
 
     context 'when cadeia value is B' do
       before { instance.cadeia = Stub::CADEIA_B }
+
       it { expect(instance.cadeia_label).to eq('Cadeia BB') }
       it { expect(instance.cadeia_description).to eq('Cadeia BB Descr.') }
     end
 
     context 'when cadeia value is C' do
       before { instance.cadeia = Stub::CADEIA_C }
+
       it { expect(instance.cadeia_label).to eq('Cadeia C') }
       it { expect(instance.cadeia_description).to eq('Cadeia C Descr.') }
     end
 
     context 'when type value is A' do
       before { instance.type = Stub::TYPE_A }
+
       it { expect(instance.type_label).to eq('Tipo A') }
       it { expect(instance.type_description).to eq('Tipo A Descr.') }
     end
 
     context 'when type value is B' do
       before { instance.type = Stub::TYPE_B }
+
       it { expect(instance.type_label).to eq('Tipo B') }
       it { expect(instance.type_description).to eq('Tipo B Descr.') }
     end

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/options_consumer_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe ::EacRubyUtils::OptionsConsumer do
     end
   end
 
-  context '#consume_all' do
+  describe '#consume_all' do
     subject(:instance) { described_class.new(a: 'a_value', b: 'b_value', c: 'c_value') }
 
     it 'return all options in arguments' do

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/patches/hash/sym_keys_hash_spec.rb

@@ -5,7 +5,7 @@ require 'eac_ruby_utils/patches/hash/sym_keys_hash'
 RSpec.describe ::Hash do
   let(:a_hash) { { 'a' => 'a_value', 1 => '1_value', s: 's_value' } }
 
-  context '#to_sym_keys_hash' do
+  describe '#to_sym_keys_hash' do
     it 'converts all keys to symbols' do
       expect(a_hash.to_sym_keys_hash).to eq(a: 'a_value', '1': '1_value', s: 's_value')
     end

data/vendor/eac_ruby_utils/spec/lib/eac_ruby_utils/patches/object/if_present_spec.rb

@@ -3,7 +3,7 @@
 require 'eac_ruby_utils/patches/object/if_present'
 
 RSpec.describe ::Object do
-  context '#if_present' do
+  describe '#if_present' do
     it { expect(nil.if_present).to eq(nil) }
     it { expect(nil.if_present('default')) .to eq('default') }
     it { expect(nil.if_present('default') { |_v| 'calculated' }).to eq('default') }