eac_ruby_utils 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756eb69d3a1307a39239c2640d0976ca21d82bbcab84bcc17237c83b65efd3f3
-  data.tar.gz: 6231ab9073aec9b7989d700af8b1098173f662adf53dfb323b554ce125ddd19b
+  metadata.gz: 35cad818d0449efc8f237c35d3d610481291074b374eec4172fa1ea01585da21
+  data.tar.gz: 6a2cb53075c922aad98fef9bdcc95ad0401cbbd23f3ff6465861bacb2b8f9833
 SHA512:
-  metadata.gz: d95f14f0bdcb4dacc15bb69b78d862b7eda60c73b2d0b6616b1a29d974f4d981c37b5dcff958a2ab6ba2378f2c6daa89c1c876abf56efeab2ddca367673ec576
-  data.tar.gz: ba6472d7a7831f55da514677a4cc088c132ff91ce50e4317b18aab0b7870724e23eede3aef543ef6d3e11606fe270b53aefe02c8d0da135fe84b3c9f54a3dafa
+  metadata.gz: 50329b46d50c97ce8dbe491367d3a1f33ecc8a347a8580d6a977847afd3eab450ca96918f5b3fb92d375031c1e6cc1fd9aeb48289447894898d25400e90c4353
+  data.tar.gz: 6c8fda13c7c6c5b6a0e7bd5e8260c0824c66e0c4786913ef7a262acb1596ab315a5a08ebdfc48ffb7ee8a1f946f293f40778dd4a987a826905cca5754a101edb

data/lib/eac_ruby_utils.rb

@@ -8,8 +8,15 @@ module EacRubyUtils
   require 'eac_ruby_utils/core_ext'
   require 'eac_ruby_utils/envs'
   require 'eac_ruby_utils/filesystem_cache'
+  require 'eac_ruby_utils/fs_cache'
   require 'eac_ruby_utils/listable'
+  require 'eac_ruby_utils/gem'
+  require 'eac_ruby_utils/gem/minitest_test'
+  require 'eac_ruby_utils/gem/rspec_test'
+  require 'eac_ruby_utils/gem/test'
+  require 'eac_ruby_utils/gem/test_all'
   require 'eac_ruby_utils/options_consumer'
+  require 'eac_ruby_utils/settings_provider'
   require 'eac_ruby_utils/patch'
   require 'eac_ruby_utils/patches'
   require 'eac_ruby_utils/paths_hash'

data/lib/eac_ruby_utils/console/docopt_runner/_settings.rb

@@ -1,45 +1,18 @@
 # frozen_string_literal: true
 
+require 'eac_ruby_utils/settings_provider'
+
 module EacRubyUtils
   module Console
     class DocoptRunner
+      include ::EacRubyUtils::SettingsProvider
+
       attr_reader :settings
 
       private
 
       def setting_value(key, required = true)
-        %i[setting_from_method setting_from_argument setting_from_constant].each do |method|
-          value = send(method, key)
-          return value if value
-        end
-        return nil unless required
-
-        raise "Setting \"#{key}\" not found. Implement a \"#{key}\" method" \
-          ", declare a #{setting_constant(key, true)} constant" \
-          "or pass a #{key.to_sym} option to #{self.class.name}.new() method."
-      end
-
-      def setting_from_argument(key)
-        settings[key]
-      end
-
-      def setting_from_constant(key)
-        constant_name = setting_constant(key)
-        begin
-          self.class.const_get(constant_name)
-        rescue NameError
-          nil
-        end
-      end
-
-      def setting_from_method(key)
-        respond_to?(key) ? send(key) : nil
-      end
-
-      def setting_constant(key, fullname = false)
-        name = key.to_s.underscore.upcase
-        name = "#{self.class.name}::#{name}" if fullname
-        name
+        super(key, required: required, order: %w[method settings_object constant])
       end
     end
   end

data/lib/eac_ruby_utils/envs/process.rb

@@ -6,13 +6,13 @@ module EacRubyUtils
   module Envs
     class Process
       def initialize(command)
-        @command = command
-        @stdout, @stderr, exit_code = Open3.capture3(command)
-        @exit_code = exit_code.to_i
+        @data = { command: command }
+        @data[:stdout], @data[:stderr], @data[:exit_code] = Open3.capture3(command)
+        @data[:exit_code] = @data[:exit_code].to_i
       end
 
       def to_h
-        { exit_code: @exit_code, stdout: @stdout, stderr: @stderr, command: @command }
+        @data.dup
       end
     end
   end

data/lib/eac_ruby_utils/fs_cache.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/filesystem_cache'
+
+module EacRubyUtils
+  class << self
+    def fs_cache
+      @fs_cache ||= ::EacRubyUtils::FilesystemCache.new(::Dir.tmpdir, 'eac_ruby_utils', '.cache')
+    end
+  end
+end

