capybara-page-object 0.5.0 → 0.6.0

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

@@ -0,0 +1,10 @@
+module CapybaraPageObject
+  class FormField < CapybaraPageObject::Element
+    field(:key) { source[:name] }
+    field(:value) { source.value }
+
+    def blank?
+      value.nil? || '' == value
+    end
+  end
+end

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

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

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

@@ -0,0 +1,7 @@
+module CapybaraPageObject
+  class Image < CapybaraPageObject::Element
+    field(:key) { alt }
+    field(:value) { URI(source[:src]) }
+    field(:alt){ source[:alt].strip }
+  end
+end

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

@@ -1,5 +1,3 @@
-require 'element/text_based_input'
-
 module CapybaraPageObject
   class Input < CapybaraPageObject::FormField  
     include TextBasedInput
@@ -7,6 +5,11 @@ module CapybaraPageObject
     BUTTON_TYPES = ['submit', 'reset', 'button']
     CHECKABLE_TYPES = ['radio', 'checkbox']
 
+    # TODO this doesn't belong here
+    def checked?
+      source.checked?
+    end
+
     def untyped?
       source[:type].nil?
     end

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

@@ -1,5 +1,5 @@
 module CapybaraPageObject
-  class List < CapybaraPageObject::Node
+  class List < CapybaraPageObject::Element
     def items(*args)
       all('li').map { |e| ListItem.new(e) }
     end

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

@@ -1,5 +1,5 @@
 module CapybaraPageObject
-  class ListItem < CapybaraPageObject::Node
+  class ListItem < CapybaraPageObject::Element
     def text
       source.text.strip
     end

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

@@ -0,0 +1,6 @@
+module CapybaraPageObject
+  class Meta < CapybaraPageObject::Element
+    field(:key) { source[:name] }
+    field(:value) { source[:content] }
+  end
+end

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

@@ -1,5 +1,5 @@
 module CapybaraPageObject
-  class Table < CapybaraPageObject::Node
+  class Table < CapybaraPageObject::Element
     def rows
       all('tr').each_with_object({}) do |e, hash|
         tr = CapybaraPageObject::TableRow.new(e)

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

@@ -0,0 +1,4 @@
+module CapybaraPageObject
+  class TableHeader < CapybaraPageObject::Element
+  end
+end

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

@@ -1,5 +1,5 @@
 module CapybaraPageObject
-  class TableRow < CapybaraPageObject::Node
+  class TableRow < CapybaraPageObject::Element
     def header?
       source.all('th').any?
     end

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

@@ -1,7 +1,5 @@
-require 'element/text_based_input'
-
 module CapybaraPageObject
-  class Textarea < CapybaraPageObject::Node
+  class Textarea < CapybaraPageObject::Element
     include TextBasedInput
     def blank?
       '' == text

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

@@ -0,0 +1,7 @@
+module Capybara
+  module Node
+    class Simple
+      include CapybaraPageObject::HTML5Data
+    end
+  end
+end

data/lib/capybara-page-object/extensions/enumerable.rb

@@ -0,0 +1,10 @@
+# need to add each_with_object for Ruby 1.8.7
+module Enumerable
+  def each_with_object(memo)
+    return to_enum :each_with_object, memo unless block_given?
+    each do |element|
+      yield element, memo
+    end
+    memo
+  end
+end

data/lib/{node.rb → capybara-page-object/node.rb}

@@ -1,18 +1,13 @@
-require 'collections'
-require 'key_value'
-require 'html5_data'
-require 'delegators'
+require 'capybara-page-object/delegators'
+
 
 module CapybaraPageObject
-  class Node < Capybara::Node::Element
+  class Node
     include Delegators
-    include CapybaraPageObject::Collections
-    include CapybaraPageObject::HTML5Data
 
     attr_accessor :source
 
     def initialize(source=nil)
-      source ||= Capybara.current_session
       @source = source
     end
 
