asciidoctor-defmastership 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c34eada26d2c22399f1418c4eef3753832cff1363ff0d82ab1f2308af83ca4
-  data.tar.gz: 95e344b6e198af8ce03fa005a9545a8d256183966547cd5dacd3f2a4fef802ba
+  metadata.gz: 120879775fb430f58cc83b38f54a85a783e53c13a303f21aa1d53b140afe534c
+  data.tar.gz: 2dd09334b90b48c2d3fec43e8ba64a456ae00c13771113bae1655ac90d3451ef
 SHA512:
-  metadata.gz: f860c3c2c9dcc1743495c8f806a9085a5be1ab836bd87f4282902423420157b96e3d0f2b5e61e3d70a95055a955c00e7ff619e1b95462d293f412d4701002d95
-  data.tar.gz: 9918bb1738b73827e6c5071effd3f44b91cc3ddaa607ad06ca2cdea3b25e42f9cd75d4300018f3e9dd1bf28362e3aacbd3251666cfe2a3d9b723f82b83c0e83b
+  metadata.gz: ef6a6b74bc6486b24cad993dad606b6a4d7d1730344c074af2fd9792fa94492730f80933bd262149963b5501e9c53ab41ce6b2a06cb61aa3ec770c3f176b06a9
+  data.tar.gz: 71c5ca0517d3766e4cd880ceccbca363f723859636d11cf2618ddf2590f73d19658ef15cdb71fe4ae13b5e283fefc4ac12ce2f45607bb9788eb1e7c2fd366a1c

data/.gitignore

@@ -14,3 +14,4 @@
 *.gem
 /Gemfile.lock
 /.ruby-version
+/rspec_results.html

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 default:
-  image: ruby:3.2
+  image: ruby:3.3
   before_script:
     - apt-get update
     - ruby -v
@@ -9,23 +9,34 @@ default:
 
 unit tests:
   script:
-    - bundle exec rake spec
+    - bundle exec rake test:spec
 
 rubocop:
   script:
-    - bundle exec rake rubocop
+    - bundle exec rake quality:rubocop
 
 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

@@ -2,19 +2,44 @@
 # frozen_string_literal: true
 
 source('https://rubygems.org')
+
 gemspec
 
-# to parse provided Rakefile
-gem 'rake', '~> 13'
-# tdd
-gem 'rspec', '~> 3'
-# code need to be clean
-gem 'rubocop', '1.54'
-# code need to be clean
-gem 'rubocop-performance', '~> 1.18'
-# Rakile needs to be clean
-gem 'rubocop-rake', '~> 0.6'
-# unit tests need to be clean
-gem 'rubocop-rspec', '~> 2.22'
-# What is tdd without code coverage ?
-gem 'simplecov', '~> 0'
+ruby RUBY_VERSION
+
+group :development do
+  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
+  # to parse provided Rakefile
+  gem 'rake', '~> 13'
+  # tdd
+  gem 'rspec', '3.12'
+  # code need to be clean
+  gem 'rubocop', '1.65'
+  # code need to be clean
+  gem 'rubocop-performance', '~> 1'
+  # Rakile needs to be clean
+  gem 'rubocop-rake', '~> 0'
+  # unit tests need to be clean
+  gem 'rubocop-rspec', '~> 2'
+  if RUBY_VERSION >= '3.0'
+    # detect selling code
+    gem 'reek', '~> 6'
+  end
+  # What is tdd without code coverage ?
+  gem 'simplecov', '~> 0'
+end
+
+group :debugging do
+  # Sometimes, we need to debug
+  gem 'pry', '~> 0'
+end

data/Rakefile

@@ -4,13 +4,18 @@
 require('bundler/gem_tasks')
 require('rspec/core/rake_task')
 
-RSpec::Core::RakeTask.new(:spec)
-require('rubocop/rake_task')
+Dir['tasks/**/*.rake'].each { |t| load t }
 
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-performance'
-  task.requires << 'rubocop-rspec'
-  task.requires << 'rubocop-rake'
+desc 'Continous integration tasks'
+task :ci do
+  [
+    'test:spec',
+    :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])
+task default: :ci

data/asciidoctor-defmastership.gemspec

@@ -37,6 +37,6 @@ Gem::Specification.new do |spec|
     end
   spec.require_paths = ['lib']
 
-  spec.add_dependency('asciidoctor', '~> 2.0')
-  spec.add_dependency('defmastership', '>= 1.0.16', '< 2.0')
+  spec.add_dependency('asciidoctor', '~> 2')
+  spec.add_dependency('defmastership', '>= 1.0.19')
 end

