defmastership 1.0.11 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3085b336c6d1b3854964192456e63b586bb0841ca62be7a4e33b7a3f7e2b5e9
-  data.tar.gz: 190eb91c0e040f064044a9b720eeb737cf3a0064eb88c718f1f2f387d0edf47f
+  metadata.gz: 01a97f896ec1b0b88f80686290f5a0bf639ae7caeb4e4c48035e13221d3f21e2
+  data.tar.gz: 75d68f34285d4babe217a678204681399ef7aa11679810eb00a5eb95eb9771d8
 SHA512:
-  metadata.gz: f8c55be957d580ad9ab71f15f58be76a43fc3e2b169d7b8397383a1a6a128c93aac5c33eab85cdf3da584d005eb92699730f2ae3560947ad25f13e478f5bff1d
-  data.tar.gz: 8d7b95ad1db59a90e96f0caacc8040307366ae7be67baab172fe57f64c9101a065fef8718d8c2f123d03c808b1669aa406c05712872c05424b6de22150db6acf
+  metadata.gz: 2926efd086db703c7a4e03b516c833a237ffa4d484492af6e70f3ae54bd4de30e50abe7cd15bdc8330b62ed46b6ddc04e474790a9e33b6260bc58ecde2113bc7
+  data.tar.gz: 5849049e21fc4882f957d09b0068769a26140327700caf88698595e2688f37b1467cc5b962d279d39c945ce6d187447d9ef6d90d1c26828bd7e841dfc08a30e2

data/.rubocop.yml

@@ -62,3 +62,7 @@ RSpec/FilePath :
 
 RSpec/NestedGroups:
   Max: 4
+
+Layout/RedundantLineBreak:
+  Enabled: false
+  

data/defmastership.gemspec

@@ -34,7 +34,7 @@ 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', '~> 1.3')
+  s.add_development_dependency('rubocop', '1.13')
   s.add_development_dependency('rubocop-rake', '~> 0.5')
   s.add_development_dependency('rubocop-rspec', '~> 2.0')
   s.add_development_dependency('simplecov', '~> 0')

data/features/export.feature

@@ -116,6 +116,27 @@ Feature: The extract command
     And the stdout should not contain anything
     And the stderr should not contain anything
 
