kelp 0.1.1

data/docs/development.rst

@@ -0,0 +1,27 @@
+Development
+===========
+
+If you'd like to hack on Kelp, fork the repository, then clone your fork::
+
+    $ git clone git://github.com/<your_username>/kelp.git
+
+Install bundler_::
+
+    $ gem install bundler
+
+Then install Kelp's dependencies (specified in ``Gemfile``)::
+
+    $ cd /path/to/kelp
+    $ bundle install
+
+It's a good idea to use RVM_ with a new gemset to keep things tidy.
+
+If you make changes that you'd like to share, push them into your Kelp fork,
+then `submit a pull request`_.
+
+
+.. _bundler: http://gembundler.com/
+.. _RVM: http://rvm.beginrescueend.com/
+.. _submit a pull request: http://github.com/wapcaplet/kelp/pulls
+
+

data/docs/future.rst

@@ -0,0 +1,9 @@
+Future plans
+============
+
+* Write Cucumber integration tests
+* Support other stuff besides Caypbara
+* Turn the project into a proper Rails plugin, with generators
+* Create a gem
+
+

data/docs/index.rst

@@ -0,0 +1,33 @@
+.. Kelp documentation master file, created by
+   sphinx-quickstart on Sun Dec 12 16:07:03 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Kelp
+====
+
+This is the documentation for Kelp_, a collection of helpers that makes it
+easier to write step definitions for Cucumber_. The Kelp gem is hosted on
+Rubygems_, so you can install it with::
+
+    $ gem install kelp
+
+The name "Kelp" is a contraction of "Cuke Helpers". It was chosen because it's
+short, easy to remember, and is in keeping with the theme of greenish plants.
+Kelp is licensed under the `MIT License`_.
+
+Please use the `issue tracker`_ to report any bugs or feature requests.
+
+.. toctree::
+    :maxdepth: 2
+
+    usage
+    development
+    testing
+    future
+
+.. _Kelp: http://github.com/wapcaplet/kelp
+.. _Cucumber: http://cukes.info/
+.. _Rubygems: http://rubygems.org/gems/kelp
+.. _MIT License: http://www.opensource.org/licenses/mit-license.php
+.. _issue tracker: http://github.com/wapcaplet/kelp/issues

data/docs/make.bat

@@ -0,0 +1,155 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Kelp.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Kelp.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end

data/docs/testing.rst

@@ -0,0 +1,15 @@
+Testing
+=======
+
+Kelp comes with a ``Rakefile``, so you can run the RSpec tests like so::
+
+    $ rake spec
+
+You can also generate an rcov_ coverage report via::
+
+    $ rake rcov
+
+This will write an HTML report to ``coverage/index.html``.
+
+.. _rcov: http://eigenclass.org/hiki.rb?rcov
+

data/docs/usage.rst

@@ -0,0 +1,85 @@
+Usage
+=====
+
+To use Kelp's helpers in your Cucumber step definitions, simply ``require`` the
+helper module you're interested in:
+
+.. code-block:: ruby
+
+    require 'kelp/capybara/web_helper'
+
+Then add the relevant modules to Cucumber's ``World``:
+
+.. code-block:: ruby
+
+    World(WebHelper)
+
+Many of the provided helpers are designed to make it easier to do things you
+might otherwise be tempted to do with nested step definitions. For example, if
+you need to verify the presence of several text strings on a webpage, you might
+have a step definition like this:
+
+.. code-block:: ruby
+
+    Then /^I should see the login page$/ do
+      Then %{I should see "Welcome"}
+      And %{I should see "Thanks for visiting"}
+      And %{I should see "Login"}
+    end
+
+Using the provided helper method ``should_see``, you can do this instead:
+
+.. code-block:: ruby
+
+    Then /^I should see the login page$/ do
+      should_see "Welcome"
+      should_see "Thanks for visiting"
+      should_see "Login"
+    end
+
+Or even this:
+
+.. code-block:: ruby
+
+    Then /^I should see the login page$/ do
+      should_see [
+        "Welcome",
+        "Thanks for visiting",
+        "Login"
+      ]
+    end
+
+Many of the provided methods are similar to their counterparts in the
+Cucumber-Rails generated step definitions. Following links, filling in fields,
+and pressing buttons can all be easily done with Ruby code instead of nested
+steps. Thus this:
+
+.. code-block:: ruby
+
+    When %{I follow "Login"}
+    And %{I fill in "Username" with "skroob"}
+    And %{I fill in "Password" with "12345"}
+    And %{I press "Log me in"}
+
+translates to this:
+
+.. code-block:: ruby
+
+    follow "Login"
+    fill_in_fields \
+      "Username" => "skroob",
+      "Password" => "12345"
+    press "Log me in"
+
+Several methods also accept keywords to define the scope of an action. For
+instance, if you want to look within an element with ``id="greeting"``, do:
+
+.. code-block:: ruby
+
+    should_see "Welcome", :within => "#greeting"
+
+At the moment, the ``:within`` keyword is the only accepted scope; the locator
+you pass to this should be in whatever format your ``Capybara.default_selector``
+is set to. Other keywords like ``:before`` or ``:after`` may be supported in future
+revisions.
+

