defmastership 1.0.6 → 1.0.11

data/features/export.feature

@@ -15,62 +15,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     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 WRONG explicit checksum to CSV 
-    Given a file named "toto.adoc" with:
-    """
-    [define, requirement, TOTO-0001(babe1234)]
-    def one
-    """
-    When I successfully run `defmastership export toto.adoc`
-    Then the file "toto.csv" should contain:
-    """
-    Type,Reference,Value,sha256,Wrong explicit checksum
-    requirement,TOTO-0001,def one,d27cb5c3,babe1234
-    """
-    And the stdout should not contain anything
-    And the stderr should not contain anything
-
-  Scenario: Extract two definitions with one WRONG explicit checksum to CSV 
-    Given a file named "toto.adoc" with:
-    """
-    [define, requirement, TOTO-0001(d27cb5c3)]
-    def one
-
-    [define, requirement, TOTO-0002(babe1234)]
-    def two
-    """
-    When I successfully run `defmastership export toto.adoc`
-    Then the file "toto.csv" should contain:
-    """
-    Type,Reference,Value,sha256,Wrong explicit checksum
-    requirement,TOTO-0001,def one,d27cb5c3,\"\"
-    requirement,TOTO-0002,def two,b80e1be5,babe1234
-    """
-    And the stdout should not contain anything
-    And the stderr should not contain anything
-
-  Scenario: Extract one definition with explicit checksum to CSV 
-    Given a file named "toto.adoc" with:
-    """
-    [define, requirement, TOTO-0001(b86dcbde)]
-    --
-    Exemple of multiline requirement.
-    Second line.
-    --
-    """
-    When I successfully run `defmastership export toto.adoc`
-    Then the file "toto.csv" should contain:
-    """
-    Type,Reference,Value,sha256
-    requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde
+    Second line.",~b86dcbde
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
@@ -87,9 +34,9 @@ Feature: The extract command
     When I successfully run `defmastership export --separator=';' toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type;Reference;Value;sha256
+    Type;Reference;Value;Checksum
     requirement;TOTO-0001;"Exemple of multiline requirement.
-    Second line.";b86dcbde
+    Second line.";~b86dcbde
     """
 
   Scenario: Extract one definition with variable to CSV 
@@ -107,10 +54,10 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement with variable: Variable content.
     Variable content : Variable content Toto.
-    Third line with {not_defined_variable}.",3bf370ed
+    Third line with {not_defined_variable}.",~3bf370ed
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
@@ -135,11 +82,11 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256
+    Type,Reference,Value,Checksum
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde
+    Second line.",~b86dcbde
     something_else,TOTO-0003,"only one paragraphe.
-    with two sentences.",4761e172
+    with two sentences.",~4761e172
     """
     And the file "toto.csv" should not contain:
     """
@@ -225,9 +172,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Labels
+    Type,Reference,Value,Checksum,Labels
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"label1
+    Second line.",~b86dcbde,"label1
     label2"
     """
     And the stdout should not contain anything
@@ -248,9 +195,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Participate to:
+    Type,Reference,Value,Checksum,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"SYSTEM-0012
+    Second line.",~b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
     And the stdout should not contain anything
@@ -271,9 +218,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Participate to:
+    Type,Reference,Value,Checksum,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"SYSTEM-0012
+    Second line.",~b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
     And the stdout should not contain anything
@@ -295,9 +242,9 @@ Feature: The extract command
     And the stderr should not contain anything
     And the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Participate to:
+    Type,Reference,Value,Checksum,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.",b86dcbde,"SYSTEM-0012
+    Second line.",~b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
 
@@ -314,9 +261,9 @@ Feature: The extract command
     When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Internal links
+    Type,Reference,Value,Checksum,Internal links
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].",059b7188,"TOTO-0001
+    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].",~059b7188,"TOTO-0001
     TOTO-0123
     TOTO-0002"
     """
@@ -339,8 +286,8 @@ Feature: The extract command
     And the stdout should not contain anything
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,sha256,Verified by:,Criticity:
-    requirement,TOTO-0001,One single line.,554b0ff5,Beautiful Test,Very cool
+    Type,Reference,Value,Checksum,Verified by:,Criticity:
+    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

data/features/modify.feature

@@ -3,7 +3,7 @@ Feature: The modify command
   In order to manage to applu predefined modifications
   I want defmastership to apply automatic modifications
 
-  Scenario: Change one modifier
+  Scenario: Changes with one modifier
     Given a file named "modifications.yml" with:
     """
     ---
@@ -36,6 +36,28 @@ Feature: The modify command
     [define, requirement, TOTO-0123]
     """
 
+
+  Scenario: Change with wrong modifier
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    """
+    When I run `defmastership modify --modifications wrong-modification thedoc.adoc`
+    Then it should fail with:
+    """
+    error: wrong-modification is not a known modification
+    """
+
   Scenario: Make modifications with yaml file parameter 
     Given a file named "pouet.yml" with:
     """

