defmastership 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b282623e3f26fd7e1b8f88df3605ffb8a536c5d7a71e3f8f6b41d937d740c77c
-  data.tar.gz: af43d982dc66141dced00cf731300759631b5730fda62b250c43bde1d026d844
+  metadata.gz: 1e4fb0225a55bdddfb2c4f0c3dbca650f991c9c018ea1d80bd9f6b7481b9e8b2
+  data.tar.gz: d70ae41ef99b5437241cec107f99ed924be71419c3c2c704e52035367c06c8bd
 SHA512:
-  metadata.gz: dbcdd3fc1b665dd867760123c43927f6f27b83726000a8e567f20fc716269ae073ca4c70f3362c029ff4347d6f0371068b6e15ab893e74fef89cf6419cbd9487
-  data.tar.gz: 67e21c19f23d236f53bda017cfd5fdf1ce7700490b8e68c805c042f3f902123c7d1f275b06046a2c3ecc6614e5bf527dc3db0d5fb6addbc24c0a002337ae06bd
+  metadata.gz: b698312e2bd57eab8331876ec1b4284a682e319d870c037b21272467c1b6e0e44e822eb49228dbc8edfe34c1916c3593eebc294c5611b49605cebb1fc3eb0336
+  data.tar.gz: f24030b68f490ebe51fe60d0573876e3e9388c077ef7f1ee02561341db96a22955cd3071ffe2c33857e43b330f08fb19aa7d0b3bc0f413486b765499550cffcb

data/features/definition_version.feature

@@ -221,6 +221,47 @@ Feature: definitions version
         :ref_tag: THE_TAG
     """
 
+  Scenario: Update explicit version based on git tag with definitions inside a git submodule
+    Given I initialize a git repo in "submodule_origin"
+    And a file named "submodule_origin/ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    And I add and commit the changes in repo "submodule_origin"
+    And I initialize a git repo
+    And I set the environment variable "GIT_ALLOW_PROTOCOL" to "file"
+    And I add the repo "submodule_origin" as a submodule "submodule"
+    And I set the "THE_TAG" tag
+    And a file named "submodule/ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_tag: 'THE_TAG'
+    """
+    And I set the environment variable "GIT_ALLOW_PROTOCOL" to "file"
+    When I successfully run `defmastership modify --modifications update_requirement_version submodule/ref_doc.adoc`
+    Then the file "submodule/ref_doc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    modified text.
+    --
+    """
+
   Scenario: Update explicit version based on git tag on a different git repo
     And a file named "defmastership-example.adoc" with:
     """

data/features/step_definitions/git_steps.rb

@@ -20,3 +20,33 @@ Given('I set the {string} tag') do |tag_name|
   git = Git.open(Aruba.config.home_directory)
   git.add_tag(tag_name)
 end
+
+Given('I initialize a git repo in {string}') do |repo_dir|
+  require 'fileutils'
+  repo_path = File.join(Aruba.config.home_directory, repo_dir)
+  FileUtils.mkdir_p(repo_path)
+
+  git = Git.init(repo_path)
+  git.config('user.name', 'Bob Léponge')
+  git.config('user.email', 'bob.léponge@example.com')
+end
+
+Given('I add and commit the changes in repo {string}') do |repo_dir|
+  repo_path = File.join(Aruba.config.home_directory, repo_dir)
+  git = Git.open(repo_path)
+
+  git.config('user.name', 'Bob Léponge')
+  git.config('user.email', 'bob.léponge@example.com')
+  git.add(all: true)
+  git.commit('Commit changes')
+end
+
+Given('I add the repo {string} as a submodule {string}') do |remote_dir, submodule_dir|
+  run_command("git submodule add ./#{remote_dir} #{submodule_dir}")
+  last_command_started.wait
+
+  main_git = Git.open(Aruba.config.home_directory)
+  main_git.add('.gitmodules')
+  main_git.add(submodule_dir)
+  main_git.commit("Add submodule #{submodule_dir}")
+end

data/lib/defmastership/modifier/update_def_version.rb

@@ -49,8 +49,14 @@ module Defmastership
       private
 
       def parse_ref_files_from_git(adoc_sources, tmpdir)
-        Git.clone(ref_repo, tmpdir, branch: ref_tag)
+        repo_url = Helper.resolve_remote_url(ref_repo)
+
+        Git.clone(repo_url, tmpdir, branch: ref_tag, recursive: true)
         ref_sources = ref_document.empty? ? adoc_sources.keys : ref_document
+        parse_tmpdir_files(tmpdir, ref_sources)
+      end
+
+      def parse_tmpdir_files(tmpdir, ref_sources)
         ref_sources.each do |adoc_file|
           @ref_document.parse_file_with_preprocessor("#{tmpdir}/#{adoc_file}")
         end
@@ -78,6 +84,26 @@ module Defmastership
 
       # Helper functions
       module Helper
+        # @param path [String] the repository path
+        # @return [String, nil] the origin URL if found
+        def self.find_origin_url(path)
+          local_git = Git.open(path)
+          origin_remote = local_git.remotes.find { |remote| remote.name.eql?('origin') }
+          origin_remote&.url
+        rescue ArgumentError
+          nil
+        end
+
+        # @param path [String] the repository path
+        # @return [String] the resolved remote URL
+        def self.resolve_remote_url(path)
+          if File.directory?(path)
+            find_origin_url(path) || path
+          else
+            path
+          end
+        end
+
         # @param doc [Document] the document with defintions
         # @param match [MatchData] Regexp match matching a reference
         # @return [Definition] the definition from a +Document+ with a matching reference

data/lib/defmastership/version.rb

@@ -3,6 +3,6 @@
 
 module Defmastership
   # [String] Gem version
-  VERSION = '1.3.6'
+  VERSION = '1.3.7'
   public_constant :VERSION
 end

data/spec/unit/defmastership/modifier/update_def_version_spec.rb

@@ -116,6 +116,7 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       before do
         allow(Dir).to(receive(:mktmpdir).and_yield('tmp'))
         allow(Git).to(receive(:clone))
+        allow(Git).to(receive(:open)).and_raise(ArgumentError)
         allow(Defmastership::Document).to(receive(:new).twice.and_return(ref_document, document))
         allow(document).to(receive(:parse_file_with_preprocessor).with('file1.adoc'))
         allow(document).to(receive(:parse_file_with_preprocessor).with('file2.adoc'))
@@ -131,7 +132,7 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       end
 
       it { expect(Dir).to(have_received(:mktmpdir).with('defmastership')) }
-      it { expect(Git).to(have_received(:clone).with('.', 'tmp', branch: 'THE_TAG')) }
+      it { expect(Git).to(have_received(:clone).with('.', 'tmp', branch: 'THE_TAG', recursive: true)) }
       it { expect(Defmastership::Document).to(have_received(:new).twice) }
       it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).with('tmp/file1.adoc')) }
       it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).with('tmp/file2.adoc')) }
@@ -142,6 +143,111 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       end
     end
 
