asciidoctor-defmastership 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0425e34011a043292dc14256c4649ec16f0bdade8f2a746e586c3011dc4ad1fc
-  data.tar.gz: c30c83e7c430f0b20889011ef5fd8b8fa5ff21419cd48dfef7f8be0302ca7832
+  metadata.gz: 32c34eada26d2c22399f1418c4eef3753832cff1363ff0d82ab1f2308af83ca4
+  data.tar.gz: 95e344b6e198af8ce03fa005a9545a8d256183966547cd5dacd3f2a4fef802ba
 SHA512:
-  metadata.gz: 8084b8fbe8836c2bcd30b8b9afc754879f53341d7b117234183be59dcdab6c6d87e5fef7f534b673f9f13283f6e4f398decd341c4c6cc185b138ee35134f118c
-  data.tar.gz: '0869b435d1224cab6ffe0637b87bedf6f9080e991b9382331d72e2238270eaa7b286997a071fc161f54249794e0afd9d8eb91b94d1f288cc654501934db1c159'
+  metadata.gz: f860c3c2c9dcc1743495c8f806a9085a5be1ab836bd87f4282902423420157b96e3d0f2b5e61e3d70a95055a955c00e7ff619e1b95462d293f412d4701002d95
+  data.tar.gz: 9918bb1738b73827e6c5071effd3f44b91cc3ddaa607ad06ca2cdea3b25e42f9cd75d4300018f3e9dd1bf28362e3aacbd3251666cfe2a3d9b723f82b83c0e83b

data/.gitignore

@@ -13,3 +13,4 @@
 *.csv
 *.gem
 /Gemfile.lock
+/.ruby-version

data/.gitlab-ci.yml

@@ -1,5 +1,5 @@
 default:
-  image: ruby:2.5
+  image: ruby:3.2
   before_script:
     - apt-get update
     - ruby -v
@@ -7,10 +7,25 @@ default:
     - gem install bundler --no-document
     - bundle install --jobs $(nproc) "${FLAGS[@]}"
 
-rspec:
+unit tests:
   script:
     - bundle exec rake spec
 
 rubocop:
   script:
     - bundle exec rake rubocop
+
+unit tests ruby2.7:
+  image: ruby:2.7
+  script:
+    - bundle exec rake spec
+
+unit tests ruby3.0:
+  image: ruby:3.0
+  script:
+    - bundle exec rake spec
+
+unit tests ruby3.1:
+  image: ruby:3.1
+  script:
+    - bundle exec rake spec

data/.rubocop.yml

@@ -10,26 +10,30 @@
 # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
 
 require:
+  - rubocop-performance
   - rubocop-rspec
+  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   EnabledByDefault: true
   DisplayCopNames: true
 
 Style/Copyright:
   Enabled: true
-  Notice: 'Copyright (\(c\) )?2020 Jerome Arbez-Gindre'
+  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
   AutocorrectNotice: '# Copyright (c) 2020 Jerome Arbez-Gindre'
 
-Lint/ConstantResolution:
+Lint/ConstantResolution: # Not available ins rubocop 0.81
   Enabled: false
 
-# Style/DocumentationMethod:
-#   Enabled: false
+Style/DocumentationMethod:
+  Enabled: false
 
-# Style/StringHashKeys :
-#   Enabled: false
+Style/StringHashKeys :
+  Enabled: true
+  Exclude:
+    - '*.gemspec'
 
 Style/MissingElse:
   EnforcedStyle: case
@@ -43,9 +47,9 @@ Metrics/BlockLength :
     - 'spec/**/*'
     - '*.gemspec'
 
-# Security/Eval :
-#   Exclude:
-#     - 'Rakefile'
+Security/Eval :
+  Exclude:
+    - 'Rakefile'
 
 Style/ConstantVisibility :
   Exclude:
@@ -53,15 +57,15 @@ Style/ConstantVisibility :
      # constants
     - 'lib/asciidoctor/defmastership/extension.rb'
 
-# # rubocop-rspec options
-# RSpec/MessageExpectation :
-#   Enabled: false
+# rubocop-rspec options
+RSpec/MessageExpectation :
+  Enabled: true
 
 RSpec/FilePath :
-  Enabled: false
+  Enabled: true
 
-# RSpec/NestedGroups:
-#   Max: 4
+RSpec/NestedGroups:
+  Max: 4
 
 Layout/RedundantLineBreak:
   Enabled: false
@@ -69,3 +73,7 @@ Layout/RedundantLineBreak:
 Style/DisableCopsWithinSourceCodeDirective:
   Enabled: true
   AllowedCops: ['Lint/InterpolationCheck']
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+  

data/Gemfile

@@ -3,3 +3,18 @@
 
 source('https://rubygems.org')
 gemspec
+
+# to parse provided Rakefile
+gem 'rake', '~> 13'
+# tdd
+gem 'rspec', '~> 3'
+# code need to be clean
+gem 'rubocop', '1.54'
+# code need to be clean
+gem 'rubocop-performance', '~> 1.18'
+# Rakile needs to be clean
+gem 'rubocop-rake', '~> 0.6'
+# unit tests need to be clean
+gem 'rubocop-rspec', '~> 2.22'
+# What is tdd without code coverage ?
+gem 'simplecov', '~> 0'

data/Rakefile

@@ -7,6 +7,10 @@ require('rspec/core/rake_task')
 RSpec::Core::RakeTask.new(:spec)
 require('rubocop/rake_task')
 
-::RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+  task.requires << 'rubocop-rake'
+end
 
-task(default: %i[spec rubocop])
+task(default: %i[rubocop spec])

data/asciidoctor-defmastership.gemspec

@@ -6,7 +6,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require('asciidoctor/defmastership/version')
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.5'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.required_ruby_version = '>= 2.7'
   spec.name          = 'asciidoctor-defmastership'
   spec.version       = Asciidoctor::DefMastership::VERSION
   spec.authors       = ['Jérôme Arbez-Gindre']
@@ -33,13 +37,6 @@ Gem::Specification.new do |spec|
     end
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency('aruba')
-  spec.add_development_dependency('rake')
-  spec.add_development_dependency('rspec')
-  spec.add_development_dependency('rubocop', '1.13')
-  spec.add_development_dependency('rubocop-rake', '~> 0.5')
-  spec.add_development_dependency('rubocop-rspec', '~> 2.0')
-
   spec.add_dependency('asciidoctor', '~> 2.0')
-  spec.add_dependency('defmastership', '>= 1.0.13', '< 2.0')
+  spec.add_dependency('defmastership', '>= 1.0.16', '< 2.0')
 end

data/bin/console

@@ -2,8 +2,8 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('bundler/setup')
 require('asciidoctor/defmastership')
+require('bundler/setup')
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/asciidoctor/defmastership/extension.rb

@@ -20,6 +20,7 @@ require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
 #   [define, requirement, TOTO-0001]
 #   This shall be nice.
 #
+require('asciidoctor/defmastership/regexp_dispatcher')
 require('defmastership/constants')
 require('defmastership/parsing_state')
 
@@ -27,38 +28,18 @@ module Asciidoctor
   module DefMastership
     # Preprocessor to replace adoc statements
     class Preprocessor < Asciidoctor::Extensions::Preprocessor
