defmastership 1.3.2 → 1.3.4

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

@@ -0,0 +1,162 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/modifier/update_iref_version')
+
+RSpec.describe(Defmastership::Modifier::UpdateIrefVersion) do
+  subject(:modifier) { described_class.new({}) }
+
+  describe '.new' do
+    it { is_expected.not_to(be_nil) }
+    it { expect(described_class.ancestors).to(include(Defmastership::Modifier::ModifierCommon)) }
+    it { is_expected.to(have_attributes(config: {})) }
+  end
+
+  describe '.replacement_methods' do
+    it { expect(described_class.replacement_methods).to(eq(%i[replace_irefs])) }
+  end
+
+  describe '#do_modifications' do
+    let(:document) { instance_double(Defmastership::Document, 'document') }
+    let(:adoc_sources) do
+      {
+        'file1.adoc' => 'pouet',
+        'file2.adoc' => 'tagada'
+      }
+    end
+
+    before 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))
+
+      modifier.do_modifications(adoc_sources)
+    end
+
+    it { expect(Defmastership::Document).to(have_received(:new)) }
+
+    it do
+      expect(document).to(
+        have_received(:parse_file_with_preprocessor)
+          .once.with('file1.adoc')
+          .once.with('file2.adoc')
+      )
+    end
+
+    it { expect(modifier.do_modifications(adoc_sources)).to(eq(adoc_sources)) }
+
+    it 'call the parent method' do
+      expect_any_instance_of(Defmastership::Modifier::ModifierCommon).to(receive(:do_modifications).with(adoc_sources))
+      modifier.do_modifications(adoc_sources)
+    end
+  end
+
+  describe '#replace_irefs' do
+    let(:document) { instance_double(Defmastership::Document, 'document') }
+    let(:definition) { instance_double(Defmastership::Definition, 'definition') }
+
+    before do
+      allow(Defmastership::Document).to(receive(:new).and_return(document))
+    end
+
+    context 'when the line is matching a good internal ref definition (with version)' do
+      before do
+        allow(document).to(receive(:ref_to_def).and_return(definition))
+        allow(definition).to(receive(:explicit_version).and_return('z'))
+      end
+
+      [
+        ['',             '(z)'],
+        ['(~abcd1234)',  '(z~abcd1234)'],
+        ['(a)',          '(z)'],
+        ['(a~abcd1234)', '(z~abcd1234)']
+      ].each do |from, to|
+        it do
+          modifier.replace_irefs('', "whatever defs:iref[THE_REF#{from}] whatever")
+          expect(document).to(have_received(:ref_to_def).with('THE_REF'))
+        end
+
+        it do
+          modifier.replace_irefs('', "whatever defs:iref[THE_REF#{from}] whatever")
+          expect(definition).to(have_received(:explicit_version))
+        end
+
+        it {
+          expect(modifier.replace_irefs('', "whatever defs:iref[THE_REF#{from}] whatever"))
+            .to(eq("whatever defs:iref[THE_REF#{to}] whatever"))
+        }
+      end
+    end
+
+    context 'when the line is matching a good internal ref definition (without version)' do
+      before do
+        allow(document).to(receive(:ref_to_def).and_return(definition))
+        allow(definition).to(receive(:explicit_version).and_return(nil))
+      end
+
+      [
+        ['',             ''],
+        ['(~abcd1234)',  '(~abcd1234)'],
+        ['(a)',          ''],
+        ['(a~abcd1234)', '(~abcd1234)']
+      ].each do |from, to|
+        it do
+          modifier.replace_irefs('', "whatever defs:iref[THE_REF#{from}] whatever")
+          expect(document).to(have_received(:ref_to_def).with('THE_REF'))
+        end
+
+        it do
+          modifier.replace_irefs('', "whatever defs:iref[THE_REF#{from}] whatever")
+          expect(definition).to(have_received(:explicit_version))
+        end
+
+        it {
+          expect(modifier.replace_irefs('', "whatever defs:iref[THE_REF#{from}] whatever"))
+            .to(eq("whatever defs:iref[THE_REF#{to}] whatever"))
+        }
+      end
+    end
+
+    context 'when the definition does not exist' do
+      before do
+        allow(document).to(receive(:ref_to_def).and_return(nil))
+      end
+
+      it do
+        modifier.replace_irefs('', 'whatever defs:iref[BAD_REF(a~abcd1234)] whatever')
+        expect(document).to(have_received(:ref_to_def).with('BAD_REF'))
+      end
+
+      it {
+        expect(modifier.replace_irefs('', 'whatever defs:iref[BAD_REF(a~abcd1234)] whatever'))
+          .to(eq('whatever defs:iref[BAD_REF(a~abcd1234)] whatever'))
+      }
+    end
+
+    context 'when the line is not a valid iref' do
+      it { expect(modifier.replace_irefs('', 'bla bla')).to(eq('bla bla')) }
+    end
+
+    context 'when the line is matching more than one iref' do
+      let(:other_definition) { instance_double(Defmastership::Definition, 'other_definition') }
+
+      before do
+        allow(document).to(receive(:ref_to_def).with('REF1').and_return(definition))
+        allow(document).to(receive(:ref_to_def).with('REF2').and_return(other_definition))
+        allow(definition).to(receive(:explicit_version).and_return('pouet'))
+        allow(other_definition).to(receive(:explicit_version).and_return('tagada'))
+        modifier.replace_irefs('', 'defs:iref[REF1], defs:iref[REF2]')
+      end
+
+      it { expect(document).to(have_received(:ref_to_def).with('REF1')) }
+      it { expect(document).to(have_received(:ref_to_def).with('REF2')) }
+      it { expect(definition).to(have_received(:explicit_version)) }
+      it { expect(other_definition).to(have_received(:explicit_version)) }
+
+      it {
+        expect(modifier.replace_irefs('', 'defs:iref[REF1], defs:iref[REF2]'))
+          .to(eq('defs:iref[REF1(pouet)], defs:iref[REF2(tagada)]'))
+      }
+    end
+  end
+end

