defmastership-core 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2409414409c0de765bc37b9b666c32e31ec11fc6c5b5a03c44bc88c1d575d31
+  data.tar.gz: e2db2622f4b8eece83f5b1c80f918890619dc0d7a88c4b32cd35b90a6560afa3
+SHA512:
+  metadata.gz: 75804159eff5802621ef51db560c7fac277b025d2eeb28462af0915c467aa2b927eb745c9aa20029056974e1d4c8bc7cb61deffe53c064b6f3da32e26128b769
+  data.tar.gz: f79713179f65c5c7e57eac2cbcf623b0a151a91a58de39d6953ef1803369c081429039c1eb200a52f312265fffc03a5999ed3de4b227f4797c84a73005367138

data/.gitignore

@@ -0,0 +1,9 @@
+*~
+/tmp
+/coverage
+/Gemfile.lock
+/pkg/
+/.ruby-version
+/doc/
+/.yardoc/
+/rspec_results.html

data/.gitlab-ci.yml

@@ -0,0 +1,68 @@
+default:
+  image: ruby:3.3
+  before_script:
+    - apt-get update
+    - ruby -v
+    - which ruby
+    - gem install bundler --no-document
+    - bundle install --jobs $(nproc) "${FLAGS[@]}"
+    - git config --global user.email "you@example.com"
+    - git config --global user.name "Your Name"
+
+unit tests:
+  script:
+    - bundle exec rake test:spec
+  artifacts:
+    paths:
+      - rspec_results.html
+      - coverage/*
+
+code_quality:
+  script:
+    - bundle exec rake quality:all
+
+yard documentation:
+  script:
+    - bundle exec rake yard
+  artifacts:
+    paths:
+      - doc
+
+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
+  script:
+    - bundle exec rake test:spec
+
+unit tests ruby3.1:
+  image: ruby:3.1
+  script:
+    - bundle exec rake test:spec
+
+unit tests ruby3.2:
+  image: ruby:3.2
+  script:
+    - bundle exec rake test:spec
+
+pages:
+  stage: deploy
+  script:
+    - mkdir public
+    - cp -r doc/* public
+    - cp "rspec_results.html" public
+    - cp -r "coverage" public
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,88 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+ruby RUBY_VERSION
+
+# rubocop:disable Metrics/BlockLength
+group :development do
+  # needed by yard to render documentation
+  gem 'asciidoctor',           '~> 2'
+  # cucumber steps for command line tests
+  gem 'aruba',                 '~> 2'
+  # bdd
+  gem 'cucumber',              '~> 9'
+
+  # code duplication
+  gem 'flay',                  '~> 2'
+
+  # automatic test run
+  gem 'guard',                 '~> 2'
+  # automatic update invocation
+  gem 'guard-bundler',         '~> 3'
+  if RUBY_VERSION >= '3.0'
+    # automatic style check
+    gem 'guard-reek', '~> 1.2'
+  end
+  # automatic tdd
+  gem 'guard-rspec',           '~> 4'
+  # automatic style check
+  gem 'guard-rubocop',         '~> 1'
+
+  # 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
+  # to parse and execute Rakefile
+  gem 'rake', '~> 13'
+
+  if RUBY_VERSION >= '3.0'
+    # needed by yard to render documentation
+    gem 'rdoc', '~> 6'
+  end
+  # tdd
+  gem 'rspec',                 '~> 3'
+  # # to test performances
+  # gem 'rspec-benchmark',       '~> 0'
+  # code needs to be clean
+  gem 'rubocop',               '1.68'
+  # code needs to be clean
+  gem 'rubocop-performance',   '~> 1'
+  # test code needs to be clean
+  gem 'rubocop-rspec',         '~> 3'
+  # Rakefiles need to be clean
+  gem 'rubocop-rake',          '~> 0'
+
+  if RUBY_VERSION >= '3.0'
+    # detect selling code
+    gem 'reek', '~> 6'
+    # my code needs to be critiqued
+    gem 'rubycritic', '~> 4'
+    # Doc need to be clean
+    gem 'rubocop-yard', '~> 0'
+  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
+  gem 'pry', '~> 0'
+end

data/Guardfile

@@ -0,0 +1,44 @@
+# Copyright (c) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# notifications :emacs
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec --options config/rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop,
+      all_on_start: true,
+      cli: ['--display-cop-names', '--config=config/rubocop.yml'] do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m.first) }
+end
+
+guard :reek,
+      cli: ['--config config/reek.yml', '--single-line'] do
+  watch(/.+\.rb$/)
+  watch('config/reek.yml')
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Jérôme Arbez-Gindre, and the individual contributors
+to DefMastership.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,8 @@
+= defmastership-core
+
+== Features
+
+* Some classes/constants used by both asciidoctor-defmastership and defmastership itself
+
+
+

data/Rakefile

@@ -0,0 +1,20 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('rake/clean')
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+desc 'Continous integration tasks'
+task :ci do
+  [
+    'test:spec',
+    :rubocop
+  ].each do |name|
+    puts "\n=== Running #{name}...\n"
+    Rake::Task[name].invoke
+    puts "\n=== Running #{name} -> Done\n"
+  end
+end
+
+task default: :ci

data/config/mutant.yml

@@ -0,0 +1,30 @@
+---
+usage: opensource
+includes:
+  - lib
+integration:
+  name: rspec
+  arguments:
+    - --options=config/rspec
+    - spec
+requires:
+  - defmastership
+matcher:
+  subjects:
+    - 'DefMastership*'
+  # ignore:
+  #   - 'DefMastership::BatchModifier*'
+  #   - 'DefMastership::Export::CSV::Formatter*'
+  #   - 'DefMastership::Export::CSV::BodyFormatter*'
+  #   - 'DefMastership::Export::CSV::HeaderFormatter*'
+  #   - 'DefMastership::Modifier::ChangeRef*'
+  #   - 'DefMastership::Definition*'
+  #   - 'DefMastership::Document*'
+  #   - 'DefMastership::Modifier::ModifierCommon*'
+  #   - 'DefMastership::Modifier::Factory*'
+  #   - 'DefMastership::ParsingState*'
+  #   - 'DefMastership::Modifier::RenameIncludedFiles*'
+  #   - 'DefMastership::Modifier::UpdateDefChecksum*'
+  #   - 'DefMastership::Modifier::UpdateDef*'
+  #   - 'DefMastership::Modifier::UpdateDefVersion*'
+# fail_fast: true

data/config/reek.yml

@@ -0,0 +1,130 @@
+---
+# detectors:
+#   Attribute:
+#     enabled: true
+#     exclude: []
+#   BooleanParameter:
+#     enabled: true
+#     exclude: []
+#   ClassVariable:
+#     enabled: true
+#     exclude: []
+#   ControlParameter:
+#     enabled: true
+#     exclude: []
+#   DataClump:
+#     enabled: true
+#     exclude: []
+#     max_copies: 2
+#     min_clump_size: 2
+#   DuplicateMethodCall:
+#     enabled: true
+#     exclude: []
+#     max_calls: 1
+#     allow_calls: []
+#   FeatureEnvy:
+#     enabled: true
+#     exclude: []
+#   InstanceVariableAssumption:
+#     enabled: true
+#     exclude: []
+#   IrresponsibleModule:
+#     enabled: true
+#     exclude: []
+#   LongParameterList:
+#     enabled: true
+#     exclude: []
+#     max_params: 3
+#     overrides:
+#       initialize:
+#         max_params: 5
+#   LongYieldList:
+#     enabled: true
+#     exclude: []
+#     max_params: 3
+#   ManualDispatch:
+#     enabled: true
+#     exclude: []
+#   MissingSafeMethod:
+#     enabled: true
+#     exclude: []
+#   ModuleInitialize:
+#     enabled: true
+#     exclude: []
+#   NestedIterators:
+#     enabled: true
+#     exclude: []
+#     max_allowed_nesting: 1
+#     ignore_iterators:
+#     - tap
+#     - Tempfile.create
+#   NilCheck:
+#     enabled: true
+#     exclude: []
+#   RepeatedConditional:
+#     enabled: true
+#     exclude: []
+#     max_ifs: 2
+#   SubclassedFromCoreClass:
+#     enabled: true
+#     exclude: []
+#   TooManyConstants:
+#     enabled: true
+#     exclude: []
+#     max_constants: 5
+#   TooManyInstanceVariables:
+#     enabled: true
+#     exclude: []
+#     max_instance_variables: 4
+#   TooManyMethods:
+#     enabled: true
+#     exclude: []
+#     max_methods: 15
+#   TooManyStatements:
+#     enabled: true
+#     exclude:
+#     - initialize
+#     max_statements: 5
+#   UncommunicativeMethodName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^[a-z]$/"
+#     - "/[0-9]$/"
+#     - "/[A-Z]/"
+#     accept: []
+#   UncommunicativeModuleName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^.$/"
+#     - "/[0-9]$/"
+#     accept: []
+#   UncommunicativeParameterName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^.$/"
+#     - "/[0-9]$/"
+#     - "/[A-Z]/"
+#     - "/^_/"
+#     accept: []
+#   UncommunicativeVariableName:
+#     enabled: true
+#     exclude: []
+#     reject:
+#     - "/^.$/"
+#     - "/[0-9]$/"
+#     - "/[A-Z]/"
+#     accept:
+#     - "/^_$/"
+#   UnusedParameters:
+#     enabled: true
+#     exclude: []
+#   UnusedPrivateMethod:
+#     enabled: false
+#     exclude: []
+#   UtilityFunction:
+#     enabled: true
+#     exclude: []
+#     public_methods_only: false

data/config/rspec

@@ -0,0 +1,4 @@
+--format documentation
+--format html --out rspec_results.html
+--color
+--require spec_helper

data/config/rubocop.yml

@@ -0,0 +1,89 @@
+# 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
+  - rubocop-yard
+
+AllCops:
+  TargetRubyVersion: 2.7
+  EnabledByDefault: true
+  DisplayCopNames: true
+
+Style/Copyright:
+  Enabled: true
+  Notice: 'Copyright (\(c\) )?202[0-9] Jerome Arbez-Gindre'
+  AutocorrectNotice: '# Copyright (c) 2023 Jerome Arbez-Gindre'
+
+Lint/ConstantResolution: # Not available ins rubocop 0.81
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/StringHashKeys :
+  Enabled: true
+  Exclude:
+    - '*.gemspec'
+    - 'spec/unit/def_mastership/batch_modifier_spec.rb'
+    - 'spec/unit/def_mastership/modifier/update_def_checksum_spec.rb'
+    - 'spec/unit/def_mastership/modifier/update_def_spec.rb'
+    - 'spec/unit/def_mastership/modifier/update_def_version_spec.rb'
+
+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/defmastership/constants.rb'
+
+# rubocop-rspec options
+RSpec/MessageExpectation :
+  Enabled: true
+
+RSpec/SpecFilePathFormat :
+  Enabled: true
+
+RSpec/SpecFilePathSuffix :
+  Enabled: true
+
+RSpec/NestedGroups:
+  Max: 4
+
+Layout/RedundantLineBreak:
+  Enabled: false
+
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: true
+  Exclude:
+    - 'Gemfile'
+    - 'tasks/code_quality.rake'
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+

data/defmastership-core.gemspec

@@ -0,0 +1,33 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# Ensure we require the local version and not one we might have
+# installed already
+require(
+  File.join(
+    [
+      File.dirname(__FILE__),
+      'lib',
+      'defmastership',
+      'core',
+      'version.rb'
+    ]
+  )
+)
+
+Gem::Specification.new do |spec|
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+  spec.required_ruby_version = '>= 2.7'
+  spec.name = 'defmastership-core'
+  spec.version = DefMastership::Core::VERSION
+  spec.author = 'Jérôme Arbez-Gindre'
+  spec.email = 'jeromearbezgindre@gmail.com'
+  spec.licenses = ['MIT']
+  spec.homepage = 'https://gitlab.com/defmastership/defmastership-core/'
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = 'Handling of references and definitions with asciidoctor - common code'
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths << 'lib'
+end

data/lib/defmastership/core/constants.rb

@@ -0,0 +1,124 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # Common code for DefMastership and Asciidoctor::DefMastership
+  module Core
+    # set of regexp of added asciidoctor constructions
+    # This module smells of :reek:TooManyConstants
+    module DMRegexp
+      # [Regexp] to match a single line comment
+      SINGLE_LINE_COMMENT = %r{^//[^/]}.freeze
+      public_constant :SINGLE_LINE_COMMENT
+
+      # [Regexp] match all text before the definition's reference
+      DEF_BEFORE_REF = <<~'BEF'
+        ^\s*
+        \[\s*define\s*,
+        \s*(?<type>[\w:_-]+)\s*,
+        \s*
+      BEF
+      public_constant :DEF_BEFORE_REF
+
+      # [Regexp] match all text after the definition's reference
+      DEF_AFTER_REF = <<~'AFT'
+        \s*
+        (,\s*\[\s*(?<labels>.*?)\s*\])?\s*\]
+      AFT
+      public_constant :DEF_AFTER_REF
+
+      # [Regexp] match optional explicit version and explicit checksum
+      DEF_VERSION_AND_CHECKSUM = '(?<version_and_checksum>' \
+                                 '\((?<explicit_version>[^~]+)?(?<explicit_checksum>~[[:alnum:]]+)?\)' \
+                                 ')?'
+      public_constant :DEF_VERSION_AND_CHECKSUM
+
+      # [Regexp] match reference
+      REFERENCE = '(?<reference>[\\w:_-]+)'
+      public_constant :REFERENCE
+
+      # [Regexp] match a definition line
+      DEFINITION = Regexp.new(
+        "#{DEF_BEFORE_REF}#{REFERENCE}#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
+        Regexp::EXTENDED
+      )
+      public_constant :DEFINITION
+
+      # [Regexp] match a asciidcotor attribute definition
+      VARIABLE_DEF = /^\s*:(?<varname>[\w:_-]+):\s+
+                   (?<value>\S.*\S)\s*$/x.freeze
+      public_constant :VARIABLE_DEF
+
+      # [Regexp] match a asciidcotor attribute use
+      VARIABLE_USE = /{(?<varname>[\w:_-]+)}/x.freeze
+      public_constant :VARIABLE_USE
+
+      # [Regexp] match an external cross reference type configuration
+      EREF_CONFIG = /^\s*:eref-(?<reference>[\w:_-]+)-(?<symb>prefix|url):\s*
+                   \s*(?<value>\S.*\S)\s*/x.freeze
+      public_constant :EREF_CONFIG
+      # [Regexp] match an external cross reference use
+      EREF_DEF = /^\s*
+               defs:eref\[
+               \s*(?<reference>[\w:_-]+)\s*,
+               \s*\[\s*(?<extrefs>[^\]]+?)\s*\]\s*\]/x.freeze
+      public_constant :EREF_DEF
+
+      # [Regexp] match an asciidoc block delimiter
+      BLOCK = /^--\s*$/.freeze
+      public_constant :BLOCK
+
+      # [Regexp] match the begining of an internal cross reference
+      IREF_DEF_BEF = 'defs:iref\[\s*'
+      public_constant :IREF_DEF_BEF
+      # [Regexp] match the end of an internal cross reference
+      IREF_DEF_AFT = '\s*\]'
+      public_constant :IREF_DEF_AFT
+      # [Regexp] match an internal cross reference
+      IREF_DEF = Regexp.new(
+        "#{IREF_DEF_BEF}(?<intref>[\\w:_-]+)#{IREF_DEF_AFT}",
+        Regexp::EXTENDED
+      )
+      public_constant :IREF_DEF
+
+      # [Regexp] match an attribute configuration
+      ATTR_CONFIG = /\s*:attr-(?<attr>[\w:_-]+)-prefix:
+                      \s+(?<prefix>.+?)\s*$/x.freeze
+      public_constant :ATTR_CONFIG
+      # [Regexp] match an attribute use
+      ATTR_SET = /\s*
+                defs:attribute\[
+                \s*(?<attr>[\w:_-]+)\s*,
+                \s*(?<value>.+?)\s*\]/x.freeze
+      public_constant :ATTR_SET
+
+      # [Regexp] match an empty line
+      EMPTY_LINE = /^\s*$/.freeze
+      public_constant :EMPTY_LINE
+
+      # [Regexp] match everything
+      WHATEVER = //.freeze
+      public_constant :WHATEVER
+
+      # [Regexp] match asciidoc include statement keyword
+      INCLUDE_KEYWORD = '\binclude::'
+      public_constant :INCLUDE_KEYWORD
+      # [Regexp] match asciidoc include statement path
+      INCLUDE_PATH = '(?<path>.*/)?'
+      public_constant :INCLUDE_PATH
+      # [Regexp] match asciidoc include statement filename
+      INCLUDE_FILENAME = '(?<filename>[^\\/]+)'
+      public_constant :INCLUDE_FILENAME
+      # [Regexp] match asciidoc include statement options
+      INCLUDE_OPTIONS = '\[(?<options>[^\]]*)\]'
+      public_constant :INCLUDE_OPTIONS
+
+      # [Regexp] match asciidoc include statement
+      INCLUDE = Regexp.new(
+        INCLUDE_KEYWORD + INCLUDE_PATH + INCLUDE_FILENAME + INCLUDE_OPTIONS,
+        Regexp::EXTENDED
+      )
+      public_constant :INCLUDE
+    end
+  end
+end

data/lib/defmastership/core/parsing_state.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  module Core
+    # Allow to know if we need to parse the line or simply ignore it
+    class ParsingState
+      # mutant:disable (for mutant, aatribute initialization is useless)
+      def initialize
+        @last_disabling_line = nil
+      end
+
+      def enabled?(line)
+        return false if line.match?(DMRegexp::SINGLE_LINE_COMMENT)
+
+        line = line.chomp
+        possibly_invert_last_disabling_line(line) if ['....', '----', '////'].include?(line)
+
+        !@last_disabling_line
+      end
+
+      private
+
+      def possibly_invert_last_disabling_line(line)
+        if @last_disabling_line == line
+          @last_disabling_line = nil
+        elsif !@last_disabling_line
+          @last_disabling_line = line
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/core/version.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+module DefMastership
+  # Common to defmastership and asciidoctor-defmastership
+  module Core
+    # [String] Gem version
+    VERSION = '1.0.0'
+    public_constant :VERSION
+  end
+end

data/lib/defmastership.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/core/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/core/constants')
+require('defmastership/core/parsing_state')

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('simplecov')
+
+SimpleCov.start do
+  command_name 'spec:unit'
+
+  add_group 'Libraries', 'lib'
+  add_group 'Unit test', 'spec/unit'
+
+  add_filter 'config'
+  add_filter 'vendor'
+  add_filter 'set_join_hack'
+
+  minimum_coverage 100
+
+  enable_coverage :branch
+end
+
+RSpec::Matchers.define(:matchdata_including) do |h|
+  match do |matchdata|
+    h.all? do |key, _|
+      matchdata[key] == h[key]
+    end
+  end
+end
+
+require('defmastership')