@@ -24,8 +19,17 @@ module CapybaraPageObject
       classes_list = source[:class] or return []
       classes_list.split(' ')
     end
-  end
 
-  class MissingPath < RuntimeError
+    def source
+      @source ||= Capybara.current_session
+    end
+
+    def self.element(name, &block)
+      define_method(name, &block)
+    end
+
+    def self.field(name, &block)
+      define_method(name, &block)
+    end
   end
 end

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

@@ -0,0 +1,77 @@
+require 'capybara-page-object/node'
+require 'capybara-page-object/collections'
+
+module CapybaraPageObject
+
+  module InstanceMethods
+    def path(*args)
+      raise MissingPath, "You need to override #path in #{self.class}"
+    end
+
+    def prefix
+      '/'
+    end
+
+    def visit_path(attr)
+      target = prefix + path
+      if attr.kind_of?(String)
+        target += attr
+      elsif attr.kind_of?(Hash)
+        pairs = attr.map { |k, v| "#{k}=#{v}" }
+        target += '?' + pairs.join('&') if pairs.any?
+      elsif attr != nil
+        raise ArgumentError
+      end
+      source.visit target
+    end    
+  end
+
+  module ClassMethods
+    def from_string(string, target)
+      new(Capybara.string(string).find(target))
+    end
+
+    def current?
+      page = new
+      page.source.current_path == page.prefix + page.path
+    end
+
+    def visit(attr={})
+      page = new
+      page.visit_path(attr)
+      page
+    end
+  end
+
+  class Page < CapybaraPageObject::Node
+    # TODO why doesn't this work when in the module?
+    def tables
+      all('table').each_with_object({}) do |e, hash|
+        t = CapybaraPageObject::Table.new(e)
+        hash[t.key] = t
+      end
+    end
+
+    def forms
+      all('form').each_with_object({}) do |e, hash|
+        f = CapybaraPageObject::Form.new(e)
+        hash[f.key] = f
+      end
+    end
+
+    def self.path(p)
+      define_method(:path) { p }
+    end
+
+    def self.component(name, &block)
+      define_method(name, &block)
+    end
+
+    include CapybaraPageObject::Collections
+    include CapybaraPageObject::InstanceMethods
+    extend CapybaraPageObject::ClassMethods
+  end
+
+  class MissingPath < RuntimeError
+  end
+end

data/spec/common_spec.rb

@@ -3,20 +3,20 @@ require 'helper'
 describe "Page" do
   before do
     html = File.open(File.dirname(__FILE__) + '/fixtures/node.html').read
-    @page = CapybaraPageObject::Node.from_string html, 'body'
+    @page = CapybaraPageObject::Page.from_string html, 'body'
   end
 
   context "#tables" do
     it "returns a hash of Tables keyed by ID" do
       tables = @page.tables
-      tables.keys.should == ['table_1', 'table_2']
+      tables.keys.should =~ ['table_1', 'table_2']
       tables['table_1'].class.should == CapybaraPageObject::Table
     end
   end
 
   context "#forms" do
-    pending "returns a hash of Forms keyed by ID" do
-      @page.forms.should == ['form_1', 'form_2']
+    it "returns a hash of Forms keyed by ID" do
+      @page.forms.keys.should =~ ['form_1', 'form_2']
       @page.forms['form_1'].class.should == CapybaraPageObject::Form
     end
   end
@@ -24,13 +24,13 @@ describe "Page" do
   context "#data" do
     it "returns an empty hash if the element has no HTML5 data attributes" do
       html = '<div foo="bar"/>'
-      @fragment = CapybaraPageObject::Node.from_string html, 'div'
+      @fragment = CapybaraPageObject::Element.from_string html, 'div'
       @fragment.data.should == {}
     end
 
     it "returns a hash of the elements HTML5 data attributes" do
       html = '<div id="data" data-foo="a" data-bar="b" data-cat>Some data</div>'
