defmastership 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0108caf9fe5e03e882cd80fda5c2221698cc468ffb1153f4a1dbbfcfb0d3ca7
-  data.tar.gz: b8fe780478f0b8a060beddb40e9fb1eb105e634f60d92467845fc1d122d8bd62
+  metadata.gz: 53e14ee5a671db1f61203808a5136d16cf346cfd2880e5ff39ffa822b6131df7
+  data.tar.gz: f4235cec1338a38892901d804fba920cca1e907c1a622540ea5b6a3eead4a523
 SHA512:
-  metadata.gz: 6a4c2cf44ad08ddb72a5f83b58ca19de4049970b81fae449870cc376ab294887dd239a82f190a67821b7ecd493195a5287931024f1e85d0ea2cd61d4e5e20b45
-  data.tar.gz: 51a482a53c38481d2c494842962675948477ea245f7bc1a4d2c9c4d45c4bef38185670caad69d7ebc88d61ab44af2647bab396ddd6df817ea8d6ee0190dc9fc5
+  metadata.gz: 0fd2843e5cf8b1e432696fb8d58c01c7c36b51d8a6c9509907717f8a9eb794d7c93361a0b18a285e4747ec5a821c5e388669c963ab9463a74bc9b455b948e45a
+  data.tar.gz: 2604bc1ee99150a82210c993219d941e1a2ca1ce43c2b8dc4adba385b5d5f880751f410f2975a82875db6453e22e58ef5616a7705c5cc6105b16ed2c46a1fc13

data/.gitlab-ci.yml

@@ -1,9 +1,6 @@
 default:
-  image: ruby:3.3
+  image: ruby:3.4
   before_script:
-    - apt-get update
-    - ruby -v
-    - which ruby
     - gem install bundler --no-document
     - bundle install --jobs $(nproc) "${FLAGS[@]}"
     - git config --global user.email "you@example.com"
@@ -35,56 +32,22 @@ yard documentation:
     paths:
       - doc
 
-bdd ruby2.7:
-  image: ruby:2.7
-  before_script:
-    - apt-get update
-    - ruby -v
-    - which ruby
-    - gem install bundler -v 2.4.22 --no-document
-    - bundle install --jobs $(nproc) "${FLAGS[@]}"
-    - git config --global user.email "you@example.com"
-    - git config --global user.name "Your Name"
-  script:
-    - bundle exec rake test:features
-
-bdd ruby3.0:
-  image: ruby:3.0
-  script:
-    - bundle exec rake test:features
-
-bdd ruby3.1:
-  image: ruby:3.1
-  script:
-    - bundle exec rake test:features
-
 bdd ruby3.2:
   image: ruby:3.2
   script:
     - bundle exec rake test:features
 
-unit tests ruby2.7:
-  image: ruby:2.7
-  before_script:
-    - apt-get update
-    - ruby -v
-    - which ruby
-    - gem install bundler -v 2.4.22 --no-document
-    - bundle install --jobs $(nproc) "${FLAGS[@]}"
-  script:
-    - bundle exec rake test:spec
-
-unit tests ruby3.0:
-  image: ruby:3.0
+bdd ruby3.3:
+  image: ruby:3.3
   script:
-    - bundle exec rake test:spec
+    - bundle exec rake test:features
 
-unit tests ruby3.1:
-  image: ruby:3.1
+unit tests ruby3.2:
+  image: ruby:3.2
   script:
     - bundle exec rake test:spec
 
-unit tests ruby3.2:
+unit tests ruby3.3:
   image: ruby:3.2
   script:
     - bundle exec rake test:spec

data/Gemfile

@@ -7,80 +7,52 @@ gemspec
 
 ruby RUBY_VERSION
 
-# rubocop:disable Metrics/BlockLength
 group :development do
   # cucumber steps for command line tests
-  gem 'aruba',                 '~> 2'
+  gem 'aruba',                 '~> 2.3'
   # bdd
-  gem 'cucumber',              '~> 9'
-
+  gem 'cucumber',              '~> 10.0'
   # code duplication
-  gem 'flay',                  '~> 2'
-
+  gem 'flay',                  '~> 2.13'
   # automatic test run
-  gem 'guard',                 '~> 2'
+  gem 'guard',                 '~> 2.19'
   # automatic update invocation
-  gem 'guard-bundler',         '~> 3'
-  if RUBY_VERSION >= '3.0'
-    # automatic style check
-    gem 'guard-reek', '~> 1.2'
-  end
+  gem 'guard-bundler',         '~> 3.0'
+  # automatic style check
+  gem 'guard-reek',            '~> 1.2'
   # automatic tdd
-  gem 'guard-rspec',           '~> 4'
+  gem 'guard-rspec',           '~> 4.7'
   # automatic style check
