vectory 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7ebbb9e4146780f1f9d42e0dee106494c251eb27b7d3f52d69f172da0a0d2e7
-  data.tar.gz: 132e451c7c1e9298f305f67a7103f8da8b7d5af3df371f5705e8a2eb95b59991
+  metadata.gz: 29078da81dfd3def401e196f9c13654a5b2ccc4eefed851c261796cca0e8e9d2
+  data.tar.gz: 602ba638f3ff426687d778c87d4f93bde391cd7aaaa565902374bede727e0bd5
 SHA512:
-  metadata.gz: 33a7acbdacd776a6627d30a2641123743d325b3c5f89b3f1f40a244556b4f363c1c2a4b49458d2260014c53004a2d06a9c8d7f617e732f82457c30576e9c6085
-  data.tar.gz: 4a243d964fcda1b2d7e8dab7ef9bea706265c646d168d70df847bc6fd4d4e6c9f3453334adf4b0824670a59c029e4fa8a5812d4aecb4714298dfaa3425e1010a
+  metadata.gz: 32c32817c07c2578914427b923f82f97cbfd71249d11d10c07dcab6ad051d647679bd7cffdcaf6b104a6bd928dc8fe71bba32e686ebb00d1fa2c2b3758b93cd0
+  data.tar.gz: 3636e536af14c71d4efd99136c0408528412a20b7e50e12efd33147d8c7e5bea1bb70128c35af71b9b439febd2ab3636c29a58984e04b49ecb146c292891180e

data/.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  repository_dispatch:
+    workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+          cache-version: 0
+          working-directory: docs
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        run: bundle exec jekyll build --verbose --trace --baseurl "${{ steps.pages.outputs.base_path }}"
+        working-directory: docs
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/_site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/.github/workflows/links.yml

@@ -0,0 +1,99 @@
+name: links
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  pull_request:
+    paths:
+      - 'docs/**'
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  link_checker:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.4'
+        bundler-cache: true
+        working-directory: docs
+
+    - name: Build site
+      env:
+        JEKYLL_ENV: production
+      run: bundle exec jekyll build --trace
+      working-directory: docs
+
+    - name: Restore lychee cache
+      uses: actions/cache@v4
+      with:
+        path: .lycheecache
+        key: cache-lychee-${{ github.sha }}
+        restore-keys: cache-lychee-
+
+    - name: Check if site was built
+      run: |
+        if [ ! -d "_site" ]; then
+          echo "Error: _site directory not created"
+          exit 1
+        fi
+        echo "Site built successfully"
+        ls -la _site/
+      working-directory: docs
+
+    - name: Link Checker (Built Site)
+      uses: lycheeverse/lychee-action@v2
+      with:
+        # Check the built HTML site for rendered links
+        # Only check https and http schemes, exclude file:// due to path resolution issues
+        args: >-
+          --verbose
+          --no-progress
+          --config lychee.toml
+          --root-dir "$(pwd)/_site"
+          --scheme https,http
+          '_site/**/*.html'
+        fail: true
+        output: link-check-results.md
+        format: markdown
+        workingDirectory: docs
+
+    - name: Upload link check results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: link-check-results
+        path: |
+          docs/link-check-results.md
+        retention-days: 30
+
+    - name: Comment PR with results
+      if: "${{ failure() && github.event_name == 'pull_request' }}"
+      uses: actions/github-script@v7
+      with:
+          script: |
+            const fs = require('fs');
+            let comment = '## 🔗 Link Check Failed\n\n';
+
+            if (fs.existsSync('docs/link-check-results.md')) {
+              const results = fs.readFileSync('docs/link-check-results.md', 'utf8');
+              comment += '### Built Site Results\n\n' + results + '\n\n';
+            }
+
+            comment += '\n---\n\n*Please fix the broken links and push a new commit.*';
+
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment
+            });

data/.github/workflows/rake.yml

@@ -8,8 +8,12 @@ on:
     tags: [ v* ]
   pull_request:
 
+permissions:
+  contents: write
+  packages: read
+
 jobs:
   rake:
     uses: metanorma/ci/.github/workflows/inkscape-rake.yml@main
     secrets:
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+      pat_token: ${{ secrets.CLARICLE_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -13,12 +13,16 @@ on:
   push:
     tags: [ v* ]
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 jobs:
   release:
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:
-      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
-
+      rubygems-api-key: ${{ secrets.CLARICLE_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.CLARICLE_CI_PAT_TOKEN }}

data/.gitignore

@@ -2,3 +2,8 @@
 Gemfile.lock
 .rspec_status
 .rubocop-*
+
+.sass-cache
+_site
+CLAUDE.md
+.kilocode

data/.rubocop.yml

@@ -1,11 +1,19 @@
 # Auto-generated by Cimas: Do not edit it manually!
 # See https://github.com/metanorma/cimas
 inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+inherit_mode:
+  merge:
+    - Exclude
 
 # local repo-specific modifications
 # ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.5
-  SuggestExtensions: false
+  TargetRubyVersion: 3.0

data/.rubocop_todo.yml

@@ -0,0 +1,252 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2026-01-20 11:39:21 UTC using RuboCop version 1.82.1.
+# 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
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'vectory.gemspec'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/vectory/configuration.rb'
+    - 'lib/vectory/conversion/ghostscript_strategy.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'lib/vectory/conversion.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'lib/vectory/conversion.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'lib/vectory/platform.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/vectory/conversion.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, AllowedPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/vectory/conversion.rb'
+
+# Offense count: 76
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/vectory/configuration.rb'
+    - 'lib/vectory/conversion.rb'
+    - 'lib/vectory/conversion/ghostscript_strategy.rb'
+
+# Offense count: 11
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/vectory/capture.rb'
+    - 'lib/vectory/cli.rb'
+    - 'lib/vectory/configuration.rb'
+    - 'lib/vectory/ghostscript_wrapper.rb'
+    - 'lib/vectory/image_resize.rb'
+    - 'lib/vectory/inkscape_wrapper.rb'
+    - 'lib/vectory/system_call.rb'
+    - 'spec/support/text_matcher.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 32
+
+# Offense count: 3
+# Configuration parameters: CountBlocks, CountModifierForms.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 10
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/vectory/capture.rb'
+    - 'lib/vectory/configuration.rb'
+    - 'lib/vectory/ghostscript_wrapper.rb'
+    - 'lib/vectory/image_resize.rb'
+    - 'lib/vectory/inkscape_wrapper.rb'
+
+# Offense count: 25
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 174
+
+# Offense count: 9
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/vectory/capture.rb'
+    - 'lib/vectory/configuration.rb'
+    - 'lib/vectory/ghostscript_wrapper.rb'
+    - 'lib/vectory/image_resize.rb'
+    - 'lib/vectory/inkscape_wrapper.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/vectory/platform.rb'
+
+# Offense count: 1
+# 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/vectory/image_resize_spec.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Performance/StringInclude:
+  Exclude:
+    - 'lib/vectory/platform.rb'
+
+# Offense count: 1
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/vectory/cli_spec.rb'
+
+# Offense count: 56
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/vectory/capture_spec.rb'
+    - 'spec/vectory/cli_spec.rb'
+    - 'spec/vectory/datauri_spec.rb'
+    - 'spec/vectory/eps_spec.rb'
+    - 'spec/vectory/inkscape_wrapper_spec.rb'
+    - 'spec/vectory/svg_document_spec.rb'
+    - 'spec/vectory/svg_mapping_spec.rb'
+    - 'spec/vectory/svg_spec.rb'
+    - 'spec/vectory/system_call_spec.rb'
+    - 'spec/vectory/utils_spec.rb'
+    - 'spec/vectory/vector_spec.rb'
+
+# Offense count: 43
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 38
+
+# Offense count: 8
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 45
+RSpec/MultipleExpectations:
+  Max: 10
+
+# Offense count: 2
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: ^expect_, ^assert_
+RSpec/NoExpectationExample:
+  Exclude:
+    - 'spec/vectory/image_resize_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExampleGroupBody:
+  Exclude:
+    - 'spec/vectory/vector_spec.rb'
+
+# Offense count: 5
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/vectory/cli_spec.rb'
+    - 'spec/vectory/inkscape_wrapper_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: separated, grouped
+Style/AccessorGrouping:
+  Exclude:
+    - 'lib/vectory/configuration.rb'
+
+# Offense count: 1
+# 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/vectory/conversion.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'lib/vectory/configuration.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/vectory/configuration.rb'
+
+# Offense count: 15
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/vectory/conversion/strategy.rb'
+    - 'lib/vectory/platform.rb'
+
+# Offense count: 13
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: .
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: percent
+  MinSize: 3

data/Gemfile

@@ -5,9 +5,11 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in vectory.gemspec
 gemspec
 
-gem "equivalent-xml"
+gem "canon", "~> 0.1.7"
+gem "openssl", "~> 3.0"
 gem "rake"
 gem "rspec"
 gem "rubocop"
 gem "rubocop-performance"
-gem "rexml"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/README.adoc

@@ -2,7 +2,7 @@
 
 image:https://img.shields.io/gem/v/vectory.svg["Gem Version", link="https://rubygems.org/gems/vectory"]
 image:https://github.com/metanorma/vectory/actions/workflows/rake.yml/badge.svg["rake", link="https://github.com/metanorma/vectory/actions/workflows/rake.yml"]
-image:https://codeclimate.com/github/metanorma/vectory/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/vectory"]
+// image:https://codeclimate.com/github/metanorma/vectory/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/vectory"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/vectory.svg["Pull Requests", link="https://github.com/metanorma/vectory/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/vectory/latest.svg["Commits since latest",link="https://github.com/metanorma/vectory/releases"]
 
@@ -355,6 +355,28 @@ Vector#width
 
 == Development
 
+=== Regenerating Test Fixtures
+
+Some test fixtures are generated by external tools (Ghostscript, Inkscape, cairo).
+When these tools are updated, the reference files may need to be regenerated.
+
+To regenerate all test fixtures:
+
+[source,sh]
+----
+bundle exec rake regenerate_fixtures
+
+----
+
+This will update the following files:
+
+* `spec/examples/ps2eps/ref.eps` - PS to EPS conversion reference
+* `spec/examples/ps2svg/ref.svg` - PS to SVG conversion reference
+* `spec/examples/svg/doc2-ref.xml` - SVG mapping reference
+
+NOTE: After regenerating fixtures, review the changes to ensure they are expected
+before committing.
+
 === Releasing
 
 Releasing is done automatically with GitHub Actions. Just bump and tag with

data/Rakefile

@@ -12,3 +12,16 @@ task default: :spec
 # RuboCop::RakeTask.new
 
 # task default: %i[spec rubocop]
+
+desc "Regenerate test fixture reference files"
+task :regenerate_fixtures do
+  require "fileutils"
+  require_relative "spec/support/fixture_generator"
+
+  puts "Regenerating test fixtures..."
+  FixtureGenerator.generate_all
+  puts "Fixtures regenerated successfully!"
+rescue LoadError => e
+  abort "Error: #{e.message}\n" \
+       "Make sure all dependencies are installed: bundle install"
+end

data/docs/Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+# Jekyll plugins
+gem "jekyll", "~> 3.0"
+gem "just-the-docs", "~> 0.7"
+
+# Markdown and AsciiDoc processing
+gem "asciidoctor", "~> 2.0"
+gem "jekyll-asciidoc", "~> 3.0"
+gem "kramdown-parser-gfm"
+
+# SEO and metadata
+gem "jekyll-seo-tag", "~> 2.0"
+gem "jekyll-sitemap", "~> 1.0"
+
+# Windows compatibility
+gem "jekyll-watch", "~> 2.0", platforms: %i[mingw x64_mingw]
+gem "wdm", "~> 0.1", platforms: %i[mingw x64_mingw]