data/config/mutant.yml

@@ -1,6 +1,26 @@
 ---
 includes:
-- lib
-integration: rspec
+  - lib
+integration:
+  name: rspec
 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

data/config/rspec

@@ -0,0 +1,4 @@
+--format documentation
+--format html --out rspec_results.html
+--color
+--require spec_helper

data/config/rubocop.yml

@@ -1,151 +1,79 @@
-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:
-  Exclude:
-  # Ignore RSpec DSL
-    - spec/**/*
-  # Ignore gemspec DSL
-    - '*.gemspec'
-
-Naming/FileName:
-  Exclude:
-    - Rakefile
-
-# Avoid parameter lists longer than five parameters.
-ParameterLists:
-  Max: 3
-  CountKeywordArgs: true
-
-# Avoid more than `Max` levels of nesting.
-BlockNesting:
-  Max: 3
-
-# Align with the style guide.
-CollectionMethods:
-  PreferredMethods:
-    collect:  'map'
-    inject:   'reduce'
-    find:     'detect'
-    find_all: 'select'
-
-# Do not force public/protected/private keyword to be indented at the same
-# level as the def keyword. My personal preference is to outdent these keywords
-# because I think when scanning code it makes it easier to identify the
-# sections of code and visually separate them. When the keyword is at the same
-# level I think it sort of blends in with the def keywords and makes it harder
-# to scan the code and see where the sections are.
-AccessModifierIndentation:
-  Enabled: false
-
-# Limit line length
-LineLength:
-  Max: 80
-
-# Disable documentation checking until a class needs to be documented once
-Documentation:
-  Enabled: false
-
-# Do not always use &&/|| instead of and/or.
-AndOr:
-  Enabled: false
+Style/Copyright:
+  Enabled: true
+  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
+  AutocorrectNotice: '# Copyright (c) 2023 Jerome Arbez-Gindre'
 
-# Do not favor modifier if/unless usage when you have a single-line body
-IfUnlessModifier:
+Lint/ConstantResolution: # Not available ins rubocop 0.81
   Enabled: false
 
-# Allow case equality operator (in limited use within the specs)
-CaseEquality:
+Style/DocumentationMethod:
   Enabled: false
 
-# Constants do not always have to use SCREAMING_SNAKE_CASE
-ConstantName:
-  Enabled: false
-
-# Not all trivial readers/writers can be defined with attr_* methods
-TrivialAccessors:
-  Enabled: false
-
-# Allow empty lines around class body
-EmptyLinesAroundClassBody:
-  Enabled: false
-
-# Allow empty lines around module body
-EmptyLinesAroundModuleBody:
-  Enabled: false
-
-# Allow empty lines around block body
-EmptyLinesAroundBlockBody:
-  Enabled: false
-
-# Allow multiple line operations to not require indentation
-MultilineOperationIndentation:
-  Enabled: false
-
-# Prefer String#% over Kernel#sprintf
-FormatString:
-  Enabled: false
-
-# Use square brackets for literal Array objects
-PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%':  '{}'
-    '%i': '[]'
-    '%q': ()
-    '%Q': ()
-    '%r': '{}'
-    '%s': ()
-    '%w': '[]'
-    '%W': '[]'
-    '%x': ()
-
-# Align if/else blocks with the variable assignment
-EndAlignment:
-  EnforcedStyleAlignWith: variable
-
-# Do not always align parameters when it is easier to read
-AlignParameters:
+Style/StringHashKeys :
+  Enabled: true
   Exclude:
-    - spec/**/*_spec.rb
-
-# Prefer #kind_of? over #is_a?
-ClassCheck:
-  EnforcedStyle: kind_of?
+    - '*.gemspec'
 
-# Do not prefer double quotes to be used when %q or %Q is more appropriate
-UnneededPercentQ:
-  Enabled: false
+Style/MissingElse:
+  EnforcedStyle: case
 
-# Allow a maximum ABC score
-Metrics/AbcSize:
-  Max: 20.1
+Metrics/ModuleLength :
+  Exclude:
+    - 'spec/**/*'
 
-# Do not prefer lambda.call(...) over lambda.(...)
-LambdaCall:
-  Enabled: false
+Metrics/BlockLength :
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
 
-# Allow additional spaces
-ExtraSpacing:
-  Enabled: false
+Security/Eval :
+  Exclude:
+    - 'Rakefile'
 
