moxml 0.1.7 → 0.1.8

data/spec/moxml/xpath_capabilities_spec.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "XPath Capabilities" do
+  let(:xml_with_namespaces) do
+    <<~XML
+      <?xml version="1.0"?>
+      <library xmlns="http://library.org"
+               xmlns:book="http://library.org/book"
+               xmlns:author="http://library.org/author">
+        <book:item id="1" price="10">
+          <book:title>Ruby Programming</book:title>
+          <author:name>Jane Doe</author:name>
+        </book:item>
+        <book:item id="2" price="15">
+          <book:title>XML Processing</book:title>
+          <author:name>John Smith</author:name>
+        </book:item>
+      </library>
+    XML
+  end
+
+  let(:simple_xml) do
+    <<~XML
+      <library>
+        <book id="1" category="programming">
+          <title>Ruby Guide</title>
+          <pages>300</pages>
+        </book>
+        <book id="2" category="reference">
+          <title>XML Reference</title>
+          <pages>250</pages>
+        </book>
+        <magazine id="3">
+          <title>Tech Monthly</title>
+        </magazine>
+      </library>
+    XML
+  end
+
+  # Test each adapter
+  %i[nokogiri oga rexml ox libxml].each do |adapter_name|
+    context "with #{adapter_name} adapter" do
+      around do |example|
+        Moxml.with_config(adapter_name, true, "UTF-8") do
+          example.run
+        end
+      rescue LoadError
+        skip "#{adapter_name} not available"
+      end
+
+      describe "basic path selection" do
+        it "supports descendant paths (//element)" do
+          doc = Moxml.new.parse(simple_xml)
+          books = doc.xpath("//book")
+          expect(books.length).to eq(2)
+        end
+
+        it "supports absolute paths (/root/child)" do
+          doc = Moxml.new.parse(simple_xml)
+          books = doc.xpath("/library/book")
+          expect(books.length).to eq(2)
+        end
+
+        it "supports relative paths (.//element)" do
+          doc = Moxml.new.parse(simple_xml)
+          library = doc.root
+          books = library.xpath(".//book")
+          expect(books.length).to eq(2)
+        end
+      end
+
+      describe "attribute predicates" do
+        it "supports attribute existence check ([@attr])" do
+          doc = Moxml.new.parse(simple_xml)
+          items_with_id = doc.xpath("//book[@id]")
+          expect(items_with_id.length).to eq(2)
+        end
+
+        it "supports attribute value matching ([@attr='value'])" do
+          doc = Moxml.new.parse(simple_xml)
+          programming = doc.xpath("//book[@category='programming']")
+          expect(programming.length).to be >= 0 # May not work on all
+        rescue Moxml::XPathError
+          skip "Attribute value predicates not supported on #{adapter_name}"
+        end
+      end
+
+      describe "namespace support" do
+        it "handles namespaced elements with prefix mapping" do
+          doc = Moxml.new.parse(xml_with_namespaces)
+          namespaces = {
+            "book" => "http://library.org/book",
+            "author" => "http://library.org/author",
+          }
+
+          items = doc.xpath("//book:item", namespaces)
+          expect(items.length).to be >= 0
+        rescue Moxml::XPathError, NoMethodError
+          skip "Namespace XPath not supported on #{adapter_name}"
+        end
+
+        it "handles default namespaces" do
+          doc = Moxml.new.parse(xml_with_namespaces)
+          namespaces = { "lib" => "http://library.org" }
+
+          library = doc.xpath("//lib:library", namespaces)
+          expect(library.length).to be >= 0
+        rescue Moxml::XPathError, NoMethodError
+          skip "Default namespace XPath not supported on #{adapter_name}"
+        end
+      end
+
+      describe "position-based selection" do
+        it "supports numeric positions ([1])" do
+          doc = Moxml.new.parse(simple_xml)
+          first_book = doc.xpath("//book[1]")
+          expect(first_book.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "Position predicates not supported on #{adapter_name}"
+        end
+
+        it "supports position() function" do
+          doc = Moxml.new.parse(simple_xml)
+          first_books = doc.xpath("//book[position()=1]")
+          expect(first_books.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "position() function not supported on #{adapter_name}"
+        end
+      end
+
+      describe "XPath functions" do
+        it "supports count() function" do
+          doc = Moxml.new.parse(simple_xml)
+          # NOTE: count() returns a number, not nodes
+          result = doc.xpath("count(//book)")
+          expect(result).to be_a(Numeric) if result.is_a?(Numeric)
+        rescue Moxml::XPathError, NoMethodError
+          skip "count() function not supported on #{adapter_name}"
+        end
+
+        it "supports text() node selection" do
+          doc = Moxml.new.parse(simple_xml)
+          texts = doc.xpath("//title/text()")
+          expect(texts.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "text() not supported on #{adapter_name}"
+        end
+      end
+
+      describe "complex predicates" do
+        it "supports numeric comparisons ([@attr < value])" do
+          doc = Moxml.new.parse(simple_xml)
+          cheap_books = doc.xpath("//book[@id < 2]")
+          expect(cheap_books.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "Numeric predicates not supported on #{adapter_name}"
+        end
+
+        it "supports boolean expressions ([cond1 and cond2])" do
+          doc = Moxml.new.parse(simple_xml)
+          result = doc.xpath("//book[@id and @category]")
+          expect(result.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "Boolean expressions not supported on #{adapter_name}"
+        end
+      end
+
+      describe "axes" do
+        it "supports child axis" do
+          doc = Moxml.new.parse(simple_xml)
+          children = doc.xpath("/library/child::book")
+          expect(children.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "child:: axis not supported on #{adapter_name}"
+        end
+
+        it "supports descendant axis" do
+          doc = Moxml.new.parse(simple_xml)
+          descendants = doc.xpath("//library/descendant::title")
+          expect(descendants.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "descendant:: axis not supported on #{adapter_name}"
+        end
+      end
+
+      describe "union operator" do
+        it "supports union (|)" do
+          doc = Moxml.new.parse(simple_xml)
+          items = doc.xpath("//book | //magazine")
+          expect(items.length).to be >= 0
+        rescue Moxml::XPathError
+          skip "Union operator not supported on #{adapter_name}"
+        end
+      end
+    end
+  end
+end

data/spec/moxml/xpath_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Moxml::XPath do
+  describe "module structure" do
+    it "has Engine class" do
+      expect(defined?(Moxml::XPath::Engine)).to eq("constant")
+    end
+
+    it "has AST module" do
+      expect(defined?(Moxml::XPath::AST)).to eq("constant")
+    end
+
+    it "has AST::Node class" do
+      expect(defined?(Moxml::XPath::AST::Node)).to eq("constant")
+    end
+  end
+
+  describe "error classes" do
+    it "has Error class inheriting from XPathError" do
+      expect(Moxml::XPath::Error).to be < Moxml::XPathError
+    end
+
+    it "has SyntaxError class" do
+      expect(defined?(Moxml::XPath::SyntaxError)).to eq("constant")
+      expect(Moxml::XPath::SyntaxError).to be < Moxml::XPath::Error
+    end
+
+    it "has EvaluationError class" do
+      expect(defined?(Moxml::XPath::EvaluationError)).to eq("constant")
+      expect(Moxml::XPath::EvaluationError).to be < Moxml::XPath::Error
+    end
+
+    it "has FunctionError class" do
+      expect(defined?(Moxml::XPath::FunctionError)).to eq("constant")
+      expect(Moxml::XPath::FunctionError).to be < Moxml::XPath::Error
+    end
+
+    it "has NodeTypeError class" do
+      expect(defined?(Moxml::XPath::NodeTypeError)).to eq("constant")
+      expect(Moxml::XPath::NodeTypeError).to be < Moxml::XPath::Error
+    end
+  end
+
+  describe Moxml::XPath::Engine do
+    let(:xml) { File.read("spec/moxml/xpath/fixtures/sample.xml") }
+    let(:doc) { Moxml.new.parse(xml) }
+    let(:engine) { described_class.new(doc) }
+
+    describe "#initialize" do
+      it "accepts a document" do
+        expect(engine.document).to eq(doc)
+      end
+    end
+
+    describe "#evaluate" do
+      it "raises NotImplementedError in Phase 1.0" do
+        expect { engine.evaluate("//book") }
+          .to raise_error(NotImplementedError, /Phase 1.1/)
+      end
+    end
+
+    describe "#valid?" do
+      it "returns false for syntax errors" do
+        allow(engine).to receive(:evaluate)
+          .and_raise(Moxml::XPath::SyntaxError.new("Invalid"))
+        expect(engine.valid?("invalid[[[")).to be false
+      end
+
+      it "returns true for valid expressions" do
+        allow(engine).to receive(:evaluate).and_return([])
+        expect(engine.valid?("//book")).to be true
+      end
+    end
+  end
+end

data/spec/performance/README.md

@@ -0,0 +1,83 @@
+# Performance Tests
+
+## Purpose
+
+This directory contains performance benchmarks, memory profiling, and concurrency tests. These tests are optional and skipped by default to keep CI fast.
+
+## What Should Be Placed Here
+
+- ✅ Benchmark tests comparing adapter performance
+- ✅ Memory consumption profiling
+- ✅ Thread safety and concurrent access tests
+- ✅ Performance regression tests
+- ✅ Scalability tests with large documents
+
+## What Should NOT Be Placed Here
+
+- ❌ Functional correctness tests (use unit/ or integration/ instead)
+- ❌ Documentation examples (use examples/ instead)
+- ❌ Cross-adapter consistency tests (use consistency/ instead)
+
+## How to Run
+
+```bash
+# Run all performance tests
+bundle exec rake spec:performance
+
+# Or explicitly with environment variable
+RUN_PERFORMANCE=1 bundle exec rspec spec/performance/
+
+# Run specific benchmark
+bundle exec rspec spec/performance/xpath_benchmark_spec.rb --tag performance
+```
+
+## Directory Structure
+
+```
+performance/
+├── xpath_benchmark_spec.rb        # XPath performance across adapters
+├── benchmark_spec.rb              # General parsing/serialization benchmarks
+├── memory_usage_spec.rb           # Memory consumption tests
+└── thread_safety_spec.rb          # Concurrent access tests
+```
+
+## Writing Performance Tests
+
+Performance tests should be tagged with `:performance`:
+
+```ruby
+RSpec.describe "XPath Performance", :performance do
+  it "benchmarks xpath queries" do
+    # Benchmark code
+  end
+end
+```
+
+## Configuration
+
+Performance tests are skipped by default in `.rspec`:
+```
+--tag ~performance
+```
+
+Enable them with:
+```bash
+RUN_PERFORMANCE=1 bundle exec rspec
+```
+
+## CI Integration
+
+Performance tests typically run:
+- On-demand (manual trigger)
+- Nightly builds
+- Before releases
+- Never on pull requests (too slow)
+
+## Metrics
+
+Performance tests should track:
+- Execution time (iterations per second)
+- Memory allocation
+- Peak memory usage
+- Thread safety (no race conditions)
+- Scalability (linear vs. exponential growth)

data/spec/performance/benchmark_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "benchmark/ips"
+
+RSpec.shared_examples "Performance Examples" do
+  if ENV["SKIP_BENCHMARKS"]
+    it "skips benchmarks when SKIP_BENCHMARKS is set" do
+      skip "Benchmarks skipped. To run benchmarks, unset SKIP_BENCHMARKS"
+    end
+  else
+    let(:context) { Moxml.new }
+
+    let(:large_xml) do
+      xml = "<root>\n"
+      1000.times do |i|
+        xml += "<item id='#{i}'><name>Test #{i}</name><value>#{i}</value></item>\n"
+      end
+      xml += "</root>"
+      xml
+    end
+
+    context "measures performance" do
+      let(:doc) { context.parse(large_xml) }
+
+      let(:thresholds) do
+        {
+          nokogiri: { parser: 15, serializer: 1000 },
+          oga: { parser: 10, serializer: 100 },
+          rexml: { parser: 0, serializer: 60 },
+          ox: { parser: 2, serializer: 1000 },
+          headed_ox: { parser: 2, serializer: 1000 },
+          libxml: { parser: 10, serializer: 30 },
+        }
+      end
+
+      it "meets Parser performance threshold" do
+        result = nil
+        report = Benchmark.ips do |x|
+          x.config(time: 5, warmup: 2)
+          x.report("Parser") { result = context.parse(large_xml) }
+        end
+
+        threshold = thresholds.dig(context.config.adapter_name, :parser) || 1
+        ips = report.entries.first.ips
+        message = "Parser performance below threshold: got #{ips.round(2)} ips, expected >= #{threshold} ips"
+        expect(ips).to be >= threshold, message
+      end
+
+      it "meets Serializer performance threshold" do
+        report = Benchmark.ips do |x|
+          x.config(time: 5, warmup: 2)
+          x.report("Serializer") { _ = doc.to_xml }
+        end
+
+        threshold = thresholds.dig(context.config.adapter_name,
+                                   :serializer) || 1
+        ips = report.entries.first.ips
+        message = "Serializer performance below threshold: got #{ips.round(2)} ips, expected >= #{threshold} ips"
+        expect(ips).to be >= threshold, message
+      end
+    end
+  end
+end

data/spec/{support/shared_examples/examples/memory.rb → performance/memory_usage_spec.rb}

@@ -51,7 +51,9 @@ RSpec.shared_examples "Memory Usage Examples" do
     end
 
     it "handles streaming processing" do
-      pending "Ox has a load_file method, but nothing about a stream" if context.config.adapter_name == :ox
+      if %i[ox headed_ox].include?(context.config.adapter_name)
+        pending "Ox/HeadedOx have load_file method but not stream parsing"
+      end
       # Process file
       doc = nil
       File.open("spec/fixtures/small.xml") do |f|

data/spec/{support/shared_examples/examples/thread_safety.rb → performance/thread_safety_spec.rb}

@@ -20,7 +20,9 @@ RSpec.shared_examples "Thread Safety Examples" do
     end
 
     it "handles concurrent processing" do
-      pending "Ox doesn't have a native XPath" if Moxml.new.config.adapter_name == :ox
+      if Moxml.new.config.adapter_name == :ox
+        skip "Ox doesn't have a native XPath"
+      end
 
       processor = processor_class.new
       threads = []