defmastership 1.0.18 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995e93909012fff3a4dcbeb55605d6e8754e24c3868f63d3000ed1c6674809c7
-  data.tar.gz: 94ae5225d555eb837017ebe243a69bfec21feb0882d14a3329b48f2b016c1ba2
+  metadata.gz: 57c8ecae1a1c2e304a23c513b3a65b6c112da30ccaf75fb7f137f9247e9db36c
+  data.tar.gz: 2730ff7b5ef8838d4a131f182099479935ab347f0505b3a5518e6561bc30eb8c
 SHA512:
-  metadata.gz: 48169bb5cfc6bea00209d60619cace40a45471e2ff6c2b2543cd8846ca001daac2e6a865c18cf20b95ed5e6102b36328302d91b577a69952acf7e3bc0d79c209
-  data.tar.gz: 00265e2ed2fc50f527ffba937dd2dae5d3d9f2189c2ada4b451f2504dbfdb96efffa73e1b8e18981055ea43c45458bc9df93479630ec014f2e9ec7b8bafd5cc5
+  metadata.gz: d4832d0e97edd679f51fe2223bf8eabe28c8e8e2dc14b9b994c055d24c31e14547b3db9fdb962abd843c86d9c370af1c3d3e662a52833260fc0b40b61f70ba7d
+  data.tar.gz: fdbfa9b7b031f10129cb5a7e12c9d3aee542ee86d1f56f406a3e05bd17297a20e99a8ec1ddf537bd61e2f128a0d6d764bdd47659d48e2c9e8166b603bc1ca6df

data/.gitignore

