capybara-page-object 0.2.1 → 0.3.0

data/lib/element/list.rb

@@ -0,0 +1,21 @@
+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]
+    end
+  end
+end

data/lib/element/listitem.rb

@@ -0,0 +1,7 @@
+module CapybaraPageObject
+  class Listitem < CapybaraPageObject::Node
+    def element_names
+      ['li']
+    end
+  end
+end

data/lib/element/meta.rb

@@ -0,0 +1,16 @@
+module CapybaraPageObject
+  class Meta < CapybaraPageObject::Node
+    
+    def element_names
+      ['meta']
+    end
+    
+    def key
+      root_node[:name]
+    end
+    
+    def value
+      root_node[:content]
+    end
+  end
+end

data/lib/element/select.rb

@@ -0,0 +1,16 @@
+module CapybaraPageObject
+  class Select < CapybaraPageObject::Node
+    
+    def element_names
+      ['select']
+    end
+    
+    def key
+      root_node[:name]
+    end
+    
+    def value
+      root_node.value
+    end
+  end
+end

data/lib/{table.rb → element/table.rb}

@@ -1,7 +1,5 @@
-require File.dirname(__FILE__) + '/base'
-
 module CapybaraPageObject
-  class Table < CapybaraPageObject::Base
+  class Table < CapybaraPageObject::Node
     def rows(attr={})
       extract('tr', attr)
     end

data/lib/element/textarea.rb

@@ -0,0 +1,16 @@
+module CapybaraPageObject
+  class Textarea < CapybaraPageObject::Node
+    
+    def element_names
+      ['textarea']
+    end
+    
+    def key
+      root_node[:name]
+    end
+    
+    def value
+      text
+    end
+  end
+end

data/lib/{extractors → extractor}/common.rb

@@ -1,4 +1,4 @@
-module Extractors
+module Extractor
   
   module Common
     def extract(element, attr={}, page_object_class=nil)
@@ -28,16 +28,8 @@ module Extractors
         end
       end
     end
-    
-    def data
-      r = {}
-      native.attributes.each do |k, v|
-        next unless k.start_with?('data-')
-        r[k.gsub('data-', '')] = v.value
-      end
-      r      
-    end
-  
+
+    # TODO use method_missing o handle these?
     def all(*args)
       source.all(*args)
     end

data/lib/{extractors → extractor}/page_level.rb

@@ -1,19 +1,9 @@
-module Extractors
-  module PageLevel
-    include Common
-    
+module Extractor
+  module PageLevel    
     def title
       find('title').text
     end
 
-    def tables(attr={})
-      extract('table', attr, CapybaraPageObject::Table)
-    end
-
-    def forms(attr={})
-      extract('form', attr)
-    end
-
     def meta_description
       extract('meta', :by => 'name')['description']['content']
     end
@@ -22,4 +12,4 @@ module Extractors
       extract('meta', :by => 'name')['keywords']['content'].split(',').collect(&:strip)
     end
   end
-end
+end

data/lib/html5_data.rb

@@ -0,0 +1,14 @@
+module CapybaraPageObject
+  module HTML5Data
+    def data
+      r = {}
+      if native.respond_to?(:attributes)
+        native.attributes.each do |k, v|
+          next unless k.start_with?('data-')
+          r[k.gsub('data-', '')] = v.value
+        end
+      end
+      r
+    end
+  end
+end

data/lib/key_value.rb

@@ -0,0 +1,11 @@
+module CapybaraPageObject
+  module Collections
+    def key
+      root_node[:id]
+    end
+
+    def value
+      text
+    end
+  end
+end

data/lib/navigation.rb

@@ -0,0 +1,16 @@
+module CapybaraPageObject
+  module Navigation
+    def path(*args)
+      raise MissingPath, "You need to override this"
+    end
+
+    def prefix
+      ''
+    end
+
+    def visit
+      source.visit prefix + path
+      self
+    end
+  end
+end

data/lib/node.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/collections'
+require File.dirname(__FILE__) + '/navigation'
+require File.dirname(__FILE__) + '/key_value'
+require File.dirname(__FILE__) + '/html5_data'
+require File.dirname(__FILE__) + '/extractor/common'
+require File.dirname(__FILE__) + '/extractor/page_level'
+
+module CapybaraPageObject
+  class Node
+    include Extractor::Common
+    include Extractor::PageLevel
+    include CapybaraPageObject::Collections
+    include CapybaraPageObject::Navigation
+    include CapybaraPageObject::HTML5Data
+    include Extractor::PageLevel
+
+    attr_accessor :source
+
+    def initialize(source=nil)
+      source ||= Capybara.current_session
+      @source = source
+    end
+
+    def self.from_string(string)
+      new(Capybara.string(string))
+    end
+    
+    def respond_to?(sym)
+      source.respond_to?(sym) || super(sym)
+    end
+
+    def method_missing(sym, *args, &block)
+      if source.respond_to?(sym)
+        source.send(sym)
+      else
+        super(sym, *args, &block)
+      end
+    end
+    
+    def classes
+      classes_list = root_node[:class] or return []
+      classes_list.split(' ')
+    end
+    
+    def children(opts={})
+      factory = opts[:factory]
+      return all(child_node) unless factory
+      r = []
+      all(child_node).each do |li|
+        r << factory.new(li)
+      end
+      r
+    end
+    
+    private
+    
+    def element_names
+      raise "You need to override element_names"
+    end
+    
+    def root_node
+      # TODO still don't fully understand why we need both approaches
+      element_names.each do |element_name|
+        if source.native.name == element_name
+          return source.native
+        elsif source.has_css?(element_name)
+          return find(element_name)
+        end
+      end
+      raise "No element matches for #{element_names.join(', ')}"
+    end
+  end
+
+  class MissingPath < RuntimeError
+  end
+end

