defmastership 1.0.7 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0341f43f016456f897b3382a1a8356dd7dc5d35b37059bccfd254f5cd9ccf65d
-  data.tar.gz: 442ebad69c76c21f8bfb972bd53d7ce83e6431795026f7b4abc760a70b450bf7
+  metadata.gz: 1a98ba2cd70decfd584d57f914d05bc31356cd53846fa13b01f3406ff41dc087
+  data.tar.gz: 999f28e56b654a6dd35d9da30a8701abd1121f62db4df730fcf903a255b34eff
 SHA512:
-  metadata.gz: 7106dd56ff07b88ca64e67f3dbd62b46f09a078dff05a955f80a5a1473ca3ff918ff038346a9e598c8355de761e1e5dcc1270db811eadacb875d51de57032b09
-  data.tar.gz: 719a47a9bb86aca473565693a645a85b72ade6036a2ed1ee47cdafc00c85640c52a747e2394d59e8f2ed08803406d49f03914a1b5d74026d20ae01de56b8c474
+  metadata.gz: 44bd90676d2ebd37cf47c0e6d9160340d1861497eb4a110e47e5b35c26cd23a28a1ddd24c93e489238520f916997fb2f45801ec1c74b84a7c44f16798b3c0eaf
+  data.tar.gz: 60d4904b54cbb6708ff1633ad0d01d9e43a97d0e4cb90c51126487de2eae477e81e670db38fc151784bde3bb59f1f473abf804f08f0968f06d99dbd58a32c3fa

data/.rubocop.yml

@@ -62,3 +62,7 @@ RSpec/FilePath :
 
 RSpec/NestedGroups:
   Max: 4
+
+Layout/RedundantLineBreak:
+  Enabled: false
+  

data/bin/defmastership

@@ -65,7 +65,7 @@ module DefMastership
           my_doc.definitions.each do |definition|
             next if definition.wrong_explicit_checksum.nil?
 
-            warn("WARNING: #{definition.reference} has a wrong explicit checksum (should be #{definition.sha256})")
+            warn("warning: #{definition.reference} has a wrong explicit checksum (should be #{definition.sha256})")
           end
           exit 1 unless options[:"no-fail"]
         end

data/features/changeref.feature

@@ -36,6 +36,39 @@ Feature: The changeref command
     [define, requirement, TOTO-0123]
     """
 
+  Scenario: Change a definition with explicit checksum and version
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(a~12345678)]
+    """
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "modifications.yml" should contain:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123(a~12345678)]
+    """
+
   Scenario: Change two definitions
     Given a file named "modifications.yml" with:
     """

data/features/{checksum.feature → definition_checksum.feature}

@@ -1,4 +1,4 @@
-Feature: checksum
+Feature: definition checksum 
   As a Responsible of definitions for a given document
   In order to detect modifications of defintiions
   I want defmastership to export and update checksum in definitions
