defmastership 1.0.17 → 1.0.19

data/lib/defmastership/definition.rb

@@ -3,51 +3,90 @@
 
 require 'digest'
 
+# Contains the content of a DefMastership definition
 module DefMastership
+  BUILD_FROM_MATCH = {
+    type: ->(match) { match[:type] },
+    reference: ->(match) { match[:reference] },
+    lines: ->(_) { [] },
+    labels: lambda do |match|
+      labels = Set.new
+      labels.merge(match[:labels].split(/\s*,\s*/).to_set) if match[:labels]
+      labels
+    end,
+    eref: ->(_) { Hash.new([]) },
+    iref: ->(_) { [] },
+    attributes: ->(_) { {} },
+    explicit_checksum: ->(match) { match[:explicit_checksum] },
+    explicit_version: ->(match) { match[:explicit_version] }
+  }.freeze
+
+  private_constant :BUILD_FROM_MATCH
+
+  # Class to host data of Definition class
+  DefinitionData = Struct.new(
+    :type,
+    :reference,
+    :lines,
+    :labels,
+    :eref,
+    :iref,
+    :attributes,
+    :explicit_checksum,
+    :explicit_version
+  )
+
+  private_constant :DefinitionData
+
   # DefMastership definition: contains all data of a definition
   class Definition
-    attr_reader :type, :reference, :lines, :labels, :eref, :iref, :attributes, :explicit_version
+    extend Forwardable
+    def_delegators :@data,
+                   :type,
+                   :reference,
+                   :lines,
+                   :labels,
+                   :eref,
+                   :iref,
+                   :attributes,
+                   :explicit_checksum,
+                   :explicit_version
 
     def initialize(match)
-      @type = match[:type]
-      @reference = match[:reference]
-      @lines = []
-      @labels = Set.new
-      @labels.merge(match[:labels].split(/\s*,\s*/).to_set) if match[:labels]
-      @eref = Hash.new([])
-      @iref = []
-      @attributes = {}
-      @explicit_checksum = match[:explicit_checksum]
-      @explicit_version = match[:explicit_version]
+      @data = DefinitionData.new(
+        *BUILD_FROM_MATCH.transform_values { |lamb| lamb.call(match) }
+           .fetch_values(*DefinitionData.members)
+      )
     end
 
     def <<(new_line)
-      @lines << new_line
+      lines << new_line
       self
     end
 
     def value
-      @lines.join("\n")
+      lines.join("\n")
     end
 
-    def sha256
-      "~#{Digest::SHA2.new(256).hexdigest(value).chars.last(8).join}"
+    def sha256_short
+      "~#{Digest::SHA2.hexdigest(value).chars.last(8).join}"
     end
 
     def wrong_explicit_checksum
-      @explicit_checksum if @explicit_checksum != sha256
+      explicit_checksum unless explicit_checksum.eql?(sha256_short)
     end
 
-    def add_eref(refname, extrefs)
-      @eref[refname] = extrefs.strip.split(/\s*,\s*/)
+    def add_eref(ref, extrefs)
+      eref[ref] = extrefs.strip.split(/\s*,\s*/)
     end
 
     def add_iref(ref)
-      @iref << ref
+      iref << ref
     end
 
     def set_attribute(key, value)
-      @attributes[key] = value
+      attributes[key] = value
     end
   end
+  public_constant :Definition
 end

data/lib/defmastership/document.rb

@@ -2,21 +2,79 @@
 # frozen_string_literal: true
 
 require('asciidoctor')
+require('defmastership/matching_line')
 
+# Contains the content of a DefMastership document: mainly definitions
 module DefMastership