@@ -1,3 +1,4 @@
+*~
 /*_results.html
 /tmp
 /coverage
@@ -5,3 +6,6 @@ defmastership-0.0.1.gem
 /Gemfile.lock
 /pkg/
 /.ruby-version
+/doc/
+/.yardoc/
+/whatever

data/.gitlab-ci.yml

@@ -1,24 +1,40 @@
 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 test:features
+  artifacts:
+    paths:
+      - features_results.html
 
 unit tests:
   script:
     - bundle exec rake test:spec
+  artifacts:
+    paths:
+      - rspec_results.html
+      - coverage/*
 
 code_quality:
   script:
     - bundle exec rake quality:all
 
+yard documentation:
+  script:
+    - bundle exec rake yard
+  artifacts:
+    paths:
+      - doc
+
 bdd ruby2.7:
   image: ruby:2.7
   before_script:
@@ -27,6 +43,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 +58,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 +84,21 @@ unit tests ruby3.1:
   script:
     - bundle exec rake test:spec
 
+unit tests ruby3.2:
+  image: ruby:3.2
+  script:
+    - bundle exec rake test:spec
+
+pages:
+  stage: deploy
+  script:
+    - mkdir public
+    - cp -r doc/* public
+    - cp "features_results.html" public
+    - cp "rspec_results.html" public
+    - cp -r "coverage" public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

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'
+  gem 'aruba',                 '~> 2'
   # bdd
-  gem 'cucumber',              '~> 9.1'
+  gem 'cucumber',              '~> 9'
+
+  # 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
@@ -19,37 +36,51 @@ group :development do
     key = '7oac4dMz95cTUuFPtGDfTDSQep6ZhdGW'
     source "https://#{plan}:#{key}@gem.mutant.dev" do
       # license needed
-      gem 'mutant-license', '~> 0.1.1'
+      gem 'mutant-license', '~> 0'
     end
     # mutation testing
-    gem 'mutant-rspec', '~> 0.11'
+    gem 'mutant-rspec', '~> 0'
   end
-
   # to parse and execute Rakefile
-  gem 'rake',                  '~> 13.1'
+  gem 'rake', '~> 13'
+
+  if RUBY_VERSION >= '3.0'
+    # needed by yard to render documentation
+    gem 'rdoc', '~> 6'
+  end
   # tdd
-  gem 'rspec',                 '~> 3.13'
+  gem 'rspec',                 '~> 3'
   # # to test performances
-  # gem 'rspec-benchmark',       '~> 0.6.0'
+  # gem 'rspec-benchmark',       '~> 0'
   # code needs to be clean
-  gem 'rubocop',               '~> 1.62.0'
+  gem 'rubocop',               '1.68'
   # code needs to be clean
-  gem 'rubocop-performance',   '~> 1.20.0'
+  gem 'rubocop-performance',   '~> 1'
   # test code needs to be clean
-  gem 'rubocop-rspec',         '~> 2.27.0'
-  # Rakefiels need to be clean
-  gem 'rubocop-rake',          '~> 0.6'
+  gem 'rubocop-rspec',         '~> 3'
+  # Rakefiles need to be clean
+  gem 'rubocop-rake',          '~> 0'
+
   if RUBY_VERSION >= '3.0'
     # detect selling code
-    gem 'reek', '~> 6.3'
+    gem 'reek', '~> 6'
+    # my code needs to be critiqued
+    gem 'rubycritic', '~> 4'
+    # Doc need to be clean
+    gem 'rubocop-yard', '~> 0'
   end
+
   # What is tdd without code coverage ?
-  gem 'simplecov', '~> 0.22', '< 0.23'
-  # # to document code
-  # gem 'yard',                  '~> 0.9.5'
+  gem 'simplecov', '~> 0'
+
+  if RUBY_VERSION >= '3.0'
+    # to document code
+    gem 'yard', '~> 0'
+  end
 end
+# rubocop:enable Metrics/BlockLength
 
 group :debugging do
   # Sometimes, we need to debug
-  gem 'pry', '~> 0.14.0'
+  gem 'pry', '~> 0'
 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/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2020 Jérôme Arbez-Gindre, and the individual contributors
-to DefMastership.
+to Defmastership.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.adoc

@@ -0,0 +1,24 @@
+= defmastership
+
+== Features
+
+* CSV export of https://gitlab.com/defmastership/asciidoctor-defmastership[asciidoctor-defmastership] statements.
+* Automatic modifications of asciidoc files for : (See https://defmastership.gitlab.io/defmastership-example/defmastership-example.pdf/#_automatic_modifications[list of modifications].)
+** Computation of definitions reference ids
+** Explicit checksums updates
+** Explicit version updates (note: defmastership-examples not updated with last feature modification)
+
+NOTE: depend on https://gitlab.com/defmastership/defmastership-core[defmastership-core]
+
+== Development method
+
+* BDD:
+** https://gitlab.com/defmastership/defmastership/-/tree/master/features[features].
+** https://defmastership.gitlab.io/defmastership/features_results.html[features_results.html]
+
+* TDD:
+** https://gitlab.com/defmastership/defmastership/-/tree/master/spec/unit/defmastership?ref_type=heads[unit tests (rspec)]
+** https://defmastership.gitlab.io/defmastership/rspec_results.html[rspec_results.html]
+** https://defmastership.gitlab.io/defmastership/coverage[Unit tests coverage]
+
+

data/Rakefile

@@ -1,7 +1,6 @@
 # Copyright (c) 2023 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('bundler/gem_tasks')
 require('rake/clean')
 
 Dir['tasks/**/*.rake'].each { |t| load t }

data/bin/defmastership

@@ -6,14 +6,14 @@ require('csv')
 require('defmastership')
 require('gli')
 
-module DefMastership
+module Defmastership
   # The start of everything !
   class App
     extend GLI::App
 
     program_desc 'Tool to handle Asciidoctor definition extension'
 
-    version DefMastership::VERSION
+    version Defmastership::VERSION
 
     subcommand_option_handling :normal
     arguments :strict
@@ -54,12 +54,12 @@ module DefMastership
       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 = Defmastership::Document.new
         my_doc.parse_file_with_preprocessor(args.first)
 
         output_file = args.first.sub(/\.adoc$/, '.csv')
 
-        DefMastership::CSVFormatter.new(my_doc, options['separator']).export_to(output_file)
+        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|
@@ -112,4 +112,4 @@ module DefMastership
   end
 end
 
-exit(DefMastership::App.run(ARGV))
+exit(Defmastership::App.run(ARGV))

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,26 +1,32 @@
 ---
+usage: opensource
 includes:
   - lib
 integration:
   name: rspec
+  arguments:
+    - --options=config/rspec
+    - spec
 requires:
   - 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*'
+    - 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

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