defmastership 1.0.17 → 1.0.18

data/lib/defmastership/rename_included_files_modifier.rb

@@ -1,15 +1,182 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require 'defmastership/constants'
+require('defmastership/matching_line')
+require 'defmastership/modifier'
+
+# defintion of the Rename Included Files Modifier
 module DefMastership
-  # Change included filenames
-  class RenameIncludedFilesModifier < ModifierBase
-    def replacements
+  LOCAL_FILTERS = [
+    Filter.new(DMRegexp::VARIABLE_DEF,  :new_variable_def),
+    Filter.new(DMRegexp::DEFINITION,    :new_definition),
+    Filter.new(DMRegexp::BLOCK,         :block_delimiter),
+    Filter.new(DMRegexp::EMPTY_LINE,    :empty_line),
+    Filter.new(DMRegexp::WHATEVER,      :new_line)
+  ].freeze
+  private_constant :LOCAL_FILTERS
+
+  # Change included filenames on one line at a time
+  class RenameIncludedFilesModifier
+    include Modifier
+
+    PARSER_ACTIONS = {
+      new_variable_def: lambda { |matching_line|
+        @variables.merge!(Helper.variable_def_hash(matching_line.match))
+      },
+      add_line: proc { |_| },
+      add_new_definition: lambda { |matching_line|
+        config[:reference] = matching_line.match[:reference]
+      }
+    }.freeze
+
+    private_constant :PARSER_ACTIONS
+
+    def self.replacement_methods
       %i[replace]
     end
 
-    def new_line_modifier(config, _adoc_texts)
-      RenameIncludedFilesLineModifier.from_config(config)
+    def self.default_config
+      {
+        from_regexp: '',
+        to_template: ''
+      }
+    end
+
+    def initialize(config)
+      @variables = {}
+      @definition_parser = DefinitionParser.new(self)
+
+      setup_modifier_module(config)
+    end
+
+    def method_missing(method_name, *args)
+      action = PARSER_ACTIONS[method_name]
+      return instance_exec(*args, &action) if action
+
+      super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      PARSER_ACTIONS.key?(method_name) || super
+    end
+
+    def replace(line)
+      match = matched?(line)
+
+      return line unless match
+
+      new_line = build_new_include_line(match, line)
+
+      rename_file(line, new_line)
+
+      new_line
+    end
+
+    private
+
+    def build_new_include_line(match, line)
+      line.sub(Helper.complete_regexp_from(from_regexp)) do
+        Helper.text_with(match, to_template % Helper.hmerge(config, match))
+      end
+    end
+
+    def matched?(line)
+      return false unless concerned_line?(line)
+      return false unless line =~ Helper.complete_regexp_from(from_regexp)
+
+      match = Regexp.last_match
+
+      return false if config.key?(:cancel_if_match) && match[:filename].match?(cancel_if_match)
+
+      match
+    end
+
+    def concerned_line?(line)
+      return false if line.commented?
+
+      parse(line)
+
+      return false if @definition_parser.idle?
+
+      true
+    end
+
+    def parse(line)
+      Helper.apply_filters_until_consumed(line) do |event, match|
+        generate_event(event, MatchingLine.new(match))
+      end
+    end
+
+    def rename_file(from, to)
+      filename_from = Helper.extract_filename(from, @variables)
+      filename_to = Helper.extract_filename(to, @variables)
+      changes << [filename_from, filename_to]
+      File.rename(filename_from, filename_to)
+    end
+
+    def generate_event(event, matching_line)
+      if PARSER_ACTIONS.key?(event)
+        public_send(event, matching_line)
+      else
+        @definition_parser.public_send(event, matching_line)
+      end
+    end
+
+    # Helper functions
+    module Helper
+      def self.extract_filename(include_statement, variables)
+        filename = filename_from_include_statement(include_statement)
+
+        filename_replace_all_variables(filename, variables).chomp
+      end
+
+      def self.filename_from_include_statement(include_statement)
+        include_statement
+          .sub(Regexp.new(DMRegexp::INCLUDE_KEYWORD), '')
+          .sub(Regexp.new(DMRegexp::INCLUDE_OPTIONS), '')
+      end
+
+      def self.filename_replace_all_variables(filename, variables)
+        filename.scan(DMRegexp::VARIABLE_USE) do
+          varname = Regexp.last_match[:varname]
+          value = variables.fetch(varname.to_sym)
+          filename = filename_replace_one_variable(filename, varname, value)
+        end
+        filename
+      end
+
+      def self.filename_replace_one_variable(filename, varname, value)
+        filename.sub("{#{varname}}", value)
+      end
+
+      def self.complete_regexp_from(from)
+        Regexp.new(
+          DMRegexp::INCLUDE_KEYWORD + DMRegexp::INCLUDE_PATH +
+          "(?<filename>#{from})" + DMRegexp::INCLUDE_OPTIONS
+        )
+      end
+
+      def self.text_with(match, to)
+        "include::#{match[:path]}#{to}[#{match[:options]}]"
+      end
+
+      def self.hmerge(config, match)
+        config.merge(match.names.map(&:to_sym).zip(match.captures).to_h)
+      end
+
+      def self.variable_def_hash(match)
+        { match[:varname].to_sym => match[:value] }
+      end
+
+      def self.apply_filters_until_consumed(line)
+        LOCAL_FILTERS.each do |filter|
+          next unless line.match(filter.regexp)
+
+          yield(filter.event, Regexp.last_match)
+          break
+        end
+      end
     end
   end
 end

