defmastership 1.0.5 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a306f9f76179edc5687278ed6a5c1c1c2b3943ad01cd3925cdcb7d7e1466ac2
-  data.tar.gz: dc3afb4b34d6e64e41ff0207242518317e3fe7615474ec17ca87f378436014df
+  metadata.gz: '0498ff0b39ccfc024d4988c4c1137726e827e841a1750b921bc4c8d3be06db62'
+  data.tar.gz: af1b86530d440a08417bac712f15e30db40aa01b07ea312b1d7d4f125dccef5c
 SHA512:
-  metadata.gz: 6434c67db6ccf69c1f837b0ac664512d06563ded9d22faf9a890585ae3e2c3b072d10740fbaba91a23075244a21101801e1366e41ef2fe348c070dfb3467f92f
-  data.tar.gz: 6c511e6138122b454a69a0a2ba27c51abb28b55d09ce0b0a39652a91927f4cd29f2ea015407ff7f4d9f9c9e9eee297e5f43955528fccd1a07fc7caaee48c2a0e
+  metadata.gz: ec47e5182f9586be6102eed5be90c459db84e54e334cbe867bee2be4bf34645f8a91d7e08aea0b89a4733e3ca6089c90f96e1a6969d8f6b329034cc4486bd8b2
+  data.tar.gz: 625fb3fb76aaac4189ce12cd2f9af3bfa83491a2ecbbe5192bb35ffe43e121e54a27a318afb60ad938a8e58818bccef38896b919d5b9678ea0af4565c09aab66

data/.rubocop.yml

@@ -19,7 +19,7 @@ AllCops:
 
 Style/Copyright:
   Enabled: true
-  Notice: 'Copyright (\(c\) )?2020 Jerome Arbez-Gindre'
+  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
   AutocorrectNotice: '# Copyright (c) 2020 Jerome Arbez-Gindre'
 
 Lint/ConstantResolution: # Not available ins rubocop 0.81

data/bin/defmastership

@@ -2,7 +2,6 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('asciidoctor')
 require('csv')
 require('defmastership')
 require('gli')
@@ -50,47 +49,59 @@ module DefMastership
 
     desc 'Export the definition database in CSV'
     arg_name 'asciidoctor_files'
-    command :export do |c|
+    command :export, :exp, :e do |c|
       c.flag(%i[separator sep s], default_value: ',', desc: 'CSV separator')
+      c.switch(%i[no-fail], desc: 'Exit succes even in case of wrong explicit checksum')
+
       c.action do |_global_options, options, args|
-        doc = Asciidoctor.load_file(args[0], safe: :unsafe, parse: false)
-        # FIXME: also escape ifdef, ifndef, ifeval and endif directives
-        # FIXME: do this more carefully by reading line by line; if input
-        # differs by output by leading backslash, restore original line
-        lines = doc.reader.read_lines
         my_doc = DefMastership::Document.new
-        my_doc.parse(lines)
+        my_doc.parse_file_with_preprocessor(args[0])
 
         output_file = args[0].sub(/\.adoc$/, '.csv')
 
         DefMastership::CSVFormatter.new(my_doc, options['separator']).export_to(output_file)
+
+        if my_doc.wrong_explicit_checksum?
+          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})")
+          end
+          exit 1 unless options[:"no-fail"]
+        end
       end
     end
 
-    desc 'Change temp references to definitive references'
+    desc 'Apply one or more modifications'
     arg_name 'asciidoctor_files'
-    command :changeref do |c|
-      c.flag(%i[change-summary s], default_value: 'changes.csv', desc: 'generates a change summary in a CSV file')
-
-      c.flag(%i[change-file f], default_value: 'changeref.yaml', desc: 'set the change specification file')
+    command :modify, :mod, :m do |c|
+      c.flag(
+        %i[modifications mod m],
+        must_match: /(?:[\w-]+)(?:,[\w-]+)*/,
+        default_value: 'all',
+        desc: 'comma separated list of modifications to apply'
+      )
+      c.flag(%i[modifications-file mf], default_value: 'modifications.yml', desc: 'modifications description file')
+      c.flag(%i[changes-summary s], default_value: 'changes.csv', desc: 'generates a change summary in a CSV file')
 
       c.action do |_global_options, options, args|
