defmastership 1.0.1

data/config/rubocop.yml

@@ -0,0 +1,44 @@
+inherit_from: ../.rubocop.yml
+
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5.0
+
+Metrics/BlockLength:
+  Exclude:
+  # Ignore RSpec DSL
+    - spec/**/*
+  # Ignore gemspec DSL
+    - '*.gemspec'
+
+# Naming/FileName:
+#   Exclude:
+#     - Rakefile
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'sélect'
+
+# Prefer #kind_of? over #is_a?
+ClassCheck:
+  EnforcedStyle: kind_of?
+
+Security/Eval:
+  Exclude:
+    - Rakefile
+
+AlignHash:
+  EnforcedColonStyle: table
+
+MessageSpies:
+  EnforcedStyle: receive

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/defmastership.gemspec

@@ -0,0 +1,37 @@
+# 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'
+                  ]))
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 2.6'
+  s.name = 'defmastership'
+  s.version = DefMastership::VERSION
+  s.author = 'Jérôme Arbez-Gindre'
+  s.email = 'jeromearbezgindre@gmail.com'
+  s.licenses = 'Nonstandard'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Handling of references and definitions with asciidoctor'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths << 'lib'
+  s.extra_rdoc_files = ['README.rdoc', 'defmastership.rdoc']
+  s.rdoc_options << '--title defmastership' << '--main README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'defmastership'
+  s.add_development_dependency('aruba', '~> 1')
+  s.add_development_dependency('rake', '~> 13')
+  s.add_development_dependency('rdoc', '~> 6')
+  s.add_development_dependency('rspec', '~> 3')
+  s.add_development_dependency('rubocop', '~> 0')
+  s.add_development_dependency('rubocop-rspec', '~> 1')
+  s.add_development_dependency('simplecov', '~> 0')
+  s.add_runtime_dependency('aasm', '~> 5')
+  s.add_runtime_dependency('asciidoctor', '~> 2')
+  s.add_runtime_dependency('gli', '~> 2')
+end

data/defmastership.rdoc

@@ -0,0 +1,5 @@
+= defmastership
+
+Generate this with
+    defmastership _doc
+After you have described your command line interface

data/features/changeref.feature

