capybara-page-object 0.5.0 → 0.6.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+script: SKIP_COVERAGE=1 rake

data/Gemfile

@@ -1,17 +1,16 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source :rubygems
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.3"
+  gem 'simplecov', :require => false
   gem "rspec"
   gem 'rake', '~> 0.9.2.2'
   gem "rdoc", '~> 3.12'
 end
 
+group :test do
+end
+
+gem "activesupport", '~> 3.0' # for OrderedHash
 gem "capybara"

data/Gemfile.lock

@@ -1,6 +1,8 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.0)
+    addressable (2.2.7)
     capybara (1.1.2)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -13,35 +15,42 @@ GEM
     diff-lcs (1.1.3)
     ffi (1.0.11)
     git (1.2.5)
-    jeweler (1.6.4)
+    jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+      rdoc
     json (1.6.6)
-    mime-types (1.17.2)
-    multi_json (1.1.0)
+    libwebsocket (0.1.3)
+      addressable
+    mime-types (1.18)
+    multi_json (1.3.2)
     nokogiri (1.5.2)
     rack (1.4.1)
     rack-test (0.6.1)
       rack (>= 1.0)
     rake (0.9.2.2)
-    rcov (0.9.11)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    rubyzip (0.9.6.1)
-    selenium-webdriver (2.20.0)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rubyzip (0.9.7)
+    selenium-webdriver (2.21.2)
       childprocess (>= 0.2.5)
       ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)
       rubyzip
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
     xpath (0.1.4)
       nokogiri (~> 1.3)
 
@@ -49,10 +58,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  activesupport (~> 3.0)
+  bundler (~> 1.1.0)
   capybara
-  jeweler (~> 1.6.4)
+  jeweler (~> 1.8.3)
   rake (~> 0.9.2.2)
-  rcov
   rdoc (~> 3.12)
   rspec
+  simplecov

data/README.markdown

