asciidoctor-defmastership 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 120879775fb430f58cc83b38f54a85a783e53c13a303f21aa1d53b140afe534c
-  data.tar.gz: 2dd09334b90b48c2d3fec43e8ba64a456ae00c13771113bae1655ac90d3451ef
+  metadata.gz: 5a574088c4efd73e56f84596649ce647b0f38c3d64f36542329fbd0168871de2
+  data.tar.gz: a8e5efb88da6f4207c49530a795f49bdbdeada308080b6b43c3e4ebcaf5637b1
 SHA512:
-  metadata.gz: ef6a6b74bc6486b24cad993dad606b6a4d7d1730344c074af2fd9792fa94492730f80933bd262149963b5501e9c53ab41ce6b2a06cb61aa3ec770c3f176b06a9
-  data.tar.gz: 71c5ca0517d3766e4cd880ceccbca363f723859636d11cf2618ddf2590f73d19658ef15cdb71fe4ae13b5e283fefc4ac12ce2f45607bb9788eb1e7c2fd366a1c
+  metadata.gz: 7831b216a022ae43ed67df33b279dc771a821137ce4a5cd51f3b6dc443be6fc07f0836b55f2f619445ae43530dde58637fb143e9ed7d4ae6e8b64b1b81f415ab
+  data.tar.gz: 0f9ceb5bc4a32f406e427221f4b48a4835215b1d4986d19883d95281ba1b8577eae995222957377d81a0a44347d487725df38249815dddcc7cf848e92cfa50f5

data/.gitignore

