capybara-js_finders 0.3.0 → 0.4.0

data/README.md

@@ -76,7 +76,7 @@ assert find_cell(:row => "Andrew Bon", :column => "Email").has_no_content?("john
 assert find_cell(:row => "John Smith", :column => "January", :text => "28").has_text?("Present at work")
 ```
 
-#### Multicolumn and multirows support
+#### Multicolumn and multirow support
 
 If there are many rows and/or columns matching `:row` and/or `:column` parameter you can wider the search to include all of them
 by using `:multirow` and/or `:multicolumn` action.
@@ -127,6 +127,39 @@ find_cell(:row => "John Smith", :column => "Permissions", :text => "Moderator")
 find_cell(:multirow => true, :row => "John Smith", :column => "Permissions", :text => "Moderator") # will find the proper cell
 ```
 
+#### Performance
+
+Current implementation calculates the position of every th or td element on a page.
+This might be slow especially when there are many such elements on the page. You if you have multiple
+subsequent `find_cell` invocations and you know that the page does not change between them
+you might use `static_page(&block)` method to improve the overall performance. Only first
+call to `find_cell` will calculate cells' positions and the following checks will
+reuse those values.
+
+##### Example:
+
+```ruby
+
+click_link("Permissions")
+
+static_page do
+  find_cell(:row => "John Smith", :column => "Permissions") # execute JS to calculate elements' positions
+  find_cell(:row => "Andrew Bon", :column => "Email")       # JS is not executed
+end
+
+click_link("Posts")
+
+static_page do
+  find_cell(:row => "Ruby is Awesome", :column => "Published at")       # execute JS to calculate elements' positions
+  find_cell(:row => "And CoffeScript too", :column => "Published at")   # JS is not executed
+end
+
+click_link("Visitors")
+
+find_cell(:row => "June 2011", :column => "Visitors")   # JS script is always executed outside static_page block
+find_cell(:row => "July 2011", :column => "Page views") # JS script is always executed outside static_page block
+```
+
 ## License
 
 MIT License

data/lib/capybara-js_finders/capybara_extensions.rb

@@ -8,9 +8,14 @@ Capybara::DSL.module_eval do
   def execute_script(*args, &block)
     page.execute_script(*args, &block)
   end
+
   def find_cell(*params, &block)
     page.find_cell(*params, &block)
   end
+
+  def static_page(&block)
+    page.static_page(&block)
+  end
 end
 
 require 'capybara'
@@ -19,15 +24,22 @@ Capybara::Node::Base.module_eval do
   def execute_script(script)
     driver.execute_script(script)
   end
+
   def evaluate_script(script)
     driver.evaluate_script(script)
   end
 end
 
-Capybara::Session::NODE_METHODS << :find_cell
-Capybara::Session::DSL_METHODS  << :find_cell
+
+Capybara::Session::NODE_METHODS.concat(Capybara::JsFinders::NEW_METHODS)
+Capybara::Session::DSL_METHODS.concat(Capybara::JsFinders::NEW_METHODS)
+
 Capybara::Session.class_eval do
   def find_cell(*params, &block)
     current_node.find_cell(*params, &block)
   end
+
+  def static_page(&block)
+    current_node.static_page(&block)
+  end
 end

data/lib/capybara-js_finders/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module JsFinders
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/capybara-js_finders.rb

@@ -12,6 +12,7 @@ module Capybara
     TR = "tr".freeze # Top range
     BR = "br".freeze # Bottom range
     XpathTrue = "(1=1)"
+    NEW_METHODS = [:find_cell, :static_page].freeze
 
     # TODO: This script is only prototype compatible. Let it discover jquery or prototype and use proper methods.
     # 
@@ -133,13 +134,28 @@ module Capybara
       end
       rows = Array.wrap(rows)
 
-      execute_script(SCRIPT)
+      if @static_page
+        execute_script(SCRIPT) unless @executed
+        @executed = true
+      else
+        execute_script(SCRIPT)
+      end
       xpath = JsFinders.cell_condition(columns, rows)
-      xpath = ".//td[ #{xpath} ]"
+      xpath = ".//td[ #{xpath} ]" # TODO: td or th ?
       # puts xpath
       find(:xpath, xpath, options)
     end
+
+    def static_page(&block)
+      @static_page = true
+      return block.call
+    ensure
+      @executed = false
+      @static_page = false
+    end
+
   end
+
 end
 
 require "capybara-js_finders/capybara_extensions"

data/test/unit/find_cell_tests/app/views/table.erubis

@@ -4,6 +4,13 @@
   </head>
 
   <body>
+
+    <div id="me" style="background-color: purple; width: 100%; height: 50px;">
+        <a href="/x" onclick="Element.hide('me'); return false;">Hide me</a>
+    </div>
+
+    <br/>
+
     <table cellpadding="15" cellspacing="15" border="2">
       <tr>
         <td>

data/test/unit/find_cell_tests/basic_test.rb

@@ -93,6 +93,38 @@ module FindCellTests
       assert ! user.find_cell(:column => "March 2013", :text => "13").has_content?("March")
     end
 
+    def test_assume_static_page
+      user.visit '/'
+
+      red = user.find(:xpath, XPath::HTML.cell("red").to_s )
+      attributes = [Capybara::JsFinders::LR, Capybara::JsFinders::RR, Capybara::JsFinders::TR, Capybara::JsFinders::BR]
+      attributes.each {|attr| assert_nil red[attr]}
+      positions = nil
+
+      user.static_page do
+        user.find_cell(:row => "OneRow", :column => "OneColumn", :text => "red")
+        positions = attributes.map do |attr|
+          assert red[attr]
+          red[attr]
+        end
+
+        user.click_link("Hide me") # Changes positions of elements
+
+        user.find_cell(:row => "OneRow", :column => "OneColumn", :text => "red") # Find the cell but without recalculating positions because we are inside static_page block
+        assert_equal positions, attributes.map{|attr| red[attr] } # Attributes store the same positions as after first find_cell call
+      end
+
+      user.find_cell(:row => "OneRow", :column => "OneColumn", :text => "red") # Find the cell but recalculates positions because we are outside of static_page block
+      assert_not_equal positions, attributes.map{|attr| red[attr] } # Attributes store different positions than after first find_cell call
+
+      user.visit '/'
+      user.static_page do # Make sure that another use of static_page again recalculates positions for first find_cell query
+        red = user.find_cell(:row => "OneRow", :column => "OneColumn", :text => "red")
+        attributes.map { |attr| assert red[attr] }
+      end
+    end
+
+    
     private
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-js_finders
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-27 00:00:00.000000000 +02:00
+date: 2011-07-28 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &72850780 !ruby/object:Gem::Requirement
+  requirement: &71901060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *72850780
+  version_requirements: *71901060
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &72850530 !ruby/object:Gem::Requirement
+  requirement: &71900800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *72850530
+  version_requirements: *71900800
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &72850300 !ruby/object:Gem::Requirement
+  requirement: &71900560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 2.4.2
   type: :development
   prerelease: false
-  version_requirements: *72850300
+  version_requirements: *71900560
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &72850070 !ruby/object:Gem::Requirement
+  requirement: &71900330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.2.6
   type: :development
   prerelease: false
-  version_requirements: *72850070
+  version_requirements: *71900330
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &72849840 !ruby/object:Gem::Requirement
+  requirement: &71900100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 2.6.6
   type: :development
   prerelease: false
-  version_requirements: *72849840
+  version_requirements: *71900100
 - !ruby/object:Gem::Dependency
   name: bbq
-  requirement: &72849610 !ruby/object:Gem::Requirement
+  requirement: &71899850 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 0.0.3
   type: :development
   prerelease: false
-  version_requirements: *72849610
+  version_requirements: *71899850
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &72849380 !ruby/object:Gem::Requirement
+  requirement: &71899490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '1.17'
   type: :development
   prerelease: false
-  version_requirements: *72849380
+  version_requirements: *71899490
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &72849190 !ruby/object:Gem::Requirement
+  requirement: &71899180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72849190
+  version_requirements: *71899180
 description: ! "    Additional finders for capybara that for some reason\n    cannot
   use only xpath for finding nodes but needs to\n    execute js for some calculations.\n\n
   \   Ex: I you want to find a table cell\n    that is under or next to other cell
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1067246483
+      hash: -1004171375
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1067246483
+      hash: -1004171375
 requirements: []
 rubyforge_project: capybara-js_finders
 rubygems_version: 1.6.2