+  Scenario: Ignore definitions in example 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 successfully 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:
     """
@@ -291,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/features/rename_included_files.feature

@@ -73,7 +73,9 @@ Feature: The rename_included_files command
     :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"
@@ -85,7 +87,9 @@ Feature: The rename_included_files command
     :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

data/lib/defmastership.rb

@@ -6,6 +6,7 @@ require('defmastership/version')
 # Add requires for other files you add to your project here, so
 # you just need to require this one file in your bin file
 require('defmastership/constants')
+require('defmastership/parsing_state')
 require('defmastership/definition')
 require('defmastership/definition_parser')
 require('defmastership/filters')

data/lib/defmastership/change_ref_line_modifier.rb

@@ -28,7 +28,7 @@ module DefMastership
         to_template: '',
         next_ref: 0
       }
-      @in_literal = false
+      @parsing_state = ParsingState.new
     end
 
     def replace(method, line)
@@ -36,10 +36,10 @@ module DefMastership
     end
 
     def replace_refdef(line)
-      if in_literal(line)
-        line
-      else
+      if @parsing_state.enabled?(line)
         do_replace_refdef(line)
+      else
+        line
       end
     end
 
@@ -78,10 +78,5 @@ module DefMastership
     def hmerge(match)
       @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
   end
 end

data/lib/defmastership/comment_filter.rb

@@ -1,43 +1,10 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-# Add a class to handled asciidoctor comments
-module DefMastership
-  attr_reader :comment_filter
-
-  # Kind of proxy that Filters comments fome Asciidoctor document
-  class CommentFilter
-    def initialize
-      @in_multiline_comment = false
-    end
-
-    def accept?(line)
-      case line
-      when DMRegexp::SINGLE_LINE_COMMENT then false
-      when DMRegexp::MULTI_LINE_COMMENT_DELIM
-        @in_multiline_comment ^= true
-        false
-      else !@in_multiline_comment
-      end
-    end
-  end
-
-  @comment_filter = CommentFilter.new
-
-  def self.reset_comments
-    @comment_filter = CommentFilter.new
-    nil
-  end
-
-  def self.comment_filter
-    @comment_filter
-  end
-end
-
 # adding a method to string to figure out if a string is commented or
 # not.
 class String
   def commented?
-    !DefMastership.comment_filter.accept?(self)
+    !match(DefMastership::DMRegexp::SINGLE_LINE_COMMENT).nil?
   end
 end

data/lib/defmastership/constants.rb

@@ -6,8 +6,6 @@ module DefMastership
   module DMRegexp
     SINGLE_LINE_COMMENT = %r{^//[^/]}.freeze
 
-    MULTI_LINE_COMMENT_DELIM = %r{^////\s*$}.freeze
-
     DEF_BEFORE_REF = <<~'BEF'
       ^\s*
       \[\s*define\s*,
@@ -41,7 +39,6 @@ module DefMastership
                \s*(?<refname>[\w:_-]+)\s*,
                \s*\[(?<extrefs>[^\]]+)\]\s*\]/x.freeze
     BLOCK = /^--\s*$/.freeze
-    LITERAL_BLOCK = /^\.\.\.\.\s*$/.freeze
 
     IREF_DEF_BEF = 'defs:iref\[\s*'
     IREF_DEF_AFT = '\s*\]'
@@ -72,7 +69,6 @@ module DefMastership
     )
 
     public_constant :SINGLE_LINE_COMMENT,
-                    :MULTI_LINE_COMMENT_DELIM,
                     :DEF_BEFORE_REF,
                     :DEF_AFTER_REF,
                     :DEFINITION,
@@ -81,7 +77,6 @@ module DefMastership
                     :EREF_CONFIG,
                     :EREF_DEF,
                     :BLOCK,
-                    :LITERAL_BLOCK,
                     :IREF_DEF_BEF,
                     :IREF_DEF_AFT,
                     :IREF_DEF,

data/lib/defmastership/definition.rb

@@ -31,7 +31,7 @@ module DefMastership
     end
 
     def sha256
-      "~#{Digest::SHA2.new(256).hexdigest(value).split(//).last(8).join}"
+      "~#{Digest::SHA2.new(256).hexdigest(value).chars.last(8).join}"
     end
 
     def wrong_explicit_checksum

data/lib/defmastership/document.rb

@@ -16,19 +16,17 @@ module DefMastership
       @eref          = {}
       @iref          = false
       @attributes    = {}
-      @in_literal    = true
       @variables     = {}
+      @parsing_state = ParsingState.new
       @definition_parser = DefinitionParser.new(self)
     end
 
     def parse(lines)
-      lines.reject(&:commented?).each do |line|
-        (@in_literal ? FILTERS : FILTERS_IN_LITERAL).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
@@ -49,11 +47,6 @@ module DefMastership
       end
     end
 
-    def code_block_delimiter(_match, line)
-      @in_literal ^= true
-      line
-    end
-
     def add_new_definition(match, line)
       definition = Definition.new(match)
       @labels.merge(definition.labels)
@@ -116,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/filters.rb

@@ -6,12 +6,6 @@ module DefMastership
   Filter = Struct.new(:regexp, :event, :consumed_line)
   private_constant :Filter
 
-  FILTERS_IN_LITERAL = [
-    Filter.new(DMRegexp::LITERAL_BLOCK, :code_block_delimiter, false),
-    Filter.new(DMRegexp::WHATEVER,      :new_line,             true)
-  ].freeze
-  private_constant :FILTERS_IN_LITERAL
-
   FILTERS = [
     Filter.new(DMRegexp::VARIABLE_DEF,  :new_variable_def,     false),
     Filter.new(DMRegexp::VARIABLE_USE,  :new_variable_use,     false),
@@ -22,7 +16,6 @@ module DefMastership
     Filter.new(DMRegexp::ATTR_CONFIG,   :new_attribute_conf,   true),
     Filter.new(DMRegexp::ATTR_SET,      :new_attribute_value,  false),
     Filter.new(DMRegexp::BLOCK,         :block_delimiter,      true),
-    Filter.new(DMRegexp::LITERAL_BLOCK, :code_block_delimiter, true),
     Filter.new(DMRegexp::EMPTY_LINE,    :empty_line,           false),
     Filter.new(DMRegexp::WHATEVER,      :new_line,             true)
   ].freeze

data/lib/defmastership/parsing_state.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # Allow to know if we need to parse the line or simply ignore it
+  class ParsingState
+    def initialize
+      @last_disabling_line = nil
+    end
+
+    def enabled?(line)
+      return false if line.match(DMRegexp::SINGLE_LINE_COMMENT)
+
+      line = line.dup.chomp
+      if ['....', '----', '////'].include?(line)
+        if @last_disabling_line == line
+          @last_disabling_line = nil
+        elsif @last_disabling_line.nil?
+          @last_disabling_line = line
+        end
+      end
+      @last_disabling_line.nil?
+    end
+  end
+end

data/lib/defmastership/rename_included_files_line_modifier.rb

@@ -96,7 +96,7 @@ module DefMastership
 
         filename.gsub!("{#{varname}}", @variables[varname.to_sym])
       end
-      filename
+      filename.chomp
     end
 
     def complete_regexp_from(from)

data/lib/defmastership/version.rb

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

data/spec/unit/defmastership/comment_filter_spec.rb

@@ -3,124 +3,10 @@
 
 require('defmastership')
 
-RSpec.describe(DefMastership::CommentFilter) do
-  describe '.new' do
-    it { is_expected.not_to(be(nil)) }
-  end
-
-  describe '#accept?' do
-    subject(:comment_filter) { described_class.new }
-
-    context 'when no comment' do
-      it do
-        expect(comment_filter.accept?('whatever')).to(be(true))
-      end
-    end
-
-    context 'when single line comment' do
-      it do
-        expect(comment_filter.accept?('// whatever')).to(be(false))
-      end
-    end
-
-    context 'when bat formated single line comment' do
-      it do
-        expect(comment_filter.accept?('///')).to(be(true))
-      end
-    end
-
-    context 'when starting multiline comment' do
-      it do
-        expect(comment_filter.accept?('////')).to(be(false))
-      end
-    end
-
-    context 'when multiline comment' do
-      before do
-        comment_filter.accept?('////')
-      end
-
-      it do
-        expect(comment_filter.accept?('whatever')).to(be(false))
-      end
-    end
-
-    context 'when exiting multiline comment' do
-      before do
-        comment_filter.accept?('////')
-        comment_filter.accept?('something')
-      end
-
-      it do
-        expect(comment_filter.accept?('////')).to(be(false))
-      end
-    end
-
-    context 'when end of multiline comment' do
-      before do
-        comment_filter.accept?('////')
-        comment_filter.accept?('something')
-        comment_filter.accept?('////')
-      end
-
-      it do
-        expect(comment_filter.accept?('whatever')).to(be(true))
-      end
-    end
-  end
-
-  describe 'String .commented?' do
-    let(:comment_filter) do
-      instance_double(described_class, 'comment_filter')
-    end
-
-    before do
-      allow(DefMastership).to(
-        receive(:comment_filter)
-          .and_return(comment_filter)
-      )
-    end
-
-    context 'when not .commented?' do
-      before do
-        allow(comment_filter).to(receive(:accept?).with('blabla').and_return(true))
-        'blabla'.commented?
-      end
-
-      it { expect(DefMastership).to(have_received(:comment_filter)) }
-
-      it { expect(comment_filter).to(have_received(:accept?).with('blabla')) }
-
-      it { expect('blabla'.commented?).to(be(false)) }
-    end
-
-    context 'when .commented?' do
-      before do
-        allow(comment_filter).to(
-          receive(:accept?)
-            .with('blabla').and_return(false)
-        )
-      end
-
-      it do
-        expect('blabla'.commented?).to(be(true))
-      end
-    end
-  end
-
-  describe '#reset_comments' do
-    before do
-      '////'.commented?
-    end
-
-    it do
-      expect('whatever'.commented?).to(be(true))
-    end
-
-    it do
-      '////'.commented?
-      DefMastership.reset_comments
-      expect('whatever'.commented?).to(be(false))
-    end
+RSpec.describe(String) do
+  context 'when .commented?' do
+    it { expect('blabla'.commented?).to(be(false)) }
+    it { expect('//blabla'.commented?).to(be(true)) }
+    it { expect('///blabla'.commented?).to(be(false)) }
   end
 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

@@ -0,0 +1,62 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::ParsingState) do
+  subject(:parsing_state) do
+    described_class.new
+  end
+
+  describe '.new' do
+    it { is_expected.not_to(be(nil)) }
+  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") }
+
+      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)) }
+    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(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) }
+      end
+
+      it { expect(parsing_state.enabled?("////\n")).to(eq(true)) }
+    end
+  end
+end

data/spec/unit/defmastership/rename_included_files_line_modifier_spec.rb

@@ -110,32 +110,32 @@ RSpec.describe(DefMastership::RenameIncludedFilesLineModifier) do
         end
 
         it do
-          expect(includeschanger.replace('include::orig[]'))
-            .to(eq('include::dest[]'))
+          expect(includeschanger.replace("include::orig[]\n"))
+            .to(eq("include::dest[]\n"))
         end
 
         it do
-          includeschanger.replace('include::orig[]')
+          includeschanger.replace("include::orig[]\n")
           expect(File).to(have_received(:rename).with('orig', 'dest'))
         end
 
         it do
-          includeschanger.replace('include::orig[]')
+          includeschanger.replace("include::orig[]\n")
           expect(includeschanger).to(have_attributes(changes: [%w[orig dest]]))
         end
 
         it do
-          expect(includeschanger.replace('include::toto/orig[]'))
-            .to(eq('include::toto/dest[]'))
+          expect(includeschanger.replace("include::toto/orig[]\n"))
+            .to(eq("include::toto/dest[]\n"))
         end
 
         it do
-          includeschanger.replace('include::toto/orig[]')
+          includeschanger.replace("include::toto/orig[]\n")
           expect(File).to(have_received(:rename).with('toto/orig', 'toto/dest'))
         end
 
         it do
-          includeschanger.replace('include::toto/orig[]')
+          includeschanger.replace("include::toto/orig[]\n")
           expect(includeschanger).to(have_attributes(changes: [%w[toto/orig toto/dest]]))
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.16
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,7 @@ files:
 - lib/defmastership/filters.rb
 - lib/defmastership/line_modifier_base.rb
 - lib/defmastership/modifier_base.rb
+- lib/defmastership/parsing_state.rb
 - lib/defmastership/rename_included_files_line_modifier.rb
 - lib/defmastership/rename_included_files_modifier.rb
 - lib/defmastership/update_def_checksum_line_modifier.rb
@@ -234,6 +235,7 @@ files:
 - spec/unit/defmastership/definition_parser_spec.rb
 - spec/unit/defmastership/definition_spec.rb
 - spec/unit/defmastership/document_spec.rb
+- spec/unit/defmastership/parsing_state_spec.rb
 - spec/unit/defmastership/rename_included_files_line_modifier_spec.rb
 - spec/unit/defmastership/rename_included_files_modifier_spec.rb
 - spec/unit/defmastership/update_def_checksum_line_modifier_spec.rb