defmastership 1.0.19 → 1.1.0

data/lib/defmastership/modifier/update_def_version.rb

@@ -0,0 +1,110 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require 'defmastership/modifier/update_def'
+require 'git'
+require 'tmpdir'
+
+module Defmastership
+  module Modifier
+    # modify one line after another
+    class UpdateDefVersion < UpdateDef
+      # @return [Hash{Symbol => Object}] the default configuration
+      def self.default_config
+        {
+          def_type: '',
+          ref_document: [],
+          ref_tag: '',
+          ref_repo: '.',
+          first_version: ''
+        }
+      end
+
+      # @param config [YAML] the modifier's provided configurations
+      def initialize(config)
+        @ref_document = Document.new
+
+        Helper.normalilize_config!(config) if config.key?(:ref_document)
+
+        super
+      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)
+        if ref_tag == ''
+          ref_document.each { |ref_doc| @ref_document.parse_file_with_preprocessor(ref_doc) }
+        else
+          Dir.mktmpdir('defmastership') do |tmpdir|
+            parse_ref_files_from_git(adoc_sources, tmpdir)
+          end
+        end
+
+        super
+      end
+
+      private
+
+      def parse_ref_files_from_git(adoc_sources, tmpdir)
+        Git.clone(ref_repo, tmpdir, branch: ref_tag)
+        ref_sources = ref_document.empty? ? adoc_sources.keys : ref_document
+        ref_sources.each do |adoc_file|
+          @ref_document.parse_file_with_preprocessor("#{tmpdir}/#{adoc_file}")
+        end
+      end
+
+      def reference_replacement(reference, match)
+        "#{reference}#{version_and_checksum_str(match)}"
+      end
+
+      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, first_version)
+      end
+
+      # Helper functions
+      module Helper
+        # @param doc [Document] the document with defintions
+        # @param match [MatchData] Regexp match matching a reference
+        # @return [Definition] the definition from a +Document+ with a matching reference
+        def self.def_from_match(doc, match)
+          doc.ref_to_def(match[:reference])
+        end
+
+        # @param ref_definition [Definition] the definition from the reference document
+        # @param definition [Definition] the definition from the current document
+        # @param first_version [String] first version from configuration
+        # @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
+
+          new_ref_version ? new_ref_version.next : first_version
+        end
+
+        # Make sure that ref_document configuration is an Array
+        #
+        # @param config [YAML] the definition from the reference document
+        def self.normalilize_config!(config)
+          ref_docs = config.fetch(:ref_document)
+          config[:ref_document] = [ref_docs] if ref_docs.instance_of?(String)
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/set_join_hack.rb

@@ -4,6 +4,8 @@
 if RUBY_VERSION < '3.0'
   # Ruby 2.7 do not implement join for Set
   class Set
+    # @param args [String] the separator (default: '')
+    # @return [String] join value of the set elements
     def join(*args)
       to_a.join(*args)
     end

data/lib/defmastership/version.rb

@@ -1,7 +1,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-module DefMastership
-  VERSION = '1.0.19'
+module Defmastership
+  # [String] Gem version
+  VERSION = '1.1.0'
   public_constant :VERSION
 end

data/lib/defmastership.rb

@@ -6,16 +6,14 @@ 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_modifier')
 require('defmastership/comment_filter')
-require('defmastership/constants')
-require('defmastership/csv_formatter')
 require('defmastership/definition')
 require('defmastership/definition_parser')
 require('defmastership/document')
+require('defmastership/export/csv/formatter')
 require('defmastership/filters')
-require('defmastership/modifier_factory')
-require('defmastership/parsing_state')
-require('defmastership/rename_included_files_modifier')
-require('defmastership/update_def_checksum_modifier')
-require('defmastership/update_def_version_modifier')
+require('defmastership/modifier/change_ref')
+require('defmastership/modifier/factory')
+require('defmastership/modifier/rename_included_files')
+require('defmastership/modifier/update_def_checksum')
+require('defmastership/modifier/update_def_version')