data/lib/defmastership.rb

@@ -22,3 +22,9 @@ require('defmastership/change_ref_line_modifier')
 
 require('defmastership/rename_included_files_modifier')
 require('defmastership/rename_included_files_line_modifier')
+
+require('defmastership/update_def_checksum_modifier')
+require('defmastership/update_def_checksum_line_modifier')
+
+require('defmastership/update_def_version_modifier')
+require('defmastership/update_def_version_line_modifier')

data/lib/defmastership/batch_modifier.rb

@@ -26,6 +26,8 @@ module DefMastership
     private
 
     def modifier_from(modif)
+      raise(ArgumentError, "#{modif} is not a known modification") if @config[modif.to_sym].nil?
+
       class_name = "#{@config[modif.to_sym][:type].split('_').map(&:capitalize).join}Modifier"
       DefMastership.const_get(class_name).new(@config[modif.to_sym][:config])
     end

data/lib/defmastership/change_ref_line_modifier.rb

@@ -66,12 +66,13 @@ module DefMastership
       regexp_str =
         "(?<before>#{REGEXP_FROM[const][:before]})" \
         "(?<from>#{from})" \
+        "#{DMRegexp::DEF_VERSION_AND_CHECKSUM}" \
         "(?<after>#{REGEXP_FROM[const][:after]})"
       Regexp.new(regexp_str, Regexp::EXTENDED)
     end
 
     def text_with(match, replacement)
-      match[:before] + replacement + match[:after]
+      match[:before] + replacement + (match[:version_and_checksum] || '') + match[:after]
     end
 
     def hmerge(match)

data/lib/defmastership/change_ref_modifier.rb

@@ -8,8 +8,8 @@ module DefMastership
       %i[replace_refdef replace_irefs]
     end
 
-    def line_modifier_class
-      ChangeRefLineModifier
+    def new_line_modifier(config, _adoc_texts)
+      ChangeRefLineModifier.from_config(config)
     end
   end
 end

data/lib/defmastership/constants.rb

@@ -20,10 +20,12 @@ module DefMastership
       (,\s*\[\s*(?<labels>.*?)\s*\])?\s*\]
     AFT
 
-    DEF_CHECKSUM = '(\((?<explicit_checksum>[[:alnum:]]+)\))?'
+    DEF_VERSION_AND_CHECKSUM = '(?<version_and_checksum>' \
+                               '\((?<explicit_version>[^~]+)?(?<explicit_checksum>~[[:alnum:]]+)?\)' \
+                               ')?'
 
     DEFINITION = Regexp.new(
-      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_CHECKSUM}#{DEF_AFTER_REF}",
+      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
       Regexp::EXTENDED
     )
 

data/lib/defmastership/csv_formatter.rb

@@ -8,18 +8,13 @@ require('defmastership/csv_formatter_body')
 module DefMastership
   # to export a CSV file
   class CSVFormatter
-    COLUMN_LIST1 = %i[fixed wrong_explicit_checksum labels eref iref attributes].freeze
-    COLUMN_LIST2 = %i[fixed labels eref iref attributes].freeze
-    private_constant :COLUMN_LIST1
-    private_constant :COLUMN_LIST2
-
     def initialize(doc, sep = ',')
       @doc = doc
       @sep = sep
     end
 
     def export_to(output_file)
-      column_list = @doc.wrong_explicit_checksum? ? COLUMN_LIST1 : COLUMN_LIST2
+      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) }
@@ -39,5 +34,16 @@ module DefMastership
       body_line = column_list.map { |part| body_formatter.public_send(part, definition) }
       body_line.reduce(:+)
     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
+    end
   end
 end

data/lib/defmastership/csv_formatter_body.rb

@@ -19,8 +19,13 @@ module DefMastership
       wrong_explicit_checksum ? [wrong_explicit_checksum] : ['']
     end
 
+    def explicit_version(definition)
+      explicit_version = definition.explicit_version
+      explicit_version ? [explicit_version] : ['']
+    end
+
     def labels(definition)
-      @doc.labels.empty? ? [] : [definition.labels.to_a.join("\n")]
+      [definition.labels.to_a.join("\n")]
     end
 
     def eref(definition)
@@ -28,13 +33,11 @@ module DefMastership
     end
 
     def iref(definition)
-      @doc.iref ? [definition.iref.join("\n")] : []
+      [definition.iref.join("\n")]
     end
 
     def attributes(definition)
-      @doc.attributes.map do |key, _|
-        definition.attributes[key]
-      end
+      @doc.attributes.map { |key, _| definition.attributes[key] }
     end
   end
 end

data/lib/defmastership/csv_formatter_header.rb

@@ -11,13 +11,17 @@ module DefMastership
     end
 
     def fixed