-# All objects can still be mutated if their eigenclass is patched
-RedundantFreeze:
-  Enabled: false
+Style/ConstantVisibility :
+  Exclude:
+     # there is one unique explicit constant visibility for all
+     # constants
+    - 'lib/asciidoctor/defmastership/extension.rb'
 
-# Prefer using `fail` when raising and `raise` when reraising
-SignalException:
-  EnforcedStyle: semantic
+# rubocop-rspec options
+RSpec/MessageExpectation :
+  Enabled: true
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
+RSpec/FilePath :
+  Enabled: true
 
-Style/CommentedKeyword:
-  Enabled: false
+RSpec/NestedGroups:
+  Max: 4
 
-Style/MixinGrouping:
+Layout/RedundantLineBreak:
   Enabled: false
+  
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: true
+  AllowedCops: ['Lint/InterpolationCheck']
 
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
+Layout/EndOfLine:
+  EnforcedStyle: lf
+  

data/lib/asciidoctor/defmastership/preprocessor.rb

@@ -0,0 +1,189 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# :nocov:
+require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
+# :nocov:
+
+# An extension that allow to define applicable definitions
+#
+# Usage
+#   :tag-mylabel-color: yellow
+#   :tag-otherlabel-color: red
+#
+#
+#   [define, requirement, TOTO-0001, [mylabel, otherlabel]]
+#   --
+#   The system shall allow to do lots of things.
+#   --
+#
+# or
+#
+#   [define, requirement, TOTO-0001]
+#   This shall be nice.
+#
+require('asciidoctor/defmastership/regexp_dispatcher')
+require('defmastership/constants')
+require('defmastership/parsing_state')
+
+module Asciidoctor
+  # Module to host DefMastership preprocessor
+  module DefMastership
+    # Preprocessor to replace adoc statements
+    # This class smells of :reek:InstanceVariableAssumption.
+    # Not an issue because process is the only method used by Asciidoctor
+    class Preprocessor < Asciidoctor::Extensions::Preprocessor
+      REGEXPS = {
+        eref_config: ::DefMastership::DMRegexp::EREF_CONFIG,
+        definition: ::DefMastership::DMRegexp::DEFINITION,
+        eref_def: ::DefMastership::DMRegexp::EREF_DEF,
+        iref_def: ::DefMastership::DMRegexp::IREF_DEF,
+        attr_set: ::DefMastership::DMRegexp::ATTR_SET,
+        variable_def: ::DefMastership::DMRegexp::VARIABLE_DEF
+      }.freeze
+
+      private_constant :REGEXPS
+
+      def process(_document, reader)
+        @has_url = Set.new
+        @variables = {}
+        @parsing_state = ::DefMastership::ParsingState.new
+
+        return reader if reader.eof?
+
+        reader.unshift_lines(parse_and_replace(reader.read_lines))
+      end
+
+      def build_definition(_line, matches)
+        Helper::DefinitionStringBuilder.new(matches, show_explicit_checksum(matches)).str
+      end
+
+      def variable_set(line, matches)
+        @variables.merge!(Helper.variable_hash(matches))
+        [line]
+      end
+
+      def set_eref_url_if_any(line, matches)
+        @has_url.add(matches[:reference]) if Helper.valid_eref_url?(matches)
+        [line]
+      end
+
+      def build_external_ref(_line, matches)
+        return [] unless show_ext_ref(matches)
+
+        extrefs = matches[:extrefs].split(/\s*,\s*/)
+        extref_line = extrefs.map { |ref| build_link(ref, matches) }
+        ["[.external_reference]\#{eref-#{matches[:reference]}-prefix} #{extref_line.join(', ')}.#"]
+      end
+
+      # This method smells of :reek:UtilityFunction
+      def build_internal_ref(line, _matches)
+        [
+          line.gsub(REGEXPS.fetch(:iref_def)) do
+            intref = Regexp.last_match[:intref]
+            "<<#{intref},#{intref}>>"
+          end
+        ]
+      end
+
+      # This method smells of :reek:UtilityFunction
+      def attribute_setting(_line, matches)
+        [
+          '[.attribute]',
+          "{attr-#{matches[:attr]}-prefix} #{matches[:value]}."
+        ]
+      end
+
+      private
+
+      def build_subs
+        subs = RegexpDispatcher.new(self)
+        subs
+          .add_rule(REGEXPS.fetch(:eref_config), :set_eref_url_if_any)
+          .add_rule(REGEXPS.fetch(:definition), :build_definition)
+          .add_rule(REGEXPS.fetch(:eref_def), :build_external_ref)
+          .add_rule(REGEXPS.fetch(:iref_def), :build_internal_ref)
+          .add_rule(REGEXPS.fetch(:attr_set), :attribute_setting)
+          .add_rule(REGEXPS.fetch(:variable_def), :variable_set)
+      end
+
+      def parse_and_replace(lines)
+        subs = build_subs
+        lines.reduce([]) do |new_lines, line|
+          next new_lines + [line] unless @parsing_state.enabled?(line)
+
+          next new_lines + subs.replace(line)
+        end
+      end
+
+      def show_explicit_checksum(matches)
+        matches[:explicit_checksum] &&
+          !@variables['show-explicit-checksum'].eql?('disable') &&
+          !@variables["show-#{matches[:type]}-explicit-checksum"].eql?('disable')
+      end
+
+      def build_link(ref, matches)
+        refname = matches[:reference]
+        return ref unless @has_url.include?(refname)
+
+        ref_pattern =
+          @variables["eref-#{refname}-ref-pattern"] || '#%s'
+        ref_str = format(ref_pattern, ref)
+
+        "link:{eref-#{refname}-url}#{ref_str}[#{ref}]"
+      end
+
+      def show_ext_ref(matches)
+        !@variables['show-ext-ref'].eql?('disable') &&
+          !@variables["show-#{matches[:reference]}-ext-ref"].eql?('disable')
+      end
+    end
+
+    # Proepocessors class Helpers
+    class Preprocessor
+      # Helpers for Preprocessor class
+      module Helper
+        # Isolate the definition macro
+        class DefinitionStringBuilder
+          def initialize(matches, show_explicit_checksum)
+            @matches = matches
+            @show_explicit_checksum = show_explicit_checksum
+          end
+
+          def str
+            explicit_checksum_str = " [.checksum]#(#{@matches[:explicit_checksum]})#" if @show_explicit_checksum
+            explicit_version_str = Helper.build_explicit_version_str(@matches[:explicit_version])
+            labels_str = Helper.build_labels_str(@matches[:labels])
+            reference = @matches[:reference]
+            [
+              ".#{reference}#{explicit_version_str}#{explicit_checksum_str}#{labels_str}",
+              "[##{reference}.define.#{@matches[:type]}]"
+            ]
+          end
+        end
+
+        def self.valid_eref_url?(match)
+          match[:symb] == 'url' && !match[:value].eql?('none')
+        end
+
+        def self.build_labels_str(labels)
+          return unless labels
+
+          labels_strings =
+            labels.split(/\s*,\s*/).reduce([]) do |acc, label|
+              acc << "[.tag.{tag-#{label}-color}]##{label}#"
+            end
+          " #{labels_strings.join(' ')}"
+        end
+
+        def self.build_explicit_version_str(explicit_version)
+          " [.version]#(#{explicit_version})#" if explicit_version
+        end
+
+        def self.variable_hash(match)
+          { match[:varname] => match[:value] }
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/defmastership/regexp_dispatcher.rb