@@ -1,3 +1,5 @@
+*~
+/*_results.html
 /.bundle/
 /.yardoc
 /_yardoc/

data/.gitlab-ci.yml

@@ -7,13 +7,50 @@ default:
     - gem install bundler --no-document
     - bundle install --jobs $(nproc) "${FLAGS[@]}"
 
+bdd:
+  script:
+    - bundle exec rake test:features
+
+yard documentation:
+  script:
+    - bundle exec rake yard
+  artifacts:
+    paths:
+      - doc
+
 unit tests:
   script:
     - bundle exec rake test:spec
 
-rubocop:
+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 quality:rubocop
+    - bundle exec rake test:features
 
 unit tests ruby2.7:
   image: ruby:2.7
@@ -40,3 +77,14 @@ unit tests ruby3.2:
   image: ruby:3.2
   script:
     - bundle exec rake test:spec
+
+pages:
+  stage: deploy
+  script:
+    - mkdir public
+    - cp -r doc/* public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

data/Gemfile

@@ -7,7 +7,13 @@ gemspec
 
 ruby RUBY_VERSION
 
+# rubocop:disable Metrics/BlockLength
 group :development do
+  # cucumber steps for command line tests
+  gem 'aruba',                 '~> 2'
+  # bdd
+  gem 'cucumber',              '~> 9'
+
   if RUBY_VERSION >= '3.0'
     # mutation testing
     plan = 'oss'
@@ -21,8 +27,13 @@ group :development do
   end
   # to parse provided Rakefile
   gem 'rake', '~> 13'
+
+  if RUBY_VERSION >= '3.0'
+    # needed by yard to render documentation
+    gem 'rdoc', '~> 6'
+  end
   # tdd
-  gem 'rspec', '3.12'
+  gem 'rspec', '~> 3'
   # code need to be clean
   gem 'rubocop', '1.65'
   # code need to be clean
@@ -37,7 +48,13 @@ group :development do
   end
   # What is tdd without code coverage ?
   gem 'simplecov', '~> 0'
+
+  if RUBY_VERSION >= '3.0'
+    # to document code
+    gem 'yard', '~> 0'
+  end
 end
+# rubocop:enable Metrics/BlockLength
 
 group :debugging do
   # Sometimes, we need to debug

data/README.adoc

@@ -0,0 +1,69 @@
+= Asciidoctor::Defmastership
+
+Asciidoctor Defmastership module is dedicated to preprocess asciidoctor files which have specific lines as follows:
+
+* For comment lines do nothing
+* For other lines check line against a vector of regexp and for each match replace the parsed lines with new content
+* Follows a list of noticeable transformations, for a complete list refers to spec/unit/asciidoctor/def_mastership/preprocessor_spec.rb
+
+* Lines like [define,requirement,XXYY] add title XXYY, anchor point and call style define.requirement located in stylesheet of renderer
+* Add a dedicated style to checksums and option for visibility or not
+* Add attribute to requirements
+
+The style inserted by preprocessor can then be parsed whith appropriate stylesheet :
+* html => CSS
+* pdf => xsl+sty dblatex (ie docbook + latex)
+
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source, ruby]
+----
+gem 'asciidoctor-defmastership'
+----
+
+And then execute:
+
+[source, bash]
+----
+$ bundle
+----
+
+Or install it yourself as:
+
+
+[source, bash]
+----
+$ gem install asciidoctor-defmastership
+----
+
+== Usage
+
+If `my_document.adoc` contains definitions blocks
+
+[source, bash]
+----
+$ asciidoctor -r asciidoctor-defmastership my_document.adoc
+----
+==  Development
+
+Require asciidoctor module for preprocessor hooking
+
+Require defmastership for REGEXP collections
+
+- bin : minimal applications (console + setup) to test module
+- lib : asciidoctor/defmastership, asciidoctor/defmastership/preprocessor is the main module
+
+Preprocessor architecture :
+
+* Process : Main entry point for parsing and replacing lines
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+==  Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/defmastership/asciidoctor-defmastership.

data/Rakefile

@@ -1,16 +1,14 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('bundler/gem_tasks')
-require('rspec/core/rake_task')
-
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 desc 'Continous integration tasks'
 task :ci do
   [
     'test:spec',
-    :rubocop
+    'test:features',
+    'quality:all'
   ].each do |name|
     puts "\n=== Running #{name}...\n"
     Rake::Task[name].invoke

data/asciidoctor-defmastership.gemspec

@@ -3,7 +3,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require('asciidoctor/defmastership/version')
+require('asciidoctor-defmastership/version')
 
 Gem::Specification.new do |spec|
   spec.metadata = {
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
   spec.name          = 'asciidoctor-defmastership'
-  spec.version       = Asciidoctor::DefMastership::VERSION
+  spec.version       = Asciidoctor::Defmastership::VERSION
   spec.authors       = ['Jérôme Arbez-Gindre']
   spec.email         = ['jeromearbezgindre@gmail.com']
   spec.licenses      = ['MIT']
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
                    applicable definitions references, link to other references
                    (internal or external))
 
-  spec.homepage    = 'https://gitlab.com/jjag/asciidoctor-defmastership/'
+  spec.homepage    = 'https://gitlab.com/defmastership/asciidoctor-defmastership/'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that
@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
     end
   spec.require_paths = ['lib']
 
-  spec.add_dependency('asciidoctor', '~> 2')
-  spec.add_dependency('defmastership', '>= 1.0.19')
+  spec.add_dependency('asciidoctor', '~> 2.0')
+  spec.add_dependency('defmastership-core', '>= 1.1.0')
+  spec.add_dependency('ostruct', '~> 0.6')
 end

data/bin/console

@@ -2,7 +2,7 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('asciidoctor/defmastership')
+require('asciidoctor-defmastership')
 require('bundler/setup')
 
 # You can add fixtures and/or initialization code here to make experimenting

data/config/cucumber.yml

@@ -0,0 +1,3 @@
+---
+default: features --publish-quiet --format html -o features_results.html --format progress -x
+wip: features --publish-quiet --format pretty -x -s --tags '@wip and not @pending'

data/config/mutant.yml

@@ -1,26 +1,17 @@
 ---
+usage: opensource
 includes:
   - lib
 integration:
   name: rspec
+  arguments:
+    - --options=config/rspec
+    - spec
 requires:
-  - defmastership
+  - asciidoctor/defmastership
 matcher:
   subjects:
-    - 'DefMastership*'
-  # ignore:
-  #   - 'DefMastership::BatchModifier*'
-  #   - 'DefMastership::CSVFormatter*'
-  #   - 'DefMastership::CSVFormatterBody*'
-  #   - 'DefMastership::CSVFormatterHeader*'
-  #   - 'DefMastership::ChangeRefModifier*'
-  #   - 'DefMastership::Definition*'
-  #   - 'DefMastership::Document*'
-  #   - 'DefMastership::Modifier*'
-  #   - 'DefMastership::ModifierFactory*'
-  #   - 'DefMastership::ParsingState*'
-  #   - 'DefMastership::RenameIncludedFilesModifier*'
-  #   - 'DefMastership::UpdateDefChecksumModifier*'
-  #   - 'DefMastership::UpdateDefModifier*'
-  #   - 'DefMastership::UpdateDefVersionModifier*'
+    - 'Asciidoctor::Defmastership*'
+    # - 'Asciidoctor::Defmastership::Preprocessor*'
+    # - 'Asciidoctor::Defmastership::RegexpDispatcher*'
 # fail_fast: true

data/config/rubocop.yml

@@ -55,13 +55,16 @@ Style/ConstantVisibility :
   Exclude:
      # there is one unique explicit constant visibility for all
      # constants
-    - 'lib/asciidoctor/defmastership/extension.rb'
+    - 'lib/asciidoctor-defmastership/extension.rb'
 
 # rubocop-rspec options
 RSpec/MessageExpectation :
   Enabled: true
 
-RSpec/FilePath :
+RSpec/SpecFilePathFormat :
+  Enabled: true
+
+RSpec/SpecFilePathSuffix :
   Enabled: true
 
 RSpec/NestedGroups:
@@ -72,7 +75,9 @@ Layout/RedundantLineBreak:
   
 Style/DisableCopsWithinSourceCodeDirective:
   Enabled: true
-  AllowedCops: ['Lint/InterpolationCheck']
+  AllowedCops: ['Lint/InterpolationCheck', 'Naming/FileName']
+  Exclude:
+    - 'Gemfile'
 
 Layout/EndOfLine:
   EnforcedStyle: lf

data/lib/asciidoctor/defmastership.rb

@@ -1,12 +1,4 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-if RUBY_ENGINE == 'opal'
-  require('asciidoctor/defmastership/preprocessor')
-else
-  require_relative('defmastership/preprocessor')
-end
-
-Asciidoctor::Extensions.register do
-  preprocessor Asciidoctor::DefMastership::Preprocessor
-end
+require('asciidoctor-defmastership')

data/lib/asciidoctor-defmastership/preprocessor.rb

@@ -0,0 +1,239 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# :nocov:
+require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
+# :nocov:
+
+# An extension that allow to define applicable definitions
+#
+# Usage
+#   :tag-mylabel-color: yellow
+#   :tag-otherlabel-color: red
+#
+#
+#   [define, requirement, TOTO-0001, [mylabel, otherlabel]]
+#   --
+#   The system shall allow to do lots of things.
+#   --
+#
+# or
+#
+#   [define, requirement, TOTO-0001]
+#   This shall be nice.
+#
+require('asciidoctor-defmastership/regexp_dispatcher')
+require('defmastership/core/constants')
+require('defmastership/core/parsing_state')
+
+module Asciidoctor
+  # Module to host Defmastership preprocessor
+  module Defmastership
+    # Preprocessor to replace adoc statements
+    # This class smells of :reek:InstanceVariableAssumption.
+    # Not an issue because process is the only method used by Asciidoctor
+    class Preprocessor < Asciidoctor::Extensions::Preprocessor
+      REGEXPS = {
+        eref_config: ::Defmastership::Core::DMRegexp::EREF_CONFIG,
+        definition: ::Defmastership::Core::DMRegexp::DEFINITION,
+        eref_def: ::Defmastership::Core::DMRegexp::EREF_DEF,
+        iref_def: ::Defmastership::Core::DMRegexp::IREF_DEF,
+        attr_set: ::Defmastership::Core::DMRegexp::ATTR_SET,
+        variable_def: ::Defmastership::Core::DMRegexp::VARIABLE_DEF
+      }.freeze
+
+      private_constant :REGEXPS
+
+      # @param _config [Hash] configuration Hash for this preprocessor instance
+      def initialize(_config = {})
+        super
+        @has_url = Set.new
+        @variables = {}
+        @parsing_state = ::Defmastership::Core::ParsingState.new
+      end
+
+      # Entry point for the plugin call
+      #
+      # @param _document [Asciidoctor::Document] the current document
+      # @param reader [Asciidoctor::Reader] to retrieve lines from AsciiDoc source file
+      # This method smells of :reek:FeatureEnvy
+      def process(_document, reader)
+        return reader if reader.eof?
+
+        reader.unshift_lines(parse_and_replace(reader.read_lines))
+      end
+
+      # Process a definition line
+      #
+      # @param _line [String] the original line
+      # @param match [MatchData] the match data from the matching Regexp
+      # @return [Array<String>] the lines to replace the original line
+      def build_definition(_line, match)
+        Helper::DefinitionStringBuilder.new(match, show_explicit_checksum(match)).str_a
+      end
+
+      # Process a variable setting line
+      #
+      # @param line [String] the original line
+      # @param match [MatchData] the match data from the matching Regexp
+      # @return [Array<String>] the lines to replace the original line
+      def variable_set(line, match)
+        @variables.merge!(Helper.variable_hash(match))
+        [line]
+      end
+
+      # Process a set url line
+      #
+      # @param line [String] the original line
+      # @param match [MatchData] the match data from the matching Regexp
+      # @return [Array<String>] the lines to replace the original line
+      def set_eref_url_if_any(line, match)
+        @has_url.add(match[:reference]) if Helper.valid_eref_url?(match)
+        [line]
+      end
+
+      # Process an external ref line
+      #
+      # @param _line [String] the original line
+      # @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)
+
+        extrefs = match[:extrefs].split(/\s*,\s*/)
+        extref_line = extrefs.map { |ref| build_link(ref, match) }
+        ["[.external_reference]\#{eref-#{match[:reference]}-prefix} #{extref_line.join(', ')}.#"]
+      end
+
+      # Process an internal ref line
+      #
+      # @param line [String] the original line
+      # @param _match [MatchData] the match data from the matching Regexp
+      # @return [Array<String>] the lines to replace the original line
+      # This method smells of :reek:UtilityFunction
+      def build_internal_ref(line, _match)
+        [
+          line.gsub(REGEXPS.fetch(:iref_def)) do
+            intref = Regexp.last_match[:intref]
+            "<<#{intref},#{intref}>>"
+          end
+        ]
+      end
+
+      # Process an attribute setting line
+      #
+      # @param _line [String] the original line
+      # @param match [MatchData] the match data from the matching Regexp
+      # @return [Array<String>] the lines to replace the original line
+      # This method smells of :reek:UtilityFunction
+      def attribute_setting(_line, match)
+        [
+          '[.attribute]',
+          "{attr-#{match[:attr]}-prefix} #{match[:value]}."
+        ]
+      end
+
+      private
+
+      def build_regexp_dispatcher
+        regexp_dispatcher = RegexpDispatcher.new(self)
+        regexp_dispatcher
+          .add_rule(REGEXPS.fetch(:eref_config), :set_eref_url_if_any)
+          .add_rule(REGEXPS.fetch(:definition), :build_definition)
+          .add_rule(REGEXPS.fetch(:eref_def), :build_external_ref)
+          .add_rule(REGEXPS.fetch(:iref_def), :build_internal_ref)
+          .add_rule(REGEXPS.fetch(:attr_set), :attribute_setting)
+          .add_rule(REGEXPS.fetch(:variable_def), :variable_set)
+      end
+
+      def parse_and_replace(lines)
+        regexp_dispatcher = build_regexp_dispatcher
+        lines.reduce([]) do |new_lines, line|
+          next new_lines + [line] unless @parsing_state.enabled?(line)
+
+          next new_lines + regexp_dispatcher.replace(line)
+        end
+      end
+
+      def show_explicit_checksum(match)
+        match[:explicit_checksum] &&
+          !@variables['show-explicit-checksum'].eql?('disable') &&
+          !@variables["show-#{match[:type]}-explicit-checksum"].eql?('disable')
+      end
+
+      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)
+
+        "link:{eref-#{refname}-url}#{ref_str}[#{ref}]"
+      end
+
+      def show_ext_ref(match)
+        !@variables['show-ext-ref'].eql?('disable') &&
+          !@variables["show-#{match[:reference]}-ext-ref"].eql?('disable')
+      end
+    end
+
+    # Proepocessors class Helpers
+    class Preprocessor
+      # Helpers for Preprocessor class
+      module Helper
+        # Isolate the definition macro
+        class DefinitionStringBuilder
+          # @param match [MatchData] match data from defintion Regexp
+          # @param show_explicit_checksum [Boolean] sepcify if we need to show checksums in rendered document
+          def initialize(match, show_explicit_checksum)
+            @match = match
+            @show_explicit_checksum = show_explicit_checksum
+          end
+
+          # @return [Array<String>] the lines to replace defininition's line
+          def str_a
+            explicit_checksum_str = " [.checksum]#(#{@match[:explicit_checksum]})#" if @show_explicit_checksum
+            explicit_version_str = Helper.explicit_version_str(@match[:explicit_version])
+            labels_str = Helper.labels_str(@match[:labels])
+            reference = @match[:reference]
+            [
+              ".#{reference}#{explicit_version_str}#{explicit_checksum_str}#{labels_str}",
+              "[##{reference}.define.#{@match[:type]}]"
+            ]
+          end
+        end
+
+        # @param match [MatchData] match data from external ref setting Regexp
+        # @return [Boolean] true if the match data includes a valid URL
+        def self.valid_eref_url?(match)
+          match[:symb] == 'url' && !match[:value].eql?('none')
+        end
+
+        # @param labels [Array[String]] List of labels of a definition
+        # @return [String] the replacement string for labels
+        def self.labels_str(labels)
+          return unless labels
+
+          labels_strings =
+            labels.split(/\s*,\s*/).reduce([]) do |acc, label|
+              acc << "[.tag.{tag-#{label}-color}]##{label}#"
+            end
+          " #{labels_strings.join(' ')}"
+        end
+
+        # @param explicit_version [String] an explicit version setting
+        # @return [String] the replacement string for explicit version
+        def self.explicit_version_str(explicit_version)
+          " [.version]#(#{explicit_version})#" if explicit_version
+        end
+
+        # @param match [MatchData] the match data from the matching variable setting Regexp
+        # @return [[Hash{String => Object}]] the hash corresponding to the variable setting
+        def self.variable_hash(match)
+          { match[:varname] => match[:value] }
+        end
+      end
+    end
+  end
+end

data/lib/{asciidoctor/defmastership → asciidoctor-defmastership}/regexp_dispatcher.rb

@@ -8,27 +8,37 @@ require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
 require('ostruct')
 
 module Asciidoctor
-  module DefMastership
+  module Defmastership
     # Hosts several Text replacement rules
     class RegexpDispatcher
       # Class to link a regexp with a method
       Rule = Struct.new(:regexp, :method_symbol)
       private_constant :Rule
 
-      def initialize(effective_subs)
-        @effective_subs = effective_subs
+      # @param client [Object] the object that will receive method call on regexp matches
+      def initialize(client)
+        @client = client
         @rules = []
       end
 
+      # Add a rule
+      #
+      # @param regexp [Regexp] the regexp for this rule
+      # @param method_symbol [Symbol] the symbol for the method call
+      # @return [RegexpDispatcher] self to allow add_rule calls chain
       def add_rule(regexp, method_symbol)
         @rules << Rule.new(regexp, method_symbol)
         self
       end
 
+      # Add a rule
+      #
+      # @param line [String] the original line
+      # @return [Array<String>] the lines to replace the original line
       def replace(line)
         @rules.each do |rule|
           matches = rule.regexp.match(line)
-          return @effective_subs.public_send(rule.method_symbol, line, matches) if matches
+          return @client.public_send(rule.method_symbol, line, matches) if matches
         end
         [line]
       end

data/lib/{asciidoctor/defmastership → asciidoctor-defmastership}/version.rb

@@ -3,8 +3,9 @@
 
 module Asciidoctor
   # main application module
-  module DefMastership
-    VERSION = '1.0.9'
+  module Defmastership
+    # [String] Gem version
+    VERSION = '1.1.0'
     public_constant :VERSION
   end
 end

data/lib/asciidoctor-defmastership.rb

@@ -0,0 +1,15 @@
+# rubocop:disable Naming/FileName
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+if RUBY_ENGINE == 'opal'
+  require('asciidoctor-defmastership/preprocessor')
+else
+  require_relative('asciidoctor-defmastership/preprocessor')
+end
+
+Asciidoctor::Extensions.register do
+  preprocessor Asciidoctor::Defmastership::Preprocessor
+end
+
+# rubocop:enable Naming/FileName

data/tasks/documentation.rake

@@ -0,0 +1,19 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+namespace 'documentation' do
+  require('yard')
+
+  YARD::Rake::YardocTask.new do |task|
+    task.files = ['lib/**/*.rb']
+    task.options = ['--fail-on-warning', '--verbose']
+    task.stats_options = ['--list-undoc']
+  end
+rescue LoadError
+  task(:yard) do
+    puts('Install Yard to run its rake tasks')
+  end
+end
+
+desc 'Synonym for documentation:yard'
+task(yard: 'documentation:yard')

data/tasks/package.rake

@@ -0,0 +1,4 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('bundler/gem_tasks')

data/tasks/test.rake

@@ -1,6 +1,8 @@
 # Copyright (c) 2023 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
+require('cucumber/rake/task')
+require('rake/clean')
 require('rspec/core/rake_task')
 
 namespace 'test' do
@@ -8,8 +10,15 @@ namespace 'test' do
     t.rspec_opts = ['--options config/rspec']
   end
 
+  CLEAN << 'features_results.html'
+
+  Cucumber::Rake::Task.new(:features)
+  Cucumber::Rake::Task.new('features:wip') do |t|
+    t.cucumber_opts = ['--profile wip']
+  end
+
   desc 'Runs all unit tests and acceptance tests'
-  task(all: ['test:spec'])
+  task(all: ['test:spec', 'test:features'])
 end
 
 desc 'Synonym for test:spec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: defmastership
+  name: defmastership-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.19
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.19
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: |-
   asciidoctor-defmastership allows to define
                      applicable definitions references, link to other references
@@ -50,33 +64,29 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENCE
-- README.md
+- README.adoc
 - Rakefile
 - asciidoctor-defmastership.gemspec
 - bin/console
 - bin/setup
+- config/cucumber.yml
 - config/mutant.yml
 - config/reek.yml
 - config/rspec
 - config/rubocop.yml
-- example/.config.adoc
-- example/.gitignore
-- example/example.adoc
-- example/howto.sh
+- lib/asciidoctor-defmastership.rb
+- lib/asciidoctor-defmastership/preprocessor.rb
+- lib/asciidoctor-defmastership/regexp_dispatcher.rb
+- lib/asciidoctor-defmastership/version.rb
 - lib/asciidoctor/defmastership.rb
-- lib/asciidoctor/defmastership/preprocessor.rb
-- lib/asciidoctor/defmastership/regexp_dispatcher.rb
-- lib/asciidoctor/defmastership/version.rb
 - tasks/console.rake
-- tasks/package.task
+- tasks/documentation.rake
+- tasks/package.rake
 - tasks/smelling_code.rake
 - tasks/test.rake
-homepage: https://gitlab.com/jjag/asciidoctor-defmastership/
+homepage: https://gitlab.com/defmastership/asciidoctor-defmastership/
 licenses:
 - MIT
 metadata:
@@ -96,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: asciidoctor extension to handle applicable definition references

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,79 +0,0 @@
-# The behavior of RuboCop can be controlled via the .rubocop.yml
-# configuration file. It makes it possible to enable/disable
-# certain cops (checks) and to alter their behavior if they accept
-# any parameters. The file can be placed either in your home
-# directory or in some project directory.
-#
-# RuboCop will start looking for the configuration file in the directory
-# where the inspected file is and continue its way up to the root directory.
-#
-# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
-
-require:
-  - rubocop-performance
-  - rubocop-rspec
-  - rubocop-rake
-
-AllCops:
-  TargetRubyVersion: 2.7
-  EnabledByDefault: true
-  DisplayCopNames: true
-
-Style/Copyright:
-  Enabled: true
-  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
-  AutocorrectNotice: '# Copyright (c) 2020 Jerome Arbez-Gindre'
-
-Lint/ConstantResolution: # Not available ins rubocop 0.81
-  Enabled: false
-
-Style/DocumentationMethod:
-  Enabled: false
-
-Style/StringHashKeys :
-  Enabled: true
-  Exclude:
-    - '*.gemspec'
-
-Style/MissingElse:
-  EnforcedStyle: case
-
-Metrics/ModuleLength :
-  Exclude:
-    - 'spec/**/*'
-
-Metrics/BlockLength :
-  Exclude:
-    - 'spec/**/*'
-    - '*.gemspec'
-
-Security/Eval :
-  Exclude:
-    - 'Rakefile'
-
-Style/ConstantVisibility :
-  Exclude:
-     # there is one unique explicit constant visibility for all
-     # constants
-    - 'lib/asciidoctor/defmastership/extension.rb'
-
-# rubocop-rspec options
-RSpec/MessageExpectation :
-  Enabled: true
-
-RSpec/FilePath :
-  Enabled: true
-
-RSpec/NestedGroups:
-  Max: 4
-
-Layout/RedundantLineBreak:
-  Enabled: false
-  
-Style/DisableCopsWithinSourceCodeDirective:
-  Enabled: true
-  AllowedCops: ['Lint/InterpolationCheck']
-
-Layout/EndOfLine:
-  EnforcedStyle: lf
-  

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.5
-before_install: gem install bundler -v 2.0.2

data/README.md