-      %w[Type Reference Value sha256]
+      %w[Type Reference Value Checksum]
     end
 
     def wrong_explicit_checksum
       @doc.wrong_explicit_checksum? ? ['Wrong explicit checksum'] : []
     end
 
+    def explicit_version
+      @doc.explicit_version? ? ['Version'] : []
+    end
+
     def labels
       @doc.labels.empty? ? [] : %w[Labels]
     end

data/lib/defmastership/definition.rb

@@ -6,19 +6,19 @@ require 'digest'
 module DefMastership
   # DefMastership definition: contains all data of a definition
   class Definition
-    attr_reader :type, :reference, :lines, :labels, :eref, :iref, :attributes
+    attr_reader :type, :reference, :lines, :labels, :eref, :iref, :attributes, :explicit_version
 
     def initialize(match)
       @type = match[:type]
       @reference = match[:reference]
       @lines = []
       @labels = Set.new
-      labels = match[:labels]
-      @labels.merge(labels.split(/\s*,\s*/).to_set) if labels
+      @labels.merge(match[:labels].split(/\s*,\s*/).to_set) if match[:labels]
       @eref = Hash.new([])
       @iref = []
       @attributes = {}
       @explicit_checksum = match[:explicit_checksum]
+      @explicit_version = match[:explicit_version]
     end
 
     def <<(new_line)
@@ -31,7 +31,7 @@ module DefMastership
     end
 
     def sha256
-      Digest::SHA2.new(256).hexdigest(value).split(//).last(8).join
+      "~#{Digest::SHA2.new(256).hexdigest(value).split(//).last(8).join}"
     end
 
     def wrong_explicit_checksum

data/lib/defmastership/document.rb

@@ -1,6 +1,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require('asciidoctor')
+
 module DefMastership
   # Contains the content of a DefMastership document: mainly definitions
 
@@ -16,16 +18,37 @@ module DefMastership
       @attributes    = {}
       @in_literal    = true
       @variables     = {}
-
       @definition_parser = DefinitionParser.new(self)
     end
 
+    def parse(lines)
+      lines.reject(&:commented?).each do |line|
+        (@in_literal ? FILTERS : FILTERS_IN_LITERAL).each do |filter|
+          next unless line.match(filter.regexp)
+
+          line = generate_event(filter.event, Regexp.last_match, line)
+
+          break if filter.consumed_line
+        end
+      end
+    end
+
+    def parse_file_with_preprocessor(adoc_file)
+      parse(Asciidoctor.load_file(adoc_file, safe: :unsafe, parse: false).reader.read_lines)
+    end
+
     def wrong_explicit_checksum?
       @definitions.reduce(false) do |res, definition|
         res || !definition.wrong_explicit_checksum.nil?
       end
     end
 
+    def explicit_version?
+      @definitions.reduce(false) do |res, definition|
+        res || !definition.explicit_version.nil?
+      end
+    end
+
     def code_block_delimiter(_match, line)
       @in_literal ^= true
       line
@@ -38,6 +61,10 @@ module DefMastership
       line
     end
 
+    def ref_to_def(ref)
+      @definitions.find { |definition| definition.reference == ref }
+    end
+
     def add_line(_match, line)
       @definitions.last << line
       line
@@ -45,17 +72,12 @@ module DefMastership
 
     def new_eref_setup(match, line)
       @eref[match[:refname].to_sym] ||= {}
-
-      @eref[match[:refname].to_sym][match[:symb].to_sym] =
-        match[:value]
+      @eref[match[:refname].to_sym][match[:symb].to_sym] = match[:value]
       line
     end
 
     def new_eref_def(match, line)
-      @definitions.last.add_eref(
-        match[:refname].to_sym,
-        match[:extrefs]
-      )
+      @definitions.last.add_eref(match[:refname].to_sym, match[:extrefs])
       line
     end
 
@@ -73,10 +95,7 @@ module DefMastership
     end
 
     def new_attribute_value(match, line)
-      @definitions.last.set_attribute(
-        match[:attr].to_sym,
-        match[:value]
-      )
+      @definitions.last.set_attribute(match[:attr].to_sym, match[:value])
       line
     end
 
@@ -86,26 +105,13 @@ module DefMastership
     end
 
     def new_variable_use(_match, line)
-      new_line = line.dup
       line.scan(DMRegexp::VARIABLE_USE) do |_|
         varname = Regexp.last_match[:varname]
         next if @variables[varname.to_sym].nil?
 
-        new_line.gsub!("{#{varname}}", @variables[varname.to_sym])
-      end
-      new_line
-    end
-
-    def parse(lines)
-      lines.reject(&:commented?).each do |line|
-        (@in_literal ? FILTERS : FILTERS_IN_LITERAL).each do |filter|
-          next unless line.match(filter.regexp)
-
-          line = generate_event(filter.event, Regexp.last_match, line)
-
-          break if filter.consumed_line
-        end
+        line = line.gsub("{#{varname}}", @variables[varname.to_sym])
       end
+      line
     end
 
     private