defmastership 1.0.2 → 1.0.7

data/features/rename_included_files.feature

@@ -0,0 +1,121 @@
+
+Feature: The rename_included_files command
+  As a Responsible of definitions for a given document.
+  In order to easy traceability with included files,
+  I want defmastership to change filename of included files to reflect
+  reference.
+
+  Scenario: do NOT change the filename of a file NOT included in a definition
+    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:
+    """
+    include::any_path/one_file.png[]
+    """
+    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:
+    """
+    include::any_path/one_file.png[]
+    """
+    And the file "any_path/one_file.png" should exist
+
+  Scenario: change the filename of a file included in a definition
+    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[]
+    """
+    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[]
+    """
+    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:
+    """
+    ---
+    :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:
+    """
+    :any: one
+    :path: two
+    [define, requirement, TOTO-WHATEVER-123]
+    include::{any}_{path}/one_file.png[]
+    """
+    And a directory named "one_two"
+    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
+    :path: two
+    [define, requirement, TOTO-WHATEVER-123]
+    include::{any}_{path}/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And the file "one_two/one_file.png" should not exist
+    And the file "one_two/TOTO-WHATEVER-123_one_file.png" should exist
+
+  Scenario: DO NOT change the filename again and again
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :cancel_if_match: TOTO-WHATEVER
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::any_path/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And a directory named "any_path"
+    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]
+    include::any_path/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And the file "any_path/one_file.png" should not exist
+    And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
+

data/features/step_definitions/defmastership_steps.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 When(/^I get help for "([^"]*)"$/) do |app_name|

data/features/support/env.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('aruba/cucumber')

data/lib/defmastership.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('defmastership/version')
@@ -6,10 +7,21 @@ require('defmastership/version')
 # you just need to require this one file in your bin file
 require('defmastership/constants')
 require('defmastership/definition')
+require('defmastership/definition_parser')
+require('defmastership/filters')
 require('defmastership/document')
 require('defmastership/comment_filter')
 require('defmastership/csv_formatter')
 
-require('defmastership/ref_changer')
-require('defmastership/batch_changer')
-require('defmastership/project_ref_changer')
+require('defmastership/modifier_base')
+require('defmastership/line_modifier_base')
+require('defmastership/batch_modifier')
+
+require('defmastership/change_ref_modifier')
+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')

data/lib/defmastership/batch_modifier.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # Change references from temporary to definitive with multiple RefChangers
+  class BatchModifier
+    attr_reader :config, :adoc_texts, :changes
+
+    def initialize(config, adoc_texts)
+      @config = config
+      @adoc_texts = adoc_texts
+      @changes = []
+    end
+
+    def apply(modifs)
+      modifs.split(/\s*,\s*/).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
+      end
+    end
+
+    private
+
+    def modifier_from(modif)
+      class_name = "#{@config[modif.to_sym][:type].split('_').map(&:capitalize).join}Modifier"
+      DefMastership.const_get(class_name).new(@config[modif.to_sym][:config])
+    end
+  end
+end

data/lib/defmastership/{ref_changer.rb → change_ref_line_modifier.rb}

@@ -1,12 +1,11 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 module DefMastership
-  # Change references from temporary to definitive
-  class RefChanger
-    attr_reader :changes
-
-    def self.from_h(hash)
-      new.from_h(hash)
+  # Change references from temporary to definitive with multiple RefChangers
+  class ChangeRefLineModifier < LineModifierBase
+    def self.from_config(hash)
+      new.from_config(hash)
     end
 
     REGEXP_FROM = {
@@ -23,32 +22,17 @@ module DefMastership
     private_constant :REGEXP_FROM
 
     def initialize
-      @h = {
+      super
+      @config = {
         from_regexp: '',
         to_template: '',
         next_ref: 0
       }
-      @changes = []
       @in_literal = false
     end
 
-    def method_missing(method_name, *args, &block)
-      return @h[method_name] if @h[method_name]
-
-      super
-    end
-
-    def respond_to_missing?(method_name, *args)
-      @h[method_name] || super
-    end
-
-    def from_h(hash)
-      @h.merge!(hash)
-      self
-    end
-
-    def to_h
-      @h
+    def replace(method, line)
+      public_send("replace_#{method}".to_sym, line)
     end
 
     def replace_refdef(line)
@@ -69,6 +53,15 @@ module DefMastership
 
     private
 
+    def do_replace_refdef(line)
+      line.gsub(regexp_from(:definition, from_regexp)) do
+        replacement = to_template % hmerge(Regexp.last_match)
+        changes << [Regexp.last_match[:from], replacement]
+        @config[:next_ref] += 1
+        text_with(Regexp.last_match, replacement)
+      end
+    end
+
     def regexp_from(const, from)
       regexp_str =
         "(?<before>#{REGEXP_FROM[const][:before]})" \
@@ -82,21 +75,12 @@ module DefMastership
     end
 
     def hmerge(match)
-      @h.merge(Hash[match.names.map(&:to_sym).zip(match.captures)])
+      @config.merge(match.names.map(&:to_sym).zip(match.captures).to_h)
     end
 
     def in_literal(line)
       @in_literal ^= true if line.chomp == '....'
       @in_literal
     end
-
-    def do_replace_refdef(line)
-      line.gsub(regexp_from(:definition, from_regexp)) do
-        replacement = to_template % hmerge(Regexp.last_match)
-        changes << [Regexp.last_match[:from], replacement]
-        @h[:next_ref] += 1
-        text_with(Regexp.last_match, replacement)
-      end
-    end
   end
 end

data/lib/defmastership/change_ref_modifier.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # Change all refs of a given project
+  class ChangeRefModifier < ModifierBase
+    def replacements
+      %i[replace_refdef replace_irefs]
+    end
+
+    def new_line_modifier(config, _adoc_texts)
+      ChangeRefLineModifier.from_config(config)
+    end
+  end
+end

data/lib/defmastership/comment_filter.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 # Add a class to handled asciidoctor comments

data/lib/defmastership/constants.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 module DefMastership
@@ -18,8 +19,11 @@ module DefMastership
       \s*
       (,\s*\[\s*(?<labels>.*?)\s*\])?\s*\]
     AFT
+
+    DEF_CHECKSUM = '(\((?<explicit_checksum>[[:alnum:]]+)\))?'
+
     DEFINITION = Regexp.new(
-      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_AFTER_REF}",
+      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_CHECKSUM}#{DEF_AFTER_REF}",
       Regexp::EXTENDED
     )
 
@@ -55,6 +59,16 @@ module DefMastership
 
     WHATEVER = //.freeze
 
+    INCLUDE_KEYWORD  = '\binclude::'
+    INCLUDE_PATH     = '(?<path>.*/)?'
+    INCLUDE_FILENAME = '(?<filename>[^\\/]+)'
+    INCLUDE_OPTIONS  = '\[(?<options>[\]]*)\]'
+
+    INCLUDE = Regexp.new(
+      INCLUDE_KEYWORD + INCLUDE_PATH + INCLUDE_FILENAME + INCLUDE_OPTIONS,
+      Regexp::EXTENDED
+    )
+
     public_constant :SINGLE_LINE_COMMENT,
                     :MULTI_LINE_COMMENT_DELIM,
                     :DEF_BEFORE_REF,

data/lib/defmastership/csv_formatter.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('csv')
@@ -7,35 +8,35 @@ require('defmastership/csv_formatter_body')
 module DefMastership
   # to export a CSV file
   class CSVFormatter
-    COLUMN_LIST = %w[fixed labels eref iref attributes].freeze
-    private_constant :COLUMN_LIST
+    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)
+    def initialize(doc, sep = ',')
       @doc = doc
-      @header_formatter = CSVFormatterHeader.new(@doc)
-      @body_formatter = CSVFormatterBody.new(@doc)
+      @sep = sep
     end
 
     def export_to(output_file)
-      CSV.open(output_file, 'w:ISO-8859-1') do |csv|
-        csv << header
-        @doc.definitions.each { |definition| csv << body(definition) }
+      column_list = @doc.wrong_explicit_checksum? ? COLUMN_LIST1 : COLUMN_LIST2
+      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) }
       end
     end
 
-    def header
-      header_line =
-        COLUMN_LIST.map do |part|
-          @header_formatter.public_send("#{part}_header".to_sym)
-        end
+    private
+
+    def header(column_list)
+      header_formatter = CSVFormatterHeader.new(@doc)
+      header_line = column_list.map { |part| header_formatter.public_send(part) }
       header_line.reduce(:+)
     end
 
-    def body(definition)
-      body_line =
-        COLUMN_LIST.map do |part|
-          @body_formatter.public_send("#{part}_body".to_sym, definition)
-        end
+    def body(definition, column_list)
+      body_formatter = CSVFormatterBody.new(@doc)
+      body_line = column_list.map { |part| body_formatter.public_send(part, definition) }
       body_line.reduce(:+)
     end
   end

data/lib/defmastership/csv_formatter_body.rb

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('csv')
@@ -9,23 +10,28 @@ module DefMastership
       @doc = doc
     end
 
-    def fixed_body(definition)
-      [definition.type, definition.reference, definition.value]
+    def fixed(definition)
+      [definition.type, definition.reference, definition.value, definition.sha256]
     end
 
-    def labels_body(definition)
+    def wrong_explicit_checksum(definition)
+      wrong_explicit_checksum = definition.wrong_explicit_checksum
+      wrong_explicit_checksum ? [wrong_explicit_checksum] : ['']
+    end
+
+    def labels(definition)
       @doc.labels.empty? ? [] : [definition.labels.to_a.join("\n")]
     end
 
-    def eref_body(definition)
+    def eref(definition)
       @doc.eref.map { |key, _| definition.eref[key].join("\n") }
     end
 
-    def iref_body(definition)
+    def iref(definition)
       @doc.iref ? [definition.iref.join("\n")] : []
     end
 
-    def attributes_body(definition)
+    def attributes(definition)
       @doc.attributes.map do |key, _|
         definition.attributes[key]
       end