defmastership 1.0.13 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e81c3ab45ea06b43ad767d8ab89231e05eacca67dee259a8d968d515da6adb6
-  data.tar.gz: bb2abcc00dea06b45b35373eec37923236770310cd70842770be8d1ac92149e7
+  metadata.gz: 942362543576801349518b2d73e49abb5cfb076b246df05a7e28fe86814b506e
+  data.tar.gz: 1a351eadc8b3583df8f31b590225a4b8e5207d7db089b3a62ac644f03fa02c08
 SHA512:
-  metadata.gz: 3df9a3fd838a4600b66690fd30fedcbf28b8e3af6d2afbe8d1ef813ea8b3b163b854f16ff3f219550a24b9624302ea0d32b8a043f90047070425d39e1b017cc4
-  data.tar.gz: 5b2b9c5105d548c2cba1571ad36830453bec01664d7ab4edec71a1132b30bb0651dd4d5a197f1d4c13a2a09d0ea9e69b2b0f3af975f0611de32b1cd52737c92d
+  metadata.gz: 6151951967b1d4b0e2108b2b11f101045780d6ec3f8ba4505078dbb1c240f2795bd56cce0f177187c58b2d8dacd3d63c1cfce6ca8969cb5f54d972d32d61e42b
+  data.tar.gz: 6836a23ffae998a9a1b54716941b0e9bb661e81f18a4422ad984af1ee41218b685ba937c108298f8a02cf348af434ddd1138f81c5644017193c5d72d6ad2cbdd

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:
     """

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/document.rb

@@ -16,14 +16,16 @@ 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 @parsing_state.enabled?(line)
+
+        FILTERS.each do |filter|
           next unless line.match(filter.regexp)
 
           line = generate_event(filter.event, Regexp.last_match, line)
@@ -49,11 +51,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)

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

@@ -10,7 +10,7 @@ module DefMastership
 
     def enabled?(line)
       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.13'
+  VERSION = '1.0.14'
   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/parsing_state_spec.rb

@@ -17,6 +17,7 @@ RSpec.describe(DefMastership::ParsingState) 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
 
@@ -26,9 +27,10 @@ RSpec.describe(DefMastership::ParsingState) do
       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 satrting with "...."' do
+    context 'with intricated disables starting with "...."' do
       before do
         ["....\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
       end
@@ -37,12 +39,20 @@ RSpec.describe(DefMastership::ParsingState) do
       it { expect(parsing_state.enabled?("....\n")).to(eq(true)) }
     end
 
-    context 'with intricated disables satrting with "----"' do
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.14
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-05 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