+    context 'when ref_repo is not a directory' do
+      subject(:modifier) do
+        described_class.new(ref_tag: 'THE_TAG', ref_repo: 'not_a_directory', def_type: 'req', first_version: 'a')
+      end
+
+      let(:adoc_sources) do
+        {
+          'file1.adoc' => "[define,req,REFERENCE]\nfile1 line2"
+        }
+      end
+
+      before do
+        document = instance_double(Defmastership::Document, 'document')
+        ref_document = instance_double(Defmastership::Document, 'ref_document')
+        definition = instance_double(Defmastership::Definition, 'definition')
+        ref_definition = instance_double(Defmastership::Definition, 'ref_definitions')
+
+        allow(Dir).to(receive(:mktmpdir).and_yield('tmp'))
+        allow(Git).to(receive(:clone))
+        allow(File).to(receive(:directory?).with('not_a_directory').and_return(false))
+
+        allow(Defmastership::Document).to(receive(:new).twice.and_return(ref_document, document))
+        allow(document).to(receive_messages(parse_file_with_preprocessor: nil, ref_to_def: definition))
+        allow(ref_document).to(receive_messages(parse_file_with_preprocessor: nil, ref_to_def: ref_definition))
+        allow(ref_definition).to(receive_messages(explicit_version: nil, sha256_short: 'something_else'))
+        allow(definition).to(receive(:sha256_short).and_return('something'))
+      end
+
+      it 'clones the non-directory path directly as the repository URL' do
+        modifier.do_modifications(adoc_sources)
+        expect(Git).to(have_received(:clone).with('not_a_directory', 'tmp', branch: 'THE_TAG', recursive: true))
+      end
+    end
+
+    context 'when ref_repo is a local git repository' do
+      subject(:modifier) { described_class.new(ref_tag: 'THE_TAG', def_type: 'req', first_version: 'a') }
+
+      let(:local_git) { instance_double(Git::Base) }
+      let(:remote)    { instance_double(Git::Remote, name: 'origin', url: 'https://gitlab.example.com/repo.git') }
+      let(:adoc_sources) do
+        {
+          'file1.adoc' => "[define,req,REFERENCE]\nfile1 line2"
+        }
+      end
+
+      before do
+        document = instance_double(Defmastership::Document, 'document')
+        ref_document = instance_double(Defmastership::Document, 'ref_document')
+        definition = instance_double(Defmastership::Definition, 'definition')
+        ref_definition = instance_double(Defmastership::Definition, 'ref_definitions')
+
+        allow(Dir).to(receive(:mktmpdir).and_yield('tmp'))
+        allow(Git).to(receive(:clone))
+        allow(File).to(receive(:directory?).with('.').and_return(true))
+        allow(Git).to(receive(:open)).with('.').and_return(local_git)
+        allow(local_git).to(receive(:remotes)).and_return([remote])
+
+        allow(Defmastership::Document).to(receive(:new).twice.and_return(ref_document, document))
+        allow(document).to(receive_messages(parse_file_with_preprocessor: nil, ref_to_def: definition))
+        allow(ref_document).to(receive_messages(parse_file_with_preprocessor: nil, ref_to_def: ref_definition))
+        allow(ref_definition).to(receive_messages(explicit_version: nil, sha256_short: 'something_else'))
+        allow(definition).to(receive(:sha256_short).and_return('something'))
+
+        modifier.do_modifications(adoc_sources)
+      end
+
+      it { expect(Git).to(have_received(:clone).with('https://gitlab.example.com/repo.git', 'tmp', branch: 'THE_TAG', recursive: true)) }
+    end
+
+    context 'when ref_repo is a local git repository without an origin remote' do
+      subject(:modifier) { described_class.new(ref_tag: 'THE_TAG', def_type: 'req', first_version: 'a') }
+
+      let(:local_git) { instance_double(Git::Base) }
+      let(:remote)    { instance_double(Git::Remote, name: 'upstream', url: 'https://gitlab.example.com/repo.git') }
+      let(:adoc_sources) do
+        {
+          'file1.adoc' => "[define,req,REFERENCE]\nfile1 line2"
+        }
+      end
+
+      before do
+        document = instance_double(Defmastership::Document, 'document')
+        ref_document = instance_double(Defmastership::Document, 'ref_document')
+        definition = instance_double(Defmastership::Definition, 'definition')
+        ref_definition = instance_double(Defmastership::Definition, 'ref_definitions')
+
+        allow(Dir).to(receive(:mktmpdir).and_yield('tmp'))
+        allow(Git).to(receive(:clone))
+        allow(File).to(receive(:directory?).with('.').and_return(true))
+        allow(Git).to(receive(:open)).with('.').and_return(local_git)
+        # Setup the mock so it doesn't find 'origin'
+        allow(local_git).to(receive(:remotes)).and_return([remote])
+
+        allow(Defmastership::Document).to(receive(:new).twice.and_return(ref_document, document))
+        allow(document).to(receive_messages(parse_file_with_preprocessor: nil, ref_to_def: definition))
+        allow(ref_document).to(receive_messages(parse_file_with_preprocessor: nil, ref_to_def: ref_definition))
+        allow(ref_definition).to(receive_messages(explicit_version: nil, sha256_short: 'something_else'))
+        allow(definition).to(receive(:sha256_short).and_return('something'))
+
+        modifier.do_modifications(adoc_sources)
+      end
+
+      it { expect(Git).to(have_received(:clone).with('.', 'tmp', branch: 'THE_TAG', recursive: true)) }
+    end
+
     context 'when ref_tag and ref_repo is provided' do
       subject(:modifier) do
         described_class.new(ref_tag: 'THE_TAG', ref_repo: 'not dot', def_type: 'req', first_version: 'a')
