cocoa-xml 0.4.4

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 0.4.3 / 2010-01-26
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/cocoa-xml.rb
+lib/cocoa-xml/nodeset.rb
+lib/cocoa-xml/version.rb
+lib/cocoa-xml/nsxmlnode_extras.rb
+lib/cocoa-xml/nsxmldocument_extras.rb
+lib/nokogiri/css.rb
+lib/nokogiri/syntax_error.rb
+lib/nokogiri/css/generated_parser.rb
+lib/nokogiri/css/generated_tokenizer.rb
+lib/nokogiri/css/node.rb
+lib/nokogiri/css/parser.rb
+lib/nokogiri/css/parser.y
+lib/nokogiri/css/syntax_error.rb
+lib/nokogiri/css/tokenizer.rb
+lib/nokogiri/css/tokenizer.rex
+lib/nokogiri/css/xpath_visitor.rb

data/README.rdoc

@@ -0,0 +1,105 @@
+= Cocoa-XML
+
+* http://github.com/cehoffman/cocoa-xml
+* http://cehoffman.github.com/cocoa-xml
+
+== DESCRIPTION:
+
+Cocoa-xml provides a more ruby like interface to Cocoa's NSXMLDocument
+and classes that inherit from NSXMLNode.  It provides access to XPath,
+XQuery, and CSS selectors for searching documents.
+
+== FEATURES/PROBLEMS:
+
+* Cocoa-xml uses native Cocoa xml processing facilities.
+* CSS, XPath, and XQuery can be used to search a document
+* Broken HTML documents can be processed thanks to NSXMLDocument
+
+== SYNOPSIS:
+
+  require 'cocoa-xml'
+  
+  doc = CocoaXML::HTML("http://www.google.com/search?q=cehoffman")
+  
+  doc.css('h3.r a.l').each do |link|
+    puts link.text
+  end
+  
+  doc.xpath('//h3/a[@class="l"]').each do |link|
+    puts link.text
+  end
+  
+  doc.xquery('data(//h3/a[@class="l"]')).each do |link|
+    puts link
+  end
+  
+== REQUIREMENTS:
+
+* MacRuby 0.6 (development version)
+* OS X Snow Leopard (only version supported by MacRuby currently)
+
+== INSTALL:
+
+  $ sudo gem install cocoa-xml
+
+== DEVELOPERS:
+
+It is advised to use the current development version of {MacRuby}[http://www.macruby.com] from
+the source tree.
+
+== CREDITS:
+
+CSS selector support is taken from Nokogiri.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Chris Hoffman
+
+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.
+
+=== Nokogiri License
+
+(The MIT License)
+
+Copyright (c) 2008 - 2009:
+
+* {Aaron Patterson}[http://tenderlovemaking.com]
+* {Mike Dalessio}[http://mike.daless.io]
+
+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.

data/Rakefile

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require "./lib/cocoa-xml/version.rb"
+
+Hoe.plugin :gemcutter
+Hoe.plugin :clean
+Hoe.plugin :git
+Hoe.plugin :yard
+
+Hoe.spec 'cocoa-xml' do
+  self.version = ::CocoaXML::Version
+  developer('Chris Hoffman', 'cehoffman@gmail.com')
+
+  self.rubyforge_name = 'cocoa-xml'
+
+  self.yard_title = "Cocoa-XML"
+  self.yard_markup = 'rdoc'
+  self.yard_opts = ['--no-private']
+end
+
+# vim: syntax=ruby

data/lib/cocoa-xml.rb

@@ -0,0 +1,48 @@
+framework 'Cocoa'
+
+require "cocoa-xml/version"
+require "cocoa-xml/nodeset"
+require "cocoa-xml/nsxmldocument_extras"
+require "cocoa-xml/nsxmlnode_extras"
+require "nokogiri/css"
+
+module CocoaXML
+  # Parse an input HTML source
+  #
+  # @param [url, NSURL, #read, #to_str] source a url as a string or NSURL,
+  #   object that responds to #read, or #to_str
+  # @return [NSXMLDocument] An NSXMLDocument set to interpret source as HTML
+  def self.HTML(source)
+    parse source, NSXMLDocumentTidyHTML
+  end
+
+  # Parse an input XML source
+  #
+  # @param [url, NSURL, #read, #to_str] source a url as a string or NSURL,
+  #   object that responds to #read, or #to_str
+  # @return [NSXMLDocument] An NSXMLDocument set to inperpret source as XML
+  def self.XML(source)
+    parse source, NSXMLDocumentTidyXML
+  end
+
+  private
+    # Parse an HTML or XML source
+    #
+    # @param [url, NSURL, #read, #to_str] source a url as a string or NSURL,
+    #   object that responds to #read, or #to_str
+    # @param [Number] Constant determing how to interpret input source, xml or
+    #   html
+    # @return [NSXMLDocument]
+    def self.parse(source, type)
+      error = Pointer.new :object
+
+      url = (source.is_a?(NSURL) && source) || NSURL.URLWithString(source.to_str) if source.respond_to?(:to_str)
+      source = source.read if source.respond_to?(:read)
+
+      unless url.nil?
+        ::NSXMLDocument.alloc.initWithContentsOfURL url, options: type, error: error
+      else
+        ::NSXMLDocument.alloc.initWithXMLString source, options: type, error: error
+      end
+    end
+end

data/lib/cocoa-xml/nodeset.rb

@@ -0,0 +1,57 @@
+module CocoaXML
+  class NodeSet < Array
+    # Collect all the texts of nodes in set and join together
+    #
+    # @return [String] single string containing text of each element
+    def text
+      collect { |node| (node.respond_to?(:to_str) && node.to_str) || node.text }.flatten.join
+    end
+    alias :inner_text :text
+
+    # Collect all the #to_s representations of elements in array
+    #
+    # @return [String] single string containing #to_s of each element
+    def to_s
+      collect { |node| node.to_s }.join
+    end
+
+    # Perform selector on each element in set
+    #
+    # @param [String] selector css selector to use on each node
+    # @return [NodeSet<NSXMLNode, String>] new set resulting from
+    #    performing selector on each node in set
+    # @todo This will bomb if the node has String elements in it
+    def css(selector)
+      xpath ::Nokogiri::CSS::xpath_for(selector, :prefix => ".//").join
+    end
+
+    # Perform XQuery on each node in set
+    #
+    # @param [String] query xquery to perform on each node in set
+    # @return [NodeSet<NSXMLNode, String>] results of performing
+    #    query
+    # @todo This will bomb if the node has String elements in it
+    def xquery(query)
+      query.sub! %r{^//}, ''    # Root searches to start from nodes
+      NodeSet.new(collect { |node| node.xquery(query) }.flatten)
+    end
+
+    # Perform XPath selection on each node in set
+    #
+    # @param [String] path xpath to follow on each node
+    # @return [NodeSet<NSXMLNode>] results of path on each node
+    # @todo This will bomb if the node has String elements in it
+    def xpath(query)
+      query.sub! %r{^//}, ''    # Roots searches to start from nodes
+      NodeSet.new(collect { |node| node.xpath(query) }.flatten)
+    end
+
+    # Get the value of the attribute for each node in set
+    #
+    # @param [String] attr attribute to search for on each node
+    # @return [Array<String, nil>] value of attribute for each node
+    def [](attr)
+      collect { |node| node[attr] }.flatten
+    end
+  end
+end

data/lib/cocoa-xml/nsxmldocument_extras.rb

@@ -0,0 +1,48 @@
+module CocoaXML
+  module NSXMLDocumentExtras
+    # @private
+    def self.included(klass)
+      klass.class_eval do
+        alias :encoding :characterEncoding
+        alias :encoding= :setCharacterEncoding
+      end
+    end
+
+    # Encoding of document
+    #
+    # @see http://www.iana.org/assignments/character-sets Valid Encoding Specifiers
+    #
+    # @return [NSString] encoding of document
+    def encoding
+      # Implemented as alias to characterEncoding
+    end
+
+    # Set encoding of document
+    #
+    # @see file:///Developer/Documentation/DocSets/com.apple.adc.documentation.AppleSnowLeopard.CoreReference.docset/Contents/Resources/Documents/documentation/Cocoa/Reference/Foundation/Classes/NSXMLDocument_Class/Reference/Reference.html#//apple_ref/occ/instm/NSXMLDocument/setCharacterEncoding: Developer Documentation
+    # @see http://developer.apple.com/mac/library/documentation/Cocoa/Reference/Foundation/Classes/NSXMLDocument_Class/NSXMLDocument_Class.pdf Apple NSXMLDocument PDF
+    #
+    # @param [NSString] enc valid character encoding
+    # @return [void]
+    def encoding=(enc)
+      # Implemented as an alias to setCharacterEncoding
+    end
+
+    # Determine if output of document is treated as HTML, e.g. <br> style tags
+    def html?
+      documentContentKind == NSXMLDocumentHTMLKind
+    end
+
+    # Determine if output of document is treated as XHTML, e.g. <br/> style tags
+    def xhtml?
+      documentContentKind == NSXMLDocumentXHTMLKind
+    end
+
+    # Determine if output of document is treated as XML
+    def xml?
+      documentContentKind == NSXMLDocumentXMLKind
+    end
+  end
+end
+
+::NSXMLDocument.send :include, CocoaXML::NSXMLDocumentExtras

data/lib/cocoa-xml/nsxmlnode_extras.rb

@@ -0,0 +1,106 @@
+module CocoaXML
+  # These are a set of methods added onto the Cocoa NSXMLNode class and children.
+  module NSXMLNodeExtras
+    # Search from this node down using a css selector
+    #
+    # @param [String] selector selector used to select nodes from document
+    # @return [NodeSet<NSXMLNode>] array of nodes matched by selector
+    def css(selector)
+      xpath ::Nokogiri::CSS::xpath_for(selector, :prefix => ".//").join
+    end
+
+    # Search document using provided path
+    #
+    # @param [String] path path used to select nodes from document
+    # @return [NodeSet<NSXMLNode>] array of nodes matched by selector
+    def xpath(path)
+      error = Pointer.new(:object)
+      results = nodesForXPath path, error: error
+
+      return NodeSet.new(results) if error[0].nil?
+    end
+
+    # Process document using provided query
+    #
+    # @param [String] query query used process information in document
+    # @return [NodeSet<NSXMLNode, String>] results depends on
+    #    query.  Notice that unlike {#xpath} basic types can also be returned.
+    def xquery(query)
+      error = Pointer.new(:object)
+      results = objectsForXQuery query, error: error
+
+      return NodeSet.new(results) if error[0].nil?
+
+      #TODO Do something with the error
+    end
+
+    # Get the contained text from this node and children nodes
+    #
+    # @return [String] text contents of node
+    def text
+      xquery('data(.)').join
+    end
+    alias :inner_text :text
+
+    # Get the value of an attribute of node
+    #
+    # @param [String] attr attribute of node to query
+    # @return [String, nil] string value of attribute or nil if no attribute
+    def [](attr)
+      xquery("data(@#{attr})").pop
+    end
+
+    # Set the value of an attribute of node
+    #
+    # @param [String] attr attribute of node to set
+    # @param [#to_s] value value to set attribute to
+    # @return ????
+    # @todo Find out what this funtion will return
+    def []=(attr, value)
+      node = attributeForName(attr.to_s)
+      node && node.setStringValue(value) || addAttribute(::NSXMLNode.attributeWithName(attr.to_s, stringValue: value))
+    end
+
+    # @private
+    def attribute(attr)
+      attributeForName(attr.to_s)
+    end
+
+    # @return [String] the xml of this node including children nodes with proper indentation
+    def to_s
+      XMLStringWithOptions NSXMLNodePrettyPrint
+    end
+
+    # @private
+    def self.included(klass)
+      klass.class_eval do
+        alias :remove :detach
+        alias :unlink :detach
+        alias :path :XPath
+
+        # TODO: Why is this not working
+        alias :old_children :children
+        def children
+          NodeSet.new(old_children)
+        end
+      end
+    end
+
+    # Remove this node from its parent
+    #
+    # @return [self] this node
+    def remove
+      # Implemented as an alias to detach
+    end
+    alias :unlink :remove
+
+    # An XPath formula to reach this node
+    #
+    # @return [String] XPath to this node
+    def path
+      # Implemented as an alias to :XPath
+    end
+  end
+end
+
+::NSXMLNode.send :include, CocoaXML::NSXMLNodeExtras

data/lib/cocoa-xml/version.rb

@@ -0,0 +1,3 @@
+module CocoaXML
+  Version = '0.4.4'
+end

data/lib/nokogiri/css.rb

@@ -0,0 +1,27 @@
+require 'nokogiri/css/node'
+require 'nokogiri/css/xpath_visitor'
+require 'nokogiri/css/generated_parser'
+require 'nokogiri/css/generated_tokenizer'
+require 'nokogiri/css/tokenizer'
+require 'nokogiri/css/parser'
+require 'nokogiri/css/syntax_error'
+
+module Nokogiri
+  # Modules to convert CSS selectors to valid XPath
+  # @see http://nokogiri.org/Nokogiri/CSS.html Nokogiri Documentation
+  module CSS
+    #class << self
+      ###
+      # Parse this CSS selector in +selector+.  Returns an AST.
+      def self.parse selector
+        Parser.new.parse selector
+      end
+
+      ###
+      # Get the XPath for +selector+.
+      def self.xpath_for selector, options={}
+        Parser.new(options[:ns] || {}).xpath_for selector, options
+      end
+    #end
+  end
+end