defmastership 1.0.15 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615339b09506e076db9c98a773e115daaa9914bafebef1029af8c4c9e8266dc0
-  data.tar.gz: 14b7cf352d495dc847cdd9fbdfff6abd821ebc0e6a8f6f2334ecb16c7bc87de2
+  metadata.gz: 29225577d47450033d4ea2c9715ab51cb2025318ff26da38435c11900ff0cb52
+  data.tar.gz: a36cb1eb3b8c45cb14b74200d43163edd1907bcfe7ed2a54d15f4f1ebd341454
 SHA512:
-  metadata.gz: ebd3eb769920a15442d8a048e55b5fb124aa4a5c2916a85378d5d9f07c20b29b160c94b12e783d5d4a4f89f9aa5d80342065d533b66c6972de74eb1adaecbc59
-  data.tar.gz: ad72f426a240eda86b517a9d5e7bd8f28cc037acef3a7a391880a2e9c4e4432309a962b810086aed081c97bdc63a2fd4709dd4de261828e520bd93649b7cb55e
+  metadata.gz: bb97db7204c4665f53c5f57e03737e31a88373a928ce4157f912938b84feff1b3b7f260365fa210bab905b47eb87c336e259e91d1a77d73ace80e84f8152d464
+  data.tar.gz: 4c359dbf1017c365d9c00faf7617233e3793093dba327d39982cebd7dabd68a7b5af0a999568c91775cd16a2a8af9cc544a67fdf3acedf92d65120269c372d18

data/.gitignore

@@ -4,3 +4,4 @@
 defmastership-0.0.1.gem
 /Gemfile.lock
 /pkg/
+/.ruby-version

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 default:
-  image: ruby:2.5
+  image: ruby:3.2
   before_script:
     - apt-get update
     - ruby -v
@@ -7,14 +7,45 @@ default:
     - gem install bundler --no-document
     - bundle install --jobs $(nproc) "${FLAGS[@]}"
 
-cucumber:
+bdd:
   script:
     - bundle exec rake features
 
-rspec:
+unit tests:
   script:
     - bundle exec rake spec
 
 rubocop:
   script:
     - bundle exec rake rubocop
+
+bdd ruby2.7:
+  image: ruby:2.7
+  script:
+    - bundle exec rake features
+
+bdd ruby3.0:
+  image: ruby:3.0
+  script:
+    - bundle exec rake features
+
+bdd ruby3.1:
+  image: ruby:3.1
+  script:
+    - bundle exec rake features
+
+unit tests ruby2.7:
+  image: ruby:2.7
+  script:
+    - bundle exec rake spec
+
+unit tests ruby3.0:
+  image: ruby:3.0
+  script:
+    - bundle exec rake spec
+
+unit tests ruby3.1:
+  image: ruby:3.1
+  script:
+    - bundle exec rake spec
+

data/.rubocop.yml

@@ -10,17 +10,19 @@
 # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
 
 require:
+  - rubocop-performance
   - rubocop-rspec
+  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   EnabledByDefault: true
   DisplayCopNames: true
 
 Style/Copyright:
   Enabled: true
   Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
-  AutocorrectNotice: '# Copyright (c) 2020 Jerome Arbez-Gindre'
+  AutocorrectNotice: '# Copyright (c) 2023 Jerome Arbez-Gindre'
 
 Lint/ConstantResolution: # Not available ins rubocop 0.81
   Enabled: false
@@ -29,7 +31,10 @@ Style/DocumentationMethod:
   Enabled: false
 
 Style/StringHashKeys :
-  Enabled: false
+  Enabled: true
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
 
 Style/MissingElse:
   EnforcedStyle: case
@@ -55,14 +60,17 @@ Style/ConstantVisibility :
 
 # rubocop-rspec options
 RSpec/MessageExpectation :
-  Enabled: false
+  Enabled: true
 
 RSpec/FilePath :
-  Enabled: false
+  Enabled: true
 
 RSpec/NestedGroups:
   Max: 4
 
 Layout/RedundantLineBreak:
   Enabled: false
-  
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+

data/Rakefile

@@ -1,12 +1,12 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require('cucumber')
+require('cucumber/rake/task')
 require('rake/clean')
+require('rdoc/task')
 require('rubygems')
 require('rubygems/package_task')
-require('rdoc/task')
-require('cucumber')
-require('cucumber/rake/task')
 
 Rake::RDocTask.new do |rd|
   rd.main = 'README.rdoc'
@@ -14,40 +14,54 @@ Rake::RDocTask.new do |rd|
   rd.title = 'Your application title'
 end
 
-spec = eval(::File.read('defmastership.gemspec'))
+spec = eval(File.read('defmastership.gemspec'))
 
 Gem::PackageTask.new(spec)
 CUKE_RESULTS = 'features_results.html'
 CLEAN << CUKE_RESULTS
 
 desc('Run features')
-::Cucumber::Rake::Task.new(:features) do |t|
-  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
-  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = ['features'] +
+         ['--format', 'html'] +
+         ['-o', CUKE_RESULTS] +
+         ['--format', 'progress'] +
+         ['-x']
+  opts += ['--tags', ENV.fetch('TAGS').split.join(' or ')] if ENV['TAGS']
   t.cucumber_opts = opts
   t.fork = false
 end
 
 desc('Run features tagged as work-in-progress (@wip)')
-::Cucumber::Rake::Task.new('features:wip') do |t|
-  tag_opts = ' --tags ~@pending' \
-             ' --tags @wip'
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} "\
-                    "--format pretty -x -s#{tag_opts}"
+Cucumber::Rake::Task.new('features:wip') do |t|
+  t.cucumber_opts = ['features'] +
+                    ['--format', 'html'] +
+                    ['-o', CUKE_RESULTS] +
+                    ['--format', 'pretty'] +
+                    ['-x'] +
+                    ['-s'] +
+                    ['--tags', '@wip and not @pending']
   t.fork = false
 end
 
+desc('Test all features')
 task(cucumber: :features)
+
+desc('Test only WIP features')
 task(wip: 'features:wip')
 
 require('bundler/gem_tasks')
 
 require('rspec/core/rake_task')
 
-::RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec)
 
 require('rubocop/rake_task')
 
-::RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+  task.requires << 'rubocop-rake'
+end
 
-task(default: %i[spec features rubocop])
+task(default: %i[rubocop spec features])

data/bin/defmastership

@@ -67,7 +67,7 @@ module DefMastership
 
             warn("warning: #{definition.reference} has a wrong explicit checksum (should be #{definition.sha256})")
           end
-          exit 1 unless options[:"no-fail"]
+          exit 1 unless options[:'no-fail']
         end
       end
     end
@@ -87,16 +87,16 @@ module DefMastership
       c.action do |_global_options, options, args|
         changer = BatchModifier.new(
           YAML.load_file(options[:'modifications-file']),
-          args.map { |afile| [afile, File.open(afile).read] }.to_h
+          args.to_h { |afile| [afile, File.read(afile)] }
         )
 
         changer.apply(options[:modifications])
 
         changer.adoc_texts.each do |adoc_file, adoc_text|
-          File.open(adoc_file, 'w') { |f| f.write(adoc_text) }
+          File.write(adoc_file, adoc_text)
         end
 
-        File.open(options[:'modifications-file'], 'w') { |f| f.write(changer.config.to_yaml) }
+        File.write(options[:'modifications-file'], changer.config.to_yaml)
 
         unless options['changes-summary'].nil?
           CSV.open(options['changes-summary'], 'wb') do |csv|

data/defmastership.gemspec

@@ -14,31 +14,36 @@ require(
   )
 )
 
-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 = ['MIT']
-  s.homepage = 'https://gitlab.com/jjag/defmastership/'
-  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', '1.13')
-  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')
-  s.add_runtime_dependency('gli', '~> 2')
+Gem::Specification.new do |spec|
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+  spec.required_ruby_version = '>= 2.7'
+  spec.name = 'defmastership'
+  spec.version = DefMastership::VERSION
+  spec.author = 'Jérôme Arbez-Gindre'
+  spec.email = 'jeromearbezgindre@gmail.com'
+  spec.licenses = ['MIT']
+  spec.homepage = 'https://gitlab.com/jjag/defmastership/'
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = 'Handling of references and definitions with asciidoctor'
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths << 'lib'
+  spec.extra_rdoc_files = ['README.rdoc', 'defmastership.rdoc']
+  spec.rdoc_options << '--title defmastership' << '--main README.rdoc' << '-ri'
+  spec.bindir = 'bin'
+  spec.executables << 'defmastership'
+  spec.add_development_dependency('aruba', '~> 2')
+  spec.add_development_dependency('cucumber', '~> 8')
+  spec.add_development_dependency('rake', '~> 13')
+  spec.add_development_dependency('rdoc', '~> 6')
+  spec.add_development_dependency('rspec', '~> 3')
+  spec.add_development_dependency('rubocop', '1.50')
+  spec.add_development_dependency('rubocop-performance', '~> 1.17')
+  spec.add_development_dependency('rubocop-rake', '~> 0.6')
+  spec.add_development_dependency('rubocop-rspec', '~> 2.22')
+  spec.add_development_dependency('simplecov', '~> 0')
+  spec.add_runtime_dependency('aasm', '~> 5')
+  spec.add_runtime_dependency('asciidoctor', '~> 2')
+  spec.add_runtime_dependency('gli', '~> 2')
 end

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

@@ -18,7 +18,7 @@ module DefMastership
         @adoc_texts = modifier.do_modifications(@adoc_texts)
         @config[modif.to_sym][:config] = modifier.config
         modifier.changes.each do |change|
-          @changes << [modif] + change
+          @changes << ([modif] + change)
         end
       end
     end

data/lib/defmastership/change_ref_line_modifier.rb

@@ -1,6 +1,9 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require 'defmastership/constants'
+require 'defmastership/line_modifier_base'
+
 module DefMastership
   # Change references from temporary to definitive with multiple RefChangers
   class ChangeRefLineModifier < LineModifierBase

data/lib/defmastership/change_ref_modifier.rb

@@ -1,6 +1,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require 'defmastership/modifier_base'
+
 module DefMastership
   # Change all refs of a given project
   class ChangeRefModifier < ModifierBase

data/lib/defmastership/csv_formatter.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 require('csv')
-require('defmastership/csv_formatter_header')
 require('defmastership/csv_formatter_body')
+require('defmastership/csv_formatter_header')
 
 module DefMastership
   # to export a CSV file
@@ -15,7 +15,7 @@ module DefMastership
 
     def export_to(output_file)
       column_list = build_column_list
-      CSV.open(output_file, 'w:ISO-8859-1', { col_sep: @sep }) do |csv|
+      CSV.open(output_file, 'w:ISO-8859-1', col_sep: @sep) do |csv|
         csv << header(column_list)
         @doc.definitions.each { |definition| csv << body(definition, column_list) }
       end
@@ -26,13 +26,13 @@ module DefMastership
     def header(column_list)
       header_formatter = CSVFormatterHeader.new(@doc)
       header_line = column_list.map { |part| header_formatter.public_send(part) }
-      header_line.reduce(:+)
+      header_line.flatten
     end
 
     def body(definition, column_list)
       body_formatter = CSVFormatterBody.new(@doc)
       body_line = column_list.map { |part| body_formatter.public_send(part, definition) }
-      body_line.reduce(:+)
+      body_line.flatten
     end
 
     def build_column_list

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

@@ -16,14 +16,21 @@ module DefMastership
 
       adoc_texts =
         replacements.reduce(adoc_texts) do |texts, method|
-          texts.transform_values do |text|
-            text.lines.map { |line| line_modifier.public_send(method, line) }.join
-          end
+          transform_values(texts, line_modifier, method)
         end
 
       @config = line_modifier.config
       @changes = line_modifier.changes
       adoc_texts
     end
+
+    private
+
+    def transform_values(texts, line_modifier, method)
+      texts.transform_values do |text|
+        text.lines.map { |line| line_modifier.public_send(method, line) }
+            .join
+      end
+    end
   end
 end

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.17'
   public_constant :VERSION
 end

data/lib/defmastership.rb

@@ -5,27 +5,22 @@ 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/batch_modifier')
+require('defmastership/change_ref_line_modifier')
+require('defmastership/change_ref_modifier')
+require('defmastership/comment_filter')
 require('defmastership/constants')
-require('defmastership/parsing_state')
+require('defmastership/csv_formatter')
 require('defmastership/definition')
 require('defmastership/definition_parser')
-require('defmastership/filters')
 require('defmastership/document')
-require('defmastership/comment_filter')
-require('defmastership/csv_formatter')
-
-require('defmastership/modifier_base')
+require('defmastership/filters')
 require('defmastership/line_modifier_base')
-require('defmastership/batch_modifier')
-
-require('defmastership/change_ref_modifier')
-require('defmastership/change_ref_line_modifier')
-
-require('defmastership/rename_included_files_modifier')
+require('defmastership/modifier_base')
+require('defmastership/parsing_state')
 require('defmastership/rename_included_files_line_modifier')
-
-require('defmastership/update_def_checksum_modifier')
+require('defmastership/rename_included_files_modifier')
 require('defmastership/update_def_checksum_line_modifier')
-
-require('defmastership/update_def_version_modifier')
+require('defmastership/update_def_checksum_modifier')
 require('defmastership/update_def_version_line_modifier')
+require('defmastership/update_def_version_modifier')

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('bundler/setup')
-require('aruba/rspec')
 require('aasm/rspec')
+require('aruba/rspec')
+require('bundler/setup')
 
 # formatter = [SimpleCov::Formatter::HTMLFormatter]
 # SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatter)

data/spec/unit/{defmastership → def_mastership}/batch_modifier_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe(DefMastership::BatchModifier) do
   end
 
   describe '.new' do
-    it { is_expected.not_to(be(nil)) }
+    it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(config: config)) }
 
     it do
@@ -114,9 +114,10 @@ RSpec.describe(DefMastership::BatchModifier) do
 
     context 'with wrong modification' do
       it do
-        expect { batchmodifier.apply('wrong-modification') }.to(
-          raise_error(ArgumentError, 'wrong-modification is not a known modification')
-        )
+        expect { batchmodifier.apply('wrong-modification') }
+          .to(
+            raise_error(ArgumentError, 'wrong-modification is not a known modification')
+          )
       end
     end
   end

data/spec/unit/{defmastership → def_mastership}/change_ref_line_modifier_spec.rb

@@ -7,12 +7,16 @@ RSpec.describe(DefMastership::ChangeRefLineModifier) do
   subject(:refchanger) { described_class.new }
 
   describe '.new' do
-    it { is_expected.not_to(be(nil)) }
+    it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(from_regexp: '')) }
     it { is_expected.to(have_attributes(to_template: '')) }
     it { is_expected.to(have_attributes(next_ref:    0)) }
     it { is_expected.to(have_attributes(changes:     [])) }
-    it { expect { refchanger.user_defined_attribute }.to(raise_error(NoMethodError)) }
+
+    it do
+      expect { refchanger.user_defined_attribute }
+        .to(raise_error(NoMethodError))
+    end
   end
 
   describe '.from_config' do
@@ -24,7 +28,7 @@ RSpec.describe(DefMastership::ChangeRefLineModifier) do
       )
     end
 
-    it { is_expected.not_to(be(nil)) }
+    it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(from_regexp: 'Whatever.+')) }
     it { is_expected.to(have_attributes(to_template: 'Whatever')) }
     it { is_expected.to(have_attributes(next_ref:    17)) }
@@ -238,6 +242,9 @@ RSpec.describe(DefMastership::ChangeRefLineModifier) do
         .to(eq('defs:iref[TUTU]'))
     end
 
-    it { expect { refchanger.replace(:pouet, 'whatever') }.to(raise_error(NoMethodError)) }
+    it do
+      expect { refchanger.replace(:pouet, 'whatever') }
+        .to(raise_error(NoMethodError))
+    end
   end
 end

data/spec/unit/{defmastership → def_mastership}/change_ref_modifier_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe(DefMastership::ChangeRefModifier) do
   end
 
   describe '.new' do
-    it { is_expected.not_to(be(nil)) }
+    it { is_expected.not_to(be_nil) }
     it { is_expected.to(have_attributes(config: 'fake config')) }
     it { is_expected.to(have_attributes(changes: [])) }
   end