defmastership 1.0.18 → 1.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.1.0
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-09 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: defmastership-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +94,41 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: jeromearbezgindre@gmail.com
 executables:
 - defmastership
 extensions: []
-extra_rdoc_files:
-- README.rdoc
-- defmastership.rdoc
+extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".rspec"
-- ".rubocop.yml"
 - Gemfile
+- Guardfile
 - LICENSE
-- README.rdoc
+- README.adoc
 - Rakefile
 - bin/defmastership
-- config/devtools.yml
-- config/flay.yml
-- config/flog.yml
+- config/cucumber.yml
 - config/mutant.yml
 - config/reek.yml
+- config/rspec
 - config/rubocop.yml
-- config/yardstick.yml
-- cucumber.yml
 - defmastership.gemspec
-- defmastership.rdoc
 - features/changeref.feature
 - features/definition_checksum.feature
 - features/definition_version.feature
@@ -88,51 +137,50 @@ files:
 - features/modify.feature
 - features/rename_included_files.feature
 - features/step_definitions/defmastership_steps.rb
+- features/step_definitions/git_steps.rb
 - features/support/env.rb
 - lib/defmastership.rb
 - lib/defmastership/batch_modifier.rb
-- lib/defmastership/change_ref_modifier.rb
 - lib/defmastership/comment_filter.rb
-- lib/defmastership/constants.rb
-- lib/defmastership/csv_formatter.rb
-- lib/defmastership/csv_formatter_body.rb
-- lib/defmastership/csv_formatter_header.rb
 - lib/defmastership/definition.rb
 - lib/defmastership/definition_parser.rb
 - lib/defmastership/document.rb
+- lib/defmastership/export/body_formatter.rb
+- lib/defmastership/export/csv/formatter.rb
+- lib/defmastership/export/header_formatter.rb
 - lib/defmastership/filters.rb
 - lib/defmastership/matching_line.rb
-- lib/defmastership/modifier.rb
-- lib/defmastership/modifier_factory.rb
-- lib/defmastership/parsing_state.rb
-- lib/defmastership/rename_included_files_modifier.rb
+- lib/defmastership/modifier/change_ref.rb
+- lib/defmastership/modifier/factory.rb
+- lib/defmastership/modifier/modifier_common.rb
+- lib/defmastership/modifier/rename_included_files.rb
+- lib/defmastership/modifier/update_def.rb
+- lib/defmastership/modifier/update_def_checksum.rb
+- lib/defmastership/modifier/update_def_version.rb
 - lib/defmastership/set_join_hack.rb
-- lib/defmastership/update_def_checksum_modifier.rb
-- lib/defmastership/update_def_modifier.rb
-- lib/defmastership/update_def_version_modifier.rb
 - lib/defmastership/version.rb
 - spec/spec_helper.rb
-- spec/unit/def_mastership/batch_modifier_spec.rb
-- spec/unit/def_mastership/change_ref_modifier_spec.rb
-- spec/unit/def_mastership/csv_formatter_body_spec.rb
-- spec/unit/def_mastership/csv_formatter_header_spec.rb
-- spec/unit/def_mastership/csv_formatter_spec.rb
-- spec/unit/def_mastership/definition_parser_spec.rb
-- spec/unit/def_mastership/definition_spec.rb
-- spec/unit/def_mastership/document_spec.rb
-- spec/unit/def_mastership/matching_line_spec.rb
-- spec/unit/def_mastership/modifier_factory_spec.rb
-- spec/unit/def_mastership/modifier_spec.rb
-- spec/unit/def_mastership/parsing_state_spec.rb
-- spec/unit/def_mastership/rename_included_files_modifier_spec.rb
-- spec/unit/def_mastership/string_spec.rb
-- spec/unit/def_mastership/update_def_checksum_modifier_spec.rb
-- spec/unit/def_mastership/update_def_modifier_spec.rb
-- spec/unit/def_mastership/update_def_version_modifier_spec.rb
-- spec/unit/def_mastership_spec.rb
+- spec/unit/defmastership/batch_modifier_spec.rb
+- spec/unit/defmastership/definition_parser_spec.rb
+- spec/unit/defmastership/definition_spec.rb
+- spec/unit/defmastership/document_spec.rb
+- spec/unit/defmastership/export/body_formatter_spec.rb
+- spec/unit/defmastership/export/csv/formatter_spec.rb
+- spec/unit/defmastership/export/header_formatter_spec.rb
+- spec/unit/defmastership/matching_line_spec.rb
+- spec/unit/defmastership/modifier/change_ref_spec.rb
+- spec/unit/defmastership/modifier/factory_spec.rb
+- spec/unit/defmastership/modifier/modifier_common_spec.rb
+- spec/unit/defmastership/modifier/rename_included_files_spec.rb
+- spec/unit/defmastership/modifier/update_def_checksum_spec.rb
+- spec/unit/defmastership/modifier/update_def_spec.rb
+- spec/unit/defmastership/modifier/update_def_version_spec.rb
+- spec/unit/defmastership/string_spec.rb
+- spec/unit/defmastership_spec.rb
+- tasks/code_quality.rake
 - tasks/console.rake
-- tasks/package.task
-- tasks/smelling_code.rake
+- tasks/documentation.rake
+- tasks/package.rake
 - tasks/test.rake
 homepage: https://gitlab.com/jjag/defmastership/
 licenses:
@@ -140,10 +188,7 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
 post_install_message:
-rdoc_options:
-- "--title defmastership"
-- "--main README.rdoc"
-- "-ri"
+rdoc_options: []
 require_paths:
 - lib
 - lib
@@ -158,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Handling of references and definitions with asciidoctor

data/.rubocop.yml

@@ -1,76 +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) 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/**/*'
-
-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/FilePath :
-  Enabled: true
-
-RSpec/NestedGroups:
-  Max: 4
-
-Layout/RedundantLineBreak:
-  Enabled: false
-
-Layout/EndOfLine:
-  EnforcedStyle: lf
-

data/README.rdoc

@@ -1,6 +0,0 @@
-= defmastership
-
-Describe your project here
-
-:include:defmastership.rdoc
-

data/config/devtools.yml

@@ -1,2 +0,0 @@
----
-unit_test_timeout: 0.2

data/config/flay.yml

@@ -1,3 +0,0 @@
----
-threshold: 8
-total_score: 119

data/config/flog.yml

@@ -1,2 +0,0 @@
----
-threshold: 13.5

data/config/yardstick.yml

@@ -1,2 +0,0 @@
----
-threshold: 100

data/cucumber.yml

@@ -1,2 +0,0 @@
----
-default: --publish --format pretty

data/defmastership.rdoc

@@ -1,5 +0,0 @@
-= defmastership
-
-Generate this with
-    defmastership _doc
-After you have described your command line interface

data/lib/defmastership/change_ref_modifier.rb

@@ -1,99 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require 'defmastership/constants'
-require 'defmastership/modifier'
-
-module DefMastership
-  # Change references from temporary to definitive with multiple RefChangers
-  class ChangeRefModifier
-    include Modifier
-
-    REGEXP_FROM = {
-      definition: {
-        before: DMRegexp::DEF_BEFORE_REF,
-        after: DMRegexp::DEF_AFTER_REF
-      },
-      iref: {
-        before: DMRegexp::IREF_DEF_BEF,
-        after: DMRegexp::IREF_DEF_AFT
-      }
-    }.freeze
-
-    private_constant :REGEXP_FROM
-
-    def self.replacement_methods
-      %i[replace_refdef replace_irefs]
-    end
-
-    def self.default_config
-      {
-        from_regexp: '',
-        to_template: '',
-        next_ref: 0
-      }
-    end
-
-    def initialize(config)
-      @parsing_state = ParsingState.new
-
-      setup_modifier_module(config)
-    end
-
-    def replace(method, line)
-      public_send(:"replace_#{method}", line)
-    end
-
-    def replace_refdef(line)
-      if @parsing_state.enabled?(line)
-        do_replace_refdef(line)
-      else
-        line
-      end
-    end
-
-    def replace_irefs(line)
-      changes.reduce(line) do |res_line, (from, to)|
-        res_line.gsub(Helper.regexp_from(:iref, from)) do
-          Helper.text_with(Regexp.last_match, to)
-        end
-      end
-    end
-
-    private
-
-    def do_replace_refdef(line)
-      line.sub(Helper.regexp_from(:definition, from_regexp)) do
-        replacement_from(Regexp.last_match)
-      end
-    end
-
-    def replacement_from(match)
-      replacement = to_template % hmerge(match)
-      changes << [match[:from], replacement]
-      config[:next_ref] += 1
-      Helper.text_with(match, replacement)
-    end
-
-    def hmerge(match)
-      config.merge(match.named_captures.transform_keys(&:to_sym))
-    end
-
-    # Helper functions
-    module Helper
-      def self.regexp_from(const, from)
-        regexps = REGEXP_FROM.fetch(const)
-        regexp_str =
-          "(?<before>#{regexps[:before]})" \
-          "(?<from>#{from})" \
-          "#{DMRegexp::DEF_VERSION_AND_CHECKSUM}" \
-          "(?<after>#{regexps[:after]})"
-        Regexp.new(regexp_str, Regexp::EXTENDED)
-      end
-
-      def self.text_with(match, replacement)
-        match[:before] + replacement + (match[:version_and_checksum] || '') + match[:after]
-      end
-    end
-  end
-end

data/lib/defmastership/constants.rb

@@ -1,89 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # set of regexp of added asciidoctor constructions
-  # This module smells of :reek:TooManyConstants
-  module DMRegexp
-    SINGLE_LINE_COMMENT = %r{^//[^/]}.freeze
-
-    DEF_BEFORE_REF = <<~'BEF'
-      ^\s*
-      \[\s*define\s*,
-      \s*(?<type>[\w:_-]+)\s*,
-      \s*
-    BEF
-
-    DEF_AFTER_REF = <<~'AFT'
-      \s*
-      (,\s*\[\s*(?<labels>.*?)\s*\])?\s*\]
-    AFT
-
-    DEF_VERSION_AND_CHECKSUM = '(?<version_and_checksum>' \
-                               '\((?<explicit_version>[^~]+)?(?<explicit_checksum>~[[:alnum:]]+)?\)' \
-                               ')?'
-
-    DEFINITION = Regexp.new(
-      "#{DEF_BEFORE_REF}(?<reference>[\\w:_-]+)#{DEF_VERSION_AND_CHECKSUM}#{DEF_AFTER_REF}",
-      Regexp::EXTENDED
-    )
-
-    VARIABLE_DEF = /^\s*:(?<varname>[\w:_-]+):\s+
-                   (?<value>\S.*\S)\s*$/x.freeze
-
-    VARIABLE_USE = /{(?<varname>[\w:_-]+)}/x.freeze
-
-    EREF_CONFIG = /^\s*:eref-(?<refname>[\w:_-]+)-(?<symb>prefix|url):\s*
-                   \s*(?<value>\S.*\S)\s*/x.freeze
-    EREF_DEF = /^\s*
-               defs:eref\[
-               \s*(?<refname>[\w:_-]+)\s*,
-               \s*\[\s*(?<extrefs>[^\]]+?)\s*\]\s*\]/x.freeze
-    BLOCK = /^--\s*$/.freeze
-
-    IREF_DEF_BEF = 'defs:iref\[\s*'
-    IREF_DEF_AFT = '\s*\]'
-    IREF_DEF = Regexp.new(
-      "#{IREF_DEF_BEF}(?<intref>[\\w:_-]+)#{IREF_DEF_AFT}",
-      Regexp::EXTENDED
-    )
-
-    ATTR_CONFIG = /\s*:attr-(?<attr>[\w:_-]+)-prefix:
-                      \s+(?<prefix>.+?)\s*$/x.freeze
-    ATTR_SET = /\s*
-                defs:attribute\[
-                \s*(?<attr>[\w:_-]+)\s*,
-                \s*(?<value>.+?)\s*\]/x.freeze
-
-    EMPTY_LINE = /^\s*$/.freeze
-
-    WHATEVER = //.freeze
-
-    INCLUDE_KEYWORD  = '\binclude::'
-    INCLUDE_PATH     = '(?<path>.*/)?'
-    INCLUDE_FILENAME = '(?<filename>[^\\/]+)'
-    INCLUDE_OPTIONS  = '\[(?<options>[^\]]*)\]'
-
-    INCLUDE = Regexp.new(
-      INCLUDE_KEYWORD + INCLUDE_PATH + INCLUDE_FILENAME + INCLUDE_OPTIONS,
-      Regexp::EXTENDED
-    )
-
-    public_constant :SINGLE_LINE_COMMENT,
-                    :DEF_BEFORE_REF,
-                    :DEF_AFTER_REF,
-                    :DEFINITION,
-                    :VARIABLE_DEF,
-                    :VARIABLE_USE,
-                    :EREF_CONFIG,
-                    :EREF_DEF,
-                    :BLOCK,
-                    :IREF_DEF_BEF,
-                    :IREF_DEF_AFT,
-                    :IREF_DEF,
-                    :ATTR_CONFIG,
-                    :ATTR_SET,
-                    :EMPTY_LINE,
-                    :WHATEVER
-  end
-end

data/lib/defmastership/csv_formatter.rb

@@ -1,53 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require('csv')
-require('defmastership/csv_formatter_body')
-require('defmastership/csv_formatter_header')
-
-module DefMastership
-  # to export a CSV file
-  class CSVFormatter
-    def initialize(doc, sep)
-      @doc = doc
-      @sep = sep
-    end
-
-    def export_to(output_file)
-      column_list = build_column_list
-      CSV.open(output_file, 'w:ISO-8859-1', col_sep: @sep) do |csv|
-        csv << header(column_list)
-        export_definitions_in(csv, column_list)
-      end
-    end
-
-    private
-
-    def export_definitions_in(csv, column_list)
-      @doc.definitions.each { |definition| csv << body(definition, column_list) }
-    end
-
-    def header(column_list)
-      header_formatter = CSVFormatterHeader.new(@doc)
-      header_line = column_list.map { |part| header_formatter.public_send(part) }
-      header_line.flatten
-    end
-
-    def body(definition, column_list)
-      body_formatter = CSVFormatterBody.new(@doc, definition)
-      body_line = column_list.map { |part| body_formatter.public_send(part) }
-      body_line.flatten
-    end
-
-    def build_column_list
-      [
-        [:wrong_explicit_checksum, @doc.wrong_explicit_checksum?],
-        [:explicit_version, @doc.explicit_version?],
-        [:labels, !@doc.labels.empty?],
-        [:eref, !@doc.eref.empty?],
-        [:iref, @doc.iref],
-        [:attributes, !@doc.attributes.empty?]
-      ].reduce([:fixed]) { |acc, elem| acc + (elem.fetch(1) ? [elem.first] : []) }
-    end
-  end
-end

data/lib/defmastership/csv_formatter_body.rb

@@ -1,46 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require('csv')
-
-require('defmastership/set_join_hack')
-
-module DefMastership
-  # format lines per definition
-  class CSVFormatterBody
-    def initialize(doc, definition)
-      @doc = doc
-      @definition = definition
-    end
-
-    def fixed
-      [@definition.type, @definition.reference, @definition.value, @definition.sha256_short]
-    end
-
-    def wrong_explicit_checksum
-      wrong_explicit_checksum = @definition.wrong_explicit_checksum
-      wrong_explicit_checksum ? [wrong_explicit_checksum] : ['']
-    end
-
-    def explicit_version
-      explicit_version = @definition.explicit_version
-      explicit_version ? [explicit_version] : ['']
-    end
-
-    def labels
-      [@definition.labels.join("\n")]
-    end
-
-    def eref
-      @doc.eref.map { |key,| @definition.eref.fetch(key, []).join("\n") }
-    end
-
-    def iref
-      [@definition.iref.join("\n")]
-    end
-
-    def attributes
-      @doc.attributes.map { |key,| @definition.attributes.fetch(key, '') }
-    end
-  end
-end

data/lib/defmastership/csv_formatter_header.rb

@@ -1,41 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require('csv')
-
-module DefMastership
-  # format header for one document
-  class CSVFormatterHeader
-    def initialize(doc)
-      @doc = doc
-    end
-
-    def fixed
-      %w[Type Reference Value Checksum]
-    end
-
-    def wrong_explicit_checksum
-      @doc.wrong_explicit_checksum? ? ['Wrong explicit checksum'] : []
-    end
-
-    def explicit_version
-      @doc.explicit_version? ? ['Version'] : []
-    end
-
-    def labels
-      @doc.labels.empty? ? [] : %w[Labels]
-    end
-
-    def eref
-      @doc.eref.map { |_, ref| ref.fetch(:prefix) }
-    end
-
-    def iref
-      @doc.iref ? ['Internal links'] : []
-    end
-
-    def attributes
-      @doc.attributes.map { |_, value| value }
-    end
-  end
-end