send-keys 0.1.0

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "send-keys"
+    s.summary = "Simulate key presses in your capybara tests"
+    s.email = "mark@aussiev8.com.au"
+    s.homepage = "http://github.com/markgandolfo/send-keys"
+    s.description = "Provides cucumber steps and methods to send key presses to DOM Elements with your Capybara tests."
+    s.authors = ["Mark Gandolfo"]
+    s.files = FileList["[A-Z]*", "{lib}/**/*"]
+    s.files.exclude('*.komodoproject')
+    
+    s.add_dependency 'capybara'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/send-keys.rb

@@ -0,0 +1,2 @@
+require 'send-keys/support/send_keys'
+require 'send-keys/step_definitions/send_keys_steps'

data/lib/send-keys/step_definitions/send_keys_steps.rb

@@ -0,0 +1,12 @@
+## Possible Keys
+# :null, :cancel, :help, :backspace, :tab, :clear, :return, :enter, :shift, :left_shift, :control, :left_control :alt, :left_alt, :pause,
+# :escape, :space:page_up, :page_down, :end, :home, :left, :arrow_left, :up:arrow_up, :right, :arrow_right:down, :arrow_down, :insert,
+# :delete, :semicolon, :equals, :numpad0, :numpad1, :numpad2, :numpad3, :numpad4, :numpad5, :numpad6, :numpad7, :numpad8, :numpad9,
+# :multiply, :add, :separator, :subtract, :decimal, :divide
+#
+
+# And I send "hello" to "#element"
+# And /^I send (#{allowed_keys.join('|')}) to "([^\"]*)"$/ do |key, element|
+And /^I send (.*) to "(.*)"$/ do |key, element|
+  find(element).send_string_of_keys(key)
+end

data/lib/send-keys/support/send_keys.rb

@@ -0,0 +1,69 @@
+module SendKeys
+  def allowed_keys
+    @allowed_keys ||= %w(
+      option
+      null
+      cancel
+      help
+      backspace
+      tab
+      clear
+      return
+      enter
+      shift
+      left_shift
+      control
+      left_control
+      alt
+      left_alt
+      pause
+      escape
+      space
+      page_up
+      page_down
+      end
+      home
+      left
+      arrow_left
+      uparrow_up
+      right
+      arrow_rightdown
+      arrow_down
+      insert
+      delete
+      semicolon
+      equals
+      numpad0 numpad1 numpad2 numpad3 numpad4 numpad5 numpad6 numpad7 numpad8 numpad9
+      multiplyadd
+      separator
+      subtract
+      decimal
+      divide
+      f1 f2 f3 f4 f5 f6 f7 f8 f9 f10 f11 f12
+    ).index_by {|k|k}
+  end
+ 
+  def send_string_of_keys(key)
+    send_key = []
+
+    if matches = key.match(%r{^\[(.*)\]$})
+      key = matches[1].split(',').map(&:strip)
+    else
+      key = [key]
+    end
+
+    key.each do |k| 
+      if matches = k.match(%r{^['"](.*)['"]$})
+        send_key << matches[1]
+      elsif allowed_keys.has_key?(k)
+        send_key << k.to_sym
+      else
+        send_key << k.to_s
+      end
+    end
+   
+    node.send_keys(send_key)
+  end
+end
+
+Capybara::Node.send :include, SendKeys

data/readme.mdown

@@ -0,0 +1,61 @@
+## Send Keys ##
+
+Send keys is a capybara extension that lets you send keystrokes to an element in the browser. It uses webdriver so must be used using the `@javascript` tag in your features.
+
+### Installation ###
+
+Check out the repo `git clone git@github.commarkgandolfo/send-keys.git` and put the step_definitions/send_keys_steps.rb into your step_definitions directory and copy support/send_keys.rb to your support directory. 
+
+### Why would you need this ###
+
+Some javascript events only respond to key presses, and at the moment capybara doesn't support the functionality required to pull this off. For example, we wanted to test a text-completion form, where a user was able to start typing a word, and our application would show a list of possible options. With the generic fill_in method this didn't work. This is just one of the many use cases. 
+
+### How to use it ###
+
+First make sure you use the @javascript tag, to force capybara to use the webdriver driver. 
+
+Then in your features you can send characters or modifier keys to an element, or an array of modifier keys and keys.
+You'll need to use the css selectors to select an element. 
+
+For Example
+
+    # Send the 'a' character to the input who's id is search (#search)
+    And I send a to "input#search"
+    
+    # Send the 'a', 'b' and 'c' characters to the input who's id is search (#search)
+    And I send abc to "input#search"
+    
+    # You can put them in quotes if you feel more comfortable
+    And I send 'abc' to "input#search"
+    
+    # You can also send modifier/special key strokes to an element
+    And I send arrow_left to "input#search"
+    
+    # You can even send a combination of modifier and characters
+    # This will result in a the character 'A' being sent to the input
+    And I send [shift, a] to "input#search"
+    
+    # Or maybe you just want to press enter
+    And I send enter to "input#search"
+
+    # How cool would it be to test the counter in a text area (say for a twitter app)
+    And I send hello to "#message"
+    And I should see "135" in "characters_left"
+    And I send backspace to "#message"
+    And I should see "136" in "characters_left"
+    
+    # We used it to test completion suggestions
+    # The first suggested name was highlighted and responded to an enter keypress
+    And I send "bo" to "input#username"
+    And I should see "bob" within "username_suggestions"
+    And I send enter to "input#username"
+
+#### List of modifiers/special keys ####
+
+There are a list of modifier and special keys which can be sent to an element
+    
+`null, cancel, help, backspace, tab, clear, return, enter, shift, left_shift, control, left_control alt, left_alt, pause, escape, space, page_up, page_down, end, home, left, arrow_left, uparrow_up, right, arrow_rightdown, arrow_down, insert, delete, semicolon, equals, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12`
+
+##### Please note #####
+
+Different OS' have different ways of simulating modifier keys, as a result not all will work on MacOSX, for example tab will not work. When I have some time I'll patch webdriver to support these keys.

data/send-keys.gemspec

@@ -0,0 +1,46 @@
+# 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{send-keys}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Gandolfo"]
+  s.date = %q{2010-10-30}
+  s.description = %q{Provides cucumber steps and methods to send key presses to DOM Elements with your Capybara tests.}
+  s.email = %q{mark@aussiev8.com.au}
+  s.extra_rdoc_files = [
+    "readme.mdown"
+  ]
+  s.files = [
+    "Rakefile",
+     "VERSION",
+     "lib/send-keys.rb",
+     "lib/send-keys/step_definitions/send_keys_steps.rb",
+     "lib/send-keys/support/send_keys.rb",
+     "readme.mdown",
+     "send-keys.gemspec"
+  ]
+  s.homepage = %q{http://github.com/markgandolfo/send-keys}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Simulate key presses in your capybara tests}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capybara>, [">= 0"])
+    else
+      s.add_dependency(%q<capybara>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capybara>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: send-keys
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Gandolfo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Provides cucumber steps and methods to send key presses to DOM Elements with your Capybara tests.
+email: mark@aussiev8.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- readme.mdown
+files: 
+- Rakefile
+- VERSION
+- lib/send-keys.rb
+- lib/send-keys/step_definitions/send_keys_steps.rb
+- lib/send-keys/support/send_keys.rb
+- readme.mdown
+- send-keys.gemspec
+has_rdoc: true
+homepage: http://github.com/markgandolfo/send-keys
+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: Simulate key presses in your capybara tests
+test_files: []
+