-      EREF_CONFIG_REGEXP = ::DefMastership::DMRegexp::EREF_CONFIG
-      DEFINITION_REGEXP  = ::DefMastership::DMRegexp::DEFINITION
-      EREF_DEF_REGEXP    = ::DefMastership::DMRegexp::EREF_DEF
-      IREF_DEF_REGEXP    = ::DefMastership::DMRegexp::IREF_DEF
-      ATTR_CONFIG_REGEXP = ::DefMastership::DMRegexp::ATTR_CONFIG
-      ATTR_SET_REGEXP    = ::DefMastership::DMRegexp::ATTR_SET
-
-      private_constant :EREF_CONFIG_REGEXP,
-                       :DEFINITION_REGEXP,
-                       :EREF_DEF_REGEXP,
-                       :IREF_DEF_REGEXP,
-                       :ATTR_CONFIG_REGEXP,
-                       :ATTR_SET_REGEXP
-
-      Filter = Struct.new(:regex, :apply)
-
-      FILTERS = [
-        Filter.new(EREF_CONFIG_REGEXP, :set_eref_url_if_any),
-        Filter.new(DEFINITION_REGEXP,  :build_definition),
-        Filter.new(EREF_DEF_REGEXP,    :build_external_ref),
-        Filter.new(IREF_DEF_REGEXP,    :build_internal_ref),
-        Filter.new(ATTR_SET_REGEXP,    :attribute_setting)
-      ].freeze
-
-      private_constant :FILTERS
-
-      # class initialization
+      EREF_CONFIG_REGEXP  = ::DefMastership::DMRegexp::EREF_CONFIG
+      DEFINITION_REGEXP   = ::DefMastership::DMRegexp::DEFINITION
+      EREF_DEF_REGEXP     = ::DefMastership::DMRegexp::EREF_DEF
+      IREF_DEF_REGEXP     = ::DefMastership::DMRegexp::IREF_DEF
+      ATTR_SET_REGEXP     = ::DefMastership::DMRegexp::ATTR_SET
+      VARIABLE_DEF_REGEXP = ::DefMastership::DMRegexp::VARIABLE_DEF
+
       def initialize(config = {})
         super(config)
-        # This is a preprocessor: we need to parse tag attributes
-        @parsing_is_enabled = true
+
         @has_url = {}
+        @variables = {}
         @parsing_state = ::DefMastership::ParsingState.new
       end
 
@@ -72,15 +53,23 @@ module Asciidoctor
 
       private
 
+      def build_subs
+        subs = RegexpDispatcher.new(self)
+        subs
+          .add_rule(EREF_CONFIG_REGEXP, :set_eref_url_if_any)
+          .add_rule(DEFINITION_REGEXP, :build_definition)
+          .add_rule(EREF_DEF_REGEXP, :build_external_ref)
+          .add_rule(IREF_DEF_REGEXP, :build_internal_ref)
+          .add_rule(ATTR_SET_REGEXP, :attribute_setting)
+          .add_rule(VARIABLE_DEF_REGEXP, :variable_set)
+      end
+
       def parse_and_replace(lines)
+        subs = build_subs
         lines.reduce([]) do |new_lines, line|
-          shall_parse = @parsing_state.enabled?(line)
-          filter = FILTERS.find { |onefilter| line.match(onefilter.regex) }
-          if filter && shall_parse
-            new_lines + __send__(filter.apply, line, Regexp.last_match)
-          else
-            new_lines + [line]
-          end
+          next new_lines + [line] unless @parsing_state.enabled?(line)
+
+          next new_lines + subs.replace(line)
         end
       end
 
@@ -89,38 +78,51 @@ module Asciidoctor
         [line]
       end
 
+      def show_explicit_checksum(matches)
+        matches[:explicit_checksum] &&
+          @variables['show-explicit-checksum'] != 'disable' &&
+          @variables["show-#{matches[:type]}-explicit-checksum"] != 'disable'
+      end
+
       def build_definition(_line, matches)
         definition_lines = []
-        explicit_checksum_str = " [.checksum]\#(#{matches[:explicit_checksum]})\#" if matches[:explicit_checksum]
-        explicit_version_str = " [.version]\#(#{matches[:explicit_version]})\#" if matches[:explicit_version]
+        explicit_checksum_str = " [.checksum]#(#{matches[:explicit_checksum]})#" if show_explicit_checksum(matches)
+        explicit_version_str = " [.version]#(#{matches[:explicit_version]})#" if matches[:explicit_version]
         labels_str = " #{labels_strings(matches[:labels]).join(' ')}" if matches[:labels]
         definition_lines << ".#{matches[:reference]}#{explicit_version_str}#{explicit_checksum_str}#{labels_str}"
         definition_lines <<
-          "[\##{matches[:reference]}.define.#{matches[:type]}]"
+          "[##{matches[:reference]}.define.#{matches[:type]}]"
       end
 
       def labels_strings(labels)
         labels_strs = []
         labels.split(/\s*,\s*/).reject(&:empty?).each do |label|
-          labels_strs << "[.tag.{tag-#{label}-color}]\##{label}\#"
+          labels_strs << "[.tag.{tag-#{label}-color}]##{label}#"
         end
         labels_strs
       end
 
       def build_link(ref, matches)
         if @has_url[matches[:refname]]
-          "link:{eref-#{matches[:refname]}-url}\##{ref}\[#{ref}]"
+          "link:{eref-#{matches[:refname]}-url}##{ref}[#{ref}]"
         else
           ref
         end
       end
 
+      def show_ext_ref(matches)
+        @variables['show-ext-ref'] != 'disable' &&
+          @variables["show-#{matches[:refname]}-ext-ref"] != 'disable'
+      end
+
       def build_external_ref(_line, matches)
+        return [] unless show_ext_ref(matches)
+
         extrefs = matches[:extrefs].split(/\s*,\s*/)
         new_line = "[.external_reference]\#{eref-#{matches[:refname]}-prefix} "
         extref_line = extrefs.map { |ref| build_link(ref, matches) }
         @has_url[matches[:refname]]
-        ["#{new_line}#{extref_line.join(', ')}.\#"]
+        ["#{new_line}#{extref_line.join(', ')}.#"]
       end
 
       def build_internal_ref(line, _matches)
@@ -137,6 +139,11 @@ module Asciidoctor
           "{attr-#{matches[:attr]}-prefix} #{matches[:value]}."
         ]
       end
+
+      def variable_set(line, matches)
+        @variables[matches[:varname]] = matches[:value]
+        [line]
+      end
     end
   end
 end

data/lib/asciidoctor/defmastership/regexp_dispatcher.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
+require('ostruct')
+
+module Asciidoctor
+  module DefMastership
+    # Hosts several Text replacement rules
+    class RegexpDispatcher
+      Rule = Struct.new(:regexp, :method_symbol)
+      private_constant :Rule
+
+      def initialize(effective_subs)
+        @effective_subs = effective_subs
+        @rules = []
+      end
+
+      def add_rule(regexp, method_symbol)
+        @rules << Rule.new(regexp, method_symbol)
+        self
+      end
+
+      def replace(line)
+        @rules.each do |rule|
+          matches = rule.regexp.match(line)
+          return @effective_subs.__send__(rule.method_symbol, line, matches) if matches
+        end
+        [line]
+      end
+    end
+  end
+end

data/lib/asciidoctor/defmastership/version.rb

@@ -3,7 +3,7 @@
 
 module Asciidoctor
   module DefMastership
-    VERSION = '1.0.5'
+    VERSION = '1.0.7'
     public_constant :VERSION
   end
 end

metadata

@@ -1,99 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.13
+        version: 1.0.16
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -124,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.13
+        version: 1.0.16
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -163,12 +79,14 @@ files:
 - example/howto.sh
 - lib/asciidoctor/defmastership.rb
 - lib/asciidoctor/defmastership/extension.rb
+- lib/asciidoctor/defmastership/regexp_dispatcher.rb
 - lib/asciidoctor/defmastership/version.rb
 homepage: https://gitlab.com/jjag/asciidoctor-defmastership/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,15 +94,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: asciidoctor extension to handle applicable definition references
 test_files: []