@@ -1,35 +0,0 @@
-# Asciidoctor::DefMastership
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/asciidoctor/defmastership`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'asciidoctor-defmastership'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install asciidoctor-defmastership
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asciidoctor-defmastership.

data/example/.config.adoc

@@ -1,2 +0,0 @@
-:eref-implements-prefix:    Participate to:
-:eref-implements-url:       ./the_other_document.html

data/example/.gitignore

@@ -1 +0,0 @@
-/example.html

data/example/example.adoc

@@ -1,57 +0,0 @@
-:toc: left
-:tag-performance-color: green
-:tag-chabada-color: fuchsia
-:attr-verifiedby-prefix: Verified by:
-
-include::.config.adoc[]
-
-= My beautiful document
-
-== Document content
-== Requirements
-
-[define, requirement, TOTO-0001, [performance]]
---
-The system shall allow to do lots of things:
-
-* toto
-* titi
---
-defs:attribute[verifiedby, Test compliqué]
-
-[define, requirement, TOTO-0002, [performance, chabada]]
---
-The system shall allow to do these things too:
-
-* pouet
-* tagada
-* being able to reference defs:iref[TOTO-0001] and defs:iref[TOTO-0243]
-* having also external reference as below
---
-
-defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
-
-[define, requirement, TOTO-0003]
-The system shall be nice.
-And Also funny.
---
-Not included !
---
-
-////
-Pouet tagada
-////
-
-
-
-
-// [define, requirement, TOTO_0030]
-// --
-// The system shall allow to do eat chocolates from:
-
-// * Switzerland
-// * Belgium
-// --
-
-link:rspec_results.html[Unit tests results]
-link:coverage/index.html[Coverage analysis]

data/example/howto.sh

@@ -1 +0,0 @@
-bundle exec asciidoctor --trace -a linkcss -a stylesheet=definition.css  -a stylesdir=../../asciidoctor-stylesheet-factory/stylesheets -r ../lib/asciidoctor/defmastership.rb example.adoc

data/lib/asciidoctor/defmastership/preprocessor.rb

@@ -1,189 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-# :nocov:
-require('asciidoctor/extensions') unless RUBY_ENGINE == 'opal'
-# :nocov:
-
-# An extension that allow to define applicable definitions
-#
-# Usage
-#   :tag-mylabel-color: yellow
-#   :tag-otherlabel-color: red
-#
-#
-#   [define, requirement, TOTO-0001, [mylabel, otherlabel]]
-#   --
-#   The system shall allow to do lots of things.
-#   --
-#
-# or
-#
-#   [define, requirement, TOTO-0001]
-#   This shall be nice.
-#
-require('asciidoctor/defmastership/regexp_dispatcher')
-require('defmastership/constants')
-require('defmastership/parsing_state')
-
-module Asciidoctor
-  # Module to host DefMastership preprocessor
-  module DefMastership
-    # Preprocessor to replace adoc statements
-    # This class smells of :reek:InstanceVariableAssumption.
-    # Not an issue because process is the only method used by Asciidoctor
-    class Preprocessor < Asciidoctor::Extensions::Preprocessor
-      REGEXPS = {
-        eref_config: ::DefMastership::DMRegexp::EREF_CONFIG,
-        definition: ::DefMastership::DMRegexp::DEFINITION,
-        eref_def: ::DefMastership::DMRegexp::EREF_DEF,
-        iref_def: ::DefMastership::DMRegexp::IREF_DEF,
-        attr_set: ::DefMastership::DMRegexp::ATTR_SET,
-        variable_def: ::DefMastership::DMRegexp::VARIABLE_DEF
-      }.freeze
-
-      private_constant :REGEXPS
-
-      def process(_document, reader)
-        @has_url = Set.new
-        @variables = {}
-        @parsing_state = ::DefMastership::ParsingState.new
-
-        return reader if reader.eof?
-
-        reader.unshift_lines(parse_and_replace(reader.read_lines))
-      end
-
-      def build_definition(_line, matches)
-        Helper::DefinitionStringBuilder.new(matches, show_explicit_checksum(matches)).str
-      end
-
-      def variable_set(line, matches)
-        @variables.merge!(Helper.variable_hash(matches))
-        [line]
-      end
-
-      def set_eref_url_if_any(line, matches)
-        @has_url.add(matches[:reference]) if Helper.valid_eref_url?(matches)
-        [line]
-      end
-
-      def build_external_ref(_line, matches)
-        return [] unless show_ext_ref(matches)
-
-        extrefs = matches[:extrefs].split(/\s*,\s*/)
-        extref_line = extrefs.map { |ref| build_link(ref, matches) }
-        ["[.external_reference]\#{eref-#{matches[:reference]}-prefix} #{extref_line.join(', ')}.#"]
-      end
-
-      # This method smells of :reek:UtilityFunction
-      def build_internal_ref(line, _matches)
-        [
-          line.gsub(REGEXPS.fetch(:iref_def)) do
-            intref = Regexp.last_match[:intref]
-            "<<#{intref},#{intref}>>"
-          end
-        ]
-      end
-
-      # This method smells of :reek:UtilityFunction
-      def attribute_setting(_line, matches)
-        [
-          '[.attribute]',
-          "{attr-#{matches[:attr]}-prefix} #{matches[:value]}."
-        ]
-      end
-
-      private
-
-      def build_subs
-        subs = RegexpDispatcher.new(self)
-        subs
-          .add_rule(REGEXPS.fetch(:eref_config), :set_eref_url_if_any)
-          .add_rule(REGEXPS.fetch(:definition), :build_definition)
-          .add_rule(REGEXPS.fetch(:eref_def), :build_external_ref)
-          .add_rule(REGEXPS.fetch(:iref_def), :build_internal_ref)
-          .add_rule(REGEXPS.fetch(:attr_set), :attribute_setting)
-          .add_rule(REGEXPS.fetch(:variable_def), :variable_set)
-      end
-
-      def parse_and_replace(lines)
-        subs = build_subs
-        lines.reduce([]) do |new_lines, line|
-          next new_lines + [line] unless @parsing_state.enabled?(line)
-
-          next new_lines + subs.replace(line)
-        end
-      end
-
-      def show_explicit_checksum(matches)
-        matches[:explicit_checksum] &&
-          !@variables['show-explicit-checksum'].eql?('disable') &&
-          !@variables["show-#{matches[:type]}-explicit-checksum"].eql?('disable')
-      end
-
-      def build_link(ref, matches)
-        refname = matches[:reference]
-        return ref unless @has_url.include?(refname)
-
-        ref_pattern =
-          @variables["eref-#{refname}-ref-pattern"] || '#%s'
-        ref_str = format(ref_pattern, ref)
-
-        "link:{eref-#{refname}-url}#{ref_str}[#{ref}]"
-      end
-
-      def show_ext_ref(matches)
-        !@variables['show-ext-ref'].eql?('disable') &&
-          !@variables["show-#{matches[:reference]}-ext-ref"].eql?('disable')
-      end
-    end
-
-    # Proepocessors class Helpers
-    class Preprocessor
-      # Helpers for Preprocessor class
-      module Helper
-        # Isolate the definition macro
-        class DefinitionStringBuilder
-          def initialize(matches, show_explicit_checksum)
-            @matches = matches
-            @show_explicit_checksum = show_explicit_checksum
-          end
-
-          def str
-            explicit_checksum_str = " [.checksum]#(#{@matches[:explicit_checksum]})#" if @show_explicit_checksum
-            explicit_version_str = Helper.build_explicit_version_str(@matches[:explicit_version])
-            labels_str = Helper.build_labels_str(@matches[:labels])
-            reference = @matches[:reference]
-            [
-              ".#{reference}#{explicit_version_str}#{explicit_checksum_str}#{labels_str}",
-              "[##{reference}.define.#{@matches[:type]}]"
-            ]
-          end
-        end
-
-        def self.valid_eref_url?(match)
-          match[:symb] == 'url' && !match[:value].eql?('none')
-        end
-
-        def self.build_labels_str(labels)
-          return unless labels
-
-          labels_strings =
-            labels.split(/\s*,\s*/).reduce([]) do |acc, label|
-              acc << "[.tag.{tag-#{label}-color}]##{label}#"
-            end
-          " #{labels_strings.join(' ')}"
-        end
-
-        def self.build_explicit_version_str(explicit_version)
-          " [.version]#(#{explicit_version})#" if explicit_version
-        end
-
-        def self.variable_hash(match)
-          { match[:varname] => match[:value] }
-        end
-      end
-    end
-  end
-end

data/tasks/package.task

@@ -1,9 +0,0 @@
-# Copyright (c) 2023 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require('rubygems')
-require('rubygems/package_task')
-
-spec = eval(File.read('asciidoctor-defmastership.gemspec'))
-
-Gem::PackageTask.new(spec)