eac_tools 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52be2b949c88f70cad235bb01bab0f0155f1093364f0328a83ec022bcd5446e9
-  data.tar.gz: b9b1dcf2119964ebe0052931f853579bbce9dc274412a780075dfc1df24cf550
+  metadata.gz: 9f62da51457512bc25b5321faa19507d05bd3fa231950ef6cfcbf39f70809f39
+  data.tar.gz: 641dc2b412c60738c9d5acb21d217cdcb5459430501c63498114d0336a6b7465
 SHA512:
-  metadata.gz: 9bfcb9a6e13b090f254550a6c3b0f563f0d5c61fdef6227e29c660bec2f2d419803dbed1655ae29945f1c82d0f26e0f9c76408a74718f92d2817e749fb339ec2
-  data.tar.gz: 34bf06360e871a1e7a88275da9222fb6ea92a75b0e177cb0ce6ff87c2bce3ee8412d7564dcfa045a9acc8cc90f2783d11241f4b3921b205433e937b29b605320
+  metadata.gz: a5a9048310a062489b32ecf8578dfdfad82a3d8ee9d7da42fdd1ea368d1c31d218828ff62641ce5b755a944f4310e268d85bff1f2adacf6c932bdbe47f1ae3ac
+  data.tar.gz: 82da69b9433611450a88634316e05e162d3af4fccb9da97b51747fe42fcfd535f2462111ab9152e56ffd07d04c55381b0297cfefce1b0f6b0249c4405a45d1ff

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    eac_tools (0.3.0)
-      avm-eac_generic_base0 (~> 0.2, >= 0.2.2)
+    eac_tools (0.4.0)
+      avm-eac_generic_base0 (~> 0.3)
       avm-eac_rails_base1 (~> 0.3, >= 0.3.1)
       avm-eac_redmine_base0 (~> 0.8)
       avm-eac_redmine_plugin_base0 (~> 0.1, >= 0.1.1)
-      avm-eac_ruby_base1 (~> 0.8, >= 0.8.2)
+      avm-eac_ruby_base1 (~> 0.9)
       avm-tools (~> 0.121)
-      eac_ruby_utils (~> 0.95, >= 0.95.1)
+      eac_ruby_utils (~> 0.95, >= 0.95.2)
 
 PATH
   remote: sub/avm-eac_generic_base0
   specs:
-    avm-eac_generic_base0 (0.2.2)
-      avm (~> 0.19)
-      eac_ruby_utils (~> 0.80)
+    avm-eac_generic_base0 (0.3.0)
+      avm (~> 0.24)
+      eac_ruby_utils (~> 0.05, >= 0.95.2)
 
 PATH
   remote: sub/avm-eac_rails_base1
@@ -46,7 +46,7 @@ PATH
 PATH
   remote: sub/avm-eac_ruby_base1
   specs:
-    avm-eac_ruby_base1 (0.8.2)
+    avm-eac_ruby_base1 (0.9.0)
       avm (~> 0.23)
       avm-eac_generic_base0 (~> 0.2)
       eac_ruby_utils (~> 0.95, >= 0.95.1)
@@ -73,7 +73,7 @@ PATH
 PATH
   remote: sub/avm
   specs:
-    avm (0.23.0)
+    avm (0.24.0)
       eac_cli (~> 0.27, >= 0.27.6)
       eac_docker (~> 0.3)
       eac_git (~> 0.6)
@@ -108,6 +108,16 @@ PATH
       eac_fs (~> 0.10)
       eac_ruby_utils (~> 0.95, >= 0.95.1)
 
+PATH
+  remote: sub/eac_ruby_utils
+  specs:
+    eac_ruby_utils (0.95.2)
+      activesupport (>= 4, < 7)
+      addressable (~> 2.6)
+      bundler
+      filesize
+      net-ssh (~> 4.2)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -185,11 +195,6 @@ GEM
       rubocop (~> 0.80.1)
       rubocop-rails (~> 2.4.2)
       rubocop-rspec (~> 1.38.1)
