From d11a75494682432260fd92bd927bb9c2d3cac3f1 Mon Sep 17 00:00:00 2001
From: Yorick Peterse <yorickpeterse@gmail.com>
Date: Mon, 6 Jul 2015 00:51:20 +0200
Subject: [PATCH] Basic support for compiling XPath to Ruby

This currently comes with exactly 0% test coverage. Once I've
implemented all required handler methods I'll be updating the current
evaluator tests to use the compiler instead. This removes the need for
writing an entirely new set of tests.

Currently the compiler is only capable of compiling basic expressions
such as "foo", "foo/bar" and "foo[@x="y"]/bar".
---
 lib/oga/xpath/compiler.rb | 177 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 177 insertions(+)

diff --git a/lib/oga/xpath/compiler.rb b/lib/oga/xpath/compiler.rb
index e5565a1..f30f181 100644
--- a/lib/oga/xpath/compiler.rb
+++ b/lib/oga/xpath/compiler.rb
@@ -9,6 +9,9 @@ module Oga
     # recompiling the same expression over and over again.
     #
     class Compiler
+      # Wildcard for node names/namespace prefixes.
+      STAR = '*'
+
       ##
       # Compiles an XPath AST into a Ruby Proc.
       #
@@ -16,7 +19,181 @@ module Oga
       # @return [Proc]
       #
       def compile(ast)
+        document = literal('node')
+        matched  = literal('matched')
 
+        if ast.type == :path
+          ruby_ast = process(ast, document)
+        else
+          ruby_ast = process(ast, document) do |node|
+            matched.push(node)
+          end
+        end
+
+        literal('lambda').add_block(document) do
+          matched.assign(literal(XML::NodeSet).new)
+            .followed_by(ruby_ast)
+            .followed_by(matched)
+        end
+      end
+
+      ##
+      # Processes a single XPath AST node.
+      #
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def process(ast, input, &block)
+        send("on_#{ast.type}", ast, input, &block)
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_path(ast, input, &block)
+        matched  = literal('matched')
+        ruby_ast = nil
+
+        ast.children.reverse_each.with_index do |child, index|
+          # The last segment of the path should add the code that actually
+          # pushes the matched node into the node set.
+          if index == 0
+            ruby_ast = process(child, input) do |node|
+              matched.push(node)
+            end
+          else
+            ruby_ast = process(child, input) { ruby_ast }
+          end
+        end
+
+        ruby_ast
+      end
+
+      ##
+      # Dispatches the processing of axes to dedicated methods. This works
+      # similar to {#process} except the handler names are "on_axis_X" with "X"
+      # being the axis name.
+      #
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_axis(ast, input, &block)
+        name, test = *ast.children
+
+        handler = name.gsub('-', '_')
+
+        send(:"on_axis_#{handler}", test, input, &block)
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_axis_child(ast, input, &block)
+        child     = literal('node')
+        condition = process(ast, child, &block)
+
+        input.children.each.add_block(child) do
+          condition.if_true { yield child }
+        end
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_axis_attribute(ast, input)
+        ns, name = *ast
+
+        query = ns ? "#{ns}:#{name}" : name
+
+        input.get(string(query))
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_predicate(ast, input, &block)
+        test, predicate = *ast
+
+        process(test, input) do |node|
+          process(predicate, node).if_true(&block)
+        end
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_test(ast, input)
+        ns, name = *ast
+
+        condition = element_or_attribute(input)
+
+        if name != STAR
+          condition = condition.and(input.name.eq(string(name)))
+        end
+
+        if ns and ns != STAR
+          condition = condition.and(input.namespace_name.eq(string(ns)))
+        end
+
+        condition
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_eq(ast, input)
+        left, right = *ast
+
+        process(left, input).eq(process(right, input))
+      end
+
+      ##
+      # @param [AST::Node] ast
+      # @param [Oga::Ruby::Node] input
+      # @return [Oga::Ruby::Node]
+      #
+      def on_string(ast, input)
+        string(ast.children[0])
+      end
+
+      private
+
+      ##
+      # @param [#to_s] value
+      # @return [Oga::Ruby::Node]
+      #
+      def literal(value)
+        Ruby::Node.new(:lit, [value.to_s])
+      end
+
+      ##
+      # @param [#to_s] value
+      # @return [Oga::Ruby::Node]
+      #
+      def string(value)
+        Ruby::Node.new(:string, [value.to_s])
+      end
+
+      ##
+      # @param [Oga::Ruby::Node] node
+      # @return [Oga::Ruby::Node]
+      #
+      def element_or_attribute(node)
+        node.is_a?(XML::Attribute).or(node.is_a?(XML::Element))
       end
     end # Compiler
   end # XPath