blackwinter-ruby-xquery 0.2.2

data/README

@@ -0,0 +1,41 @@
+= ruby-xquery - Libxml's XPath support + plain ol' Ruby = XQuery (kind of... ;-)
+
+== VERSION
+
+This documentation refers to ruby-xquery version 0.2.2
+
+
+== DESCRIPTION
+
+TODO: well, the description... ;-)
+
+
+== LINKS
+
+<b></b>
+Documentation::     <http://prometheus.rubyforge.org/ruby-xquery>
+Source code (old):: <http://prometheus.rubyforge.org/svn/scratch/ruby-xquery>
+Source code::       <http://github.com/blackwinter/ruby-xquery>
+Rubyforge project:: <http://rubyforge.org/projects/prometheus>
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@uni-koeln.de>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2007-2008 Jens Wille
+
+ruby-xquery is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+ruby-xquery is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+ruby-xquery. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'hen'
+rescue LoadError
+  abort "Please install the 'hen' gem first."
+end
+
+require 'lib/libxml/xquery/version'
+
+Hen.lay! {{
+  :rubyforge => {
+    :package => 'ruby-xquery'
+  },
+
+  :gem => {
+    :version      => LibXML::XML::XQuery::VERSION,
+    :summary      => "Libxml's XPath support + plain ol' Ruby = XQuery (kind of... ;-)",
+    :files        => FileList['lib/**/*.rb'].to_a,
+    :extra_files  => FileList['[A-Z]*', 'spec/**/*.rb', 'test_data/**/*'].to_a,
+    :dependencies => [['libxml-ruby', '>= 0.9.3']]
+  }
+}}

data/lib/libxml/xquery/enhanced_find.rb

@@ -0,0 +1,49 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-xquery, mimicking XQuery in Ruby.                       #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-xquery is free software; you can redistribute it and/or modify it      #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-xquery is distributed in the hope that it will be useful, but WITHOUT  #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-xquery. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+module LibXML::XML::XQuery::EnhancedFind
+
+  def enhanced_find(xpath)
+    find(xpath.gsub(/\*\*/, 'descendant::node()'), namespaces)
+  end
+  alias_method :[], :enhanced_find
+
+  def /(xpath)
+    enhanced_find(xpath.to_s)
+  end
+
+  def self.included(base)
+    # overwrite original methods
+    instance_methods.each { |method|
+      base.send(:define_method, method, instance_method(method))
+    }
+  end
+
+end
+
+[LibXML::XML::Document, LibXML::XML::Node].each { |klass|
+  klass.send :include, LibXML::XML::XQuery::EnhancedFind
+}

data/lib/libxml/xquery/namespaces.rb

@@ -0,0 +1,67 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-xquery, mimicking XQuery in Ruby.                       #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-xquery is free software; you can redistribute it and/or modify it      #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-xquery is distributed in the hope that it will be useful, but WITHOUT  #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-xquery. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+module LibXML::XML::XQuery::Namespaces
+
+  def namespaces
+    @namespaces ||= self.class::DEFAULT_NAMESPACES
+  end
+
+  def namespaces=(ns)
+    if url
+      @namespaces = self.class.namespaces[url] = ns
+    else
+      raise "can't set namespaces (document has no URL)"
+    end
+  end
+
+  def self.included(base)
+    base.const_set(:DEFAULT_NAMESPACES, [])
+
+    # container for XML::Node's access to its document's namespaces
+    base.instance_variable_set(
+      :@namespaces, Hash.new(base.const_get(:DEFAULT_NAMESPACES))
+    )
+
+    class << base; attr_reader :namespaces; end
+
+    # overwrite original methods
+    instance_methods.each { |method|
+      base.send(:define_method, method, instance_method(method))
+    }
+  end
+
+end
+
+[LibXML::XML::Document].each { |klass|
+  klass.send :include, LibXML::XML::XQuery::Namespaces
+}
+
+class LibXML::XML::Node
+  def namespaces
+    LibXML::XML::Document.namespaces[doc.url]
+  end
+end

data/lib/libxml/xquery/string_representation.rb

@@ -0,0 +1,49 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-xquery, mimicking XQuery in Ruby.                       #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-xquery is free software; you can redistribute it and/or modify it      #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-xquery is distributed in the hope that it will be useful, but WITHOUT  #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-xquery. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+class LibXML::XML::Attr
+
+  def to_s(sep = nil)
+    value.strip
+  end
+
+end
+
+class LibXML::XML::Node
+
+  def to_s(sep = nil)
+    content.strip
+  end
+
+end
+
+class LibXML::XML::XPath::Object
+
+  def to_s(sep = ' | ')
+    map { |n| (c = n.to_s(sep)).empty? ? nil : c }.compact.join(sep)
+  end
+
+end

data/lib/libxml/xquery/uniqueness.rb

@@ -0,0 +1,92 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-xquery, mimicking XQuery in Ruby.                       #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-xquery is free software; you can redistribute it and/or modify it      #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-xquery is distributed in the hope that it will be useful, but WITHOUT  #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-xquery. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+require 'forwardable'
+
+module LibXML::XML::XQuery::Uniqueness
+
+  extend Forwardable
+
+  DELEGATORS = %w[to_a each length size]
+
+  def_delegators *DELEGATORS
+
+  def to_a
+    if @_uniq
+      # return unique nodes according to their #to_s
+      seen = Hash.new { |h, k| h[k] = true; false }
+      uniq = []
+
+      _xquery_original_to_a.each { |n|
+        uniq << n unless seen[n.to_s]
+      }
+
+      uniq
+    else
+      _xquery_original_to_a
+    end
+  end
+
+  def uniq
+    proxy = self.class.new.uniq!
+    proxy.instance_variable_set(:@_this, self)
+
+    class << proxy
+      (instance_methods - DELEGATORS).each { |method|
+        undef_method(method) unless method =~ /\A__/
+      }
+
+      def method_missing(*args)
+        block_given? ? @_this.send(*args) { |a| yield a } : @_this.send(*args)
+      end
+    end
+
+    proxy
+  end
+
+  def uniq!
+    @_uniq = true
+    self
+  end
+
+  def uniq?
+    @_uniq
+  end
+
+  def self.included(base)
+    base.send(:alias_method, :_xquery_original_to_a, :to_a)
+
+    # overwrite original methods
+    instance_methods.each { |method|
+      base.send(:define_method, method, instance_method(method))
+    }
+  end
+
+end
+
+[LibXML::XML::XPath::Object].each { |klass|
+  klass.send :include, LibXML::XML::XQuery::Uniqueness
+}

data/lib/libxml/xquery/version.rb

@@ -0,0 +1,35 @@
+module LibXML
+
+  module XML
+
+    module XQuery
+
+      module Version
+
+        MAJOR = 0
+        MINOR = 2
+        TINY  = 2
+
+        class << self
+
+          # Returns array representation.
+          def to_a
+            [MAJOR, MINOR, TINY]
+          end
+
+          # Short-cut for version string.
+          def to_s
+            to_a.join('.')
+          end
+
+        end
+
+      end
+
+      VERSION = Version.to_s
+
+    end
+
+  end
+
+end

data/lib/libxml/xquery.rb

@@ -0,0 +1,45 @@
+#--
+###############################################################################
+#                                                                             #
+# ruby-xquery -- Libxml's XPath support + plain ol' Ruby = XQuery (kind of... #
+# ;-)                                                                         #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-xquery is free software; you can redistribute it and/or modify it      #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-xquery is distributed in the hope that it will be useful, but WITHOUT  #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-xquery. If not, see <http://www.gnu.org/licenses/>.               #
+#                                                                             #
+###############################################################################
+#++
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+require 'libxml'
+
+raise "need libxml-ruby version >= 0.9.3, got #{LibXML::XML::VERSION}" \
+  unless LibXML::XML::VERSION >= '0.9.3'
+
+# Libxml's XPath support + plain ol' Ruby = XQuery (kind of... ;-)
+
+module LibXML::XML::XQuery
+end
+
+Dir[File.join(File.dirname(__FILE__), 'xquery', '**', '*.rb')].each { |rb|
+  require rb
+}

data/lib/xml/xquery.rb

@@ -0,0 +1,2 @@
+# for backwards-compatibility
+require 'libxml/xquery'

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+BASE = File.join(File.dirname(__FILE__), '..') unless Object.const_defined?(:BASE)
+
+$: << File.join(BASE, 'lib')
+
+require 'libxml/xquery'
+
+DOC = LibXML::XML::Document.file(File.join(BASE, 'test_data', 'hamlet.xml')) unless Object.const_defined?(:DOC)

data/spec/xquery_spec.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe LibXML::XML::XQuery do
+
+  it 'should find all acts' do
+    DOC['//ACT'].size.should == 5
+  end
+
+  it 'should find all acts with Hpricot-style syntax' do
+    (DOC/'//ACT').size.should == 5
+  end
+
+  it 'should find all speakers per act' do
+    DOC['//ACT'].map { |act|
+      act['descendant::node()/SPEAKER'].size
+    }.should == [259, 202, 252, 180, 257]
+  end
+
+  it 'should find all unique speakers per act' do
+    DOC['//ACT'].map { |act|
+      act['descendant::node()/SPEAKER'].uniq.size
+    }.should == [14, 10, 15, 15, 13]
+  end
+
+  it 'should find descendant::node() with abbreviated syntax' do
+    act = DOC['//ACT'].first
+
+    act['**/SPEAKER'].to_a.should == act['descendant::node()/SPEAKER'].to_a
+  end
+
+  it 'should not have any side-effects when using non-bang uniq' do
+    speakers = DOC['//ACT'].first['descendant::node()/SPEAKER']
+
+    lambda {
+      speakers.uniq
+    }.should_not change(speakers, :size)
+  end
+
+  it 'should indeed have side-effects when using bang uniq' do
+    speakers = DOC['//ACT'].first['descendant::node()/SPEAKER']
+
+    lambda {
+      speakers.uniq!
+    }.should change(speakers, :size)
+  end
+
+end