defmastership 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29225577d47450033d4ea2c9715ab51cb2025318ff26da38435c11900ff0cb52
-  data.tar.gz: a36cb1eb3b8c45cb14b74200d43163edd1907bcfe7ed2a54d15f4f1ebd341454
+  metadata.gz: 995e93909012fff3a4dcbeb55605d6e8754e24c3868f63d3000ed1c6674809c7
+  data.tar.gz: 94ae5225d555eb837017ebe243a69bfec21feb0882d14a3329b48f2b016c1ba2
 SHA512:
-  metadata.gz: bb97db7204c4665f53c5f57e03737e31a88373a928ce4157f912938b84feff1b3b7f260365fa210bab905b47eb87c336e259e91d1a77d73ace80e84f8152d464
-  data.tar.gz: 4c359dbf1017c365d9c00faf7617233e3793093dba327d39982cebd7dabd68a7b5af0a999568c91775cd16a2a8af9cc544a67fdf3acedf92d65120269c372d18
+  metadata.gz: 48169bb5cfc6bea00209d60619cace40a45471e2ff6c2b2543cd8846ca001daac2e6a865c18cf20b95ed5e6102b36328302d91b577a69952acf7e3bc0d79c209
+  data.tar.gz: 00265e2ed2fc50f527ffba937dd2dae5d3d9f2189c2ada4b451f2504dbfdb96efffa73e1b8e18981055ea43c45458bc9df93479630ec014f2e9ec7b8bafd5cc5

data/.gitlab-ci.yml

@@ -9,43 +9,55 @@ default:
 
 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[@]}"
   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
 
 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
 

data/Gemfile

@@ -1,5 +1,55 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-source('https://rubygems.org')
+source 'https://rubygems.org'
+
 gemspec
+
+ruby RUBY_VERSION
+
+group :development do
+  # cucumber steps for command line tests
+  gem 'aruba',                 '~> 2.2'
+  # bdd
+  gem 'cucumber',              '~> 9.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.62.0'
+  # code needs to be clean
+  gem 'rubocop-performance',   '~> 1.20.0'
+  # test code needs to be clean
+  gem 'rubocop-rspec',         '~> 2.27.0'
+  # Rakefiels need to be clean
+  gem 'rubocop-rake',          '~> 0.6'
+  if RUBY_VERSION >= '3.0'
+    # detect selling code
+    gem 'reek', '~> 6.3'
+  end
+  # What is tdd without code coverage ?
+  gem 'simplecov', '~> 0.22', '< 0.23'
+  # # to document code
+  # gem 'yard',                  '~> 0.9.5'
+end
+
+group :debugging do
+  # Sometimes, we need to debug
+  gem 'pry', '~> 0.14.0'
+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/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/defmastership.gemspec

@@ -33,16 +33,6 @@ Gem::Specification.new do |spec|
   spec.rdoc_options << '--title defmastership' << '--main README.rdoc' << '-ri'
   spec.bindir = 'bin'
   spec.executables << 'defmastership'
-  spec.add_development_dependency('aruba', '~> 2')
-  spec.add_development_dependency('cucumber', '~> 8')
-  spec.add_development_dependency('rake', '~> 13')
-  spec.add_development_dependency('rdoc', '~> 6')
-  spec.add_development_dependency('rspec', '~> 3')
-  spec.add_development_dependency('rubocop', '1.50')
-  spec.add_development_dependency('rubocop-performance', '~> 1.17')
-  spec.add_development_dependency('rubocop-rake', '~> 0.6')
-  spec.add_development_dependency('rubocop-rspec', '~> 2.22')
-  spec.add_development_dependency('simplecov', '~> 0')
   spec.add_runtime_dependency('aasm', '~> 5')
   spec.add_runtime_dependency('asciidoctor', '~> 2')
   spec.add_runtime_dependency('gli', '~> 2')

data/features/definition_checksum.feature

@@ -213,7 +213,7 @@ Feature: definition checksum
     And the stdout should not contain anything
     And the stderr should not contain anything
 
-  Scenario: Checksum take into account variables in ref modification
+  Scenario: Checksum takes into account variables in ref modification
     Given a file named "modifications.yml" with:
     """
     ---
@@ -243,6 +243,36 @@ Feature: definition checksum
     And the stdout should not contain anything
     And the stderr should not contain anything
 
+  Scenario: Checksum does not take into account bad variables definition
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    :variable:multiline
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(~2e7dd73e)]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
   Scenario: Checksum keep explicit version in ref modification
     Given a file named "modifications.yml" with:
     """

data/features/export.feature

@@ -201,7 +201,7 @@ Feature: The extract command
     And the stdout should not contain anything
     And the stderr should not contain anything
 
-  Scenario: Extract one definition with external ref to CSV 
+  Scenario: Extract one definition with external ref to CSV
     Given a file named "toto.adoc" with:
     """
     :eref-implements-prefix: Participate to:
@@ -224,6 +224,27 @@ Feature: The extract command
     And the stdout should not contain anything
     And the stderr should not contain anything
 
+  Scenario: Extract one definition with missing external ref to CSV
+    Given a file named "toto.adoc" with:
+    """
+    :eref-implements-prefix: Participate to:
+    :eref-implements-url:    ./the_other_document.html
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Participate to:
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde,
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
   Scenario: Extract one definition with external ref without url to CSV 
     Given a file named "toto.adoc" with:
     """
@@ -313,6 +334,27 @@ Feature: The extract command
     And the stdout should not contain anything
     And the stderr should not contain anything
 
+  Scenario: Extract one definition with missing attributes to CSV
+    Given a file named "toto.adoc" with:
+    """
+    :attr-verifiedby-prefix: Verified by:
+    :attr-criticity-prefix: Criticity:
+    [define, requirement, TOTO-0001]
+    One single line.
+
+    something else.
+    defs:attribute[verifiedby, Beautiful Test]
+    """
+    When I successfully run `defmastership export toto.adoc`
+    And the stdout should not contain anything
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Verified by:,Criticity:
+    requirement,TOTO-0001,One single line.,~554b0ff5,Beautiful Test,
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
   Scenario: Extract one definition with example in it
     Given a file named "toto.adoc" with:
     """

data/features/rename_included_files.feature

@@ -58,6 +58,34 @@ Feature: The rename_included_files command
     And the file "any_path/one_file.png" should not exist
     And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
 