-      @fragment = CapybaraPageObject::Node.from_string html, 'div'
+      @fragment = CapybaraPageObject::Element.from_string html, 'div'
       h = {'foo' => 'a', 'bar' => 'b', 'cat' => ''}
       @fragment.data.should == h 
     end

data/spec/element/anchor_spec.rb

@@ -7,9 +7,14 @@ describe "Anchor" do
   end
 
   context "#link" do
-    it "return a URI object" do
-      @anchor.link.class.should == URI::Generic
-      @anchor.link.path.should == 'hello.html'
+    it "return the link" do
+      @anchor.link.should == 'hello.html'
+    end
+  end
+
+  context "#uri" do
+    it "return the link as a URI" do
+      @anchor.uri.should == URI('hello.html')
     end
   end
 end

data/spec/element/form_field_spec.rb

@@ -2,11 +2,17 @@ require 'helper'
 
 describe "FormField" do
   before do
-    @input = CapybaraPageObject::FormField.from_string '<input value="hello">', 'input'
+    @input = CapybaraPageObject::FormField.from_string '<input name="greeting" value="hello">', 'input'
     @textarea = CapybaraPageObject::FormField.from_string '<textarea>foo</textarea>', 'textarea'
     @blank_textarea = CapybaraPageObject::FormField.from_string '<textarea></textarea>', 'textarea'
   end
 
+  context "#key" do
+    it "returns the name of the form field" do
+      @input.key.should == 'greeting'
+    end
+  end
+
   context "#value" do
     it "delegates" do
       @input.value.should == 'hello'

data/spec/element/form_spec.rb

@@ -42,23 +42,33 @@ describe "Form" do
     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
+  context "#inputs" do
+    it "returns the inputs on the page (excluding buttons)" do
+      @form.inputs.keys.should == ["input_1", "text_input", "password_input", "checkbox_1",
+        "checkbox_2", "radio_button_1", "radio_button_2"]
+    end
+  end
+
+  context "#textareas" do
+    it "returns the textareas on the page" do
+      @form.textareas.keys.should == ["essay"]
+    end
+  end
+
+  context "#selects" do
+    it "returns the selects on the page" do
+      @form.selects.keys.should == ["colour", "countries"]
+    end
+  end
+
+  context "#fields" do
+    it "merges inputs, textareas and selects" do
+      @form.stub!(:inputs => {'a' => 1})
+      @form.stub!(:textareas => {'b' => 2})
+      @form.stub!(:selects => {'c' => 3})
+      @form.fields.should == {'a' => 1, 'b' => 2, 'c' => 3}
+    end
+  end
 
   # it "provides direct read access to form's fields" do
   #   @form.essay.should == 'hello world'

data/spec/helper.rb

@@ -12,4 +12,17 @@ require 'rspec'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+unless ENV["SKIP_COVERAGE"]
+  require 'simplecov'
+
+  SimpleCov.start
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    if SimpleCov.result.covered_percent < 100
+      `open coverage/index.html`
+     end
+  end
+end
+
 require 'capybara-page-object'

data/spec/node_spec.rb

@@ -18,5 +18,14 @@ describe "Page" do
       anchor = CapybaraPageObject::Anchor.from_string '<a/>', 'a'
       anchor.classes.should be_empty
     end
+
+    it "has a nice DSL" do
+      source = mock
+      source.should_receive(:find_button).with('place_order')
+      class Bar < CapybaraPageObject::Node
+        element(:place_order) { source.find_button('place_order') }
+      end
+      Bar.new(source).place_order
+    end
   end
 end

data/spec/page_spec.rb

