defmastership 1.0.18 → 1.1.0

data/config/rubocop.yml

@@ -1,44 +1,83 @@
-inherit_from: ../.rubocop.yml
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
 
 require:
+  - rubocop-performance
   - rubocop-rspec
+  - rubocop-rake
+  - rubocop-yard
 
 AllCops:
-  TargetRubyVersion: 2.5.0
+  TargetRubyVersion: 2.7
+  EnabledByDefault: true
+  DisplayCopNames: true
 
-Metrics/BlockLength:
+Style/Copyright:
+  Enabled: true
+  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
+  AutocorrectNotice: '# Copyright (c) 2023 Jerome Arbez-Gindre'
+
+Lint/ConstantResolution: # Not available ins rubocop 0.81
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/StringHashKeys :
+  Enabled: true
+  Exclude:
+    - '*.gemspec'
+    - 'spec/unit/defmastership/batch_modifier_spec.rb'
+    - 'spec/unit/defmastership/modifier/update_def_checksum_spec.rb'
+    - 'spec/unit/defmastership/modifier/update_def_spec.rb'
+    - 'spec/unit/defmastership/modifier/update_def_version_spec.rb'
+
+Style/MissingElse:
+  EnforcedStyle: case
+
+Metrics/ModuleLength :
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength :
   Exclude:
-  # Ignore RSpec DSL
-    - spec/**/*
-  # Ignore gemspec DSL
+    - 'spec/**/*'
     - '*.gemspec'
 
-# Naming/FileName:
-#   Exclude:
-#     - Rakefile
+Security/Eval :
+  Exclude:
+    - 'Rakefile'
+
+# rubocop-rspec options
+RSpec/MessageExpectation :
+  Enabled: true
+
+RSpec/SpecFilePathFormat :
+  Enabled: true
 
-# Avoid more than `Max` levels of nesting.
-BlockNesting:
-  Max: 3
+RSpec/SpecFilePathSuffix :
+  Enabled: true
 
-# Align with the style guide.
-CollectionMethods:
-  PreferredMethods:
-    collect:  'map'
-    inject:   'reduce'
-    find:     'detect'
-    find_all: 'sélect'
+RSpec/NestedGroups:
+  Max: 4
 
-# Prefer #kind_of? over #is_a?
-ClassCheck:
-  EnforcedStyle: kind_of?
+Layout/RedundantLineBreak:
+  Enabled: false
 
-Security/Eval:
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: true
   Exclude:
-    - Rakefile
+    - 'Gemfile'
+    - 'tasks/code_quality.rake'
 
-AlignHash:
-  EnforcedColonStyle: table
+Layout/EndOfLine:
+  EnforcedStyle: lf
 
-MessageSpies:
-  EnforcedStyle: receive

data/defmastership.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   }
   spec.required_ruby_version = '>= 2.7'
   spec.name = 'defmastership'
-  spec.version = DefMastership::VERSION
+  spec.version = Defmastership::VERSION
   spec.author = 'Jérôme Arbez-Gindre'
   spec.email = 'jeromearbezgindre@gmail.com'
   spec.licenses = ['MIT']
@@ -29,11 +29,13 @@ Gem::Specification.new do |spec|
   spec.summary = 'Handling of references and definitions with asciidoctor'
   spec.files = `git ls-files`.split("\n")
   spec.require_paths << 'lib'
-  spec.extra_rdoc_files = ['README.rdoc', 'defmastership.rdoc']
-  spec.rdoc_options << '--title defmastership' << '--main README.rdoc' << '-ri'
   spec.bindir = 'bin'
   spec.executables << 'defmastership'
-  spec.add_runtime_dependency('aasm', '~> 5')
-  spec.add_runtime_dependency('asciidoctor', '~> 2')
-  spec.add_runtime_dependency('gli', '~> 2')
+  spec.add_dependency('aasm', '~> 5')
+  spec.add_dependency('asciidoctor', '~> 2')
+  spec.add_dependency('csv', '~> 3')
+  spec.add_dependency('defmastership-core', '>= 1.1.0')
+  spec.add_dependency('git', '~> 1')
+  spec.add_dependency('gli', '~> 2')
+  spec.add_dependency('ostruct', '~> 0')
 end

data/features/changeref.feature

@@ -20,7 +20,6 @@ Feature: The changeref command
     """
     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:
     """
     ---
@@ -53,7 +52,6 @@ Feature: The changeref command
     """
     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:
     """
     ---
@@ -87,7 +85,6 @@ Feature: The changeref command
     """
     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:
     """
     ---
@@ -122,7 +119,6 @@ Feature: The changeref command
     """
     When I successfully run `defmastership modify --modifications tata_or_titi thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "modifications.yml" should contain:
     """
     ---
@@ -160,7 +156,6 @@ Feature: The changeref command
     """
     When I successfully run `defmastership modify --modifications toto thedoc.adoc thedoc2.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "modifications.yml" should contain:
     """
     ---
@@ -200,7 +195,6 @@ Feature: The changeref command
     """
     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 "thedoc.adoc" should contain:
     """
     [define, requirement, TOTO-0123]
@@ -232,7 +226,6 @@ Feature: The changeref command
     """
     When I successfully run `defmastership modify --modifications toto thedoc.adoc thedoc2.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-0123]
@@ -263,7 +256,6 @@ Feature: The changeref command
     """
     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:
     """
     ---

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:
     """
     ---