-    eac_ruby_utils (0.95.1)
-      activesupport (>= 4, < 7)
-      addressable (~> 2.6)
-      filesize
-      net-ssh (~> 4.2)
     eac_templates (0.3.1)
       eac_config (~> 0.5)
       eac_ruby_utils (~> 0.64)
@@ -300,6 +305,7 @@ DEPENDENCIES
   eac_fs!
   eac_ruby_base0!
   eac_ruby_gem_support (~> 0.5.1)
+  eac_ruby_utils!
   eac_tools!
 
 BUNDLED WITH

data/lib/eac_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacTools
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/sub/avm/lib/avm/sources/base/configuration.rb

@@ -11,19 +11,27 @@ module Avm
       module Configuration
         CONFIGURATION_FILENAMES = %w[.avm.yml .avm.yaml].freeze
 
+        # @return [EacRubyUtils::Envs::Command, nil]
+        def configuration_value_to_env_command(value)
+          configuration_value_to_shell_words(value).if_present { |v| env.command(v).chdir(path) }
+        end
+
+        # @return [Array<String>, nil]
+        def configuration_value_to_shell_words(value)
+          return nil if value.blank?
+
+          value.is_a?(::Enumerable) ? value.map(&:to_s) : ::Shellwords.split(value.to_s)
+        end
+
         # @return [Array<String>, nil]
         def read_configuration_as_shell_words(key)
-          configuration.entry(key).value.if_present do |v|
-            v.is_a?(::Enumerable) ? v.map(&:to_s) : ::Shellwords.split(v.to_s)
-          end
+          configuration_value_to_shell_words(configuration.entry(key).value)
         end
 
         # Utility to read a configuration as a [EacRubyUtils::Envs::Command].
         # @return [EacRubyUtils::Envs::Command]
         def read_configuration_as_env_command(key)
-          read_configuration_as_shell_words(key).if_present do |v|
-            env.command(v).chdir(path)
-          end
+          configuration_value_to_env_command(configuration.entry(key).value)
         end
 
         private

data/sub/avm/lib/avm/sources/base/testing.rb

@@ -1,25 +1,68 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs/command'
 
 module Avm
   module Sources
     class Base
       module Testing
-        TEST_COMMAND_KEY = 'test.command'
+        DEFAULT_TEST_COMMANDS = {}.freeze
+        TEST_KEY = 'test'
+        TEST_COMMAND_KEY = "#{TEST_KEY}.command"
+        TEST_COMMANDS_KEY = "#{TEST_KEY}.commands"
 
         def configured_test_command
           read_configuration_as_env_command(TEST_COMMAND_KEY)
         end
 
-        # @return [Avm::Sources::Tester]
-        def tester
-          tester_class.new(self)
+        # @return [Hash<String, EacRubyUtils::Envs::Command>, nil]
+        def configured_test_commands
+          configured_value_as_test_commands(configuration.entry(TEST_COMMANDS_KEY).value)
         end
 
-        # @return [Class<Avm::Sources::Tester>
-        def tester_class
-          Avm::Sources::Tester
+        # @return [Hash<String, EacRubyUtils::Envs::Command>, nil]
+        def configured_value_as_test_commands(value)
+          return nil if value.blank?
+
+          [::EacRubyUtils::Envs::Command, ::Hash, ::Enumerable].each do |type|
+            next unless value.is_a?(type)
+
+            return send(
+              "configured_#{type.name.demodulize.variableize}_value_as_test_commands",
+              value
+            )
+          end
+
+          raise "Value for test commands should be a Hash or a Enumerable (Actual: #{value})"
+        end
+
+        # @return [Hash<String, EacRubyUtils::Envs::Command>]
+        def default_test_commands
+          DEFAULT_TEST_COMMANDS
+        end
+
+        # @return [Enumerable<EacRubyUtils::Envs::Command>]
+        def test_commands
+          configured_test_commands ||
+            configured_value_as_test_commands(configured_test_command)
+          default_test_commands
+        end
+
+        protected
+
+        def configured_command_value_as_test_commands(value)
+          configured_enumerable_value_as_test_commands([value])
+        end
+
+        def configured_enumerable_value_as_test_commands(value)
+          configured_hash_value_as_test_commands(
+            value.each_with_index.map { |v| ["test_#{v[1]}", v[0]] }.to_h
+          )
+        end
+
+        def configured_hash_value_as_test_commands(value)
+          value.map { |k, v| [k.to_s.strip, configuration_value_to_env_command(v)] }.to_h
         end
       end
     end