@@ -1,37 +1,97 @@
-class FooPage < CapybaraPageObject::Page
-  def path
-    '/foo'
+require 'active_support/ordered_hash'
+require File.dirname(__FILE__) + '/../lib/capybara-page-object/page'
+
+describe "a class which extends CapybaraPageObject::Page" do
+
+  before do
+    class FooShow < CapybaraPageObject::Page
+      def path
+        'foos/'
+      end
+    end
+    class FooIndex < CapybaraPageObject::Page
+      def path
+        'foos'
+      end
+    end
   end
-end
 
-describe "Page" do
-  context "#new" do
-    it "visits the appropriate when initialised" do
-      mock_source = mock()
-      mock_source.should_receive(:current_path)
-      mock_source.should_receive(:visit).with('/foo')
-      @page = FooPage.new(nil, mock_source)
-    end
-    
-    it "supports key-value pairs" do
-      mock_source = mock()
-      mock_source.should_receive(:current_path)
-      mock_source.should_receive(:visit).with('/foo?a=1&b=2')
-      # intential mix of string and symbol keys below
-      @page = FooPage.new({'a' => 1, :b => 2}, mock_source)
-    end
-  
-    it "raises an exception if revisiting" do
-      s = stub('Capybara', :current_path => '/foo', :visit => nil)
-      lambda do
-        @page = FooPage.new(nil, s)
-      end.should raise_error(RuntimeError, 'Detected repeat of page load - use #reload instead')
+  context ".current?" do
+    it "is true if the path matches the current session path" do
+      Capybara.stub :current_session => mock(:current_path => '/foos')
+      FooIndex.should be_current
+    end
+
+    it "is false if the path doesn't match the current session path" do
+      Capybara.stub :current_session => mock(:current_path => '/foos/1')
+      FooIndex.should_not be_current
     end
   end
-  
-  context "#refresh" do
-    pending "revisits the page" do
-      # TODO implemented but untested
+
+  context ".visit" do
+    it "visits the appropriate path" do
+      session = mock
+      session.should_receive(:visit).with('/foos')
+      Capybara.stub :current_session => session
+      FooIndex.visit
+    end
+
+    it "throws an error if path hasn't been overridden" do
+      lambda do
+        CapybaraPageObject::Page.visit
+      end.should raise_error(CapybaraPageObject::MissingPath, 'You need to override #path in CapybaraPageObject::Page')
+    end
+
+    it "converts a supplied hash into querystring paramaters" do
+      session = mock
+      session.should_receive(:visit).with('/foos?a=1&b=2')
+      Capybara.stub :current_session => session
+      # using an OrderedHash so we can guarantee the order on Ruby 1.8
+      # also, the mix of string and symbol keys is intentional
+      # for some reason, passing in the hash to the initializer fails when
+      # running via Rake
+      key_values = ActiveSupport::OrderedHash.new
+      key_values['a'] = 1
+      key_values[:b] = 2
+      @page = FooIndex.visit key_values
+    end
+
+    it "converts a supplied string into a resource identifier" do
+      session = mock()
+      session.should_receive(:visit).with('/foos/bar')
+      Capybara.stub :current_session => session
+      @page = FooShow.visit 'bar'
+    end
+
+    it "returns an instance of the page object" do
+      Capybara.stub :current_session => stub.as_null_object
+      FooIndex.visit.class.should == FooIndex
+    end
+
+    it "throws an error if the supplied argument is something other a string or hash" do
+      lambda do
+        FooIndex.visit Object
+      end.should raise_error ArgumentError
+    end
+
+    it "has a DSL for setting the path" do
+      class Blah < CapybaraPageObject::Page
+        path 'xyz'
+      end
+      session = mock()
+      session.should_receive(:visit).with('/xyz')
+      Capybara.stub :current_session => session
+      @page = Blah.visit
+    end
+
+    it "has a DSL for setting components" do
+      class Blah < CapybaraPageObject::Page
+        component(:navigation) { source.find('#navigation') }
+      end
+      session = mock
+      session.should_receive(:find).with('#navigation')
+      Capybara.stub :current_session => session
+      Blah.new.navigation
     end
   end
 end