defmastership 1.0.4 → 1.0.9

data/features/modify.feature

@@ -0,0 +1,165 @@
+Feature: The modify command
+  As a Responsible of definitions for a given document
+  In order to manage to applu predefined modifications
+  I want defmastership to apply automatic modifications
+
+  Scenario: Changes with one 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 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:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [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:
+    """
+    ---
+    :toto:
+      :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 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:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    """
+
+  Scenario: Generate a table with changes
+    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]
+    [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
+    And the file "changes.csv" should contain:
+    """
+    Modifier,Was,Becomes
+    temp-references,TOTO-TEMP-XXX1,TOTO-0123
+    temp-references,TOTO-TEMP-XXX2,TOTO-0124
+    """
+
+  Scenario: Apply two modifcations
+    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
+    :tata_or_titi:
+      :type: change_ref
+      :config:
+        :from_regexp: "(?<tata_or_titi>TATA|TITI)-TEMP-[X\\d]{4}"
+        :to_template: "%<tata_or_titi>s-%<next_ref>07d"
+        :next_ref: 432
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    [define, requirement, TITI-TEMP-XXX2]
+    """
+    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:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    :tata_or_titi:
+      :type: change_ref
+      :config:
+        :from_regexp: "(?<tata_or_titi>TATA|TITI)-TEMP-[X\\d]{4}"
+        :to_template: "%<tata_or_titi>s-%<next_ref>07d"
+        :next_ref: 433
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    [define, requirement, TITI-0000432]
+    """

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/lib/defmastership.rb

@@ -7,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,35 @@
+# 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)
+      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
+  end
+end

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

@@ -2,12 +2,10 @@
 # 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 = {
@@ -24,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)
@@ -70,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]})" \
@@ -83,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