defmastership 1.0.3 → 1.0.8

data/spec/unit/defmastership/change_ref_modifier_spec.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::ChangeRefModifier) do
+  subject(:modifier) do
+    described_class.new(
+      'fake config'
+    )
+  end
+
+  let(:adoc_texts) do
+    {
+      'file1.adoc' => "file1 line1\nfile1 line2",
+      'file2.adoc' => "file2 line1\nfile2 line2"
+    }
+  end
+
+  describe '.new' do
+    it { is_expected.not_to(be(nil)) }
+    it { is_expected.to(have_attributes(config: 'fake config')) }
+    it { is_expected.to(have_attributes(changes: [])) }
+  end
+
+  describe '#do_modifications' do
+    let(:line_modifier) { instance_double(DefMastership::ChangeRefLineModifier, 'lineModifier') }
+
+    before do
+      allow(DefMastership::ChangeRefLineModifier).to(
+        receive(:from_config).with('fake config').and_return(line_modifier)
+      )
+      allow(line_modifier).to(receive(:replace_refdef).with("file1 line1\n").and_return("new file1 line1\n"))
+      allow(line_modifier).to(receive(:replace_refdef).with('file1 line2').and_return('new file1 line2'))
+      allow(line_modifier).to(receive(:replace_refdef).with("file2 line1\n").and_return("new file2 line1\n"))
+      allow(line_modifier).to(receive(:replace_refdef).with('file2 line2').and_return('new file2 line2'))
+      allow(line_modifier).to(receive(:replace_irefs).with("new file1 line1\n").and_return("new2 file1 line1\n"))
+      allow(line_modifier).to(receive(:replace_irefs).with('new file1 line2').and_return('new2 file1 line2'))
+      allow(line_modifier).to(receive(:replace_irefs).with("new file2 line1\n").and_return("new2 file2 line1\n"))
+      allow(line_modifier).to(receive(:replace_irefs).with('new file2 line2').and_return('new2 file2 line2'))
+      allow(line_modifier).to(receive(:config).and_return('new fake config'))
+      allow(line_modifier).to(receive(:changes).and_return([%w[from1 to1], %w[from2 to2]]))
+    end
+
+    context 'when detailed expectations' do
+      before { modifier.do_modifications(adoc_texts) }
+
+      it do
+        expect(DefMastership::ChangeRefLineModifier).to(
+          have_received(:from_config).with('fake config')
+        )
+      end
+
+      it { expect(line_modifier).to(have_received(:replace_refdef).with("file1 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace_refdef).with('file1 line2')) }
+      it { expect(line_modifier).to(have_received(:replace_refdef).with("file2 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace_refdef).with('file2 line2')) }
+      it { expect(line_modifier).to(have_received(:replace_irefs).with("new file1 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace_irefs).with('new file1 line2')) }
+      it { expect(line_modifier).to(have_received(:replace_irefs).with("new file2 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace_irefs).with('new file2 line2')) }
+      it { expect(line_modifier).to(have_received(:config)) }
+      it { expect(line_modifier).to(have_received(:changes)) }
+      it { is_expected.to(have_attributes(config: 'new fake config')) }
+      it { is_expected.to(have_attributes(changes: [%w[from1 to1], %w[from2 to2]])) }
+    end
+
+    it do
+      expected_adoc = {
+        'file1.adoc' => "new2 file1 line1\nnew2 file1 line2",
+        'file2.adoc' => "new2 file2 line1\nnew2 file2 line2"
+      }
+      expect(modifier.do_modifications(adoc_texts)).to(eq(expected_adoc))
+    end
+  end
+end

data/spec/unit/defmastership/comment_filter_spec.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('defmastership')
@@ -74,8 +75,10 @@ RSpec.describe(DefMastership::CommentFilter) do
     end
 
     before do
-      allow(DefMastership).to(receive(:comment_filter)
-        .and_return(comment_filter))
+      allow(DefMastership).to(
+        receive(:comment_filter)
+          .and_return(comment_filter)
+      )
     end
 
     context 'when not .commented?' do
@@ -93,8 +96,10 @@ RSpec.describe(DefMastership::CommentFilter) do
 
     context 'when .commented?' do
       before do
-        allow(comment_filter).to(receive(:accept?)
-          .with('blabla').and_return(false))
+        allow(comment_filter).to(
+          receive(:accept?)
+            .with('blabla').and_return(false)
+        )
       end
 
       it do

data/spec/unit/defmastership/csv_formatter_body_spec.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('defmastership')
@@ -12,156 +13,162 @@ RSpec.describe(DefMastership::CSVFormatterBody) do
     it { is_expected.not_to(be(nil)) }
   end
 
-  describe '#fixed_body' do
+  describe '#fixed' do
     before do
       allow(definition).to(receive(:type).with(no_args).and_return('a'))
       allow(definition).to(receive(:reference).with(no_args).and_return('b'))
       allow(definition).to(receive(:value).with(no_args).and_return('c'))
-      formatter.fixed_body(definition)
+      allow(definition).to(receive(:sha256).with(no_args).and_return('d'))
+      formatter.fixed(definition)
     end
 
     it { expect(definition).to(have_received(:type).with(no_args)) }
-
     it { expect(definition).to(have_received(:reference).with(no_args)) }
-
     it { expect(definition).to(have_received(:value).with(no_args)) }
-
-    it { expect(formatter.fixed_body(definition)).to(eq(%w[a b c])) }
+    it { expect(definition).to(have_received(:sha256).with(no_args)) }
+    it { expect(formatter.fixed(definition)).to(eq(%w[a b c d])) }
   end
 
-  describe '#labels_body' do
-    context 'when no labels on document' do
+  describe '#wrong_explicit_checksum' do
+    context 'when no wrong_explicit checksum' do
       before do
-        allow(document).to(receive(:labels).with(no_args).and_return([]))
-        formatter.labels_body(definition)
+        allow(definition).to(receive(:wrong_explicit_checksum).with(no_args).and_return(nil))
+        formatter.wrong_explicit_checksum(definition)
       end
 
-      it { expect(document).to(have_received(:labels).once.with(no_args)) }
-
-      it { expect(formatter.labels_body(definition)).to(eq([])) }
+      it { expect(definition).to(have_received(:wrong_explicit_checksum).with(no_args)) }
+      it { expect(formatter.wrong_explicit_checksum(definition)).to(eq([''])) }
     end
 
-    context 'when labels on document' do
-      before { allow(document).to(receive(:labels).with(no_args).and_return(['whatever'])) }
+    context 'when explicit checksum' do
+      before do
+        allow(definition).to(receive(:wrong_explicit_checksum).with(no_args).and_return('ab12'))
+        formatter.wrong_explicit_checksum(definition)
+      end
+
+      it { expect(formatter.wrong_explicit_checksum(definition)).to(eq(['ab12'])) }
+    end
+  end
 
-      context 'when no labels on definition' do
-        before do
-          allow(definition).to(receive(:labels).with(no_args).and_return([]))
-          formatter.labels_body(definition)
-        end
+  describe '#explicit_version' do
+    context 'when no explicit_version' do
+      before do
+        allow(definition).to(receive(:explicit_version).with(no_args).and_return(nil))
+        formatter.explicit_version(definition)
+      end
 
-        it { expect(definition).to(have_received(:labels).once.with(no_args)) }
+      it { expect(definition).to(have_received(:explicit_version).with(no_args)) }
+      it { expect(formatter.explicit_version(definition)).to(eq([''])) }
+    end
 
-        it { expect(formatter.labels_body(definition)).to(eq([''])) }
+    context 'when explicit_version' do
+      before do
+        allow(definition).to(receive(:explicit_version).with(no_args).and_return('ab12'))
+        formatter.explicit_version(definition)
       end
 
-      context 'when labels on definition' do
-        before do
-          allow(definition).to(receive(:labels).with(no_args).and_return(%w[toto tutu]))
-          formatter.labels_body(definition)
-        end
+      it { expect(formatter.explicit_version(definition)).to(eq(['ab12'])) }
+    end
+  end
 
-        it { expect(definition).to(have_received(:labels).once.with(no_args)) }
+  describe '#labels' do
+    before { allow(document).to(receive(:labels).with(no_args).and_return(['whatever'])) }
 
-        it { expect(formatter.labels_body(definition)).to(eq(["toto\ntutu"])) }
+    context 'when no labels on definition' do
+      before do
+        allow(definition).to(receive(:labels).with(no_args).and_return([]))
+        formatter.labels(definition)
       end
+
+      it { expect(definition).to(have_received(:labels).once.with(no_args)) }
+      it { expect(formatter.labels(definition)).to(eq([''])) }
+    end
+
+    context 'when labels on definition' do
+      before do
+        allow(definition).to(receive(:labels).with(no_args).and_return(%w[toto tutu]))
+        formatter.labels(definition)
+      end
+
+      it { expect(definition).to(have_received(:labels).once.with(no_args)) }
+      it { expect(formatter.labels(definition)).to(eq(["toto\ntutu"])) }
     end
   end
 
-  describe '#eref_body' do
+  describe '#eref' do
     context 'when no eref on the document' do
       before do
         allow(document).to(receive(:eref).with(no_args).and_return({}))
-        formatter.eref_body(definition)
+        formatter.eref(definition)
       end
 
       it { expect(document).to(have_received(:eref).with(no_args)) }
-
-      it { expect(formatter.eref_body(nil)).to(eq([])) }
+      it { expect(formatter.eref(nil)).to(eq([])) }
     end
 
     context 'when eref on the document' do
       before do
-        allow(document).to(receive(:eref).with(no_args).and_return(
-                             a: 'whatever',
-                             b: 'whatever',
-                             c: 'whatever'
-                           ))
+        allow(document).to(
+          receive(:eref).with(no_args).and_return(
+            a: 'whatever', b: 'whatever', c: 'whatever'
+          )
+        )
         allow(definition).to(receive(:eref).with(no_args).and_return(a: %w[A B], b: [], c: ['C']))
-        formatter.eref_body(definition)
+        formatter.eref(definition)
       end
 
       it { expect(definition).to(have_received(:eref).exactly(3).times.with(no_args)) }
-
-      it { expect(formatter.eref_body(definition)).to(eq(["A\nB", '', 'C'])) }
+      it { expect(formatter.eref(definition)).to(eq(["A\nB", '', 'C'])) }
     end
   end
 
-  describe '#iref_body' do
-    context 'when no iref on the document' do
+  describe '#iref' do
+    before { allow(document).to(receive(:iref).with(no_args).and_return(true)) }
+
+    context 'when no iref on the definition' do
       before do
-        allow(document).to(receive(:iref).with(no_args).and_return(false))
-        formatter.iref_body(definition)
+        allow(definition).to(receive(:iref).with(no_args).and_return([]))
+        formatter.iref(definition)
       end
 
-      it { expect(document).to(have_received(:iref).with(no_args)) }
-
-      it { expect(formatter.iref_body(definition)).to(eq([])) }
+      it { expect(definition).to(have_received(:iref).with(no_args)) }
+      it { expect(formatter.iref(definition)).to(eq([''])) }
     end
 
-    context 'when iref on the document' do
-      before { allow(document).to(receive(:iref).with(no_args).and_return(true)) }
-
-      context 'when no iref on the definition' do
-        before do
-          allow(definition).to(receive(:iref).with(no_args).and_return([]))
-          formatter.iref_body(definition)
-        end
-
-        it { expect(definition).to(have_received(:iref).with(no_args)) }
-
-        it { expect(formatter.iref_body(definition)).to(eq([''])) }
+    context 'when iref on the definition' do
+      before do
+        allow(definition).to(receive(:iref).with(no_args).and_return(%w[A B]))
+        formatter.iref(definition)
       end
 
-      context 'when iref on the definition' do
-        before do
-          allow(definition).to(receive(:iref).with(no_args).and_return(%w[A B]))
-          formatter.iref_body(definition)
-        end
-
-        it { expect(definition).to(have_received(:iref).with(no_args)) }
-
-        it { expect(formatter.iref_body(definition)).to(eq(["A\nB"])) }
-      end
+      it { expect(definition).to(have_received(:iref).with(no_args)) }
+      it { expect(formatter.iref(definition)).to(eq(["A\nB"])) }
     end
   end
 
-  describe '#attributes_body' do
+  describe '#attributes' do
     context 'when no attributes on the document' do
       before do
         allow(document).to(receive(:attributes).with(no_args).and_return({}))
-        formatter.attributes_body(definition)
+        formatter.attributes(definition)
       end
 
       it { expect(document).to(have_received(:attributes).with(no_args)) }
-
-      it { expect(formatter.attributes_body(nil)).to(eq([])) }
+      it { expect(formatter.attributes(nil)).to(eq([])) }
     end
 
     context 'when attributes on the document' do
       before do
-        allow(document).to(receive(:attributes).with(no_args).and_return(
-                             a: 'whatever',
-                             b: 'whatever',
-                             c: 'whatever'
-                           ))
+        allow(document).to(
+          receive(:attributes).with(no_args)
+            .and_return(a: 'whatever', b: 'whatever', c: 'whatever')
+        )
         allow(definition).to(receive(:attributes).and_return(a: 'X', b: '', c: 'Y'))
-        formatter.attributes_body(definition)
+        formatter.attributes(definition)
       end
 
       it { expect(definition).to(have_received(:attributes).exactly(3).times) }
-
-      it { expect(formatter.attributes_body(definition)).to(eq(['X', '', 'Y'])) }
+      it { expect(formatter.attributes(definition)).to(eq(['X', '', 'Y'])) }
     end
   end
 end

data/spec/unit/defmastership/csv_formatter_header_spec.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('defmastership')
@@ -12,88 +13,134 @@ RSpec.describe(DefMastership::CSVFormatterHeader) do
   end
 
   describe '#header' do
-    describe '#fixed_header' do
-      it { expect(formatter.fixed_header).to(eq(%w[Type Reference Value])) }
+    describe '#fixed' do
+      it { expect(formatter.fixed).to(eq(%w[Type Reference Value Checksum])) }
     end
 
-    describe '#labels_header' do
+    describe '#explicit_version' do
+      context 'when no explicit version' do
+        before do
+          allow(document).to(receive(:explicit_version?).and_return(false))
+          formatter.explicit_version
+        end
+
+        it { expect(document).to(have_received(:explicit_version?)) }
+
+        it { expect(formatter.explicit_version).to(eq([])) }
+      end
+
+      context 'when explicit version' do
+        before do
+          allow(document).to(receive(:explicit_version?).and_return(true))
+          formatter.explicit_version
+        end
+
+        it { expect(formatter.explicit_version).to(eq(['Version'])) }
+      end
+    end
+
+    describe '#wrong_explicit_checksum' do
+      context 'when no wrong explicit checksum' do
+        before do
+          allow(document).to(receive(:wrong_explicit_checksum?).and_return(false))
+          formatter.wrong_explicit_checksum
+        end
+
+        it { expect(document).to(have_received(:wrong_explicit_checksum?)) }
+
+        it { expect(formatter.wrong_explicit_checksum).to(eq([])) }
+      end
+
+      context 'when wrong explicit checksum' do
+        before do
+          allow(document).to(receive(:wrong_explicit_checksum?).and_return(true))
+          formatter.wrong_explicit_checksum
+        end
+
+        it { expect(formatter.wrong_explicit_checksum).to(eq(['Wrong explicit checksum'])) }
+      end
+    end
+
+    describe '#labels' do
       context 'when no labels' do
         before do
           allow(document).to(receive(:labels).and_return([]))
-          formatter.labels_header
+          formatter.labels
         end
 
         it { expect(document).to(have_received(:labels)) }
 
-        it { expect(formatter.labels_header).to(eq([])) }
+        it { expect(formatter.labels).to(eq([])) }
       end
 
       context 'when there is labels' do
         before { allow(document).to(receive(:labels).and_return(['Whatever'])) }
 
-        it { expect(formatter.labels_header).to(eq(['Labels'])) }
+        it { expect(formatter.labels).to(eq(['Labels'])) }
       end
     end
 
-    describe '#eref_header' do
+    describe '#eref' do
       context 'when no eref' do
         before do
           allow(document).to(receive(:eref).and_return({}))
-          formatter.eref_header
+          formatter.eref
         end
 
         it { expect(document).to(have_received(:eref)) }
 
-        it { expect(formatter.eref_header).to(eq([])) }
+        it { expect(formatter.eref).to(eq([])) }
       end
 
       context 'when eref' do
         before do
-          allow(document).to(receive(:eref).and_return(
-                               whatever: { prefix: 'A' },
-                               other: { prefix: 'C', url: 'D' }
-                             ))
+          allow(document).to(
+            receive(:eref).and_return(
+              whatever: { prefix: 'A' },
+              other: { prefix: 'C', url: 'D' }
+            )
+          )
         end
 
-        it { expect(formatter.eref_header).to(eq(['A', 'C D'])) }
+        it { expect(formatter.eref).to(eq(%w[A C])) }
       end
     end
 
-    describe '#iref_header' do
+    describe '#iref' do
       context 'when no iref' do
         before do
           allow(document).to(receive(:iref).and_return(false))
-          formatter.iref_header
+          formatter.iref
         end
 
         it { expect(document).to(have_received(:iref)) }
 
-        it { expect(formatter.iref_header).to(eq([])) }
+        it { expect(formatter.iref).to(eq([])) }
       end
 
       context 'when iref' do
         before { allow(document).to(receive(:iref).and_return(true)) }
 
-        it { expect(formatter.iref_header).to(eq(['Internal links'])) }
+        it { expect(formatter.iref).to(eq(['Internal links'])) }
       end
     end
 
-    describe '#attributes_header' do
+    describe '#attributes' do
       context 'when no attributes' do
         before do
           allow(document).to(receive(:attributes).and_return({}))
-          formatter.attributes_header
+          formatter.attributes
         end
 
         it { expect(document).to(have_received(:attributes)) }
 
-        it { expect(formatter.attributes_header).to(eq([])) }
+        it { expect(formatter.attributes).to(eq([])) }
       end
 
       context 'when attributes' do
         before { allow(document).to(receive(:attributes).and_return(whatever: 'A', other: 'B')) }
 
-        it { expect(formatter.attributes_header).to(eq(%w[A B])) }
+        it { expect(formatter.attributes).to(eq(%w[A B])) }
       end
     end
   end