eac_tools 0.119.0 → 0.120.0

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/rspec/source_target_fixtures_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module EacRubyGemSupport
+  module Rspec
+    class SourceTargetFixturesController
+      enable_simple_cache
+      common_constructor :spec_paths_controller
+      delegate :example, to: :spec_paths_controller
+
+      def fixtures_dir
+        if example.respond_to?(:fixtures_dir)
+          example.fixtures_dir
+        else
+          spec_paths_controller.fixtures_directory
+        end
+      end
+
+      def write_target_fixtures?
+        ENV['WRITE_TARGET_FIXTURES'].to_bool
+      end
+
+      private
+
+      def source_target_fixtures_uncached
+        ::EacRubyGemSupport::SourceTargetFixtures.new(fixtures_dir)
+      end
+    end
+  end
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/rspec/spec_paths_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module EacRubyGemSupport
+  module Rspec
+    class SpecPathsController
+      # @!attribute [r] spec_file
+      #   @return [Pathname]
+
+      # @!method initialize(example, spec_file)
+      #   @param example [RSpec::Core::ExampleGroup]
+      #   @param spec_file [Pathname]
+      common_constructor :example, :spec_file do
+        self.spec_file = spec_file.to_pathname
+      end
+
+      # @return [Pathname]
+      def fixtures_directory
+        spec_directory.join(spec_file.basename('.*')).basename_sub { |b| "#{b}_files" }
+      end
+
+      # @return [Pathname]
+      def spec_directory
+        spec_file.parent
+      end
+    end
+  end
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/source_target_fixtures/source_target_file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EacRubyGemSupport
+  class SourceTargetFixtures
+    class SourceTargetFile
+      common_constructor :owner, :basename
+
+      def source
+        owner.source_file(basename)
+      end
+
+      def target
+        owner.target_file(basename)
+      end
+    end
+  end
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/source_target_fixtures.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module EacRubyGemSupport
+  # Lists pairs of source/target files in a directory.
+  class SourceTargetFixtures
+    class << self
+      def source_target_basename(file)
+        m = /^(.+)\.(?:source|target)(?:\..+)?$/.match(File.basename(file))
+        m ? m[1] : nil
+      end
+    end
+
+    # @!attribute [r] fixtures_directory
+    #   @return [String]
+
+    # @!method initialize(fixtures_directory)
+    #   @param fixtures_directory [Pathname]
+    common_constructor :fixtures_directory
+
+    def source_target_files
+      sources_targets_basenames.map do |basename|
+        ::EacRubyGemSupport::SourceTargetFixtures::SourceTargetFile.new(self, basename)
+      end
+    end
+
+    def source_files
+      r = []
+      source_target_files.each do |st|
+        r << st.source if st.source
+      end
+      r
+    end
+
+    def target_files
+      r = []
+      source_target_files.each do |st|
+        r << st.target if st.target
+      end
+      r
+    end
+
+    def target_file(basename)
+      fixture_file(basename, 'target')
+    end
+
+    def source_file(basename)
+      fixture_file(basename, 'source')
+    end
+
+    private
+
+    def fixture_file(basename, suffix)
+      prefix = "#{basename}.#{suffix}"
+      Dir.foreach(fixtures_directory) do |item|
+        next if %w[. ..].include?(item)
+        return File.expand_path(item, fixtures_directory) if item.starts_with?(prefix)
+      end
+      nil
+    end
+
+    def sources_targets_basenames
+      basenames = Set.new
+      Dir.foreach(fixtures_directory) do |item|
+        next if %w[. ..].include?(item)
+
+        b = self.class.source_target_basename(item)
+        basenames << b if b.present?
+      end
+      basenames
+    end
+  end
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacRubyGemSupport
+  VERSION = '0.15.0'
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_base1'
+EacRubyBase1::RootModuleSetup.perform __FILE__ do
+  ignore 'rspec/shared_examples/**/*'
+  require 'super_diff'
+  require 'super_diff/active_support'
+  require 'super_diff/rspec'
+end

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/rspec/helpers/filesystem_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.describe EacRubyGemSupport::Rspec::Helpers::Filesystem do
+  describe '#temp_file' do
+    let(:a_temp_file) { temp_file }
+
+    it { expect(temp_file).to be_file }
+  end
+
+  describe '#temp_dir' do
+    let(:a_temp_dir) { temp_dir }
+
+    it { expect(temp_dir).to be_directory }
+  end
+
+  describe '#temp_copy' do
+    let(:source_file) { Pathname.new(__FILE__) }
+    let(:source_dir) { source_file.parent }
+    let(:file_copy) { temp_copy(source_file) }
+    let(:dir_copy) { temp_copy(source_dir) }
+
+    it { expect(file_copy).to be_file }
+    it { expect(file_copy.read).to eq(source_file.read) }
+    it { expect(file_copy).not_to eq(source_file) }
+
+    it { expect(dir_copy).to be_directory }
+    it { expect(dir_copy.join(source_file.basename).read).to eq(source_file.read) }
+    it { expect(dir_copy).not_to eq(source_dir) }
+  end
+end

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/rspec/shared_examples/source_target_fixtures_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+RSpec.describe "RSpec.shared_examples('source_target_fixtures')" do # rubocop:disable RSpec/DescribeClass
+  include_examples 'source_target_fixtures', __FILE__
+
+  def source_data(file)
+    YAML.load_file(file)
+  end
+end

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/rspec/shared_examples/source_target_fixtures_spec_files/one.source.yaml