data/tasks/code_quality.rake

@@ -56,14 +56,7 @@ namespace 'quality' do
   end
 
   desc 'Runs all quality code check'
-  task(
-    all: [
-      'quality:rubocop',
-      'quality:reek',
-      'quality:flay',
-      'quality:rubycritic'
-    ]
-  )
+  task(all: ['quality:rubocop', 'quality:reek', 'quality:flay'])
 end
 # rubocop:enable Metrics/BlockLength
 

data/tasks/test.rake

@@ -16,6 +16,18 @@ namespace 'test' do
     t.cucumber_opts = ['--profile wip']
   end
 
+  desc 'mutation testing'
+  task :mutation do
+    sh 'mutant run'
+  end
+
+  namespace 'mutation' do
+    desc 'mutation testing (fail fast)'
+    task :ff do
+      sh 'mutant run --fail-fast'
+    end
+  end
+
   desc 'Runs all unit tests and acceptance tests'
   task(all: ['test:spec', 'test:features'])
 end
@@ -28,3 +40,6 @@ task(test: 'test:all')
 
 desc('Test all features')
 task(cucumber: 'test:features')
+
+desc 'Synonym for test:mutation'
+task(mutation: 'test:mutation')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.5.5
 - !ruby/object:Gem::Dependency
   name: facets
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +135,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 email: jeromearbezgindre@gmail.com
 executables:
 - defmastership
@@ -147,6 +175,10 @@ files:
 - features/defmastership.feature
 - features/defmastership_version.feature
 - features/export.feature
+- features/external_ref_checksum.feature
+- features/external_ref_version.feature
+- features/internal_ref_checksum.feature
+- features/internal_ref_version.feature
 - features/modify.feature
 - features/rename_included_files.feature
 - features/step_definitions/defmastership_steps.rb
@@ -156,12 +188,17 @@ files:
 - lib/defmastership/batch_modifier.rb
 - lib/defmastership/comment_filter.rb
 - lib/defmastership/config_preserver.rb
+- lib/defmastership/def_type_list.rb
 - lib/defmastership/definition.rb
 - lib/defmastership/definition_parser.rb
 - lib/defmastership/document.rb
 - lib/defmastership/export/body_formatter.rb
 - lib/defmastership/export/csv/formatter.rb
+- lib/defmastership/export/formatter.rb
 - lib/defmastership/export/header_formatter.rb
+- lib/defmastership/export/json/formatter.rb
+- lib/defmastership/export/xlsx/formatter.rb
+- lib/defmastership/export/yaml/formatter.rb
 - lib/defmastership/filters.rb
 - lib/defmastership/hash_merge_no_new.rb
 - lib/defmastership/matching_line.rb
@@ -169,20 +206,32 @@ files:
 - lib/defmastership/modifier/factory.rb
 - lib/defmastership/modifier/modifier_common.rb
 - lib/defmastership/modifier/rename_included_files.rb
+- lib/defmastership/modifier/replacement_formatter.rb
 - lib/defmastership/modifier/update_def.rb
 - lib/defmastership/modifier/update_def_checksum.rb
 - lib/defmastership/modifier/update_def_version.rb
+- lib/defmastership/modifier/update_eref_checksum.rb
+- lib/defmastership/modifier/update_eref_common.rb
+- lib/defmastership/modifier/update_eref_version.rb
+- lib/defmastership/modifier/update_iref_checksum.rb
+- lib/defmastership/modifier/update_iref_common.rb
+- lib/defmastership/modifier/update_iref_version.rb
 - lib/defmastership/version.rb
 - spec/spec_helper.rb
 - spec/unit/defmastership/app_spec.rb
 - spec/unit/defmastership/batch_modifier_spec.rb
 - spec/unit/defmastership/config_preserver_spec.rb
+- spec/unit/defmastership/def_type_list_spec.rb
 - spec/unit/defmastership/definition_parser_spec.rb
 - spec/unit/defmastership/definition_spec.rb
 - spec/unit/defmastership/document_spec.rb
 - spec/unit/defmastership/export/body_formatter_spec.rb
 - spec/unit/defmastership/export/csv/formatter_spec.rb
+- spec/unit/defmastership/export/formatter_spec.rb
 - spec/unit/defmastership/export/header_formatter_spec.rb
+- spec/unit/defmastership/export/json/formatter_spec.rb
+- spec/unit/defmastership/export/xlsx/formatter_spec.rb
+- spec/unit/defmastership/export/yaml/formatter_spec.rb
 - spec/unit/defmastership/hash_spec.rb
 - spec/unit/defmastership/matching_line_spec.rb
 - spec/unit/defmastership/modifier/change_ref_spec.rb
@@ -192,6 +241,10 @@ files:
 - spec/unit/defmastership/modifier/update_def_checksum_spec.rb
 - spec/unit/defmastership/modifier/update_def_spec.rb
 - spec/unit/defmastership/modifier/update_def_version_spec.rb
+- spec/unit/defmastership/modifier/update_eref_checksum_spec.rb
+- spec/unit/defmastership/modifier/update_eref_version_spec.rb
+- spec/unit/defmastership/modifier/update_iref_checksum_spec.rb
+- spec/unit/defmastership/modifier/update_iref_version_spec.rb
 - spec/unit/defmastership/string_spec.rb
 - spec/unit/defmastership_spec.rb
 - tasks/code_quality.rake
@@ -219,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Handling of references and definitions with asciidoctor
 test_files: []