defmastership 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0341f43f016456f897b3382a1a8356dd7dc5d35b37059bccfd254f5cd9ccf65d
-  data.tar.gz: 442ebad69c76c21f8bfb972bd53d7ce83e6431795026f7b4abc760a70b450bf7
+  metadata.gz: c6fbf5098c8ab70e422d9c158c0a28cd876de25cfd159a131b0ddefc5f1eca86
+  data.tar.gz: 8717156666df342a45994bb455b0cc58f09fc1da9b31c48cd0d4b36a40c528b6
 SHA512:
-  metadata.gz: 7106dd56ff07b88ca64e67f3dbd62b46f09a078dff05a955f80a5a1473ca3ff918ff038346a9e598c8355de761e1e5dcc1270db811eadacb875d51de57032b09
-  data.tar.gz: 719a47a9bb86aca473565693a645a85b72ade6036a2ed1ee47cdafc00c85640c52a747e2394d59e8f2ed08803406d49f03914a1b5d74026d20ae01de56b8c474
+  metadata.gz: 6afcfd48186a2f89426e62007dc068711ea36e26a8ecf9b9c56428a351eabb6a89be58872a96de30c9a87ccdc71366e685fd8486469a3465e661ae490c0925be
+  data.tar.gz: 275587475f39f39bbd311cdf9a0fb1cc9cdcb30c6cf766b44d9b1ff64ac9a8feb2c9117f4903f8eb806b3e73594b6c2e5e63876038483429cabd7eb66fb93575

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/{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.

data/features/definition_version.feature

@@ -0,0 +1,24 @@
+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
+

data/features/export.feature

@@ -15,9 +15,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.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
@@ -34,9 +34,9 @@ Feature: The extract command
     When I successfully run `defmastership export --separator=';' toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type;Reference;Value;sha256
+    Type;Reference;Value;Checksum
     requirement;TOTO-0001;"Exemple of multiline requirement.
-    Second line.";b86dcbde
+    Second line.";~b86dcbde
     """
 
   Scenario: Extract one definition with variable to CSV 
@@ -54,10 +54,10 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement with variable: Variable content.
     Variable content : Variable content Toto.
-    Third line with {not_defined_variable}.",3bf370ed
+    Third line with {not_defined_variable}.",~3bf370ed
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
@@ -82,11 +82,11 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde
+    Second line.",~b86dcbde
     something_else,TOTO-0003,"only one paragraphe.
-    with two sentences.",4761e172
+    with two sentences.",~4761e172
     """
     And the file "toto.csv" should not contain:
     """
@@ -172,9 +172,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Labels
+    Type,Reference,Value,Checksum,Labels
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"label1
+    Second line.",~b86dcbde,"label1
     label2"
     """
     And the stdout should not contain anything
@@ -195,9 +195,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Participate to:
+    Type,Reference,Value,Checksum,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"SYSTEM-0012
+    Second line.",~b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
     And the stdout should not contain anything
@@ -218,9 +218,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Participate to:
+    Type,Reference,Value,Checksum,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"SYSTEM-0012
+    Second line.",~b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
     And the stdout should not contain anything
@@ -242,9 +242,9 @@ Feature: The extract command
     And the stderr should not contain anything
     And the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Participate to:
+    Type,Reference,Value,Checksum,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"SYSTEM-0012
+    Second line.",~b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
 
@@ -261,9 +261,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Internal links
+    Type,Reference,Value,Checksum,Internal links
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].",059b7188,"TOTO-0001
+    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].",~059b7188,"TOTO-0001
     TOTO-0123
     TOTO-0002"
     """
@@ -286,8 +286,8 @@ Feature: The extract command
     And the stdout should not contain anything
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Verified by:,Criticity:
-    requirement,TOTO-0001,One single line.,554b0ff5,Beautiful Test,Very cool
+    Type,Reference,Value,Checksum,Verified by:,Criticity:
+    requirement,TOTO-0001,One single line.,~554b0ff5,Beautiful Test,Very cool
     """
     And the stdout should not contain anything
     And the stderr should not contain anything

data/features/modify.feature

@@ -3,7 +3,7 @@ Feature: The modify command
   In order to manage to applu predefined modifications
   I want defmastership to apply automatic modifications
 
-  Scenario: Change one modifier
+  Scenario: Changes with one modifier
     Given a file named "modifications.yml" with:
     """
     ---
@@ -36,6 +36,28 @@ Feature: The modify command
     [define, requirement, TOTO-0123]
     """
 
+
+  Scenario: Change with wrong modifier
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :temp-references:
+      :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]
+    """
+    When I run `defmastership modify --modifications wrong-modification thedoc.adoc`
+    Then it should fail with:
+    """
+    error: wrong-modification is not a known modification
+    """
+
   Scenario: Make modifications with yaml file parameter 
     Given a file named "pouet.yml" with:
     """

data/lib/defmastership/batch_modifier.rb

@@ -26,6 +26,8 @@ module DefMastership
     private
 
     def modifier_from(modif)
+      raise(ArgumentError, "#{modif} is not a known modification") if @config[modif.to_sym].nil?
+
       class_name = "#{@config[modif.to_sym][:type].split('_').map(&:capitalize).join}Modifier"
       DefMastership.const_get(class_name).new(@config[modif.to_sym][:config])
     end

data/lib/defmastership/constants.rb

@@ -20,10 +20,10 @@ module DefMastership
       (,\s*\[\s*(?<labels>.*?)\s*\])?\s*\]
     AFT
 
-    DEF_CHECKSUM = '(\((?<explicit_checksum>[[:alnum:]]+)\))?'
+    DEF_VERSION_AND_CHECKSUM = '(\((?<explicit_version>[^~]+)?(?<explicit_checksum>~[[:alnum:]]+)?\))?'
 
     DEFINITION = Regexp.new(
-      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_CHECKSUM}#{DEF_AFTER_REF}",
+      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
       Regexp::EXTENDED
     )
 

data/lib/defmastership/csv_formatter.rb

@@ -8,18 +8,13 @@ require('defmastership/csv_formatter_body')
 module DefMastership
   # to export a CSV file
   class CSVFormatter
-    COLUMN_LIST1 = %i[fixed wrong_explicit_checksum labels eref iref attributes].freeze
-    COLUMN_LIST2 = %i[fixed labels eref iref attributes].freeze
-    private_constant :COLUMN_LIST1
-    private_constant :COLUMN_LIST2
-
     def initialize(doc, sep = ',')
       @doc = doc
       @sep = sep
     end
 
     def export_to(output_file)
-      column_list = @doc.wrong_explicit_checksum? ? COLUMN_LIST1 : COLUMN_LIST2
+      column_list = build_column_list
       CSV.open(output_file, 'w:ISO-8859-1', { col_sep: @sep }) do |csv|
         csv << header(column_list)
         @doc.definitions.each { |definition| csv << body(definition, column_list) }
@@ -39,5 +34,16 @@ module DefMastership
       body_line = column_list.map { |part| body_formatter.public_send(part, definition) }
       body_line.reduce(:+)
     end
+
+    def build_column_list
+      column_list = [:fixed]
+      column_list += [:wrong_explicit_checksum] if @doc.wrong_explicit_checksum?
+      column_list += [:explicit_version] if @doc.explicit_version?
+      column_list += [:labels] unless @doc.labels.empty?
+      column_list += [:eref] unless @doc.eref.empty?
+      column_list += [:iref] if @doc.iref
+      column_list += [:attributes] unless @doc.attributes.empty?
+      column_list
+    end
   end
 end