defmastership 1.3.0 → 1.3.2

data/lib/defmastership/app.rb

@@ -0,0 +1,116 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('csv')
+require('defmastership/batch_modifier')
+require('defmastership/config_preserver')
+require('defmastership/document')
+require('defmastership/export/csv/formatter')
+require('defmastership/version')
+require('gli')
+
+module Defmastership
+  # The start of everything !
+  class App
+    extend GLI::App
+
+    program_desc 'Tool to handle Asciidoctor definition extension'
+    subcommand_option_handling :normal
+    arguments :strict
+
+    version Defmastership::VERSION
+
+    # Helper method
+    def self.configure_export_flags(command)
+      command.flag(%i[separator sep s], default_value: ',', desc: 'CSV separator')
+      command.switch(%i[no-fail], desc: 'Exit success even in case of wrong explicit checksum')
+    end
+
+    desc 'Export the definition database in CSV'
+    arg 'asciidoctor_file'
+    command :export do |command|
+      configure_export_flags(command)
+      command.action do |_global_options, options, args|
+        @results = { number_of_args_give_to_action: args.size }
+
+        my_doc = Defmastership::Document.new
+        my_doc.parse_file_with_preprocessor(args.first)
+
+        output_file = args.first.sub(/\.adoc$/, '.csv')
+
+        Defmastership::Export::CSV::Formatter.new(my_doc, options['separator']).export_to(output_file)
+
+        if my_doc.wrong_explicit_checksum?
+          my_doc.definitions.each do |definition|
+            next if definition.wrong_explicit_checksum.nil?
+
+            warn(
+              "warning: #{definition.reference} has a wrong explicit " \
+              "checksum (should be #{definition.sha256_short})"
+            )
+          end
+          exit 1 unless options[:'no-fail']
+        end
+      end
+    end
+
+    # Helper method
+    def self.configure_modify_flags(command)
+      configure_modify_modifications_flag(command)
+      configure_modify_modifications_file_flag(command)
+      configure_modify_changes_summary_flag(command)
+    end
+
+    # Helper method
+    def self.configure_modify_modifications_flag(command)
+      command.flag(
+        %i[modifications mod m],
+        must_match: /(?:[\w-]+)(?:,[\w-]+)*/,
+        default_value: 'all',
+        desc: 'comma separated list of modifications to apply'
+      )
+    end
+
+    # Helper method
+    def self.configure_modify_modifications_file_flag(command)
+      command.flag(
+        %i[modifications-file mf],
+        default_value: 'modifications.yml',
+        desc: 'modifications description file'
+      )
+    end
+
+    # Helper method
+    def self.configure_modify_changes_summary_flag(command)
+      command.flag(
+        %i[changes-summary s],
+        desc: 'generates a change summary in a CSV file'
+      )
+    end
+
+    desc 'Apply one or more modifications'
+    arg 'asciidoctor_file'
+    arg 'asciidoctor_file', %i[optional multiple]
+    command :modify do |command|
+      configure_modify_flags(command)
+
+      command.action do |_global_options, options, args|
+        @results = { number_of_args_give_to_action: args.size }
+        config_preserver = Defmastership::ConfigPreserver.new(options[:'modifications-file'])
+        changer = BatchModifier.new(config_preserver.config, args.to_h { |afile| [afile, File.read(afile)] })
+        changer.apply(options[:modifications].split(/\s*,\s*/).map(&:to_sym))
+        changer.adoc_sources.each do |adoc_filename, adoc_text|
+          File.write(adoc_filename, adoc_text)
+        end
+        config_preserver.save(changer.config)
+
+        unless options['changes-summary'].nil?
+          CSV.open(options['changes-summary'], 'wb') do |csv|
+            csv << %w[Modifier Was Becomes]
+            changer.changes.each { |row| csv << row }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/batch_modifier.rb

@@ -1,6 +1,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require('defmastership/modifier/factory')
+
 module Defmastership
   # Apply modications on a list of related asciidoc sources
   class BatchModifier

data/lib/defmastership/config_preserver.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/hash_merge_no_new')
+require('yaml')
+
+module Defmastership
+  # The configuration can be modified by Mofifiers (e.g. ChangeRef).
+  # The configuration file need to include these modifications without:
+  #   - saving default values
+  #   - removing empty line
+  #   - removing comments
+  class ConfigPreserver
+    def initialize(filename)
+      @filename = filename
+    end
+
+    # Get the yaml config from configuration file
+    #
+    # @return [Hash] the configuration
+    def config
+      # idiomatic way to perform a deep clone of a hash
+      Marshal.load(Marshal.dump(YAML.load_file(@filename)))
+    end
+
+    # Save the updated configuration taking into account blank lines and comments
+    #
+    # @return [Hash] the configuration
+    def save(new_config)
+      # we don't wan't to add new configuration items from default values
+      new_config_content = config.merge_no_new(new_config).to_yaml.split("\n")
+
+      # Put in there place the emty lines and comments
+      File.open(@filename, 'r').each_line(chomp: true).with_index do |line, line_num|
+        if /\A\s*(\#.*)?\z/.match?(line)
+          new_config_content.insert(line_num, line)
+        elsif line =~ /\A\s*[^\s].+?(\s*\#.*)\z/
+          new_config_content[line_num] += Regexp.last_match(1)
+        end
+      end
+
+      File.write(@filename, "#{new_config_content.join("\n")}\n")
+    end
+  end
+end

data/lib/defmastership/definition.rb

@@ -1,7 +1,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require 'digest'
+require('digest')
+require('forwardable')
 
 # Contains the content of a Defmastership definition
 module Defmastership
@@ -15,7 +16,7 @@ module Defmastership
       labels.merge(match[:labels].split(/\s*,\s*/).to_set) if match[:labels]
       labels
     end,
-    eref: ->(_) { Hash.new([]) },
+    eref: ->(_) { Hash.new { |hash, key| hash[key] = [] } },
     iref: ->(_) { [] },
     attributes: ->(_) { {} },
     explicit_checksum: ->(match) { match[:explicit_checksum] },
@@ -43,6 +44,7 @@ module Defmastership
   # Defmastership definition: contains all data of a definition
   class Definition
     extend Forwardable
+
     def_delegators :@data,
                    :type,
                    :reference,

data/lib/defmastership/document.rb

@@ -4,7 +4,11 @@
 require('asciidoctor')
 require('defmastership/core/constants')
 require('defmastership/core/parsing_state')
+require('defmastership/definition')
+require('defmastership/definition_parser')
+require('defmastership/filters')
 require('defmastership/matching_line')
+require('forwardable')
 
 # Contains the content of a Defmastership document: mainly definitions
 module Defmastership
@@ -75,6 +79,7 @@ module Defmastership
   # Reflects document structure from a definition point of view
   class Document
     extend Forwardable
+
     def_delegators :@data, :definitions, :labels, :eref, :iref, :attributes, :variables
 
     def initialize
@@ -134,7 +139,7 @@ module Defmastership
     # @param reference [String] the  defintion from the reference
     # @return [Definition] the defintion from the reference
     def ref_to_def(reference)
-      definitions.find { |definition| definition.reference == reference }
+      definitions.find { |definition| definition.reference.eql?(reference) }
     end
 
     private

data/lib/defmastership/export/body_formatter.rb

@@ -1,8 +1,6 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/set_join_hack')
-
 module Defmastership
   module Export
     # format CSV lines per definition

data/lib/defmastership/export/header_formatter.rb

@@ -1,8 +1,6 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('csv')
-
 module Defmastership
   module Export
     # format CSV header (first line) for one document

data/lib/defmastership/hash_merge_no_new.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2025 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# adding a method to hash to allow to merge two hases only by modifying aready existing entries
+class Hash
+  # Merges another hash by updating only the values for keys that already exist.
+  # It does not add new keys from the other hash. The merge is recursive for nested hashes.
+  # @param other_hash [Hash] The hash to merge from.
+  # @return [Hash] The new, merged hash.
+  def merge_no_new(other_hash)
+    # We use #merge with a block to handle key "collisions".
+    # We only merge the keys from `other_hash` that already exist in `self`
+    # by using `other_hash.slice(*keys)`.
+    merge(other_hash.slice(*keys)) do |_key, old_val, new_val|
+      if old_val.is_a?(Hash) && new_val.is_a?(Hash)
+        # Recursive call if both values are hashes
+        old_val.merge_no_new(new_val)
+      else
+        # else, we simply take the new value
+        new_val
+      end
+    end
+  end
+end

data/lib/defmastership/modifier/change_ref.rb

@@ -1,9 +1,9 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require 'defmastership/core/constants'
-require('defmastership/core/parsing_state')
-require 'defmastership/modifier/modifier_common'
+require('defmastership/core/constants')
+require('defmastership/modifier/modifier_common')
+require('facets/file/writelines')
 
 module Defmastership
   module Modifier
@@ -12,7 +12,7 @@ module Defmastership
       include ModifierCommon
 
       # [Regexp] match all text before the definition's reference
-      DEF_BEFORE_REF = <<~"BEF"
+      DEF_BEFORE_REF = <<~"BEF".freeze
         ^
         \\s*
         \\[
@@ -24,7 +24,7 @@ module Defmastership
       private_constant :DEF_BEFORE_REF
 
       # [Regexp] match all text after the definition's reference
-      DEF_AFTER_REF = <<~"AFT"
+      DEF_AFTER_REF = <<~"AFT".freeze
         \\s*
         #{Core::DMRegexp::DEF_SUMMARY}
         #{Core::DMRegexp::DEF_LABELS}
@@ -57,7 +57,7 @@ module Defmastership
       #
       # @return [Array<Symbol>] the two symbols of replacement methods
       def self.replacement_methods
-        %i[replace_refdef replace_irefs]
+        %i[replace_refdef replace_irefs replace_include_tags replace_tags_in_included_files]
       end
 
       # @return [Hash{Symbol => Object}] the default configuration
@@ -100,6 +100,29 @@ module Defmastership
         end
       end
 
+      # Replace the definition's refs in tags of include statements
+      #
+      # @param line [String] the current line
+      # @return [String] the modified line
+      def replace_include_tags(line)
+        return line unless line.match?(Core::DMRegexp::INCLUDE)
+
+        changes.reduce(line) do |res_line, (from, to)|
+          res_line.sub(/(?<before>tags?=!?([^;]*;)?)#{from}\b/) { "#{$LAST_MATCH_INFO[:before]}#{to}" }
+        end
+      end
+
+      # Replace the definition's refs in included files
+      #
+      # @param line [String] the current line
+      # @return [String] the (unmodified) line
+      def replace_tags_in_included_files(line)
+        if line.match(Core::DMRegexp::INCLUDE)
+          Helper.replace_tags_in_included_files(Helper::ParsedFilename.full_filename(Regexp.last_match), changes)
+        end
+        line
+      end
+
       private
 
       def do_replace_refdef(line)
@@ -134,12 +157,54 @@ module Defmastership
           Regexp.new(regexp_str, Regexp::EXTENDED)
         end
 
-        # @param  match [MatchData] The match form Regepxp match
+        # @param  match [MatchData] The match from Regexp match
         # @param  replacement [String] the reference replacement text
         # @return [String] the overall replaced text
         def self.text_with(match, replacement)
           match[:before] + replacement + (match[:version_and_checksum] || '') + match[:after]
         end
+
+        # Replace the definition's refs in included files
+        #
+        # @param  filename [String] the included file name
+        # @param  changes [Array<Array<String>>] the changes to apply
+        # @return [void]
+        def self.replace_tags_in_included_files(filename, changes)
+          lines = File.readlines(filename)
+
+          new_lines =
+            lines.map do |included_line|
+              apply_changes_in_included_file_line(included_line, changes)
+            end
+
+          File.writelines(filename, new_lines)
+        end
+
+        # Do the concrete replacements in included files
+        #
+        # @param  line [String] The line from the included file
+        # @param  changes [Array<Array<String>>] the changes to apply
+        # @return [String] the modified line with all changes
+        def self.apply_changes_in_included_file_line(line, changes)
+          changes.reduce(line) do |res_line, (from, to)|
+            if res_line.match?(/(tag|end)::#{from}\[\]/)
+              res_line.sub(from, to)
+            else
+              res_line
+            end
+          end
+        end
+
+        # Build filename from match data
+        module ParsedFilename
+          # build the full filename from the match of an include statement
+          #
+          # @param  match [MatchData] The match from Regexp match
+          # @return [String] the overall filename
+          def self.full_filename(match)
+            (match[:path] || '') + match[:filename]
+          end
+        end
       end
       private_constant :Helper
     end

data/lib/defmastership/modifier/factory.rb

@@ -1,6 +1,11 @@
 # Copyright (c) 2023 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require('defmastership/modifier/change_ref')
+require('defmastership/modifier/rename_included_files')
+require('defmastership/modifier/update_def_checksum')
+require('defmastership/modifier/update_def_version')
+
 module Defmastership
   module Modifier
     # build modifiers from a piece of configuration

data/lib/defmastership/modifier/rename_included_files.rb

@@ -1,9 +1,7 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/core/constants')
-require('defmastership/matching_line')
-require('defmastership/modifier/modifier_common')
+require('defmastership/filters')
 
 module Defmastership
   # defintion of the Rename Included Files Modifier

data/lib/defmastership/modifier/update_def.rb

@@ -1,8 +1,6 @@
 # Copyright (c) 2024 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('defmastership/core/constants')
-
 module Defmastership
   module Modifier
     # @abstract Subclass and define +reference_replacement+ to implement a
@@ -62,7 +60,7 @@ module Defmastership
         match = line.match(Core::DMRegexp::DEFINITION)
 
         return line unless match
-        return line unless match[:type] == def_type
+        return line unless match[:type].eql?(def_type)
 
         reference = match[:reference]
         line.sub(self.class.reference_regexp(reference), reference_replacement(reference, match))

data/lib/defmastership/modifier/update_def_checksum.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require 'defmastership/modifier/update_def'
+require('defmastership/modifier/update_def')
 
 module Defmastership
   module Modifier

data/lib/defmastership/modifier/update_def_version.rb

@@ -1,9 +1,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require 'defmastership/modifier/update_def'
-require 'git'
-require 'tmpdir'
+require('defmastership/modifier/update_def')
+require('git')
 
 module Defmastership
   module Modifier
@@ -36,7 +35,7 @@ module Defmastership
       #  * :key filename
       #  * :value file content
       def do_modifications(adoc_sources)
-        if ref_tag == ''
+        if ref_tag.eql?('')
           ref_document.each { |ref_doc| @ref_document.parse_file_with_preprocessor(ref_doc) }
         else
           Dir.mktmpdir('defmastership') do |tmpdir|
@@ -92,7 +91,7 @@ module Defmastership
         # @return [String] the current definition version
         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
+          return new_ref_version if definition.sha256_short.eql?(ref_definition.sha256_short)
 
           new_ref_version ? new_ref_version.next : first_version
         end

data/lib/defmastership/version.rb

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

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require('aasm/rspec')
-require('aruba/rspec')
 
 # formatter = [SimpleCov::Formatter::HTMLFormatter]
 # SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatter)
@@ -17,15 +16,9 @@ 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|
-  config.include(Aruba::Api)
+  minimum_coverage line: 100, branch: 100
 end
 
 RSpec::Matchers.define(:matchdata_including) do |h|
@@ -35,5 +28,3 @@ RSpec::Matchers.define(:matchdata_including) do |h|
     end
   end
 end
-
-require('defmastership')