@@ -1,13 +1,17 @@
 # Copyright (c) 2023 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+# :nocov:
 require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
+# :nocov:
+
 require('ostruct')
 
 module Asciidoctor
   module DefMastership
     # Hosts several Text replacement rules
     class RegexpDispatcher
+      # Class to link a regexp with a method
       Rule = Struct.new(:regexp, :method_symbol)
       private_constant :Rule
 
@@ -24,7 +28,7 @@ module Asciidoctor
       def replace(line)
         @rules.each do |rule|
           matches = rule.regexp.match(line)
-          return @effective_subs.__send__(rule.method_symbol, line, matches) if matches
+          return @effective_subs.public_send(rule.method_symbol, line, matches) if matches
         end
         [line]
       end

data/lib/asciidoctor/defmastership/version.rb

@@ -2,8 +2,9 @@
 # frozen_string_literal: true
 
 module Asciidoctor
+  # main application module
   module DefMastership
-    VERSION = '1.0.7'
+    VERSION = '1.0.9'
     public_constant :VERSION
   end
 end

data/lib/asciidoctor/defmastership.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 
 if RUBY_ENGINE == 'opal'
-  require('asciidoctor/defmastership/extension')
+  require('asciidoctor/defmastership/preprocessor')
 else
-  require_relative('defmastership/extension')
+  require_relative('defmastership/preprocessor')
 end
 
 Asciidoctor::Extensions.register do

data/tasks/console.rake