data/lib/defmastership/set_join_hack.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+if RUBY_VERSION < '3.0'
+  # Ruby 2.7 do not implement join for Set
+  class Set
+    def join(*args)
+      to_a.join(*args)
+    end
+  end
+end

data/lib/defmastership/update_def_checksum_modifier.rb

@@ -1,21 +1,16 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require 'defmastership/constants'
+require 'defmastership/update_def_modifier'
+
 module DefMastership
-  # Update definition checksum with calculated one
-  class UpdateDefChecksumModifier < ModifierBase
-    def replacements
-      %i[replace]
-    end
+  # modify one line after another
+  class UpdateDefChecksumModifier < UpdateDefModifier
+    private
 
-    def new_line_modifier(config, adoc_texts)
-      document = Document.new
-      adoc_texts.each do |adoc_file, _|
-        document.parse_file_with_preprocessor(adoc_file)
-      end
-      line_modifier = UpdateDefChecksumLineModifier.from_config(config)
-      line_modifier.document = document
-      line_modifier
+    def reference_replacement(reference, match)
+      "#{reference}(#{match[:explicit_version]}#{document.ref_to_def(reference).sha256_short})"
     end
   end
 end

data/lib/defmastership/update_def_modifier.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # absttrac class for modififier that need o update defintion references
+  class UpdateDefModifier
+    include Modifier
+
+    attr_reader :document
+
+    def self.default_config
+      {
+        def_type: ''
+      }
+    end
+
+    def self.replacement_methods
+      %i[replace_reference]
+    end
+
+    def self.reference_regexp(reference)
+      Regexp.new("#{reference}#{DMRegexp::DEF_VERSION_AND_CHECKSUM}")
+    end
+
+    def initialize(config)
+      @document = Document.new
+
+      setup_modifier_module(config)
+    end
+
+    def do_modifications(adoc_sources)
+      adoc_sources.each_key do |adoc_file|
+        document.parse_file_with_preprocessor(adoc_file)
+      end
+
+      super(adoc_sources)
+    end
+
+    def replace_reference(line)
+      match = line.match(DMRegexp::DEFINITION)
+
+      return line unless match
+      return line unless match[:type] == def_type
+
+      reference = match[:reference]
+      line.sub(self.class.reference_regexp(reference), reference_replacement(reference, match))
+    end
+  end
+end

