eac_ruby_gem_support 0.8.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13a8eb8edc90d11d33090a072aa8e067a55bd53817e3483a4f94d2de692cf12c
-  data.tar.gz: 9c1eb39f5cc95e5f32fed0bbb2956b36ad9943b8123a45a860af404755930e39
+  metadata.gz: 604189d5f2c83ce11eb9e52435b54de3883861fcaf742a0023eed4bd171654d5
+  data.tar.gz: b5613db689320ecda2285e19236068df36e1c95c4c14e95a012c99c6d54b1330
 SHA512:
-  metadata.gz: 41aeb063f73b535aea447bc5a4553928555363fd800139da1d048984995c88de4be053ad6acc0394e0c1086048495d6cb2d9b733ed1f61cd04a051d08376b64e
-  data.tar.gz: dcbaafbe599e411976a472a065cad33bbec9c4599641a021fd1e75500c798f1a01724cdece6fdfef2e513e0631f47054bf7c0f58539a621810f5a7cafe0554d6
+  metadata.gz: 2fa46da053d9c5c5b97839c8372cf6097cc73e541d8c4e825cc40969ab81cd45c7a18eedef98510fcdee408a932a56625bb57020c55423aea5d491b6c06a2255
+  data.tar.gz: 75dbfb0333063516002e019f9114d04a5bb1e7a89283258fd4010d62584c4477b0b07ebdf50c8f16308495db4982df217c7b40db5b526e9d4af03700641212ac

data/.rubocop.yml

@@ -23,12 +23,18 @@ Rails/DynamicFindBy:
   Enabled: false
 Rails/Exit:
   Enabled: false
+Rails/FindEach:
+  Enabled: false
 Rails/Output:
   Enabled: false
 Rails/SkipsModelValidations:
   Enabled: false
 Rails/TimeZone:
   Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
 Style/AsciiComments:
   Enabled: false
 Style/Documentation:

data/lib/eac_ruby_gem_support/rspec/setup.rb

@@ -12,10 +12,10 @@ module EacRubyGemSupport
       extend ::ActiveSupport::Concern
       include ::EacRubyGemSupport::Rspec::Specs::Rubocop
 
+      SETUPS = %w[load_path example_persistence filesystem_helper shared_examples].freeze
+
       def self.extended(setup_obj)
-        setup_obj.setup_load_path
-        setup_obj.setup_example_persistence
-        setup_obj.setup_filesystem_helper
+        SETUPS.each { |s| setup_obj.send("setup_#{s}") }
       end
 
       def setup_filesystem_helper
@@ -32,6 +32,11 @@ module EacRubyGemSupport
         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')

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_gem_support/rspec/shared_examples/spec_paths'
+require 'eac_ruby_gem_support/rspec/source_target_fixtures_controller'
+require 'eac_ruby_gem_support/source_target_fixtures'
+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.load_file(target_file)
+  end
+
+  def target_content(data)
+    data.to_yaml
+  end
+
+  def target_file_extname
+    '.yaml'
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_gem_support/rspec/spec_paths_controller'
+require 'eac_ruby_utils/core_ext'
+
+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/lib/eac_ruby_gem_support/rspec/source_target_fixtures_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_gem_support/source_target_fixtures'
+require 'eac_ruby_utils/core_ext'
+
+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/lib/eac_ruby_gem_support/rspec/spec_paths_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+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/lib/eac_ruby_gem_support/source_target_fixtures/source_target_file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+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/lib/eac_ruby_gem_support/source_target_fixtures.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyGemSupport
+  # Lists pairs of source/target files in a directory.
+  class SourceTargetFixtures
+    require_sub __FILE__
+
+    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/lib/eac_ruby_gem_support/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_gem_support
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.119'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.119.2
+        version: '0.120'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.119'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.119.2
+        version: '0.120'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,60 +44,60 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.57'
+        version: '1.60'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.57.1
+        version: 1.60.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.57'
+        version: '1.60'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.57.1
+        version: 1.60.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.21'
+        version: '2.23'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.21.2
+        version: 2.23.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.21'
+        version: '2.23'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.21.2
+        version: 2.23.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '2.26'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.24.1
+        version: 2.26.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '2.26'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.24.1
+        version: 2.26.1
 description: 
 email: 
 executables: []
@@ -116,7 +110,13 @@ files:
 - lib/eac_ruby_gem_support/rspec/helpers/filesystem.rb
 - lib/eac_ruby_gem_support/rspec/helpers/utils.rb
 - lib/eac_ruby_gem_support/rspec/setup.rb
+- lib/eac_ruby_gem_support/rspec/shared_examples/source_target_fixtures.rb
+- lib/eac_ruby_gem_support/rspec/shared_examples/spec_paths.rb
+- lib/eac_ruby_gem_support/rspec/source_target_fixtures_controller.rb
+- lib/eac_ruby_gem_support/rspec/spec_paths_controller.rb
 - lib/eac_ruby_gem_support/rspec/specs/rubocop.rb
+- lib/eac_ruby_gem_support/source_target_fixtures.rb
+- lib/eac_ruby_gem_support/source_target_fixtures/source_target_file.rb
 - lib/eac_ruby_gem_support/version.rb
 homepage: https://github.com/esquilo-azul/eac_ruby_gem_support
 licenses: []