data/sub/avm/lib/avm/sources/tests/builder.rb

@@ -44,6 +44,13 @@ module Avm
           create_units(main_source.subs)
         end
 
+        # @return [Array<Avm::Sources::Tests::Single>]
+        def create_source_units(source)
+          source.test_commands.map do |test_name, test_command|
+            ::Avm::Sources::Tests::Single.new(self, source, test_name, test_command)
+          end
+        end
+
         # @return [Avm::Sources::Tests::Single]
         def create_unit(source)
           ::Avm::Sources::Tests::Single.new(self, source)
@@ -51,7 +58,7 @@ module Avm
 
         # @return [Array<Avm::Sources::Tests::Single>]
         def create_units(sources)
-          sources.map { |a_source| create_unit(a_source) }
+          sources.flat_map { |a_source| create_source_units(a_source) }
         end
 
         # @return [Avm::Sources::Tests::Single]

data/sub/avm/lib/avm/sources/tests/single.rb

@@ -14,9 +14,8 @@ module Avm
         enable_simple_cache
         enable_speaker
 
-        common_constructor :builder, :source
+        common_constructor :builder, :source, :test_name, :test_command
 
-        delegate :logs, :result, to: :tester
         delegate :to_s, to: :id
 
         def failed?
@@ -25,11 +24,7 @@ module Avm
 
         # @return [String]
         def id
-          if main?
-            MAIN_SOURCE_ID
-          else
-            relative_path_from_main_source.to_s
-          end
+          "#{main? ? MAIN_SOURCE_ID : relative_path_from_main_source}\##{test_name}"
         end
 
         def main?
@@ -47,8 +42,32 @@ module Avm
 
         private
 
-        def tester_uncached
-          source.tester
+        # @return [EacFs::Logs]
+        def logs_uncached
+          ::EacFs::Logs.new.add(:stdout).add(:stderr)
+        end
+
+        # @return [Avm::Sources::Tests::Result]
+        def result_uncached
+          if test_command.blank?
+            ::Avm::Sources::Tests::Result::NONEXISTENT
+          elsif run_test_command
+            ::Avm::Sources::Tests::Result::SUCESSFUL
+          else
+            ::Avm::Sources::Tests::Result::FAILED
+          end
+        end
+
+        def run_test_command
+          execute_command_and_log(test_command)
+        end
+
+        # @return [true, false]
+        def execute_command_and_log(command)
+          r = command.execute
+          logs[:stdout].write(r[:stdout])
+          logs[:stderr].write(r[:stderr])
+          r[:exit_code].zero?
         end
       end
     end

data/sub/avm/lib/avm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avm
-  VERSION = '0.23.0'
+  VERSION = '0.24.0'
 end

data/sub/avm-eac_generic_base0/Gemfile

@@ -3,3 +3,6 @@
 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/avm-eac_generic_base0/avm-eac_generic_base0.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib,locale}/**/*']
 
-  s.add_dependency 'avm', '~> 0.19'
-  s.add_dependency 'eac_ruby_utils', '~> 0.80'
+  s.add_dependency 'avm', '~> 0.24'
+  s.add_dependency 'eac_ruby_utils', '~> 0.05', '>= 0.95.2'
 
-  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.4'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.5.1'
 end

data/sub/avm-eac_generic_base0/lib/avm/eac_generic_base0/sources/base.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'avm/eac_generic_base0/sources/tester'
 require 'avm/sources/base'
 require 'eac_ruby_utils/core_ext'
 
