defmastership 1.0.17 → 1.0.19

data/features/export.feature

@@ -20,7 +20,6 @@ Feature: The extract command
     Second line.",~b86dcbde
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract to CSV with alternative CSV separator
     Given a file named "toto.adoc" with:
@@ -60,7 +59,6 @@ Feature: The extract command
     Third line with {not_defined_variable}.",~3bf370ed
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
 
   Scenario: Extract some definitions to CSV 
@@ -93,7 +91,6 @@ Feature: The extract command
     ignored multiline
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Ignore definitions in literal block
     Given a file named "toto.adoc" with:
@@ -114,7 +111,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Ignore definitions in example block
     Given a file named "toto.adoc" with:
@@ -135,7 +131,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Ignore definitions in commment block
     Given a file named "toto.adoc" with:
@@ -156,7 +151,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Handle mixes comment and literal blocks 
     Given a file named "toto.adoc" with:
@@ -179,7 +173,6 @@ Feature: The extract command
     something_else
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract definition with labels 
     Given a file named "toto.adoc" with:
@@ -199,9 +192,8 @@ Feature: The extract command
     label2"
     """
     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:
@@ -222,7 +214,49 @@ Feature: The extract command
     SYSTEM-0014"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
+
+  Scenario: Extract one definition with external ref (with version and checksum) 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.
+    --
+    defs:eref[implements, [SYSTEM-0012(a), SYSTEM-0014, SYSTEM-0015(b~1223abcd)]]
+    """
+    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,"SYSTEM-0012(a)
+    SYSTEM-0014
+    SYSTEM-0015(b~1223abcd)"
+    """
+    And the stdout 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
 
   Scenario: Extract one definition with external ref without url to CSV 
     Given a file named "toto.adoc" with:
@@ -245,7 +279,6 @@ Feature: The extract command
     SYSTEM-0014"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with external ref to CSV without URL
     Given a file named "toto.adoc" with:
@@ -260,7 +293,6 @@ Feature: The extract command
     """
     When I successfully run `defmastership export toto.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "toto.csv" should contain:
     """
     Type,Reference,Value,Checksum,Participate to:
@@ -289,7 +321,6 @@ Feature: The extract command
     TOTO-0002"
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with attributes to CSV 
     Given a file named "toto.adoc" with:
@@ -311,7 +342,26 @@ Feature: The extract command
     requirement,TOTO-0001,One single line.,~554b0ff5,Beautiful Test,Very cool
     """
     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
 
   Scenario: Extract one definition with example in it
     Given a file named "toto.adoc" with:
@@ -336,7 +386,6 @@ Feature: The extract command
     ----",~8f20a443
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with single line comment in it
     Given a file named "toto.adoc" with:
@@ -353,7 +402,6 @@ Feature: The extract command
     requirement,TOTO-0001,// comment,~b0b506c3
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything
 
   Scenario: Extract one definition with multi line comment or literal in it
     Given a file named "toto.adoc" with:
@@ -380,4 +428,3 @@ Feature: The extract command
     ....",~7eb3c490
     """
     And the stdout should not contain anything
-    And the stderr should not contain anything

data/features/modify.feature

@@ -20,7 +20,6 @@ Feature: The modify command
     """
     When I successfully run `defmastership modify --modifications temp-references thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "modifications.yml" should contain:
     """
     ---
@@ -75,7 +74,6 @@ Feature: The modify command
     """
     When I successfully run `defmastership modify --modifications-file=pouet.yml --modifications toto thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "pouet.yml" should contain:
     """
     ---
@@ -108,8 +106,7 @@ Feature: The modify command
     [define, requirement, TOTO-TEMP-XXX2]
     """
     When I successfully run `defmastership modify --modifications temp-references --changes-summary=changes.csv thedoc.adoc`
-    Then the stderr should not contain anything
-    And the stdout should not contain anything
+    Then the stdout should not contain anything
     And the file "changes.csv" should contain:
     """
     Modifier,Was,Becomes
@@ -141,7 +138,6 @@ Feature: The modify command
     """
     When I successfully run `defmastership modify --modifications temp-references,tata_or_titi --changes-summary=changes.csv thedoc.adoc`
     Then the stdout should not contain anything
-    And the stderr should not contain anything
     And the file "modifications.yml" should contain:
     """
     ---

data/features/rename_included_files.feature

@@ -23,7 +23,6 @@ Feature: The rename_included_files command
     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:
     """
     include::any_path/one_file.png[]
@@ -49,7 +48,6 @@ Feature: The rename_included_files command
     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]
@@ -58,6 +56,33 @@ 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 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:
     """
@@ -81,7 +106,6 @@ Feature: The rename_included_files command
     And an empty file named "one_two/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:
     """
     :any: one
@@ -114,7 +138,6 @@ Feature: The rename_included_files command
     And an empty file named "any_path/TOTO-WHATEVER-123_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]

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'git'
+
+Given('I initialize a git repo') do
+  Git.init(Aruba.config.home_directory)
+end
+
+Given('I add and commit the {string} file') do |filename|
+  git = Git.open(Aruba.config.home_directory)
+  git.add(filename)
+  git.commit('whatever')
+end
+
+Given('I set the {string} tag') do |tag_name|
+  git = Git.open(Aruba.config.home_directory)
+  git.add_tag(tag_name)
+end

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
 
@@ -22,22 +23,24 @@ module DefMastership
                                '\((?<explicit_version>[^~]+)?(?<explicit_checksum>~[[:alnum:]]+)?\)' \
                                ')?'
 
+    REFERENCE = '(?<reference>[\\w:_-]+)'
+
     DEFINITION = Regexp.new(
-      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
+      "#{DEF_BEFORE_REF}#{REFERENCE}#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
       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
 
-    EREF_CONFIG = /^\s*:eref-(?<refname>[\w:_-]+)-(?<symb>prefix|url):\s*
+    EREF_CONFIG = /^\s*:eref-(?<reference>[\w:_-]+)-(?<symb>prefix|url):\s*
                    \s*(?<value>\S.*\S)\s*/x.freeze
     EREF_DEF = /^\s*
                defs:eref\[
-               \s*(?<refname>[\w:_-]+)\s*,
-               \s*\[(?<extrefs>[^\]]+)\]\s*\]/x.freeze
+               \s*(?<reference>[\w:_-]+)\s*,
+               \s*\[\s*(?<extrefs>[^\]]+?)\s*\]\s*\]/x.freeze
     BLOCK = /^--\s*$/.freeze
 
     IREF_DEF_BEF = 'defs:iref\[\s*'
@@ -61,7 +64,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,

data/lib/defmastership/csv_formatter.rb

@@ -8,7 +8,7 @@ require('defmastership/csv_formatter_header')
 module DefMastership
   # to export a CSV file
   class CSVFormatter
-    def initialize(doc, sep = ',')
+    def initialize(doc, sep)
       @doc = doc
       @sep = sep
     end
@@ -17,12 +17,16 @@ module DefMastership
       column_list = build_column_list
       CSV.open(output_file, 'w:ISO-8859-1', col_sep: @sep) do |csv|
         csv << header(column_list)
-        @doc.definitions.each { |definition| csv << body(definition, column_list) }
+        export_definitions_in(csv, column_list)
       end
     end
 
     private
 
+    def export_definitions_in(csv, column_list)
+      @doc.definitions.each { |definition| csv << body(definition, column_list) }
+    end
+
     def header(column_list)
       header_formatter = CSVFormatterHeader.new(@doc)
       header_line = column_list.map { |part| header_formatter.public_send(part) }
@@ -30,20 +34,20 @@ module DefMastership
     end
 
     def body(definition, column_list)
-      body_formatter = CSVFormatterBody.new(@doc)
-      body_line = column_list.map { |part| body_formatter.public_send(part, definition) }
+      body_formatter = CSVFormatterBody.new(@doc, definition)
+      body_line = column_list.map { |part| body_formatter.public_send(part) }
       body_line.flatten
     end
 
     def build_column_list
-      column_list = [:fixed]
-      column_list += [:wrong_explicit_checksum] if @doc.wrong_explicit_checksum?
-      column_list += [:explicit_version] if @doc.explicit_version?
-      column_list += [:labels] unless @doc.labels.empty?
-      column_list += [:eref] unless @doc.eref.empty?
-      column_list += [:iref] if @doc.iref
-      column_list += [:attributes] unless @doc.attributes.empty?
-      column_list
+      [
+        [:wrong_explicit_checksum, @doc.wrong_explicit_checksum?],
+        [:explicit_version, @doc.explicit_version?],
+        [:labels, !@doc.labels.empty?],
+        [:eref, !@doc.eref.empty?],
+        [:iref, @doc.iref],
+        [:attributes, !@doc.attributes.empty?]
+      ].reduce([:fixed]) { |acc, elem| acc + (elem.fetch(1) ? [elem.first] : []) }
     end
   end
 end

data/lib/defmastership/csv_formatter_body.rb

@@ -3,41 +3,44 @@
 
 require('csv')
 
+require('defmastership/set_join_hack')
+
 module DefMastership
   # format lines per definition
   class CSVFormatterBody
-    def initialize(doc)
+    def initialize(doc, definition)
       @doc = doc
+      @definition = definition
     end
 
-    def fixed(definition)
-      [definition.type, definition.reference, definition.value, definition.sha256]
+    def fixed
+      [@definition.type, @definition.reference, @definition.value, @definition.sha256_short]
     end
 
-    def wrong_explicit_checksum(definition)
-      wrong_explicit_checksum = definition.wrong_explicit_checksum
+    def wrong_explicit_checksum
+      wrong_explicit_checksum = @definition.wrong_explicit_checksum
       wrong_explicit_checksum ? [wrong_explicit_checksum] : ['']
     end
 
-    def explicit_version(definition)
-      explicit_version = definition.explicit_version
+    def explicit_version
+      explicit_version = @definition.explicit_version
       explicit_version ? [explicit_version] : ['']
     end
 
-    def labels(definition)
-      [definition.labels.to_a.join("\n")]
+    def labels
+      [@definition.labels.join("\n")]
     end
 
-    def eref(definition)
-      @doc.eref.map { |key, _| definition.eref[key].join("\n") }
+    def eref
+      @doc.eref.map { |key,| @definition.eref.fetch(key, []).join("\n") }
     end
 
-    def iref(definition)
-      [definition.iref.join("\n")]
+    def iref
+      [@definition.iref.join("\n")]
     end
 
-    def attributes(definition)
-      @doc.attributes.map { |key, _| definition.attributes[key] }
+    def attributes
+      @doc.attributes.map { |key,| @definition.attributes.fetch(key, '') }
     end
   end
 end

data/lib/defmastership/csv_formatter_header.rb

@@ -27,7 +27,7 @@ module DefMastership
     end
 
     def eref
-      @doc.eref.map { |_, ref| ref[:prefix] }
+      @doc.eref.map { |_, ref| ref.fetch(:prefix) }
     end
 
     def iref