svg_conform 0.1.4 → 0.1.5

data/spec/svg_conform/requirements/id_reference_state_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "IdReferenceRequirement" do
+  let(:validator) { SvgConform::Validator.new(mode: :sax) }
+
+  # SVG with a reference to undefined ID 'missing_id'
+  let(:svg_with_error) do
+    <<~SVG
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+        <a href="#missing_id">
+          <rect x="10" y="10" width="80" height="80"/>
+        </a>
+      </svg>
+    SVG
+  end
+
+  # SVG with valid references only
+  let(:svg_without_error) do
+    <<~SVG
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+        <rect id="valid_id" x="10" y="10" width="80" height="80"/>
+        <a href="#valid_id">
+          <text x="50" y="50">Link</text>
+        </a>
+      </svg>
+    SVG
+  end
+
+  it "does not leak state from first validation to second validation" do
+    # First validation: SVG with reference error
+    result1 = validator.validate(svg_with_error, profile: :metanorma)
+
+    # Verify first validation caught the error
+    expect(result1.errors.map(&:message)).to include(
+      match(/Reference to undefined ID 'missing_id'/),
+    )
+
+    # Second validation: SVG without reference errors
+    result2 = validator.validate(svg_without_error, profile: :metanorma)
+
+    # Verify second validation does NOT report errors from first validation
+    error_messages = result2.errors.map(&:message).join("\n")
+    expect(error_messages).not_to include("missing_id"),
+                                  "State leaked from first validation! Second validation should not mention 'missing_id'"
+
+    # Second validation should have no errors (or at least no reference errors)
+    reference_errors = result2.errors.select do |e|
+      e.message.include?("Reference to undefined")
+    end
+    expect(reference_errors).to be_empty,
+                                "Second validation should have no reference errors, but got: #{reference_errors.map(&:message)}"
+  end
+
+  it "handles multiple sequential validations correctly" do
+    # Run multiple validations to ensure state resets each time
+    results = []
+
+    # Alternate between error and no-error SVGs
+    3.times do
+      results << validator.validate(svg_with_error, profile: :metanorma)
+      results << validator.validate(svg_without_error, profile: :metanorma)
+    end
+
+    # Check that error pattern is consistent
+    results.each_with_index do |result, i|
+      if i.even?
+        # Should have error (svg_with_error)
+        expect(result.errors.map(&:message)).to include(
+          match(/Reference to undefined ID 'missing_id'/),
+        )
+      else
+        # Should NOT have error about missing_id (svg_without_error)
+        error_messages = result.errors.map(&:message).join("\n")
+        expect(error_messages).not_to include("missing_id")
+      end
+    end
+  end
+
+  it "resets state when using the same profile instance" do
+    # Get profile instance
+    profile = SvgConform::Profiles.get(:metanorma)
+
+    # Run two validations using the same profile
+    validator.validate(svg_with_error, profile: profile)
+    result2 = validator.validate(svg_without_error, profile: profile)
+
+    # Second validation should not have first validation's errors
+    error_messages = result2.errors.map(&:message).join("\n")
+    expect(error_messages).not_to include("missing_id")
+  end
+end