data/spec/common_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe "Page" do
+  before do
+    html = File.open(File.dirname(__FILE__) + '/fixtures/node.html').read
+    @page = CapybaraPageObject::Node.from_string html    
+  end
+
+  context "#tables" do
+    it "returns an array of Table objects" do
+      tables = @page.tables
+      tables[0].class.should == CapybaraPageObject::Table
+      tables[0].class.should == CapybaraPageObject::Table
+    end
+
+    it "returns a hash of Tables keyed by id" do
+      tables = @page.tables(:by => 'id')
+      tables['table_1'].class.should == CapybaraPageObject::Table
+      tables['table_2'].class.should == CapybaraPageObject::Table
+      # TODO: support @page.tables[:table_1] ? perhaps have a default_key override?
+    end
+  end
+
+  context "#forms" do
+    it "returns the ids for the forms" do
+      @page.forms(:keys => 'id').should =~ ['form_1', 'form_2']
+    end
+  end
+
+  it "return the elements as a hash" do
+    @page.tables(:keys => 'id').should =~ ['table_1', 'table_2']
+    @page.tables(:keys => 'class').should =~ ['table_1_class', 'table_2_class']
+  end
+
+  context "#data" do
+    it "returns an empty hash if the element has no HTML5 data attributes" do
+      e = Capybara.string('<foo/>')
+      e.data.should == {}
+    end
+
+    it "returns a hash of the elements HTML5 data attributes" do
+      h = {'foo' => 'a', 'bar' => 'b', 'cat' => ''}
+      @page.find('#data').data.should == h 
+    end
+  end
+end

data/spec/element/anchor_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../helper'
+
+describe "Anchor" do
+    
+  before do
+    @anchor = CapybaraPageObject::Anchor.from_string '<a href="hello.html">'
+  end
+
+  context "#link" do
+    it "return a URI object" do
+      @anchor.link.class.should == URI::Generic
+      @anchor.link.path.should == 'hello.html'
+    end
+  end
+end

data/spec/element/base_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../helper'
+
+describe "Base" do
+  before do
+    @tag = CapybaraPageObject::Anchor.from_string '<a id="bar">content</a>'
+  end
+
+  context "#key" do
+    it "default to the ID if not overridden" do
+      @tag.key.should == 'bar'
+    end
+  end
+
+  context "#value" do
+    it "default to the text if not overridden" do
+      @tag.value.should == 'content'
+    end
+  end
+end

data/spec/element/form_field_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../helper'
+
+describe "FormField" do
+  before do
+    @input = CapybaraPageObject::FormField.from_string '<input value="hello">'
+    @textarea = CapybaraPageObject::FormField.from_string '<textarea>foo</textarea>'
+    @blank_textarea = CapybaraPageObject::FormField.from_string '<textarea></textarea>'
+  end
+
+  context "#value" do
+    it "delegates" do
+      @input.value.should == 'hello'
+      @textarea.value.should == 'foo'
+    end
+  end
+
+  context "#blank" do
+    it "is false if there is an input value" do
+      @input.should_not be_blank
+    end
+    it "is false if there is textarea content" do
+      @textarea.should_not be_blank
+    end
+    it "is true if there is no textarea content" do
+      @blank_textarea.should be_blank
+    end
+  end
+end

data/spec/element/form_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/../helper'
+
+describe "Form" do
+  before do
+    @form = CapybaraPageObject::Form.from_string <<-EOF
+    <form>
+      <input name="input_1" value="value_1">
+      <input type="text" name="text_input" value="text_input_value">
+
+      <input type="password" name="password_input" value="password">
+
+      <select name="colour">
+        <option>red</option>
+        <option selected>blue</option>
+      </select>
+
+      <select name="countries" multiple>
+        <option>france</option>
+        <option selected>spain</option>
+        <option selected>germany</option>
+      </select>
+
+      <textarea name="essay">hello world</textarea>
+      <input type="checkbox" name="checkbox_1" value="checkbox_value_1">
+      <input type="checkbox" name="checkbox_2" value="checkbox_value_2" checked>
+
+      <input type="radio" name="radio_button_1" value="radio_value_1">
+      <input type="radio" name="radio_button_2" value="radio_value_2" checked>
+
+      <input type="submit" value="submit button"></input>
+      <input type="reset" value="reset button"></input>
+      <input type="button" value="button button"></input>
+      <button>button 2</button>
+    </form>
+    EOF
+  end
+
+  context "#buttons" do
+    it "return the buttons contained in the form" do
+      @form.buttons.size.should == 4
+    end
+  end
+
+  context "#fields" do
+    it "return the fields contained in the form - inputs, selects and textareas. Excludes button type inputs (submit, reset, etc.)" do
+      f = {
+        'input_1' => 'value_1',
+        'text_input' => 'text_input_value',
+        'password_input' => 'password',
+        'colour' => 'blue',
+        'essay' => 'hello world',
+        'checkbox_1' => false,
+        'checkbox_2' => true,
+        'radio_button_1' => false,
+        'radio_button_2' => true,
+        'countries' => ['spain', 'germany']
+      }
+      @form.fields.should == f 
+    end
+  end
+
+  it "provides direct read access to form's fields" do
+    @form.essay.should == 'hello world'
+  end
+
+  it "doesn't respond to nonexistant fields" do
+    @form.should_not respond_to(:nonexistant_field)
+  end
+end