-        ref_changer = ProjectRefChanger.new(
-          YAML.load_file(options['change-file']),
+        changer = BatchModifier.new(
+          YAML.load_file(options[:'modifications-file']),
           args.map { |afile| [afile, File.open(afile).read] }.to_h
         )
 
-        ref_changer.replace_all
+        changer.apply(options[:modifications])
 
-        ref_changer.adoc_texts.each do |adoc_file, adoc_text|
+        changer.adoc_texts.each do |adoc_file, adoc_text|
           File.open(adoc_file, 'w') { |f| f.write(adoc_text) }
         end
-        File.open(options['change-file'], 'w') { |f| f.write(ref_changer.yaml_config) }
 
-        unless options['change-summary'].nil?
-          CSV.open(options['change-summary'], 'wb') do |csv|
-            csv << %w[Was Becomes]
-            ref_changer.changes.each { |row| csv << row }
+        File.open(options[:'modifications-file'], 'w') { |f| f.write(changer.config.to_yaml) }
+
+        unless options['changes-summary'].nil?
+          CSV.open(options['changes-summary'], 'wb') do |csv|
+            csv << %w[Modifier Was Becomes]
+            changer.changes.each { |row| csv << row }
           end
         end
       end

data/cucumber.yml

@@ -1,2 +1,2 @@
 ---
-default: --publish
+default: --publish --format pretty

data/defmastership.gemspec

@@ -3,12 +3,17 @@
 
 # Ensure we require the local version and not one we might have
 # installed already
-require(File.join([
-                    File.dirname(__FILE__),
-                    'lib',
-                    'defmastership',
-                    'version.rb'
-                  ]))
+require(
+  File.join(
+    [
+      File.dirname(__FILE__),
+      'lib',
+      'defmastership',
+      'version.rb'
+    ]
+  )
+)
+
 Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.5'
   s.name = 'defmastership'
@@ -30,6 +35,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rdoc', '~> 6')
   s.add_development_dependency('rspec', '~> 3')
   s.add_development_dependency('rubocop', '~> 1.3')
+  s.add_development_dependency('rubocop-rake', '~> 0.5')
   s.add_development_dependency('rubocop-rspec', '~> 2.0')
   s.add_development_dependency('simplecov', '~> 0')
   s.add_runtime_dependency('aasm', '~> 5')

data/features/changeref.feature

@@ -4,57 +4,32 @@ Feature: The changeref command
   I want defmastership to change reference for asciidoctor documents
 
   Scenario: Change a definition 
-    Given a file named "changeref.yaml" with:
+    Given a file named "modifications.yml" with:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :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 changeref thedoc.adoc`
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
-    And the file "changeref.yaml" should contain:
+    And the file "modifications.yml" should contain:
     """
     ---
     :toto:
-      :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 a definition with yaml file parameter 
-    Given a file named "pouet.yaml" with:
-    """
-    ---
-    :toto:
-      :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 changeref --change-file=pouet.yaml thedoc.adoc`
-    Then the stdout should not contain anything
-    And the stderr should not contain anything
-    And the file "pouet.yaml" should contain:
-    """
-    ---
-    :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 124
+      :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:
     """
@@ -62,29 +37,33 @@ Feature: The changeref command
     """
 
   Scenario: Change two definitions
-    Given a file named "changeref.yaml" with:
+    Given a file named "modifications.yml" with:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :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 run `defmastership changeref thedoc.adoc`
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
-    And the file "changeref.yaml" should contain:
+    And the file "modifications.yml" should contain:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 125
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 125
     """
     And the file "thedoc.adoc" should contain:
     """
@@ -92,77 +71,51 @@ Feature: The changeref command
     [define, requirement, TOTO-0124]
     """
 
-  Scenario: Generate a table with changess
-    Given a file named "changeref.yaml" with:
+  Scenario: Change definitions with variable from regexp
+    Given a file named "modifications.yml" with:
     """
     ---
-    :toto:
-      :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 run `defmastership changeref --change-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:
-    """
-    Was,Becomes
-    TOTO-TEMP-XXX1,TOTO-0123
-    TOTO-TEMP-XXX2,TOTO-0124
-    """
-
-  Scenario: Change two definitions with two schema
-    Given a file named "changeref.yaml" with:
-    """
-    ---
-    :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
     :tata_or_titi:
-      :from_regexp: "(?<tata_or_titi>TATA|TITI)-TEMP-[X\\d]{4}"
-      :to_template: "%<tata_or_titi>s-%<next_ref>07d"
-      :next_ref: 432
+      :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]
+    [define, requirement, TATA-TEMP-X2X3]
     """
-    When I run `defmastership changeref thedoc.adoc`
+    When I successfully run `defmastership modify --modifications tata_or_titi thedoc.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
-    And the file "changeref.yaml" should contain:
+    And the file "modifications.yml" should contain:
     """
     ---