@@ -161,6 +267,7 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       before do
         allow(Dir).to(receive(:mktmpdir).and_yield('tmp'))
         allow(Git).to(receive(:clone))
+        allow(Git).to(receive(:open)).and_raise(ArgumentError)
         allow(Defmastership::Document).to(receive(:new).twice.and_return(ref_document, document))
         allow(document).to(receive(:parse_file_with_preprocessor).with('file1.adoc'))
         allow(document).to(receive(:parse_file_with_preprocessor).with('file2.adoc'))
@@ -176,7 +283,7 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       end
 
       it { expect(Dir).to(have_received(:mktmpdir).with('defmastership')) }
-      it { expect(Git).to(have_received(:clone).with('not dot', 'tmp', branch: 'THE_TAG')) }
+      it { expect(Git).to(have_received(:clone).with('not dot', 'tmp', branch: 'THE_TAG', recursive: true)) }
       it { expect(Defmastership::Document).to(have_received(:new).twice) }
       it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).with('tmp/file1.adoc')) }
       it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).with('tmp/file2.adoc')) }
@@ -211,6 +318,7 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       before do
         allow(Dir).to(receive(:mktmpdir).and_yield('tmp'))
         allow(Git).to(receive(:clone))
+        allow(Git).to(receive(:open)).and_raise(ArgumentError)
         allow(Defmastership::Document).to(receive(:new).twice.and_return(ref_document, document))
         allow(document).to(receive(:parse_file_with_preprocessor).with('file1.adoc'))
         allow(document).to(receive(:parse_file_with_preprocessor).with('file2.adoc'))
@@ -225,7 +333,7 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
       end
 
       it { expect(Dir).to(have_received(:mktmpdir).with('defmastership')) }
-      it { expect(Git).to(have_received(:clone).with('.', 'tmp', branch: 'THE_TAG')) }
+      it { expect(Git).to(have_received(:clone).with('.', 'tmp', branch: 'THE_TAG', recursive: true)) }
       it { expect(Defmastership::Document).to(have_received(:new).twice) }
       it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).with('tmp/./another/doc.adoc')) }
       it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).once) }
@@ -236,6 +344,77 @@ RSpec.describe(Defmastership::Modifier::UpdateDefVersion) do
     end
   end
 
+  describe '.resolve_remote_url' do
+    subject(:resolved_url) { described_class.const_get(:Helper).resolve_remote_url(path) }
+
+    context 'when the path is not a directory' do
+      let(:path) { 'git@github.com:org/repo.git' }
+
+      before do
+        allow(File).to(receive(:directory?).with(path).and_return(false))
+      end
+
+      it 'returns the exact path itself' do
+        expect(resolved_url).to(be(path))
+      end
+
+      it 'queries File.directory?' do
+        resolved_url
+        expect(File).to(have_received(:directory?).with(path))
+      end
+    end
+
+    context 'when the path is a directory and has an origin remote' do
+      let(:path)      { '/path/to/local/repo'                                                                    }
+      let(:local_git) { instance_double(Git::Base)                                                               }
+      let(:remote)    { instance_double(Git::Remote, name: 'origin', url: 'https://gitlab.example.com/repo.git') }
+
+      before do
+        allow(File).to(receive(:directory?).with(path).and_return(true))
+        allow(Git).to(receive(:open)).with(path).and_return(local_git)
+        allow(local_git).to(receive(:remotes)).and_return([remote])
+      end
+
+      it 'returns the origin remote url' do
+        expect(resolved_url).to(eq('https://gitlab.example.com/repo.git'))
+      end
+
+      it 'queries File.directory?' do
+        resolved_url
+        expect(File).to(have_received(:directory?).with(path))
+      end
+    end
+
+    context 'when the path is a directory but does not have an origin remote' do
+      let(:path) { '/path/to/local/repo' }
+      let(:local_git) { instance_double(Git::Base)                                                                 }
+      let(:remote)    { instance_double(Git::Remote, name: 'upstream', url: 'https://gitlab.example.com/repo.git') }
+
+      before do
+        allow(File).to(receive(:directory?).with(path).and_return(true))
+        allow(Git).to(receive(:open)).with(path).and_return(local_git)
+        allow(local_git).to(receive(:remotes)).and_return([remote])
+      end
+
+      it 'returns the path itself' do
+        expect(resolved_url).to(eq(path))
+      end
+    end
+
+    context 'when Git.open raises an ArgumentError' do
+      let(:path) { '/path/to/local/repo' }
+
+      before do
+        allow(File).to(receive(:directory?).with(path).and_return(true))
+        allow(Git).to(receive(:open)).with(path).and_raise(ArgumentError)
+      end
+
+      it 'returns the path itself' do
+        expect(resolved_url).to(eq(path))
+      end
+    end
+  end
+
   describe '#replace_reference' do
     subject(:modifier) { described_class.new(def_type: 'requirement', first_version: 'a') }
 

