cucumber-farmer 1.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,34 @@
+##BUNDLER
+.bundle/
+
+## EMACS
+*~
+\#*
+
+## MAC OS
+.DS_Store
+
+## RUBYMINE
+.idea
+.\#*
+
+## RVM
+.rvmrc
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+## DOCS
+doc/
+.yardoc/

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem 'bundler', '~> 1.0'
+
+gem 'mattscilipoti-rdialog', '~> 0.6.1'
+
+group :test do
+  gem 'cucumber', '~> 0.6'
+  gem 'shoulda',  '~> 2.10'
+  gem 'sinatra',  '= 1.0'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Scilipoti
+
+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.

data/README.rdoc

@@ -0,0 +1,80 @@
+= farmer
+
+A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.
+
+== Why?
+Some requirements are simple for a human to confirm, but are very difficult to assert using automation.
+Farmer allows us to include human confirmation into our normal testing flow.
+For example, we needed to verify that certain portions of an image were 'blacked out'.
+
+== What?
+Farmer utilizes rdialog to allow you to:
+* Present messages
+* Display files
+* Ask a human for confirmation
+
+== Example
+    When I display the message "Please review the following images.  \nEnsure 'Frame' and 'Speed Data' items are hidden."
+    And I display these Files:
+      |filename|
+      |images/processed_a.jpg|
+      |images/processed_b.jpg|
+
+    Then I should say "'Frame' item is hidden in all images"
+    Then I should say "'Speed Data' item is hidden in all images"
+
+This will:
+* Display an info box to the user, informing them of the upcoming test, then...
+* Open a new page in firefox to display the named files (in tabs).
+* Once the user closes all the tabs, confirmation dialogs will be displayed.
+
+== Installation
+  $ apt-get install dialog
+  $ gem install farmer
+
+In features/support/env.rb:
+  require 'farmer/step_definitions'
+
+== Test
+Two levels of testing are required.  Library testing and 'usage as a gem' testing.
+==== Usage as gem:
+A (sinatra) test app is included, containing some acceptance tests.
+Interestingly, these tests ask you to verify farmer's functionality.
+
+  cd test_app
+  cucumber
+
+==== Test the library:
+This library was extracted from an existing app.
+It was created test-first (mostly), but extracting the tests is harder than extracting code.
+Test are added regularly.
+  rake
+
+== Questions?
+* Check out step_definitions/dialog_steps.
+
+== Issues?
+* Create an issue on github (http://github.com/mattscilipoti/farmer/issues???)
+
+== TODO:
+* expand test coverage to unit tests
+* add step_definitions to rdoc.
+* utilize pickle foundation.
+* make dialog timeout configurable.
+* namespace
+
+== Note on Patches/Pull Requests
+* Fork the project.
+* Since you will probably want to utilize your own copy, while waiting for upstream to include your pull request,
+  I recommend creating a branch named 'upstream'.
+* Make your changes in a topic and merge them into 'master' and 'upstream'.
+  This way, 'master' can have your readme, version, etc.
+* Please, do not mess with rakefile or version files in the 'upstream' branch.
+* Add tests for it. This is important.  I don't want break it in a
+  future version unintentionally.
+* Commit.
+* Send me a pull request from 'upstream' or the topic branch.
+
+== Copyright
+
+Copyright (c) 2010 Matt Scilipoti. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cucumber-farmer"
+    gem.summary = 'A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.'
+    gem.description = %Q{A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.
+      Some requirements are simple for a human to confirm, but are very difficult to assert using automation.
+      Farmer allows us to include human confirmation into our normal testing flow.
+      For example, we needed to verify that certain portions of an image were 'blacked out'.
+    }
+    gem.email = "matt@scilipoti.name"
+    gem.homepage = "http://github.com/mattscilipoti/farmer"
+    gem.authors = ["Matt Scilipoti"]
+    gem.add_dependency('mattscilipoti-rdialog', '0.6.1')
+    gem.add_development_dependency "cucumber", ">= 0.6"
+    gem.add_development_dependency "shoulda", ">= 2.10"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "farmer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/cucumber-farmer.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cucumber-farmer}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Scilipoti"]
+  s.date = %q{2010-08-26}
+  s.description = %q{A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.
+      Some requirements are simple for a human to confirm, but are very difficult to assert using automation.
+      Farmer allows us to include human confirmation into our normal testing flow.
+      For example, we needed to verify that certain portions of an image were 'blacked out'.
+    }
+  s.email = %q{matt@scilipoti.name}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cucumber-farmer.gemspec",
+     "lib/farmer.rb",
+     "lib/farmer/step_definitions.rb",
+     "test/helper.rb",
+     "test_app/features/home_page.feature",
+     "test_app/features/human_confirmation.feature",
+     "test_app/features/step_definitions/web_steps.rb",
+     "test_app/features/support/env.rb",
+     "test_app/test_app.rb"
+  ]
+  s.homepage = %q{http://github.com/mattscilipoti/farmer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.}
+  s.test_files = [
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mattscilipoti-rdialog>, ["= 0.6.1"])
+      s.add_development_dependency(%q<cucumber>, [">= 0.6"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.10"])
+    else
+      s.add_dependency(%q<mattscilipoti-rdialog>, ["= 0.6.1"])
+      s.add_dependency(%q<cucumber>, [">= 0.6"])
+      s.add_dependency(%q<shoulda>, [">= 2.10"])
+    end
+  else
+    s.add_dependency(%q<mattscilipoti-rdialog>, ["= 0.6.1"])
+    s.add_dependency(%q<cucumber>, [">= 0.6"])
+    s.add_dependency(%q<shoulda>, [">= 2.10"])
+  end
+end
+

data/lib/farmer/step_definitions.rb

@@ -0,0 +1,84 @@
+begin
+  gem 'mattscilipoti-rdialog', '>=0.5.0'
+  require 'mattscilipoti-rdialog'
+rescue LoadError
+  puts "REQUIRED: dialog & rdialog are required.\n  `sudo apt-get install dialog`\n  `gem install mattscilipoti-rdialog`"
+  exit
+end
+
+#  When I display the message "message goes here"'
+#Displays info box containing the message
+When /^I display the message "([^\"]*)"$/ do |message|
+  dialog = RDialog.new
+  dialog.infobox(message)
+end
+
+When /^I display these Files:$/ do |table|
+  files = table.rows.collect { |row| row[0] }
+
+  view_in_firefox(*files)
+end
+
+def dialog_timeout
+  5 #seconds
+end
+
+#  Then I should say "confirmation request goes here"'
+#Displays a dialog box containing the message
+#User response is used to pass/fail the test
+#Cancel/No fails test
+Then /^I should say "([^\"]*)"$/ do |question|
+  response = nil
+  dialog = RDialog.new
+  dialog.timeout = dialog_timeout
+  msg = %Q{#{question}?
+
+  This dialog will timeout after #{dialog_timeout} secs.}
+  response = dialog.yesno(question + '?')
+
+  response.should be_true
+end
+
+#  Given these warnings are displayed:
+#    |dialog |
+#    |firefox|
+# Displays named warnings to humans.
+# dialog: inform them that their input will be requested
+# firefox: specifies firefox requirements.
+Given /^(?:these warnings are|this warning is) displayed:$/ do |table|
+  table.raw.flatten.inject(warnings = []) do |warning_messages, warning_name|
+    msg = warning_for(warning_name)
+    warning_messages << msg
+  end
+
+  dialog = RDialog.new
+  dialog.timeout = 30 #seconds
+  dialog.msgbox(warnings.join('\n--------------------------\n'))
+end
+
+def dialog_warning
+  <<WARN
+Dialog Warning: Some of these scenarios will ask you to manually verify steps.
+Yes/No dialogs will timeout after #{dialog_timeout} secs.
+
+test
+WARN
+end
+
+def firefox_warning
+  <<WARN
+Firefox Notice: profile 'cucumber' expected.\n
+If this profile doesn't exist, ProfileManager will automatically be displayed so you can add it (or use 'firefox -ProfileManager')
+To ensure tests wait until Firefox is closed, please ensure ALL instances of Firefox using the 'cu Profile are closed.
+You can leave instances from other profiles open.
+WARN
+end
+
+def view_in_firefox(*files)
+  file_args = files.join(' ')
+  `firefox -P cucumber -no-remote #{file_args}`
+end
+
+def warning_for(identifier)
+  send("#{identifier.to_s}_warning")
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'farmer'
+
+class Test::Unit::TestCase
+end

data/test_app/features/home_page.feature

@@ -0,0 +1,5 @@
+Feature : Home Page experience
+
+Scenario: See hello world
+  When I visit the home page
+  Then I should see "Hello World"

data/test_app/features/human_confirmation.feature

@@ -0,0 +1,27 @@
+Feature: Humans can confirm test results
+
+  In order to ensure that humans can be utilized and incorporated into acceptance testing flow
+  As a human tester
+  I want be able to receive information and provide feedback
+  
+  Scenario: Basic Yes/No Dialog
+    Then I should say "I can see a yes/no dialog box"
+  
+  Scenario: Info Box
+    When I display the message "TEST MESSAGE.  Please close me."
+    Then I should say "I saw the 'TEST MESSAGE'"
+    
+  Scenario: Single Warning (dialog)
+    Given this warning is displayed:
+      |dialog|
+
+    Then I should say "I am aware that dialogs will used for manual verification" 
+    
+  Scenario: Multiple warnings (dialog & firefox)
+    Given these warnings are displayed:
+      |dialog|
+      |firefox|
+
+    Then I should say "I am aware that dialogs will used for manual verification" 
+    Then I should say "I saw an informational warning about firefox requirements" 
+  

data/test_app/features/step_definitions/web_steps.rb

@@ -0,0 +1,7 @@
+When /^I visit the home page$/ do
+  visit '/'
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  assert_contain text
+end

data/test_app/features/support/env.rb

@@ -0,0 +1,39 @@
+# See http://wiki.github.com/aslakhellesoy/cucumber/sinatra
+# for more details about Sinatra with Cucumber
+
+app_file = File.expand_path('../../test_app', File.dirname(__FILE__))
+require app_file
+
+# Force the application name because polyglot breaks the auto-detection logic.
+Sinatra::Application.app_file = app_file
+
+gem 'rack-test', '>=0.5.0'
+require 'test/unit/assertions'
+require 'rack/test'
+require 'webrat'
+
+Webrat.configure do |config|
+  config.mode = :rack
+end
+
+class TestAppWorld
+  include Test::Unit::Assertions
+  include Rack::Test::Methods
+  include Webrat::Methods
+  include Webrat::Matchers
+  # Webrat::Methods.delegate_to_session :response_code, :response_body
+
+  def app
+    Sinatra::Application
+  end
+end
+
+#add farmer lib to load path (like gem command would do)
+farmer_lib_path = File.expand_path('../../../lib/', File.dirname(__FILE__))
+$LOAD_PATH.unshift farmer_lib_path
+
+#>>>>>>>> Adding farmer steps here >>>>>>>>>>>>>>>>>
+require 'farmer/step_definitions'
+#<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+
+World { TestAppWorld.new }

data/test_app/test_app.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+gem 'sinatra', '=1.0'
+require 'sinatra'
+get '/' do
+  'Hello World'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: cucumber-farmer
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Matt Scilipoti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mattscilipoti-rdialog
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 10
+        version: "2.10"
+  type: :development
+  version_requirements: *id003
+description: "A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.\n      Some requirements are simple for a human to confirm, but are very difficult to assert using automation.\n      Farmer allows us to include human confirmation into our normal testing flow.\n      For example, we needed to verify that certain portions of an image were 'blacked out'.\n    "
+email: matt@scilipoti.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cucumber-farmer.gemspec
+- lib/farmer.rb
+- lib/farmer/step_definitions.rb
+- test/helper.rb
+- test_app/features/home_page.feature
+- test_app/features/human_confirmation.feature
+- test_app/features/step_definitions/web_steps.rb
+- test_app/features/support/env.rb
+- test_app/test_app.rb
+has_rdoc: true
+homepage: http://github.com/mattscilipoti/farmer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library of cucumber step definitions, which allow you to use a human to assert conditions during acceptance tests.
+test_files: 
+- test/helper.rb