tg4rb 0.0.2 → 1.0.0

data/History.txt

@@ -1,3 +1,10 @@
+== 1.0.0 / 2007-08-21
+* NOTE: This version breaks compatibility with previous version! Scripts written in previous versions won't work.
+* fixed small bug with escaping single quotes
+* API change: changed the visibility of element_by_least_restrictive_xpath in Tg4rbToolbox to private
+* API change: created public method element() in Tg4rbToolbox
+* provided workaround for bug in xpath from tg4w: now clicks on links work with the link's text (requires HPricot)
+
 == 0.0.2 / 2007-07-09
 * fixed silly import problem on generated script
 

data/Manifest.txt

@@ -3,7 +3,6 @@ LICENSE.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/tg4rb
 lib/tg4rb.rb
 lib/tg4rb_toolbox.rb
 lib/tg4w_handler.rb

data/README.txt

@@ -14,7 +14,7 @@ reproduce the actions recorded with TestGen4Web.
   
 * takes an XML with actions from tg4w and outputs stand-alone Ruby code that can be run directly or embedded into existing code (e.g. for test automation).
 * can be used as a library or as an executable script.
-* takes the xpath from tg4w and uses only enough info to guarantee the uniqueness of the referenced element, allowing the generated script to keep working even with some change on page structure.
+* takes the xpath from tg4w and uses only enough info to guarantee the uniqueness of the referenced element, allowing the generated script to keep working even with some change to page structure.
 
 == PROBLEMS:
 
@@ -37,6 +37,7 @@ reproduce the actions recorded with TestGen4Web.
 * hoe
 * rubyforge
 * rake
+* hpricot
 
 == INSTALL:
 

data/lib/tg4rb.rb

@@ -2,5 +2,5 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 require 'tg4w_handler'
 require 'tg4w_to_firewatir'
 class Tg4rb
-  VERSION='0.0.2'
+  VERSION='1.0.0'
 end

data/lib/tg4rb_toolbox.rb

@@ -1,4 +1,20 @@
+require 'rubygems'
+require 'hpricot'
+
 module Tg4rbToolbox
+
+  # Returns the element referred to by xpath
+  def element(xpath)
+    puts "### Original xpath: #{xpath}"
+    xpath = fix_link_text_xpath(Hpricot(@ff.html),xpath) if xpath.include? 'CDATA'
+    element_by_least_restrictive_xpath(xpath)
+  end
+
+  private
+  # Finds the element referred to by xpath, but using the least information it
+  # can from the xpath that is enough to guarantee the uniqueness of the
+  # element, allowing an element to be found even if the page structures
+  # changes a bit.
   def element_by_least_restrictive_xpath(xpath)
     puts '## full xpath:'
     puts xpath
@@ -16,5 +32,24 @@ module Tg4rbToolbox
     puts '## no unique element found. using first occurence.'
     ele.first
   end
+
+  # Works around the faulty xpath that comes from TestGen4Web where a link is
+  # referred to by its inner text (all the text between <a> tags, excluding the
+  # tags inside it, e.g.: 'I love <b>bold</b>!' becomes 'I love bold!'). Tg4w
+  # gives a link xpath with CDATA as a tag attribute with the flattened-out
+  # text, which isn't official xpath and isn't recognized by Firewatir. This
+  # method takes the page's html document(HPricot::Doc), finds the links,
+  # flattens them out and compares them to the flattened-out text given by
+  # tg4w. When a match is found, it returns the propper xpath for that link.
+
+  def fix_link_text_xpath(doc,xpath)
+    cdata_text = xpath =~ /"(.*)\\"/ ? $1 : ''
+    puts "### cdata_text: #{cdata_text}"
+    links = doc.search('//a')
+    true_xpath = ''
+    links.each {|l| puts l.inner_text + '; ' + cdata_text; if l.inner_text == cdata_text then true_xpath = l.xpath end}
+    true_xpath
+  end
+
 end
 

data/lib/tg4w_handler.rb

@@ -77,7 +77,7 @@ class Tg4wHandler
       a.attributes.each {|name,value| hash[name] = value} 
       # expecting xpath and value cdatas
       a.elements.each {|e| hash[e.name] = e.text.strip}
-      hash['xpath'] = fix_xpath(hash['xpath'])
+      hash['xpath'] = escape(fix_xpath(hash['xpath']))
       hash['value'] = escape(hash['value'])
       actions << hash
     end

data/lib/tg4w_to_firewatir.rb

@@ -18,7 +18,7 @@ class Tg4wToFirewatir < Tg4wHandler
 
   def parse_fill(action)
     @output << <<-end
-      element_by_least_restrictive_xpath('#{action['xpath']}').set('#{action['value']}')
+      element('#{action['xpath']}').set('#{action['value']}')
     end
   end
 
@@ -38,7 +38,7 @@ class Tg4wToFirewatir < Tg4wHandler
 
   def parse_click(action)
     @output << <<-end
-      element_by_least_restrictive_xpath('#{action['xpath']}').click
+      element('#{action['xpath']}').click
     end
   end
 
@@ -47,11 +47,11 @@ class Tg4wToFirewatir < Tg4wHandler
     # it does not respond to set()
     if action['value'] == 'true'
       @output << <<-end
-        element_by_least_restrictive_xpath('#{action['xpath']}').set
+        element('#{action['xpath']}').set
       end
     elsif action['value'] == 'false'
       @output << <<-end
-        element_by_least_restrictive_xpath('#{action['xpath']}').clear
+        element('#{action['xpath']}').clear
       end
     end
   end
@@ -60,7 +60,7 @@ class Tg4wToFirewatir < Tg4wHandler
     # FIXME element_by_xpath() doesn't return it as SelectList, therefore
     # it does not respond to select_value()
     @output << <<-end
-      element_by_least_restrictive_xpath('#{action['xpath']}').select_value('#{action['value']}')
+      element('#{action['xpath']}').select_value('#{action['value']}')
     end
   end
 

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: tg4rb
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-07-11 00:00:00 -03:00
+  version: 1.0.0
+date: 2007-09-09 00:00:00 -03:00
 summary: A recorder for FireWatir
 require_paths: 
 - lib
 email: helder@gmail.com
 homepage: "    by Helder Ribeiro"
 rubyforge_project: firewatir-gen
-description: "== FEATURES:  * takes an XML with actions from tg4w and outputs stand-alone Ruby code that can be run directly or embedded into existing code (e.g. for test automation). * can be used as a library or as an executable script. * takes the xpath from tg4w and uses only enough info to guarantee the uniqueness of the referenced element, allowing the generated script to keep working even with some change on page structure.  == PROBLEMS:  * the generated code is damn ugly. * a few action types from the XML input still aren't recognized. * some dependencies aren't very clearly sorted out yet. you might find you need something that is not specified. if yes, please report this as an issue in our issue tracker. * i don't know, find more and let me know =)  == SYNOPSIS:"
+description: "== FEATURES:  * takes an XML with actions from tg4w and outputs stand-alone Ruby code that can be run directly or embedded into existing code (e.g. for test automation). * can be used as a library or as an executable script. * takes the xpath from tg4w and uses only enough info to guarantee the uniqueness of the referenced element, allowing the generated script to keep working even with some change to page structure.  == PROBLEMS:  * the generated code is damn ugly. * a few action types from the XML input still aren't recognized. * some dependencies aren't very clearly sorted out yet. you might find you need something that is not specified. if yes, please report this as an issue in our issue tracker. * i don't know, find more and let me know =)  == SYNOPSIS:"
 autorequire: 
 default_executable: 
 bindir: bin
@@ -34,7 +34,6 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/tg4rb
 - lib/tg4rb.rb
 - lib/tg4rb_toolbox.rb
 - lib/tg4w_handler.rb
@@ -49,8 +48,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - Manifest.txt
 - README.txt
-executables: 
-- tg4rb
+executables: []
+
 extensions: []
 
 requirements: []
@@ -63,5 +62,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.1
+        version: 1.3.0
     version: 

data/bin/tg4rb

@@ -1,37 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems'
-require File.join(File.split(File.split(File.expand_path(__FILE__))[0])[0],'lib','tg4rb') 
-require 'rexml/document'
-include REXML
-
-if ARGV.length != 1
-  puts "Wrong number of arguments. Use: program <xml_file>"
-  exit
-end
-
-xml_file = File.expand_path(ARGV[0])
-# dumb check
-if xml_file.split('.')[-1] != 'xml'
-  puts "Not a .xml file"
-  exit
-end
-
-rb_file = xml_file.split('.')[0..-2].join('.') << '.rb'
-if File.exists? rb_file
-  puts "File #{rb_file} exists. \nOverwrite it? (y/N)"
-  # need to make STDIN explicit because there's a filename in the
-  # command-line argument (gets defaults to reading from it)
-  if STDIN.gets.strip == 'y'
-    File.delete(rb_file)
-  else
-    exit(true)
-  end
-end
-
-doc = Document.new(File.read(xml_file))
-actions = Tg4wToFirewatir.parse_xml(doc)
-translator = Tg4wToFirewatir.new(actions)
-File.open(rb_file,'w') {|f| f << translator.translate}
-
-# vim: set filetype=ruby :
-