ayril 0.1.0

data/lib/ayril/xml_node.rb

@@ -0,0 +1,118 @@
+# Copyright (C) 2011 by Wilson Lee <kourge[!]gmail.com>, Robert Lowe <rob[!]iblargz.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Ayril
+  class XMLNode < NSXMLNode
+
+    autoload :NodeManipulation, 'ayril/xml_node/node_manipulation'
+    autoload :NodeTraversal,    'ayril/xml_node/node_traversal'
+
+    include XMLNode::NodeManipulation
+    include XMLNode::NodeTraversal
+
+    # XXX: Why raise NotImplementedError? 
+    #   xmldocs with text nodes failed to parse and returned nil..?
+    #
+    # def initWithKind(kind) raise NotImplementedError end
+    # def initWithKind(kind, options: options) raise NotImplementedError end
+
+    def self.document
+      XMLDocument.alloc
+    end
+
+    def self.documentWithRootElement(element)
+      XMLDocument.alloc.initWithRootElement element
+    end
+
+    def self.elementWithName(name)
+      XMLElement.alloc.initWithName name
+    end
+
+    def self.elementWithName(name, stringValue: string)
+      XMLElement.alloc.initWithName name, stringValue: string
+    end
+  
+    def self.elementWithName(name, children: children, attributes: attrs)
+      self.elementWithName(name).tap do |e|
+        attrs.kind_of?(Hash) ? e.setAttributesAsDictionary(attrs)
+                             : e.setAttributes(attrs)
+        e.setChildren children
+      end
+    end
+
+    def self.elementWithName(name, URI: uri)
+      XMLElement.alloc.initWithName name, URI: uri
+    end
+
+    def self.attributeWithName(name, stringValue: string)
+      e = XMLElement.alloc.initWithName "r"
+      e.setAttributesAsDictionary name => string
+      (e.attributeForName name).tap { |a| a.detach }
+    end
+  
+    def self.attributeWithName(name, URI: uri, stringValue: string)
+      self.attributeWithName(name, stringValue: string).tap do |n|
+        n.URI = uri
+      end
+    end
+
+    def self.textWithStringValue(string)
+      d = XMLDocument.initWithXMLString "<r>#{string}</r>", options: 0, error: nil
+      d.rootElement.childAtIndex(0).tap { |n| n.detach }
+    end
+
+    def self.commentWithStringValue(string)
+      d = XMLDocument.alloc.initWithXMLString "<r><!--#{string}--></r>", options: 0, error: nil
+      d.rootElement.childAtIndex(0).tap { |n| n.detach }
+    end
+
+    # def self.namespaceWithName(name, stringValue: string) raise NotImplementedError end
+    # def self.DTDNodeWithXMLString(string) raise NotImplementedError end
+    # def self.predefinedNamespaceForPrefix(prefix) raise NotImplementedError end
+    # def self.processingInstructionWithName(name, stringValue: string) raise NotImplementedError end
+
+    def kind?(kind)
+      return self.kind == kind if kind.kind_of? Fixnum
+      kind = kind.to_sym
+      kinds = %w(invalid document element attribute namespace processing_instruction comment text DTD).invoke(:to_sym)
+      if kinds.include? kind
+        camelcase = kind.to_s.capitalize.gsub(/_([a-z])/) { |m| m[1].upcase }
+        return self.kind == Object.const_get(:"NSXML#{camelcase}Kind")
+      end
+      false
+    end
+    alias :type? :kind?
+
+    def doc?; self.kind == NSXMLDocumentKind end
+
+    def elem?; self.kind == NSXMLElementKind end
+    alias :element? :elem?
+
+    def attr?; self.kind == NSXMLAttributeKind end
+    alias :attribute? :attr?
+  
+    def namespace?; self.kind == NSXMLNamespaceKind end
+    def pi?; self.kind == NSXMLProcessingInstructionKind end
+    def comment?; self.kind == NSXMLCommentKind end
+    def text?; self.kind == NSXMLTextKind end
+    def dtd?; self.kind == NSXMLDTDKind end
+  end
+
+end

data/lib/ayril/xml_node/node_manipulation.rb

@@ -0,0 +1,73 @@
+# Copyright (C) 2011 by Wilson Lee <kourge[!]gmail.com>, Robert Lowe <rob[!]iblargz.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Ayril
+  class XMLNode
+    module NodeManipulation
+      # Removes node from parent and return the removed node itself.
+      def remove
+        self.tap { |e| e.parent.removeChildAtIndex e.index }
+      end
+
+      # Updates the content of node. If passed nothing or a blank string, the 
+      # children are cleared. If passed a string, the string is parsed into 
+      # element(s). Passing an element or an array of elements is good. All 
+      # elements are first detached if possible.
+      def update(content='')
+        if content == ''; children = nil
+        elsif content.respond_to? :to_s
+          children = XMLElement.alloc.initWithXMLString("<r>#{content}</r>", 
+            error: nil).children
+        elsif content.kind_of? XMLElement; children = [content]
+        end
+        children.each { |child| child.detach } if not children.nil?
+        self.setChildren children
+      end
+
+      # Replaces a node with another node and returns the old node.
+      def replace(content)
+        content = content.to_elem if content.respond_to? :to_elem
+        self.parent.replaceChildAtIndex self.index, withNode: content
+        self
+      end
+      alias :swap :replace
+
+      # Clean the whitespace of the node, i.e. remove all of its children text nodes
+      # that contain only whitespace.
+      def clean_whitespace
+        node = self.childAtIndex 0
+        while node
+          next_node = node.nextSibling
+          node.remove if node.kind == NSXMLTextKind and node.stringValue =~ /\S/
+          node = next_node
+        end
+        self
+      end
+
+      forward :xpath, :XPath
+
+      forward :text, :stringValue
+      forward :text=, :stringValue=
+
+      forward :to_html, :XMLString
+      def inner_html; self.children.invoke(:XMLString).join end
+    end
+  end
+end

data/lib/ayril/xml_node/node_traversal.rb

@@ -0,0 +1,158 @@
+# Copyright (C) 2011 by Wilson Lee <kourge[!]gmail.com>, Robert Lowe <rob[!]iblargz.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Ayril
+  class XMLNode
+    module NodeTraversal
+      # Recursively collects the results of a method until nil is returned.
+      def recursively_collect(property)
+        elements = []; element = self
+        while element = element.send(property)
+          elements << element if element.kind == NSXMLElementKind
+        end
+        elements
+      end
+
+      # Returns all ancestors of a node.
+      def ancestors
+        self.recursively_collect :parent
+      end
+
+      # Returns all descendants of a node, direct or indirect.
+      def descendants
+        self.select "*"
+      end
+
+      # Returns the first descendant element of a node.
+      def first_descendant
+        element = self.childAtIndex 0
+        while element and element.kind != NSXMLElementKind
+          element = element.nextSibling
+        end
+        element
+      end
+
+      # Returns the direct children of a node.
+      def immediate_descendants
+        return [] unless (element = self.childAtIndex 0)
+        while element and element.kind != NSXMLElementKind
+          element = element.nextSibling
+        end
+        return [element] + element.next_siblings unless element.nil?
+        []
+      end
+      alias :child_elements :immediate_descendants
+
+      def previous_siblings
+        self.recursively_collect :previousSibling
+      end
+
+      def previous_element_sibling
+        element = self.previousSibling
+        while element and element.kind != NSXMLElementKind
+          element = element.previousSibling
+        end
+        element
+      end
+
+      def next_siblings
+        self.recursively_collect :nextSibling
+      end
+
+      def next_element_sibling
+        element = self.nextSibling
+        while element and element.kind != NSXMLElementKind
+          element = element.nextSibling
+        end
+        element
+      end
+
+      def siblings
+        self.previous_siblings.reverse + self.next_siblings
+      end
+
+      def up(*args)
+        expr, index = args[0..1]
+        return self.parent if args.length == 0
+        if expr.kind_of? Integer then self.ancestors[expr]
+        else Selector.find_element(self.ancestors, expr, index) end
+      end
+
+      def down(*args)
+        expr, index = args[0..1]
+        return self.first_descendant if args.length == 0
+        if expr.kind_of? Integer then self.descendants[expr]
+        else self.select(expr)[index || 0] end
+      end
+      alias :find :down
+      alias :search :down
+
+      def previous(*args)
+        expr, index = args[0..1]
+        return self.previous_element_sibling if args.length == 0
+        expr.kind_of?(Integer) ? self.previous_siblings[expr] : 
+          Selector::find_element(self.previous_siblings, expr, index)
+      end
+
+      def next(*args)
+        expr, index = args[0..1]
+        return self.next_element_sibling if args.length == 0
+        expr.kind_of?(Integer) ? self.next_siblings[expr] :
+          Selector::find_element(self.next_siblings, expr, index)
+      end
+
+      def select(css)
+        self.select_by_xpath(Selector.new(css.to_s).xpath).to_a
+      end
+      alias :elements_by_selector :select
+      alias :[] :select # REXML inspired
+
+      def at(css)
+        self.select(css)[0]
+      end
+      alias :% :at
+
+      def select_by_xpath(xpath)
+        self.nodesForXPath(xpath.to_s, error: nil).to_a
+      end
+      alias :/ :select_by_xpath # Hpricot inspired
+
+      def adjacent(*args)
+        Selector.find_child_elements(self.parent, args) - [self]
+      end
+
+      def empty?
+        self.descendants.invoke(:XMLString).join('') == ''
+      end
+
+      def descendant_of?(ancestor)
+        element = self
+        while element = element.parent
+          return true if element == ancestor
+        end
+        false
+      end
+
+      def contains?(child)
+        child.descendant_of? self
+      end
+    end
+  end
+end

data/test/invoke_ayril_selector.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/../lib/ayril'
+
+puts Ayril::Selector.new($*[0]).xpath

data/test/invoke_prototype_selector.js

@@ -0,0 +1,4 @@
+
+load("test/selector.js");
+var s = new Selector(arguments[0]);
+print(s.xpath);

data/test/sanity.xml

@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="utf-8"?>  
+<response xmlns="http://www.example.com/api/" status="ok">  
+  <invoices page="1" per_page="10" pages="4" total="47">  
+    <invoice>  
+      <invoice_id>344</invoice_id>  
+      <client_id>3</client_id>  
+      <number>FB00004</number>  
+      <amount>45.6</amount>  
+      <currency_code>CAD</currency_code>  
+      <language>en</language>  
+      <amount_outstanding>0</amount_outstanding>  
+      <status>paid</status>  
+      <date>2007-06-23</date>  
+      <folder>active</folder>  
+      <po_number></po_number>  
+      <discount>0</discount>  
+      <notes>Due upon receipt.</notes>  
+      <terms>Payment due in 30 days.</terms>  
+      <url deprecated="true">https://2ndsite.example.com/view/St2gThi6rA2t7RQ</url>  
+      <auth_url deprecated="true">https://2ndsite.example.com/invoices/344</auth_url>  
+      <links>  
+        <client_view>https://2ndsite.example.com/view/St2gThi6rA2t7RQ</client_view>  
+        <view>https://2ndsite.example.com/invoices/344</view>  
+        <edit>https://2ndsite.example.com/invoices/344/edit</edit>  
+      </links>  
+      <return_uri>http://www.example.com/callback</return_uri>  
+      <updated>2009-08-12 09:00:00</updated>  
+      <recurring_id>15</recurring_id>  
+      <organization>ABC Corp</organization>  
+      <first_name>John</first_name>  
+      <last_name>Doe</last_name>  
+      <p_street1>123 Fake St.</p_street1>  
+      <p_street2>Unit 555</p_street2>  
+      <p_city>New York</p_city>  
+      <p_state>New York</p_state>  
+      <p_country>United States</p_country>  
+      <p_code>553132</p_code>  
+      <vat_name></vat_name>  
+      <vat_number></vat_number>  
+      <staff_id>1</staff_id>  
+      <lines>  
+        <line>  
+          <line_id>1</line_id>  <!-- (Read Only) line id -->  
+          <amount>40</amount>  
+          <name>Yard work</name>  
+          <description>Mowed the lawn</description>  
+          <unit_cost>10</unit_cost>  
+          <quantity>4</quantity>  
+          <tax1_name>GST</tax1_name>  
+          <tax2_name>PST</tax2_name>  
+          <tax1_percent>5</tax1_percent>  
+          <tax2_percent>8</tax2_percent>  
+          <type>Item</type>  
+        </line>  
+      </lines>  
+    </invoice>  
+    <invoice>  
+      <invoice_id>345</invoice_id>  
+      <client_id>3</client_id>  
+      <number>FB000404</number>  
+      <amount>44.6</amount>  
+      <currency_code>USD</currency_code>  
+      <language>en</language>  
+      <amount_outstanding>0</amount_outstanding>  
+      <status>paid</status>  
+      <date>2007-06-23</date>  
+      <folder>active</folder>  
+      <po_number></po_number>  
+      <discount>0</discount>  
+      <notes>Due upon receipt.</notes>  
+      <terms>Payment due in 30 days.</terms>  
+      <url deprecated="true">https://2ndsite.example.com/view/St2gThi6rA2t7RQ</url>  
+      <auth_url deprecated="true">https://2ndsite.example.com/invoices/344</auth_url>  
+      <links>  
+        <client_view>https://2ndsite.example.com/view/St2gThi6rA2t7RQ</client_view>  
+        <view>https://2ndsite.example.com/invoices/344</view>  
+        <edit>https://2ndsite.example.com/invoices/344/edit</edit>  
+      </links>  
+      <return_uri>http://www.example.com/callback</return_uri>  
+      <updated>2009-08-12 09:00:00</updated>  
+      <recurring_id>15</recurring_id>  
+      <organization>ABC Corp</organization>  
+      <first_name>John</first_name>  
+      <last_name>Doe</last_name>  
+      <p_street1>123 Fake St.</p_street1>  
+      <p_street2>Unit 555</p_street2>  
+      <p_city>New York</p_city>  
+      <p_state>New York</p_state>  
+      <p_country>United States</p_country>  
+      <p_code>553132</p_code>  
+      <vat_name></vat_name>  
+      <vat_number></vat_number>  
+      <staff_id>1</staff_id>  
+      <lines>  
+        <line>  
+          <line_id class="can_i_has_selector">4</line_id>  <!-- (Read Only) line id -->  
+          <amount>40</amount>  
+          <name>Yard work</name>  
+          <description>Mowed the lawn</description>  
+          <unit_cost>10</unit_cost>  
+          <quantity>4</quantity>  
+          <tax1_name>GST</tax1_name>  
+          <tax2_name>PST</tax2_name>  
+          <tax1_percent>5</tax1_percent>  
+          <tax2_percent>8</tax2_percent>  
+          <type>Item</type>  
+        </line>  
+        <line>  
+          <line_id>1</line_id>  <!-- (Read Only) line id -->  
+          <amount>40</amount>  
+          <name>Yard work</name>  
+          <description>Mowed the lawn</description>  
+          <unit_cost>10</unit_cost>  
+          <quantity>4</quantity>  
+          <tax1_name>GST</tax1_name>  
+          <tax2_name>PST</tax2_name>  
+          <tax1_percent>5</tax1_percent>  
+          <tax2_percent id="can_i_has_id">8</tax2_percent>  
+          <type>Item</type>  
+        </line>  
+      </lines>  
+    </invoice>  
+  </invoices>  
+</response>