defmastership 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48dcfc9355927a24217b26f811929da3faa225f85429ad6c09502acb1a8d9330
-  data.tar.gz: b18de20de3320444e7a30b2d93a63194672c8ae3d5abc6eab25d39877151234d
+  metadata.gz: 7005c6bf64a1de44a7ac2f511070d4233ec8abde7816df47ceb1219c77500732
+  data.tar.gz: 219352e005a6e87d02258caacc30ad537e3d644da8dc008b1d4b958e70f33fcc
 SHA512:
-  metadata.gz: 8d9432830f28f130973894adc2e7a973568338e6d418ea808257ef3bdac58dd81ae5ed2c6195db9a6045132d6ac0bceefd35329b7d5f52733d85b2bb0205b2d2
-  data.tar.gz: ffdcbfffb2a16e5eb79432da1ce89b4d6264866336b3b20196d03432f6026e283db369cf9f99e71abdb885cfbf1747fcd0db74586bd5aab38c667b25d46e954e
+  metadata.gz: 5a80ed40ddcf6300da7287b30e5e5c10bb4789aca80ef2c927a85056987c6831022e18e2459ac72633b408f05d3ab564292d96611c282f19e73d173534eadf91
+  data.tar.gz: 218bad889104732f8ba69f00b0313b7a8327ddffb7ea5bfd2e2fac66b4dd38ae37efacf7f0033be576b32924bececafa4582c02a7cf458bc9c81ed2474cbacbd

data/Gemfile

@@ -11,13 +11,13 @@ group :development do
   # cucumber steps for command line tests
   gem 'aruba',                 '~> 2.3'
   # bdd
-  gem 'cucumber',              '~> 10.0'
+  gem 'cucumber',              '~> 10.2'
   # code duplication
-  gem 'flay',                  '~> 2.13'
+  gem 'flay',                  '~> 2.14'
   # automatic test run
   gem 'guard',                 '~> 2.19'
   # automatic update invocation
-  gem 'guard-bundler',         '~> 3.0'
+  # gem 'guard-bundler',         '~> 3.0'
   # automatic style check
   gem 'guard-reek',            '~> 1.2'
   # automatic tdd
@@ -31,21 +31,21 @@ group :development do
   # detect selling code
   gem 'reek',                  '~> 6.5'
   # needed by yard to render documentation
-  gem 'rdoc',                  '~> 6.14'
+  gem 'rdoc',                  '~> 7.0'
   # tdd
   gem 'rspec',                 '~> 3.13'
   # code needs to be clean
-  gem 'rubocop',               '~> 1.77'
+  gem 'rubocop',               '~> 1.82'
   # code needs to be clean
-  gem 'rubocop-performance',   '~> 1.25'
+  gem 'rubocop-performance',   '~> 1.26'
   # test code needs to be clean
-  gem 'rubocop-rspec',         '~> 3.6'
+  gem 'rubocop-rspec',         '~> 3.8'
   # Rakefiles need to be clean
   gem 'rubocop-rake',          '~> 0.7'
   # Doc need to be clean
-  gem 'rubocop-yard',          '~> 0.10'
+  gem 'rubocop-yard',          '~> 1.0'
   # my code needs to be critiqued
-  gem 'rubycritic',            '~> 4.9'
+  gem 'rubycritic',            '~> 4.11'
   # What is tdd without code coverage ?
   gem 'simplecov',             '~> 0.22'
   # to document code

data/Guardfile

@@ -30,15 +30,12 @@ guard :rspec, cmd: 'bundle exec rspec --options config/rspec' do
   dsl.watch_spec_files_for(ruby.lib_files)
 end
 
-guard :rubocop,
-      all_on_start: true,
-      cli: ['--display-cop-names', '--config=config/rubocop.yml'] do
+guard :rubocop, all_on_start: true, cli: ['--display-cop-names', '--config=config/rubocop.yml'] do
   watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m.first) }
 end
 
-guard :reek,
-      cli: ['--config config/reek.yml', '--single-line'] do
+guard :reek, cli: ['--config config/reek.yml', '--single-line'] do
   watch(/.+\.rb$/)
   watch('config/reek.yml')
 end

data/Rakefile