-  gem 'guard-rubocop',         '~> 1'
-
-  if RUBY_VERSION >= '3.0'
-    # mutation testing
-    plan = 'oss'
-    key = '7oac4dMz95cTUuFPtGDfTDSQep6ZhdGW'
-    source "https://#{plan}:#{key}@gem.mutant.dev" do
-      # license needed
-      gem 'mutant-license', '~> 0'
-    end
-    # mutation testing
-    gem 'mutant-rspec', '~> 0'
-  end
+  gem 'guard-rubocop',         '~> 1.5'
+  # mutation testing
+  gem 'mutant-rspec',          '~> 0.13'
   # to parse and execute Rakefile
-  gem 'rake', '~> 13'
-
-  if RUBY_VERSION >= '3.0'
-    # needed by yard to render documentation
-    gem 'rdoc', '~> 6'
-  end
+  gem 'rake',                  '~> 13.3'
+  # detect selling code
+  gem 'reek',                  '~> 6.5'
+  # needed by yard to render documentation
+  gem 'rdoc',                  '~> 6.14'
   # tdd
-  gem 'rspec',                 '~> 3'
-  # # to test performances
-  # gem 'rspec-benchmark',       '~> 0'
+  gem 'rspec',                 '~> 3.13'
   # code needs to be clean
-  gem 'rubocop',               '1.68'
+  gem 'rubocop',               '~> 1.77'
   # code needs to be clean
-  gem 'rubocop-performance',   '~> 1'
+  gem 'rubocop-performance',   '~> 1.25'
   # test code needs to be clean
-  gem 'rubocop-rspec',         '~> 3'
+  gem 'rubocop-rspec',         '~> 3.6'
   # Rakefiles need to be clean
-  gem 'rubocop-rake',          '~> 0'
-
-  if RUBY_VERSION >= '3.0'
-    # detect selling code
-    gem 'reek', '~> 6'
-    # my code needs to be critiqued
-    gem 'rubycritic', '~> 4'
-    # Doc need to be clean
-    gem 'rubocop-yard', '~> 0'
-  end
-
+  gem 'rubocop-rake',          '~> 0.7'
+  # Doc need to be clean
+  gem 'rubocop-yard',          '~> 0.10'
+  # my code needs to be critiqued
+  gem 'rubycritic',            '~> 4.9'
   # What is tdd without code coverage ?
-  gem 'simplecov', '~> 0'
-
-  if RUBY_VERSION >= '3.0'
-    # to document code
-    gem 'yard', '~> 0'
-  end
+  gem 'simplecov',             '~> 0.22'
+  # to document code
+  gem 'yard',                  '~> 0.9'
 end
-# rubocop:enable Metrics/BlockLength
 
 group :debugging do
   # Sometimes, we need to debug
-  gem 'pry', '~> 0'
+  gem 'pry',                   '~> 0.15'
 end

data/bin/defmastership

@@ -2,114 +2,6 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('csv')
-require('defmastership')
-require('gli')
-
-module Defmastership
-  # The start of everything !
-  class App
-    extend GLI::App
-
-    program_desc 'Tool to handle Asciidoctor definition extension'
-
-    version Defmastership::VERSION
-
-    subcommand_option_handling :normal
-    arguments :strict
-
-    # desc 'Describe some switch here'
-    # switch [:s,:switch]
-
-    # desc 'Describe some flag here'
-    # default_value 'the default'
-    # arg_name 'The name of the argument'
-    # flag [:f,:flagname]
-
-    pre do |_global, _command, _options, _args|
-      # Pre logic here
-      # Return true to proceed; false to abort and not call the
-      # chosen command
-      # Use skips_pre before a command to skip this block
-      # on that command only
-      true
-    end
-
-    post do |_global, _command, _options, _args|
-      # Post logic here
-      # Use skips_post before a command to skip this
-      # block on that command only
-    end
-
-    on_error do |_exception|
-      # Error logic here
-      # return false to skip default error handling
-      true
-    end
-
-    desc 'Export the definition database in CSV'
-    arg_name 'asciidoctor_files'
-    command :export, :exp, :e do |c|
-      c.flag(%i[separator sep s], default_value: ',', desc: 'CSV separator')
-      c.switch(%i[no-fail], desc: 'Exit succes even in case of wrong explicit checksum')
-
-      c.action do |_global_options, options, args|
-        my_doc = Defmastership::Document.new
-        my_doc.parse_file_with_preprocessor(args.first)
-
-        output_file = args.first.sub(/\.adoc$/, '.csv')
-
-        Defmastership::Export::CSV::Formatter.new(my_doc, options['separator']).export_to(output_file)
-
-        if my_doc.wrong_explicit_checksum?
-          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_short})"
-            )
-          end
-          exit 1 unless options[:'no-fail']
-        end
-      end
-    end
-
-    desc 'Apply one or more modifications'
-    arg_name 'asciidoctor_files'
-    command :modify, :mod, :m do |c|
-      c.flag(
-        %i[modifications mod m],
-        must_match: /(?:[\w-]+)(?:,[\w-]+)*/,
-        default_value: 'all',
-        desc: 'comma separated list of modifications to apply'
-      )
-      c.flag(%i[modifications-file mf], default_value: 'modifications.yml', desc: 'modifications description file')
-      c.flag(%i[changes-summary s], default_value: 'changes.csv', desc: 'generates a change summary in a CSV file')
-
-      c.action do |_global_options, options, args|
-        changer = BatchModifier.new(
-          YAML.load_file(options[:'modifications-file']),
-          args.to_h { |afile| [afile, File.read(afile)] }
-        )
-
-        changer.apply(options[:modifications].split(/\s*,\s*/).map(&:to_sym))
-
-        changer.adoc_sources.each do |adoc_filename, adoc_text|
-          File.write(adoc_filename, adoc_text)
-        end
-
-        File.write(options[:'modifications-file'], changer.config.to_yaml)
-
-        unless options['changes-summary'].nil?
-          CSV.open(options['changes-summary'], 'wb') do |csv|
-            csv << %w[Modifier Was Becomes]
-            changer.changes.each { |row| csv << row }
-          end
-        end
-      end
-    end
-  end
-end
+require('defmastership/app')
 
 exit(Defmastership::App.run(ARGV))

data/config/mutant.yml

@@ -1,32 +1,37 @@
 ---
 usage: opensource
+# fail_fast: true
 includes:
-  - lib
+- lib
 integration:
   name: rspec
   arguments:
-    - --options=config/rspec
-    - spec
+  - --options=config/rspec
+  - spec
 requires:
-  - defmastership
+- defmastership/batch_modifier
+- defmastership/comment_filter
+- defmastership/config_preserver
+- defmastership/definition_parser
+- defmastership/definition
+- defmastership/document
+- defmastership/export/body_formatter
+- defmastership/export/csv/formatter
+- defmastership/export/header_formatter
+- defmastership/filters
+- defmastership/hash_merge_no_new
+- defmastership/matching_line
+- defmastership/modifier/change_ref
+- defmastership/modifier/factory
+- defmastership/modifier/modifier_common
+- defmastership/modifier/rename_included_files
+- defmastership/modifier/update_def_checksum
+- defmastership/modifier/update_def
+- defmastership/modifier/update_def_version
+mutation:
+  operators: full
 matcher:
   subjects:
-    - Defmastership*
+  - Defmastership*
   ignore:
-    - Defmastership::Core*
-  #   - Defmastership::BatchModifier*
-  #   - Defmastership::Export::CSV::Formatter*
-  #   - Defmastership::Export::CSV::BodyFormatter*
-  #   - Defmastership::Export::CSV::HeaderFormatter*
-  #   - Defmastership::Modifier::ChangeRef*
-  #   - Defmastership::Definition*
-  #   - Defmastership::DefinitionParser*
-  #   - Defmastership::Document*
-  #   - Defmastership::Factory*
-  #   - Defmastership::Modifier::ModifierCommon*
-  #   - Defmastership::Modifier::Factory*
-  #   - Defmastership::Modifier::RenameIncludedFiles*
-  #   - Defmastership::Modifier::UpdateDefChecksum*
-  #   - Defmastership::Modifier::UpdateDef*
-  #   - Defmastership::Modifier::UpdateDefVersion*
-# fail_fast: true
+  - Defmastership::Core*

data/config/rubocop.yml

@@ -9,14 +9,16 @@
 #
 # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
   - rubocop-rake
+
+require:
   - rubocop-yard
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   EnabledByDefault: true
   DisplayCopNames: true
 
@@ -35,6 +37,7 @@ 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'

data/defmastership.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'rubygems_mfa_required' => 'true'
   }
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
   spec.name = 'defmastership'
   spec.version = Defmastership::VERSION
   spec.author = 'Jérôme Arbez-Gindre'
@@ -31,11 +31,12 @@ Gem::Specification.new do |spec|
   spec.require_paths << 'lib'
   spec.bindir = 'bin'
   spec.executables << 'defmastership'
-  spec.add_dependency('aasm', '~> 5')
-  spec.add_dependency('asciidoctor', '~> 2')
-  spec.add_dependency('csv', '~> 3')
-  spec.add_dependency('defmastership-core', '~> 1.3.0')
-  spec.add_dependency('git', '~> 1')
-  spec.add_dependency('gli', '~> 2')
-  spec.add_dependency('ostruct', '~> 0')
+  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('facets', '~> 3.1')
+  spec.add_dependency('git', '~> 3.1')
+  spec.add_dependency('gli', '~> 2.22')
+  spec.add_dependency('ostruct', '~> 0.6')
 end

data/features/changeref.feature

@@ -3,7 +3,7 @@ Feature: The changeref command
   In order to make references reliable
   I want defmastership to change reference for asciidoctor documents
 
-  Scenario: Change a definition 
+  Scenario: Change a definition
     Given a file named "modifications.yml" with:
     """
     ---
@@ -35,6 +35,39 @@ Feature: The changeref command
     [define, requirement, TOTO-0123]
     """
 
+  Scenario: Preserve modification file
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    # the name of the modification
+    :toto:
+      :type: change_ref
+
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        # the next ref
+        :next_ref: 123      # will be incremented once this value is used
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    """
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    And the file "modifications.yml" should contain exactly:
+    """
+    ---
+    # the name of the modification
+    :toto:
+      :type: change_ref
+
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        # the next ref
+        :next_ref: 124      # will be incremented once this value is used
+    """
+
   Scenario: Change a definition with explicit checksum and version
     Given a file named "modifications.yml" with:
     """
@@ -237,6 +270,84 @@ Feature: The changeref command
     defs:iref[TOTO-0123]
     """
 
+  Scenario Outline: Change definitions, modify tags in include statements
+    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]
+    --
+    include::target[<initial options>]
+    --
+    """
+    And an empty file named "target"
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    --
+    include::target[<modified options>]
+    --
+    """
+
+    Examples:
+      | initial options                                     | modified options                               |
+      | tags=TOTO-TEMP-XXX1                                 | tags=TOTO-0123                                 |
+      | tag=TOTO-TEMP-XXX1                                  | tag=TOTO-0123                                  |
+      | tag=!TOTO-TEMP-XXX1                                 | tag=!TOTO-0123                                 |
+      | lines = "1..7,9", tag=TOTO-TEMP-XXX1, leveloffset=1 | lines = "1..7,9", tag=TOTO-0123, leveloffset=1 |
+      | lines=1..7;9, tag=TOTO-TEMP-XXX1                    | lines=1..7;9, tag=TOTO-0123                    |
+      | tag=!TOTO-TEMP-XXX2;TOTO-TEMP-XXX1                  | tag=!TOTO-TEMP-XXX2;TOTO-0123                  |
+      
+  Scenario Outline: Change definitions, 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 file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    include::target[TOTO-TEMP-XXX1 ]
+    --
+    """
+    And a file named "target" with:
+    """
+    <initial target comment>
+    """
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file named "target" should contain:
+    """
+    <modified target comment>
+    """
+
+    Examples:
+      | initial target comment             | modified target comment       |
+      | # tag::TOTO-TEMP-XXX1[]            | # tag::TOTO-0123[]            |
+      | # tags::TOTO-TEMP-XXX1[]           | # tags::TOTO-TEMP-XXX1[]      |
+      | # tag::TOTO-TEMP-XXX1              | # tag::TOTO-TEMP-XXX1         |
+      | # end::TOTO-TEMP-XXX1[]            | # end::TOTO-0123[]            |
+      | # tag::TOTO-TEMP-XXX2[]            | # tag::TOTO-TEMP-XXX2[]       |
+      | ; end::TOTO-TEMP-XXX1[]            | ; end::TOTO-0123[]            |
+      | // tag::TOTO-TEMP-XXX1[]  Whatever | // tag::TOTO-0123[]  Whatever |
+      | /* end::TOTO-TEMP-XXX1[] */        | /* end::TOTO-0123[] */        |
+
   Scenario: Do not change definitions when in literal
     Given a file named "modifications.yml" with:
     """

data/features/definition_version.feature

@@ -181,6 +181,46 @@ Feature: definitions version
     --
     """
 
+  Scenario: Preserve modification file
+    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`
+    Then the file "modifications.yml" should contain exactly:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_tag: THE_TAG
+    """
+
   Scenario: Update explicit version based on git tag on a different git repo
     And a file named "defmastership-example.adoc" with:
     """
@@ -243,7 +283,7 @@ Feature: definitions version
         :def_type: requirement
         :first_version: a
         :ref_document: ./ref_doc.adoc
-        :ref_tag: 'THE_TAG'
+        :ref_tag: THE_TAG
     """
     When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
     And the stdout should not contain anything

data/features/export.feature

@@ -211,6 +211,24 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
+  Scenario: Extract definition with summary including comma
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001, " A nice, summary " ]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Summary,Value,Checksum
+    requirement,TOTO-0001,"A nice, summary","Exemple of multiline requirement.
+    Second line.",~77a203d4
+    """
+    And the stdout should not contain anything
+
   Scenario: Extract definition with labels 
     Given a file named "toto.adoc" with:
     """

data/features/step_definitions/git_steps.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2024 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require 'git'
+require('git')
 
 Given('I initialize a git repo') do
   Git.init(Aruba.config.home_directory)