eac_tools 0.97.0 → 0.97.2

data/sub/eac_config/spec/lib/eac_config/entry_path_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_config/entry_path'
+
+RSpec.describe EacConfig::EntryPath do
+  describe '#assert' do
+    {
+      ['a.b.c'] => %w[a b c],
+      [['a', 1], 'b', []] => %w[a 1 b],
+      ['a', 'b', ['c', 1.2], 'd', 'e.f'] => %w[a b c 1 2 d e f]
+    }.each do |data|
+      source = data[0]
+      expected_parts = data[1]
+
+      context "when source is #{source}" do
+        let(:instance) { described_class.assert(source) }
+
+        it { expect(instance.parts).to eq(expected_parts) }
+      end
+    end
+
+    [['a..c'], ['a', ' ']].each do |source|
+      context "when invalid source is #{source}" do
+        it do
+          expect { described_class.assert(source) }.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/envvars_node/entry_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_config/envvars_node/entry'
+
+RSpec.describe EacConfig::EnvvarsNode::Entry do
+  describe '#entry_key_to_envvar_name' do
+    {
+      'a.entry.value' => 'A_ENTRY_VALUE',
+      'appli-cation_0.var_one' => 'APPLICATION_0_VAR_ONE'
+    }.each do |input, expected_result|
+      it { expect(described_class.entry_path_to_envvar_name(input)).to eq(expected_result) }
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/envvars_node_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'eac_config/envvars_node'
+require 'eac_ruby_utils/ruby'
+
+RSpec.describe EacConfig::EnvvarsNode do
+  let(:instance) { described_class.new }
+
+  before do
+    ENV['COMMON'] = 'AAA'
+    ENV['BLANK'] = ''
+    ENV.delete('NO_EXIST')
+  end
+
+  context 'with common entry' do
+    let(:entry) { instance.entry('common') }
+
+    it { expect(entry).to be_a(EacConfig::Entry) }
+    it { expect(entry.value).to eq('AAA') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+
+    context 'with a clean ruby environment' do
+      let(:entry_value) do
+        EacRubyUtils::Ruby.on_clean_environment do
+          entry.value
+        end
+      end
+
+      it { expect(entry_value).to eq('AAA') }
+    end
+  end
+
+  context 'with blank entry' do
+    let(:entry) { instance.entry('blank') }
+
+    it { expect(entry).to be_a(EacConfig::Entry) }
+    it { expect(entry.value).to eq('') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+  end
+
+  context 'with not existing entry' do
+    let(:entry) { instance.entry('no.exist') }
+
+    it { expect(entry).to be_a(EacConfig::Entry) }
+    it { expect(entry.value).to be_nil }
+    it { expect(entry.found_node).to be_nil }
+    it { expect(entry).not_to be_found }
+  end
+end

data/sub/eac_config/spec/lib/eac_config/old_configs_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'eac_config/old_configs'
+
+RSpec.describe EacConfig::OldConfigs do
+  let(:configs_key) { 'configsspec' }
+  let(:storage_path) do
+    file = Tempfile.new(configs_key)
+    path = file.path
+    file.close
+    file.unlink
+    path
+  end
+  let(:instance) { described_class.new(configs_key, storage_path: storage_path) }
+
+  describe '#storage_path' do
+    it { expect(instance.storage_path).to eq(storage_path) }
+  end
+
+  describe '#write' do
+    let(:entry_key) { 'parent.child' }
+
+    before do
+      instance[entry_key] = 'value1'
+      instance.save
+    end
+
+    it { expect(YAML.load_file(storage_path)).to eq(parent: { child: 'value1' }) }
+  end
+
+  describe '#read' do
+    let(:present_key) { 'a.present.key' }
+    let(:blank_key) { 'a.blank.key' }
+
+    before do
+      instance[present_key] = 'A value'
+      instance[blank_key] = ''
+      instance.save
+      instance.load
+    end
+
+    it { expect(instance[present_key]).to be_present }
+    it { expect(instance[blank_key]).to be_present }
+  end
+end

data/sub/eac_config/spec/lib/eac_config/paths_hash_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'eac_config/paths_hash'
+
+RSpec.describe EacConfig::PathsHash do
+  let(:source_hash) do
+    {
+      parent: {
+        child1: {
+          child1_1: 'v1_1', # rubocop:disable Naming/VariableNumber
+          child1_2: 'v1_2' # rubocop:disable Naming/VariableNumber
+        },
+        child2: 'v2'
+      }
+    }
+  end
+  let(:instance) { described_class.new(source_hash) }
+
+  describe '#[]' do
+    {
+      'parent.child1.child1_1' => 'v1_1',
+      'parent.child1.child1_2' => 'v1_2',
+      'parent.child2' => 'v2',
+      'no_exist' => nil,
+      'parent.child1' => {
+        child1_1: 'v1_1', # rubocop:disable Naming/VariableNumber
+        child1_2: 'v1_2' # rubocop:disable Naming/VariableNumber
+      }
+    }.each do |entry_key, expected_value|
+      it { expect(instance[entry_key]).to eq(expected_value) }
+    end
+
+    ['.only_suffix', '', '.', 'only_prefx.', 'empty..part'].each do |entry_key|
+      it "invalid entry key \"#{entry_key}\" raises EntryKeyError" do
+        expect { instance[entry_key] }.to raise_error(EacConfig::PathsHash::EntryKeyError)
+      end
+    end
+  end
+
+  describe '#[]=' do
+    let(:source_hash) { {} }
+
+    before do
+      instance['a.b.c'] = '123'
+    end
+
+    it { expect(instance.to_h).to eq(a: { b: { c: '123' } }) }
+  end
+
+  describe '#key?' do
+    {
+      'parent.child1.child1_1' => true,
+      'parent.child1.child1_2' => true,
+      'parent.child1.child1_2.no_exist' => false,
+      'parent.child1.child1_3' => false,
+      'parent.child2' => true,
+      'no_exist' => false,
+      'parent.child1' => true
+    }.each do |entry_key, expected_value|
+      it { expect(instance.key?(entry_key)).to eq(expected_value) }
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/struct'
+require 'eac_config/yaml_file_node'
+
+RSpec.describe EacConfig::YamlFileNode do
+  storages = %w[1 1_1 1_2 1_2_1].map do |suffix|
+    key = "storage#{suffix}"
+    subpath = "#{key}.yaml"
+    subpath = "storage1_2/#{subpath}" if suffix == '1_2_1'
+    EacRubyUtils::Struct.new(suffix: suffix, key: key, subpath: subpath.to_pathname)
+  end
+
+  let(:fixtures_dir) { Pathname.new(__dir__).join('yaml_file_node_spec_files') }
+  let(:instance) { storage1 }
+
+  storages.each do |storage|
+    let(storage.key) { described_class.new(fixtures_dir.join(storage.subpath)) }
+  end
+
+  describe '#entry' do
+    context 'with common entry' do
+      let(:entry) { instance.entry('common') }
+
+      it { expect(entry.value).to eq('AAA') }
+      it { expect(entry.found_node).to eq(instance) }
+      it { expect(entry).to be_found }
+    end
+
+    storages.each do |storage|
+      context "with entry in loaded path \"#{storage.subpath}\"" do
+        let(:entry) { instance.entry(storage.key) }
+        let(:storage_node) { send(storage.key) }
+
+        it { expect(entry).to be_a(EacConfig::Entry) }
+        it { expect(entry).to be_found }
+        it { expect(entry.value).to eq(storage.key) }
+        it { expect(entry.found_node.url).to eq(storage_node.url) }
+      end
+    end
+
+    context 'with not existing entry' do
+      let(:entry) { instance.entry('no_exist') }
+
+      it { expect(entry).to be_a(EacConfig::Entry) }
+      it { expect(entry.value).to be_nil }
+      it { expect(entry.found_node).to be_nil }
+      it { expect(entry).not_to be_found }
+    end
+  end
+
+  describe '#entries' do
+    context 'when search path is "common"' do
+      let(:path) { 'common' }
+      let(:actual) { instance.entries(path).node_entries }
+      let(:expected) { [EacConfig::YamlFileNode::Entry.new(storage1, path)] }
+
+      it { expect(actual).to eq(expected) }
+    end
+
+    context 'when search path is "same.path"' do
+      let(:path) { 'same.path' }
+      let(:actual) { instance.entries(path).node_entries }
+      let(:expected) do
+        [storage1_1, storage1_2_1].map do |n|
+          EacConfig::YamlFileNode::Entry.new(n, 'same.path')
+        end
+      end
+
+      it { expect(actual).to eq(expected) }
+    end
+
+    context 'when search path is "*.search_me"' do
+      let(:path) { '*.search_me' }
+      let(:actual) { instance.entries(path).node_entries }
+      let(:expected) do
+        [
+          [storage1, 'storage1_a'], [storage1, 'storage1_b'],
+          [storage1_2, 'storage1_2_a'], [storage1_2, 'storage1_2_b'], [storage1_2, 'storage1_2_c']
+        ].map do |args|
+          EacConfig::YamlFileNode::Entry.new(args[0], "#{args[1]}.search_me")
+        end
+      end
+
+      it { expect(actual).to eq(expected) }
+    end
+  end
+end

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1.yaml

@@ -0,0 +1,10 @@
+---
+common: AAA
+load_path:
+  - storage1_1.yaml
+  - storage1_2.yaml
+storage1: storage1
+storage1_a:
+  search_me: 1_a
+storage1_b:
+  search_me: 1_b

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_1.yaml

@@ -0,0 +1,4 @@
+---
+storage1_1: storage1_1
+same:
+  path: SAME_PATH_1_1

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_2/storage1_2_1.yaml

@@ -0,0 +1,4 @@
+---
+storage1_2_1: storage1_2_1
+same:
+  path: SAME_PATH_1_2_1

data/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_2.yaml

@@ -0,0 +1,10 @@
+---
+load_path:
+  - ./storage1_2/storage1_2_1.yaml
+storage1_2: storage1_2
+storage1_2_a:
+  search_me: 1_2_a
+storage1_2_b:
+  search_me: 1_2_a
+storage1_2_c:
+  search_me: 1_2_a

data/sub/{avm-eac_asciidoctor_base0 → eac_config}/spec/spec_helper.rb

@@ -2,7 +2,3 @@
 
 require 'eac_ruby_utils/rspec/default_setup'
 EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__))
-  .stub_avm_contexts
-
-require 'eac_ruby_utils/require_sub'
-EacRubyUtils.require_sub __FILE__

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,26 @@
+# 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.7'
+  s.add_dependency 'bundler'
+  s.add_dependency 'filesize', '~> 0.2'
+  s.add_dependency 'net-ssh', '~> 4.2'
+  s.add_development_dependency 'avm-eac_ubuntu_base0', '~> 0.5', '>= 0.5.1'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.10'
+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