data/spec/unit/def_mastership/core/parsing_state_spec.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/core/parsing_state')
+
+RSpec.describe(DefMastership::Core::ParsingState) do
+  subject(:parsing_state) do
+    described_class.new
+  end
+
+  describe '.new' do
+    it { is_expected.not_to(be_nil) }
+  end
+
+  describe '#enabled_with?' do
+    context 'when single line commment' do
+      it { expect(parsing_state.enabled?("//whatever\n")).to(be(false)) }
+    end
+
+    context 'when starting' do
+      it { expect(parsing_state.enabled?("whatever\n")).to(be(true)) }
+      it { expect(parsing_state.enabled?("----\n")).to(be(false)) }
+      it { expect(parsing_state.enabled?("....\n")).to(be(false)) }
+      it { expect(parsing_state.enabled?("////\n")).to(be(false)) }
+      it { expect(parsing_state.enabled?('....')).to(be(false)) }
+    end
+
+    context 'when disabled' do
+      before { parsing_state.enabled?("----\n") }
+
+      it { expect(parsing_state.enabled?("whatever\n")).to(be(false)) }
+      it { expect(parsing_state.enabled?("----\n")).to(be(true)) }
+      it { expect(parsing_state.enabled?("....\n")).to(be(false)) }
+      it { expect(parsing_state.enabled?("////\n")).to(be(false)) }
+    end
+
+    context 'with intricated disables starting with "...."' do
+      before do
+        ["....\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
+      end
+
+      it { expect(parsing_state.enabled?("----\n")).to(be(false)) }
+      it { expect(parsing_state.enabled?("....\n")).to(be(true)) }
+    end
+
+    context 'with intricated disables starting with "----"' do
+      before do
+        ["....\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
+      end
+
+      it { expect(parsing_state.enabled?("....\n")).to(be(true)) }
+    end
+
+    context 'with intricated disables starting with "////"' do
+      before do
+        ["////\n", "----\n", "whatever\n"].each { |line| parsing_state.enabled?(line) }
+      end
+
+      it { expect(parsing_state.enabled?("////\n")).to(be(true)) }
+    end
+  end
+end

data/spec/unit/def_mastership/core_spec.rb

@@ -0,0 +1,8 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+RSpec.describe(DefMastership::Core) do
+  it 'has a version number' do
+    expect(DefMastership::Core::VERSION).not_to(be_nil)
+  end
+end

data/tasks/code_quality.rake

@@ -0,0 +1,74 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
+namespace 'quality' do
+  begin
+    require('rubocop/rake_task')
+
+    RuboCop::RakeTask.new do |task|
+      task.options << '--display-cop-names'
+      task.options << '--config=config/rubocop.yml'
+    end
+  rescue LoadError
+    task(:rubocop) do
+      puts('Install rubocop to run its rake tasks')
+    end
+  end
+
+  begin
+    require('reek/rake/task')
+
+    Reek::Rake::Task.new do |task|
+      task.fail_on_error = true
+      task.source_files = '{lib,spec}/**/*.rb'
+      task.reek_opts = '--config config/reek.yml --single-line'
+    end
+  rescue LoadError
+    task(:reek) do
+      puts('Install reek to run its rake tasks')
+    end
+  end
+
+  begin
+    require('flay_task')
+
+    FlayTask.new(:flay, 200, %w[bin lib]) do |task|
+      task.verbose = true
+    end
+  rescue LoadError
+    task(:flay) do
+      puts('Install flay to run its rake tasks')
+    end
+  end
+
+  begin
+    require('rubycritic/rake_task')
+
+    RubyCritic::RakeTask.new do |task|
+      task.verbose = true
+      task.options = '--no-browser'
+    end
+  rescue LoadError
+    task(:rubycritic) do
+      puts('Install rubycritic to run its rake tasks')
+    end
+  end
+
+  desc 'Runs all quality code check'
+  task(
+    all: [
+      'quality:rubocop',
+      'quality:reek',
+      'quality:flay',
+      'quality:rubycritic'
+    ]
+  )
+end
+# rubocop:enable Metrics/BlockLength
+
+desc 'Synonym for quality:rubocop'
+task(rubocop: 'quality:rubocop')
+
+desc 'Synonym for quality:reek'
+task(reek: 'quality:reek')

data/tasks/console.rake

@@ -0,0 +1,8 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+desc 'Starts the interactive console'
+task :console do
+  require 'pry'
+  Pry.start
+end

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) 2024 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('bundler/gem_tasks')

data/tasks/test.rake

@@ -0,0 +1,19 @@
+# Copyright (c) 2023 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('rspec/core/rake_task')
+
+namespace 'test' do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['--options config/rspec']
+  end
+
+  desc 'Runs all unit tests'
+  task(all: ['test:spec'])
+end
+
+desc 'Synonym for test:spec'
+task(spec: 'test:spec')
+
+desc 'Synonym for test:all'
+task(test: 'test:all')

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: defmastership-core
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jérôme Arbez-Gindre
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-14 00:00:00.000000000 Z
+dependencies: []
+description:
+email: jeromearbezgindre@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.adoc
+- Rakefile
+- config/mutant.yml
+- config/reek.yml
+- config/rspec
+- config/rubocop.yml
+- defmastership-core.gemspec
+- lib/defmastership.rb
+- lib/defmastership/core/constants.rb
+- lib/defmastership/core/parsing_state.rb
+- lib/defmastership/core/version.rb
+- spec/spec_helper.rb
+- spec/unit/def_mastership/core/parsing_state_spec.rb
+- spec/unit/def_mastership/core_spec.rb
+- tasks/code_quality.rake
+- tasks/console.rake
+- tasks/documentation.rake
+- tasks/package.rake
+- tasks/test.rake
+homepage: https://gitlab.com/defmastership/defmastership-core/
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Handling of references and definitions with asciidoctor - common code
+test_files: []