@@ -6,69 +6,69 @@ Feature: checksum
   Scenario: Extract one definition with WRONG explicit checksum to CSV 
     Given a file named "thedoc.adoc" with:
     """
-    [define, requirement, TOTO-0001(babe1234)]
+    [define, requirement, TOTO-0001(~babe1234)]
     def one
     """
     When I run `defmastership export thedoc.adoc`
     Then it should fail with:
     """
-    WARNING: TOTO-0001 has a wrong explicit checksum (should be d27cb5c3)
+    warning: TOTO-0001 has a wrong explicit checksum (should be ~d27cb5c3)
     """
     And the file "thedoc.csv" should contain:
     """
-    Type,Reference,Value,sha256,Wrong explicit checksum
-    requirement,TOTO-0001,def one,d27cb5c3,babe1234
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,~babe1234
     """
     And the stdout should not contain anything
 
   Scenario: Extract two definitions with one WRONG explicit checksum to CSV 
     Given a file named "thedoc.adoc" with:
     """
-    [define, requirement, TOTO-0001(d27cb5c3)]
+    [define, requirement, TOTO-0001(~d27cb5c3)]
     def one
 
-    [define, requirement, TOTO-0002(babe1234)]
+    [define, requirement, TOTO-0002(~babe1234)]
     def two
     """
     When I run `defmastership export thedoc.adoc`
     Then it should fail with:
     """
-    WARNING: TOTO-0002 has a wrong explicit checksum (should be b80e1be5)
+    warning: TOTO-0002 has a wrong explicit checksum (should be ~b80e1be5)
     """
     Then the file "thedoc.csv" should contain:
     """
-    Type,Reference,Value,sha256,Wrong explicit checksum
-    requirement,TOTO-0001,def one,d27cb5c3,\"\"
-    requirement,TOTO-0002,def two,b80e1be5,babe1234
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,\"\"
+    requirement,TOTO-0002,def two,~b80e1be5,~babe1234
     """
     And the stdout should not contain anything
 
   Scenario: Export not failing even if WRONG explicit checksum 
     Given a file named "thedoc.adoc" with:
     """
-    [define, requirement, TOTO-0001(d27cb5c3)]
+    [define, requirement, TOTO-0001(~d27cb5c3)]
     def one
 
-    [define, requirement, TOTO-0002(babe1234)]
+    [define, requirement, TOTO-0002(~babe1234)]
     def two
     """
     When I successfully run `defmastership export --no-fail thedoc.adoc`
     Then the file "thedoc.csv" should contain:
     """
-    Type,Reference,Value,sha256,Wrong explicit checksum
-    requirement,TOTO-0001,def one,d27cb5c3,\"\"
-    requirement,TOTO-0002,def two,b80e1be5,babe1234
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,\"\"
+    requirement,TOTO-0002,def two,~b80e1be5,~babe1234
     """
     And the stdout should not contain anything
     And the stderr should contain:
     """
-    WARNING: TOTO-0002 has a wrong explicit checksum (should be b80e1be5)
+    warning: TOTO-0002 has a wrong explicit checksum (should be ~b80e1be5)
     """
 
   Scenario: Extract one definition with explicit checksum to CSV 
     Given a file named "thedoc.adoc" with:
     """
-    [define, requirement, TOTO-0001(b86dcbde)]
+    [define, requirement, TOTO-0001(~b86dcbde)]
     --
     Exemple of multiline requirement.
     Second line.
@@ -77,9 +77,9 @@ Feature: checksum
     When I successfully run `defmastership export thedoc.adoc`
     Then the file "thedoc.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde
+    Second line.",~b86dcbde
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
@@ -105,7 +105,7 @@ Feature: checksum
     And the stderr should not contain anything
     And the file "thedoc.adoc" should contain:
     """
-    [define, requirement, TOTO-TEMP-XXX1(244eed18)]
+    [define, requirement, TOTO-TEMP-XXX1(~244eed18)]
     --
     the requirement value.
     --
@@ -122,7 +122,7 @@ Feature: checksum
     """
     And a file named "thedoc.adoc" with:
     """
-    [define, requirement, TOTO-TEMP-XXX1(abcd1234)]
+    [define, requirement, TOTO-TEMP-XXX1(~abcd1234)]
     --
     the requirement value.
     --
@@ -132,7 +132,7 @@ Feature: checksum
     And the stderr should not contain anything
     And the file "thedoc.adoc" should contain:
     """
-    [define, requirement, TOTO-TEMP-XXX1(244eed18)]
+    [define, requirement, TOTO-TEMP-XXX1(~244eed18)]
     --
     the requirement value.
     --
@@ -154,14 +154,14 @@ Feature: checksum
     When I successfully run `defmastership export thedoc.adoc`
     Then the file "thedoc.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde
+    Second line.",~b86dcbde
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
 
-  Scenario: Checksum is calculated on included file in ref modifcation
+  Scenario: Checksum is calculated on included file in ref modification
     Given a file named "modifications.yml" with:
     """
     ---
@@ -185,7 +185,7 @@ Feature: checksum
     When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
     Then the file "thedoc.adoc" should contain:
     """
-    [define, requirement, TOTO-0001(b86dcbde)]
+    [define, requirement, TOTO-0001(~b86dcbde)]
     --
     include::included.txt[]
     --
@@ -206,14 +206,14 @@ Feature: checksum
     When I successfully run `defmastership export thedoc.adoc`
     Then the file "thedoc.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde
+    Second line.",~b86dcbde
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
 
-  Scenario: Checksum take into account variables in ref modifcation
+  Scenario: Checksum take into account variables in ref modification
     Given a file named "modifications.yml" with:
     """
     ---
@@ -234,7 +234,7 @@ Feature: checksum
     When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
     Then the file "thedoc.adoc" should contain:
     """
-    [define, requirement, TOTO-0001(b86dcbde)]
+    [define, requirement, TOTO-0001(~b86dcbde)]
     --
     Exemple of {variable} requirement.
     Second line.
@@ -242,3 +242,57 @@ Feature: checksum
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
+
+  Scenario: Checksum keep explicit version in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~abcd1234)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum keep explicit version in ref setting
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~244eed18)]
+    --
+    the requirement value.
+    --
+    """

data/features/definition_version.feature

@@ -0,0 +1,204 @@
+Feature: definitions version 
+  As a Responsible of definitions for a given document 
+  In order to detect handle versions definitions
+  I want defmastership to export explicit versions in definitions
+
+  Scenario: Extract one definition with explicit version to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(pouet)]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Version
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde,pouet
+    """
+    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.
+    --
+    """
+