@@ -0,0 +1,2 @@
+---
+value: Test!

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/rspec/shared_examples/source_target_fixtures_spec_files/one.target.yaml

@@ -0,0 +1,2 @@
+---
+value: Test!

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/rspec/shared_examples/spec_paths_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe "RSpec.shared_examples('spec_paths')" do # rubocop:disable RSpec/DescribeClass
+  include_context 'spec_paths', __FILE__
+
+  it do
+    expect(spec_file).to eq(__FILE__.to_pathname)
+  end
+
+  it do
+    expect(spec_directory).to eq(__FILE__.to_pathname.dirname)
+  end
+
+  it do
+    expect(fixtures_directory).to eq(__FILE__.to_pathname.dirname.join('spec_paths_spec_files'))
+  end
+end

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/source_target_fixtures_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe EacRubyGemSupport::SourceTargetFixtures do
+  let(:fixtures_dir) { File.join(__dir__, 'source_target_fixtures_spec_files') }
+  let(:instance) { described_class.new(fixtures_dir) }
+
+  describe '#source_target_files' do
+    it { expect(instance.source_target_files.count).to eq(3) }
+
+    (1..3).each do |index|
+      basename = "stub#{index}" # rubocop:disable RSpec/LeakyLocalVariable
+      let(basename) { instance.source_target_files.find { |stf| stf.basename == basename } }
+
+      it { expect(send(basename)).to be_present }
+      it { expect(send(basename).basename).to eq(basename) }
+    end
+
+    it { expect(stub1.source).to eq(File.join(fixtures_dir, 'stub1.source.txt')) }
+    it { expect(stub1.target).to eq(File.join(fixtures_dir, 'stub1.target.html')) }
+    it { expect(stub2.source).to eq(File.join(fixtures_dir, 'stub2.source.html')) }
+    it { expect(stub2.target).to be_nil }
+    it { expect(stub3.source).to be_nil }
+    it { expect(stub3.target).to eq(File.join(fixtures_dir, 'stub3.target.yaml')) }
+  end
+end

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/source_target_fixtures_spec_files/stub1.source.txt

@@ -0,0 +1 @@
+

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/source_target_fixtures_spec_files/stub1.target.html

@@ -0,0 +1 @@
+

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/source_target_fixtures_spec_files/stub2.source.html

@@ -0,0 +1 @@
+

data/sub/eac_ruby_gem_support/spec/lib/eac_ruby_gem_support/source_target_fixtures_spec_files/stub3.target.yaml

@@ -0,0 +1 @@
+

data/sub/{avm-eac_redmine_plugin_base0 → eac_ruby_gem_support}/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require 'avm/eac_redmine_plugin_base0'
+require 'eac_ruby_utils'
 require 'eac_ruby_gem_support'
 EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__))

data/sub/eac_ruby_utils/.avm.yaml

@@ -0,0 +1,3 @@
+---
+locale: en
+bundle_test_command: exec rspec

data/sub/eac_ruby_utils/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.local
+Gemfile.lock
+doc/
+.yardoc/

data/sub/eac_ruby_utils/.gitrepo

@@ -0,0 +1,7 @@
+[subrepo]
+  cmdver = 0.4.9
+  commit = bd7cd8909484da68230700c817ad15b79f4f2aca
+  method = merge
+  parent = 12585d6280788727a139ff23a00e0ff963b21d51
+  branch = master
+  remote = https://github.com/esquilo-azul/eac_ruby_utils.git

data/sub/eac_ruby_utils/.rspec

@@ -0,0 +1 @@
+--require spec/spec_helper --color --format doc --default-path . --pattern 'spec/**/*_spec.rb'

data/sub/eac_ruby_utils/.yardopts

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb

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,28 @@
+# 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 = '>= 3.2' # rubocop:disable Gemspec/RequiredRubyVersion
+
+  s.add_dependency 'activesupport', '>= 6.1.7.10'
+  s.add_dependency 'addressable', '~> 2.9'
+  s.add_dependency 'bundler'
+  s.add_dependency 'memoized', '~> 1.1', '>= 1.1.3'
+  s.add_dependency 'net-ssh', '~> 4.2'
+  s.add_dependency 'ostruct'
+  s.add_dependency 'zeitwerk', '~> 2.8', '>= 2.8.3'
+  s.add_development_dependency 'avm-eac_ubuntu_base0', '~> 0.7', '>= 0.7.1'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.15'
+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, &)
+        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