testability-driver 0.9.2 → 1.0.0

data/lib/tdriver/util/xml/parsers/nokogiri/abstraction.rb

@@ -62,6 +62,40 @@ module MobyUtil
 
       private
 
+        # TODO: document me
+        def node_object( object )
+
+          case object
+
+            when ::Nokogiri::XML::Element
+
+              element_object( object )
+
+            when ::Nokogiri::XML::Text
+
+              text_object( object )
+
+            when ::Nokogiri::XML::Attr
+
+              attribute_object( object )
+
+            when ::NilClass
+
+              nil_node
+
+            # do not create wrapper object if already wrapped
+            when ::MobyUtil::XML::Element, ::MobyUtil::XML::Nodeset, ::MobyUtil::XML::Text, ::MobyUtil::XML::Attribute, ::MobyUtil::XML::NilNode 
+            
+              object
+
+          else
+
+             raise NotImplementedError.new( "Object wrapper for node type of #{ object.class } not implemented - Please contact TDriver support" )
+
+          end
+
+        end
+
         # method to create MobyUtil::XML::Attribute object
         def attribute_object( xml_data )
 
@@ -69,18 +103,24 @@ module MobyUtil
 
         end
 
-        # method to create MobyUtil::XML::Element or MobyUtil::XML::NilElement object 
+        # method to create MobyUtil::XML::Element 
         def element_object( xml_data )
 
-          unless xml_data.nil?
+          MobyUtil::XML::Element.new( xml_data, @parser ).extend( Element )
+
+        end
 
-            MobyUtil::XML::Element.new( xml_data, @parser ).extend( Element )
+        # method to create MobyUtil::XML::NilNode
+        def nil_node
 
-          else
+            MobyUtil::XML::NilNode.new( nil, @parser )
+
+        end
 
-            MobyUtil::XML::NilElement.new( nil, @parser )
+        # method to create MobyUtil::XML::Text
+        def text_object( xml_data )
 
-          end
+          MobyUtil::XML::Text.new( xml_data, @parser ).extend( Text )
 
         end
 
@@ -89,7 +129,6 @@ module MobyUtil
 
           MobyUtil::XML::Nodeset.new( xml_data, @parser ).extend( Nodeset )
 
-
         end
 
         # TODO: Documentation

data/lib/tdriver/util/xml/parsers/nokogiri/attribute.rb

@@ -17,9 +17,6 @@
 ## 
 ############################################################################
 
-
-=begin
-
 module MobyUtil
 
   module XML
@@ -28,17 +25,31 @@ module MobyUtil
 
       module Attribute
 
+        include Abstraction
+
         def value
-          @xml.nil? ? nil : @xml.value.to_s
+
+          @xml.value
+
+        end
+
+        def content
+
+          @xml.content
+
         end
 
         def name
-          @xml.nil? ? nil : @xml.name
+
+          @xml.name
+
         end
 
-        #def to_s
-          #  value
-        #end
+        def to_s
+
+          @xml.value
+
+        end
 
         # enable hooking for performance measurement & debug logging
         MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
@@ -51,4 +62,3 @@ module MobyUtil
 
 end # MobyUtil
 
-=end

data/lib/tdriver/util/xml/parsers/nokogiri/document.rb

@@ -30,7 +30,7 @@ module MobyUtil
 
         def parse( xml_string )
 
-          ::Nokogiri::XML.parse( xml_string, '', 'UTF8', 0 )
+          ::Nokogiri::XML.parse( xml_string, nil, 'UTF8', ::Nokogiri::XML::ParseOptions::STRICT )
 
         end
 

data/lib/tdriver/util/xml/parsers/nokogiri/element.rb

@@ -25,7 +25,7 @@ module MobyUtil
 
       module Element # behaviour
 
-        include Abstraction 
+        include Abstraction
 
         def <=>( object )
 
@@ -113,6 +113,12 @@ module MobyUtil
 
         end
 
+        def at_xpath( xpath_query, *args, &block )
+
+          node_object( @xml.at_xpath( xpath_query, *args, &block ) )
+
+        end
+
         def replace( other )
 
           @xml.replace( other.xml )
@@ -135,6 +141,12 @@ module MobyUtil
 
         end
 
+        def parent
+        
+          element_object( @xml.parent )
+        
+        end
+
         # enable hooking for performance measurement & debug logging
         MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
 

data/lib/tdriver/util/xml/parsers/nokogiri/loader.rb

@@ -35,6 +35,12 @@ require File.expand_path( File.join( File.dirname( __FILE__ ), 'nodeset.rb' ) )
 # nokogiri parser wrapper
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'element.rb' ) )
 
+# nokogiri parser wrapper
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'text.rb' ) )
+
+# nokogiri parser wrapper
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'attribute.rb' ) )
+
 # nokogiri parser wrapper
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'builder.rb' ) )
 

data/lib/tdriver/util/xml/parsers/nokogiri/nodeset.rb

@@ -29,27 +29,39 @@ module MobyUtil
 
         def []( node )
 
-          element_object( @xml[ node ] )
+          node_object( @xml[ node ] )
 
         end
 
         def first
 
-          element_object( @xml.first )
+          node_object( @xml.first )
 
         end
 
         def last
 
-          element_object( @xml.last )
+          node_object( @xml.last )
 
         end
 
         def each( &block )
 
-          @xml.each{ | element | 
+          @xml.each{ | node | 
 
-            yield( element_object( element ) ) 
+            yield( node_object( node ) ) 
+
+          }
+
+          self
+
+        end
+
+        def each_with_index( &block )
+
+          @xml.each_with_index{ | node, index | 
+
+            yield( node_object( node ), index ) 
 
           }
 
@@ -116,9 +128,9 @@ module MobyUtil
     
         def to_a
 
-          @xml.collect{ | element | 
+          @xml.collect{ | node | 
 
-            element_object( element ) 
+            node_object( node ) 
 
           }
           
@@ -126,11 +138,11 @@ module MobyUtil
         
         def delete( node )
 
-          @xml.each do | element |
+          @xml.each do | nodeset_node |
 
-            if ( node.xml.content == element.content )
+            if ( node.xml.content == nodeset_node.content )
 
-              @xml.delete( element )
+              @xml.delete( nodeset_node )
 
               break
 
@@ -149,9 +161,9 @@ module MobyUtil
 
         def _collect( &block )
 
-          @xml.collect{ | element | 
+          @xml.collect{ | node | 
 
-            yield( element_object( element ) ) 
+            yield( node_object( node ) ) 
 
           } 
 
@@ -159,15 +171,15 @@ module MobyUtil
 
         def _sort( &block )
 
-          @xml.sort{ | element_a, element_b | 
+          @xml.sort{ | node_a, node_b | 
         
             if block_given?
 
-              yield( element_object( element_a ), element_object( element_b ) ) 
+              yield( node_object( node_a ), node_object( node_b ) ) 
 
             else
 
-              element_a <=> element_b
+              node_a <=> node_b
 
             end
 

data/lib/tdriver/util/xml/parsers/nokogiri/text.rb

@@ -0,0 +1,57 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+module MobyUtil
+
+  module XML
+
+    module Nokogiri
+
+      module Text # behaviour
+
+        include Abstraction 
+
+        def parent
+        
+          element_object( @xml.parent )
+        
+        end
+
+        def to_s
+  
+          @xml.content
+
+        end
+
+        def content
+
+          @xml.content
+
+        end
+
+        # enable hooking for performance measurement & debug logging
+        MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+      end # Element
+
+    end # Nokogiri
+
+  end # XML
+
+end # MobyUtil

data/lib/tdriver/util/xml/text.rb

@@ -0,0 +1,32 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+module MobyUtil
+
+  module XML
+
+    class Text
+
+      include Abstraction
+
+    end # Text
+
+  end # XML
+
+end # MobyUtil

data/lib/tdriver/util/xml/xml.rb

@@ -57,8 +57,7 @@ module MobyUtil
     #  ==> Returns XML document object; default xml parser will be used. 
     #
     # == params
-    # xml_string:: String containing XML
-    # parser:: XML parser class e.g. MobyUtil::XML::Nokogiri
+    # xml_string:: String containing XML  
     # == return
     # Document:: XML document object
     # == raises
@@ -66,7 +65,7 @@ module MobyUtil
 
       begin
 
-        MobyUtil::XML::Document.new( nil, current_parser ).extend( @@parser::Document ).tap{ | document | 
+        MobyUtil::XML::Document.new( nil, @@parser ).extend( @@parser::Document ).tap{ | document | 
 
           # parse given string
           document.xml = document.parse( xml_string ) 
@@ -75,30 +74,45 @@ module MobyUtil
 
       rescue Exception => exception
 
-        # string for exception message
-        dump_location = ""
+        if $TDRIVER_INITIALIZED == true
+        
+          # string for exception message
+          dump_location = ""
 
-        # check if xml parse error logging is enabled
-        if MobyUtil::KernelHelper.to_boolean( MobyUtil::Parameter[ :logging_xml_parse_error_dump, 'true' ] )
+          # check if xml parse error logging is enabled
+          if MobyUtil::KernelHelper.to_boolean( MobyUtil::Parameter[ :logging_xml_parse_error_dump ] )
 
-          # generate filename for xml dump
-          filename = MobyUtil::KernelHelper.to_boolean( MobyUtil::Parameter[ :logging_xml_parse_error_dump_overwrite, 'false' ] ) ? 'xml_error_dump.xml' : 'xml_error_dump_%i.xml' % Time.now
+            # generate filename for xml dump
+            filename = MobyUtil::KernelHelper.to_boolean( MobyUtil::Parameter[ :logging_xml_parse_error_dump_overwrite ] ) ? 'xml_error_dump.xml' : 'xml_error_dump_%i.xml' % Time.now
 
-          # ... join filename with xml dump output path 
-          path = File.join( MobyUtil::FileHelper.expand_path( MobyUtil::Parameter[ :logging_xml_parse_error_dump_path, 'logfiles/' ] ), filename )
+            # ... join filename with xml dump output path 
+            path = File.join( MobyUtil::FileHelper.expand_path( MobyUtil::Parameter[ :logging_xml_parse_error_dump_path ] ), filename )
 
-          # create error dump folder if not exist, used e.g. when xml parse error
-          MobyUtil::FileHelper.mkdir_path( File.dirname( path ) )
+            begin
 
-          # write xml string to file
-          File.open( path, "w" ){ | file | file << xml_string }
+              # write xml string to file
+              File.open( path, "w" ){ | file | file << xml_string }
 
-          dump_location = ". Saved to %s" % path
+              dump_location = ". Saved to %s" % path
+
+            rescue
+
+              dump_location = ". Error while saving to file %s" % path
+
+            end
 
-        end
 
-        # raise exception
-        Kernel::raise MobyUtil::XML::ParseError.new( "%s (%s)%s" % [ exception.message.gsub("\n", ''), exception.class, dump_location ] )
+          end
+
+          # raise exception
+          Kernel::raise MobyUtil::XML::ParseError.new( "%s (%s)%s" % [ exception.message.gsub("\n", ''), exception.class, dump_location ] )
+
+        else
+        
+          # raise exception
+          Kernel::raise MobyUtil::XML::ParseError.new( "%s (%s)" % [ exception.message.gsub("\n", ''), exception.class ] )
+        
+        end
 
       end
 
@@ -110,8 +124,7 @@ module MobyUtil
     #  ==> Returns XML document object; default xml parser will be used. 
     #
     # == params
-    # filename:: String containing path and filename of XML file.
-    # parser:: XML parser class e.g. MobyUtil::XML::Nokogiri
+    # filename:: String containing path and filename of XML file.    
     # == return
     # Document:: XML document object
     # == raises
@@ -121,7 +134,7 @@ module MobyUtil
       # raise exception if file not found
       Kernel::raise IOError.new( "File '%s' not found" % filename ) unless File.exist?( filename )
 
-      self.parse_string( IO.read( filename ), current_parser )
+      self.parse_string( IO.read( filename ) )
 
     end