defmastership 1.0.16 → 1.0.18

data/tasks/test.rake

@@ -0,0 +1,45 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('cucumber/rake/task')
+require('rspec/core/rake_task')
+
+namespace 'test' do
+  RSpec::Core::RakeTask.new(:spec)
+
+  cuke_results = 'features_results.html'
+  CLEAN << cuke_results
+
+  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
+  end
+
+  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']
+  end
+
+  desc 'Runs all unit tests and acceptance tests'
+  task(all: ['test:spec', 'test:features'])
+end
+
+desc 'Synonym for test:spec'
+task(spec: 'test:spec')
+
+desc 'Synonym for test:all'
+task(test: 'test:all')
+
+desc('Test all features')
+task(cucumber: 'test:features')

metadata

@@ -1,127 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.0.18
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: aasm
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description: 
+description:
 email: jeromearbezgindre@gmail.com
 executables:
 - defmastership
@@ -203,7 +91,6 @@ files:
 - features/support/env.rb
 - lib/defmastership.rb
 - lib/defmastership/batch_modifier.rb
-- lib/defmastership/change_ref_line_modifier.rb
 - lib/defmastership/change_ref_modifier.rb
 - lib/defmastership/comment_filter.rb
 - lib/defmastership/constants.rb
@@ -214,40 +101,45 @@ files:
 - lib/defmastership/definition_parser.rb
 - lib/defmastership/document.rb
 - lib/defmastership/filters.rb
-- lib/defmastership/line_modifier_base.rb
-- lib/defmastership/modifier_base.rb
+- lib/defmastership/matching_line.rb
+- lib/defmastership/modifier.rb
+- lib/defmastership/modifier_factory.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
+- lib/defmastership/set_join_hack.rb
 - lib/defmastership/update_def_checksum_modifier.rb
-- lib/defmastership/update_def_version_line_modifier.rb
+- lib/defmastership/update_def_modifier.rb
 - lib/defmastership/update_def_version_modifier.rb
 - lib/defmastership/version.rb
 - spec/spec_helper.rb
-- spec/unit/defmastership/batch_modifier_spec.rb
-- spec/unit/defmastership/change_ref_line_modifier_spec.rb
-- spec/unit/defmastership/change_ref_modifier_spec.rb
-- spec/unit/defmastership/comment_filter_spec.rb
-- spec/unit/defmastership/csv_formatter_body_spec.rb
-- spec/unit/defmastership/csv_formatter_header_spec.rb
-- spec/unit/defmastership/csv_formatter_spec.rb
-- 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
-- spec/unit/defmastership/update_def_checksum_modifier_spec.rb
-- spec/unit/defmastership/update_def_version_line_modifier_spec.rb
-- spec/unit/defmastership/update_def_version_modifier_spec.rb
-- spec/unit/defmastership_spec.rb
+- spec/unit/def_mastership/batch_modifier_spec.rb
+- spec/unit/def_mastership/change_ref_modifier_spec.rb
+- spec/unit/def_mastership/csv_formatter_body_spec.rb
+- spec/unit/def_mastership/csv_formatter_header_spec.rb
+- spec/unit/def_mastership/csv_formatter_spec.rb
+- spec/unit/def_mastership/definition_parser_spec.rb
+- spec/unit/def_mastership/definition_spec.rb
+- spec/unit/def_mastership/document_spec.rb
+- spec/unit/def_mastership/matching_line_spec.rb
+- spec/unit/def_mastership/modifier_factory_spec.rb
+- spec/unit/def_mastership/modifier_spec.rb
+- spec/unit/def_mastership/parsing_state_spec.rb
+- spec/unit/def_mastership/rename_included_files_modifier_spec.rb
+- spec/unit/def_mastership/string_spec.rb
+- spec/unit/def_mastership/update_def_checksum_modifier_spec.rb
+- spec/unit/def_mastership/update_def_modifier_spec.rb
+- spec/unit/def_mastership/update_def_version_modifier_spec.rb
+- spec/unit/def_mastership_spec.rb
+- tasks/console.rake
+- tasks/package.task
+- tasks/smelling_code.rake
+- tasks/test.rake
 homepage: https://gitlab.com/jjag/defmastership/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options:
 - "--title defmastership"
 - "--main README.rdoc"
@@ -259,15 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: Handling of references and definitions with asciidoctor
 test_files: []

data/lib/defmastership/change_ref_line_modifier.rb

@@ -1,82 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # Change references from temporary to definitive with multiple RefChangers
-  class ChangeRefLineModifier < LineModifierBase
-    def self.from_config(hash)
-      new.from_config(hash)
-    end
-
-    REGEXP_FROM = {
-      definition: {
-        before: DMRegexp::DEF_BEFORE_REF,
-        after: DMRegexp::DEF_AFTER_REF
-      },
-      iref: {
-        before: DMRegexp::IREF_DEF_BEF,
-        after: DMRegexp::IREF_DEF_AFT
-      }
-    }.freeze
-
-    private_constant :REGEXP_FROM
-
-    def initialize
-      super
-      @config = {
-        from_regexp: '',
-        to_template: '',
-        next_ref: 0
-      }
-      @parsing_state = ParsingState.new
-    end
-
-    def replace(method, line)
-      public_send("replace_#{method}".to_sym, line)
-    end
-
-    def replace_refdef(line)
-      if @parsing_state.enabled?(line)
-        do_replace_refdef(line)
-      else
-        line
-      end
-    end
-
-    def replace_irefs(line)
-      changes.reduce(line) do |res_line, (from, to)|
-        res_line.gsub(regexp_from(:iref, from)) do
-          text_with(Regexp.last_match, to)
-        end
-      end
-    end
-
-    private
-
-    def do_replace_refdef(line)
-      line.gsub(regexp_from(:definition, from_regexp)) do
-        replacement = to_template % hmerge(Regexp.last_match)
-        changes << [Regexp.last_match[:from], replacement]
-        @config[:next_ref] += 1
-        text_with(Regexp.last_match, replacement)
-      end
-    end
-
-    def regexp_from(const, from)
-      regexp_str =
-        "(?<before>#{REGEXP_FROM[const][:before]})" \
-        "(?<from>#{from})" \
-        "#{DMRegexp::DEF_VERSION_AND_CHECKSUM}" \
-        "(?<after>#{REGEXP_FROM[const][:after]})"
-      Regexp.new(regexp_str, Regexp::EXTENDED)
-    end
-
-    def text_with(match, replacement)
-      match[:before] + replacement + (match[:version_and_checksum] || '') + match[:after]
-    end
-
-    def hmerge(match)
-      @config.merge(match.names.map(&:to_sym).zip(match.captures).to_h)
-    end
-  end
-end

data/lib/defmastership/line_modifier_base.rb

@@ -1,29 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # Change references from temporary to definitive with multiple RefChangers
-  class LineModifierBase
-    attr_reader :changes, :config
-
-    def initialize
-      @config = {}
-      @changes = []
-    end
-
-    def method_missing(method_name, *args, &block)
-      return @config[method_name] if @config[method_name]
-
-      super
-    end
-
-    def respond_to_missing?(method_name, *args)
-      @config[method_name] || super
-    end
-
-    def from_config(config)
-      @config.merge!(config)
-      self
-    end
-  end
-end

data/lib/defmastership/modifier_base.rb

@@ -1,29 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # Change references from temporary to definitive with multiple RefChangers
-  class ModifierBase
-    attr_reader :config, :changes
-
-    def initialize(config)
-      @config = config
-      @changes = []
-    end
-
-    def do_modifications(adoc_texts)
-      line_modifier = new_line_modifier(@config, adoc_texts)
-
-      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
-        end
-
-      @config = line_modifier.config
-      @changes = line_modifier.changes
-      adoc_texts
-    end
-  end
-end

data/lib/defmastership/rename_included_files_line_modifier.rb

@@ -1,126 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # Change included filenames on one line at a time
-  class RenameIncludedFilesLineModifier < LineModifierBase
-    LOCAL_FILTERS = [
-      Filter.new(DMRegexp::VARIABLE_DEF,  :new_variable_def,     false),
-      Filter.new(DMRegexp::DEFINITION,    :new_definition,       true),
-      Filter.new(DMRegexp::BLOCK,         :block_delimiter,      true),
-      Filter.new(DMRegexp::EMPTY_LINE,    :empty_line,           false),
-      Filter.new(DMRegexp::WHATEVER,      :new_line,             true)
-    ].freeze
-    private_constant :LOCAL_FILTERS
-
-    def self.from_config(config)
-      new.from_config(config)
-    end
-
-    def initialize
-      super
-      @config = {
-        from_regexp: '',
-        to_template: ''
-      }
-      @variables = {}
-      @definition_parser = DefinitionParser.new(self)
-    end
-
-    def replace(line)
-      match = matched?(line)
-
-      return line unless match
-
-      new_line =
-        line.gsub(complete_regexp_from(from_regexp)) do
-          text_with(match, to_template % hmerge(match))
-        end
-
-      rename_file(line, new_line)
-
-      new_line
-    end
-
-    def add_new_definition(match, _line)
-      @config[:reference] = match[:reference]
-    end
-
-    def add_line(_match, _line) end
-
-    def new_variable_def(match, line)
-      @variables[match[:varname].to_sym] = match[:value]
-      line
-    end
-
-    private
-
-    def matched?(line)
-      return if line.commented?
-
-      parse(line)
-
-      return if @definition_parser.idle?
-      return unless line =~ complete_regexp_from(from_regexp)
-
-      match = Regexp.last_match
-
-      return if @config[:cancel_if_match] && match[:filename] =~ Regexp.new(cancel_if_match)
-
-      match
-    end
-
-    def parse(line)
-      LOCAL_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 rename_file(from, to)
-      @changes << [extract_filename(from), extract_filename(to)]
-      File.rename(extract_filename(from), extract_filename(to))
-    end
-
-    def extract_filename(include_statement)
-      filename = include_statement
-                 .gsub(Regexp.new(DMRegexp::INCLUDE_KEYWORD), '')
-                 .gsub(Regexp.new(DMRegexp::INCLUDE_OPTIONS), '')
-
-      filename.dup.scan(DMRegexp::VARIABLE_USE) do |_|
-        varname = Regexp.last_match[:varname]
-        next if @variables[varname.to_sym].nil?
-
-        filename.gsub!("{#{varname}}", @variables[varname.to_sym])
-      end
-      filename.chomp
-    end
-
-    def complete_regexp_from(from)
-      Regexp.new(
-        DMRegexp::INCLUDE_KEYWORD + DMRegexp::INCLUDE_PATH +
-        "(?<filename>#{from})" + DMRegexp::INCLUDE_OPTIONS
-      )
-    end
-
-    def text_with(match, to)
-      "include::#{match[:path] || ''}#{to}[#{match[:options]}]"
-    end
-
-    def hmerge(match)
-      @config.merge(match.names.map(&:to_sym).zip(match.captures).to_h)
-    end
-
-    def generate_event(event, match, line)
-      if respond_to?(event)
-        public_send(event, match, line)
-      else
-        @definition_parser.public_send(event, match, line)
-      end
-      line
-    end
-  end
-end

data/lib/defmastership/update_def_checksum_line_modifier.rb

@@ -1,38 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # modify one line after another
-  class UpdateDefChecksumLineModifier < LineModifierBase
-    attr_accessor :document
-
-    def self.from_config(hash)
-      new.from_config(hash)
-    end
-
-    def initialize
-      super
-      @config = {
-        def_type: ''
-      }
-    end
-
-    def replace(line)
-      match = matched?(line)
-
-      return line unless match
-      return line unless match[:type] == def_type
-
-      line.gsub(Regexp.new("#{match[:reference]}#{DMRegexp::DEF_VERSION_AND_CHECKSUM}")) do
-        "#{match[:reference]}(#{match[:explicit_version]}#{@document.ref_to_def(match[:reference]).sha256})"
-      end
-    end
-
-    def matched?(line)
-      return if line.commented?
-      return unless line =~ DMRegexp::DEFINITION
-
-      Regexp.last_match
-    end
-  end
-end

data/lib/defmastership/update_def_version_line_modifier.rb

@@ -1,58 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # modify one line after another
-  class UpdateDefVersionLineModifier < LineModifierBase
-    attr_accessor :document, :ref_document
-
-    def self.from_config(hash)
-      new.from_config(hash)
-    end
-
-    def initialize
-      super
-      @config = {
-        def_type: '',
-        ref_document: '',
-        first_version: ''
-      }
-    end
-
-    def replace(line)
-      match = matched?(line)
-
-      return line unless match
-      return line unless match[:type] == def_type
-
-      version_and_checksum = ''
-      if match[:explicit_checksum] || version_string(match)
-        version_and_checksum = "(#{version_string(match)}#{match[:explicit_checksum]})"
-      end
-
-      line.gsub(Regexp.new("#{match[:reference]}#{DMRegexp::DEF_VERSION_AND_CHECKSUM}")) do
-        "#{match[:reference]}#{version_and_checksum}"
-      end
-    end
-
-    private
-
-    def matched?(line)
-      return if line.commented?
-      return unless line =~ DMRegexp::DEFINITION
-
-      Regexp.last_match
-    end
-
-    def version_string(match)
-      ref_definition = @ref_document.ref_to_def(match[:reference])
-      definition = @document.ref_to_def(match[:reference])
-
-      return if ref_definition.nil?
-      return ref_definition.explicit_version if definition.sha256 == ref_definition.sha256
-
-      ref_version = @ref_document.ref_to_def(match[:reference]).explicit_version
-      ref_version.nil? ? @config[:first_version] : ref_version.next
-    end
-  end
-end