@@ -0,0 +1,8 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+desc 'Starts the interactive console'
+task :console do
+  require 'pry'
+  Pry.start
+end

data/tasks/package.task

@@ -0,0 +1,9 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('rubygems')
+require('rubygems/package_task')
+
+spec = eval(File.read('asciidoctor-defmastership.gemspec'))
+
+Gem::PackageTask.new(spec)

data/tasks/smelling_code.rake

@@ -0,0 +1,41 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+namespace 'quality' do
+  begin
+    require('rubocop/rake_task')
+
+    RuboCop::RakeTask.new do |task|
+      task.options << '--display-cop-names'
+      task.options << '--config=config/rubocop.yml'
+    end
+  rescue LoadError
+    task(:rubocop) do
+      puts('Install rubocop to run its rake tasks')
+    end
+  end
+
+  begin
+    require('reek/rake/task')
+
+    Reek::Rake::Task.new do |t|
+      t.fail_on_error = true
+      t.verbose = false
+
+      t.reek_opts = '--config config/reek.yml'
+    end
+  rescue LoadError
+    task(:reek) do
+      puts('Install reek to run its rake tasks')
+    end
+  end
+
+  desc 'Runs all quality code check'
+  task(all: ['quality:rubocop', 'quality:reek'])
+end
+
+desc 'Synonym for quality:rubocop'
+task(rubocop: 'quality:rubocop')
+
+desc 'Synonym for quality:reek'
+task(reek: 'quality:reek')

data/tasks/test.rake

@@ -0,0 +1,19 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('rspec/core/rake_task')
+
+namespace 'test' do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['--options config/rspec']
+  end
+
+  desc 'Runs all unit tests and acceptance tests'
+  task(all: ['test:spec'])
+end
+
+desc 'Synonym for test:spec'
+task(spec: 'test:spec')
+
+desc 'Synonym for test:all'
+task(test: 'test:all')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: defmastership
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.16
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.0.19
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.16
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.0.19
 description: |-
   asciidoctor-defmastership allows to define
                      applicable definitions references, link to other references
@@ -66,21 +60,22 @@ files:
 - asciidoctor-defmastership.gemspec
 - bin/console
 - bin/setup
-- config/devtools.yml
-- config/flay.yml
-- config/flog.yml
 - config/mutant.yml
 - config/reek.yml
+- config/rspec
 - config/rubocop.yml
-- config/yardstick.yml
 - example/.config.adoc
 - example/.gitignore
 - example/example.adoc
 - example/howto.sh
 - lib/asciidoctor/defmastership.rb
-- lib/asciidoctor/defmastership/extension.rb
+- lib/asciidoctor/defmastership/preprocessor.rb
 - lib/asciidoctor/defmastership/regexp_dispatcher.rb
 - lib/asciidoctor/defmastership/version.rb
+- tasks/console.rake
+- tasks/package.task
+- tasks/smelling_code.rake
+- tasks/test.rake
 homepage: https://gitlab.com/jjag/asciidoctor-defmastership/
 licenses:
 - MIT
@@ -101,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: asciidoctor extension to handle applicable definition references

data/config/devtools.yml

@@ -1,2 +0,0 @@
----
-unit_test_timeout: 0.2

data/config/flay.yml

@@ -1,3 +0,0 @@
----
-threshold: 8
-total_score: 119

data/config/flog.yml

@@ -1,2 +0,0 @@
----
-threshold: 13.5

data/config/yardstick.yml

@@ -1,2 +0,0 @@
----
-threshold: 100

data/lib/asciidoctor/defmastership/extension.rb

