defmastership 1.0.17 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29225577d47450033d4ea2c9715ab51cb2025318ff26da38435c11900ff0cb52
-  data.tar.gz: a36cb1eb3b8c45cb14b74200d43163edd1907bcfe7ed2a54d15f4f1ebd341454
+  metadata.gz: 6075e9ff9eb3bb1d4080344f8288946ed3ae008c0ef7c943e558417ac1922084
+  data.tar.gz: 2707d0ef2c7ac04eb6fb5ff07362584243c3f8d7661a9e7f617d8239b79d162d
 SHA512:
-  metadata.gz: bb97db7204c4665f53c5f57e03737e31a88373a928ce4157f912938b84feff1b3b7f260365fa210bab905b47eb87c336e259e91d1a77d73ace80e84f8152d464
-  data.tar.gz: 4c359dbf1017c365d9c00faf7617233e3793093dba327d39982cebd7dabd68a7b5af0a999568c91775cd16a2a8af9cc544a67fdf3acedf92d65120269c372d18
+  metadata.gz: 6670fef12836200db63e7bff8eec4afd5dad49e53a1d873b84816572933ca7fee2364076691f4e55d7858e3a49398b34d601f1c1ba6a7f05b9a8628b393acc03
+  data.tar.gz: e0169b605d73381d402c932cdd6387cb06cca5287364735c4a95c5fe5087845a24b4bc62018a87676510520db5ea6d656b4e1a9cb2e8586b772f6c0deae7f87f

data/.gitignore

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

data/.gitlab-ci.yml

@@ -1,51 +1,77 @@
 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:
-    - bundle exec rake features
+    - bundle exec rake test:features
 
 unit tests:
   script:
-    - bundle exec rake spec
+    - bundle exec rake test:spec
 
-rubocop:
+code_quality:
   script:
-    - bundle exec rake rubocop
+    - bundle exec rake quality:all
 
 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 features
+    - bundle exec rake test:features
 
 bdd ruby3.0:
   image: ruby:3.0
   script:
-    - bundle exec rake features
+    - bundle exec rake test:features
 
 bdd ruby3.1:
   image: ruby:3.1
   script:
-    - bundle exec rake features
+    - 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 spec
+    - bundle exec rake test:spec
 
 unit tests ruby3.0:
   image: ruby:3.0
   script:
-    - bundle exec rake spec
+    - bundle exec rake test:spec
 
 unit tests ruby3.1:
   image: ruby:3.1
   script:
-    - bundle exec rake spec
+    - bundle exec rake test:spec
+
+unit tests ruby3.2:
+  image: ruby:3.2
+  script:
+    - bundle exec rake test:spec
 

data/Gemfile

@@ -1,5 +1,75 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-source('https://rubygems.org')
+source 'https://rubygems.org'
+
 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.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
+    plan = 'oss'
+    key = '7oac4dMz95cTUuFPtGDfTDSQep6ZhdGW'
+    source "https://#{plan}:#{key}@gem.mutant.dev" do
+      # license needed
+      gem 'mutant-license', '~> 0.1.1'
+    end
+    # mutation testing
+    gem 'mutant-rspec', '~> 0.11'
+  end
+  # to parse and execute Rakefile
+  gem 'rake',                  '~> 13.1'
+  # tdd
+  gem 'rspec',                 '~> 3.13'
+  # # to test performances
+  # gem 'rspec-benchmark',       '~> 0.6.0'
+  # code needs to be clean
+  gem 'rubocop',               '~> 1.65'
+  # code needs to be clean
+  gem 'rubocop-performance',   '~> 1.21'
+  # test code needs 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'
+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/Rakefile

