bret-watircraft 0.4.0

data/BUGS.txt

@@ -0,0 +1,11 @@
+Known Bugs
+
+* Support for FireWatir is incomplete (specifically: Page fields)
+* Page fields do not support Radio lists.
+* Need to provide homepage for project.
+
+Reported Bugs which we can't reproduce
+
+* "Couldn't find 'site' generator" when running watircraft command.
+  (using 0.3.1, neither taza nor watircraft-beta is also installed)
+  

data/History.txt

@@ -0,0 +1,209 @@
+=== 0.4.0 / 2009-02-23
+
+You will need to run "watircraft ." at the root of your project in order to 
+update your test suite to work with this version of the WatirCraft Framework.
+
+Summary
+
+* Code for cucumber or rspec now runs in the same context. There is also a new
+  console that allows you to run code in the same context. This should vastly
+  simplify learnability and debugging options. Please try out the new script
+  console.
+  
+* Added support for tables. Please see the rdoc for Page#table for details on
+  how to use this.
+
+Details on New Features
+
+* Added script/console. This provides an interactive Ruby shell (irb) that 
+  executes in the context of your site. Hopefully a useful learning and
+  debugging tool. 
+  
+* Added new methods primarily intended to be used from within the script/console.
+  In the default context (site), there is "pages" which returns a list of the 
+  pages defined for the site. In the context of a page, there are "elements" and
+  "fields". And also "elements_exist?" and "values". To get better formatted
+  results, type "y" before these commands.
+
+* Rspec tests ("describe" & "it") now execute in the context of a site, or at least
+  something very similar. This makes it easier to share libraries between
+  rspec and cucumber tests. Also easier to translate learning from one to the
+  other.
+  
+* Added Site#page method. Now, site.page("check out") is the same as 
+  site.check_out_page
+
+* You can now use strings as arguments to Page.element and Page.field. These
+  strings can even be in "human-form" with spaces and capitolization. They will
+  automatically be "computerized".
+
+Other Changes
+
+* Site#origin now returns the base url of the site. (Was: Site#url).
+
+* Hard-coded dependencies on Cucumber 0.1.16 and Rspec 1.1.12. Previously, 
+  watircraft would install the latest versions of these gems, which could
+  create inconsistencies if installed over time on different machines. Now
+  this won't happen. However, if newer versions are installed on your machine,
+  they will be used.
+
+* Updated to use Cucumber 0.1.16 instead of 0.1.13.
+
+* Explicitly declare dependency on Watir 1.6.2 (or newer). Previously this
+  was assumed.
+
+
+=== 0.3.2 / 2009-02-04
+
+Another patch release. Like 0.3.1, no need to update if your project is 
+already at 0.3.x
+
+* Fix "undefined method display_value" error that appeared when creating
+  page fields with links or parents.
+
+=== 0.3.1 / 2009-02-03
+
+This patch release includes some fixes and an improved updater.
+
+Update Notes
+
+You can update an existing project created with a previous release 
+by typing "watircraft ." in root of your project. 
+(That is _watircraft space period_.)
+
+If your project was created with or already updated to 0.3.0, you do not 
+need to update (although it won't hurt if you do).
+
+If your project was created with beta2 or previous, you will need to update
+to use this version.
+
+Improvements to Updater
+
+* When using "watircraft" to update an existing project, you no longer
+  have to specify the site name.
+* When updating, the "correct" files will automatically be replaced.
+* The initialize.rb file is now stamped with the time and version.
+
+Fixes
+
+* Automatically install cucumber when installing watircraft.
+* Allow pages to be specified in camel case (or not) in the page generator.
+* Changed method of declaring dependencies in an attempt to fix reported
+  "could not find site generator" error which I cannot reproduce.
+* Improved documentation for generators. (Type "watircraft" or 
+  "script\generate page" to see this.)
+* You can now use the cucumber command from inside the tests/features 
+  directory (previously it would only work from project root).
+
+=== 0.3.0 / 2009-02-02
+
+Repackaged as watircraft gem version 0.3.0.
+
+Features
+
+* You can now get a list of the script/generate commands that are available to
+  you by typing "script/generate" from the root of your project. Currently these
+  are *page*, *spec* and *steps*. However, additional generators will be made 
+  available in future versions of this framework, as well as other plug-ins.
+
+Installation Instructions
+
+  gem install watircraft
+
+Update Instructions
+
+If you have a project created with a prior version of watircraft (aka taza), you
+will need to do the following.
+
+# Open a command shell to the root of your project (i.e. where you type
+  rake commands).
+# Type "watircraft . --site=your_site_name". This will add some files and
+  ask whether you want 
+  to replace several files. Say yes ('y') and replace the following files (only):
+  
+  * script/destroy
+  * script/generate
+  * feature_helper.rb
+  * spec_helper.rb
+  * world.rb
+
+User Visible Changes
+
+* Renamed gem from "taza" to "watircraft".
+* Rename "taza" command to "watircraft".
+* Removed flow generator. Plan is to use Watirloo's use case class instead.
+* Now uses rspec version 1.1.12.
+* Added Readme and History files.
+* Added initialize.rb file to test projects. This will simplify future updates.
+* The "watircraft" command now takes an option to specify a site.
+
+Technical Changes
+
+* Merged in changes from Taza 0.8.2., including
+  * Fix a bug in filters leading to infinite regress.
+* Added rake task for Manifest.txt.
+* Renamed generator_helper from taza to watircraft.
+* Removed partials. Need to review how to provide this functionality in 
+  watircraft.
+* Taza generators are now WatirCraft generators.
+* Executable version number is now automatically built from VERSION.yml.
+  (With taza, you had to maintain this by hand)
+
+Known Bugs
+
+* Need to provide homepage for project.  
+
+=== Beta 2 / 2009-01-23
+
+Fixes
+
+* Updated documentation for Taza::Page. It includes details on the element and
+  field commands.
+* Fix bug preventing the cucumber command from working. 
+
+Known Bugs
+
+* Cucumber command will only work when run from the root of the project. 
+
+Update Notes
+
+Like Beta 1, this is delivered as a gem called taza version 0.8.1. You should
+delete that one before installing this one.
+
+If you already have a project created with Beta 1, you will need to add the
+following code to the top of your lib/<project_name>.rb file:
+
+  APP_ROOT = File.expand_path(File.join(File.dirname(FILE), '..')) unless defined?(APP_ROOT)
+
+=== Beta 1 / 2009-01-14
+
+Forked from Taza 0.8.1.
+
+Summary of Features
+
+* Tests can be configured to work with different environments.
+* Rich page classes simplify tests, and make theme easier to read and maintain.
+* Support for both rspec and cucumber style tests.
+* Defined pages can be used with both rspec and cucumber tests.
+* Generate scripts create templates for pages, specs (rspec tests) and steps (for cucumber tests).
+
+Known Bugs
+
+* Support for FireWatir is incomplete (specifically: Page fields)
+* Flows are not supported.
+* Need to merge with latest version of taza/master.
+* Need to update to latest version of rspec (1.1.12)
+* Page fields do not support Radio lists.
+
+Differences from Taza/Master
+
+* Only supports a single site per project
+* Simplified directory structure
+* Added support for cucumber
+* Added spec generator (rspec).
+* Addition of Page fields.
+* Simplified config files.
+
+This version is delivered as a gem purporting to be taza version 0.8.1. This
+will be fixed in a future release.
+

data/Manifest.txt

@@ -0,0 +1,103 @@
+BUGS.txt
+History.txt
+Manifest.txt
+README.rdoc
+VERSION.yml
+watircraft.gemspec
+bin/watircraft
+lib/extensions
+lib/extensions/array.rb
+lib/extensions/hash.rb
+lib/extensions/object.rb
+lib/extensions/string.rb
+lib/extensions/watir.rb
+lib/taza
+lib/taza/browser.rb
+lib/taza/entity.rb
+lib/taza/fixture.rb
+lib/taza/flow.rb
+lib/taza/page.rb
+lib/taza/settings.rb
+lib/taza/site.rb
+lib/taza/tasks.rb
+lib/taza.rb
+lib/watircraft
+lib/watircraft/generator_helper.rb
+lib/watircraft/table.rb
+lib/watircraft/version.rb
+lib/watircraft.rb
+spec/array_spec.rb
+spec/browser_spec.rb
+spec/entity_spec.rb
+spec/fake_table.rb
+spec/fixtures_spec.rb
+spec/fixture_spec.rb
+spec/hash_spec.rb
+spec/object_spec.rb
+spec/page_generator_spec.rb
+spec/page_spec.rb
+spec/project_generator_spec.rb
+spec/sandbox
+spec/sandbox/config
+spec/sandbox/config/config.yml
+spec/sandbox/config/environments.yml
+spec/sandbox/config/simpler.yml
+spec/sandbox/config/simpler_site.yml
+spec/sandbox/config.yml
+spec/sandbox/fixtures
+spec/sandbox/fixtures/examples.yml
+spec/sandbox/fixtures/users.yml
+spec/sandbox/flows
+spec/sandbox/flows/batman.rb
+spec/sandbox/flows/robin.rb
+spec/sandbox/pages
+spec/sandbox/pages/foo
+spec/sandbox/pages/foo/bar_page.rb
+spec/sandbox/pages/foo/partials
+spec/sandbox/pages/foo/partials/partial_the_reckoning.rb
+spec/settings_spec.rb
+spec/site_generator_spec.rb
+spec/site_spec.rb
+spec/spec_generator_helper.rb
+spec/spec_generator_spec.rb
+spec/spec_helper.rb
+spec/steps_generator_spec.rb
+spec/string_spec.rb
+spec/table_spec.rb
+spec/taza_spec.rb
+spec/watircraft_bin_spec.rb
+app_generators/watircraft
+app_generators/watircraft/templates
+app_generators/watircraft/templates/config.yml.erb
+app_generators/watircraft/templates/feature_helper.rb
+app_generators/watircraft/templates/initialize.rb.erb
+app_generators/watircraft/templates/rakefile.rb
+app_generators/watircraft/templates/script
+app_generators/watircraft/templates/script/console
+app_generators/watircraft/templates/script/console.cmd
+app_generators/watircraft/templates/site_start.rb.erb
+app_generators/watircraft/templates/spec_helper.rb
+app_generators/watircraft/templates/spec_initialize.rb
+app_generators/watircraft/templates/world.rb
+app_generators/watircraft/USAGE
+app_generators/watircraft/watircraft_generator.rb
+watircraft_generators/page
+watircraft_generators/page/page_generator.rb
+watircraft_generators/page/templates
+watircraft_generators/page/templates/page.rb.erb
+watircraft_generators/page/USAGE
+watircraft_generators/site
+watircraft_generators/site/site_generator.rb
+watircraft_generators/site/templates
+watircraft_generators/site/templates/environments.yml.erb
+watircraft_generators/site/templates/site.rb.erb
+watircraft_generators/spec
+watircraft_generators/spec/spec_generator.rb
+watircraft_generators/spec/templates
+watircraft_generators/spec/templates/spec.rb.erb
+watircraft_generators/spec/USAGE
+watircraft_generators/steps
+watircraft_generators/steps/steps_generator.rb
+watircraft_generators/steps/templates
+watircraft_generators/steps/templates/steps.rb.erb
+watircraft_generators/steps/USAGE

data/README.rdoc

@@ -0,0 +1,75 @@
+= WatirCraft
+
+== DESCRIPTION
+
+WatirCraft is a testing framework that builds on Watir. 
+It allows tests to be expressed as Rspec or Cucumber tests and provides 
+a library structure to support maintainable testing. It gives you
+a place to put things.
+
+* http://testobsessed.com/2008/05/31/a-place-to-put-things/
+
+== FEATURES
+
+* Generate a directory structure for your test suite with one command.
+* Provides page adapters you can customize for your application.
+* Configure application URL and browser type (IE, Firefox) in one location.
+* Framework automatically initializes browser for testing.
+
+== APPROACH
+
+WatirCraft is an object-oriented testing framework that helps you create
+class libraries to support the tests for your application. On their own,
+many testers have created procedural libraries for testing because they
+understand these and find them easier to create and understand.
+
+Although object-oriented frameworks like WatirCraft are somewhat more difficult
+to understand at first, they are easier to customize and upgrade. As we add
+more features to the WatirCraft framework, your test suite will automatically
+get the benefit.
+
+== INSTALL
+
+* gem update --system
+* gem install watircraft
+
+== EXAMPLE
+
+An example test suite for this framework can be found in the framework 
+examples project on github. Look in the watircraft directory.
+* http://github.com/bret/framework-examples/
+
+== ORIGIN
+
+WatirCraft is based on the Taza framework. 
+* http://github.com/scudco/taza/wikis
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2008 Charley Baker
+
+Copyright (c) 2009 Charley Baker, Bret Pettichord
+
+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.
+
+
+WatirCraft is a trademark of WatirCraft LLC.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 4
+:patch: 0
+:major: 0