data/spec/svg_conform/validator_input_types_spec.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe SvgConform::Validator do
+  let(:validator) { described_class.new(mode: :sax) }
+  let(:simple_svg) do
+    <<~SVG
+      <?xml version="1.0" encoding="UTF-8"?>
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+        <rect id="box" x="10" y="10" width="80" height="80" fill="black"/>
+      </svg>
+    SVG
+  end
+
+  describe "#validate with different input types" do
+    context "with String input (backward compatibility)" do
+      it "validates XML string successfully" do
+        result = validator.validate(simple_svg, profile: :metanorma)
+
+        expect(result).to be_a(SvgConform::ValidationResult)
+        expect(result.valid?).to be true
+      end
+
+      it "processes errors correctly" do
+        invalid_svg = '<svg><rect fill="red"/></svg>'
+        result = validator.validate(invalid_svg, profile: :svg_1_2_rfc)
+
+        expect(result).to be_a(SvgConform::ValidationResult)
+        # Will have errors due to missing viewBox and invalid color
+      end
+    end
+
+    context "with Moxml::Document input" do
+      it "validates Moxml document without re-parsing" do
+        # Parse once into Moxml
+        moxml_doc = Moxml.new.parse(simple_svg)
+
+        # Validate using the document object
+        result = validator.validate(moxml_doc, profile: :metanorma)
+
+        expect(result).to be_a(SvgConform::ValidationResult)
+        expect(result.valid?).to be true
+      end
+
+      it "serializes document once for SAX validation (safe for large files)" do
+        moxml_doc = Moxml.new.parse(simple_svg)
+
+        # Should call to_xml once for SAX validation
+        # (SAX mode is safe for large files, unlike DOM)
+        expect(moxml_doc).to receive(:to_xml).once.and_call_original
+
+        validator.validate(moxml_doc, profile: :metanorma)
+      end
+    end
+
+    context "with Moxml::Element input" do
+      it "validates Moxml element node" do
+        moxml_doc = Moxml.new.parse(simple_svg)
+        svg_element = moxml_doc.root
+
+        result = validator.validate(svg_element, profile: :metanorma)
+
+        expect(result).to be_a(SvgConform::ValidationResult)
+        expect(result.valid?).to be true
+      end
+    end
+
+    context "with Nokogiri input (metanorm use case)" do
+      it "validates Nokogiri::XML::Document" do
+        nokogiri_doc = Nokogiri::XML(simple_svg)
+
+        result = validator.validate(nokogiri_doc, profile: :metanorma)
+
+        expect(result).to be_a(SvgConform::ValidationResult)
+        expect(result.valid?).to be true
+      end
+
+      it "validates Nokogiri::XML::Element" do
+        nokogiri_doc = Nokogiri::XML(simple_svg)
+        svg_element = nokogiri_doc.root
+
+        # This is the metanorma use case - passing element directly
+        result = validator.validate(svg_element, profile: :metanorma)
+
+        expect(result).to be_a(SvgConform::ValidationResult)
+        expect(result.valid?).to be true
+      end
+
+      it "serializes Nokogiri element once for SAX validation" do
+        nokogiri_doc = Nokogiri::XML(simple_svg)
+        svg_element = nokogiri_doc.root
+
+        # Should call to_xml once for SAX validation
+        # (SAX mode is memory-safe for large SVGs)
+        expect(svg_element).to receive(:to_xml).once.and_call_original
+
+        validator.validate(svg_element, profile: :metanorma)
+      end
+    end
+
+    context "with invalid input" do
+      it "raises ArgumentError for unsupported input type" do
+        expect do
+          validator.validate(12345, profile: :metanorma)
+        end.to raise_error(ArgumentError, /Invalid input type/)
+      end
+
+      it "raises ArgumentError for nil input" do
+        expect do
+          validator.validate(nil, profile: :metanorma)
+        end.to raise_error(ArgumentError, /Invalid input type/)
+      end
+    end
+
+    context "with reference manifest" do
+      let(:svg_with_refs) do
+        <<~SVG
+          <?xml version="1.0" encoding="UTF-8"?>
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+            <defs>
+              <rect id="box" width="10" height="10"/>
+            </defs>
+            <use href="#box" x="20" y="20"/>
+          </svg>
+        SVG
+      end
+
+      it "builds reference manifest from Nokogiri element" do
+        nokogiri_doc = Nokogiri::XML(svg_with_refs)
+        svg_element = nokogiri_doc.root
+
+        result = validator.validate(svg_element, profile: :metanorma)
+
+        expect(result.reference_manifest).not_to be_nil
+        expect(result.available_ids.map(&:id_value)).to include("box")
+        expect(result.internal_references.size).to be > 0
+      end
+
+      it "builds reference manifest from Moxml document" do
+        moxml_doc = Moxml.new.parse(svg_with_refs)
+
+        result = validator.validate(moxml_doc, profile: :metanorma)
+
+        expect(result.reference_manifest).not_to be_nil
+        expect(result.available_ids.map(&:id_value)).to include("box")
+      end
+    end
+  end
+
+  describe "integration with remediation" do
+    let(:invalid_svg) do
+      <<~SVG
+        <?xml version="1.0" encoding="UTF-8"?>
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+          <rect fill="red" width="10" height="10"/>
+        </svg>
+      SVG
+    end
+
+    it "applies remediation when using document object input" do
+      nokogiri_doc = Nokogiri::XML(invalid_svg)
+      svg_element = nokogiri_doc.root
+
+      result = validator.validate(svg_element, profile: :svg_1_2_rfc, fix: true)
+
+      # Should have validation errors initially
+      expect(result.has_errors?).to be true
+      # Remediation should have been attempted
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svg_conform
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-19 00:00:00.000000000 Z
+date: 2025-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -92,11 +92,15 @@ files:
 - config/profiles/svg_1_2_rfc.yml
 - config/profiles/svg_1_2_rfc_with_rdf.yml
 - config/svgcheck_mapping.yml
+- docs/api_reference.adoc
+- docs/cli_guide.adoc
 - docs/profiles.adoc
 - docs/rdf_metadata_support.adoc
+- docs/reference_manifest.adoc
 - docs/remediation.adoc
 - docs/requirements.adoc
 - examples/demo.rb
+- examples/document_input_demo.rb
 - examples/readme_usage.rb
 - examples/requirements_demo.rb
 - exe/svg_conform
@@ -137,6 +141,11 @@ files:
 - lib/svg_conform/node_index_builder.rb
 - lib/svg_conform/profile.rb
 - lib/svg_conform/profiles.rb
+- lib/svg_conform/references.rb
+- lib/svg_conform/references/base_reference.rb
+- lib/svg_conform/references/id_definition.rb
+- lib/svg_conform/references/reference_classifier.rb
+- lib/svg_conform/references/reference_manifest.rb
 - lib/svg_conform/remediation_engine.rb
 - lib/svg_conform/remediation_result.rb
 - lib/svg_conform/remediation_runner.rb
@@ -160,6 +169,7 @@ files:
 - lib/svg_conform/requirements/element_requirement_config.rb
 - lib/svg_conform/requirements/font_family_requirement.rb
 - lib/svg_conform/requirements/forbidden_content_requirement.rb
+- lib/svg_conform/requirements/id_collection_requirement.rb
 - lib/svg_conform/requirements/id_reference_requirement.rb
 - lib/svg_conform/requirements/invalid_id_references_requirement.rb
 - lib/svg_conform/requirements/link_validation_requirement.rb
@@ -386,6 +396,9 @@ files:
 - 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/svg_conform/references/integration_spec.rb
+- spec/svg_conform/references/reference_classifier_spec.rb
+- spec/svg_conform/references/reference_manifest_spec.rb
 - spec/svg_conform/remediations/color_remediation_spec.rb
 - spec/svg_conform/remediations/font_embedding_remediation_spec.rb
 - spec/svg_conform/remediations/font_remediation_spec.rb
@@ -401,6 +414,7 @@ files:
 - spec/svg_conform/requirements/font_family_requirement_spec.rb
 - spec/svg_conform/requirements/forbidden_content_requirement_spec.rb
 - spec/svg_conform/requirements/id_reference_requirement_spec.rb
+- spec/svg_conform/requirements/id_reference_state_spec.rb
 - spec/svg_conform/requirements/invalid_id_references_requirement_spec.rb
 - spec/svg_conform/requirements/link_validation_requirement_spec.rb
 - spec/svg_conform/requirements/namespace_attributes_requirement_spec.rb
@@ -411,6 +425,7 @@ files:
 - spec/svg_conform/requirements/style_promotion_requirement_spec.rb
 - spec/svg_conform/requirements/style_requirement_spec.rb
 - spec/svg_conform/requirements/viewbox_required_requirement_spec.rb
+- spec/svg_conform/validator_input_types_spec.rb
 - spec/svg_conform_spec.rb
 - spec/svgcheck_compatibility_spec.rb
 - svg_conform.gemspec