defmastership 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd61d32bacab380bbfc110df15fd6617b38540aa5bc8eb14bd5b2736e657b7c
-  data.tar.gz: 1ec7bc921411173863b71ba0c3f4164829ac2efbe0689c321830f632a3333f64
+  metadata.gz: '0498ff0b39ccfc024d4988c4c1137726e827e841a1750b921bc4c8d3be06db62'
+  data.tar.gz: af1b86530d440a08417bac712f15e30db40aa01b07ea312b1d7d4f125dccef5c
 SHA512:
-  metadata.gz: e8dcebcb309fd755a339ab702f7c07c65387e5a961400518661d70e9421911630652855a10ad647ac6155b9686665927fde8315a8efb71e3a2913a8db32fbcd5
-  data.tar.gz: 83e28e54b372de48cc554b8f532e659817453e905f3c6634071b3e280f23fba2431119353af9bdd6b23b97a6d6bf8a2b9a261b39e70591f27be45a3b04dce19b
+  metadata.gz: ec47e5182f9586be6102eed5be90c459db84e54e334cbe867bee2be4bf34645f8a91d7e08aea0b89a4733e3ca6089c90f96e1a6969d8f6b329034cc4486bd8b2
+  data.tar.gz: 625fb3fb76aaac4189ce12cd2f9af3bfa83491a2ecbbe5192bb35ffe43e121e54a27a318afb60ad938a8e58818bccef38896b919d5b9678ea0af4565c09aab66

data/features/definition_version.feature

@@ -22,3 +22,183 @@ Feature: definitions version
     And the stdout should not contain anything
     And the stderr should not contain anything
 