-  # Contains the content of a DefMastership document: mainly definitions
+  # Class to host data of Document class
+  DocumentData = Struct.new(
+    :definitions,
+    :labels,
+    :eref,
+    :iref,
+    :attributes,
+    :variables
+  )
+
+  private_constant :DocumentData
+
+  PARSER_ACTIONS = {
+    add_new_definition: lambda { |matching_line|
+      definition = Definition.new(matching_line.match)
+      labels.merge(definition.labels)
+      definitions << definition
+    },
+    add_line: lambda { |matching_line|
+      line = matching_line.line
+      definitions.last << line
+    },
+    new_eref_setup: lambda { |matching_line|
+      reference = matching_line[:reference].to_sym
+      eref[reference] ||= {}
+      eref[reference][matching_line[:symb].to_sym] = matching_line[:value]
+    },
+    new_eref_def: lambda { |matching_line|
+      definitions.last.add_eref(matching_line[:reference].to_sym, matching_line[:extrefs])
+    },
+    new_iref_def: lambda { |matching_line|
+      self.iref = true
+      line = matching_line.line
+      line.scan(DMRegexp::IREF_DEF) do |_|
+        definitions.last.add_iref(Regexp.last_match[:intref])
+      end
+    },
+    new_attribute_conf: lambda { |matching_line|
+      attributes[matching_line[:attr].to_sym] = matching_line[:prefix]
+    },
+    new_attribute_value: lambda { |matching_line|
+      definitions.last.set_attribute(matching_line[:attr].to_sym, matching_line[:value])
+    },
+    new_variable_def: lambda { |matching_line|
+      variables[matching_line[:varname].to_sym] = matching_line[:value]
+    },
+    new_variable_use: lambda { |matching_line|
+      line = matching_line.line
+      line.scan(DMRegexp::VARIABLE_USE) do |_|
+        varname = Regexp.last_match[:varname]
+        value = variables[varname.to_sym]
+
+        next unless value
+
+        line = line.gsub("{#{varname}}", value)
+      end
+      line
+    }
+  }.freeze
+
+  private_constant :PARSER_ACTIONS
 
   # Reflects document structure from a definition point of view
   class Document
-    attr_reader :definitions, :labels, :eref, :iref, :attributes, :variables
+    extend Forwardable
+    def_delegators :@data, :definitions, :labels, :eref, :iref, :attributes, :variables
 
     def initialize
-      @definitions   = []
-      @labels        = Set.new
-      @eref          = {}
-      @iref          = false
-      @attributes    = {}
-      @variables     = {}
+      @data = DocumentData.new([], Set.new, {}, false, {}, {})
       @parsing_state = ParsingState.new
       @definition_parser = DefinitionParser.new(self)
     end
@@ -26,7 +84,7 @@ module DefMastership
         if @parsing_state.enabled?(line)
           apply_filters(line)
         else
-          generate_event(:new_line, nil, line)
+          generate_event(:new_line, MatchingLine.new(nil, line))
         end
       end
     end
@@ -36,96 +94,65 @@ module DefMastership
     end
 
     def wrong_explicit_checksum?
-      @definitions.reduce(false) do |res, definition|
-        res || !definition.wrong_explicit_checksum.nil?
+      definitions.reduce(false) do |res, definition|
+        res || !!definition.wrong_explicit_checksum
       end
     end
 
     def explicit_version?
-      @definitions.reduce(false) do |res, definition|
-        res || !definition.explicit_version.nil?
+      definitions.reduce(false) do |res, definition|
+        res || !!definition.explicit_version
       end
     end
 
-    def add_new_definition(match, line)
-      definition = Definition.new(match)
-      @labels.merge(definition.labels)
-      @definitions << definition
-      line
-    end
+    def method_missing(method_name, *args)
+      action = PARSER_ACTIONS[method_name]
+      return instance_exec(*args, &action) if action
 
-    def ref_to_def(ref)
-      @definitions.find { |definition| definition.reference == ref }
+      super
     end
 
-    def add_line(_match, line)
-      @definitions.last << line
-      line
-    end
-
-    def new_eref_setup(match, line)
-      @eref[match[:refname].to_sym] ||= {}
-      @eref[match[:refname].to_sym][match[:symb].to_sym] = match[:value]
-      line
-    end
-
-    def new_eref_def(match, line)
-      @definitions.last.add_eref(match[:refname].to_sym, match[:extrefs])
-      line
+    # This method smells of :reek:UtilityFunction
+    def respond_to_missing?(method_name, *_args)
+      PARSER_ACTIONS.key?(method_name)
     end
 
-    def new_iref_def(_match, line)
-      @iref = true
-      line.scan(DMRegexp::IREF_DEF) do |_|
-        @definitions.last.add_iref(Regexp.last_match[:intref])
-      end
-      line
+    def ref_to_def(reference)
+      definitions.find { |definition| definition.reference == reference }
     end
 
-    def new_attribute_conf(match, line)
-      @attributes[match[:attr].to_sym] = match[:prefix]
-      line
+    def iref=(value)
+      @data.iref = value
     end
 
-    def new_attribute_value(match, line)
-      @definitions.last.set_attribute(match[:attr].to_sym, match[:value])
-      line
-    end
+    private
 
-    def new_variable_def(match, line)
-      @variables[match[:varname].to_sym] = match[:value]
-      line
+    def apply_filters(line)
+      Helper.reduce_filters_until_consumed(line) do |event, match, updated_line|
+        generate_event(event, MatchingLine.new(match, updated_line))
+      end
     end
 
-    def new_variable_use(_match, line)
-      line.scan(DMRegexp::VARIABLE_USE) do |_|
-        varname = Regexp.last_match[:varname]
-        next if @variables[varname.to_sym].nil?
-
-        line = line.gsub("{#{varname}}", @variables[varname.to_sym])
+    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
-      line
     end
 
-    private
-
-    def apply_filters(line)
-      FILTERS.each do |filter|
-        next unless line.match(filter.regexp)
-
-        line = generate_event(filter.event, Regexp.last_match, line)
+    # Helper functions
+    module Helper
+      def self.reduce_filters_until_consumed(line)
+        FILTERS.reduce(line) do |res, filter|
+          next res unless line.match(filter.regexp)
 
-        break if filter.consumed_line
-      end
-    end
+          res = yield(filter.event, Regexp.last_match, res)
+          break if filter.consumed_line
 
-    def generate_event(event, match, line)
-      if respond_to?(event)
-        line = public_send(event, match, line)
-      else
-        @definition_parser.public_send(event, match, line)
+          res
+        end
       end
-      line
     end
   end
 end

data/lib/defmastership/matching_line.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # a composite class
+  MatchingLine =
+    Struct.new(:match, :line) do
+      def [](key)
+        value = match[key]
+        return value if value
+
+        super
+      end
+    end
+
+  public_constant :MatchingLine
+end

data/lib/defmastership/modifier.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # define methods for line modifiers
+  module Modifier
+    attr_reader :config, :changes
+
+    def setup_modifier_module(config)
+      @config = self.class.default_config.merge(config)
+      @changes = []
+    end
+
+    def method_missing(method_name, *args)
+      config_method_name = config[method_name]
+      return config_method_name if config_method_name
+
+      super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      config.key?(method_name) || super
+    end
+
+    def apply_to_all(texts, method)
+      texts.transform_values do |text|
+        apply_to_one(text, method)
+      end
+    end
+
+    def apply_to_one(text, method)
+      text.lines.map { |line| public_send(method, line) }
+          .join
+    end
+
+    def do_modifications(adoc_sources)
+      self.class.replacement_methods.reduce(adoc_sources) do |texts, method|
+        apply_to_all(texts, method)
+      end
+    end
+  end
+end

data/lib/defmastership/modifier_factory.rb

@@ -0,0 +1,12 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # build midifers from a piece of configuration
+  module ModifierFactory
+    def self.from_config(config)
+      class_name = "#{config.fetch(:type).split('_').map(&:capitalize).join}Modifier"
+      DefMastership.const_get(class_name).new(config.fetch(:config))
+    end
+  end
+end

data/lib/defmastership/parsing_state.rb

@@ -4,22 +4,28 @@
 module DefMastership
   # Allow to know if we need to parse the line or simply ignore it
   class ParsingState
+    # mutant:disable (for mutant, aatribute initialization is useless)
     def initialize
       @last_disabling_line = nil
     end
 
     def enabled?(line)
-      return false if line.match(DMRegexp::SINGLE_LINE_COMMENT)
+      return false if line.match?(DMRegexp::SINGLE_LINE_COMMENT)
 
-      line = line.dup.chomp
-      if ['....', '----', '////'].include?(line)
-        if @last_disabling_line == line
-          @last_disabling_line = nil
-        elsif @last_disabling_line.nil?
-          @last_disabling_line = line
-        end
+      line = line.chomp
+      possibly_invert_last_disabling_line(line) if ['....', '----', '////'].include?(line)
+
+      !@last_disabling_line
+    end
+
+    private
+
+    def possibly_invert_last_disabling_line(line)
+      if @last_disabling_line == line
+        @last_disabling_line = nil
+      elsif !@last_disabling_line
+        @last_disabling_line = line
       end
-      @last_disabling_line.nil?
     end
   end
 end

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