defmastership 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86894e5b058e9344802e4d9286dc006ecde31268bb23abecd02ebdf1d9bce26c
-  data.tar.gz: 9ff11bf910435bc4702bba12c85672597001d08cb5fa995b3d0f93e0a098a693
+  metadata.gz: c6fbf5098c8ab70e422d9c158c0a28cd876de25cfd159a131b0ddefc5f1eca86
+  data.tar.gz: 8717156666df342a45994bb455b0cc58f09fc1da9b31c48cd0d4b36a40c528b6
 SHA512:
-  metadata.gz: 5c2b91c3c566808164b74fb5c8f28a4ae44dd0946bd344a872ad9119b3d4b27ee640a4ff2e59b38099f4a5d467b27e9c940bdda446580b42ebce1f9e24540f96
-  data.tar.gz: '08e981d6f11a50f377d442202133ec518d2fbcbb05328880086338964d690a368ae0e42ec2fc6f1681e7d9b5917ebed670d3563cd705522a3bf654650f95ef63'
+  metadata.gz: 6afcfd48186a2f89426e62007dc068711ea36e26a8ecf9b9c56428a351eabb6a89be58872a96de30c9a87ccdc71366e685fd8486469a3465e661ae490c0925be
+  data.tar.gz: 275587475f39f39bbd311cdf9a0fb1cc9cdcb30c6cf766b44d9b1ff64ac9a8feb2c9117f4903f8eb806b3e73594b6c2e5e63876038483429cabd7eb66fb93575

data/.gitignore

@@ -2,3 +2,5 @@
 /tmp
 /coverage
 defmastership-0.0.1.gem
+/Gemfile.lock
+/pkg/

data/.gitlab-ci.yml

@@ -4,7 +4,6 @@ default:
     - apt-get update
     - ruby -v
     - which ruby
-    - rm Gemfile.lock
     - gem install bundler --no-document
     - bundle install --jobs $(nproc) "${FLAGS[@]}"
 

data/.rubocop.yml

@@ -18,8 +18,9 @@ AllCops:
   DisplayCopNames: true
 
 Style/Copyright:
-  Enabled: false
-  # AutocorrectNotice: 'Copyright 2020 by Jérôme Arbez-Gindre'
+  Enabled: true
+  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
+  AutocorrectNotice: '# Copyright (c) 2020 Jerome Arbez-Gindre'
 
 Lint/ConstantResolution: # Not available ins rubocop 0.81
   Enabled: false

data/Gemfile

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 source('https://rubygems.org')

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Jérôme Arbez-Gindre, and the individual contributors
+to DefMastership.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -1,3 +1,4 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 require('rake/clean')
@@ -15,8 +16,7 @@ end
 
 spec = eval(::File.read('defmastership.gemspec'))
 
-Gem::PackageTask.new(spec) do |pkg|
-end
+Gem::PackageTask.new(spec)
 CUKE_RESULTS = 'features_results.html'
 CLEAN << CUKE_RESULTS
 

data/bin/defmastership

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('asciidoctor')
 require('csv')
 require('defmastership')
 require('gli')
@@ -49,46 +49,59 @@ module DefMastership
 
     desc 'Export the definition database in CSV'
     arg_name 'asciidoctor_files'
-    command :export do |c|
-      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
+    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|
         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).export_to(output_file)
+        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

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

data/defmastership.gemspec

@@ -1,20 +1,26 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
 # 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'
   s.version = DefMastership::VERSION
   s.author = 'Jérôme Arbez-Gindre'
   s.email = 'jeromearbezgindre@gmail.com'
-  s.licenses = 'Nonstandard'
+  s.licenses = ['MIT']
   s.homepage = 'https://gitlab.com/jjag/defmastership/'
   s.platform = Gem::Platform::RUBY
   s.summary = 'Handling of references and definitions with asciidoctor'
@@ -28,8 +34,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rdoc', '~> 6')
   s.add_development_dependency('rspec', '~> 3')
-  s.add_development_dependency('rubocop', '0.91')
-  s.add_development_dependency('rubocop-rspec', '~> 1')
+  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')
   s.add_runtime_dependency('asciidoctor', '~> 2')

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]
     ....
     """
-
-