defmastership 1.0.18 → 1.1.0

data/spec/unit/{def_mastership/change_ref_modifier_spec.rb → defmastership/modifier/change_ref_spec.rb}

@@ -1,13 +1,13 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/change_ref_modifier')
+require('defmastership/modifier/change_ref')
 
-RSpec.describe(DefMastership::ChangeRefModifier) do
+RSpec.describe(Defmastership::Modifier::ChangeRef) do
   subject(:refchanger) { described_class.new({}) }
 
   describe '.new' do
-    it { expect(described_class.ancestors).to(include(DefMastership::Modifier)) }
+    it { expect(described_class.ancestors).to(include(Defmastership::Modifier::ModifierCommon)) }
     it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(from_regexp: '')) }
     it { is_expected.to(have_attributes(to_template: '')) }
@@ -28,7 +28,7 @@ RSpec.describe(DefMastership::ChangeRefModifier) do
     end
   end
 
-  describe '#replace_def' do
+  describe '#replace_refdef' do
     context 'when really simple rule' do
       subject(:refchanger) do
         described_class.new(
@@ -42,6 +42,21 @@ RSpec.describe(DefMastership::ChangeRefModifier) do
           expect(refchanger.replace_refdef('[define, whatever, TEMP]'))
             .to(eq('[define, whatever, TUTU]'))
         end
+
+        it do
+          expect(refchanger.replace_refdef('[define, whatever, TEMP(a~12345678)]'))
+            .to(eq('[define, whatever, TUTU(a~12345678)]'))
+        end
+
+        it do
+          expect(refchanger.replace_refdef('[define, whatever, TEMP(~12345678)]'))
+            .to(eq('[define, whatever, TUTU(~12345678)]'))
+        end
+
+        it do
+          expect(refchanger.replace_refdef('[define, whatever, TEMP(a)]'))
+            .to(eq('[define, whatever, TUTU(a)]'))
+        end
       end
 
       context 'when no valid definition' do
@@ -178,44 +193,4 @@ RSpec.describe(DefMastership::ChangeRefModifier) do
       ).to(eq('defs:iref[TOTO-0132] defs:iref[TOTO-0132] bla'))
     end
   end
-
-  describe '#replace' do
-    subject(:refchanger) do
-      described_class.new(
-        from_regexp: 'TEMP',
-        to_template: 'TUTU'
-      )
-    end
-
-    it do
-      expect(refchanger.replace(:refdef, '[define, whatever, TEMP]'))
-        .to(eq('[define, whatever, TUTU]'))
-    end
-
-    it do
-      expect(refchanger.replace(:refdef, '[define, whatever, TEMP(a~12345678)]'))
-        .to(eq('[define, whatever, TUTU(a~12345678)]'))
-    end
-
-    it do
-      expect(refchanger.replace(:refdef, '[define, whatever, TEMP(~12345678)]'))
-        .to(eq('[define, whatever, TUTU(~12345678)]'))
-    end
-
-    it do
-      expect(refchanger.replace(:refdef, '[define, whatever, TEMP(a)]'))
-        .to(eq('[define, whatever, TUTU(a)]'))
-    end
-
-    it do
-      refchanger.replace(:refdef, '[define, whatever, TEMP]')
-      expect(refchanger.replace(:irefs, 'defs:iref[TEMP] defs:iref[TEMP]'))
-        .to(eq('defs:iref[TUTU] defs:iref[TUTU]'))
-    end
-
-    it do
-      expect { refchanger.replace(:pouet, 'whatever') }
-        .to(raise_error(NoMethodError))
-    end
-  end
 end

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