+  Scenario: Set initial explicit version when definition has changed 
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.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_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: Do not set initial explicit version when definition has NOT changed 
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    initial text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+
+  Scenario: Set initial explicit version when definition has changed and ref is not an initial version
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(3)]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.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: 1
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(4)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: No initial explicit version when definition is new
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0002]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.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: 1
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: update explicit version whith explicit checksum
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever~abcd1234)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a~abcd1234)]
+    --
+    modified text.
+    --
+    """
+

data/lib/defmastership.rb

@@ -25,3 +25,6 @@ require('defmastership/rename_included_files_line_modifier')
 
 require('defmastership/update_def_checksum_modifier')
 require('defmastership/update_def_checksum_line_modifier')
+
+require('defmastership/update_def_version_modifier')
+require('defmastership/update_def_version_line_modifier')

data/lib/defmastership/update_def_checksum_modifier.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module DefMastership
-  # Update definition checksum wih calculated one
+  # Update definition checksum with calculated one
   class UpdateDefChecksumModifier < ModifierBase
     def replacements
       %i[replace]

data/lib/defmastership/update_def_version_line_modifier.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # modify one line after another
+  class UpdateDefVersionLineModifier < LineModifierBase
+    attr_accessor :document, :ref_document
+
+    def self.from_config(hash)
+      new.from_config(hash)
+    end
+
+    def initialize
+      super
+      @config = {
+        def_type: '',
+        ref_document: '',
+        first_version: ''
+      }
+    end
+
+    def replace(line)
+      match = matched?(line)
+
+      return line unless match
+      return line unless match[:type] == def_type
+
+      version_and_checksum = ''
+      if match[:explicit_checksum] || version_string(match)
+        version_and_checksum = "(#{version_string(match)}#{match[:explicit_checksum]})"
+      end
+
+      line.gsub(Regexp.new("#{match[:reference]}#{DMRegexp::DEF_VERSION_AND_CHECKSUM}")) do
+        "#{match[:reference]}#{version_and_checksum}"
+      end
+    end
+
+    private
+
+    def matched?(line)
+      return if line.commented?
+      return unless line =~ DMRegexp::DEFINITION
+
+      Regexp.last_match
+    end
+
+    def version_string(match)
+      ref_definition = @ref_document.ref_to_def(match[:reference])
+      definition = @document.ref_to_def(match[:reference])
+
+      return if ref_definition.nil?
+      return ref_definition.explicit_version if definition.sha256 == ref_definition.sha256
+
+      ref_version = @ref_document.ref_to_def(match[:reference]).explicit_version
+      ref_version.nil? ? @config[:first_version] : ref_version.next
+    end
+  end
+end

data/lib/defmastership/update_def_version_modifier.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # Update definition version if the definition has change since
+  # reference document
+  class UpdateDefVersionModifier < ModifierBase
+    def replacements
+      %i[replace]
+    end
+
+    def new_line_modifier(config, adoc_texts)
+      document = Document.new
+      adoc_texts.each do |adoc_file, _|
+        document.parse_file_with_preprocessor(adoc_file)
+      end
+      ref_document = Document.new
+      ref_document.parse_file_with_preprocessor(config[:ref_document])
+      line_modifier = UpdateDefVersionLineModifier.from_config(config)
+      line_modifier.document = document
+      line_modifier.ref_document = ref_document
+      line_modifier
+    end
+  end
+end

data/lib/defmastership/version.rb

@@ -2,6 +2,6 @@
 # frozen_string_literal: true
 
 module DefMastership
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
   public_constant :VERSION
 end

data/spec/unit/defmastership/update_def_version_line_modifier_spec.rb

@@ -0,0 +1,127 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::UpdateDefVersionLineModifier) do
+  subject(:linemodifier) { described_class.new }
+
+  describe '.new' do
+    it { is_expected.not_to(be(nil)) }
+    it { is_expected.to(have_attributes(def_type: '')) }
+    it { is_expected.to(have_attributes(changes:  [])) }
+    it { expect { linemodifier.user_defined_attribute }.to(raise_error(NoMethodError)) }
+  end
+
+  describe '.from_config' do
+    subject(:linemodifier) do
+      described_class.from_config(
+        def_type: 'requirement',
+        first_version: 'a'
+      )
+    end
+
+    it { is_expected.not_to(be(nil)) }
+    it { is_expected.to(have_attributes(def_type: 'requirement')) }
+    it { is_expected.to(have_attributes(first_version: 'a')) }
+    it { is_expected.to(have_attributes(document: nil)) }
+    it { is_expected.to(have_attributes(ref_document: nil)) }
+  end
+
+  describe '#replace' do
+    subject(:linemodifier) do
+      described_class.from_config(
+        def_type: 'requirement',
+        first_version: 'a'
+      )
+    end
+
+    let(:document)       { instance_double(DefMastership::Document, 'document')          }
+    let(:ref_document)   { instance_double(DefMastership::Document, 'ref_document')      }
+    let(:definition)     { instance_double(DefMastership::Definition, 'definition')      }
+    let(:ref_definition) { instance_double(DefMastership::Definition, 'ref_definitions') }
+
+    before do
+      linemodifier.document = document
+      linemodifier.ref_document = ref_document
+      allow(File).to(receive(:rename))
+    end
+
+    context 'when definition has not the good type' do
+      it do
+        expect(linemodifier.replace('[define,req,REFERENCE]'))
+          .to(eq('[define,req,REFERENCE]'))
+      end
+    end
+
+    context 'when definition has the good type' do
+      before do
+        allow(document).to(receive(:ref_to_def).with('REFERENCE').and_return(definition))
+        allow(definition).to(receive(:sha256).and_return('~abcd1234'))
+      end
+
+      context 'when definition has NOT changed' do
+        before do
+          allow(ref_document).to(receive(:ref_to_def).with('REFERENCE').and_return(ref_definition))
+          allow(ref_definition).to(receive(:sha256).and_return('~abcd1234'))
+        end
+
+        it do
+          allow(ref_definition).to(receive(:explicit_version).and_return(nil))
+          expect(linemodifier.replace('[define,requirement,REFERENCE]'))
+            .to(eq('[define,requirement,REFERENCE]'))
+        end
+
+        it do
+          allow(ref_definition).to(receive(:explicit_version).and_return('c'))
+          expect(linemodifier.replace('[define,requirement,REFERENCE]'))
+            .to(eq('[define,requirement,REFERENCE(c)]'))
+        end
+
+        it do
+          allow(ref_definition).to(receive(:explicit_version).and_return('c'))
+          expect(linemodifier.replace('[define,requirement,REFERENCE(tyty~1234)]'))
+            .to(eq('[define,requirement,REFERENCE(c~1234)]'))
+        end
+      end
+
+      context 'when definition has changed' do
+        before do
+          allow(ref_document).to(receive(:ref_to_def).with('REFERENCE').and_return(ref_definition))
+          allow(ref_definition).to(receive(:sha256).and_return('~4321aaaa'))
+        end
+
+        [
+          [nil,    '',            '(a)'],
+          ['c',    '',            '(d)'],
+          ['c',    '(tyty~1234)', '(d~1234)'],
+          ['2',    '',            '(3)'],
+          ['1222', '',            '(1223)'],
+          ['abb',  '',            '(abc)']
+        ].each do |ref, from, to|
+          it do
+            allow(ref_definition).to(receive(:explicit_version).and_return(ref))
+            expect(linemodifier.replace("[define,requirement,REFERENCE#{from}]"))
+              .to(eq("[define,requirement,REFERENCE#{to}]"))
+          end
+        end
+      end
+
+      context 'when definition is new' do
+        before do
+          allow(ref_document).to(receive(:ref_to_def).with('REFERENCE').and_return(nil))
+        end
+
+        it do
+          expect(linemodifier.replace('[define,requirement,REFERENCE(whatever)]'))
+            .to(eq('[define,requirement,REFERENCE]'))
+        end
+
+        it do
+          expect(linemodifier.replace('[define,requirement,REFERENCE(~1234)]'))
+            .to(eq('[define,requirement,REFERENCE(~1234)]'))
+        end
+      end
+    end
+  end
+end

data/spec/unit/defmastership/update_def_version_modifier_spec.rb

@@ -0,0 +1,80 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::UpdateDefVersionModifier) do
+  subject(:modifier) do
+    described_class.new(
+      ref_document: 'ref.adoc'
+    )
+  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: { ref_document: 'ref.adoc' })) }
+    it { is_expected.to(have_attributes(changes: [])) }
+  end
+
+  describe '#do_modifications' do
+    let(:line_modifier) { instance_double(DefMastership::UpdateDefVersionLineModifier, 'lineModifier') }
+    let(:document)      { instance_double(DefMastership::Document, 'document')                         }
+    let(:ref_document)  { instance_double(DefMastership::Document, 'ref_document')                     }
+
+    before do
+      allow(DefMastership::UpdateDefVersionLineModifier).to(
+        receive(:from_config).with(ref_document: 'ref.adoc').and_return(line_modifier)
+      )
+      allow(DefMastership::Document).to(receive(:new).and_return(document, ref_document))
+      allow(document).to(receive(:parse_file_with_preprocessor))
+      allow(ref_document).to(receive(:parse_file_with_preprocessor))
+      allow(line_modifier).to(receive(:'document=').with(document))
+      allow(line_modifier).to(receive(:'ref_document=').with(ref_document))
+      allow(line_modifier).to(receive(:replace).with("file1 line1\n").and_return("new file1 line1\n"))
+      allow(line_modifier).to(receive(:replace).with('file1 line2').and_return('new file1 line2'))
+      allow(line_modifier).to(receive(:replace).with("file2 line1\n").and_return("new file2 line1\n"))
+      allow(line_modifier).to(receive(:replace).with('file2 line2').and_return('new file2 line2'))
+      allow(line_modifier).to(receive(:config).and_return(ref_document: 'ref.adoc'))
+      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::UpdateDefVersionLineModifier).to(
+          have_received(:from_config).with(ref_document: 'ref.adoc')
+        )
+      end
+
+      it { expect(document).to(have_received(:parse_file_with_preprocessor).with('file1.adoc')) }
+      it { expect(document).to(have_received(:parse_file_with_preprocessor).with('file2.adoc')) }
+      it { expect(ref_document).to(have_received(:parse_file_with_preprocessor).with('ref.adoc')) }
+      it { expect(line_modifier).to(have_received(:'document=').with(document)) }
+      it { expect(line_modifier).to(have_received(:'ref_document=').with(ref_document)) }
+      it { expect(line_modifier).to(have_received(:replace).with("file1 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace).with('file1 line2')) }
+      it { expect(line_modifier).to(have_received(:replace).with("file2 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace).with('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: { ref_document: 'ref.adoc' })) }
+      it { is_expected.to(have_attributes(changes: [%w[from1 to1], %w[from2 to2]])) }
+    end
+
+    it do
+      expected_adoc = {
+        'file1.adoc' => "new file1 line1\nnew file1 line2",
+        'file2.adoc' => "new file2 line1\nnew file2 line2"
+      }
+      expect(modifier.do_modifications(adoc_texts)).to(eq(expected_adoc))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
@@ -220,6 +220,8 @@ files:
 - lib/defmastership/rename_included_files_modifier.rb
 - lib/defmastership/update_def_checksum_line_modifier.rb
 - lib/defmastership/update_def_checksum_modifier.rb
+- lib/defmastership/update_def_version_line_modifier.rb
+- lib/defmastership/update_def_version_modifier.rb
 - lib/defmastership/version.rb
 - spec/spec_helper.rb
 - spec/unit/defmastership/batch_modifier_spec.rb
@@ -236,6 +238,8 @@ files:
 - spec/unit/defmastership/rename_included_files_modifier_spec.rb
 - spec/unit/defmastership/update_def_checksum_line_modifier_spec.rb
 - spec/unit/defmastership/update_def_checksum_modifier_spec.rb
+- spec/unit/defmastership/update_def_version_line_modifier_spec.rb
+- spec/unit/defmastership/update_def_version_modifier_spec.rb
 - spec/unit/defmastership_spec.rb
 homepage: https://gitlab.com/jjag/defmastership/
 licenses: