Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update the 3 gem projects to each use the common readme file. The top…

…level rakefile and each gem's gemspec have been updated.
  • Loading branch information...
commit ee919c74bf92b971b5932aa4b74c6bcd0caa6afa 1 parent 9cf8956
@bret bret authored
View
55 CONTRIBUTORS.txt
@@ -0,0 +1,55 @@
+This is an old, out of date list of our contributors, from an old README file.
+Watir exists because of the help and assistance of many different people over the ages.
+More recent contributors are acknowledged in the CHANGES file.
+
+Contributors:
+ Bret Pettichord
+ Paul Rogers
+ Jonathan Kohl
+ Chris Morris
+ Karlin Fox
+ Lorenzo Jorquera
+ Atilla Ozgur
+ Justin McCarthy
+ Chris McMahon
+ Elisabeth Hendrickson
+ Michael Kelly
+ Peter Chau
+ Danny Faught
+ Andy Sipe
+ John Lloyd-Jones
+ Chris Hedges
+ Park Heesob
+ Shashank Date
+ Jared Luxenberg
+ Alexey Verkhovsky
+ Tuyet Cong-Ton-Nu
+ Jeff Wood
+ Angrez Singh
+ Abhishek Goliya
+ Yaxin Wang
+ Michael Bolton
+ Paul Carvalho
+ Konstantin Sobolev
+ David Schmidt
+ Dara Lillis
+ Charley Baker
+ Prema Arya
+ Xavier Noria
+ Jeff Fry
+ Zeljko Filipin
+ Paul Taylor - Bug fix 194
+ Vincent Xu - Chinese input support
+ Tomislav Car - Filefield fix (210)
+ Michael Hwee & Aidy Lewis - Multiple attribute support for FireWatir (233)
+ Alan Baird - Fix for visible? method (253)
+ Jari Bakken - Regexp support for includes? and selected? methods for select lists (261)
+
+Acknowledgements:
+ Chris Morris
+ Brian Marick
+ Jonathan Kohl
+ Penny Tonita
+ Janet Gregory
+ Andy Tinkham
+ Jacinda Scott (logo creator)
View
16 Rakefile
@@ -3,12 +3,13 @@ require 'rake/clean'
require 'fileutils'
gem 'ci_reporter'
require 'ci/reporter/rake/test_unit'
+
projects = ['watir', 'firewatir', 'commonwatir']
desc "Generate all the Watir gems"
task :gems do
projects.each do |project|
- tmp_files = %w{CHANGES VERSION}
+ tmp_files = %w{CHANGES VERSION README.rdoc}
FileUtils.cp tmp_files, project
Dir.chdir(project) do
puts `rake.bat gem`
@@ -98,16 +99,3 @@ namespace :cruise do
desc 'Run all tests'
task :all => [:ie_core_tests, :ff_mozilla_all_tests]
end
-
-desc 'Build the html for the website (wtr.rubyforge.org)'
-task :website do
- Dir.chdir 'doc' do
- puts system('call webgen -V 1')
- end
-end
-
-desc 'Build and publish the html for the website at wtr.rubyforge.org'
-task :publish_website => [:website] do
- user = 'bret' # userid on rubyforge
- puts system("call pscp -v -r doc\\output\\*.* #{user}@rubyforge.org:/var/www/gforge-projects/wtr")
-end
View
8 commonwatir/commonwatir.gemspec
@@ -2,16 +2,16 @@ spec = Gem::Specification.new do |s|
s.name = 'commonwatir'
s.version = File.read("VERSION").strip rescue "0.0.0"
s.summary = "Common library for Watir and FireWatir"
- s.description = "Common library for Watir and FireWatir"
+ s.description = "Common library for Watir and FireWatir."
s.author = 'Bret Pettichord'
s.homepage = 'http://www.watir.com'
s.email = 'bret@pettichord.com'
s.rubyforge_project = 'wtr'
-
s.require_path = 'lib'
s.add_dependency 'user-choices'
-
- s.files = Dir['lib/**/*'] << "Rakefile" << "LICENSE" << "CHANGES" << "VERSION"
+ s.files = Dir['lib/**/*'] << "Rakefile" << "LICENSE" << "CHANGES" << "VERSION" << "README.rdoc"
s.test_files = Dir['unittests/**/*']
+ s.rdoc_options = ['--main', 'README.rdoc']
+ s.extra_rdoc_files = 'README.rdoc'
end
View
3  commonwatir/lib/commonwatir.rb
@@ -1,3 +0,0 @@
-class CommonWatir
- VERSION = '1.6.5'
-end
View
9 firewatir/firewatir.gemspec
@@ -9,7 +9,8 @@ $__firewatir_source_patterns = [
'CHANGES',
'rakefile.rb',
'VERSION',
- 'firewatir.gemspec'
+ 'firewatir.gemspec',
+ "README.rdoc"
]
spec = Gem::Specification.new do |s|
@@ -39,10 +40,12 @@ spec = Gem::Specification.new do |s|
s.add_dependency 'activesupport', '=2.3.9'
s.has_rdoc = true
- s.rdoc_options <<
+ s.rdoc_options <<
'--title' << 'FireWatir API Reference' <<
'--accessor' << 'def_wrap=R,def_wrap_guard=R,def_creator=R,def_creator_with_default=R' <<
- '--exclude' << 'unittests|camel_case.rb|testUnitAddons.rb'
+ '--exclude' << 'unittests|camel_case.rb|testUnitAddons.rb' <<
+ '--main' << 'README.rdoc'
+ s.extra_rdoc_files = 'README.rdoc'
# s.test_file = 'unittests/mozilla_all_tests.rb'
View
140 watir/lib/readme.rb
@@ -1,140 +0,0 @@
-=begin rdoc
-
-This is Watir - Web Application Testing In Ruby http://wtr.rubyforge.org
-
-Install Ruby http://ruby-lang.org
- First you need to install Ruby using the one-click installer for Windows. We
- recommend Ruby 1.8.6. (Even if you are using modal dialogs.)
-
-Install Watir
- Watir is packaged as a gem, a Ruby library that can be installed over the
- internet.
-
- Watir 1.5 was released in September 2007. To install it, type this at a
- command prompt:
- gem install watir
-
- Watir 1.4 was released in August 2005. If you are upgrading from it, see
- these notes: http://wiki.openqa.org/display/WTR/Development+Builds
-
-How To Use:
- This only works on Windows.
- Requires Internet Explorer 5.5 or newer.
- Check out the mail lists and the documentation for the workarounds.
-
-User Guide: http://wiki.openqa.org/display/WTR/User+Guide
-
-Unit Tests:
- Run the unittests in a cmd shell. Go to the dir where you installed it and then type 'ruby unittests/core_tests.rb'.
- See the user guide if you are having problems with security blocking.
-
-Typical Usage
- # include the controller
- require 'watir'
- # create an instance of the controller
- ie = Watir::IE.new
- # go to the page you want to test
- ie.goto('http://myserver/mypage')
- # to enter text into a text field - assuming the field is named 'username'
- ie.text_field(:name, 'username').set('Paul')
- # if there was a text field that had an id of 'company_ID', you could set it to 'Ruby Co':
- ie.text_field(:id ,'company_ID').set('Ruby Co')
- # to click a button that has a caption of 'Cancel'
- ie.button(:value, 'Cancel').click
-
- Identifying something using two or more identifying characteristics
- # Html objects can also be identified via a combination of two of the above methods,
- # for example to click a span with a class name of 'Label', and whose text is 'Add new', one could say
- ie.span(:class =>'Label', :text => 'Add new').click
- # Or to find one object within another (for example the first text_field within a div of class
- # 'PasswordInput', where your password equals 'MyPassword'), one could say
- ie.div(:class, 'PasswordInput').text_field(:index, 1).set('MyPassword')
-
- The ways that are available to identify an html object depend upon the object type, but include
- :id used for an object that has an ID attribute.*
- :name used for an object that has a name attribute.*
- :value value of text fields, captions of buttons.
- :index finds the nth object of the specified type - eg button(:index , 2) finds the second button. This is 1 based. <br>
- :class used for an object that has a class attribute.
- :text used for links and other objects that contain text.
- :xpath finds the item using xpath query
-
- * :id and :name are the quickest of these to process, and so should be used when possible to speed up scripts.
-
- These 2 web sites provide info on Internet Explorer and on the DOM as implemented by Internet Explorer
- http://msdn.microsoft.com/library/default.asp?url=/workshop/browser/webbrowser/webbrowser.asp
- http://msdn.microsoft.com/library/default.asp?url=/workshop/browser/overview/overview.asp
-
- Command line options:
-
- -b (background) Run Internet Explorer invisible
- -f (fast) Run tests very fast
-
- Note that if you also use test/unit, you will need to require 'watir' first to avoid conflicts
- with its command line switches.
-
-Javascript Pop Up Support
- Watir now optionally installs AutoIt - http://www.autoitscript.com/
- This is the prefered method for dealing wth pop ups, file requesters etc. Support for Winclickers will be removed.
-
-Contacts:
- Bret Pettichord (bret@pettichord.com)
- Charley Baker (charley.baker@gmail.com)
- Paul Rogers (paul.rogers@shaw.ca)
- The mailing list: http://groups.google.com/group/watir-general
-
-Contributors:
- Bret Pettichord
- Paul Rogers
- Jonathan Kohl
- Chris Morris
- Karlin Fox
- Lorenzo Jorquera
- Atilla Ozgur
- Justin McCarthy
- Chris McMahon
- Elisabeth Hendrickson
- Michael Kelly
- Peter Chau
- Danny Faught
- Andy Sipe
- John Lloyd-Jones
- Chris Hedges
- Park Heesob
- Shashank Date
- Jared Luxenberg
- Alexey Verkhovsky
- Tuyet Cong-Ton-Nu
- Jeff Wood
- Angrez Singh
- Abhishek Goliya
- Yaxin Wang
- Michael Bolton
- Paul Carvalho
- Konstantin Sobolev
- David Schmidt
- Dara Lillis
- Charley Baker
- Prema Arya
- Xavier Noria
- Jeff Fry
- Zeljko Filipin
- Paul Taylor - Bug fix 194
- Vincent Xu - Chinese input support
- Tomislav Car - Filefield fix (210)
- Michael Hwee & Aidy Lewis - Multiple attribute support for FireWatir (233)
- Alan Baird - Fix for visible? method (253)
- Jari Bakken - Regexp support for includes? and selected? methods for select lists (261)
-
-Acknowledgements:
- Chris Morris
- Brian Marick
- Jonathan Kohl
- Penny Tonita
- Janet Gregory
- Andy Tinkham
- Jacinda Scott (logo creator)
-
- Thanks for your ideas and support!
-
-=end
View
4 watir/watir-rdoc.rb
@@ -1,7 +1,7 @@
$WATIR_RDOC_OPTIONS = [] <<
'--title' << 'Watir API Reference' <<
'--accessor' << 'def_wrap=R,def_wrap_guard=R,def_creator=R,def_creator_with_default=R' <<
- '--main' << 'Watir::IE' <<
+ '--main' << 'README.rdoc' <<
'--exclude' << 'unittests|camel_case.rb'
-$WATIR_EXTRA_RDOC_FILES = ['lib/readme.rb', 'lib/changes.rb', 'lib/license.rb']
+$WATIR_EXTRA_RDOC_FILES = ['README.rdoc']
View
3  watir/watir.gemspec
@@ -1,7 +1,7 @@
require 'watir-rdoc'
$__watir_source_patterns = [
- 'CHANGES', 'rakefile.rb', 'VERSION', 'watir.gemspec', 'watir-rdoc.rb',
+ 'CHANGES', 'rakefile.rb', 'VERSION', "README.rdoc", 'watir.gemspec', 'watir-rdoc.rb',
'lib/watir/*.rb', 'lib/watir/AutoItX3.dll',
'unittests/*.rb', 'unittests/html/*.html', 'unittests/html/images/*.*',
'unittests/other/*.rb', 'unittests/testcase/*.rb', 'unittests/windows/*.rb',
@@ -42,6 +42,7 @@ spec = Gem::Specification.new do |s|
s.has_rdoc = true
s.rdoc_options += $WATIR_RDOC_OPTIONS
+ s.extra_rdoc_files = $WATIR_EXTRA_RDOC_FILES
s.executables << 'watir-console'
# s.test_file = 'unittests/core_tests.rb'
Please sign in to comment.
Something went wrong with that request. Please try again.