defmastership 1.0.18 → 1.0.19

data/features/definition_checksum.feature

@@ -82,7 +82,6 @@ Feature: definition checksum
     Second line.",~b86dcbde
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Change one modifier
     Given a file named "modifications.yml" with:
@@ -102,7 +101,6 @@ Feature: definition checksum
     """
     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(~244eed18)]
@@ -129,7 +127,6 @@ Feature: definition checksum
     """
     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(~244eed18)]
@@ -159,7 +156,6 @@ Feature: definition checksum
     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 modification
     Given a file named "modifications.yml" with:
@@ -191,7 +187,6 @@ Feature: definition checksum
     --
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Checksum take into account variables in CSV export
     Given a file named "thedoc.adoc" with:
@@ -211,7 +206,6 @@ Feature: definition checksum
     Second line.",~b86dcbde
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Checksum takes into account variables in ref modification
     Given a file named "modifications.yml" with:
@@ -241,7 +235,6 @@ Feature: definition checksum
     --
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Checksum does not take into account bad variables definition
     Given a file named "modifications.yml" with:
@@ -271,7 +264,6 @@ Feature: definition 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:
@@ -291,7 +283,6 @@ Feature: definition checksum
     """
     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)]
@@ -318,7 +309,6 @@ Feature: definition checksum
     """
     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)]

data/features/definition_version.feature

@@ -1,9 +1,9 @@
-Feature: definitions version 
-  As a Responsible of definitions for a given document 
+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 
+  Scenario: Extract one definition with explicit version to CSV
     Given a file named "thedoc.adoc" with:
     """
     [define, requirement, TOTO-0001(pouet)]
@@ -20,9 +20,8 @@ Feature: definitions version
     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 
+  Scenario: Set initial explicit version when definition has changed
     Given a file named "ref_doc.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -49,7 +48,170 @@ Feature: definitions version
     """
     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: Set initial explicit version when definition has changed with multiple ref_files