@@ -0,0 +1,45 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/modifier/factory')
+
+module Defmastership
+  module Modifier
+    # Modifier example
+    class Toto
+      include ModifierCommon
+    end
+
+    # Modifier example
+    class TuTu
+      include ModifierCommon
+    end
+  end
+end
+
+RSpec.describe(Defmastership::Modifier::Factory) do
+  describe('.from_config') do
+    let(:toto)        { instance_double(Defmastership::Modifier::Toto, 'toto') }
+    let(:toto_config) { { type: 'toto', config: { p: 'whatever' } }            }
+    let(:tutu)        { instance_double(Defmastership::Modifier::TuTu, 'tutu') }
+    let(:tutu_config) { { type: 'tu_tu', config: { p: 'whatever' } }           }
+
+    before do
+      allow(Defmastership::Modifier::Toto).to(receive(:new).with(toto_config[:config]).and_return(toto))
+      allow(Defmastership::Modifier::TuTu).to(receive(:new).with(tutu_config[:config]).and_return(tutu))
+    end
+
+    it { expect(described_class.from_config(toto_config)).to(be(toto)) }
+    it { expect(described_class.from_config(tutu_config)).to(be(tutu)) }
+
+    it do
+      described_class.from_config(toto_config)
+      expect(Defmastership::Modifier::Toto).to(have_received(:new).with(toto_config[:config]))
+    end
+
+    it do
+      described_class.from_config(tutu_config)
+      expect(Defmastership::Modifier::TuTu).to(have_received(:new).with(tutu_config[:config]))
+    end
+  end
+end

data/spec/unit/{def_mastership/modifier_spec.rb → defmastership/modifier/modifier_common_spec.rb}

@@ -1,9 +1,12 @@
 # Copyright (c) 2023 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/modifier')
+require('defmastership/modifier/modifier_common')
 
-class DummyclassParrent
+# just a class for test
+class DummyClassParent
+  # This method smells of :reek:ControlParameter
+  # This method smells of :reek:UtilityFunction
   def respond_to_missing?(method_name, *_)
     return true if method_name == :ploup
 
@@ -11,8 +14,9 @@ class DummyclassParrent
   end
 end
 
-class DummyClass < DummyclassParrent
-  include DefMastership::Modifier
+# just a class for test
+class DummyClass < DummyClassParent
+  include Defmastership::Modifier::ModifierCommon
 
   def self.replacement_methods
     %i[replace_pouet_by_foo replace_foo_by_zoo]
@@ -27,20 +31,18 @@ class DummyClass < DummyclassParrent
     super()
   end
 
+  # This method smells of :reek:UtilityFunction
   def replace_pouet_by_foo(line)
     line.gsub('pouet', 'foo')
   end
 
+  # This method smells of :reek:UtilityFunction
   def replace_foo_by_zoo(line)
     line.gsub('foo', 'zoo')
   end
 end
 
-class BadDummyClass < DummyclassParrent
-  include DefMastership::Modifier
-end
-
-RSpec.describe(DefMastership::Modifier) do
+RSpec.describe(Defmastership::Modifier::ModifierCommon) do
   subject(:modifier) { DummyClass.new({}) }
 
   describe '.new' do
@@ -63,15 +65,6 @@ RSpec.describe(DefMastership::Modifier) do
     end
   end
 
-  describe '#apply_to_all' do
-    it do
-      texts = { first: "pouet\ntoto\npouet", second: "toto\npouet\ntoto" }
-
-      expect(modifier.apply_to_all(texts, :replace_pouet_by_foo))
-        .to(eq({ first: "foo\ntoto\nfoo", second: "toto\nfoo\ntoto" }))
-    end
-  end
-
   describe '#do_modifications' do
     it do
       adoc_sources = { first: "pouet\ntoto\npouet", second: "toto\npouet\ntoto" }

data/spec/unit/{def_mastership/rename_included_files_modifier_spec.rb → defmastership/modifier/rename_included_files_spec.rb}

@@ -1,13 +1,13 @@
 # Copyright (c) 2021 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/rename_included_files_modifier')
+require('defmastership/modifier/rename_included_files')
 
