asciidoctor-defmastership 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49fb875efec0cb60de96088d4b0e5ab90a50c433451d3bb0c8a934efd0d0cbf0
-  data.tar.gz: 32b56aa5a4221c309f27bf064a68727a4459946dca1d09439d20ac366088f315
+  metadata.gz: c7a66599bbeb35d3fabb9ae1f4c6aa1513a3df1aab55bd273d32effb2c817d25
+  data.tar.gz: d5adce64bed24916c2a67c5a0510da1b46a24f0075d288b1217ef216da829b35
 SHA512:
-  metadata.gz: b748eb9d7d25537ce30f4c0d899cc906516f07ac0fdb59e4babce30f394dbbffbdc2f16aafe70186580719512a13b74038b55af5f5e8697ee42264eede8d6ef8
-  data.tar.gz: 2a36075bca780cb13332c9841c5c65834c49f9873d389fea158f142313b908cd5e7e3e0ea61d907620ada1415524a9ae3fae9e5032a0a07fadaf70b8989f9215
+  metadata.gz: 36bd2d7b1375d31c8603b487aa66bd8dd6cd4d5ab1589a8a0e51712bbbb7d6b1dcbb13f7ad8d274bb5a7be6ee395c7ade73014c6435da760126b6e040c988fa0
+  data.tar.gz: 766099a3e29be419ccc797f2e541bd1162249ae7c435a02fe65e0a081ac22e00840dd75f536f0672cc2f3c8accc942d97021c1515751914cb6eaa8850fa0735e

data/.gitlab-ci.yml

@@ -1,9 +1,6 @@
 default:
-  image: ruby:3.3
+  image: ruby:3.4
   before_script:
-    - apt-get update
-    - ruby -v
-    - which ruby
     - gem install bundler --no-document
     - bundle install --jobs $(nproc) "${FLAGS[@]}"
 
@@ -26,54 +23,22 @@ code quality:
   script:
     - bundle exec rake quality:all
 
-bdd ruby2.7:
-  image: ruby:2.7
-  before_script:
-    - apt-get update
-    - ruby -v
-    - which ruby
-    - gem install bundler -v 2.4.22 --no-document
-    - bundle install --jobs $(nproc) "${FLAGS[@]}"
-  script:
-    - bundle exec rake test:features
-
-bdd ruby3.0:
-  image: ruby:3.0
-  script:
-    - bundle exec rake test:features
-
-bdd ruby3.1:
-  image: ruby:3.1
-  script:
-    - bundle exec rake test:features
-
 bdd ruby3.2:
   image: ruby:3.2
   script:
     - bundle exec rake test:features
 
-unit tests ruby2.7:
-  image: ruby:2.7
-  before_script:
-    - apt-get update
-    - ruby -v
-    - which ruby
-    - gem install bundler -v 2.4.22 --no-document
-    - bundle install --jobs $(nproc) "${FLAGS[@]}"
-  script:
-    - bundle exec rake test:spec
-
-unit tests ruby3.0:
-  image: ruby:3.0
+bdd ruby3.3:
+  image: ruby:3.3
   script:
-    - bundle exec rake test:spec
+    - bundle exec rake test:features
 
-unit tests ruby3.1:
-  image: ruby:3.1
+unit tests ruby3.2:
+  image: ruby:3.2
   script:
     - bundle exec rake test:spec
 
-unit tests ruby3.2:
+unit tests ruby3.3:
   image: ruby:3.2
   script:
     - bundle exec rake test:spec

data/Gemfile

@@ -7,56 +7,36 @@ gemspec
 
 ruby RUBY_VERSION
 
-# rubocop:disable Metrics/BlockLength
 group :development do
   # cucumber steps for command line tests
-  gem 'aruba',                 '~> 2'
+  gem 'aruba',                 '~> 2.3'
   # bdd
-  gem 'cucumber',              '~> 9'
-
-  if RUBY_VERSION >= '3.0'
-    # mutation testing
-    plan = 'oss'
-    key = '7oac4dMz95cTUuFPtGDfTDSQep6ZhdGW'
-    source "https://#{plan}:#{key}@gem.mutant.dev" do
-      # license needed
-      gem 'mutant-license', '~> 0'
-    end
-    # mutation testing
-    gem 'mutant-rspec', '~> 0'
-  end
+  gem 'cucumber',              '~> 10.1'
+  # mutation testing
+  gem 'mutant-rspec', '~> 0.13'
   # to parse provided Rakefile