@@ -10,7 +10,7 @@ task :ci do
   [
     'test:spec',
     'test:features',
-    :rubocop
+    'quality:all'
   ].each do |name|
     puts "\n=== Running #{name}...\n"
     Rake::Task[name].invoke

data/config/mutant.yml

@@ -1,6 +1,5 @@
 ---
 usage: opensource
-# fail_fast: true
 includes:
 - lib
 integration:
@@ -8,6 +7,8 @@ integration:
   arguments:
   - --options=config/rspec
   - spec
+environment_variables:
+  CODE_COVERAGE_IN_RSPEC: disabled
 requires:
 - defmastership/batch_modifier
 - defmastership/comment_filter

data/config/rubocop.yml

@@ -27,21 +27,25 @@ Style/Copyright:
   Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
   AutocorrectNotice: '# Copyright (c) 2023 Jerome Arbez-Gindre'
 
-Lint/ConstantResolution: # Not available ins rubocop 0.81
+Lint/ConstantResolution:
   Enabled: false
 
 Style/DocumentationMethod:
-  Enabled: false
+  Enabled: true
 
 Style/StringHashKeys :
   Enabled: true
   Exclude:
     - '*.gemspec'
-    - 'spec/unit/defmastership/app_spec.rb'
-    - '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'
+    - spec/unit/defmastership/app_spec.rb
+    - 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
+    - spec/unit/defmastership/modifier/update_eref_checksum_spec.rb
+    - spec/unit/defmastership/modifier/update_eref_version_spec.rb
+    - spec/unit/defmastership/modifier/update_iref_checksum_spec.rb
+    - spec/unit/defmastership/modifier/update_iref_version_spec.rb
 
 Style/MissingElse:
   EnforcedStyle: case
@@ -72,8 +76,16 @@ RSpec/SpecFilePathSuffix :
 RSpec/NestedGroups:
   Max: 4
 
+RSpec/AnyInstance:
+  Enabled: true
+  Exclude:
+    - spec/unit/defmastership/modifier/update_eref_checksum_spec.rb
+    - spec/unit/defmastership/modifier/update_eref_version_spec.rb
+    - spec/unit/defmastership/modifier/update_iref_checksum_spec.rb
+    - spec/unit/defmastership/modifier/update_iref_version_spec.rb
+
 Layout/RedundantLineBreak:
-  Enabled: false
+  Enabled: true
 
 Style/DisableCopsWithinSourceCodeDirective:
   Enabled: true

data/defmastership.gemspec

@@ -3,21 +3,10 @@
 
 # Ensure we require the local version and not one we might have
 # installed already
-require(
-  File.join(
-    [
-      File.dirname(__FILE__),
-      'lib',
-      'defmastership',
-      'version.rb'
-    ]
-  )
-)
+require(File.join([File.dirname(__FILE__), 'lib', 'defmastership', 'version.rb']))
 
 Gem::Specification.new do |spec|
-  spec.metadata = {
-    'rubygems_mfa_required' => 'true'
-  }
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
   spec.required_ruby_version = '>= 3.0'
   spec.name = 'defmastership'
   spec.version = Defmastership::VERSION
@@ -34,9 +23,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency('aasm', '~> 5.5')
   spec.add_dependency('asciidoctor', '~> 2.0')
   spec.add_dependency('csv', '~> 3.3')
-  spec.add_dependency('defmastership-core', '~> 1.5')
+  spec.add_dependency('defmastership-core', '~> 1.5.5')
   spec.add_dependency('facets', '~> 3.1')
-  spec.add_dependency('git', '~> 3.1')
+  spec.add_dependency('git', '~> 4.0')
   spec.add_dependency('gli', '~> 2.22')
+  spec.add_dependency('memoist', '~> 0.16')
   spec.add_dependency('ostruct', '~> 0.6')
+  spec.add_dependency('rubyXL', '~> 3.4')
 end

data/features/changeref.feature

@@ -348,6 +348,36 @@ Feature: The changeref command
       | // tag::TOTO-TEMP-XXX1[]  Whatever | // tag::TOTO-0123[]  Whatever |
       | /* end::TOTO-TEMP-XXX1[] */        | /* end::TOTO-0123[] */        |
 