-    :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 124
     :tata_or_titi:
-      :from_regexp: "(?<tata_or_titi>TATA|TITI)-TEMP-[X\\d]{4}"
-      :to_template: "%<tata_or_titi>s-%<next_ref>07d"
-      :next_ref: 433
+      :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: 434
     """
     And the file "thedoc.adoc" should contain:
     """
-    [define, requirement, TOTO-0123]
     [define, requirement, TITI-0000432]
+    [define, requirement, TATA-0000433]
     """
 
   Scenario: Change definitions in two files
-    Given a file named "changeref.yaml" with:
+    Given a file named "modifications.yml" with:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :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:
     """
@@ -172,16 +125,18 @@ Feature: The changeref command
     """
     [define, requirement, TOTO-TEMP-XXX2]
     """
-    When I run `defmastership changeref thedoc.adoc thedoc2.adoc`
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc thedoc2.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
-    And the file "changeref.yaml" should contain:
+    And the file "modifications.yml" should contain:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 125
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 125
     """
     And the file "thedoc.adoc" should contain:
     """
@@ -193,13 +148,15 @@ Feature: The changeref command
     """
 
   Scenario: Change a internal refs
-    Given a file named "changeref.yaml" with:
+    Given a file named "modifications.yml" with:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :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:
     """
@@ -208,7 +165,7 @@ Feature: The changeref command
     [define, requirement, TOTO-TEMP-XXX2]
     is the same as defs:iref[TOTO-TEMP-XXX1]
     """
-    When I run `defmastership changeref thedoc.adoc`
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
     And the file "thedoc.adoc" should contain:
@@ -220,13 +177,15 @@ Feature: The changeref command
     """
 
   Scenario: Change definitions and iref in two files
-    Given a file named "changeref.yaml" with:
+    Given a file named "modifications.yml" with:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :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:
     """
@@ -238,17 +197,9 @@ Feature: The changeref command
     [define, requirement, TOTO-TEMP-XXX2]
     defs:iref[TOTO-TEMP-XXX1]
     """
-    When I run `defmastership changeref thedoc.adoc thedoc2.adoc`
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc thedoc2.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
-    And the file "changeref.yaml" should contain:
-    """
-    ---
-    :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 125
-    """
     And the file "thedoc.adoc" should contain:
     """
     [define, requirement, TOTO-0123]
@@ -261,13 +212,15 @@ Feature: The changeref command
     """
 
   Scenario: Do not change definitions when in literal
-    Given a file named "changeref.yaml" with:
+    Given a file named "modifications.yml" with:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :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:
     """
@@ -275,16 +228,18 @@ Feature: The changeref command
     [define, requirement, TOTO-TEMP-XXX1]
     ....
     """
-    When I run `defmastership changeref thedoc.adoc`
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
-    And the file "changeref.yaml" should contain:
+    And the file "modifications.yml" should contain:
     """
     ---
     :toto:
-      :from_regexp: TOTO-TEMP-[X\d]{4}
-      :to_template: TOTO-%<next_ref>04d
-      :next_ref: 123
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
     """
     And the file "thedoc.adoc" should contain:
     """
@@ -292,5 +247,3 @@ Feature: The changeref command
     [define, requirement, TOTO-TEMP-XXX1]
     ....
     """
-
-