data/lib/defmastership/update_def_version_modifier.rb

@@ -1,25 +1,66 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require 'defmastership/constants'
+require 'defmastership/update_def_modifier'
+
 module DefMastership
-  # Update definition version if the definition has change since
-  # reference document
-  class UpdateDefVersionModifier < ModifierBase
-    def replacements
-      %i[replace]
+  # modify one line after another
+  class UpdateDefVersionModifier < UpdateDefModifier
+    def self.default_config
+      {
+        def_type: '',
+        ref_document: '',
+        first_version: ''
+      }
+    end
+
+    def initialize(config)
+      @ref_document = Document.new
+
+      super(config)
+    end
+
+    def do_modifications(adoc_sources)
+      @ref_document.parse_file_with_preprocessor(config.fetch(:ref_document))
+
+      super(adoc_sources)
+    end
+
+    private
+
+    def reference_replacement(reference, match)
+      "#{reference}#{version_and_checksum_str(match)}"
     end
 
-    def new_line_modifier(config, adoc_texts)
-      document = Document.new
-      adoc_texts.each do |adoc_file, _|
-        document.parse_file_with_preprocessor(adoc_file)
+    def version_and_checksum_str(match)
+      explicit_checksum = match[:explicit_checksum]
+      version = version_string(match)
+      return unless explicit_checksum || version
+
+      "(#{version}#{explicit_checksum})"
+    end
+
+    def version_string(match)
+      ref_definition = Helper.def_from_match(@ref_document, match)
+      definition = Helper.def_from_match(document, match)
+      return unless ref_definition
+
+      Helper.ref_version(ref_definition, definition, config.fetch(:first_version))
+    end
+
+    # Helper functions
+    module Helper
+      def self.def_from_match(doc, match)
+        doc.ref_to_def(match[:reference])
+      end
+
+      def self.ref_version(ref_definition, definition, first_version)
+        new_ref_version = ref_definition.explicit_version
+        return new_ref_version if definition.sha256_short == ref_definition.sha256_short
+
+        new_ref_version ? new_ref_version.next : first_version
       end
-      ref_document = Document.new
-      ref_document.parse_file_with_preprocessor(config[:ref_document])
-      line_modifier = UpdateDefVersionLineModifier.from_config(config)
-      line_modifier.document = document
-      line_modifier.ref_document = ref_document
-      line_modifier
     end
   end
 end

data/lib/defmastership/version.rb

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

data/lib/defmastership.rb

@@ -6,7 +6,6 @@ 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')
@@ -15,12 +14,8 @@ require('defmastership/definition')
 require('defmastership/definition_parser')
 require('defmastership/document')
 require('defmastership/filters')
-require('defmastership/line_modifier_base')
-require('defmastership/modifier_base')
+require('defmastership/modifier_factory')
 require('defmastership/parsing_state')
-require('defmastership/rename_included_files_line_modifier')
 require('defmastership/rename_included_files_modifier')
-require('defmastership/update_def_checksum_line_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

@@ -3,7 +3,6 @@
 
 require('aasm/rspec')
 require('aruba/rspec')
-require('bundler/setup')
 
 # formatter = [SimpleCov::Formatter::HTMLFormatter]
 # SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatter)
@@ -18,8 +17,11 @@ SimpleCov.start do
 
   add_filter 'config'
   add_filter 'vendor'
+  add_filter 'set_join_hack'
 
   minimum_coverage 100
+
+  enable_coverage :branch
 end
 
 RSpec.configure do |config|

data/spec/unit/def_mastership/batch_modifier_spec.rb

@@ -1,29 +1,31 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership')
+require('defmastership/batch_modifier')
 
 module DefMastership
-  class TotoClassModifier < ModifierBase
+  class TotoModifier
+    include Modifier
   end
 
-  class TutuClassModifier < ModifierBase
+  class TuTuModifier
+    include Modifier
   end
 end
 
 RSpec.describe(DefMastership::BatchModifier) do
   subject(:batchmodifier) do
-    described_class.new(config, adoc_texts)
+    described_class.new(config, adoc_sources)
   end
 
   let(:config) do
     {
-      modifier1: { type: 'toto_class', config: { p: 1 } },
-      modifier2: { type: 'toto_class', config: { p: 'whatever1' } },
-      modifier3: { type: 'tutu_class', config: { p1: 'whatever2', p2: 'whatever3' } }
+      modifier1: { type: 'toto', config: { p: 1 } },
+      modifier2: { type: 'toto', config: { p: 'whatever1' } },
+      modifier3: { type: 'tu_tu', config: { p1: 'whatever2', p2: 'whatever3' } }
     }
   end
-  let(:adoc_texts) do
+  let(:adoc_sources) do
     {
       'file1.adoc' => 'some text',
       'file2.adoc' => 'another text'
@@ -35,14 +37,14 @@ RSpec.describe(DefMastership::BatchModifier) do
     it { is_expected.to(have_attributes(config: config)) }
 
     it do
-      expect(batchmodifier).to(have_attributes(adoc_texts: adoc_texts))
+      expect(batchmodifier).to(have_attributes(adoc_sources: adoc_sources))
     end
   end
 
   describe '#apply' do
     context 'with only one modification' do
-      let(:toto1) { instance_double(DefMastership::TotoClassModifier, 'toto1') }
-      let(:adoc_texts_modified) do
+      let(:toto1) { instance_double(DefMastership::TotoModifier, 'toto1') }
+      let(:adoc_sources_modified) do
         {
           'file1.adoc' => 'some text modified',
           'file2.adoc' => 'another text'
@@ -51,26 +53,26 @@ RSpec.describe(DefMastership::BatchModifier) do
 
       let(:config_modified) do
         {
-          modifier1: { type: 'toto_class', config: { p: 'modified_param' } },
-          modifier2: { type: 'toto_class', config: { p: 'whatever1' } },
-          modifier3: { type: 'tutu_class', config: { p1: 'whatever2', p2: 'whatever3' } }
+          modifier1: { type: 'toto', config: { p: 'modified_param' } },
+          modifier2: { type: 'toto', config: { p: 'whatever1' } },
+          modifier3: { type: 'tu_tu', config: { p1: 'whatever2', p2: 'whatever3' } }
         }
       end
 
       before do
-        allow(DefMastership::TotoClassModifier).to(receive(:new).once.and_return(toto1))
-        allow(toto1).to(receive(:do_modifications).once.and_return(adoc_texts_modified))
+        allow(DefMastership::TotoModifier).to(receive(:new).once.and_return(toto1))
+        allow(toto1).to(receive(:do_modifications).once.and_return(adoc_sources_modified))
         allow(toto1).to(receive(:config).once.and_return(p: 'modified_param'))
         allow(toto1).to(receive(:changes).once.and_return([%w[from1 to1], %w[from2 to2]]))
-        batchmodifier.apply('modifier1')
+        batchmodifier.apply(%i[modifier1])
       end
 
       it do
-        expect(DefMastership::TotoClassModifier).to(have_received(:new).with(p: 1))
+        expect(DefMastership::TotoModifier).to(have_received(:new).with(p: 1))
       end
 
-      it { expect(toto1).to(have_received(:do_modifications).with(adoc_texts)) }
-      it { is_expected.to(have_attributes(adoc_texts: adoc_texts_modified)) }
+      it { expect(toto1).to(have_received(:do_modifications).with(adoc_sources)) }
+      it { is_expected.to(have_attributes(adoc_sources: adoc_sources_modified)) }
       it { expect(toto1).to(have_received(:config).with(no_args)) }
 
       it { is_expected.to(have_attributes(config: config_modified)) }
@@ -78,43 +80,43 @@ RSpec.describe(DefMastership::BatchModifier) do
     end
 
     context 'with two modifications' do
-      let(:toto2) { instance_double(DefMastership::TotoClassModifier, 'toto2') }
-      let(:tutu3) { instance_double(DefMastership::TutuClassModifier, 'tutu3') }
+      let(:toto2) { instance_double(DefMastership::TotoModifier, 'toto2') }
+      let(:tutu3) { instance_double(DefMastership::TuTuModifier, 'tutu3') }
 
       let(:config_modified) do
         {
-          modifier1: { type: 'toto_class', config: { p: 1 } },
-          modifier2: { type: 'toto_class', config: :whatever },
-          modifier3: { type: 'tutu_class', config: :pouet }
+          modifier1: { type: 'toto', config: { p: 1 } },
+          modifier2: { type: 'toto', config: :whatever },
+          modifier3: { type: 'tu_tu', config: :pouet }
         }
       end
 
       before do
-        allow(DefMastership::TotoClassModifier).to(receive(:new).once.and_return(toto2))
-        allow(toto2).to(receive(:do_modifications).once.and_return(:adoc_texts_modified_mod2))
+        allow(DefMastership::TotoModifier).to(receive(:new).once.and_return(toto2))
+        allow(toto2).to(receive(:do_modifications).once.and_return(:adoc_sources_modified_mod2))
         allow(toto2).to(receive(:config).once.and_return(:whatever))
-        allow(DefMastership::TutuClassModifier).to(receive(:new).once.and_return(tutu3))
-        allow(tutu3).to(receive(:do_modifications).once.and_return(:adoc_texts_modified_mod3))
+        allow(DefMastership::TuTuModifier).to(receive(:new).once.and_return(tutu3))
+        allow(tutu3).to(receive(:do_modifications).once.and_return(:adoc_sources_modified_mod3))
         allow(tutu3).to(receive(:config).once.and_return(:pouet))
         allow(toto2).to(receive(:changes).once.and_return([%w[from1 to1]]))
         allow(tutu3).to(receive(:changes).once.and_return([%w[from2 to2]]))
-        batchmodifier.apply('modifier2, modifier3')
+        batchmodifier.apply(%i[modifier2 modifier3])
       end
 
-      it { expect(DefMastership::TotoClassModifier).to(have_received(:new).with(p: 'whatever1')) }
-      it { expect(DefMastership::TutuClassModifier).to(have_received(:new).with(p1: 'whatever2', p2: 'whatever3')) }
-      it { expect(toto2).to(have_received(:do_modifications).with(adoc_texts)) }
+      it { expect(DefMastership::TotoModifier).to(have_received(:new).with(p: 'whatever1')) }
+      it { expect(DefMastership::TuTuModifier).to(have_received(:new).with(p1: 'whatever2', p2: 'whatever3')) }
+      it { expect(toto2).to(have_received(:do_modifications).with(adoc_sources)) }
       it { expect(toto2).to(have_received(:config).with(no_args)) }
-      it { expect(tutu3).to(have_received(:do_modifications).with(:adoc_texts_modified_mod2)) }
+      it { expect(tutu3).to(have_received(:do_modifications).with(:adoc_sources_modified_mod2)) }
       it { expect(tutu3).to(have_received(:config).with(no_args)) }
-      it { is_expected.to(have_attributes(adoc_texts: :adoc_texts_modified_mod3)) }
+      it { is_expected.to(have_attributes(adoc_sources: :adoc_sources_modified_mod3)) }
       it { is_expected.to(have_attributes(config: config_modified)) }
       it { is_expected.to(have_attributes(changes: [%w[modifier2 from1 to1], %w[modifier3 from2 to2]])) }
     end
 
     context 'with wrong modification' do
       it do
-        expect { batchmodifier.apply('wrong-modification') }
+        expect { batchmodifier.apply(%i[wrong-modification]) }
           .to(
             raise_error(ArgumentError, 'wrong-modification is not a known modification')
           )