-RSpec.describe(DefMastership::RenameIncludedFilesModifier) do
+RSpec.describe(Defmastership::Modifier::RenameIncludedFiles) do
   subject(:includeschanger) { described_class.new({}) }
 
   describe '.new' do
-    it { expect(described_class.ancestors).to(include(DefMastership::Modifier)) }
+    it { expect(described_class.ancestors).to(include(Defmastership::Modifier::ModifierCommon)) }
     it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(from_regexp: '')) }
     it { is_expected.to(have_attributes(to_template: '')) }

data/spec/unit/{def_mastership/update_def_checksum_modifier_spec.rb → defmastership/modifier/update_def_checksum_spec.rb}

@@ -1,13 +1,13 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/update_def_checksum_modifier')
+require('defmastership/modifier/update_def_checksum')
 
-RSpec.describe(DefMastership::UpdateDefChecksumModifier) do
+RSpec.describe(Defmastership::Modifier::UpdateDefChecksum) do
   subject(:modifier) { described_class.new({}) }
 
   describe '.new' do
-    it { expect(described_class.ancestors).to(include(DefMastership::Modifier)) }
+    it { expect(described_class.ancestors).to(include(Defmastership::Modifier::ModifierCommon)) }
     it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(def_type: '')) }
   end
@@ -19,8 +19,8 @@ RSpec.describe(DefMastership::UpdateDefChecksumModifier) do
   describe '#do_modifications' do
     subject(:modifier) { described_class.new({ def_type: 'req' })                 }
 
-    let(:document)     { instance_double(DefMastership::Document, 'document')     }
-    let(:definition)   { instance_double(DefMastership::Definition, 'definition') }
+    let(:document)     { instance_double(Defmastership::Document, 'document')     }
+    let(:definition)   { instance_double(Defmastership::Definition, 'definition') }
     let(:definitions)  { { 'REFERENCE' => definition }                            }
     let(:adoc_sources) do
       {
@@ -31,7 +31,7 @@ RSpec.describe(DefMastership::UpdateDefChecksumModifier) do
     let(:new_adoc_sources) { nil }
 
     before do
-      allow(DefMastership::Document).to(receive(:new).and_return(document))
+      allow(Defmastership::Document).to(receive(:new).and_return(document))
       allow(document).to(receive(:parse_file_with_preprocessor))
       allow(document).to(receive(:ref_to_def).with('REFERENCE').and_return(definition))
       allow(definition).to(receive(:sha256_short).and_return('~abcd1234'))
@@ -39,7 +39,7 @@ RSpec.describe(DefMastership::UpdateDefChecksumModifier) do
       modifier.do_modifications(adoc_sources)
     end
 
-    it { expect(DefMastership::Document).to(have_received(:new)) }
+    it { expect(Defmastership::Document).to(have_received(:new)) }
 
     it do
       expect(document).to(
@@ -61,8 +61,8 @@ RSpec.describe(DefMastership::UpdateDefChecksumModifier) do
       )
     end
 
-    let(:definition)  { instance_double(DefMastership::Definition, 'definition') }
-    let(:document)    { instance_double(DefMastership::Document, 'document')     }
+    let(:definition)  { instance_double(Defmastership::Definition, 'definition') }
+    let(:document)    { instance_double(Defmastership::Document, 'document')     }
     let(:definitions) { { 'REFERENCE' => definition }                            }
 
     before do
@@ -78,7 +78,7 @@ RSpec.describe(DefMastership::UpdateDefChecksumModifier) do
 
     context 'when definition has the good type' do
       before do
-        allow(DefMastership::Document).to(receive(:new).and_return(document))
+        allow(Defmastership::Document).to(receive(:new).and_return(document))
         allow(document).to(receive(:ref_to_def).with('REFERENCE').and_return(definition))
         allow(definition).to(receive(:sha256_short).and_return('~abcd1234'))
       end

data/spec/unit/{def_mastership/update_def_modifier_spec.rb → defmastership/modifier/update_def_spec.rb}

@@ -1,23 +1,27 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/update_def_modifier')
+require('defmastership/modifier/update_def')
 
-module DefMastership
-  class ConcreteRefModifier < UpdateDefModifier
-    private
+module Defmastership
+  module Modifier
+    # Just a class for tests
+    class ConcreteRef < UpdateDef
+      private
 
-    def reference_replacement(reference, match)
-      "#{reference}_something_#{match[:explicit_version]}"
+      # This method smells of :reek:UtilityFunction
+      def reference_replacement(reference, match)
+        "#{reference}_something_#{match[:explicit_version]}"
+      end
     end
   end
 end
 
-RSpec.describe(DefMastership::UpdateDefModifier) do
-  subject(:modifier) { DefMastership::ConcreteRefModifier.new({}) }
+RSpec.describe(Defmastership::Modifier::UpdateDef) do
+  subject(:modifier) { Defmastership::Modifier::ConcreteRef.new({}) }
 
   describe '.new' do
-    it { expect(described_class.ancestors).to(include(DefMastership::Modifier)) }
+    it { expect(described_class.ancestors).to(include(Defmastership::Modifier::ModifierCommon)) }
     it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(def_type: '')) }
   end