+  Scenario: change the filename with options in include macro
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::any_path/one_file.png[leveloffset=offset,lines=ranges]
+    """
+    And a directory named "any_path"
+    And an empty file named "any_path/one_file.png"
+    When I successfully run `defmastership modify --modifications rename_included_png 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-WHATEVER-123]
+    include::any_path/TOTO-WHATEVER-123_one_file.png[leveloffset=offset,lines=ranges]
+    """
+    And the file "any_path/one_file.png" should not exist
+    And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
+
   Scenario: change the filename with variable in path
     Given a file named "modifications.yml" with:
     """

data/lib/defmastership/batch_modifier.rb

@@ -4,32 +4,37 @@
 module DefMastership
   # Change references from temporary to definitive with multiple RefChangers
   class BatchModifier
-    attr_reader :config, :adoc_texts, :changes
+    attr_reader :config, :adoc_sources, :changes
 
-    def initialize(config, adoc_texts)
+    def initialize(config, adoc_sources)
       @config = config
-      @adoc_texts = adoc_texts
+      @adoc_sources = adoc_sources
       @changes = []
     end
 
     def apply(modifs)
-      modifs.split(/\s*,\s*/).each do |modif|
+      modifs.each do |modif|
         modifier = modifier_from(modif)
-        @adoc_texts = modifier.do_modifications(@adoc_texts)
-        @config[modif.to_sym][:config] = modifier.config
-        modifier.changes.each do |change|
-          @changes << ([modif] + change)
-        end
+        @adoc_sources = modifier.do_modifications(adoc_sources)
+        config.fetch(modif)[:config] = modifier.config
+
+        collect_changes(modifier, modif)
       end
     end
 
     private
 
     def modifier_from(modif)
-      raise(ArgumentError, "#{modif} is not a known modification") if @config[modif.to_sym].nil?
+      config_modif_sym = config[modif]
+      raise(ArgumentError, "#{modif} is not a known modification") unless config_modif_sym
+
+      ModifierFactory.from_config(config_modif_sym)
+    end
 
-      class_name = "#{@config[modif.to_sym][:type].split('_').map(&:capitalize).join}Modifier"
-      DefMastership.const_get(class_name).new(@config[modif.to_sym][:config])
+    def collect_changes(modifier, modif)
+      modifier.changes.reduce(changes) do |acc, change|
+        acc << ([modif.to_s] + change)
+      end
     end
   end
 end

data/lib/defmastership/change_ref_modifier.rb

@@ -1,17 +1,99 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require 'defmastership/modifier_base'
+require 'defmastership/constants'
+require 'defmastership/modifier'
 
 module DefMastership
-  # Change all refs of a given project
-  class ChangeRefModifier < ModifierBase
-    def replacements
+  # Change references from temporary to definitive with multiple RefChangers
+  class ChangeRefModifier
+    include Modifier
+
+    REGEXP_FROM = {
+      definition: {
+        before: DMRegexp::DEF_BEFORE_REF,
+        after: DMRegexp::DEF_AFTER_REF
+      },
+      iref: {
+        before: DMRegexp::IREF_DEF_BEF,
+        after: DMRegexp::IREF_DEF_AFT
+      }
+    }.freeze
+
+    private_constant :REGEXP_FROM
+
+    def self.replacement_methods
       %i[replace_refdef replace_irefs]
     end
 
-    def new_line_modifier(config, _adoc_texts)
-      ChangeRefLineModifier.from_config(config)
+    def self.default_config
+      {
+        from_regexp: '',
+        to_template: '',
+        next_ref: 0
+      }
+    end
+
+    def initialize(config)
+      @parsing_state = ParsingState.new
+
+      setup_modifier_module(config)
+    end
+
+    def replace(method, line)
+      public_send(:"replace_#{method}", line)
+    end
+
+    def replace_refdef(line)
+      if @parsing_state.enabled?(line)
+        do_replace_refdef(line)
+      else
+        line
+      end
+    end
+
+    def replace_irefs(line)
+      changes.reduce(line) do |res_line, (from, to)|
+        res_line.gsub(Helper.regexp_from(:iref, from)) do
+          Helper.text_with(Regexp.last_match, to)
+        end
+      end
+    end
+
+    private
+
+    def do_replace_refdef(line)
+      line.sub(Helper.regexp_from(:definition, from_regexp)) do
+        replacement_from(Regexp.last_match)
+      end
+    end
+
+    def replacement_from(match)
+      replacement = to_template % hmerge(match)
+      changes << [match[:from], replacement]
+      config[:next_ref] += 1
+      Helper.text_with(match, replacement)
+    end
+
+    def hmerge(match)
+      config.merge(match.named_captures.transform_keys(&:to_sym))
+    end
+
+    # Helper functions
+    module Helper
+      def self.regexp_from(const, from)
+        regexps = REGEXP_FROM.fetch(const)
+        regexp_str =
+          "(?<before>#{regexps[:before]})" \
+          "(?<from>#{from})" \
+          "#{DMRegexp::DEF_VERSION_AND_CHECKSUM}" \
+          "(?<after>#{regexps[:after]})"
+        Regexp.new(regexp_str, Regexp::EXTENDED)
+      end
+
+      def self.text_with(match, replacement)
+        match[:before] + replacement + (match[:version_and_checksum] || '') + match[:after]
+      end
     end
   end
 end

data/lib/defmastership/comment_filter.rb

@@ -5,6 +5,6 @@
 # not.
 class String
   def commented?
-    !match(DefMastership::DMRegexp::SINGLE_LINE_COMMENT).nil?
+    !!match(DefMastership::DMRegexp::SINGLE_LINE_COMMENT)
   end
 end

data/lib/defmastership/constants.rb

@@ -3,6 +3,7 @@
 
 module DefMastership
   # set of regexp of added asciidoctor constructions
+  # This module smells of :reek:TooManyConstants
   module DMRegexp
     SINGLE_LINE_COMMENT = %r{^//[^/]}.freeze
 
@@ -27,8 +28,8 @@ module DefMastership
       Regexp::EXTENDED
     )
 
-    VARIABLE_DEF = /^\s*:(?<varname>[\w:_-]+):\s*
-                   \s*(?<value>\S.*\S)\s*$/x.freeze
+    VARIABLE_DEF = /^\s*:(?<varname>[\w:_-]+):\s+
+                   (?<value>\S.*\S)\s*$/x.freeze
 
     VARIABLE_USE = /{(?<varname>[\w:_-]+)}/x.freeze
 
@@ -37,7 +38,7 @@ module DefMastership
     EREF_DEF = /^\s*
                defs:eref\[
                \s*(?<refname>[\w:_-]+)\s*,
-               \s*\[(?<extrefs>[^\]]+)\]\s*\]/x.freeze
+               \s*\[\s*(?<extrefs>[^\]]+?)\s*\]\s*\]/x.freeze
     BLOCK = /^--\s*$/.freeze
 
     IREF_DEF_BEF = 'defs:iref\[\s*'
@@ -61,7 +62,7 @@ module DefMastership
     INCLUDE_KEYWORD  = '\binclude::'
     INCLUDE_PATH     = '(?<path>.*/)?'
     INCLUDE_FILENAME = '(?<filename>[^\\/]+)'
-    INCLUDE_OPTIONS  = '\[(?<options>[\]]*)\]'
+    INCLUDE_OPTIONS  = '\[(?<options>[^\]]*)\]'
 
     INCLUDE = Regexp.new(
       INCLUDE_KEYWORD + INCLUDE_PATH + INCLUDE_FILENAME + INCLUDE_OPTIONS,