data/spec/unit/defmastership/modifier/update_iref_checksum_spec.rb

@@ -29,23 +29,26 @@ RSpec.describe(Defmastership::Modifier::UpdateIrefChecksum) do
       allow(Defmastership::Document).to(receive(:new).and_return(document))
       allow(document).to(receive(:parse_file_with_preprocessor))
       allow_any_instance_of(Defmastership::Modifier::ModifierCommon).to(receive(:do_modifications).and_return(adoc_sources))
+    end
 
+    it 'creates a new document' do
       modifier.do_modifications(adoc_sources)
+      expect(Defmastership::Document).to(have_received(:new))
     end
 
-    it { expect(Defmastership::Document).to(have_received(:new)) }
+    it 'parses the first adoc file with preprocessor' do
+      modifier.do_modifications(adoc_sources)
+      expect(document).to(have_received(:parse_file_with_preprocessor).with('file1.adoc'))
+    end
 
-    it do
-      expect(document).to(
-        have_received(:parse_file_with_preprocessor)
-          .once.with('file1.adoc')
-          .once.with('file2.adoc')
-      )
+    it 'parses the second adoc file with preprocessor' do
+      modifier.do_modifications(adoc_sources)
+      expect(document).to(have_received(:parse_file_with_preprocessor).with('file2.adoc'))
     end
 
     it { expect(modifier.do_modifications(adoc_sources)).to(eq(adoc_sources)) }
 
-    it 'call the parent method' do
+    it 'call the parent method with arguments' do
       expect_any_instance_of(Defmastership::Modifier::ModifierCommon).to(receive(:do_modifications).with(adoc_sources))
       modifier.do_modifications(adoc_sources)
     end

data/spec/unit/defmastership/modifier/update_iref_version_spec.rb

@@ -29,23 +29,26 @@ RSpec.describe(Defmastership::Modifier::UpdateIrefVersion) do
       allow(Defmastership::Document).to(receive(:new).and_return(document))
       allow(document).to(receive(:parse_file_with_preprocessor))
       allow_any_instance_of(Defmastership::Modifier::ModifierCommon).to(receive(:do_modifications).and_return(adoc_sources))
+    end
 
+    it 'creates a new document' do
       modifier.do_modifications(adoc_sources)
+      expect(Defmastership::Document).to(have_received(:new))
     end
 
-    it { expect(Defmastership::Document).to(have_received(:new)) }
+    it 'parses the first adoc file with preprocessor' do
+      modifier.do_modifications(adoc_sources)
+      expect(document).to(have_received(:parse_file_with_preprocessor).with('file1.adoc'))
+    end
 
-    it do
-      expect(document).to(
-        have_received(:parse_file_with_preprocessor)
-          .once.with('file1.adoc')
-          .once.with('file2.adoc')
-      )
+    it 'parses the second adoc file with preprocessor' do
+      modifier.do_modifications(adoc_sources)
+      expect(document).to(have_received(:parse_file_with_preprocessor).with('file2.adoc'))
     end
 
     it { expect(modifier.do_modifications(adoc_sources)).to(eq(adoc_sources)) }
 
-    it 'call the parent method' do
+    it 'call the parent method with arguments' do
       expect_any_instance_of(Defmastership::Modifier::ModifierCommon).to(receive(:do_modifications).with(adoc_sources))
       modifier.do_modifications(adoc_sources)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.3.7
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
@@ -272,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.12
 specification_version: 4
 summary: Handling of references and definitions with asciidoctor
 test_files: []