@@ -11,11 +10,6 @@ module Avm
         require_sub __FILE__, include_modules: true
         enable_abstract_methods
 
-        # @return [Avm::EacGenericBase0::Sources::Tester]
-        def tester_class
-          Avm::EacGenericBase0::Sources::Tester
-        end
-
         def valid?
           ::Avm::Registry.scms.detect_optional(path).present?
         end

data/sub/avm-eac_generic_base0/lib/avm/eac_generic_base0/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module EacGenericBase0
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/sub/avm-eac_ruby_base1/lib/avm/eac_ruby_base1/sources/base.rb

@@ -3,7 +3,6 @@
 require 'avm/eac_generic_base0/sources/base'
 require 'avm/eac_ruby_base1/rubygems/version_file'
 require 'avm/eac_ruby_base1/sources/update'
-require 'avm/eac_ruby_base1/sources/tester'
 require 'avm/eac_ruby_base1/sources/runners/bundler'
 require 'avm/version_number'
 require 'eac_ruby_utils/core_ext'
@@ -12,12 +11,21 @@ module Avm
   module EacRubyBase1
     module Sources
       class Base < ::Avm::EacGenericBase0::Sources::Base
-        require_sub __FILE__, include_modules: :prepend, require_dependency: true
+        RSPEC_TEST_COMMAND = 'rspec'
+
+        require_sub __FILE__, include_modules: :prepend
 
         # To-do: dismiss this method at Avm::EacRailsBase1::Instance and remove.
         # @return [EacRubyUtils::Envs::BaseEnv]
         attr_reader :env
 
+        # @return [Hash<String, EacRubyUtils::Envs::Command>]
+        def default_test_commands
+          {
+            RSPEC_TEST_COMMAND => rspec_test_command
+          }
+        end
+
         # To-do: dismiss this method at Avm::EacRailsBase1::Instance and remove.
         # @return [Avm::EacRubyBase1::Sources::Base]
         def env_set(env)
@@ -26,13 +34,13 @@ module Avm
           self
         end
 
-        def valid?
-          gemfile_path.exist? || gemspec_path.present?
+        # @return [EacRubyUtils::Envs::Command]
+        def rspec_test_command
+          bundle('exec', 'rspec', '--fail-fast').chdir_root
         end
 
-        # @return [Avm::EacRubyBase1::Sources::Tester]
-        def tester_class
-          Avm::EacRubyBase1::Sources::Tester
+        def valid?
+          gemfile_path.exist? || gemspec_path.present?
         end
 
         def update

data/sub/avm-eac_ruby_base1/lib/avm/eac_ruby_base1/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module EacRubyBase1
-    VERSION = '0.8.2'
+    VERSION = '0.9.0'
   end
 end

data/sub/eac_ruby_utils/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in users_support.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

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,24 @@
+# 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.add_dependency 'activesupport', '>= 4', '< 7'
+  s.add_dependency 'addressable', '~> 2.6'
+  s.add_dependency 'bundler'
+  s.add_dependency 'filesize'
+  s.add_dependency 'net-ssh', '~> 4.2'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.5.1'
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/abstract_methods.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/class/self_included_modules'
+require 'eac_ruby_utils/patches/module/common_concern'
+
+module EacRubyUtils
+  # Support to abstract methods.
+  #
+  # Usage:
+  #
+  #   require 'eac_ruby_utils/abstract_methods'
+  #
+  #   class BaseClass
+  #     include EacRubyUtils::AbstractMethods
+  #
+  #     abstract_methods :mymethod
+  #   end
+  #
+  #   BaseClass.new.mymethod # raise "Abstract method: mymethod"
+  #
+  #   class SubClass
+  #     def mymethod
+  #       "Implemented"
+  #     end
+  #   end
+  #
+  #   SubClass.new.mymethod # return "Implemented"
+  module AbstractMethods
+    common_concern
+
+    class << self
+      def abstract?(a_class)
+        a_class.self_included_modules.include?(::EacRubyUtils::AbstractMethods)
+      end
+    end
+
+    module ClassMethods
+      def abstract_methods(*methods_names)
+        methods_names.each do |method_name|
+          define_method method_name do
+            raise_abstract_method(method_name)
+          end
+        end
+      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
+
+      def abstract_method?(method_name)
+        self.class.abstract_methods.include?(method_name.to_sym)
+      end
+
+      def raise_abstract_method(method_name)
+        raise ::NoMethodError, "Abstract method \"#{method_name}\" hit in \"#{self}\"" \
+          " (Class: #{self.class})"
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/arguments_consumer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'ostruct'
+
+module EacRubyUtils
+  class ArgumentsConsumer
+    class << self
+      def parse(args, positional = [], options = {})
+        new(args, positional, options).data
+      end
+    end
+
+    attr_reader :positional, :default_options
+
+    def initialize(positional, default_options)
+      @positional = positional.dup.freeze
+      @default_options = default_options.dup.freeze
+    end
+
+    def parse(args)
+      Parser.new(self, args).data
+    end
+
+    class Parser
+      attr_reader :data, :arguments_consumer
+
+      def initialize(arguments_consumer, args)
+        @arguments_consumer = arguments_consumer
+        @data = ::ActiveSupport::HashWithIndifferentAccess.new
+        @options_found = false
+        arguments_consumer.positional.each { |key| data[key] = nil }
+        data.merge!(arguments_consumer.default_options)
+        args.each_with_index { |value, index| add_arg(value, index) }
+        data.freeze
+      end
+
+      private
+
+      def add_arg(value, index)
+        arg = ::OpenStruct.new(value: value, index: index)
+        if arg.value.is_a?(::Hash)
+          add_hash_arg(arg)
+        else
+          add_positional_arg(arg)
+        end
+      end
+
+      def add_hash_arg(arg)
+        check_no_more_arguments(arg)
+        data.merge!(arg.value)
+        @options_found = true
+      end
+
+      def add_positional_arg(arg)
+        check_no_more_arguments(arg)
+        invalid_argument arg, 'No more valid positional' if
+          arg.index >= arguments_consumer.positional.count
+        data[arguments_consumer.positional[arg.index]] = arg.value
+      end
+
+      def check_no_more_arguments(arg)
+        return unless @options_found
+
+        invalid_argument arg, 'Hash already found - no more positional allowed'
+      end
+
+      def invalid_argument(arg, message)
+        raise InvalidArgumentError.new(self, arg, message)
+      end
+    end
+
+    class InvalidArgumentError < StandardError
+      def initialize(args_consumer, arg, message)
+        @args_consumer = args_consumer
+        @arg = arg
+        super "#{message} (Arg: #{arg}, Args Consumer: #{args_consumer})"
+      end
+    end
+  end
+end

data/sub/eac_ruby_utils/lib/eac_ruby_utils/bit.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/patches/module/compare_by'
+
+module EacRubyUtils
+  class Bit
+    VALID_VALUES = [0, 1].freeze
+
+    class << self
+      def assert(obj)
+        return obj if obj.is_a?(self)
+
+        new(obj.to_i)
+      end
+
+      def valid_integer?(value)
+        value.is_a?(::Integer) && VALID_VALUES.include?(value)
+      end
+
+      def validate_integer(value)
+        return value if valid_integer?(value)
+
+        raise(::ArgumentError, "Invalid bit value: #{value} (Valid: #{VALID_VALUES})")
+      end
+    end
+
+    attr_reader :value
+    compare_by :value
+    delegate :to_s, :zero?, to: :value
+
+    # @param value [Integer]
+    def initialize(value)
+      @value = self.class.validate_integer(value)
+    end
+
+    # @return [Boolean]
+    def one?
+      !zero?
+    end
+
+    # @return [Integer]
+    def to_i
+      value
+    end
+  end
+end