data/app_generators/watircraft/USAGE

@@ -0,0 +1,11 @@
+Description:
+  
+  Creates a watircraft test project. 
+  
+  To update an existing project to this version, run this command on the project.
+
+Examples:
+
+  watircraft google    # to create a new project (or update a project called google)
+  watircraft .         # to update an existing project
+  

data/app_generators/watircraft/templates/config.yml.erb

@@ -0,0 +1,3 @@
+browser:  ie
+driver:   <%= driver %>
+site:     <%= site %>

data/app_generators/watircraft/templates/feature_helper.rb

@@ -0,0 +1,12 @@
+# This file is autogenerated. Do not edit this file.
+# It may be replaced when you upgrade to new versions of watircraft.
+
+require 'rubygems'
+
+library = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+$LOAD_PATH.unshift library
+require 'initialize'
+require 'cucumber'
+
+step_libs = Dir.chdir(library) {Dir["steps/*.rb"]}
+step_libs.each {|f| require f}

data/app_generators/watircraft/templates/initialize.rb.erb

@@ -0,0 +1,10 @@
+# This file is autogenerated. Do not edit this file.
+# It may be replaced when you upgrade to new versions of watircraft.
+
+<%= "# Generated at #{Time.now}" %>
+<%= "# Generated by watircraft #{WatirCraft::VERSION}" %>
+
+ENV['ENVIRONMENT'] ||= "test"
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) unless defined?(APP_ROOT)
+
+require 'watircraft'

data/app_generators/watircraft/templates/rakefile.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'taza/tasks'
+

data/app_generators/watircraft/templates/script/console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+requires = %w(irb/completion watir/irb-history site_start pp)
+puts "Type 'irb START' at the prompt."
+exec "irb.bat -I #{APP_ROOT}/lib -r #{requires.join " -r "} --simple-prompt --readline"

data/app_generators/watircraft/templates/script/console.cmd

@@ -0,0 +1 @@
+@ruby script/console %*

data/app_generators/watircraft/templates/site_start.rb.erb

@@ -0,0 +1,12 @@
+# This file is autogenerated. Do not edit this file.
+# It may be replaced when you upgrade to new versions of watircraft.
+
+require 'initialize'
+require '<%= site %>'
+
+SITE = <%= site.camelize %>::<%= site.camelize %>.new
+at_exit {SITE.close}
+
+require 'spec/expectations'
+START = SITE.execution_context
+START.extend Spec::Expectations      

data/app_generators/watircraft/templates/spec_helper.rb

@@ -0,0 +1,9 @@
+# This file is autogenerated. Do not edit this file.
+# It may be replaced when you upgrade to new versions of watircraft.
+
+require 'rubygems'
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib/')
+require 'init/spec_initialize'
+
+

data/app_generators/watircraft/templates/spec_initialize.rb

