capybara-page-object 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/capybara-page-object.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{capybara-page-object}
-  s.version = "0.1.0"
+  s.name = "capybara-page-object"
+  s.version = "0.2.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-03-25}
-  s.description = %q{Page Objects for Capybara}
-  s.email = %q{andy@andywaite.com}
+  s.authors = ["Andy Waite"]
+  s.date = "2012-03-26"
+  s.description = "Page Objects for Capybara"
+  s.email = "andy@andywaite.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -25,16 +25,26 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "capybara-page-object.gemspec",
+    "lib/base.rb",
     "lib/capybara-page-object.rb",
-    "test/example.html",
+    "lib/extractors/common.rb",
+    "lib/extractors/page_level.rb",
+    "lib/image.rb",
+    "lib/page.rb",
+    "lib/table.rb",
     "test/helper.rb",
-    "test/test_capybara-page-object.rb"
+    "test/image.html",
+    "test/page.html",
+    "test/table.html",
+    "test/test_image.rb",
+    "test/test_page.rb",
+    "test/test_table.rb"
   ]
-  s.homepage = %q{http://github.com/andyw8/capybara-page-object}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Page Objects for Capybara}
+  s.homepage = "http://github.com/andyw8/capybara-page-object"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Page Objects for Capybara"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/base.rb

@@ -0,0 +1,23 @@
+module CapybaraPageObject
+  class Base
+    include Extractors::Common
+
+    attr_accessor :source
+
+    def initialize(source=nil)
+      source ||= Capybara.current_session
+      @source = source
+    end
+
+    def path(*args)
+      raise PageObjectMissingPath, "You need to override this"
+    end
+
+    def visit
+      source.visit path
+    end
+  end
+
+  class MissingPath < RuntimeError
+  end
+end

data/lib/capybara-page-object.rb

@@ -1,61 +1,15 @@
 require 'rubygems'
 require 'capybara'
+require File.dirname(__FILE__) + '/extractors/common'
+require File.dirname(__FILE__) + '/extractors/page_level'
+require File.dirname(__FILE__) + '/page'
+require File.dirname(__FILE__) + '/table'
+require File.dirname(__FILE__) + '/image'
 
 module Capybara
   module Node
     module Finders
-      def title
-        find('title').text
-      end
-
-      def tables(attr={})
-        extract('table', attr)
-      end
-
-      def forms(attr={})
-        extract('form', attr)
-      end
-
-      def rows(attr={})
-        extract('tr', attr)
-      end
-
-      def headers(attr={})
-        extract('th', attr)
-      end
-
-      def meta_description
-        extract('meta', :by => 'name')['description']['content']
-      end
-      
-      def meta_keywords
-        extract('meta', :by => 'name')['keywords']['content'].split(',').collect(&:strip)
-      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
-
-      private
-
-      def extract(element, attr={})
-        by = attr[:by]
-        if by
-          r = {}
-          all(element).each do |t|
-            r[t[by]] = t
-          end
-          r
-        else
-          all(element)
-        end
-      end
+      include Extractors::PageLevel
     end
   end
 end

data/lib/extractors/common.rb

@@ -0,0 +1,50 @@
+module Extractors
+  
+  module Common
+    def extract(element, attr={}, page_object_class=nil)
+      by = attr[:by]
+      keys = attr[:keys]
+      if keys
+        r = []
+        all(element).each do |t|
+          r << t[keys]
+        end
+        r
+      elsif by
+        r = {}
+        all(element).each do |t|
+          if page_object_class
+            r[t[by]] = page_object_class.new(t)
+          else
+            r[t[by]] = t
+          end
+        end
+        r
+      else
+        if page_object_class
+          all(element).collect{ |e| page_object_class.new(e) }
+        else
+          all(element).collect
+        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
+  
+    def all(*args)
+      source.all(*args)
+    end
+  
+    def find(*args)
+      source.find(*args)
+    end
+    
+  end
+end

data/lib/extractors/page_level.rb

@@ -0,0 +1,25 @@
+module Extractors
+  module PageLevel
+    include Common
+    
+    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
+  
+    def meta_keywords
+      extract('meta', :by => 'name')['keywords']['content'].split(',').collect(&:strip)
+    end
+  end
+end

data/lib/image.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/base'
+
+module CapybaraPageObject
+  class Image < CapybaraPageObject::Base
+    def src
+      source.find('img')[:src]
+    end
+
+    def alt
+      source.find('img')[:alt].strip
+    end
+  end
+end

data/lib/page.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/base'
+
+module CapybaraPageObject
+  class Page < CapybaraPageObject::Base
+    include Extractors::PageLevel
+
+    def initialize(source)
+      if source
+        @source = source
+      else
+        @source = Capybara.current_session
+      end
+    end
+  end
+end

data/lib/table.rb

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

data/test/helper.rb

@@ -16,3 +16,9 @@ require 'capybara-page-object'
 
 class Test::Unit::TestCase
 end
+
+def load_sample_into_model(model)
+  filename = model.to_s.split('::').last + '.html'
+  html = File.open(File.dirname(__FILE__) + '/' + filename).read
+  model.new(Capybara.string(html))
+end

data/test/image.html

@@ -0,0 +1,2 @@
+<img src="image1.jpg" alt="image 1">
+<img src="image2.jpg" alt="image 2">

data/test/table.html

@@ -0,0 +1,10 @@
+<table id="table_1" class="table_1_class">
+  <tr id="table_1_tr_1">
+    <th id="table_1_th_1">TH1</th>
+    <th id="table_1_th_2">TH2</th>
+  </tr>
+  <tr id="table_1_tr_2">
+    <td id="table_1_td_1">TD1</td>
+    <td id="table_1_td_2">TD2</td>
+  </tr>
+</table>

data/test/test_image.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/helper'
+require 'capybara'
+
+class TestImage< Test::Unit::TestCase
+  context "" do
+    setup do
+      @image = load_sample_into_model(CapybaraPageObject::Image)
+    end
+
+    should "src" do
+      assert_equal 'image_1.jpg', @image.src
+    end
+    
+    should "src" do
+      assert_equal 'image 1', @image.alt
+    end
+    
+  end
+
+end

data/test/test_page.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/helper'
+require 'capybara'
+
+class TestCapybaraPageObject < Test::Unit::TestCase
+
+  context "Using the example.html" do
+
+    setup do
+      @page = load_sample_into_model(CapybaraPageObject::Page)
+    end
+
+    should "page title" do
+      assert_equal 'Hello World', @page.title
+    end
+    
+    should "tables" do
+      tables = @page.tables
+      assert_equal CapybaraPageObject::Table, tables[0].class
+      assert_equal CapybaraPageObject::Table, tables[0].class
+    end
+
+    should "tables by id" do
+      tables = @page.tables(:by => 'id')
+      assert_equal CapybaraPageObject::Table, tables['table_1'].class
+      assert_equal CapybaraPageObject::Table, tables['table_2'].class
+    end
+
+    should "forms" do
+      assert_equal ['form_1', 'form_2'], @page.forms(:keys => 'id')
+    end
+
+    should "meta_description" do
+      assert_equal "meta description", @page.meta_description
+    end
+
+    should "meta_keywords" do
+      assert_equal ["meta keyword 1", "meta keyword 2"], @page.meta_keywords
+    end
+
+    should "return the elements as a hash" do
+      assert_same_elements ['table_1', 'table_2'], @page.tables(:keys => 'id')
+      assert_same_elements ['table_1_class', 'table_2_class'], @page.tables(:keys => 'class')
+    end
+
+    should "data" do
+      h = {'foo' => 'a', 'bar' => 'b', 'cat' => ''}
+      assert_equal h, @page.find('#data').data
+    end
+
+    context "#path" do
+      should "raise exception if path not defined" do
+        assert_raise CapybaraPageObject::MissingPath do
+          @page.path
+        end
+      end
+    end
+
+  end
+end

data/test/test_table.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/helper'
+require 'capybara'
+
+class TestTable< Test::Unit::TestCase
+  context "" do
+    setup do
+      @table = load_sample_into_model(CapybaraPageObject::Table)
+    end
+    
+    should "rows" do
+      assert_same_elements ['table_1_tr_1', 'table_1_tr_2'], @table.rows(:keys => 'id')
+    end
+
+    should "headers" do
+      assert_same_elements ["table_1_th_1", "table_1_th_2"], @table.headers(:keys => 'id')
+    end
+    
+  end
+
+end

metadata

@@ -1,79 +1,106 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: capybara-page-object
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Andy Waite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: &2159420260 !ruby/object:Gem::Requirement
+
+date: 2012-03-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: capybara
   prerelease: false
-  version_requirements: *2159420260
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &2159419360 !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: shoulda
   prerelease: false
-  version_requirements: *2159419360
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &2159418440 !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-  type: :development
+  version_requirements: *id003
+  name: bundler
   prerelease: false
-  version_requirements: *2159418440
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &2159416500 !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
         version: 1.6.4
-  type: :development
+  version_requirements: *id004
+  name: jeweler
   prerelease: false
-  version_requirements: *2159416500
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2159415820 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: rcov
   prerelease: false
-  version_requirements: *2159415820
+  type: :development
 description: Page Objects for Capybara
 email: andy@andywaite.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - .document
 - Gemfile
 - Gemfile.lock
@@ -82,36 +109,52 @@ files:
 - Rakefile
 - VERSION
 - capybara-page-object.gemspec
+- lib/base.rb
 - lib/capybara-page-object.rb
-- test/example.html
+- lib/extractors/common.rb
+- lib/extractors/page_level.rb
+- lib/image.rb
+- lib/page.rb
+- lib/table.rb
 - test/helper.rb
-- test/test_capybara-page-object.rb
+- test/image.html
+- test/page.html
+- test/table.html
+- test/test_image.rb
+- test/test_page.rb
+- test/test_table.rb
 homepage: http://github.com/andyw8/capybara-page-object
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2260030659624604151
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Page Objects for Capybara
 test_files: []
+

data/test/test_capybara-page-object.rb

@@ -1,52 +0,0 @@
-require_relative 'helper'
-require 'capybara'
-
-class TestCapybaraPageObject < Test::Unit::TestCase
-
-  context "Using the example.html" do
-
-    setup do
-      html = File.open(File.dirname(__FILE__) + '/example.html').read
-      @doc = Capybara.string(html)
-    end
-
-    should "page title" do
-      assert_equal 'Hello World', @doc.title
-    end
-
-    should "tables" do
-      assert_same_elements ['table_1', 'table_2'], @doc.tables.collect{ |t| t[:id] }
-    end
-
-    should "rows" do
-      assert_same_elements ['table_1_tr_1', 'table_1_tr_2'], @doc.tables.first.rows.collect{ |t| t[:id] }
-    end
-
-    should "headers" do
-      assert_same_elements ["table_1_th_1", "table_1_th_2"], @doc.tables.first.headers.collect{ |t| t[:id] }
-    end
-
-    should "forms" do
-      assert_equal ['form_1', 'form_2'], @doc.forms.collect{ |f| f[:id] }
-    end
-
-    should "meta_description" do
-      assert_equal "meta description", @doc.meta_description
-    end
-
-    should "meta_keywords" do
-      assert_equal ["meta keyword 1", "meta keyword 2"], @doc.meta_keywords
-    end
-
-    should "return the elements as a hash" do
-      assert_same_elements ['table_1', 'table_2'], @doc.tables(:by => 'id').keys
-      assert_same_elements ['table_1_class', 'table_2_class'], @doc.tables(:by => 'class').keys
-    end
-
-    should "data" do
-      h = {'foo' => 'a', 'bar' => 'b', 'cat' => ''}
-      assert_equal h, @doc.find('#data').data
-    end
-
-  end
-end