@@ -0,0 +1,296 @@
+Feature: The changeref command
+  As a Responsible of definitions for a giventdocument
+  In order to make references reliable
+  I want defmastership to change reference for asciidoctor documents
+
+  Scenario: Change a definition 
+    Given a file named "changeref.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 thedoc.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: 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
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    """
+
+  Scenario: Change two definitions
+    Given a file named "changeref.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]
+    [define, requirement, TOTO-TEMP-XXX2]
+    """
+    When I run `defmastership changeref thedoc.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]
+    [define, requirement, TOTO-0124]
+    """
+
+  Scenario: Generate a table with changess
+    Given a file named "changeref.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]
+    [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
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    [define, requirement, TITI-TEMP-XXX2]
+    """
+    When I run `defmastership changeref thedoc.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: 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
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    [define, requirement, TITI-0000432]
+    """
+
+  Scenario: Change definitions in two files
+    Given a file named "changeref.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]
+    """
+    And a file named "thedoc2.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX2]
+    """
+    When I run `defmastership changeref 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]
+    """
+    And the file "thedoc2.adoc" should contain:
+    """
+    [define, requirement, TOTO-0124]
+    """
+
+  Scenario: Change a internal refs
+    Given a file named "changeref.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]
+    is the same as defs:iref[TOTO-TEMP-XXX2] and defs:iref[TOTO-TEMP-XXX1]
+    [define, requirement, TOTO-TEMP-XXX2]
+    is the same as defs:iref[TOTO-TEMP-XXX1]
+    """
+    When I run `defmastership changeref 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-0123]
+    is the same as defs:iref[TOTO-0124] and defs:iref[TOTO-0123]
+    [define, requirement, TOTO-0124]
+    is the same as defs:iref[TOTO-0123]
+    """
+
+  Scenario: Change definitions and iref in two files
+    Given a file named "changeref.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]
+    defs:iref[TOTO-TEMP-XXX2]
+    """
+    And a file named "thedoc2.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX2]
+    defs:iref[TOTO-TEMP-XXX1]
+    """
+    When I run `defmastership changeref 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]
+    defs:iref[TOTO-0124]
+    """
+    And the file "thedoc2.adoc" should contain:
+    """
+    [define, requirement, TOTO-0124]
+    defs:iref[TOTO-0123]
+    """
+
+  Scenario: Do not change definitions when in literal
+    Given a file named "changeref.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 thedoc.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: 123
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    ....
+    [define, requirement, TOTO-TEMP-XXX1]
+    ....
+    """
+
+

data/features/defmastership.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "defmastership"
+    Then the exit status should be 0

data/features/export.feature

@@ -0,0 +1,275 @@
+Feature: The extract command
+  As a Responsible of definitions
+  In order to make statistics on definitions
+  I want defmastership to extract definitions from asciidoctor documents
+
+  Scenario: Extract one definition to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line."
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with variable to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    :my_variable-with-dash: Variable content
+    :variable2: Toto
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement with variable: {my_variable-with-dash}.
+    {my_variable-with-dash} : {my_variable-with-dash} {variable2}.
+    Third line with {not_defined_variable}.
+    --
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value
+    requirement,TOTO-0001,"Exemple of multiline requirement with variable: Variable content.
+    Variable content : Variable content Toto.
+    Third line with {not_defined_variable}."
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+
+  Scenario: Extract some definitions to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    [define, something_else, TOTO-0003]
+    only one paragraphe.
+    with two sentences.
+    --
+    ignored multiline.
+    Second line.
+    --
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line."
+    something_else,TOTO-0003,"only one paragraphe.\nwith two sentences."
+    """
+    And the file "toto.csv" should not contain:
+    """
+    ignored multiline
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Ignore definitions in literal block
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    ....
+    [define, something_else, TOTO-0003]
+    only one line
+    ....
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should not contain:
+    """
+    something_else
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Ignore definitions in commment block
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    ////
+    [define, something_else, TOTO-0003]
+    only one line
+    ////
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should not contain:
+    """
+    something_else
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Handle mixes comment and literal blocks 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    ////
+    [define, whatever, TOTO-0003]
+    ----
+    only one line
+    ////
+    [define, something_else, TOTO-0003]
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    something_else
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract definition with labels 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001, [label1, label2]]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Labels
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.","label1
+    label2"
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with external ref to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    :eref-implements-prefix: Participate to:
+    :eref-implements-url:    ./the_other_document.html
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Participate to: ./the_other_document.html
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.","SYSTEM-0012
+    SYSTEM-0014"
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with external ref without url to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    :eref-implements-prefix: Participate to:
+    :eref-implements-url:    none
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Participate to:
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.","SYSTEM-0012
+    SYSTEM-0014"
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with external ref to CSV without URL
+    Given a file named "toto.adoc" with:
+    """
+    :eref-implements-prefix: Participate to:
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
+    """
+    When I run `defmastership export toto.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Participate to:
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.","SYSTEM-0012
+    SYSTEM-0014"
+    """
+
+  Scenario: Extract one definition with internal ref to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].
+    --
+    please see defs:iref[TOTO-0002]
+    """
+    When I run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Internal links
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].","TOTO-0001
+    TOTO-0123
+    TOTO-0002"
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with attributes to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    :attr-verifiedby-prefix: Verified by:
+    :attr-criticity-prefix: Criticity:
+    [define, requirement, TOTO-0001]
+    One single line.
+
+    something else.
+    defs:attribute[verifiedby, Beautiful Test]
+    defs:attribute[criticity, Very cool]
+    """
+    When I run `defmastership export toto.adoc`
+    And the stdout should not contain anything
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Verified by:,Criticity:
+    requirement,TOTO-0001,One single line.,Beautiful Test,Very cool
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything