coradoc 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f44a34ea3abbb6cff77d55b6516b74400db157035c2134a674ad5fe49a11f94
-  data.tar.gz: aa000ad423925a5e39f410e72e543071f5aa33e5a10c2cdefc10ee8e3bfa3c57
+  metadata.gz: 61351918127e3bddfa39198817d989d701b8acd4f12dac620953cbe774f225ad
+  data.tar.gz: 32f37a1ad17a8cf4ef39cd9d55c8c67fc20a9fd4cfa2bd45e7aa2182f2b4526c
 SHA512:
-  metadata.gz: f8f0ddca5617607309d097195635f5b316b84f031c381cfe9dc8274e557beadb4d610ad990909d219e49297bdedb67034889902e7dcbcfdf2617ec578fc75f69
-  data.tar.gz: 6a98d048011b6314b2c9ae457e43f10730b0238f1329d4cae7d38494966d23b2e13a75dc4f4df1cb4938e5451b3363c5514be15aa6f1f55a4dbfb26eab6c7307
+  metadata.gz: b3e881fb0c7dab5fb554d38fa216f5c3c22bff1be1488106b7831c137f2a841d733c234ca1f41b5fbad92940a33b175f19ea43435a4379a978ab96c73908cef9
+  data.tar.gz: d066670c69d78e1273aeb8b26307a06aa4a847b261dc6eb0175fd69d0443e2e4a2f23b78973a518e749f9f630a9fb14396c5617fd222aba8aa9f8ecd219ec64c

data/.envrc

@@ -0,0 +1 @@
+use flake

data/.irbrc

@@ -0,0 +1 @@
+require "coradoc"

data/.rspec

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

data/.rubocop.yml

@@ -1,10 +1,14 @@
 # Auto-generated by Cimas: Do not edit it manually!
 # See https://github.com/metanorma/cimas
 inherit_from:
+  - .rubocop_todo.yml
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.1
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table

data/.rubocop_todo.yml

@@ -0,0 +1,179 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-03-23 04:57:22 UTC using RuboCop version 1.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/coradoc/input/html/converters/table.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'lib/coradoc/input/html/converters/table.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, AllowedPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/coradoc/input/html/converters/table.rb'
+
+# Offense count: 236
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 6
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/coradoc/element/attribute_list_spec.rb'
+    - 'spec/coradoc/parser/asciidoc/document_attributes_spec.rb'
+    - 'spec/coradoc/parser/asciidoc/header_spec.rb'
+    - 'spec/coradoc/parser/asciidoc/section_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AutoCorrect, AllowComments.
+Lint/EmptyConditionalBody:
+  Exclude:
+    - 'lib/coradoc/element/attribute_list.rb'
+
+# Offense count: 53
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Enabled: false
+
+# Offense count: 85
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 7
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 40
+
+# Offense count: 23
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# Offense count: 57
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 187
+
+# Offense count: 1
+# Configuration parameters: Max, CountKeywordArgs.
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
+
+# Offense count: 20
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'utils/inspect_asciidoc.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'utils/parser_analyzer.rb'
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/coradoc/parser_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowOnlyRestArgument, UseAnonymousForwarding, RedundantRestArgumentNames, RedundantKeywordRestArgumentNames, RedundantBlockArgumentNames.
+# RedundantRestArgumentNames: args, arguments
+# RedundantKeywordRestArgumentNames: kwargs, options, opts
+# RedundantBlockArgumentNames: blk, block, proc
+Style/ArgumentsForwarding:
+  Exclude:
+    - 'lib/coradoc/element/base.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/coradoc/input/html/converters/table.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForClasses, EnforcedStyleForModules.
+# SupportedStyles: nested, compact
+# SupportedStylesForClasses: , nested, compact
+# SupportedStylesForModules: , nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/coradoc/input/html/converters/table.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBranchesCount.
+Style/HashLikeCase:
+  Exclude:
+    - 'lib/coradoc/input/html/converters/ol.rb'
+    - 'lib/coradoc/input/html/converters/table.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/coradoc/parser/asciidoc/paragraph.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/coradoc/element/attribute_list.rb'
+    - 'lib/coradoc/element/table.rb'
+    - 'lib/coradoc/parser/asciidoc/content.rb'
+    - 'lib/coradoc/parser/asciidoc/paragraph.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/coradoc/element/attribute_list.rb'
+    - 'lib/coradoc/element/document_attributes.rb'

data/README.adoc

@@ -1,5 +1,10 @@
 = Coradoc: object-oriented AsciiDoc parser
 
+image:https://img.shields.io/gem/v/coradoc.svg["Gem Version", link="https://rubygems.org/gems/coradoc"]
+image:https://github.com/metanorma/coradoc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/coradoc/actions?workflow=rake"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/coradoc.svg["Pull Requests", link="https://github.com/metanorma/coradoc/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/coradoc/latest.svg["Commits since latest",link="https://github.com/metanorma/coradoc/releases"]
+
 Coradoc is a modern Parser for Asciidoc document. It defines a grammar for
 AsciiDoc, and then build the Parser for that grammar.
 

data/coradoc.gemspec

@@ -26,15 +26,15 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
 
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
+  spec.add_dependency "base64"
   spec.add_dependency "marcel", "~> 1.0.0"
-  spec.add_dependency "plurimath"
-  spec.add_dependency "unitsml"
   spec.add_dependency "nokogiri", "~> 1.13"
   spec.add_dependency "oscal", "~> 0.1.1"
   spec.add_dependency "parslet"
-  spec.add_dependency "word-to-markdown"
-  spec.add_dependency "base64"
+  spec.add_dependency "plurimath"
   spec.add_dependency "thor", ">= 1.3.0"
+  spec.add_dependency "unitsml"
+  spec.add_dependency "word-to-markdown"
 end

data/exe/reverse_adoc

@@ -12,7 +12,7 @@ require "fileutils"
 config = {
   input_options: input_options = {},
   input_processor: :html,
-  output_options: output_options = {},
+  output_options: {},
   output_processor: :adoc,
 }
 destination = nil

data/exe/w2a

@@ -13,7 +13,7 @@ ARGV.push("-h") if ARGV.empty?
 config = {
   input_options: input_options = {},
   input_processor: :docx,
-  output_options: output_options = {},
+  output_options: {},
   output_processor: :adoc,
 }
 destination = nil

data/flake.lock

@@ -0,0 +1,114 @@
+{
+  "nodes": {
+    "devshell": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      },
+      "locked": {
+        "lastModified": 1735644329,
+        "narHash": "sha256-tO3HrHriyLvipc4xr+Ewtdlo7wM1OjXNjlWRgmM7peY=",
+        "owner": "numtide",
+        "repo": "devshell",
+        "rev": "f7795ede5b02664b57035b3b757876703e2c3eac",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "ref": "main",
+        "repo": "devshell",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1733328505,
+        "narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1722073938,
+        "narHash": "sha256-OpX0StkL8vpXyWOGUD6G+MA26wAXK6SpT94kLJXo6B4=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e36e9f57337d0ff0cf77aceb58af4c805472bfae",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1740462281,
+        "narHash": "sha256-XBy4GxTPJRt/43Z4Ra7jud7vLFaElTW0veddAPGk8P0=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "521ddca6084dd8e203f68dbd36b392d890e2a85a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "master",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devshell": "devshell",
+        "flake-compat": "flake-compat",
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs_2"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/flake.nix

@@ -0,0 +1,135 @@
+{
+  description = "Ruby Dev Env";
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/master";
+    flake-utils.url = "github:numtide/flake-utils";
+    devshell.url = "github:numtide/devshell/main";
+    flake-compat = {
+      url = "github:edolstra/flake-compat";
+      flake = false;
+    };
+  };
+  outputs =
+    { self
+    , nixpkgs
+    , flake-utils
+    , devshell
+    , flake-compat
+    , ...
+    }:
+    flake-utils.lib.eachDefaultSystem (system:
+    let
+      cwd = builtins.toString ./.;
+      overlays = map (x: x.overlays.default) [
+        devshell
+      ];
+      pkgs = import nixpkgs { inherit system overlays; };
+      runtimeDependencies = with pkgs; [
+        graphviz
+        inkscape
+        jre
+        plantuml
+        xml2rfc
+      ];
+    in
+    rec {
+
+      # nix develop
+      devShell = pkgs.devshell.mkShell {
+
+        env = [
+        ];
+        commands = [
+          {
+            name = "soffice-test";
+            # name = "soffice"; # This for some reason will stall the shell.
+            command = "${pkgs.libreoffice-bin}/Applications/LibreOffice.app/Contents/MacOS/soffice \"$@\"";
+            help = "Run libreoffice CLI";
+            category = "App";
+          }
+          {
+            name = "reverse_adoc";
+            command = "exe/reverse_adoc \"$@\"";
+            help = "Run reverse_adoc CLI";
+            category = "App";
+          }
+          {
+            name = "coradoc";
+            command = "exe/coradoc \"$@\"";
+            help = "Run coradoc CLI";
+            category = "App";
+          }
+          {
+            name = "release";
+            command = "bundle exec rake release \"$@\"";
+            help = "Run rake release, which adds a tag and pushes to RubyGems";
+            category = "Ruby";
+          }
+          {
+            name = "lint";
+            command = "bundle exec rubocop \"$@\"";
+            help = "Run rubocop";
+            category = "Ruby";
+          }
+          {
+            name = "update-flakes";
+            command = "make update-flakes \"$@\"";
+            help = "Update all flakes";
+            category = "Nix";
+          }
+        ] ++
+        # Only append these if there is no .tool-verions file
+        # to avoid conflicts:
+        (if ! builtins.pathExists ./.tool-versions then
+          [{
+
+            name = "irb";
+            command = "bundle exec irb \"$@\"";
+            help = "Run console IRB (has completion menu)";
+            category = "Ruby";
+          }
+            {
+              name = "console";
+              command = "bundle exec irb \"$@\"";
+              help = "Run console IRB (has completion menu)";
+              category = "Ruby";
+            }
+            {
+              name = "pry";
+              command = "bundle exec pry \"$@\"";
+              help = "Run pry";
+              category = "Ruby";
+            }
+            {
+              name = "rspec";
+              command = "bundle exec rspec \"$@\"";
+              help = "Run test suite";
+              category = "Ruby";
+            }]
+        else [ ]);
+
+        packages = with pkgs; [
+          # rubocop                  # Install with your Gemfile / gemspec
+          # ruby                     # Install with your favourite Ruby version manager, etc.
+          # rubyPackages.solargraph  # Bring your own
+          # rubyfmt                  # Broken
+          bash
+          curl
+          fd
+          gnused
+          jq
+          ripgrep
+          rubyPackages.ruby-lsp
+          rubyPackages.sorbet-runtime
+          wget
+          # libreoffice-still # unsupported in darwin
+          # libreoffice-unwrapped # unsupported in darwin
+          # libreoffice # unsupported in darwin
+          # libreoffice-bin # soffice returns nothing. Wrapper to call LibreOffice.App/Contents/MacOS/soffice implemented in devShell's command
+          pkg-config # for building native extensions
+        ] ++
+        runtimeDependencies;
+
+      };
+    });
+}

data/lib/coradoc/cli.rb

@@ -57,7 +57,7 @@ module Coradoc
       config = {
         input_options: input_options = {},
         input_processor: nil,
-        output_options: output_options = {},
+        output_options: {},
         output_processor: nil,
       }
 

data/lib/coradoc/converter.rb

@@ -16,8 +16,8 @@ module Coradoc
       yield if block_given?
     end
 
-    def self.call(*args, **kwargs, &block)
-      new(*args, **kwargs, &block).convert
+    def self.call(...)
+      new(...).convert
     end
 
     def input_processor
@@ -37,7 +37,7 @@ module Coradoc
     end
 
     def convert(data = nil)
-      input_id = input_processor.processor_id
+      input_processor.processor_id
       output_id = output_processor.processor_id
 
       unless data
@@ -51,8 +51,7 @@ module Coradoc
       if input_processor.respond_to? :processor_wants_filenames
         unless input.respond_to? :path
           raise NoInputPathError,
-                "no input path given, but #{input_processor} wants that " +
-                  "form. Ensure you don't read from standard input."
+                "no input path given, but #{input_processor} wants that form. Ensure you don't read from standard input."
         end
 
         data = input.path

data/lib/coradoc/element/attribute.rb

@@ -5,7 +5,16 @@ module Coradoc
 
       def initialize(key, value, _options = {})
         @key = key.to_s
-        @value = build_values(value.to_s)
+        @value = if extensions_value?(value.to_s)
+                   build_values(value.to_s)
+                 else
+                   value.to_s.strip
+                 end
+      end
+
+      def extensions_value?(value)
+        v = value.split(",").map(&:strip)
+        v.intersect? %w[xml html pdf xml adoc rxl]
       end
 
       private

data/lib/coradoc/element/attribute_list.rb

@@ -59,7 +59,7 @@ module Coradoc
       end
 
       def validate_named(validators)
-        @named.each_with_index do |(name, value), i|
+        @named.each_with_index do |(name, value), _i|
           name = name.to_sym
           validator = validators[name]
 
@@ -82,8 +82,9 @@ module Coradoc
         adoc << "," if @positional.any? && @named.any?
         adoc << @named.map do |k, v|
           if v.is_a?(String)
-            v = v.gsub("\"", "\\\"")
-            if v.include?(",") || v.include?('"')
+            if (v[0] == '"' && v[-1] == '"') || (v[0] == "'" && v[-1] == "'")
+            elsif v.include?(",") || v.include?('"')
+              v = v.gsub("\"", "\\\"")
               v = "\"#{v}\""
             end
           elsif v.is_a?(Array)

data/lib/coradoc/element/audio.rb

@@ -27,7 +27,7 @@ module Coradoc
         end: Integer,
         options: many("nofollow", "noopener", "inline", "interactive"),
         opts: many("nofollow", "noopener", "inline", "interactive"),
-      }
+      }.freeze
     end
   end
 end

data/lib/coradoc/element/author.rb

@@ -13,9 +13,9 @@ module Coradoc
       end
 
       def to_adoc
-        adoc = "#{@first_name}"
+        adoc = @first_name.to_s
         adoc << " #{@middle_name}" if @middle_name
-        adoc << " #{@last_name.to_s}"
+        adoc << " #{@last_name}"
         adoc << " <#{@email}>\n" if @email
         adoc
       end

data/lib/coradoc/element/base.rb

@@ -39,18 +39,30 @@ module Coradoc
 
       def self.declare_children(*children)
         @children = (@children || []).dup + children
+        access_children
+      end
+
+      # Make each child available for access
+      def self.access_children
+        @children.each do |child|
+          attr_accessor child
+        end
       end
 
       def self.visit(element, &block)
+        return element if element.nil?
+
         element = yield element, :pre
         element = if element.respond_to? :visit
                     element.visit(&block)
                   elsif element.is_a? Array
                     element.map { |child| visit(child, &block) }.flatten.compact
                   elsif element.is_a? Hash
-                    element.to_h do |k, v|
-                      [visit(k, &block), visit(v, &block)]
+                    result = {}
+                    element.each do |k, v|
+                      result[k] = visit(v, &block)
                     end
+                    result
                   else
                     element
                   end

data/lib/coradoc/element/bibliography.rb

@@ -7,7 +7,7 @@ module Coradoc
         @id = options.fetch(:id, nil)
         @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
         @title = options.fetch(:title, nil)
-        @entries = options.fetch(:entries,nil)
+        @entries = options.fetch(:entries, nil)
       end
 
       def to_adoc