capybara-page-object 0.3.0 → 0.5.0

data/README.markdown

@@ -0,0 +1,83 @@
+[![Build Status](https://secure.travis-ci.org/andyw8/capybara-page-object.png)](http://travis-ci.org/andyw8/capybara-page-object)
+
+# capybara-page-object #
+
+Page Objects for Capybara
+
+## Installation ##
+
+Gemfile
+
+    gem 'capybara-page-object'
+
+## Getting Started ##
+
+features/catalog.feature
+
+```gherkin
+Feature: Catalog
+
+  Scenario: Products available
+
+    Given the products:
+      | iPhone |
+      | iPad   |
+    When I visit the store
+    Then those products should be listed
+```
+
+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
+end
+
+When /^I visit the store$/ do
+  @page = Pages::Products::Index.visit
+end
+
+Then /^those products should be listed$/ do
+  @page.product_titles.should == @products.collect{ |p| p.title }
+end
+```
+
+features/support/pages/products/index.rb
+
+```ruby
+module Pages
+  module Products
+    class Index < CapybaraPageObject::Page
+      def path
+        '/products'
+      end
+
+      def product_titles
+        all('.products .title').collect(&:text)
+      end
+    end
+  end
+end
+```
+
+## Demo Project ##
+
+[Depot](https://github.com/andyw8/depot)
+
+## Contributing to capybara-page-object ##
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright ##
+
+Copyright (c) 2012 Andy Waite. See LICENSE.txt for
+further details.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.5.0

data/capybara-page-object.gemspec

@@ -5,62 +5,69 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capybara-page-object}
-  s.version = "0.3.0"
+  s.version = "0.5.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-01}
+  s.date = %q{2012-04-08}
   s.description = %q{Page Objects for Capybara}
   s.email = %q{andy@andywaite.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "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/listitem.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/extractor/common.rb",
-    "lib/extractor/page_level.rb",
     "lib/html5_data.rb",
     "lib/key_value.rb",
-    "lib/navigation.rb",
     "lib/node.rb",
+    "lib/page.rb",
     "spec/common_spec.rb",
     "spec/element/anchor_spec.rb",
     "spec/element/base_spec.rb",
     "spec/element/form_field_spec.rb",
     "spec/element/form_spec.rb",
+    "spec/element/head_spec.rb",
     "spec/element/image_spec.rb",
     "spec/element/input_spec.rb",
+    "spec/element/list_item_spec.rb",
     "spec/element/list_spec.rb",
-    "spec/element/listitem_spec.rb",
     "spec/element/meta_spec.rb",
     "spec/element/select_spec.rb",
+    "spec/element/table_row_spec.rb",
     "spec/element/table_spec.rb",
     "spec/element/textarea_spec.rb",
     "spec/fixtures/node.html",
     "spec/helper.rb",
-    "spec/node_spec.rb"
+    "spec/node_spec.rb",
+    "spec/page_spec.rb"
   ]
   s.homepage = %q{http://github.com/andyw8/capybara-page-object}
   s.licenses = [%q{MIT}]

data/lib/capybara-page-object.rb

@@ -1,12 +1,12 @@
 require 'capybara'
-require File.dirname(__FILE__) + '/node'
-require File.dirname(__FILE__) + '/element'
-require File.dirname(__FILE__) + '/html5_data'
+require 'node'
+require 'element'
+require 'html5_data'
+require 'page'
 
 module Capybara
   module Node
     class Simple
-      include Extractor::PageLevel
       include CapybaraPageObject::HTML5Data
     end
   end

data/lib/collections.rb

@@ -1,11 +1,17 @@
 module CapybaraPageObject
   module Collections
-    def tables(attr={})
-      extract('table', attr, CapybaraPageObject::Table)
+    def tables
+      all('table').each_with_object({}) do |e, hash|
+        t = CapybaraPageObject::Table.new(e)
+        hash[t.key] = t
+      end
     end
 
-    def forms(attr={})
-      extract('form', attr)
+    def forms
+      all('form').each_with_object({}) do |e, hash|
+        f = CapybaraPageObject::Form.new(e)
+        hash[f.key] = f
+      end
     end
   end
-end
+end

data/lib/delegators.rb

@@ -0,0 +1,14 @@
+module Delegators
+  # TODO why doesn't method_missing work?
+  def all(*args)
+    source.all(*args)
+  end
+
+  def find(*args)
+    source.find(*args)
+  end
+
+  def text
+    source.text
+  end
+end

data/lib/element.rb

@@ -1,11 +1,14 @@
-require File.dirname(__FILE__) + '/element/anchor'
-require File.dirname(__FILE__) + '/element/form'
-require File.dirname(__FILE__) + '/element/image'
-require File.dirname(__FILE__) + '/element/form_field'
-require File.dirname(__FILE__) + '/element/input'
-require File.dirname(__FILE__) + '/element/list'
-require File.dirname(__FILE__) + '/element/listitem' # TODO make this two words
-require File.dirname(__FILE__) + '/element/meta'
-require File.dirname(__FILE__) + '/element/select'
-require File.dirname(__FILE__) + '/element/table'
-require File.dirname(__FILE__) + '/element/textarea'
+require 'element/anchor'
+require 'element/form'
+require 'element/image'
+require 'element/form_field'
+require 'element/head'
+require 'element/input'
+require 'element/list'
+require 'element/list_item'
+require 'element/meta'
+require 'element/select'
+require 'element/table'
+require 'element/table_row'
+require 'element/table_header'
+require 'element/textarea'

data/lib/element/TODO.md

@@ -0,0 +1,11 @@
+## Planned Functionality ##
+
+* Support write access to form fields
+
+## Testing ##
+
+* Add missing specs for table_row, table_header
+
+## Tags Not Yet Supported ##
+
+* dl (dt/dd)

data/lib/element/anchor.rb

@@ -1,11 +1,7 @@
 module CapybaraPageObject
   class Anchor < CapybaraPageObject::Node
-    def element_names
-      ['a']
-    end
-    
     def link
-      URI(root_node[:href])
+      URI(source[:href])
     end
   end
 end

data/lib/element/form.rb

@@ -1,6 +1,5 @@
 module CapybaraPageObject
   class Form < CapybaraPageObject::Node
-
     def fields
       r = {}
       r.merge! inputs
@@ -22,8 +21,8 @@ module CapybaraPageObject
     end
 
     def respond_to?(sym)
-       fields.has_key?(sym.to_s) || super(sym)
-     end
+      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)
@@ -33,17 +32,15 @@ module CapybaraPageObject
     private
     
     def inputs
-      r = {}
-      all('input').each do |input_tag|
+      all('input').each_with_object do |input_tag, hash|
         input = Input.new(input_tag)
         next if input.button?
         if input.checkable?
-          r[input.key] = !! input.checked?
+          hash[input.key] = !! input.checked?
         else
-          r[input.key] = input_tag.value
+          hash[input.key] = input_tag.value
         end
       end
-      r
     end
 
     def textareas
@@ -56,8 +53,7 @@ module CapybaraPageObject
     def selects
       all('select').inject({}) do |result, element|
         select = Select.new(element)
-        # TODO why is select.value not working here?
-        result.merge select.key => element.value
+        result.merge select.key => select.value
       end
     end
   end

data/lib/element/form_field.rb

@@ -1,20 +1,15 @@
 module CapybaraPageObject
   class FormField < CapybaraPageObject::Node
-
     def key
-      root_node[:name]
+      source[:name]
     end
 
-    def element_names
-      ['input', 'select', 'textarea']
+    def value
+      source.value
     end
 
     def blank?
-      '' == value
-    end
-
-    def value
-      root_node.value
+      value.nil? || '' == value
     end
   end
 end

data/lib/element/head.rb

@@ -0,0 +1,15 @@
+module CapybaraPageObject
+  class Head < CapybaraPageObject::Node
+    def title
+      find('title').text
+    end
+
+    def meta_description
+      find('meta[@name="description"]')['content']
+    end
+
+    def meta_keywords
+      find('meta[@name="keywords"]')['content'].split(',').collect(&:strip)
+    end
+  end
+end

data/lib/element/image.rb

@@ -1,20 +1,15 @@
 module CapybaraPageObject
   class Image < CapybaraPageObject::Node
-    
-    def element_names
-      ['img']
-    end
-    
-    def alt
-      root_node[:alt].strip
-    end
-    
     def key
       alt
     end
-    
+
     def value
-      URI(root_node[:src])
+      URI(source[:src])
+    end
+
+    def alt
+      source[:alt].strip
     end
   end
 end

data/lib/element/input.rb

@@ -1,27 +1,22 @@
+require 'element/text_based_input'
+
 module CapybaraPageObject
-  class Input < CapybaraPageObject::Node
+  class Input < CapybaraPageObject::FormField  
+    include TextBasedInput
     
     BUTTON_TYPES = ['submit', 'reset', 'button']
     CHECKABLE_TYPES = ['radio', 'checkbox']
 
-    def element_names
-      ['input']
-    end
-    
-    def key
-      root_node[:name]
-    end
-    
     def untyped?
-      root_node[:type].nil?
+      source[:type].nil?
     end
-    
+
     def button?
-      BUTTON_TYPES.include?(root_node[:type])
+      BUTTON_TYPES.include?(source[:type])
     end
 
     def checkable?
-      type = root_node[:type]
+      type = source[:type]
       type && CHECKABLE_TYPES.include?(type)
     end
   end

data/lib/element/list.rb

@@ -1,21 +1,7 @@
 module CapybaraPageObject
   class List < CapybaraPageObject::Node
-    
-    # TODO what about DL ?
-    def element_names
-      ['ul', 'ol']
-    end
-
-    def child_node
-      'li'
-    end
-    
     def items(*args)
-      children(*args)
-    end
-    
-    def key
-      root_node[:id]
+      all('li').map { |e| ListItem.new(e) }
     end
   end
 end