form_object_model 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in form_object_model.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sean Geoghegan
+
+MIT License
+
+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.md

@@ -0,0 +1,87 @@
+# FormObjectModel
+
+[![Build Status](https://secure.travis-ci.org/reinteractive-open/form-object-model.png?branch=master)](http://travis-ci.org/reinteractive-open/form-object-model)
+
+This gem lets you construct an object model
+of a form you're using in your request specs.
+With a form object model, locators and field types
+are defined in a single place so if the form structure
+changes your test don't need to change, only the
+definition of the form fields.
+
+So given the following form in a page:
+
+```html
+<form action="/foo">
+  <label for="name">Name</label>
+  <input type="text" name="name" id="name" />
+
+  <label for="title">Title</label>
+  <select id="title" name="title">
+    <option>Mr</option>
+    <option>Miss</option>
+    <option>Mrs</option>
+  </select>
+
+  <h3>Gender</h3>
+  <label for="gender_male">Male</label>
+  <input type="radio" name="gender" value="male" id="gender_male" />
+
+  <label for="gender_female">Female</label>
+  <input type="radio" name="gender" value="female" id="gender_female" />
+</form>
+```
+
+Forms are defined like so:
+
+```ruby
+form = FormObjectModel.new do |fom|
+  form.text_field :name, "Name"
+  form.select     :title, "Title"
+  form.radio      :gender, "input[name = gender]"
+end
+```
+
+You can then set the value of the fields, in a consistent way, regardless of the field type. This is done like so:
+
+```ruby
+form.name  = "Joe Bloggs"
+form.title = "Mr"
+form.gender = "Male"
+``` 
+
+And assert the field value using:
+
+```ruby
+form.name.should have_value("Joe Bloggs")
+form.title.should have_value("Mr")
+form.gender.should have_value("Male")
+```
+
+## TODOs
+
+* Support more field types, currently just handle, text, select and radio buttons.
+* Make it easier to define custom field types for custom widgets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'form_object_model'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install form_object_model
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+begin
+  # Set up load paths for all bundled gems
+  ENV["BUNDLE_GEMFILE"] = File.expand_path("../Gemfile", __FILE__)
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/form_object_model.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/form_object_model/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sean Geoghegan"]
+  gem.email         = ["sean@seangeo.me"]
+  gem.description   = %q{An OO form testing helper that makes Capayaba-based form testing easy.}
+  gem.summary       = %q{An OO form testing helper that makes Capayaba-based form testing easy.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "form_object_model"
+  gem.require_paths = ["lib"]
+  gem.version       = FormObjectModel::VERSION
+
+  gem.add_dependency('capybara', '~> 1.1')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('rake')
+end
+

data/lib/form_object_model.rb

@@ -0,0 +1,6 @@
+require "capybara"
+require "form_object_model/version"
+require "form_object_model/form.rb"
+require "form_object_model/helper.rb"
+require "form_object_model/matcher.rb"
+

data/lib/form_object_model/form.rb

@@ -0,0 +1,118 @@
+module FormObjectModel
+  class Form
+    Field = Struct.new(:page, :name, :locator)
+    class TextField < Field
+      def fill(value)
+        page.fill_in(locator, :with => value.to_s)
+      end
+
+      def has_value?(value)
+        page.has_field?(locator, :with => value.to_s)
+      end
+
+      def value
+        page.find_field(locator).value
+      end
+    end
+
+    class SelectField < Field
+      def fill(value)
+        page.select(value.to_s, :from => locator)
+      end
+
+      def has_value?(value)
+        page.has_select?(locator, :selected => value.to_s)
+      end
+
+      def value
+        value = nil
+        page.within(page.find_field(locator)) do
+          value = page.find("option[selected]").text
+        end
+        value
+      end
+    end
+
+    class RadioField < Field
+      # This lets you select the radio button by it's label instead of id
+      def fill(value)
+        if button = button_for(value)
+          button.set(true)
+        else
+          raise "Could not find button with locator '#{locator}' and label '#{value}'"
+        end
+      end
+
+      def has_value?(value)
+        button = button_for(value)
+        button && %w(checked true).include?(button['checked'])
+      end
+
+      def value
+        element = checked_element
+        element && element.value
+      end
+
+      private
+      def checked_element
+        page.all(locator).find {|b| b['checked'] == 'checked' }
+      end
+
+      def button_for(value)
+        label_ids = label_ids_for(value)
+        page.all(locator).find {|b| label_ids.include?(b['id']) }
+      end
+
+      def label_ids_for(value)
+        page.all("label:contains('#{value}')").map {|label| label['for'] }
+      end
+    end
+
+    attr_reader :page
+
+    def initialize(page)
+      @page = page
+      yield(self) if block_given?
+    end
+
+    def text_field(name, locator)
+      define_field(name, TextField.new(page, name, locator))
+    end
+
+    def select(name, locator)
+      define_field(name, SelectField.new(page, name, locator))
+    end
+
+    # Radio button locators should match all buttons in the group
+    def radio(name, locator)
+      define_field(name, RadioField.new(page, name, locator))
+    end
+
+    def submit_button(locator, &after_submit_block)
+      @submit_button = locator
+      @after_submit_block = after_submit_block
+    end
+
+    def submit
+      raise "FormObjectModel#submit_button called before submit_button locator was set" unless @submit_button
+      page.click_button @submit_button
+      if @after_submit_block
+        @after_submit_block.call(page)
+      end
+    end
+
+    def within
+      yield(self)
+    end
+
+    private
+
+    def define_field(name, field)
+      (class << self; self; end).class_eval do
+        define_method(name) {|*args| field }
+        define_method("#{name.to_s}=".to_sym) {|val| field.fill(val) }
+      end
+    end
+  end
+end
+

data/lib/form_object_model/helper.rb

@@ -0,0 +1,8 @@
+module FormObjectModel
+  module Helper
+    def have_value(value)
+      FormObjectHaveValueMatcher.new(value)
+    end
+  end
+end
+

data/lib/form_object_model/matcher.rb

@@ -0,0 +1,15 @@
+module FormObjectModel
+  class FormObjectHaveValueMatcher < Struct.new(:value)
+    attr_reader :actual
+
+    def matches?(actual)
+      @actual = actual
+      actual.has_value?(value)
+    end
+
+    def failure_message_for_should
+      "Expected field '#{actual.locator}' to have value '#{value}' but had '#{actual.value}'"
+    end
+  end
+end
+

data/lib/form_object_model/version.rb

@@ -0,0 +1,3 @@
+module FormObjectModel
+  VERSION = "0.1.0"
+end

data/spec/integration/form_object_model_spec.rb

@@ -0,0 +1,156 @@
+require "spec_helper"
+
+describe FormObjectModel do
+  let(:page) { Capybara::Session.new(:rack_test, @app) }
+  after { page.reset! }
+
+  before(:all) do
+    @app = lambda do |env|
+      if env['REQUEST_METHOD'] == 'POST'
+        body = <<-HTML
+          <html>
+            <head>
+            </head>
+            <body>
+              <p>Submitted</p>
+            </body>
+          </html>
+        HTML
+      else
+        body = <<-HTML
+          <html>
+          <head>
+          </head>
+          <body>
+            <form action="/" method="post">
+              <label for="textfield1">Text Field 1</label>
+              <input type="text" id="textfield1" name="textfield1" />
+
+              <label for="selectfield1">Select Field</label>
+              <select id="selectfield1">
+                <option>Option 1</option>
+                <option>Option 2</option>
+                <option>Option 3</option>
+              </select>
+
+              <label for="radio1">Radio 1"</label>
+              <input type="radio" name="radio" id="radio1" value="Radio1"/>
+              <label for="radio2">Radio 2"</label>
+              <input type="radio" name="radio" id="radio2" value="Radio2"/>
+              <label for="radio3">Radio 3"</label>
+              <input type="radio" name="radio" id="radio3" value="Radio3"/>
+
+              <input type="submit" name="submit" value="Submit" />
+            </form>
+          </body>
+        </html>
+        HTML
+      end
+      [200,
+        { 'Content-Type' => 'text/html',
+          'Content-Length' => body.length.to_s },
+          [body]]
+    end
+  end
+
+  let(:form) do
+    FormObjectModel::Form.new(page) do |f|
+      f.text_field :textfield1, "Text Field 1"
+      f.select :selectfield1, "Select Field"
+      f.radio  :radiobuttons1, "input[name = radio]"
+      f.submit_button "Submit"
+    end
+  end
+
+  before { page.visit("/") }
+
+  context "text fields" do
+    it "should set the value of the field" do
+      form.textfield1 = "My Value"
+      page.should have_field("Text Field 1", :with => "My Value")
+    end
+
+    it "should fail when the value of the field is different" do
+      page.fill_in("Text Field 1", :with => "A value")
+      lambda { form.textfield1.should have_value("Other value") }.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+    end
+
+    it "should pass when the value of the field is the same" do
+      page.fill_in("Text Field 1", :with => "A value")
+      form.textfield1.should have_value("A value")
+    end
+  end
+
+  context "single select" do
+    it "should set the value of the field" do
+      form.selectfield1 = "Option 2"
+      page.should have_select("Select Field", :selected => "Option 2")
+    end
+
+    it "should fail when set to another value" do
+      page.select("Option 3", :from => "Select Field")
+      lambda { form.selectfield1.should have_value("Option 2") }.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+    end
+
+    it "should pass with the value is the same" do
+      page.select("Option 2", :from => "Select Field")
+      form.selectfield1.should have_value("Option 2")
+    end
+  end
+
+  context "radio buttons" do
+    it "should set the radio button via its label" do
+      form.radiobuttons1 = "Radio 2"
+      page.should have_checked_field("radio2")
+    end
+
+    it "should set the radio button via the other label" do
+      form.radiobuttons1 = "Radio 3"
+      page.should have_checked_field("radio3")
+    end
+
+    it "should fail when the radio button is set to another value" do
+      page.choose("radio2")
+      lambda { form.radiobuttons1.should have_value("Radio 1") }.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+    end
+
+    it "should pass when the radio button is set to the same value" do
+      page.choose("radio3")
+      form.radiobuttons1.should have_value("Radio 3")
+    end
+  end
+
+  context "submit" do
+    it "should submit the form" do
+      form.submit
+      page.should have_content("Submitted")
+    end
+
+    context "with a submit callback" do
+      let(:form) do
+        FormObjectModel::Form.new(page) do |f|
+          f.submit_button "Submit" do
+            page.should have_content("Submitted")
+            @callback_fired = true
+          end
+        end
+      end
+
+      it "should call the callback after submission" do
+        form.submit
+        @callback_fired.should be_true
+      end
+    end
+
+    context "without submit defined" do
+      let(:form) do
+        FormObjectModel::Form.new(page)
+      end
+
+      it "should raise an error on submission" do
+        lambda { form.submit }.should raise_error
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+
+require "form_object_model"
+
+RSpec.configure do |config|
+  config.include FormObjectModel::Helper
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: form_object_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Geoghegan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An OO form testing helper that makes Capayaba-based form testing easy.
+email:
+- sean@seangeo.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- form_object_model.gemspec
+- lib/form_object_model.rb
+- lib/form_object_model/form.rb
+- lib/form_object_model/helper.rb
+- lib/form_object_model/matcher.rb
+- lib/form_object_model/version.rb
+- spec/integration/form_object_model_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -173730069923801373
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -173730069923801373
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: An OO form testing helper that makes Capayaba-based form testing easy.
+test_files:
+- spec/integration/form_object_model_spec.rb
+- spec/spec_helper.rb