-  gem 'rake', '~> 13'
-
-  if RUBY_VERSION >= '3.0'
-    # needed by yard to render documentation
-    gem 'rdoc', '~> 6'
-  end
+  gem 'rake', '~> 13.3'
+  # needed by yard to render documentation
+  gem 'rdoc', '~> 6.14'
   # tdd
-  gem 'rspec', '~> 3'
+  gem 'rspec', '~> 3.13'
   # code need to be clean
-  gem 'rubocop', '1.65'
+  gem 'rubocop', '1.80'
   # code need to be clean
-  gem 'rubocop-performance', '~> 1'
+  gem 'rubocop-performance', '~> 1.25'
   # Rakile needs to be clean
-  gem 'rubocop-rake', '~> 0'
+  gem 'rubocop-rake', '~> 0.7'
   # unit tests need to be clean
-  gem 'rubocop-rspec', '~> 2'
-  if RUBY_VERSION >= '3.0'
-    # detect selling code
-    gem 'reek', '~> 6'
-  end
+  gem 'rubocop-rspec', '~> 3.6'
+  # detect selling code
+  gem 'reek', '~> 6.5'
   # What is tdd without code coverage ?
-  gem 'simplecov', '~> 0'
-
-  if RUBY_VERSION >= '3.0'
-    # to document code
-    gem 'yard', '~> 0'
-  end
+  gem 'simplecov', '~> 0.22'
+  # to document code
+  gem 'yard', '~> 0.9'
 end
-# rubocop:enable Metrics/BlockLength
 
 group :debugging do
   # Sometimes, we need to debug
-  gem 'pry', '~> 0'
+  gem 'pry', '~> 0.15'
 end

data/asciidoctor-defmastership.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
     'rubygems_mfa_required' => 'true'
   }
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
   spec.name          = 'asciidoctor-defmastership'
   spec.version       = Asciidoctor::Defmastership::VERSION
   spec.authors       = ['Jérôme Arbez-Gindre']
@@ -38,6 +38,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency('asciidoctor', '~> 2.0')
-  spec.add_dependency('defmastership-core', '~> 1.4')
+  spec.add_dependency('defmastership-core', '~> 1.5.2')
   spec.add_dependency('ostruct', '~> 0.6')
 end

data/config/reek.yml

@@ -1,5 +1,5 @@
 ---
-# detectors:
+detectors:
 #   Attribute:
 #     enabled: true
 #     exclude: []
@@ -12,11 +12,11 @@
 #   ControlParameter:
 #     enabled: true
 #     exclude: []
-#   DataClump:
+  DataClump:
 #     enabled: true
 #     exclude: []
 #     max_copies: 2
-#     min_clump_size: 2
+    min_clump_size: 3
 #   DuplicateMethodCall:
 #     enabled: true
 #     exclude: []

data/config/rubocop.yml

@@ -9,13 +9,13 @@
 #
 # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   EnabledByDefault: true
   DisplayCopNames: true
 

data/lib/asciidoctor-defmastership/preprocessor.rb

@@ -37,6 +37,7 @@ module Asciidoctor
         eref_config: ::Defmastership::Core::DMRegexp::EREF_CONFIG,
         definition: ::Defmastership::Core::DMRegexp::DEFINITION,
         eref_def: ::Defmastership::Core::DMRegexp::EREF_DEF,
+        ref_def: ::Defmastership::Core::DMRegexp::REF_WITH_OPT_VER_CHK,
         iref_def: ::Defmastership::Core::DMRegexp::IREF_DEF,
         attr_set: ::Defmastership::Core::DMRegexp::ATTR_SET,
         variable_def: ::Defmastership::Core::DMRegexp::VARIABLE_DEF
@@ -98,7 +99,7 @@ module Asciidoctor
       # @param match [MatchData] the match data from the matching Regexp
       # @return [Array<String>] the lines to replace the original line
       def build_external_ref(_line, match)
-        return [] unless show_ext_ref(match)
+        return [] unless show_ext_ref?(match)
 
         extrefs = match[:extrefs].split(/\s*,\s*/)
         extref_line = extrefs.map { |ref| build_link(ref, match) }
@@ -114,8 +115,8 @@ module Asciidoctor
       def build_internal_ref(line, _match)
         [
           line.gsub(REGEXPS.fetch(:iref_def)) do
-            intref = Regexp.last_match[:intref]
-            "<<#{intref},#{intref}>>"
+            reference, shown_ref = Helper.iref_shown_ref(Regexp.last_match, @variables)
+            "<<#{reference},#{shown_ref}>>"
           end
         ]
       end