@@ -1,8 +1,8 @@
-[![Build Status](https://secure.travis-ci.org/andyw8/capybara-page-object.png)](http://travis-ci.org/andyw8/capybara-page-object)
+[![Build Status](https://secure.travis-ci.org/andyw8/capybara-page-object.png)](http://travis-ci.org/andyw8/capybara-page-object) [![Dependency Status](https://gemnasium.com/andyw8/capybara-page-object.png)](https://gemnasium.com/andyw8/capybara-page-object)
 
 # capybara-page-object #
 
-Page Objects for Capybara
+[Page Objects](http://code.google.com/p/selenium/wiki/PageObjects) for Capybara
 
 ## Installation ##
 
@@ -30,10 +30,7 @@ features/step_definitions/product_steps.rb
 
 ```ruby
 Given /^the products:$/ do |table|
-  @products = []
-  table.raw.flatten.each do |p|
-    @products << Product.create!(:title => p)
-  end
+  @products = table.raw.flatten.map { |p| Product.create!(:title => p) }
 end
 
 When /^I visit the store$/ do
@@ -41,28 +38,51 @@ When /^I visit the store$/ do
 end
 
 Then /^those products should be listed$/ do
-  @page.product_titles.should == @products.collect{ |p| p.title }
+  @page.product_titles.should == @products.map{ |p| p.title }
 end
 ```
 
-features/support/pages/products/index.rb
+features/pages/products/index.rb
 
 ```ruby
 module Pages
   module Products
     class Index < CapybaraPageObject::Page
-      def path
-        '/products'
-      end
+      
+      path 'products'
+
+      component :navigation { Components::Navigation.new find('#nav') }
+      component :product_list { Components::ProductList.new find('#products') }
 
       def product_titles
-        all('.products .title').collect(&:text)
+        product_list.titles
       end
     end
   end
 end
+
+module Compnents
+  class ProductList < CapybaraPageObject::Component
+    def titles
+      source.all('.title').collect(&:text)
+    end
+  end
+end
 ```
 
+## Usage ##
+
+Create a class to represent a page, component or element, and include the appropriate module:
+
+* CapybaraPageObject::Page to represent a whole page
+* CapybaraPageObject::Component to represent part of a page (e.g. a sidebar)
+* CapybaraPageObject::Element to represent a single element (e.g. a <footer> tag)
+
+## Best Practices ##
+
+* Avoid CSS or XPath selectors in your step definitions - do this within the page/component/element objects
+* Avoid assertions in the page models themselves - do this in the step definitions
+
 ## Demo Project ##
 
 [Depot](https://github.com/andyw8/depot)

data/Rakefile

@@ -47,13 +47,6 @@ desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
 end
 
-desc "Generate code coverage"
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
-
 task :default => :spec
 
 require 'rdoc/task'

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/capybara-page-object.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capybara-page-object}
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Andy Waite}]
-  s.date = %q{2012-04-08}
+  s.date = %q{2012-04-22}
   s.description = %q{Page Objects for Capybara}
   s.email = %q{andy@andywaite.com}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -26,29 +27,32 @@ Gem::Specification.new do |s|
     "VERSION",
     "capybara-page-object.gemspec",
     "lib/capybara-page-object.rb",
-    "lib/collections.rb",
-    "lib/delegators.rb",
-    "lib/element.rb",
-    "lib/element/TODO.md",
-    "lib/element/anchor.rb",
-    "lib/element/form.rb",
-    "lib/element/form_field.rb",
-    "lib/element/head.rb",
-    "lib/element/image.rb",
-    "lib/element/input.rb",
-    "lib/element/list.rb",
-    "lib/element/list_item.rb",
-    "lib/element/meta.rb",
-    "lib/element/select.rb",
-    "lib/element/table.rb",
-    "lib/element/table_header.rb",
-    "lib/element/table_row.rb",
-    "lib/element/text_based_input.rb",
-    "lib/element/textarea.rb",
-    "lib/html5_data.rb",
-    "lib/key_value.rb",
-    "lib/node.rb",
-    "lib/page.rb",
+    "lib/capybara-page-object/collections.rb",
+    "lib/capybara-page-object/component.rb",
+    "lib/capybara-page-object/delegators.rb",
+    "lib/capybara-page-object/element.rb",
+    "lib/capybara-page-object/elements.rb",
+    "lib/capybara-page-object/elements/anchor.rb",
+    "lib/capybara-page-object/elements/form.rb",
+    "lib/capybara-page-object/elements/form_field.rb",
+    "lib/capybara-page-object/elements/head.rb",
+    "lib/capybara-page-object/elements/image.rb",
+    "lib/capybara-page-object/elements/input.rb",
+    "lib/capybara-page-object/elements/list.rb",
+    "lib/capybara-page-object/elements/list_item.rb",
+    "lib/capybara-page-object/elements/meta.rb",
+    "lib/capybara-page-object/elements/select.rb",
+    "lib/capybara-page-object/elements/table.rb",
+    "lib/capybara-page-object/elements/table_header.rb",
+    "lib/capybara-page-object/elements/table_row.rb",
+    "lib/capybara-page-object/elements/text_based_input.rb",
+    "lib/capybara-page-object/elements/textarea.rb",
+    "lib/capybara-page-object/extensions/capybara.rb",
+    "lib/capybara-page-object/extensions/enumerable.rb",
+    "lib/capybara-page-object/html5_data.rb",
+    "lib/capybara-page-object/key_value.rb",
+    "lib/capybara-page-object/node.rb",
+    "lib/capybara-page-object/page.rb",
     "spec/common_spec.rb",
     "spec/element/anchor_spec.rb",
     "spec/element/base_spec.rb",
@@ -79,27 +83,30 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0"])
       s.add_runtime_dependency(%q<capybara>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rake>, ["~> 0.9.2.2"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
     else
+      s.add_dependency(%q<activesupport>, ["~> 3.0"])
       s.add_dependency(%q<capybara>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
     end
   else
+    s.add_dependency(%q<activesupport>, ["~> 3.0"])
     s.add_dependency(%q<capybara>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rake>, ["~> 0.9.2.2"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

data/lib/capybara-page-object.rb

@@ -1,13 +1,14 @@
 require 'capybara'
-require 'node'
-require 'element'
-require 'html5_data'
-require 'page'
+require 'capybara-page-object/extensions/enumerable'
+require 'active_support/ordered_hash'
 
-module Capybara
-  module Node
-    class Simple
-      include CapybaraPageObject::HTML5Data
-    end
-  end
-end
+require 'capybara-page-object/key_value'
+require 'capybara-page-object/delegators'
+require 'capybara-page-object/html5_data'
+
+require 'capybara-page-object/node'
+require 'capybara-page-object/element'
+require 'capybara-page-object/elements'
+require 'capybara-page-object/page'
+require 'capybara-page-object/component'
+require 'capybara-page-object/extensions/capybara'

data/lib/capybara-page-object/collections.rb

@@ -0,0 +1,4 @@
+module CapybaraPageObject
+  module Collections
+  end
+end

data/lib/capybara-page-object/component.rb

@@ -0,0 +1,5 @@
+module CapybaraPageObject
+  class Component < CapybaraPageObject::Element
+    include CapybaraPageObject::Collections
+  end
+end

data/lib/capybara-page-object/element.rb

@@ -0,0 +1,6 @@
+module CapybaraPageObject
+  class Element < CapybaraPageObject::Node
+    include CapybaraPageObject::Collections
+    include CapybaraPageObject::HTML5Data
+  end
+end

data/lib/capybara-page-object/elements.rb

@@ -0,0 +1,15 @@
+require 'capybara-page-object/elements/text_based_input'
+require 'capybara-page-object/elements/anchor'
+require 'capybara-page-object/elements/form'
+require 'capybara-page-object/elements/image'
+require 'capybara-page-object/elements/form_field'
+require 'capybara-page-object/elements/head'
+require 'capybara-page-object/elements/input'
+require 'capybara-page-object/elements/list'
+require 'capybara-page-object/elements/list_item'
+require 'capybara-page-object/elements/meta'
+require 'capybara-page-object/elements/select'
+require 'capybara-page-object/elements/table'
+require 'capybara-page-object/elements/table_row'
+require 'capybara-page-object/elements/table_header'
+require 'capybara-page-object/elements/textarea'

data/lib/capybara-page-object/elements/anchor.rb

@@ -0,0 +1,6 @@
+module CapybaraPageObject
+  class Anchor < CapybaraPageObject::Element
+    field(:link) { source[:href] }
+    field(:uri) { URI link }
+  end
+end

data/lib/{element → capybara-page-object/elements}/form.rb

@@ -1,7 +1,10 @@
+require 'active_support/ordered_hash'
+
 module CapybaraPageObject
-  class Form < CapybaraPageObject::Node
+
+  class Form < CapybaraPageObject::Element
     def fields
-      r = {}
+      r = ActiveSupport::OrderedHash.new
       r.merge! inputs
       r.merge! selects
       r.merge! textareas
@@ -20,19 +23,8 @@ module CapybaraPageObject
       r
     end
 
-    def respond_to?(sym)
-      fields.has_key?(sym.to_s) || super(sym)
-    end
-
-    def method_missing(sym, *args, &block)
-      return fields[sym.to_s] if fields.has_key?(sym.to_s)
-      super(sym, *args, &block)
-    end
-    
-    private
-    
     def inputs
-      all('input').each_with_object do |input_tag, hash|
+      all('input').each_with_object(ActiveSupport::OrderedHash.new) do |input_tag, hash|
         input = Input.new(input_tag)
         next if input.button?
         if input.checkable?
@@ -44,14 +36,14 @@ module CapybaraPageObject
     end
 
     def textareas
-      all('textarea').inject({}) do |result, element|
+      all('textarea').inject(ActiveSupport::OrderedHash.new) do |result, element|
         textarea = Textarea.new(element)
         result.merge textarea.key => textarea.value
       end
     end
 
     def selects
-      all('select').inject({}) do |result, element|
+      all('select').inject(ActiveSupport::OrderedHash.new) do |result, element|
         select = Select.new(element)
         result.merge select.key => select.value
       end