data/spec/unit/{def_mastership → defmastership}/batch_modifier_spec.rb

@@ -3,19 +3,19 @@
 
 require('defmastership/batch_modifier')
 
-module DefMastership
+module Defmastership
   # Modifier example
-  class TotoModifier
+  class Toto
     include Modifier
   end
 
   # Modifier example
-  class TuTuModifier
+  class TuTu
     include Modifier
   end
 end
 
-RSpec.describe(DefMastership::BatchModifier) do
+RSpec.describe(Defmastership::BatchModifier) do
   subject(:batchmodifier) do
     described_class.new(config, adoc_sources)
   end
@@ -45,7 +45,7 @@ RSpec.describe(DefMastership::BatchModifier) do
 
   describe '#apply' do
     context 'with only one modification' do
-      let(:toto1) { instance_double(DefMastership::TotoModifier, 'toto1') }
+      let(:toto1) { instance_double(Defmastership::Modifier::Toto, 'toto1') }
       let(:adoc_sources_modified) do
         {
           'file1.adoc' => 'some text modified',
@@ -62,7 +62,7 @@ RSpec.describe(DefMastership::BatchModifier) do
       end
 
       before do
-        allow(DefMastership::TotoModifier).to(receive(:new).once.and_return(toto1))
+        allow(Defmastership::Modifier::Toto).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]]))
@@ -70,7 +70,7 @@ RSpec.describe(DefMastership::BatchModifier) do
       end
 
       it do
-        expect(DefMastership::TotoModifier).to(have_received(:new).with(p: 1))
+        expect(Defmastership::Modifier::Toto).to(have_received(:new).with(p: 1))
       end
 
       it { expect(toto1).to(have_received(:do_modifications).with(adoc_sources)) }
@@ -82,8 +82,8 @@ RSpec.describe(DefMastership::BatchModifier) do
     end
 
     context 'with two modifications' do
-      let(:toto2) { instance_double(DefMastership::TotoModifier, 'toto2') }
-      let(:tutu3) { instance_double(DefMastership::TuTuModifier, 'tutu3') }
+      let(:toto2) { instance_double(Defmastership::Modifier::Toto, 'toto2') }
+      let(:tutu3) { instance_double(Defmastership::Modifier::TuTu, 'tutu3') }
 
       let(:config_modified) do
         {
@@ -94,10 +94,10 @@ RSpec.describe(DefMastership::BatchModifier) do
       end
 
       before do
-        allow(DefMastership::TotoModifier).to(receive(:new).once.and_return(toto2))
+        allow(Defmastership::Modifier::Toto).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::TuTuModifier).to(receive(:new).once.and_return(tutu3))
+        allow(Defmastership::Modifier::TuTu).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]]))
@@ -105,8 +105,8 @@ RSpec.describe(DefMastership::BatchModifier) do
         batchmodifier.apply(%i[modifier2 modifier3])
       end
 
-      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(Defmastership::Modifier::Toto).to(have_received(:new).with(p: 'whatever1')) }
+      it { expect(Defmastership::Modifier::TuTu).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_sources_modified_mod2)) }

data/spec/unit/{def_mastership → defmastership}/definition_parser_spec.rb

@@ -3,7 +3,7 @@
 
 require('defmastership/definition_parser')
 
-RSpec.describe(DefMastership::DefinitionParser) do
+RSpec.describe(Defmastership::DefinitionParser) do
   subject(:parser) { described_class.new(callback_object) }
 
   let(:callback_object) { double }

data/spec/unit/{def_mastership → defmastership}/definition_spec.rb

@@ -3,7 +3,7 @@
 
 require('defmastership/definition')
 
-RSpec.describe(DefMastership::Definition) do
+RSpec.describe(Defmastership::Definition) do
   describe '.new' do
     context 'when minimal' do
       subject do