+  Scenario: Change definitions in subfolders, modify tags in included files
+    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 directory named "any_path"
+    And a file named "any_path/thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    include::target[TOTO-TEMP-XXX1 ]
+    --
+    """
+    And a file named "any_path/target" with:
+    """
+    # tag::TOTO-TEMP-XXX1[]
+    """
+    When I successfully run `defmastership modify --modifications toto any_path/thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file named "any_path/target" should contain:
+    """
+    # tag::TOTO-0123[]
+    """
+
   Scenario: Do not change definitions when in literal
     Given a file named "modifications.yml" with:
     """
@@ -383,3 +413,81 @@ Feature: The changeref command
     [define, requirement, TOTO-TEMP-XXX1]
     ....
     """
+
+  Scenario: Change a definition if the definitions's type fits with one value
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :def_type: requirement
+        :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]
+    [define, no_fit, TOTO-TEMP-XXX2]
+    """
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "modifications.yml" should contain:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :def_type: requirement
+        :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]
+    [define, no_fit, TOTO-TEMP-XXX2]
+    """
+
+  Scenario: Change a definition if the definitions's type fits with a liste of values
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :def_type:
+        - requirement
+        - pouet
+        :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]
+    [define, not_included, TOTO-TEMP-XXX2]
+    [define, pouet, TOTO-TEMP-XXX3]
+    """
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "modifications.yml" should contain:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :def_type:
+        - requirement
+        - pouet
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 125
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    [define, not_included, TOTO-TEMP-XXX2]
+    [define, pouet, TOTO-0124]
+    """

data/features/definition_checksum.feature

@@ -372,3 +372,121 @@ Feature: definition checksum
     the requirement value.
     --
     """
+
+  Scenario: Checksum update with not set def_type
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP]
+    --
+    the requirement value.
+    --
+
+    [define, whatever, TUTU-TEMP]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP(~244eed18)]
+    --
+    the requirement value.
+    --
+
+    [define, whatever, TUTU-TEMP(~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum update with def_type set to all
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: all
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP]
+    --
+    the requirement value.
+    --
+
+    [define, whatever, TUTU-TEMP]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP(~244eed18)]
+    --
+    the requirement value.
+    --
+
+    [define, whatever, TUTU-TEMP(~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum update with def_type set to a list
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type:
+        - requirement
+        - pouet
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP]
+    --
+    the requirement value.
+    --
+
+    [define, pouet, TITI-TEMP]
+    --
+    the requirement value.
+    --
+
+    [define, whatever, TUTU-TEMP]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP(~244eed18)]
+    --
+    the requirement value.
+    --
+
+    [define, pouet, TITI-TEMP(~244eed18)]
+    --
+    the requirement value.
+    --
+
+    [define, whatever, TUTU-TEMP]
+    --
+    the requirement value.
+    --
+    """

data/features/definition_version.feature

@@ -435,3 +435,171 @@ Feature: definitions version
     --
     """
 
+  Scenario: Version update with not set def_type
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement: initial text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: initial text.
+    --
+
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement: modified text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :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
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    Requirement: modified text.
+    --
+
+    [define, whatever, TOTO-0002(a)]
+    --
+    Whatever: modified text.
+    --
+    """
+
+  Scenario: Version update with not set to all
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement: initial text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: initial text.
+    --
+
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement: modified text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: all
+        :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
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    Requirement: modified text.
+    --
+
+    [define, whatever, TOTO-0002(a)]
+    --
+    Whatever: modified text.
+    --
+    """
+
+  Scenario: Version update with not set to a list
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement: initial text.
+    --
+
+    [define, pouet, TOTO-0003]
+    --
+    Pouet: initial text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: initial text.
+    --
+
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement: modified text.
+    --
+
+    [define, pouet, TOTO-0003]
+    --
+    Pouet: modified text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type:
+        - requirement
+        - pouet
+        :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
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    Requirement: modified text.
+    --
+
+    [define, pouet, TOTO-0003(a)]
+    --
+    Pouet: modified text.
+    --
+
+    [define, whatever, TOTO-0002]
+    --
+    Whatever: modified text.
+    --
+    """