@@ -27,10 +31,10 @@ RSpec.describe(DefMastership::UpdateDefModifier) do
   end
 
   describe '#do_modifications' do
-    subject(:modifier) { DefMastership::ConcreteRefModifier.new({ def_type: 'req' }) }
+    subject(:modifier) { Defmastership::Modifier::ConcreteRef.new({ def_type: 'req' }) }
 
-    let(:document)     { instance_double(DefMastership::Document, 'document')        }
-    let(:definition)   { instance_double(DefMastership::Definition, 'definition')    }
+    let(:document)     { instance_double(Defmastership::Document, 'document')        }
+    let(:definition)   { instance_double(Defmastership::Definition, 'definition')    }
     let(:definitions)  { { 'REFERENCE' => definition }                               }
     let(:adoc_sources) do
       {
@@ -41,14 +45,14 @@ RSpec.describe(DefMastership::UpdateDefModifier) do
     let(:new_adoc_sources) { nil }
 
     before do
-      allow(DefMastership::Document).to(receive(:new).and_return(document))
+      allow(Defmastership::Document).to(receive(:new).and_return(document))
       allow(document).to(receive(:parse_file_with_preprocessor).with('file1.adoc'))
       allow(document).to(receive(:parse_file_with_preprocessor).with('file2.adoc'))
 
       modifier.do_modifications(adoc_sources)
     end
 
-    it { expect(DefMastership::Document).to(have_received(:new)) }
+    it { expect(Defmastership::Document).to(have_received(:new)) }
 
     it do
       expect(document).to(
@@ -66,13 +70,13 @@ RSpec.describe(DefMastership::UpdateDefModifier) do
 
   describe '#replace_reference' do
     subject(:modifier) do
-      DefMastership::ConcreteRefModifier.new(
+      Defmastership::Modifier::ConcreteRef.new(
         def_type: 'requirement'
       )
     end
 
-    let(:definition)  { instance_double(DefMastership::Definition, 'definition') }
-    let(:document)    { instance_double(DefMastership::Document, 'document')     }
+    let(:definition)  { instance_double(Defmastership::Definition, 'definition') }
+    let(:document)    { instance_double(Defmastership::Document, 'document')     }
     let(:definitions) { { 'REFERENCE' => definition }                            }
 
     before do
@@ -95,7 +99,7 @@ RSpec.describe(DefMastership::UpdateDefModifier) do
 
     context 'when definition has the good type' do
       before do
-        allow(DefMastership::Document).to(receive(:new).and_return(document))
+        allow(Defmastership::Document).to(receive(:new).and_return(document))
         allow(document).to(receive(:ref_to_def).with('REFERENCE').and_return(definition))
         allow(definition).to(receive(:sha256_short).and_return('~abcd1234'))
       end