@@ -0,0 +1,16 @@
+# This file is autogenerated. Do not edit this file.
+# It may be replaced when you upgrade to new versions of watircraft.
+
+require 'init/site_start'
+require 'spec'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+  config.before(:all) do
+    SITE.initialize_context!(self)
+  end
+  config.before(:each) do
+    SITE.initialize_context!(self)
+  end
+end

data/app_generators/watircraft/templates/world.rb

@@ -0,0 +1,12 @@
+# This file is autogenerated. Do not edit this file.
+# It may be replaced when you upgrade to new versions of watircraft.
+
+require 'spec'
+require 'cucumber'
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
+require 'init/site_start'
+
+World do
+  START
+end

data/app_generators/watircraft/watircraft_generator.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'rubigen'
+require 'extensions/string'
+require 'watircraft/version'
+
+class WatircraftGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :author => nil
+
+  attr_reader :name, :site, :driver
+
+  # so we can use the site generator
+  prepend_sources(RubiGen::GemPathSource.new([:watircraft]))
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+    @site ||= installed_site || @name
+    @site = @site.computerize
+  end
+  
+  # return the site name if we are upgrading an existing project
+  def installed_site
+    return nil unless File.exists? @destination_root + "/config/config.yml"
+    require 'taza/settings'
+    initializer = @destination_root + "/lib/initialize.rb"
+    load initializer if File.exists? initializer
+    Taza::Settings.path = @destination_root
+    Taza::Settings.config[:site]
+  end
+
+  def manifest
+    record do |m|    
+      @@new_directories.each { |path| m.directory path }
+
+      m.file "rakefile.rb", "rakefile", :collision => :force
+      m.template "config.yml.erb", "config/config.yml", :collision => :skip
+
+      m.file "spec_helper.rb", "test/specs/spec_helper.rb", :collision => :force
+      m.file "feature_helper.rb", "test/features/feature_helper.rb", :collision => :force
+
+      m.template "initialize.rb.erb", "lib/initialize.rb", :collision => :ask
+      m.file "spec_initialize.rb", "lib/init/spec_initialize.rb", :collision => :force
+      m.file "world.rb", "lib/steps/world.rb", :collision => :force
+      m.template "site_start.rb.erb", "lib/init/site_start.rb", :collision => :force
+      
+      m.file_copy_each ["console", "console.cmd"], "script", :collision => :force 
+
+      m.dependency "install_rubigen_scripts", [destination_root, 'watircraft'],
+        :shebang => options[:shebang], :collision => :ask
+      m.dependency "site", [@site], :destination => destination_root
+    end
+  end
+
+  @@new_directories =
+    %w(
+      config
+      script
+      lib
+      lib/init
+      lib/pages
+      lib/steps
+      test
+      test/specs
+      test/features
+    )  
+  
+  protected
+    def banner
+      <<-EOS
+USAGE: #{spec.name} project_name [options]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+      opts.on("--site=SITE", String, 
+        "Name of the Site for the project.",
+        "Default: existing site (if updating) or project_name."
+        ) { |v| options[:site] = v }
+      opts.on("--driver=DRIVER", String,
+        "Name of the browser driver for the project.",
+        "Default: watir."
+        ) { |v| options[:driver] = v }
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+      @site = options[:site]
+      @driver = options[:driver] || :watir
+    end
+
+end

data/bin/watircraft

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'watircraft'
+  puts "#{File.basename($0)} #{WatirCraft::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source = RubiGen::PathSource.new(:application, 
+  File.join(File.dirname(__FILE__), "../app_generators"))
+RubiGen::Base.reset_sources
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'watircraft')

data/lib/extensions/array.rb

@@ -0,0 +1,10 @@
+class Array
+  # Returns true if the two arrays elements are equal ignoring order
+  # Example:
+  #  [1,2].equivalent([2,1])    # => true
+  #  [1,2,3].equivalent([2,1])  # => false
+  def equivalent?(other_array)
+    merged_array = self & other_array
+    merged_array.size == self.size && merged_array.size == other_array.size
+  end
+end

data/lib/extensions/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def convert_hash_keys_to_methods(fixture) # :nodoc:
+    Taza::Entity.new(self,fixture)
+  end
+end