data/lib/eac_ruby_utils/gem.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs'
+
+module EacRubyUtils
+  class Gem
+    enable_simple_cache
+
+    common_constructor :root
+    set_callback :initialize, :after do
+      @root = ::Pathname.new(root).expand_path
+    end
+
+    def to_s
+      root.basename.to_s
+    end
+
+    def bundle(*args)
+      ::EacRubyUtils::Envs.local.command('bundle', *args)
+                          .envvar('BUNDLE_GEMFILE', gemfile_path)
+                          .chdir(root)
+    end
+
+    def gemfile_lock_gem_version(gem_name)
+      gemfile_lock_content.specs.find { |gem| gem.name == gem_name }.if_present(&:version)
+    end
+
+    def gemfile_lock_content
+      ::Bundler::LockfileParser.new(::Bundler.read_file(gemfile_lock_path))
+    end
+
+    private
+
+    def gemfile_path_uncached
+      root.join('Gemfile')
+    end
+
+    def gemfile_lock_path_uncached
+      root.join('Gemfile.lock')
+    end
+  end
+end

data/lib/eac_ruby_utils/gem/minitest_test.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/gem/test'
+
+module EacRubyUtils
+  class Gem
+    class MinitestTest < ::EacRubyUtils::Gem::Test
+      def bundle_exec_args
+        %w[rake test]
+      end
+
+      def dependency_gem
+        'minitest'
+      end
+
+      def test_directory
+        'test'
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/gem/rspec_test.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/gem/test'
+
+module EacRubyUtils
+  class Gem
+    class RspecTest < ::EacRubyUtils::Gem::Test
+      def bundle_exec_args
+        %w[rspec]
+      end
+
+      def dependency_gem
+        'rspec-core'
+      end
+
+      def test_directory
+        'spec'
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/gem/test.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/fs_cache'
+require 'eac_ruby_utils/listable'
+require 'eac_ruby_utils/on_clean_ruby_environment'
+
+module EacRubyUtils
+  class Gem
+    class Test
+      include ::EacRubyUtils::Listable
+
+      enable_simple_cache
+      lists.add_string :result, :failed, :nonexistent, :successful
+
+      common_constructor :gem
+
+      def elegible?
+        dependency_present? && gem.root.join(test_directory).exist?
+      end
+
+      def dependency_present?
+        gem.gemfile_path.exist? && gem.gemfile_lock_gem_version(dependency_gem).present?
+      end
+
+      def name
+        self.class.name.demodulize.gsub(/Test\z/, '')
+      end
+
+      def stdout_cache
+        root_cache.child('stdout')
+      end
+
+      def stderr_cache
+        root_cache.child('stderr')
+      end
+
+      def to_s
+        "#{gem}[#{name}]"
+      end
+
+      private
+
+      def result_uncached
+        return RESULT_NONEXISTENT unless elegible?
+        bundle_run ? RESULT_SUCCESSFUL : RESULT_FAILED
+      end
+
+      def bundle_run
+        r = ::EacRubyUtils.on_clean_ruby_environment do
+          gem.bundle('exec', *bundle_exec_args).execute
+        end
+        stdout_cache.write(r[:stdout])
+        stderr_cache.write(r[:stderr])
+        r[:exit_code].zero?
+      end
+
+      def root_cache
+        ::EacRubyUtils.fs_cache.child(gem.root.to_s.parameterize, self.class.name.parameterize)
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/gem/test_all.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/gem/minitest_test'
+require 'eac_ruby_utils/gem/rspec_test'
+
+module EacRubyUtils
+  class Gem
+    class TestAll
+      enable_console_speaker
+      enable_simple_cache
+      common_constructor :gems
+      set_callback :initialize, :after, :run
+
+      private
+
+      def all_tests_uncached
+        decorated_gems.flat_map(&:tests)
+      end
+
+      def bundle_all_gems
+        infom 'Bundling all gems...'
+        decorated_gems.each do |gem|
+          next unless gem.gemfile_path.exist?
+          infov 'Bundle install', gem
+          gem.bundle.execute!
+        end
+      end
+
+      def decorated_gems_uncached
+        gems.map { |gem| DecoratedGem.new(gem) }
+      end
+
+      def failed_tests_uncached
+        all_tests.select { |r| r.result == ::EacRubyUtils::Gem::Test::RESULT_FAILED }
+      end
+
+      def final_results_banner
+        if failed_tests.any?
+          warn 'Some test did not pass:'
+          failed_tests.each do |test|
+            infov '  * Test', test
+            infov '    * STDOUT', test.stdout_cache.content_path
+            infov '    * STDERR', test.stderr_cache.content_path
+          end
+        else
+          success 'All tests passed'
+        end
+      end
+
+      def run
+        start_banner
+        bundle_all_gems
+        test_all_gems
+        final_results_banner
+      end
+
+      def start_banner
+        infov 'Gems to test', decorated_gems.count
+      end
+
+      def test_all_gems
+        infom 'Running tests...'
+        all_tests.each do |test|
+          infov test, Result.new(test.result).tag
+        end
+      end
+
+      class DecoratedGem < ::SimpleDelegator
+        def tests
+          [::EacRubyUtils::Gem::MinitestTest.new(__getobj__),
+           ::EacRubyUtils::Gem::RspecTest.new(__getobj__)]
+        end
+      end
+
+      class Result
+        common_constructor :result
+
+        COLORS = {
+          ::EacRubyUtils::Gem::Test::RESULT_FAILED => :red,
+          ::EacRubyUtils::Gem::Test::RESULT_NONEXISTENT => :white,
+          ::EacRubyUtils::Gem::Test::RESULT_SUCCESSFUL => :green
+        }.freeze
+
+        def tag
+          result.to_s.send(color)
+        end
+
+        def color
+          COLORS.fetch(result)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/on_clean_ruby_environment.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class << self
+    def on_clean_ruby_environment
+      on_clean_envvars('BUNDLE', 'RUBY') { yield }
+    end
+
+    private
+
+    def on_clean_envvars(*start_with_vars)
+      old_values = envvars_starting_with(start_with_vars)
+      old_values.keys.each { |k| ENV.delete(k) }
+      yield
+    ensure
+      old_values&.each { |k, v| ENV[k] = v }
+    end
+
+    def envvars_starting_with(start_with_vars)
+      ENV.select { |k, _v| start_with_vars.any? { |var| k.start_with?(var) } }
+    end
+  end
+end

data/lib/eac_ruby_utils/settings_provider.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_ruby_utils/options_consumer'
+
+module EacRubyUtils
+  # Provide a option by constant, method or options object.
+  module SettingsProvider
+    def setting_constant_name(key, fullname = false)
+      name = key.to_s.underscore.upcase
+      name = "#{self.class.name}::#{name}" if fullname
+      name
+    end
+
+    def setting_search_order
+      %w[settings_object method constant]
+    end
+
+    def settings_object
+      respond_to?(settings_object_name) ? send(settings_object_name) : {}
+    end
+
+    def settings_object_name
+      'settings'
+    end
+
+    def setting_value(key, options = {})
+      options = parse_setting_value_options(options)
+      options.order.each do |method|
+        value = send("setting_value_by_#{method}", key)
+        return value if value
+      end
+      return nil unless options.required
+
+      raise "Setting \"#{key}\" not found. Supply in #{settings_object_name}, implement a " \
+        "\"#{key}\" method or declare a #{setting_constant_name(key, true)} constant."
+    end
+
+    def setting_value_by_constant(key)
+      constant_name = setting_constant_name(key)
+      begin
+        self.class.const_get(constant_name)
+      rescue NameError
+        nil
+      end
+    end
+
+    def setting_value_by_method(key)
+      respond_to?(key) ? send(key) : nil
+    end
+
+    def setting_value_by_settings_object(key)
+      settings_object[key.to_s] || settings_object[key.to_sym]
+    end
+
+    private
+
+    def parse_setting_value_options(options)
+      r = ::EacRubyUtils::OptionsConsumer.new(options).consume_all(:required, :order, ostruct: true)
+      r.required = true if r.required.nil?
+      r.order = setting_search_order if r.order.nil?
+      r
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,6 +143,12 @@ files:
 - lib/eac_ruby_utils/envs/process.rb
 - lib/eac_ruby_utils/envs/ssh_env.rb
 - lib/eac_ruby_utils/filesystem_cache.rb
+- lib/eac_ruby_utils/fs_cache.rb
+- lib/eac_ruby_utils/gem.rb
+- lib/eac_ruby_utils/gem/minitest_test.rb
+- lib/eac_ruby_utils/gem/rspec_test.rb
+- lib/eac_ruby_utils/gem/test.rb
+- lib/eac_ruby_utils/gem/test_all.rb
 - lib/eac_ruby_utils/listable.rb
 - lib/eac_ruby_utils/listable/class_methods.rb
 - lib/eac_ruby_utils/listable/instance_methods.rb
@@ -151,6 +157,7 @@ files:
 - lib/eac_ruby_utils/listable/lists.rb
 - lib/eac_ruby_utils/listable/string_list.rb
 - lib/eac_ruby_utils/listable/value.rb
+- lib/eac_ruby_utils/on_clean_ruby_environment.rb
 - lib/eac_ruby_utils/options_consumer.rb
 - lib/eac_ruby_utils/patch.rb
 - lib/eac_ruby_utils/patches.rb
@@ -173,6 +180,7 @@ files:
 - lib/eac_ruby_utils/rspec.rb
 - lib/eac_ruby_utils/rspec/conditional.rb
 - lib/eac_ruby_utils/rspec/stubbed_ssh.rb
+- lib/eac_ruby_utils/settings_provider.rb
 - lib/eac_ruby_utils/simple_cache.rb
 - lib/eac_ruby_utils/templates.rb
 - lib/eac_ruby_utils/templates/directory.rb