defmastership 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615339b09506e076db9c98a773e115daaa9914bafebef1029af8c4c9e8266dc0
-  data.tar.gz: 14b7cf352d495dc847cdd9fbdfff6abd821ebc0e6a8f6f2334ecb16c7bc87de2
+  metadata.gz: 01a97f896ec1b0b88f80686290f5a0bf639ae7caeb4e4c48035e13221d3f21e2
+  data.tar.gz: 75d68f34285d4babe217a678204681399ef7aa11679810eb00a5eb95eb9771d8
 SHA512:
-  metadata.gz: ebd3eb769920a15442d8a048e55b5fb124aa4a5c2916a85378d5d9f07c20b29b160c94b12e783d5d4a4f89f9aa5d80342065d533b66c6972de74eb1adaecbc59
-  data.tar.gz: ad72f426a240eda86b517a9d5e7bd8f28cc037acef3a7a391880a2e9c4e4432309a962b810086aed081c97bdc63a2fd4709dd4de261828e520bd93649b7cb55e
+  metadata.gz: 2926efd086db703c7a4e03b516c833a237ffa4d484492af6e70f3ae54bd4de30e50abe7cd15bdc8330b62ed46b6ddc04e474790a9e33b6260bc58ecde2113bc7
+  data.tar.gz: 5849049e21fc4882f957d09b0068769a26140327700caf88698595e2688f37b1467cc5b962d279d39c945ce6d187447d9ef6d90d1c26828bd7e841dfc08a30e2

data/features/export.feature

@@ -130,7 +130,7 @@ Feature: The extract command
     ----
     """
     When I successfully run `defmastership export toto.adoc`
-    Then the file "toto.csv" should contain:
+    Then the file "toto.csv" should not contain:
     """
     something_else
     """
@@ -312,3 +312,72 @@ Feature: The extract command
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
+
+  Scenario: Extract one definition with example in it
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    [example]
+    ----
+    [define, requirement, TOTO-002]
+    not a real definition
+    ----
+    --
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,"[example]
+    ----
+    [define, requirement, TOTO-002]
+    not a real definition
+    ----",~8f20a443
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with single line comment in it
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    // comment
+    --
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,// comment,~b0b506c3
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with multi line comment or literal in it
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    ////
+    multiline comment
+    ////
+    ....
+    literal
+    ....
+    --
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,"////
+    multiline comment
+    ////
+    ....
+    literal
+    ....",~7eb3c490
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything

data/lib/defmastership/document.rb

@@ -22,15 +22,11 @@ module DefMastership
     end
 
     def parse(lines)
-      lines.reject(&:commented?).each do |line|
-        next unless @parsing_state.enabled?(line)
-
-        FILTERS.each do |filter|
-          next unless line.match(filter.regexp)
-
-          line = generate_event(filter.event, Regexp.last_match, line)
-
-          break if filter.consumed_line
+      lines.each do |line|
+        if @parsing_state.enabled?(line)
+          apply_filters(line)
+        else
+          generate_event(:new_line, nil, line)
         end
       end
     end
@@ -113,6 +109,16 @@ module DefMastership
 
     private
 
+    def apply_filters(line)
+      FILTERS.each do |filter|
+        next unless line.match(filter.regexp)
+
+        line = generate_event(filter.event, Regexp.last_match, line)
+
+        break if filter.consumed_line
+      end
+    end
+
     def generate_event(event, match, line)
       if respond_to?(event)
         line = public_send(event, match, line)

data/lib/defmastership/parsing_state.rb

@@ -9,8 +9,10 @@ module DefMastership
     end
 
     def enabled?(line)
+      return false if line.match(DMRegexp::SINGLE_LINE_COMMENT)
+
       line = line.dup.chomp
-      if ['....', '////'].include?(line)
+      if ['....', '----', '////'].include?(line)
         if @last_disabling_line == line
           @last_disabling_line = nil
         elsif @last_disabling_line.nil?

data/lib/defmastership/version.rb

@@ -2,6 +2,6 @@
 # frozen_string_literal: true
 
 module DefMastership
-  VERSION = '1.0.15'
+  VERSION = '1.0.16'
   public_constant :VERSION
 end

data/spec/unit/defmastership/document_spec.rb

@@ -115,6 +115,49 @@ RSpec.describe(DefMastership::Document) do
         it { expect(definition).to(have_received(:<<).with('b')) }
       end
 
+      context 'when complete definition with content including ----' do
+        let(:input_lines) do
+          [
+            '[define, requirement, TOTO-0001]',
+            '--',
+            '----',
+            'a',
+            'b',
+            '----',
+            '--',
+            'not included'
+          ]
+        end
+
+        before do
+          allow(definition).to(receive(:<<).and_return(definition))
+          document.parse(input_lines)
+        end
+
+        it { expect(definition).to(have_received(:<<).twice.with('----')) }
+        it { expect(definition).to(have_received(:<<).with('a')) }
+        it { expect(definition).to(have_received(:<<).with('b')) }
+      end
+
+      context 'when complete definition with single line comment' do
+        let(:input_lines) do
+          [
+            '[define, requirement, TOTO-0001]',
+            '--',
+            '// comment',
+            '--',
+            'not included'
+          ]
+        end
+
+        before do
+          allow(definition).to(receive(:<<).and_return(definition))
+          document.parse(input_lines)
+        end
+
+        it { expect(definition).to(have_received(:<<).with('// comment')) }
+      end
+
       context 'when definition with one paragraph' do
         let(:input_lines) do
           [

data/spec/unit/defmastership/parsing_state_spec.rb

@@ -13,33 +13,47 @@ RSpec.describe(DefMastership::ParsingState) do
   end
 
   describe '#enabled_with?' do
+    context 'when single line commment' do
+      it { expect(parsing_state.enabled?("//whatever\n")).to(eq(false)) }
+    end
+
     context 'when starting' do
       it { expect(parsing_state.enabled?("whatever\n")).to(eq(true)) }
+      it { expect(parsing_state.enabled?("----\n")).to(eq(false)) }
       it { expect(parsing_state.enabled?("....\n")).to(eq(false)) }
       it { expect(parsing_state.enabled?("////\n")).to(eq(false)) }
       it { expect(parsing_state.enabled?('....')).to(eq(false)) }
     end
 
     context 'when disabled' do
-      before { parsing_state.enabled?("....\n") }
+      before { parsing_state.enabled?("----\n") }
 
       it { expect(parsing_state.enabled?("whatever\n")).to(eq(false)) }
+      it { expect(parsing_state.enabled?("----\n")).to(eq(true)) }
+      it { expect(parsing_state.enabled?("....\n")).to(eq(false)) }
       it { expect(parsing_state.enabled?("////\n")).to(eq(false)) }
-      it { expect(parsing_state.enabled?("....\n")).to(eq(true)) }
     end
 
     context 'with intricated disables starting with "...."' do
       before do
-        ["....\n", "////\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
+        ["....\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
       end
 
       it { expect(parsing_state.enabled?("----\n")).to(eq(false)) }
       it { expect(parsing_state.enabled?("....\n")).to(eq(true)) }
     end
 
+    context 'with intricated disables starting with "----"' do
+      before do
+        ["....\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
+      end
+
+      it { expect(parsing_state.enabled?("....\n")).to(eq(true)) }
+    end
+
     context 'with intricated disables starting with "////"' do
       before do
-        ["////\n", "....\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
+        ["////\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
       end
 
       it { expect(parsing_state.enabled?("////\n")).to(eq(true)) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.16
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba