defmastership 1.3.2 → 1.3.4

data/lib/defmastership/modifier/change_ref.rb

@@ -2,52 +2,26 @@
 # frozen_string_literal: true
 
 require('defmastership/core/constants')
+require('defmastership/core/parsing_state')
+require('defmastership/def_type_list')
 require('defmastership/modifier/modifier_common')
 require('facets/file/writelines')
 
 module Defmastership
   module Modifier
     # Change references from temporary to definitive with multiple RefChangers
+    # This class smells of :reek:DataClump
     class ChangeRef
       include ModifierCommon
 
-      # [Regexp] match all text before the definition's reference
-      DEF_BEFORE_REF = <<~"BEF".freeze
-        ^
-        \\s*
-        \\[
-        #{Core::DMRegexp::DEF_KEYWORD}
-        #{Core::DMRegexp::DEF_TYPE}
-        ,
-        \\s*
-      BEF
-      private_constant :DEF_BEFORE_REF
-
-      # [Regexp] match all text after the definition's reference
-      DEF_AFTER_REF = <<~"AFT".freeze
-        \\s*
-        #{Core::DMRegexp::DEF_SUMMARY}
-        #{Core::DMRegexp::DEF_LABELS}
-        \\s*
-        \\]
-      AFT
-      private_constant :DEF_AFTER_REF
-
-      # [Regexp] match the begining of an internal cross reference
-      IREF_DEF_BEF = 'defs:iref\[\s*'
-      private_constant :IREF_DEF_BEF
-      # [Regexp] match the end of an internal cross reference
-      IREF_DEF_AFT = '\s*\]'
-      private_constant :IREF_DEF_AFT
-
       REGEXP_FROM = {
         definition: {
-          before: DEF_BEFORE_REF,
-          after: DEF_AFTER_REF
+          before: Core::DMRegexp::DEF_BEFORE_REF,
+          after: Core::DMRegexp::DEF_AFTER_REF
         },
         iref: {
-          before: IREF_DEF_BEF,
-          after: IREF_DEF_AFT
+          before: Core::DMRegexp::IREF_DEF_BEF,
+          after: Core::DMRegexp::IREF_DEF_AFT
         }
       }.freeze
 
@@ -63,6 +37,7 @@ module Defmastership
       # @return [Hash{Symbol => Object}] the default configuration
       def self.default_config
         {
+          def_type: '',
           from_regexp: '',
           to_template: '',
           next_ref: 0
@@ -78,9 +53,11 @@ module Defmastership
 
       # Replace the definition's ref in the line if relevant
       #
+      # @param _filename [String] the filename of the file beeing modified
       # @param line [String] the current line
       # @return [String] the modified line
-      def replace_refdef(line)
+      # This method smells of :reek:DataClump
+      def replace_refdef(_filename, line)
         if @parsing_state.enabled?(line)
           do_replace_refdef(line)
         else
@@ -90,9 +67,10 @@ module Defmastership
 
       # Replace the definition's refs in intenal refs
       #
+      # @param _filename [String] the filename of the file beeing modified
       # @param line [String] the current line
       # @return [String] the modified line
-      def replace_irefs(line)
+      def replace_irefs(_filename, line)
         changes.reduce(line) do |res_line, (from, to)|
           res_line.gsub(Helper.regexp_from(:iref, from)) do
             Helper.text_with(Regexp.last_match, to)
@@ -102,9 +80,10 @@ module Defmastership
 
       # Replace the definition's refs in tags of include statements
       #
+      # @param _filename [String] the filename of the file beeing modified
       # @param line [String] the current line
       # @return [String] the modified line
-      def replace_include_tags(line)
+      def replace_include_tags(_filename, line)
         return line unless line.match?(Core::DMRegexp::INCLUDE)
 
         changes.reduce(line) do |res_line, (from, to)|
@@ -114,11 +93,14 @@ module Defmastership
 
       # Replace the definition's refs in included files
       #
+      # @param filename [String] the filename of the file beeing modified
       # @param line [String] the current line
       # @return [String] the (unmodified) line
-      def replace_tags_in_included_files(line)
+      def replace_tags_in_included_files(filename, line)
         if line.match(Core::DMRegexp::INCLUDE)
-          Helper.replace_tags_in_included_files(Helper::ParsedFilename.full_filename(Regexp.last_match), changes)
+          Helper.replace_tags_in_included_files(
+            "#{Pathname(filename).dirname}/#{Helper::ParsedFilename.full_filename(Regexp.last_match)}", changes
+          )
         end
         line
       end
@@ -127,7 +109,10 @@ module Defmastership
 
       def do_replace_refdef(line)
         line.sub(Helper.regexp_from(:definition, from_regexp)) do
-          replacement_from(Regexp.last_match)
+          last_match = Regexp.last_match
+          return line unless DefTypeList.new(config.fetch(:def_type)).include?(last_match[:type])
+
+          replacement_from(last_match)
         end
       end
 

data/lib/defmastership/modifier/factory.rb

@@ -5,6 +5,10 @@ require('defmastership/modifier/change_ref')
 require('defmastership/modifier/rename_included_files')
 require('defmastership/modifier/update_def_checksum')
 require('defmastership/modifier/update_def_version')
+require('defmastership/modifier/update_eref_checksum')
+require('defmastership/modifier/update_eref_version')
+require('defmastership/modifier/update_iref_checksum')
+require('defmastership/modifier/update_iref_version')
 
 module Defmastership
   module Modifier
@@ -15,7 +19,7 @@ module Defmastership
       # @param config [YAML] piece of configuration for this Modifier
       def self.from_config(config)
         class_name = config.fetch(:type).split('_').map(&:capitalize).join
-        Modifier.const_get(class_name).new(config.fetch(:config))
+        Modifier.const_get(class_name).new(config.fetch(:config, {}))
       end
     end
   end

data/lib/defmastership/modifier/modifier_common.rb

@@ -57,13 +57,13 @@ module Defmastership
       private
 
       def apply_to_all(texts, method)
-        texts.transform_values do |text|
-          apply_to_one(text, method)
+        texts.to_h do |filename, text|
+          [filename, apply_to_one(filename, text, method)]
         end
       end
 
-      def apply_to_one(text, method)
-        text.lines.map { |line| public_send(method, line) }
+      def apply_to_one(filename, text, method)
+        text.lines.map { |line| public_send(method, filename, line) }
             .join
       end
     end

data/lib/defmastership/modifier/rename_included_files.rb

@@ -1,7 +1,11 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require('defmastership/def_type_list')
+require('defmastership/definition_parser')
 require('defmastership/filters')
+require('defmastership/matching_line')
+require('defmastership/modifier/modifier_common')
 
 module Defmastership
   # defintion of the Rename Included Files Modifier
@@ -26,6 +30,7 @@ module Defmastership
         add_line: proc { |_| },
         add_new_definition: lambda { |matching_line|
           config[:reference] = matching_line.match[:reference]
+          @current_def_type = matching_line.match[:type]
         }
       }.freeze
 
@@ -39,15 +44,18 @@ module Defmastership
       # @return [Hash{Symbol => Object}] the default configuration
       def self.default_config
         {
+          def_type: '',
           from_regexp: '',
           to_template: ''
         }
       end
 
       # @param config [YAML] the modifier's provided configurations
+      # mutant:disable
       def initialize(config)
         @variables = {}
         @definition_parser = DefinitionParser.new(self)
+        @current_def_type = nil
 
         setup_modifier_module(config)
       end
@@ -73,15 +81,17 @@ module Defmastership
 
       # Modify line if it match
       #
+      # @param filename [String] the filename of the file beeing modified
+      # @param line [String] the current line
       # @return [String] the modified line
-      def replace(line)
+      def replace(filename, line)
         match = matched?(line)
 
         return line unless match
 
         new_line = build_new_include_line(match, line)
 
-        rename_file(line, new_line)
+        rename_file(Pathname(filename).dirname, line, new_line)
 
         new_line
       end
@@ -109,6 +119,7 @@ module Defmastership
         parse(line)
 
         return false if @definition_parser.idle?
+        return false unless DefTypeList.new(config.fetch(:def_type)).include?(@current_def_type)
 
         true
       end
@@ -119,9 +130,9 @@ module Defmastership
         end
       end
 
-      def rename_file(from, to)
-        filename_from = Helper.extract_filename(from, @variables)
-        filename_to = Helper.extract_filename(to, @variables)
+      def rename_file(dirname, from, to)
+        filename_from = "#{dirname}/#{Helper.extract_filename(from, @variables)}"
+        filename_to = "#{dirname}/#{Helper.extract_filename(to, @variables)}"
         changes << [filename_from, filename_to]
         File.rename(filename_from, filename_to)
       end

data/lib/defmastership/modifier/replacement_formatter.rb

@@ -0,0 +1,37 @@
+# lib/defmastership/modifier/replacement_formatter.rb
+
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'memoist'
+
+module Defmastership
+  module Modifier
+    # A small, single-purpose class to format a ref replacement string.
+    class ReplacementFormatter
+      extend Memoist
+
+      # @param match_data [MatchData] of the ref statement
+      # @param document [Document] the overall parsed document
+      # @param key [Symbol] the key to access the reference in match_data
+      def initialize(match_data, document, key)
+        @match_data = match_data
+        @document = document
+        @key = key
+      end
+
+      private
+
+      attr_reader :match_data, :document, :key
+
+      def reference_string
+        match_data[key]
+      end
+
+      def definition
+        document.ref_to_def(reference_string)
+      end
+      memoize :definition
+    end
+  end
+end

data/lib/defmastership/modifier/update_def.rb

@@ -1,6 +1,10 @@
 # Copyright (c) 2024 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require 'defmastership/def_type_list'
+require 'defmastership/document'
+require 'defmastership/modifier/modifier_common'
+
 module Defmastership
   module Modifier
     # @abstract Subclass and define +reference_replacement+ to implement a
@@ -54,13 +58,14 @@ module Defmastership
 
       # Called on each line for an opportunity for text replacement
       #
+      # @param _filename [String] the filename of the file beeing modified
       # @param line [String] line from asciidoc sources files
       # @return [String] the modified line
-      def replace_reference(line)
+      def replace_reference(_filename, line)
         match = line.match(Core::DMRegexp::DEFINITION)
 
         return line unless match
-        return line unless match[:type].eql?(def_type)
+        return line unless DefTypeList.new(def_type).include?(match[:type])
 
         reference = match[:reference]
         line.sub(self.class.reference_regexp(reference), reference_replacement(reference, match))

data/lib/defmastership/modifier/update_eref_checksum.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'defmastership/modifier/update_eref_common'
+
+module Defmastership
+  module Modifier
+    # Update external refs checksum
+    class UpdateErefChecksum < UpdateEref
+      # Methods's symbols will be called in sequence to perform the document modifications
+      #
+      # @return [Array<Symbol>] the two symbols of replacement methods
+      def self.replacement_methods
+        %i[replace_erefs]
+      end
+
+      private
+
+      # Provides the specific formatter class for checksum replacements.
+      def formatter_class
+        Helper::ErefReplacementFormatterChecksum
+      end
+
+      # Helper functions/classes
+      module Helper
+        # A small, single-purpose class to format the eref replacement string.
+        class ErefReplacementFormatterChecksum < ReplacementFormatter
+          # @param match_data [MatchData] of the ref statement
+          # @param document [Document] the overall parsed document
+          def initialize(match_data, document)
+            super(match_data, document, :reference)
+          end
+
+          # @return [String] the formatted string or the original match if no definition is found.
+          def to_s
+            version = match_data[:explicit_version]
+            checksum = definition ? definition.sha256_short : match_data[:explicit_checksum]
+            return reference_string unless version || checksum
+
+            "#{reference_string}(#{version}#{checksum})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/modifier/update_eref_common.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'defmastership/def_type_list'
+require 'defmastership/modifier/modifier_common'
+require 'defmastership/modifier/replacement_formatter'
+
+module Defmastership
+  module Modifier
+    # Update external refs version
+    class UpdateEref
+      include ModifierCommon
+
+      # @return [Hash{Symbol => Object}] the default configuration
+      def self.default_config
+        {
+          eref_type: '',
+          ref_document: ''
+        }
+      end
+
+      # @param config [YAML] the modifier's provided configurations
+      def initialize(config)
+        @the_ref_document = Document.new
+
+        setup_modifier_module(config)
+      end
+
+      # Apply the modifier on all provided asciidoc sources based on modifier's
+      # +self.replacement_methods+ list
+      #
+      # @param adoc_sources [Hash{String => String}] asciidoc sources
+      #  * :key filename
+      #  * :value file content
+      def do_modifications(adoc_sources)
+        Array(ref_document).each { |ref_doc| the_ref_document.parse_file_with_preprocessor(ref_doc) }
+
+        super
+      end
+
+      # Replace the definition's external ref in the line if relevant
+      #
+      # @param _filename [String] the filename of the file beeing modified
+      # @param line [String] the current line
+      # @return [String] the modified line
+      def replace_erefs(_filename, line)
+        match = line.match(Core::DMRegexp::EREF_DEF)
+        # Return early if there's no match or the type is not valid
+        return line unless match && eref_type_valid?(match[:reference])
+
+        # Delegate the actual replacement to a separate method
+        perform_replacement(line, match[:extrefs])
+      end
+
+      private
+
+      # Performs the nested gsub replacement
+      #
+      # @param line [String] the current line
+      # @param extrefs [String] all teh matched external references
+      # @return [String] the modified line
+      def perform_replacement(line, extrefs)
+        line.sub(extrefs) do
+          extrefs.gsub(Regexp.new(Core::DMRegexp::REF_WITH_OPT_VER_CHK)) do
+            formatter_class.new(Regexp.last_match, the_ref_document)
+          end
+        end
+      end
+
+      attr_reader :the_ref_document
+
+      # Checks if the given eref type should be processed
+      def eref_type_valid?(this_eref_type)
+        DefTypeList.new(eref_type).include?(this_eref_type)
+      end
+    end
+  end
+end

data/lib/defmastership/modifier/update_eref_version.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'defmastership/modifier/update_eref_common'
+
+module Defmastership
+  module Modifier
+    # Update external refs version
+    class UpdateErefVersion < UpdateEref
+      # Methods's symbols will be called in sequence to perform the document modifications
+      #
+      # @return [Array<Symbol>] the two symbols of replacement methods
+      def self.replacement_methods
+        %i[replace_erefs]
+      end
+
+      private
+
+      # Provides the specific formatter class for checksum replacements.
+      def formatter_class
+        Helper::ErefReplacementFormatterVersion
+      end
+
+      # Helper functions/classes
+      module Helper
+        # A small, single-purpose class to format the eref replacement string.
+        class ErefReplacementFormatterVersion < ReplacementFormatter
+          # @param match_data [MatchData] of the ref statement
+          # @param document [Document] the overall parsed document
+          def initialize(match_data, document)
+            super(match_data, document, :reference)
+          end
+
+          # @return [String] the formatted string or the original match if no definition is found.
+          def to_s
+            version = definition ? definition.explicit_version : match_data[:explicit_version]
+            checksum = match_data[:explicit_checksum]
+            return reference_string unless version || checksum
+
+            "#{reference_string}(#{version}#{checksum})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/modifier/update_iref_checksum.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/core/constants')
+require('defmastership/modifier/replacement_formatter')
+require('defmastership/modifier/update_iref_common')
+
+module Defmastership
+  module Modifier
+    # Update internal refs checksum
+    class UpdateIrefChecksum < UpdateIref
+      include ModifierCommon
+
+      # Methods's symbols will be called in sequence to perform the document modifications
+      #
+      # @return [Array<Symbol>] the two symbols of replacement methods
+      def self.replacement_methods
+        %i[replace_irefs]
+      end
+
+      # Replace the definition's internal ref in the line if relevant
+      #
+      # @param _filename [String] the filename of the file beeing modified
+      # @param line [String] the current line
+      # @return [String] the modified line
+      def replace_irefs(_filename, line)
+        line.gsub(Core::DMRegexp::IREF_DEF) do
+          Helper::IrefReplacementFormatterChecksum.new(Regexp.last_match, document).to_s
+        end
+      end
+
+      # Helper functions/classes
+      module Helper
+        # A small, single-purpose class to format the iref replacement string.
+        class IrefReplacementFormatterChecksum < ReplacementFormatter
+          # @param match_data [MatchData] of the ref statement
+          # @param document [Document] the overall parsed document
+          def initialize(match_data, document)
+            super(match_data, document, :intref)
+          end
+
+          # @return [String] the formatted string or the original match if no definition is found.
+          def to_s
+            return match_data unless definition
+
+            "defs:iref[#{reference_string}(#{match_data[:explicit_version]}#{definition.sha256_short})]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/modifier/update_iref_common.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/core/constants')
+require('defmastership/document')
+require('defmastership/modifier/modifier_common')
+
+module Defmastership
+  module Modifier
+    # Update internal refs checksum
+    class UpdateIref
+      include ModifierCommon
+
+      # @return [Hash{Symbol => Object}] the default configuration
+      def self.default_config
+        {}
+      end
+
+      # @param config [YAML] the modifier's provided configurations
+      def initialize(config)
+        @document = Document.new
+
+        setup_modifier_module(config)
+      end
+
+      # Apply the modifier on all provided asciidoc sources based on modifier's
+      # +self.replacement_methods+ list
+      #
+      # @param adoc_sources [Hash{String => String}] asciidoc sources
+      #  * :key filename
+      #  * :value file content
+      def do_modifications(adoc_sources)
+        adoc_sources.each_key do |adoc_file|
+          document.parse_file_with_preprocessor(adoc_file)
+        end
+
+        super
+      end
+
+      private
+
+      attr_reader :document
+    end
+  end
+end

data/lib/defmastership/modifier/update_iref_version.rb

@@ -0,0 +1,59 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/core/constants')
+require('defmastership/modifier/replacement_formatter')
+require('defmastership/modifier/update_iref_common')
+
+module Defmastership
+  module Modifier
+    # Update internal refs checksum
+    class UpdateIrefVersion < UpdateIref
+      include ModifierCommon
+
+      # Methods's symbols will be called in sequence to perform the document modifications
+      #
+      # @return [Array<Symbol>] the two symbols of replacement methods
+      def self.replacement_methods
+        %i[replace_irefs]
+      end
+
+      # Replace the definition's internal ref in the line if relevant
+      #
+      # @param _filename [String] the filename of the file beeing modified
+      # @param line [String] the current line
+      # @return [String] the modified line
+      def replace_irefs(_filename, line)
+        line.gsub(Core::DMRegexp::IREF_DEF) do
+          Helper::IrefReplacementFormatterVersion.new(Regexp.last_match, document).to_s
+        end
+      end
+
+      # Helper functions/classes
+      module Helper
+        # A small, single-purpose class to format the iref replacement string.
+        class IrefReplacementFormatterVersion < ReplacementFormatter
+          # @param match_data [MatchData] of the ref statement
+          # @param document [Document] the overall parsed document
+          def initialize(match_data, document)
+            super(match_data, document, :intref)
+          end
+
+          # @return [String] the formatted string or the original match if no definition is found.
+          def to_s
+            return match_data unless definition
+
+            explicit_version = definition.explicit_version
+            explicit_checksum = match_data[:explicit_checksum]
+
+            if explicit_version || explicit_checksum
+              "defs:iref[#{reference_string}(#{explicit_version}#{explicit_checksum})]"
+            else
+              "defs:iref[#{reference_string}]"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/version.rb

@@ -3,6 +3,6 @@
 
 module Defmastership
   # [String] Gem version
-  VERSION = '1.3.2'
+  VERSION = '1.3.4'
   public_constant :VERSION
 end

data/spec/spec_helper.rb

@@ -6,19 +6,20 @@ require('aasm/rspec')
 # formatter = [SimpleCov::Formatter::HTMLFormatter]
 # SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatter)
 
-require('simplecov')
+unless ENV['CODE_COVERAGE_IN_RSPEC'] && ENV['DISABLE_CODE_COVERAGE_IN_RSPEC'] != 'disabled'
+  require 'simplecov'
+  SimpleCov.start do
+    command_name 'spec:unit'
 
-SimpleCov.start do
-  command_name 'spec:unit'
+    add_group 'Libraries', 'lib'
+    add_group 'Unit test', 'spec/unit'
 
-  add_group 'Libraries', 'lib'
-  add_group 'Unit test', 'spec/unit'
+    add_filter 'config'
+    add_filter 'vendor'
 
-  add_filter 'config'
-  add_filter 'vendor'
-
-  enable_coverage :branch
-  minimum_coverage line: 100, branch: 100
+    enable_coverage :branch
+    minimum_coverage line: 100, branch: 100
+  end
 end
 
 RSpec::Matchers.define(:matchdata_including) do |h|