@@ -165,19 +166,24 @@ module Asciidoctor
 
       def build_link(ref, match)
         refname = match[:reference]
-        return ref unless @has_url.include?(refname)
 
-        ref_pattern =
-          @variables["eref-#{refname}-ref-pattern"] || '#%s'
-        ref_str = format(ref_pattern, ref)
+        reference, shown_ref = Helper.eref_shown_ref(refname, ref.match(/#{REGEXPS.fetch(:ref_def)}/), @variables)
 
-        "link:{eref-#{refname}-url}#{ref_str}[#{ref}]"
+        return shown_ref unless @has_url.include?(refname)
+
+        formatted_url_link(refname, reference, shown_ref)
       end
 
-      def show_ext_ref(match)
+      def show_ext_ref?(match)
         !@variables['show-ext-ref'].eql?('disable') &&
           !@variables["show-#{match[:reference]}-ext-ref"].eql?('disable')
       end
+
+      def formatted_url_link(refname, reference, shown_ref)
+        ref_pattern = @variables.fetch("eref-#{refname}-ref-pattern", '#%s')
+        ref_str = format(ref_pattern, reference)
+        "link:{eref-#{refname}-url}#{ref_str}[#{shown_ref}]"
+      end
     end
 
     # Proepocessors class Helpers
@@ -250,10 +256,70 @@ module Asciidoctor
         end
 
         # @param match [MatchData] the match data from the matching variable setting Regexp
-        # @return [[Hash{String => Object}]] the hash corresponding to the variable setting
+        # @return [Hash{String => String}] the hash corresponding to the variable setting
         def self.variable_hash(match)
           { match[:varname] => match[:value] }
         end
+
+        # @param refname [String] the name associated to the reference
+        # @param matched_ref [MatchData] the parsed reference with optional version and checksum
+        # @param variables [Hash{String => String}] all seen document variables
+        #
+        # @return [[String, String]] the reference and the formated ref to show in the generated doc
+        def self.eref_shown_ref(refname, matched_ref, variables)
+          reference = matched_ref[:reference]
+          version_checksum = eref_build_version_checksum(refname, matched_ref, variables)
+          shown_ref = format_ref_with_checksum(reference, version_checksum)
+
+          [reference, shown_ref]
+        end
+
+        # @param matched_ref [MatchData] the parsed reference with optional version and checksum
+        # @param variables [Hash{String => String}] all seen document variables
+        #
+        # @return [[String, String]] the reference and the formated ref to show in the generated doc
+        def self.iref_shown_ref(matched_ref, variables)
+          reference = matched_ref[:intref]
+          version_checksum = iref_build_version_checksum(matched_ref, variables)
+          shown_ref = format_ref_with_checksum(reference, version_checksum)
+
+          [reference, shown_ref]
+        end
+
+        # @param refname [String] the name associated to the reference
+        # @param matched_ref [MatchData] the parsed reference with optional version and checksum
+        # @param variables [Hash{String => String}] all seen document variables
+        #
+        # @return [string] the combined version and checksum string.
+        def self.eref_build_version_checksum(refname, matched_ref, variables)
+          version = matched_ref[:explicit_version].to_s
+
+          return version if variables["eref-#{refname}-show-checksum"] == 'disable'
+
+          version + matched_ref[:explicit_checksum].to_s
+        end
+
+        # @param matched_ref [MatchData] the parsed reference with optional version and checksum
+        # @param variables [Hash{String => String}] all seen document variables
+        #
+        # @return [string] the combined version and checksum string.
+        def self.iref_build_version_checksum(matched_ref, variables)
+          version = matched_ref[:explicit_version].to_s
+
+          return version if variables['iref-show-checksum'] == 'disable'
+
+          version + matched_ref[:explicit_checksum].to_s
+        end
+
+        # @param reference [String] the concernend reference
+        # @param version_checksum [String] The version/checksum eventually empty
+        #
+        # @return [string] the formated ref to show in the generated doc
+        def self.format_ref_with_checksum(reference, version_checksum)
+          return reference if version_checksum.empty?
+
+          "#{reference}(#{version_checksum})"
+        end
       end
     end
   end

data/lib/asciidoctor-defmastership/version.rb

@@ -5,7 +5,7 @@ module Asciidoctor
   # main application module
   module Defmastership
     # [String] Gem version
-    VERSION = '1.3.0'
+    VERSION = '1.3.1'
     public_constant :VERSION
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-defmastership
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +90,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,15 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: asciidoctor extension to handle applicable definition references
 test_files: []