+    Given a file named "ref_doc1.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text 1.
+    --
+    """
+    Given a file named "ref_doc2.adoc" with:
+    """
+    [define, requirement, TOTO-0002(z)]
+    --
+    initial text 2.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+
+    [define, requirement, TOTO-0002(whatever)]
+    --
+    modified text again.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ['./ref_doc1.adoc', './ref_doc2.adoc']
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    modified text.
+    --
+
+    [define, requirement, TOTO-0002(aa)]
+    --
+    modified text again.
+    --
+    """
+
+  Scenario: Update explicit version based on git tag
+    Given I initialize a git repo
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    And I add and commit the "thedoc.adoc" file
+    And I set the "THE_TAG" tag
+    And 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_tag: 'THE_TAG'
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: Update explicit version based on git tag on a different git repo
+    And a file named "defmastership-example.adoc" with:
+    """
+    [define, whatever, WHATEVER-0001]
+    Simplest ever definition. !modified!
+    With a single paragraph.
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: whatever
+        :first_version: a
+        :ref_tag: 'TEST_UPDATE_VERSION'
+        :ref_repo: 'https://gitlab.com/defmastership/defmastership-example.git'
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version defmastership-example.adoc`
+    And the stdout should not contain anything
+    Then the file "defmastership-example.adoc" should contain:
+    """
+    [define, whatever, WHATEVER-0001(a)]
+    Simplest ever definition. !modified!
+    With a single paragraph.
+    """
+
+  Scenario: Update explicit version based on git tag and different filename
+    Given I initialize a git repo
+    And a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    And I add and commit the "ref_doc.adoc" file
+    And I set the "THE_TAG" tag
+    And I remove the file "ref_doc.adoc"
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "ref_doc.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
+        :ref_tag: 'THE_TAG'
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
     Then the file "thedoc.adoc" should contain:
     """
     [define, requirement, TOTO-0001(a)]
@@ -85,7 +247,6 @@ Feature: definitions version
     """
     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]
@@ -121,7 +282,6 @@ Feature: definitions version
     """
     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)]
@@ -157,7 +317,6 @@ Feature: definitions version
     """
     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]
@@ -193,7 +352,6 @@ Feature: definitions version
     """
     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)]

data/features/export.feature

@@ -20,7 +20,6 @@ Feature: The extract command
     Second line.",~b86dcbde
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract to CSV with alternative CSV separator
     Given a file named "toto.adoc" with:
@@ -60,7 +59,6 @@ Feature: The extract command
     Third line with {not_defined_variable}.",~3bf370ed
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
 
   Scenario: Extract some definitions to CSV 
@@ -93,7 +91,6 @@ Feature: The extract command
     ignored multiline
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Ignore definitions in literal block
     Given a file named "toto.adoc" with:
@@ -114,7 +111,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Ignore definitions in example block
     Given a file named "toto.adoc" with:
@@ -135,7 +131,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Ignore definitions in commment block
     Given a file named "toto.adoc" with:
@@ -156,7 +151,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Handle mixes comment and literal blocks 
     Given a file named "toto.adoc" with:
@@ -179,7 +173,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract definition with labels 
     Given a file named "toto.adoc" with:
@@ -199,7 +192,6 @@ Feature: The extract command
     label2"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with external ref to CSV
     Given a file named "toto.adoc" with:
@@ -222,7 +214,29 @@ Feature: The extract command
     SYSTEM-0014"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
+
+  Scenario: Extract one definition with external ref (with version and checksum) to CSV
+    Given a file named "toto.adoc" with:
+    """
+    :eref-implements-prefix: Participate to:
+    :eref-implements-url:    ./the_other_document.html
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    defs:eref[implements, [SYSTEM-0012(a), SYSTEM-0014, SYSTEM-0015(b~1223abcd)]]
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Participate to:
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde,"SYSTEM-0012(a)
+    SYSTEM-0014
+    SYSTEM-0015(b~1223abcd)"
+    """
+    And the stdout should not contain anything
 
   Scenario: Extract one definition with missing external ref to CSV
     Given a file named "toto.adoc" with:
@@ -243,7 +257,6 @@ Feature: The extract command
     Second line.",~b86dcbde,
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with external ref without url to CSV 
     Given a file named "toto.adoc" with:
@@ -266,7 +279,6 @@ Feature: The extract command
     SYSTEM-0014"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with external ref to CSV without URL
     Given a file named "toto.adoc" with:
@@ -281,7 +293,6 @@ Feature: The extract command
     """
     When I successfully run `defmastership export toto.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "toto.csv" should contain:
     """
     Type,Reference,Value,Checksum,Participate to:
@@ -310,7 +321,6 @@ Feature: The extract command
     TOTO-0002"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with attributes to CSV 
     Given a file named "toto.adoc" with:
@@ -332,7 +342,6 @@ Feature: The extract command
     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
 
   Scenario: Extract one definition with missing attributes to CSV
     Given a file named "toto.adoc" with:
@@ -353,7 +362,6 @@ Feature: The extract command
     requirement,TOTO-0001,One single line.,~554b0ff5,Beautiful Test,
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with example in it
     Given a file named "toto.adoc" with:
@@ -378,7 +386,6 @@ Feature: The extract command
     ----",~8f20a443
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with single line comment in it
     Given a file named "toto.adoc" with:
@@ -395,7 +402,6 @@ Feature: The extract command
     requirement,TOTO-0001,// comment,~b0b506c3
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with multi line comment or literal in it
     Given a file named "toto.adoc" with:
@@ -422,4 +428,3 @@ Feature: The extract command
     ....",~7eb3c490
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything

data/features/modify.feature

@@ -20,7 +20,6 @@ Feature: The modify command
     """
     When I successfully run `defmastership modify --modifications temp-references thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "modifications.yml" should contain:
     """
     ---
@@ -75,7 +74,6 @@ Feature: The modify command
     """
     When I successfully run `defmastership modify --modifications-file=pouet.yml --modifications toto thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "pouet.yml" should contain:
     """
     ---
@@ -108,8 +106,7 @@ Feature: The modify command
     [define, requirement, TOTO-TEMP-XXX2]
     """
     When I successfully run `defmastership modify --modifications temp-references --changes-summary=changes.csv thedoc.adoc`
-    Then the stderr should not contain anything
-    And the stdout should not contain anything
+    Then the stdout should not contain anything
     And the file "changes.csv" should contain:
     """
     Modifier,Was,Becomes
@@ -141,7 +138,6 @@ Feature: The modify command
     """
     When I successfully run `defmastership modify --modifications temp-references,tata_or_titi --changes-summary=changes.csv thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "modifications.yml" should contain:
     """
     ---

data/features/rename_included_files.feature

@@ -23,7 +23,6 @@ Feature: The rename_included_files command
     And an empty file named "any_path/one_file.png"
     When I successfully run `defmastership modify --modifications rename_included_png thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "thedoc.adoc" should contain:
     """
     include::any_path/one_file.png[]
@@ -49,7 +48,6 @@ Feature: The rename_included_files command
     And an empty file named "any_path/one_file.png"
     When I successfully run `defmastership modify --modifications rename_included_png 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-WHATEVER-123]
@@ -77,7 +75,6 @@ Feature: The rename_included_files command
     And an empty file named "any_path/one_file.png"
     When I successfully run `defmastership modify --modifications rename_included_png 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-WHATEVER-123]
@@ -109,7 +106,6 @@ Feature: The rename_included_files command
     And an empty file named "one_two/one_file.png"
     When I successfully run `defmastership modify --modifications rename_included_png thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "thedoc.adoc" should contain:
     """
     :any: one
