svg_conform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7012466cd29cbdbaa8ce867cc303b3ce937678269b0b88707e9b1e40a7b53e1
+  data.tar.gz: d03ea1ec2f7ce1acec7e8ec7804a421f8e432a66f9f83a9a04d1046e00396445
+SHA512:
+  metadata.gz: a43eb9a4225145d1d99bb5cacc968b9baa58cb5cd699257765664cd74deea99c1ad1a823454bde0d815537f767f2c0a9992c99c3f10d5c11c101b49816e23e7a
+  data.tar.gz: fc37e39db73f26ae67374cae615a9074aacf1b61ed77c3ae8fd80fedae4b6f2d1efa33c8f64cc7f28a5b0348b8bd00bf0c7205aa3c5e3b9ac27c7c18ff2b3253

data/.github/workflows/rake.yml

@@ -0,0 +1,15 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+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 }}

data/.github/workflows/svgcheck-compatibility.yml

@@ -0,0 +1,135 @@
+name: SVGCheck Compatibility
+
+on:
+  schedule:
+    # Run daily at 2 AM UTC
+    - cron: '0 2 * * *'
+  workflow_dispatch: # Allow manual triggering
+  push:
+    branches:
+      - main
+    paths:
+      - 'lib/svg_conform/**'
+      - 'spec/svgcheck_compatibility_spec.rb'
+      - 'lib/tasks/svgcheck.rake'
+
+jobs:
+  compatibility-test:
+    runs-on: ubuntu-latest
+    name: SVGCheck Compatibility Test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Checkout svgcheck reference repo
+        uses: actions/checkout@v4
+        with:
+          repository: ietf-tools/svgcheck
+          path: svgcheck-reference
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3.2'
+          bundler-cache: true
+
+      - name: Install svgcheck from source
+        run: |
+          cd svgcheck-reference
+          pip install -e .
+          cd ..
+
+      - name: Verify svgcheck installation
+        run: |
+          svgcheck --version
+
+      - name: Generate svgcheck test outputs
+        run: |
+          bundle exec svg_conform svgcheck generate svgcheck-reference --mode both
+
+      - name: Run compatibility tests
+        id: compatibility_tests
+        continue-on-error: true
+        run: |
+          bundle exec rspec spec/svgcheck_compatibility_spec.rb --format documentation | tee test_results.txt
+          echo "exit_code=${PIPESTATUS[0]}" >> $GITHUB_OUTPUT
+
+      - name: Check for fixture changes
+        id: check_changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Only check for changes in fixture files
+          if git diff --quiet spec/fixtures/svgcheck/; then
+            echo "has_changes=false" >> $GITHUB_OUTPUT
+            echo "No changes in svgcheck fixtures"
+          else
+            echo "has_changes=true" >> $GITHUB_OUTPUT
+            echo "Changes detected in svgcheck fixtures"
+            # Only stage the fixture files for commit
+            git add spec/fixtures/svgcheck/
+          fi
+
+      - name: Prepare PR body with test results
+        if: steps.check_changes.outputs.has_changes == 'true'
+        run: |
+          cat > pr_body.md << 'EOF'
+          ## SVGCheck Compatibility Report
+
+          **Workflow Run:** [${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
+          **Triggered by:** ${{ github.event_name }}
+          **Commit:** [\`${{ github.sha }}\`](${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }})
+          **Date:** $(date -u +"%Y-%m-%d %H:%M:%S UTC")
+
+          ### Test Status
+
+          Exit Code: `${{ steps.compatibility_tests.outputs.exit_code }}`
+
+          ### Compatibility Test Results
+
+          <details>
+          <summary>Click to expand full test output</summary>
+
+          ```
+          $(cat test_results.txt)
+          ```
+
+          </details>
+
+          ### Changes
+
+          This PR updates the svgcheck compatibility test fixtures based on the latest svgcheck reference implementation from [ietf-tools/svgcheck](https://github.com/ietf-tools/svgcheck).
+
+          **Updated files:**
+          - Test fixture files in `spec/fixtures/svgcheck/check/` (validation outputs)
+          - Test fixture files in `spec/fixtures/svgcheck/repair/` (repair outputs)
+
+          ### What to do
+
+          - ✅ **If tests passed and fixtures changed:** Merge this PR to update fixtures
+          - ❌ **If tests failed:** Review the test output above to identify compatibility issues
+          - 🔍 **If no changes:** This PR can be closed, no fixture updates needed
+
+          ---
+          *This PR is automatically created/updated by the SVGCheck Compatibility workflow.*
+          EOF
+
+      - name: Create or update PR
+        if: steps.check_changes.outputs.has_changes == 'true'
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "Update svgcheck compatibility fixtures"
+          title: "chore: SVGCheck compatibility report - ${{ github.run_number }}"
+          body-path: pr_body.md
+          branch: update-svgcheck-fixtures
+          delete-branch: true
+          labels: |
+            automated
+            svgcheck-compatibility

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+svgcheck-reference/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
+  - .rubocop_todo.yml
+
+plugins:
+  - rubocop-rake
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1

data/.rubocop_todo.yml

@@ -0,0 +1,183 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-10-12 09:36:25 UTC using RuboCop version 1.81.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
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
+
+# Offense count: 513
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
+
+# Offense count: 18
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/svg_conform/remediations/font_embedding_remediation.rb'
+    - 'lib/svg_conform/remediations/image_embedding_remediation.rb'
+    - 'lib/svg_conform/report_comparator.rb'
+    - 'lib/svg_conform/semantic_comparator.rb'
+    - 'lib/svg_conform/validation_context.rb'
+    - 'lib/svg_conform/validation_result.rb'
+
+# Offense count: 2
+Lint/DuplicateCaseCondition:
+  Exclude:
+    - 'lib/svg_conform/semantic_comparator.rb'
+
+# Offense count: 1
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/svg_conform/validation_context.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/svg_conform/compatibility/pattern_discovery.rb'
+    - 'lib/svg_conform/compatibility/validity_analysis.rb'
+
+# Offense count: 1
+Lint/UnreachableCode:
+  Exclude:
+    - 'lib/svg_conform/commands/check.rb'
+
+# Offense count: 126
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 21
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 253
+
+# Offense count: 3
+# Configuration parameters: CountBlocks, CountModifierForms.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 105
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# Offense count: 220
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 154
+
+# Offense count: 4
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 9
+
+# Offense count: 83
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/svg_conform/batch_report.rb'
+    - 'lib/svg_conform/compatibility/pattern_discovery.rb'
+
+# Offense count: 8
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/svg_conform/profiles/base_profile_spec.rb'
+    - 'spec/svg_conform/profiles/lucid_fix_profile_spec.rb'
+    - 'spec/svg_conform/profiles/lucid_profile_spec.rb'
+    - 'spec/svg_conform/profiles/metanorma_profile_spec.rb'
+    - 'spec/svg_conform/profiles/no_external_css_profile_spec.rb'
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_with_rdf_profile_spec.rb'
+    - 'spec/svgcheck_compatibility_spec.rb'
+
+# Offense count: 106
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 53
+
+# Offense count: 2
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/svg_conform/batch_report_spec.rb'
+
+# Offense count: 71
+RSpec/MultipleExpectations:
+  Max: 6
+
+# Offense count: 1
+Rake/MethodDefinitionInTask:
+  Exclude:
+    - 'lib/tasks/svgcheck.rake'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowComments.
+# SupportedStyles: empty, nil, both
+Style/EmptyElse:
+  Exclude:
+    - 'lib/svg_conform/remediations/namespace_remediation.rb'
+    - 'lib/svg_conform/requirements/style_requirement.rb'
+
+# Offense count: 23
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, Mode, AllowedMethods, AllowedPatterns.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+# Offense count: 1
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/svg_conform/cli.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/svg_conform/semantic_comparator.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: nonzero?
+Style/RedundantCondition:
+  Exclude:
+    - 'lib/svg_conform/external_checkers/svgcheck/parser.rb'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in svg_conform.gemspec
+gemspec
+
+gem "canon"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"