browsercuke 0.1.1 → 0.1.2

data/History.txt

@@ -0,0 +1,15 @@
+=== 0.1.2 / 2010-01-07
+
+* Reformatted license
+* Added instructions for creating new releases to the README.md
+* Removed the broken and unnecessary browsercuke-setup CLI tool
+* Fixed browsercuke & sapphirecuke CLI tools to be written in ruby (necessary for them to work).
+* Moved version number to a better location.  The existence of the lib/ directory makes Hoe run better.
+
+=== 0.1.1 / 2010-01-07
+
+* BUGFIX: Fixed problems with gem dependencies
+
+=== 0.1.0 / 2010-01-07
+
+* Initial release as a rubygem

data/README.md

@@ -1,8 +1,8 @@
-= BrowserCuke
+# BrowserCuke
 
 http://github.com/sminnee/browsercuke
 
-== DESCRIPTION:
+## DESCRIPTION:
 
 BrowserCuke is a layer of browser-based testing on top of Cucumber.  It provides an intuitive way of
 writing business-readable tests for your web applications, that use real web browsers to test.  Your
@@ -14,7 +14,7 @@ For more information about Cucumber, see [the cucumber website](http://cukes.inf
 BrowserCuke currently uses Watir to perform the browser automation, although it may be extended in 
 the future to use something like WebRat to test applications sans-JavaScript.
 
-== FEATURES
+## FEATURES
 
  * Tests Safari and Firefox
  * Looks for page elements like a human would: e.g. ignores hidden elements, and you can use form element labels as identifiers.
@@ -37,29 +37,30 @@ Roadmap:
  * Add tests for colour and image changes
  * Get the FireWatir and SafariWatir monkey patches submitted to those upstream projects.
 
-== INSTALL:
+## INSTALL:
 
 BrowserCuke is packaged as a gem, so the easiest way of installing BrowserCuke is by running this
 command:
 
-  $ gem install browsercuke
+    $ gem install browsercuke
 
-After you have installed the gem, you should run this command to set up your browsers properly:
+You will also need to make some changes on your system to get the browser
 
-  $ browsercuke-setup
+ * Safari: Go to System Prefences -> Universal Access and check the box labelled 'Enable access for assistive devices'
+ * Firefox: Install the JSSH extension.  You can download it here:
+   * [OS X + FF 3.5](http://wiki.openqa.org/download/attachments/13893658/jssh-3.5.x-Darwin-param.xpi)
 
-== SYNOPSIS:
+## SYNOPSIS:
 
 Run something like this to execute a test freature.
 
    browsercuke http://localhost/yoursite create-page.feature
 
-=== Using BrowserCuke to run tests from another project
+### Using BrowserCuke to run tests from another project
 
 BrowserCuke doesn't come bundled with any actual tests, so usually you have to write tests as part
 of your project.
 
-
 This example runs a copy of BrowserCuke installed in ~/browsercuke to execute the features 
 contained in a Sapphire project.  `sake SapphireURL/baseurl` return the URL of the current Sapphire
 project.
@@ -67,11 +68,12 @@ project.
     browsercuke firefox `sake SapphireInfo/baseurl` */tests/cuke/*.feature
 
 Because BrowserCuke was written in order to support testing of Sapphire projects, we have a special
-script for this particular example.  This will probably go away as BrowserCuke matures
+script for this particular example.  This will probably be merged into Sapphire as BrowserCuke
+matures.
 
     sapphirecuke firefox
 
-=== Rules
+### Rules
 
 Please see [the cucumber website](http://cukes.info) for information about the exact cucumber 
 syntax.
@@ -179,7 +181,7 @@ Misc
 
 ### I put "(text)" in pop-ups
 
-== REQUIREMENTS:
+## REQUIREMENTS:
 
 Currently browsercuke works with the following browsers.
 
@@ -188,32 +190,48 @@ Currently browsercuke works with the following browsers.
 
 It has been tested on OS X only; Windows and IE support coming soon!
 
-== DEVELOPERS:
+## DEVELOPERS:
 
 After checking out the source, run:
 
-  $ rake newb
+    $ rake newb
 
 This task will install any missing dependencies, run the tests/specs,
 and generate the RDoc.
 
-== LICENSE:
+To create a new release of the gem, to the following:
+
+ * Update the version number in lib/browsercuke.rb
+ * Rebuild the manifest.  If it fails initially, create a manifest containaining only 
+   `lib/browsercuke.rb` and re-execute.
+
+         rake git:manifest
+
+ * Call `rake git:changelog` and put the result at the top of History.txt, with the appropriate
+   version number
+ * Commit the changes to lib/browsercuke.rb and History.txt with commit message like "Created vX.Y.Z"
+ * Package the gem and release it to Gemcutter
+
+         rake publish
+
+## LICENSE:
 
 Browsercuke is licensed under the BSD license
 
-Copyright (c) 2009, Sam Minnée
+Copyright (c) 2009, Sam Minnée  
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of the <organization> nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
+
+ * Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+ * Neither the name of the <organization> nor the
+   names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :git
+
+Hoe.spec 'browsercuke' do
+  self.readme_file = 'README.md'
+
+  developer('Sam Minnée', 'sam@silverstripe.com')
+  
+  extra_deps << ['cucumber', '>= 0.4.4']
+  extra_deps << ['firewatir', '>= 1.6.5']
+  extra_deps << ['safariwatir', '>= 0.3.7']
+  extra_deps << ['rb-appscript', '>= 0.5.3']
+end

data/bin/browsercuke

@@ -1,6 +1,10 @@
-#!/usr/bin/env bash
-if [ "$2" = "" ]; then
-	echo "Usage: $0 (browser) (url) (feature-file) (other cucumber args)
+#!/usr/bin/env ruby
+
+require 'ftools'
+require 'rubygems'
+
+if ARGV.count < 2 then
+	puts "Usage: $0 (browser) (url) (feature-file) (other cucumber args)
 	
 Run the given feature file using the URL has the test site, on the given browser.
 
@@ -10,20 +14,33 @@ Supported browsers:
 
 "
 	exit 1
-fi
+end
 
-basedir=`dirname $0`
+# Build list of step def -r arguments
+baseDir = File.dirname(File.dirname(__FILE__))
+stepDefArgs = ['-r', baseDir + '/support', '-r', baseDir + '/step_definitions']
 
-export BROWSERSALAD_BROWSER=$1
-export BROWSERSALAD_URL=$2
+# Special case for Sapphire applications - collect all the step_definitions from the modules
+if File.exist?('sapphire/tests/cuke') then
+  dirs = Dir.entries(".")
+	dirs.each do | item |
+		if File.exist?(item + '/tests/cuke') then
+			stepDefArgs << "-r"
+			stepDefArgs << item + '/tests/cuke'
+		end
+	end
+end
 
+# Pass data along to cucumber
+extraArgs = ARGV.dup
+ENV['BROWSERSALAD_BROWSER'] = extraArgs.shift
+ENV['BROWSERSALAD_URL'] = extraArgs.shift
 
-# Special case for Sapphire applications - collect all the step_definitions from the modules
-if [ -d sapphire/tests/cuke ]; then
-	for file in `ls -1d */tests/cuke/step_definitions`; do
-		extras="$extras -r $file"
-	done
-fi
-
-echo "cucumber -r $basedir/support -r $basedir/step_definitions $extras $3 $4 $5 $6 $7 $8 $9"
-cucumber -r $basedir/support -r $basedir/step_definitions $extras $3 $4 $5 $6 $7 $8 $9
+# We can't reassign ARGV but we can manipulate its contents
+ARGV.clear
+(stepDefArgs+extraArgs).each do |arg|
+  ARGV.push arg
+end
+
+# Call cucumber
+load Gem.bin_path('cucumber', 'cucumber', ">= 0")

data/bin/sapphirecuke

@@ -1,16 +1,26 @@
-#!/usr/bin/env bash
-if [ "$1" = "" ]; then
-	echo "Usage: $0 (browser)
+#!/usr/bin/env ruby
+if ARGV.count < 1 then
+	puts "Usage: $0 (browser)
 "
 	exit 1
-fi
+end
 
-if [ ! -f sapphire/main.php ]; then
-	echo "Please run $0 from within your sapphire project root.
+if not File.exist?('sapphire/main.php') then
+	puts "Please run $0 from within your sapphire project root.
 I couldn't find ./sapphire/main.php.
 "
 	exit 2
-fi
+end
 
-dirname=`dirname $0`
-$dirname/browsercuke $1 `./sapphire/sake SapphireInfo/baseurl` */tests/cuke/*.feature
+# We can't reassign ARGV but we can manipulate its contents
+browser = ARGV[1]
+baseURL = `php ./sapphire/cli-script.php SapphireInfo/baseurl`
+features = "*/tests/cuke/*.feature"
+
+ARGV.clear
+ARGV << browser
+ARGV << baseURL
+ARGV << features
+
+# Call browsercuke
+load File.dirname(__FILE__) + '/browsercuke'

data/lib/browsercuke.rb

@@ -0,0 +1,7 @@
+# This is a stub class for defining the version
+# In time, the non-Watir ruby code that the step definitions make use of can be moved into this.
+module BrowserCuke
+  class BrowserCuke
+    VERSION = "0.1.2"
+  end
+end

data/support/env.rb

@@ -1,6 +1,4 @@
 require 'spec'
-VERSION = "0.1.1"
-
 
 $killFF = false
  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: browsercuke
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - "Sam Minn\xC3\xA9e"
@@ -76,18 +76,19 @@ email:
 - sam@silverstripe.com
 executables: 
 - browsercuke
-- browsercuke-setup
 - sapphirecuke
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- History.txt
 files: 
 - .gitignore
+- History.txt
 - README.md
+- Rakefile
 - bin/browsercuke
-- bin/browsercuke-setup
 - bin/sapphirecuke
+- lib/browsercuke.rb
 - step_definitions/browser/README.md
 - step_definitions/browser/ajax.rb
 - step_definitions/browser/buttons.rb

data/bin/browsercuke-setup

@@ -1,31 +0,0 @@
-#!/usr/bin/env bash
-echo "Browsercuke OS X installer
-===========================
-"
-
-ffbin=/Applications/Firefox.app/Contents/MacOS/firefox-bin
-
-
-if [ ! -f jssh-3.5.x-Darwin-param.xpi ]; then
-	echo "> Downloading Firefox 3.5 JSSH plugin"
-	wget http://wiki.openqa.org/download/attachments/13893658/jssh-3.5.x-Darwin-param.xpi
-fi
-
-echo "> Installing Firefox 3.5 JSSH plugin"
-open ./jssh-3.5.x-Darwin-param.xpi
-
-echo "> Please go to System Prefences -> Universal Access and check the box labelled 'Enable access for assistive devices'
-
-When you're done, press enter to continue."
-
-read -s -n1
-
-echo "
-Done!
-
-You should be able to run one of these commands now:
-
-browsercuke firefox http://localhost/yourtestsite create-page.feature
-browsercuke safari http://localhost/yourtestsite create-page.feature
-
-"