eac_tools 0.117.1 → 0.117.2

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/rspec/helpers/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+require 'tempfile'
+
+module EacRubyGemSupport
+  module Rspec
+    module Helpers
+      module Utils
+        # @return [StandardError, nil] If block raises an error, return this error. If not, return
+        #   +nil+.
+        def capture_error
+          yield
+          nil
+        rescue ::StandardError => e
+          e
+        end
+      end
+    end
+  end
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/rspec/setup/rubocop.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'rubocop'
+
+module EacRubyGemSupport
+  module Rspec
+    module Setup
+      module Rubocop
+        RUN_LAST_METADATA_KEY = :eac_ruby_gem_support_rubocop_check
+
+        def describe_rubocop # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          this = self
+          ::RSpec.describe ::RuboCop, RUN_LAST_METADATA_KEY => true do
+            before do
+              ::RuboCop::ConfigLoader.ignore_parent_exclusion = true
+            end
+
+            let(:root_path) { this.app_root_path }
+            let(:config_store) do
+              r = ::RuboCop::ConfigStore.new
+              r.for(root_path)
+              r
+            end
+            let(:runner) { ::RuboCop::Runner.new({}, config_store) }
+
+            it 'rubocop return ok' do
+              expect(::Dir.chdir(root_path) { runner.run([]) }).to eq(true)
+            end
+          end
+        end
+
+        # @return [void]
+        def setup_rubocop
+          setup_rubocop_last
+          describe_rubocop unless specific_files_requested?
+        end
+
+        # @return [void]
+        def setup_rubocop_last
+          previous_strategy = ::RSpec.configuration.ordering_registry.fetch(:global)
+          ::RSpec.configure do |config|
+            config.register_ordering(:global) do |list|
+              ordered = previous_strategy.order(list)
+              last, others = ordered.partition { |item| item.metadata[RUN_LAST_METADATA_KEY] }
+              others + last
+            end
+          end
+        end
+
+        # @return [Boolean]
+        def specific_files_requested?
+          config = ::RSpec.configuration
+          files_or_directories = config.instance_variable_get(:@files_or_directories_to_run)
+          default_pattern = ::RSpec::Core::Configuration.new.pattern
+          files_or_directories != [config.default_path] || config.pattern != default_pattern
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+
+module EacRubyGemSupport
+  module Rspec
+    module Setup
+      extend ::ActiveSupport::Concern
+
+      SETUPS = %w[load_path example_persistence filesystem_helper shared_examples rubocop].freeze
+
+      def self.extended(setup_obj)
+        SETUPS.each { |s| setup_obj.send("setup_#{s}") }
+      end
+
+      def setup_filesystem_helper
+        rspec_config.include ::EacRubyGemSupport::Rspec::Helpers::Filesystem
+        rspec_config.include ::EacRubyGemSupport::Rspec::Helpers::Utils
+        rspec_config.after(:each) { purge_temp_files }
+      end
+
+      def setup_load_path
+        $LOAD_PATH.push app_root_path.join('lib').to_path
+      end
+
+      def setup_example_persistence
+        rspec_config.example_status_persistence_file_path = example_persistence_path.to_path
+      end
+
+      def setup_shared_examples
+        require 'eac_ruby_gem_support/rspec/shared_examples/spec_paths'
+        require 'eac_ruby_gem_support/rspec/shared_examples/source_target_fixtures'
+      end
+
+      # @return [Pathname]
+      def example_persistence_path
+        root_tmp.join('example_status_persistence')
+      end
+
+      # The root directory for temporary files.
+      # @return [Pathname]
+      def root_tmp
+        r = ::Pathname.new(::Dir.tmpdir)
+              .join("#{app_root_path.expand_path.to_path.variableize}_specs_tmp")
+        r.mkpath unless r.exist?
+        r
+      end
+
+      require_sub __FILE__, include_modules: true
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+RSpec.shared_examples 'source_target_fixtures' do |spec_file| # rubocop:disable Metrics/BlockLength
+  include_examples 'spec_paths', spec_file
+  fixtures_controller = EacRubyGemSupport::Rspec::SourceTargetFixturesController
+                          .new(spec_paths_controller)
+
+  let(:fixtures_controller) { fixtures_controller }
+  let(:spec_file) { spec_file }
+
+  it 'fixtures directory should exist' do
+    expect(File.directory?(fixtures_controller.fixtures_dir)).to be true
+  end
+
+  context 'with fixtures directory' do
+    it 'has at least one file' do
+      expect(source_target_fixtures.source_target_files.count).to be > 0 # rubocop:disable Style/NumericPredicate
+    end
+
+    fixtures_controller.source_target_fixtures.source_target_files.each do |st|
+      context "when source file is \"#{File.basename(st.source)}\"" do
+        if fixtures_controller.write_target_fixtures?
+          it 'writes target data' do
+            sd = sort_results(source_data(st.source))
+            basename = EacRubyGemSupport::SourceTargetFixtures.source_target_basename(st.source)
+            target_file = File.expand_path("../#{basename}.target#{target_file_extname}", st.source)
+            File.write(target_file, target_content(sd))
+          end
+        else
+          it 'parses data' do
+            assert_source_target_complete(st)
+            sd = source_data(st.source)
+            td = target_data(st.target)
+            expect(sort_results(sd)).to eq(sort_results(td))
+          end
+        end
+      end
+    end
+  end
+
+  delegate :source_target_fixtures, to: :fixtures_controller
+
+  def assert_source_target_complete(source_target)
+    expect(source_target.source).to(be_truthy, "Source not found (Target: #{source_target.target})")
+    expect(source_target.target).to(be_truthy, "Target not found (Source: #{source_target.source})")
+  end
+
+  def source_data(source_file)
+    instance = described_class.new(source_file)
+    return instance.data if instance.respond_to?(:data)
+
+    raise "#{instance} has no \"data\" method. You need to implement \"#{instance}.data\" or " \
+          "\"#{self}.source_data(source_file)\""
+  end
+
+  def sort_results(results)
+    results
+  end
+
+  def target_data(target_file)
+    YAML.unsafe_load_file(target_file)
+  end
+
+  def target_content(data)
+    data.to_yaml
+  end
+
+  def target_file_extname
+    '.yaml'
+  end
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support/rspec/shared_examples/spec_paths.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'spec_paths' do |the_spec_file|
+  cattr_accessor :spec_paths_controller
+  self.spec_paths_controller = EacRubyGemSupport::Rspec::SpecPathsController.new(self,
+                                                                                 the_spec_file)
+
+  %i[fixtures_directory spec_directory spec_file].each do |m|
+    let(m) { self.class.spec_paths_controller.send(m) }
+  end
+end

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.14.0'
+end

data/sub/eac_ruby_gem_support/lib/eac_ruby_gem_support.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_base1'
+EacRubyBase1::RootModuleSetup.perform __FILE__ do
+  ignore 'rspec/shared_examples/**/*'
+  require 'active_support/ordered_options' # Fix "super_diff" '0.18.0'.
+  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/eac_ruby_gem_support/spec/spec_helper.rb

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