capybara-pageobject 0.1.1 → 0.1.2

data/.gitignore

@@ -6,3 +6,4 @@ pkg/*
 *.iml
 *.ipr
 *.iws
+doc/

data/README.rdoc

@@ -0,0 +1,112 @@
+= Capybara-PageObject
+
+capybara-pageobject helps you easily define page objects for capybara based tests.
+Page objects allow you to abstract your tests from low-level UI bindings.
+This allows you to easily adapt your tests to UI changes.
+
+== Setup
+
+Install as a gem:
+
+    sudo gem install capybara-pageobject
+
+== Usage
+
+Add the following section to your env.rb or acceptance_helper:
+
+    Capybara::PageObject.configure do |config|
+      config.page_file = 'support/pages/pages.yml'
+    end
+
+The gem makes a method 'website' available to your tests.
+
+
+== Page definitions
+
+Page definitions are specified in a YAML file. for eg:
+
+    home_page:
+      id: "#header_banner"
+      url: "/"
+    login_form:
+      id: "#login-form"
+      url: "/sign_in"
+      attributes:
+        email_address: "#email"
+        password: "#password.red"
+        error_message: "#alert_message"
+      actions:
+        login_button: "#login_submit"
+
+=== page
+Each first-level definition specifies a page.
+The above YAML declares that you have two pages home_page and login_form.
+
+=== url
+The url attribute specifies the url of the page.
+You can navigate to these pages as below:
+
+    website.home_page.visit
+    website.login_form.visit
+
+=== Dynamic urls
+For RESTful dynamci urls, use the following definition:
+    comment_page:
+      url: "/users/:user_id/comments/:comment_id"
+
+You can then visit the comments page as below:
+
+    website.comments_page.visit user_id: 3, comment_id: 1
+
+=== id
+The id attribute specifies the CSS3 selector which uniquely identifies that the page is loaded.
+You can use this as below:
+
+    website.login_form.visit
+    website.login_form.should be_visible
+
+=== attributes
+Each attribute on the page is specified alongwith the CSS3 selector to uniquely identify it.
+Each attribute definition can be used as below:
+
+    website.login_form.email_address "foo bar"              #Set email address to 'foo bar'
+    website.login_form.some_checkbox true                   #Check checkbox
+    website.login_form.email_address.should == "foo bar"    #Assert email address is equal to 'foo bar'
+    website.login_form.email_address.should be_visible      #Assert email address is visible
+
+Attributes also work with text content. for eg:
+
+    website.login_form.error_message.should == "Some error occurred"
+
+=== actions
+Any clickable (button or link) element on the page is defined as an action.
+Each action definition can be used as below:
+
+    website.login_form.login_button.click
+    website.login_form.login_button.should be_disabled
+    website.login_form.login_button.should be_visible
+
+==Page block mode
+To make your tests more readable, you can specify page interactions within a block. for eg:
+
+     website.login_form do
+        email_address 'foo@example.com'
+        password 'testing'
+        login_button.click
+        error_message.should be_visible
+     end
+
+===Custom Page Class
+If you need to define custom actions on the page, add a class which extends Capybara::PageObject::Page
+You can them specify it in the YAML file as below:
+
+    login_form:
+      id: "#login-form"
+      url: "/sign_in"
+      class: CustomLoginForm
+
+===TODO
+* XPath selectors
+* Standard setters ie website.login_form.email_address = "foo bar"
+
+

data/lib/capybara-pageobject.rb

@@ -1,9 +1,11 @@
 require "capybara-pageobject/version"
 require "monkey-patch/string"
 require "monkey-patch/object"
+require "monkey-patch/hash"
 
 module Capybara
   module PageObject
+    autoload :UrlParser, 'capybara-pageobject/url_parser'
     autoload :Page, 'capybara-pageobject/page'
     autoload :CapybaraHelper, 'capybara-pageobject/capybara_helper'
     autoload :Element, 'capybara-pageobject/element'

data/lib/capybara-pageobject/page.rb

@@ -1,8 +1,11 @@
+require 'capybara/rspec/matchers'
+
 module Capybara
   module PageObject
     class Page
       include CapybaraHelper
       include RSpec::Matchers
+      include Capybara::RSpecMatchers
 
       attr_accessor :context
 
@@ -20,14 +23,18 @@ module Capybara
         end
       end
 
-      def visit
-        @page_data["url"] ? page.visit(@page_data["url"]) : raise("url not defined for page")
+      def visit url_params={}
+        page.visit(UrlParser.new(@page_data["url"]).format(url_params))
       end
 
       def visible?
         @page_data["id"] ? if_absent(false) { page.find(@page_data["id"]).visible? } : raise("id not defined for page")
       end
 
+      def has_content? content
+        page.has_content?(content.to_s)
+      end
+
       def page_title
         if_absent("") { page.find("head title").text }
       end

data/lib/capybara-pageobject/url_parser.rb

@@ -0,0 +1,26 @@
+module Capybara
+  module PageObject
+    class UrlParser
+
+      def initialize url
+        raise 'url is not defined' if url.blank?
+        @url = url.dup
+      end
+
+      def format url_params
+        url_params.symbolize_keys!
+        dynamic_params = parse_params(@url)
+
+        raise "Please pass url parameters: #{dynamic_params}" unless url_params.keys.sort == dynamic_params.sort
+        url_params.each_pair { |param, value| @url.gsub!(":#{param}", value.to_s) }
+        @url
+      end
+
+      private
+
+      def parse_params url
+        url.scan(/:(\w+)/).flatten.map { |p| p.to_sym }
+      end
+    end
+  end
+end

data/lib/capybara-pageobject/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module PageObject
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/monkey-patch/hash.rb

@@ -0,0 +1,12 @@
+module MonkeyPatch
+  module Hash
+    def symbolize_keys!
+      keys.each do |key|
+        self[(key.to_sym rescue key) || key] = delete(key)
+      end
+      self
+    end
+  end
+end
+
+Hash.send(:include, MonkeyPatch::Hash)

data/spec/page_spec.rb

@@ -63,8 +63,9 @@ describe "Page" do
       capybara_page.should have_content "Email Address"
     end
 
-    it "should fail if url is not specified" do
-      expect { page_object({}).visit }.to raise_error(Exception, "url not defined for page")
+    it "should visit pages with dynamic urls" do
+      page_object({"url" => "/users/:user_id/comments/:id"}).visit(user_id: 3, id: 2)
+      capybara_page.should have_content "User data"
     end
   end
 
@@ -86,6 +87,20 @@ describe "Page" do
     end
   end
 
+  describe "has_content?" do
+    before(:each) do
+      @page = page_object({"url" => "/form"})
+      @page.visit
+    end
+    it "should return true if content is present" do
+      @page.should have_content "led zeppelin"
+    end
+
+    it "should handle dates" do
+      @page.should have_content Date.parse("1983-01-01")
+    end
+  end
+
   describe "page_title" do
     it "should return page title if page has title in head" do
       page = page_object({"url" => "/form"})

data/spec/support/test_website.rb

@@ -24,10 +24,15 @@ class TestWebsite < Sinatra::Base
     '<div id="foo1">led zeppelin</div><div id="foo2">the doors</div>'
   end
 
+  get '/users/3/comments/2' do
+    '<div id="user_home">User data</div>'
+  end
+
   get '/form' do
     page_with do
       <<-FORM
 <div id="attr1">led zeppelin</div>
+<div>1983-01-01</div>
 <div id="hidden_attr" style="display:none">the doors</div>
 <form id="unique_form">
   <input type="text" id="field1" value="Creedence Rlearwater Revival"/>

data/spec/url_parser_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "UrlParser" do
+  describe "format" do
+    it "should return url if it is static" do
+      Capybara::PageObject::UrlParser.new("/users/1").format({}).should == "/users/1"
+    end
+
+    it "should duplicate url string" do
+      url = "/users/:user_id"
+      parser = Capybara::PageObject::UrlParser.new(url)
+      parser.format(user_id: 2)
+      url.should == "/users/:user_id"
+    end
+
+    it "should raise error if dynamic url is called without params" do
+      expect { Capybara::PageObject::UrlParser.new("/users/:id").format({}) }.to raise_error(Exception, 'Please pass url parameters: [:id]')
+    end
+
+    it "should raise error if number of parameters does not match" do
+      expect { Capybara::PageObject::UrlParser.new("/users/:user_id/actions/:id").format({id: 1}) }.to raise_error(Exception, 'Please pass url parameters: [:user_id, :id]')
+    end
+
+    it "should raise error if parameter names don't match" do
+      expect { Capybara::PageObject::UrlParser.new("/users/:user_id").format({id: 1}) }.to raise_error(Exception, 'Please pass url parameters: [:user_id]')
+    end
+
+    it "should substitute url parameters" do
+      Capybara::PageObject::UrlParser.new("/users/:id").format({id: 2}).should == "/users/2"
+    end
+
+    it "should substitute multiple url parameters and ignore order" do
+      Capybara::PageObject::UrlParser.new("/users/:user_id/actions/:id").format({id: 2, user_id: 3}).should == "/users/3/actions/2"
+    end
+
+    it { expect { Capybara::PageObject::UrlParser.new(nil) }.to raise_error(Exception, 'url is not defined') }
+    it { expect { Capybara::PageObject::UrlParser.new("") }.to raise_error(Exception, 'url is not defined') }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-pageobject
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156144500 !ruby/object:Gem::Requirement
+  requirement: &2161878000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156144500
+  version_requirements: *2161878000
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156141140 !ruby/object:Gem::Requirement
+  requirement: &2161877580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156141140
+  version_requirements: *2161877580
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2156139320 !ruby/object:Gem::Requirement
+  requirement: &2161877060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.4
   type: :development
   prerelease: false
-  version_requirements: *2156139320
+  version_requirements: *2161877060
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2156062360 !ruby/object:Gem::Requirement
+  requirement: &2161876640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156062360
+  version_requirements: *2161876640
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &2156061060 !ruby/object:Gem::Requirement
+  requirement: &2161876080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156061060
+  version_requirements: *2161876080
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &2156059420 !ruby/object:Gem::Requirement
+  requirement: &2161875660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156059420
+  version_requirements: *2161875660
 description: Introduce page objects to your capybara-based functional tests
 email:
 - deepak.lewis@gmail.com
@@ -87,6 +87,7 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
+- README.rdoc
 - Rakefile
 - capybara-pageobject.gemspec
 - lib/capybara-pageobject.rb
@@ -95,8 +96,10 @@ files:
 - lib/capybara-pageobject/capybara_helper.rb
 - lib/capybara-pageobject/element.rb
 - lib/capybara-pageobject/page.rb
+- lib/capybara-pageobject/url_parser.rb
 - lib/capybara-pageobject/version.rb
 - lib/capybara-pageobject/website.rb
+- lib/monkey-patch/hash.rb
 - lib/monkey-patch/object.rb
 - lib/monkey-patch/string.rb
 - spec/action_spec.rb
@@ -108,6 +111,7 @@ files:
 - spec/support/matchers/delegate.rb
 - spec/support/pages/pages.yml
 - spec/support/test_website.rb
+- spec/url_parser_spec.rb
 - spec/website_spec.rb
 homepage: ''
 licenses: []
@@ -143,4 +147,5 @@ test_files:
 - spec/support/matchers/delegate.rb
 - spec/support/pages/pages.yml
 - spec/support/test_website.rb
+- spec/url_parser_spec.rb
 - spec/website_spec.rb