data/kelp.gemspec

@@ -0,0 +1,25 @@
+
+
+Gem::Specification.new do |s|
+  s.name = "kelp"
+  s.version = "0.1.1"
+  s.summary = "Cucumber helper methods"
+  s.description = <<-EOS
+    Kelp is a collection of helper methods for Cucumber to ease the process of
+    writing step definitions.
+  EOS
+  s.authors = ["Eric Pierce"]
+  s.email = "wapcaplet88@gmail.com"
+  s.homepage = "http://github.com/wapcaplet/kelp"
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'capybara', '>= 0.4.0'
+
+  s.add_development_dependency 'sinatra'
+  s.add_development_dependency 'rspec', '>= 2.2.0'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rcov'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

data/lib/kelp.rb

@@ -0,0 +1 @@
+require 'kelp/capybara'

data/lib/kelp/capybara.rb

@@ -0,0 +1,2 @@
+require 'kelp/capybara/web_helper'
+require 'kelp/capybara/form_helper'

data/lib/kelp/capybara/capybara_steps.rb

@@ -0,0 +1,225 @@
+# <%= embed_file('support/edit_warning.txt') %>
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(locator) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"(?: within "([^"]*)")?$/ do |button, selector|
+  press button, :within => selector
+  #with_scope(selector) do
+    #click_button(button)
+  #end
+end
+
+When /^(?:|I )follow "([^"]*)"(?: within "([^"]*)")?$/ do |link, selector|
+  follow link, :within => selector
+  #with_scope(selector) do
+    #click_link(link)
+  #end
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"(?: within "([^"]*)")?$/ do |field, value, selector|
+  fields = {field => value}
+  fill_in_fields fields, :within => selector
+  #with_scope(selector) do
+    #fill_in(field, :with => value)
+  #end
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"(?: within "([^"]*)")?$/ do |value, field, selector|
+  fields = {field => value}
+  fill_in_fields fields, :within => selector
+  #with_scope(selector) do
+    #fill_in(field, :with => value)
+  #end
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following(?: within "([^"]*)")?:$/ do |selector, fields|
+  fill_in_fields fields.rows_hash, :within => selector
+  #with_scope(selector) do
+    #fields.rows_hash.each do |name, value|
+      #When %{I fill in "#{name}" with "#{value}"}
+    #end
+  #end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"(?: within "([^"]*)")?$/ do |value, field, selector|
+  with_scope(selector) do
+    select(value, :from => field)
+  end
+end
+
+When /^(?:|I )check "([^"]*)"(?: within "([^"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    check(field)
+  end
+end
+
+When /^(?:|I )uncheck "([^"]*)"(?: within "([^"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    uncheck(field)
+  end
+end
+
+When /^(?:|I )choose "([^"]*)"(?: within "([^"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    choose(field)
+  end
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"(?: within "([^"]*)")?$/ do |path, field, selector|
+  with_scope(selector) do
+    attach_file(field, path)
+  end
+end
+
+Then /^(?:|I )should see JSON:$/ do |expected_json|
+  require 'json'
+  expected = JSON.pretty_generate(JSON.parse(expected_json))
+  actual   = JSON.pretty_generate(JSON.parse(response.body))
+  expected.should == actual
+end
+
+Then /^(?:|I )should see "([^"]*)"(?: within "([^"]*)")?$/ do |text, selector|
+  should_see text, :within => selector
+  #with_scope(selector) do
+    #if page.respond_to? :should
+      #page.should have_content(text)
+    #else
+      #assert page.has_content?(text)
+    #end
+  #end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/(?: within "([^"]*)")?$/ do |regexp, selector|
+  should_see Regexp.new(regexp), :within => selector
+  #regexp = Regexp.new(regexp)
+  #with_scope(selector) do
+    #if page.respond_to? :should
+      #page.should have_xpath('//*', :text => regexp)
+    #else
+      #assert page.has_xpath?('//*', :text => regexp)
+    #end
+  #end
+end
+
+Then /^(?:|I )should not see "([^"]*)"(?: within "([^"]*)")?$/ do |text, selector|
+  should_not_see text, :within => selector
+  #with_scope(selector) do
+    #if page.respond_to? :should
+      #page.should have_no_content(text)
+    #else
+      #assert page.has_no_content?(text)
+    #end
+  #end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/(?: within "([^"]*)")?$/ do |regexp, selector|
+  should_not_see Regexp.new(regexp), :within => selector
+  #regexp = Regexp.new(regexp)
+  #with_scope(selector) do
+    #if page.respond_to? :should
+      #page.should have_no_xpath('//*', :text => regexp)
+    #else
+      #assert page.has_no_xpath?('//*', :text => regexp)
+    #end
+  #end
+end
+
+Then /^the "([^"]*)" field(?: within "([^"]*)")? should contain "([^"]*)"$/ do |field, selector, value|
+  with_scope(selector) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within "([^"]*)")? should not contain "([^"]*)"$/ do |field, selector, value|
+  with_scope(selector) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within "([^"]*)")? should be checked$/ do |label, selector|
+  with_scope(selector) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within "([^"]*)")? should not be checked$/ do |label, selector|
+  with_scope(selector) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
+
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end