@@ -1,67 +1,22 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
+# Copyright (c) 2023 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('cucumber')
-require('cucumber/rake/task')
-require('rake/clean')
-require('rdoc/task')
-require('rubygems')
-require('rubygems/package_task')
-
-Rake::RDocTask.new do |rd|
-  rd.main = 'README.rdoc'
-  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
-  rd.title = 'Your application title'
-end
-
-spec = eval(File.read('defmastership.gemspec'))
-
-Gem::PackageTask.new(spec)
-CUKE_RESULTS = 'features_results.html'
-CLEAN << CUKE_RESULTS
-
-desc('Run features')
-Cucumber::Rake::Task.new(:features) do |t|
-  opts = ['features'] +
-         ['--format', 'html'] +
-         ['-o', CUKE_RESULTS] +
-         ['--format', 'progress'] +
-         ['-x']
-  opts += ['--tags', ENV.fetch('TAGS').split.join(' or ')] if ENV['TAGS']
-  t.cucumber_opts = opts
-  t.fork = false
-end
-
-desc('Run features tagged as work-in-progress (@wip)')
-Cucumber::Rake::Task.new('features:wip') do |t|
-  t.cucumber_opts = ['features'] +
-                    ['--format', 'html'] +
-                    ['-o', CUKE_RESULTS] +
-                    ['--format', 'pretty'] +
-                    ['-x'] +
-                    ['-s'] +
-                    ['--tags', '@wip and not @pending']
-  t.fork = false
-end
-
-desc('Test all features')
-task(cucumber: :features)
-
-desc('Test only WIP features')
-task(wip: 'features:wip')
-
 require('bundler/gem_tasks')
+require('rake/clean')
 
-require('rspec/core/rake_task')
-
-RSpec::Core::RakeTask.new(:spec)
-
-require('rubocop/rake_task')
-
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-performance'
-  task.requires << 'rubocop-rspec'
-  task.requires << 'rubocop-rake'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+desc 'Continous integration tasks'
+task :ci do
+  [
+    'test:spec',
+    'test:features',
+    :rubocop
+  ].each do |name|
+    puts "\n=== Running #{name}...\n"
+    Rake::Task[name].invoke
+    puts "\n=== Running #{name} -> Done\n"
+  end
 end
 
-task(default: %i[rubocop spec features])
+task default: :ci

data/bin/defmastership

@@ -55,9 +55,9 @@ module DefMastership
 
       c.action do |_global_options, options, args|
         my_doc = DefMastership::Document.new
-        my_doc.parse_file_with_preprocessor(args[0])
+        my_doc.parse_file_with_preprocessor(args.first)
 
-        output_file = args[0].sub(/\.adoc$/, '.csv')
+        output_file = args.first.sub(/\.adoc$/, '.csv')
 
         DefMastership::CSVFormatter.new(my_doc, options['separator']).export_to(output_file)
 
@@ -65,7 +65,10 @@ module DefMastership
           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})")
+            warn(
+              "warning: #{definition.reference} has a wrong explicit " \
+              "checksum (should be #{definition.sha256_short})"
+            )
           end
           exit 1 unless options[:'no-fail']
         end
@@ -90,10 +93,10 @@ module DefMastership
           args.to_h { |afile| [afile, File.read(afile)] }
         )
 
-        changer.apply(options[:modifications])
+        changer.apply(options[:modifications].split(/\s*,\s*/).map(&:to_sym))
 
-        changer.adoc_texts.each do |adoc_file, adoc_text|
-          File.write(adoc_file, adoc_text)
+        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)

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,6 +1,30 @@
 ---
+usage: opensource
 includes:
-- lib
-integration: rspec
+  - lib
+integration:
+  name: rspec
+  arguments:
+    - --options=config/rspec
+    - spec
 requires:
-- devtools
+  - defmastership
+matcher:
+  subjects:
+    - 'DefMastership*'
+  # ignore:
+  #   - 'DefMastership::BatchModifier*'
+  #   - 'DefMastership::CSVFormatter*'
+  #   - 'DefMastership::CSVFormatterBody*'
+  #   - 'DefMastership::CSVFormatterHeader*'
+  #   - 'DefMastership::ChangeRefModifier*'
+  #   - 'DefMastership::Definition*'
+  #   - 'DefMastership::Document*'
+  #   - 'DefMastership::Modifier*'
+  #   - 'DefMastership::ModifierFactory*'
+  #   - 'DefMastership::ParsingState*'
+  #   - 'DefMastership::RenameIncludedFilesModifier*'
+  #   - 'DefMastership::UpdateDefChecksumModifier*'
+  #   - 'DefMastership::UpdateDefModifier*'
+  #   - 'DefMastership::UpdateDefVersionModifier*'
+# fail_fast: true

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