defmastership 1.0.18 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995e93909012fff3a4dcbeb55605d6e8754e24c3868f63d3000ed1c6674809c7
-  data.tar.gz: 94ae5225d555eb837017ebe243a69bfec21feb0882d14a3329b48f2b016c1ba2
+  metadata.gz: 6075e9ff9eb3bb1d4080344f8288946ed3ae008c0ef7c943e558417ac1922084
+  data.tar.gz: 2707d0ef2c7ac04eb6fb5ff07362584243c3f8d7661a9e7f617d8239b79d162d
 SHA512:
-  metadata.gz: 48169bb5cfc6bea00209d60619cace40a45471e2ff6c2b2543cd8846ca001daac2e6a865c18cf20b95ed5e6102b36328302d91b577a69952acf7e3bc0d79c209
-  data.tar.gz: 00265e2ed2fc50f527ffba937dd2dae5d3d9f2189c2ada4b451f2504dbfdb96efffa73e1b8e18981055ea43c45458bc9df93479630ec014f2e9ec7b8bafd5cc5
+  metadata.gz: 6670fef12836200db63e7bff8eec4afd5dad49e53a1d873b84816572933ca7fee2364076691f4e55d7858e3a49398b34d601f1c1ba6a7f05b9a8628b393acc03
+  data.tar.gz: e0169b605d73381d402c932cdd6387cb06cca5287364735c4a95c5fe5087845a24b4bc62018a87676510520db5ea6d656b4e1a9cb2e8586b772f6c0deae7f87f

data/.gitignore

@@ -1,3 +1,4 @@
+*~
 /*_results.html
 /tmp
 /coverage

data/.gitlab-ci.yml

@@ -1,11 +1,13 @@
 default:
-  image: ruby:3.2
+  image: ruby:3.3
   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"
+    - git config --global user.name "Your Name"
 
 bdd:
   script:
@@ -27,6 +29,8 @@ bdd ruby2.7:
     - 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
 
@@ -40,6 +44,11 @@ bdd ruby3.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:
@@ -61,3 +70,8 @@ unit tests ruby3.1:
   script:
     - bundle exec rake test:spec
 
+unit tests ruby3.2:
+  image: ruby:3.2
+  script:
+    - bundle exec rake test:spec
+

data/Gemfile

@@ -7,11 +7,28 @@ gemspec
 
 ruby RUBY_VERSION
 
+# rubocop:disable Metrics/BlockLength
 group :development do
   # cucumber steps for command line tests
   gem 'aruba',                 '~> 2.2'
   # bdd
-  gem 'cucumber',              '~> 9.1'
+  gem 'cucumber',              '~> 9.2'
+
+  # code duplication
+  gem 'flay',                  '~> 2'
+
+  # automatic test run
+  gem 'guard',                 '~> 2'
+  # automatic update invocation
+  gem 'guard-bundler',         '~> 3'
+  if RUBY_VERSION >= '3.0'
+    # automatic style check
+    gem 'guard-reek', '~> 1.2'
+  end
+  # automatic tdd
+  gem 'guard-rspec',           '~> 4'
+  # automatic style check
+  gem 'guard-rubocop',         '~> 1'
 
   if RUBY_VERSION >= '3.0'
     # mutation testing
@@ -24,7 +41,6 @@ group :development do
     # mutation testing
     gem 'mutant-rspec', '~> 0.11'
   end
-
   # to parse and execute Rakefile
   gem 'rake',                  '~> 13.1'
   # tdd
@@ -32,24 +48,28 @@ group :development do
   # # to test performances
   # gem 'rspec-benchmark',       '~> 0.6.0'
   # code needs to be clean
-  gem 'rubocop',               '~> 1.62.0'
+  gem 'rubocop',               '~> 1.65'
   # code needs to be clean
-  gem 'rubocop-performance',   '~> 1.20.0'
+  gem 'rubocop-performance',   '~> 1.21'
   # test code needs to be clean
-  gem 'rubocop-rspec',         '~> 2.27.0'
-  # Rakefiels need to be clean
+  gem 'rubocop-rspec',         '~> 3.0'
+  # Rakefiles need to be clean
   gem 'rubocop-rake',          '~> 0.6'
   if RUBY_VERSION >= '3.0'
     # detect selling code
     gem 'reek', '~> 6.3'
+    # my code needs to be critiqued
+    gem 'rubycritic', '~> 4'
   end
+
   # What is tdd without code coverage ?
   gem 'simplecov', '~> 0.22', '< 0.23'
   # # to document code
   # gem 'yard',                  '~> 0.9.5'
 end
+# rubocop:enable Metrics/BlockLength
 
 group :debugging do
   # Sometimes, we need to debug
-  gem 'pry', '~> 0.14.0'
+  gem 'pry', '~> 0.14'
 end

data/Guardfile

@@ -0,0 +1,44 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# notifications :emacs
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec --options config/rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+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
+  watch(/.+\.rb$/)
+  watch('config/reek.yml')
+end

data/config/cucumber.yml

@@ -0,0 +1,3 @@
+---
+default: features --publish-quiet --format html -o features_results.html --format progress -x
+wip: features --publish-quiet --format pretty -x -s --tags '@wip and not @pending'

data/config/mutant.yml

@@ -1,8 +1,12 @@
 ---
+usage: opensource
 includes:
   - lib
 integration:
   name: rspec
+  arguments:
+    - --options=config/rspec
+    - spec
 requires:
   - defmastership
 matcher:

data/config/reek.yml

@@ -1,106 +1,130 @@
 ---
-detectors:
-  Attribute:
-    enabled: false
-    exclude: []
-  BooleanParameter:
-    enabled: true
-    exclude: []
-  ClassVariable:
-    enabled: true
-    exclude: []
-  ControlParameter:
-    enabled: true
-    exclude: []
-  DataClump:
-    enabled: true
-    exclude: []
-    max_copies: 0
-    min_clump_size: 2
-  DuplicateMethodCall:
-    enabled: true
-    exclude: []
-    max_calls: 1
-    allow_calls: []
-  FeatureEnvy:
-    enabled: true
-    exclude: []
-  IrresponsibleModule:
-    enabled: true
-    exclude: []
-  LongParameterList:
-    enabled: true
-    exclude:
-    - Devtools::Config#self.attribute
-    max_params: 2
-    overrides: {}
-  LongYieldList:
-    enabled: true
-    exclude: []
-    max_params: 0
-  NestedIterators:
-    enabled: true
-    exclude: []
-    max_allowed_nesting: 1
-    ignore_iterators: []
-  NilCheck:
-    enabled: true
-    exclude: []
-  RepeatedConditional:
-    enabled: true
-    exclude: []
-    max_ifs: 1
-  TooManyConstants:
-    enabled: true
-    exclude:
-    - Devtools
-  TooManyInstanceVariables:
-    enabled: true
-    exclude: []
-    max_instance_variables: 2
-  TooManyMethods:
-    enabled: true
-    exclude: []
-    max_methods: 15
-  TooManyStatements:
-    enabled: true
-    exclude: []
-    max_statements: 5
-  UncommunicativeMethodName:
-    enabled: true
-    exclude: []
-    reject:
-    - '/^[a-z]$/'
-    - '/[0-9]$/'
-    - '/[A-Z]/'
-    accept: []
-  UncommunicativeModuleName:
-    enabled: true
-    exclude: []
-    reject:
-    - '/^.$/'
-    - '/[0-9]$/'
-    accept: []
-  UncommunicativeParameterName:
-    enabled: true
-    exclude: []
-    reject:
-    - '/^.$/'
-    - '/[0-9]$/'
-    - '/[A-Z]/'
-    accept: []
-  UncommunicativeVariableName:
-    enabled: true
-    exclude: []
-    reject:
-    - '/^.$/'
-    - '/[0-9]$/'
-    - '/[A-Z]/'
-    accept: []
-  UnusedParameters:
-    enabled: true
-    exclude: []
-  UtilityFunction:
-    enabled: true
-    exclude:
-    - Devtools::Project::Initializer::Rspec#require_files # intentional for deduplication
+# detectors:
+#   Attribute:
+#     enabled: true
+#     exclude: []
+#   BooleanParameter:
+#     enabled: true
+#     exclude: []
+#   ClassVariable:
+#     enabled: true
+#     exclude: []
+#   ControlParameter:
+#     enabled: true
+#     exclude: []
+#   DataClump:
+#     enabled: true
+#     exclude: []
+#     max_copies: 2
+#     min_clump_size: 2
+#   DuplicateMethodCall:
+#     enabled: true
+#     exclude: []
+#     max_calls: 1
+#     allow_calls: []
+#   FeatureEnvy:
+#     enabled: true
+#     exclude: []
+#   InstanceVariableAssumption:
+#     enabled: true
+#     exclude: []
+#   IrresponsibleModule:
+#     enabled: true
+#     exclude: []
+#   LongParameterList:
+#     enabled: true
+#     exclude: []
+#     max_params: 3
+#     overrides:
+#       initialize:
+#         max_params: 5
+#   LongYieldList:
+#     enabled: true
+#     exclude: []
+#     max_params: 3
+#   ManualDispatch:
+#     enabled: true
+#     exclude: []
+#   MissingSafeMethod:
+#     enabled: true
+#     exclude: []
+#   ModuleInitialize:
+#     enabled: true
+#     exclude: []
+#   NestedIterators:
+#     enabled: true
+#     exclude: []
+#     max_allowed_nesting: 1
+#     ignore_iterators:
+#     - tap
+#     - Tempfile.create
+#   NilCheck:
+#     enabled: true
+#     exclude: []
+#   RepeatedConditional:
+#     enabled: true
+#     exclude: []
+#     max_ifs: 2
+#   SubclassedFromCoreClass:
+#     enabled: true
+#     exclude: []
+#   TooManyConstants:
+#     enabled: true
+#     exclude: []
+#     max_constants: 5
+#   TooManyInstanceVariables:
+#     enabled: true
+#     exclude: []
+#     max_instance_variables: 4
+#   TooManyMethods:
+#     enabled: true
+#     exclude: []
+#     max_methods: 15
+#   TooManyStatements:
+#     enabled: true
+#     exclude:
+#     - initialize
+#     max_statements: 5
+#   UncommunicativeMethodName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^[a-z]$/"
+#     - "/[0-9]$/"
+#     - "/[A-Z]/"
+#     accept: []
+#   UncommunicativeModuleName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^.$/"
+#     - "/[0-9]$/"
+#     accept: []
+#   UncommunicativeParameterName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^.$/"
+#     - "/[0-9]$/"
+#     - "/[A-Z]/"
+#     - "/^_/"
+#     accept: []
+#   UncommunicativeVariableName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^.$/"
+#     - "/[0-9]$/"
+#     - "/[A-Z]/"
+#     accept:
+#     - "/^_$/"
+#   UnusedParameters:
+#     enabled: true
+#     exclude: []
+#   UnusedPrivateMethod:
+#     enabled: false
+#     exclude: []
+#   UtilityFunction:
+#     enabled: true
+#     exclude: []
+#     public_methods_only: false

data/config/rubocop.yml

@@ -1,44 +1,88 @@
-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
 
 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/def_mastership/batch_modifier_spec.rb'
+    - 'spec/unit/def_mastership/update_def_checksum_modifier_spec.rb'
+    - 'spec/unit/def_mastership/update_def_modifier_spec.rb'
+    - 'spec/unit/def_mastership/update_def_version_modifier_spec.rb'
+
+Style/MissingElse:
+  EnforcedStyle: case
+
+Metrics/ModuleLength :
   Exclude:
-  # Ignore RSpec DSL
-    - spec/**/*
-  # Ignore gemspec DSL
+    - 'spec/**/*'
+
+Metrics/BlockLength :
+  Exclude:
+    - 'spec/**/*'
     - '*.gemspec'
 
-# Naming/FileName:
-#   Exclude:
-#     - Rakefile
+Security/Eval :
+  Exclude:
+    - 'Rakefile'
+
+Style/ConstantVisibility :
+  Exclude:
+     # there is one unique explicit constant visibility for all
+     # constants
+    - 'lib/defmastership/constants.rb'
+
+# 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

@@ -33,7 +33,9 @@ Gem::Specification.new do |spec|
   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('git', '~> 1')
+  spec.add_dependency('gli', '~> 2')
 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:
     """
     ---