@@ -1,149 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
-
-# An extension that allow to define applicable definitions
-#
-# Usage
-#   :tag-mylabel-color: yellow
-#   :tag-otherlabel-color: red
-#
-#
-#   [define, requirement, TOTO-0001, [mylabel, otherlabel]]
-#   --
-#   The system shall allow to do lots of things.
-#   --
-#
-# or
-#
-#   [define, requirement, TOTO-0001]
-#   This shall be nice.
-#
-require('asciidoctor/defmastership/regexp_dispatcher')
-require('defmastership/constants')
-require('defmastership/parsing_state')
-
-module Asciidoctor
-  module DefMastership
-    # Preprocessor to replace adoc statements
-    class Preprocessor < Asciidoctor::Extensions::Preprocessor
-      EREF_CONFIG_REGEXP  = ::DefMastership::DMRegexp::EREF_CONFIG
-      DEFINITION_REGEXP   = ::DefMastership::DMRegexp::DEFINITION
-      EREF_DEF_REGEXP     = ::DefMastership::DMRegexp::EREF_DEF
-      IREF_DEF_REGEXP     = ::DefMastership::DMRegexp::IREF_DEF
-      ATTR_SET_REGEXP     = ::DefMastership::DMRegexp::ATTR_SET
-      VARIABLE_DEF_REGEXP = ::DefMastership::DMRegexp::VARIABLE_DEF
-
-      def initialize(config = {})
-        super(config)
-
-        @has_url = {}
-        @variables = {}
-        @parsing_state = ::DefMastership::ParsingState.new
-      end
-
-      # process the document
-      def process(_document, reader)
-        return reader if reader.eof?
-
-        reader.unshift_lines(parse_and_replace(reader.read_lines))
-        reader
-      end
-
-      private
-
-      def build_subs
-        subs = RegexpDispatcher.new(self)
-        subs
-          .add_rule(EREF_CONFIG_REGEXP, :set_eref_url_if_any)
-          .add_rule(DEFINITION_REGEXP, :build_definition)
-          .add_rule(EREF_DEF_REGEXP, :build_external_ref)
-          .add_rule(IREF_DEF_REGEXP, :build_internal_ref)
-          .add_rule(ATTR_SET_REGEXP, :attribute_setting)
-          .add_rule(VARIABLE_DEF_REGEXP, :variable_set)
-      end
-
-      def parse_and_replace(lines)
-        subs = build_subs
-        lines.reduce([]) do |new_lines, line|
-          next new_lines + [line] unless @parsing_state.enabled?(line)
-
-          next new_lines + subs.replace(line)
-        end
-      end
-
-      def set_eref_url_if_any(line, matches)
-        @has_url[matches[:refname]] = true if matches[:symb] == 'url' && matches[:value] != 'none'
-        [line]
-      end
-
-      def show_explicit_checksum(matches)
-        matches[:explicit_checksum] &&
-          @variables['show-explicit-checksum'] != 'disable' &&
-          @variables["show-#{matches[:type]}-explicit-checksum"] != 'disable'
-      end
-
-      def build_definition(_line, matches)
-        definition_lines = []
-        explicit_checksum_str = " [.checksum]#(#{matches[:explicit_checksum]})#" if show_explicit_checksum(matches)
-        explicit_version_str = " [.version]#(#{matches[:explicit_version]})#" if matches[:explicit_version]
-        labels_str = " #{labels_strings(matches[:labels]).join(' ')}" if matches[:labels]
-        definition_lines << ".#{matches[:reference]}#{explicit_version_str}#{explicit_checksum_str}#{labels_str}"
-        definition_lines <<
-          "[##{matches[:reference]}.define.#{matches[:type]}]"
-      end
-
-      def labels_strings(labels)
-        labels_strs = []
-        labels.split(/\s*,\s*/).reject(&:empty?).each do |label|
-          labels_strs << "[.tag.{tag-#{label}-color}]##{label}#"
-        end
-        labels_strs
-      end
-
-      def build_link(ref, matches)
-        if @has_url[matches[:refname]]
-          "link:{eref-#{matches[:refname]}-url}##{ref}[#{ref}]"
-        else
-          ref
-        end
-      end
-
-      def show_ext_ref(matches)
-        @variables['show-ext-ref'] != 'disable' &&
-          @variables["show-#{matches[:refname]}-ext-ref"] != 'disable'
-      end
-
-      def build_external_ref(_line, matches)
-        return [] unless show_ext_ref(matches)
-
-        extrefs = matches[:extrefs].split(/\s*,\s*/)
-        new_line = "[.external_reference]\#{eref-#{matches[:refname]}-prefix} "
-        extref_line = extrefs.map { |ref| build_link(ref, matches) }
-        @has_url[matches[:refname]]
-        ["#{new_line}#{extref_line.join(', ')}.#"]
-      end
-
-      def build_internal_ref(line, _matches)
-        [
-          line.gsub(IREF_DEF_REGEXP) do
-            "<<#{Regexp.last_match[:intref]},#{Regexp.last_match[:intref]}>>"
-          end
-        ]
-      end
-
-      def attribute_setting(_line, matches)
-        [
-          '[.attribute]',
-          "{attr-#{matches[:attr]}-prefix} #{matches[:value]}."
-        ]
-      end
-
-      def variable_set(line, matches)
-        @variables[matches[:varname]] = matches[:value]
-        [line]
-      end
-    end
-  end
-end