@@ -142,7 +138,6 @@ Feature: The rename_included_files command
     And an empty file named "any_path/TOTO-WHATEVER-123_one_file.png"
     When I successfully run `defmastership modify --modifications rename_included_png 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-WHATEVER-123]

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'git'
+
+Given('I initialize a git repo') do
+  Git.init(Aruba.config.home_directory)
+end
+
+Given('I add and commit the {string} file') do |filename|
+  git = Git.open(Aruba.config.home_directory)
+  git.add(filename)
+  git.commit('whatever')
+end
+
+Given('I set the {string} tag') do |tag_name|
+  git = Git.open(Aruba.config.home_directory)
+  git.add_tag(tag_name)
+end

data/lib/defmastership/constants.rb

@@ -23,8 +23,10 @@ module DefMastership
                                '\((?<explicit_version>[^~]+)?(?<explicit_checksum>~[[:alnum:]]+)?\)' \
                                ')?'
 
+    REFERENCE = '(?<reference>[\\w:_-]+)'
+
     DEFINITION = Regexp.new(
-      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
+      "#{DEF_BEFORE_REF}#{REFERENCE}#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
       Regexp::EXTENDED
     )
 
@@ -33,11 +35,11 @@ module DefMastership
 
     VARIABLE_USE = /{(?<varname>[\w:_-]+)}/x.freeze
 
-    EREF_CONFIG = /^\s*:eref-(?<refname>[\w:_-]+)-(?<symb>prefix|url):\s*
+    EREF_CONFIG = /^\s*:eref-(?<reference>[\w:_-]+)-(?<symb>prefix|url):\s*
                    \s*(?<value>\S.*\S)\s*/x.freeze
     EREF_DEF = /^\s*
                defs:eref\[
-               \s*(?<refname>[\w:_-]+)\s*,
+               \s*(?<reference>[\w:_-]+)\s*,
                \s*\[\s*(?<extrefs>[^\]]+?)\s*\]\s*\]/x.freeze
     BLOCK = /^--\s*$/.freeze
 

data/lib/defmastership/definition.rb

@@ -76,8 +76,8 @@ module DefMastership
       explicit_checksum unless explicit_checksum.eql?(sha256_short)
     end
 
-    def add_eref(refname, extrefs)
-      eref[refname] = extrefs.strip.split(/\s*,\s*/)
+    def add_eref(ref, extrefs)
+      eref[ref] = extrefs.strip.split(/\s*,\s*/)
     end
 
     def add_iref(ref)

data/lib/defmastership/document.rb

@@ -23,22 +23,18 @@ module DefMastership
       definition = Definition.new(matching_line.match)
       labels.merge(definition.labels)
       definitions << definition
-      matching_line.line
     },
     add_line: lambda { |matching_line|
       line = matching_line.line
       definitions.last << line
-      line
     },
     new_eref_setup: lambda { |matching_line|
-      refname = matching_line[:refname].to_sym
-      eref[refname] ||= {}
-      eref[refname][matching_line[:symb].to_sym] = matching_line[:value]
-      matching_line.line
+      reference = matching_line[:reference].to_sym
+      eref[reference] ||= {}
+      eref[reference][matching_line[:symb].to_sym] = matching_line[:value]
     },
     new_eref_def: lambda { |matching_line|
-      definitions.last.add_eref(matching_line[:refname].to_sym, matching_line[:extrefs])
-      matching_line.line
+      definitions.last.add_eref(matching_line[:reference].to_sym, matching_line[:extrefs])
     },
     new_iref_def: lambda { |matching_line|
       self.iref = true
@@ -46,19 +42,15 @@ module DefMastership
       line.scan(DMRegexp::IREF_DEF) do |_|
         definitions.last.add_iref(Regexp.last_match[:intref])
       end
-      line
     },
     new_attribute_conf: lambda { |matching_line|
       attributes[matching_line[:attr].to_sym] = matching_line[:prefix]
-      matching_line.line
     },
     new_attribute_value: lambda { |matching_line|
       definitions.last.set_attribute(matching_line[:attr].to_sym, matching_line[:value])
-      matching_line.line
     },
     new_variable_def: lambda { |matching_line|
       variables[matching_line[:varname].to_sym] = matching_line[:value]
-      matching_line.line
     },
     new_variable_use: lambda { |matching_line|
       line = matching_line.line
@@ -125,8 +117,8 @@ module DefMastership
       PARSER_ACTIONS.key?(method_name)
     end
 
-    def ref_to_def(ref)
-      definitions.find { |definition| definition.reference == ref }
+    def ref_to_def(reference)
+      definitions.find { |definition| definition.reference == reference }
     end
 
     def iref=(value)

data/lib/defmastership/update_def_modifier.rb

@@ -33,7 +33,7 @@ module DefMastership
         document.parse_file_with_preprocessor(adoc_file)
       end
 
-      super(adoc_sources)
+      super
     end
 
     def replace_reference(line)