symbiont 0.1.6 → 0.1.7

data/.gitignore

@@ -3,6 +3,7 @@
 *.rbc
 *.swo
 *.swp
+.idea
 .bundle
 .config
 .yardoc

data/Gemfile.lock

@@ -1,27 +1,28 @@
 PATH
   remote: .
   specs:
-    symbiont (0.1.3)
+    symbiont (0.1.6)
       watir-webdriver (= 0.6.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.8)
+    addressable (2.3.2)
     builder (3.0.0)
-    childprocess (0.3.2)
-      ffi (~> 1.0.6)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
     diff-lcs (1.1.3)
-    ffi (1.0.11)
+    ffi (1.1.5)
+    ffi (1.1.5-x86-mingw32)
     gherkin (2.11.1-x86-mingw32)
       json (>= 1.4.6)
     json (1.7.3)
-    libwebsocket (0.1.3)
+    libwebsocket (0.1.5)
       addressable
     multi_json (1.3.5)
     rspec (2.11.0)
@@ -32,8 +33,8 @@ GEM
     rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.1)
-    rubyzip (0.9.8)
-    selenium-webdriver (2.24.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
       childprocess (>= 0.2.5)
       libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)

data/HISTORY.md

@@ -1,6 +1,12 @@
 Change Log and History
 ======================
 
+Version 0.1.7 / 2012-10-16
+--------------------------
+
+This release allows common Watir-type method calls to be callable on web objects directly. For example, you can now call 'id', 'value' and so on directly on the web objects. For a checkbox, you can directly call 'check' and 'uncheck'. This is as opposed to before where you had to use Symbiont's generated method structure, such as 'check_myCheckbox' (where myCheckbox was a declared checkbox web object). The other main element that was added was an encloser (within_window) that will allow you to essentially "attach" to a browser window and provide a set of actions in the context of that window.
+
+
 Version 0.1.6 / 2012-09-30
 --------------------------
 

data/lib/symbiont.rb

@@ -35,6 +35,12 @@ module Symbiont
     caller.extend Symbiont::Enclosers
   end
 
+  # Returns the default wait value for pages. This value is the default
+  # value beyond which a timeout is assumed.
+  def self.page_level_wait
+    @page_wait ||= 15
+  end
+
   # The initialize method will be invoked when a page definition includes
   # Symbiont. Some key things are happening here that are critical to
   # Symbiont working correctly:

data/lib/symbiont/enclosers.rb

@@ -1,6 +1,22 @@
 module Symbiont
   module Enclosers
-    
+
+    # Used to identify a web object or action on a web object as existing
+    # within an enclosing window object. The window can be referenced using
+    # either the title attribute of the window or a direct URL. The URL does
+    # not have to be the entire URL; it can just be a page name.
+    #
+    # @param [Hash] locator the :title or :url of the window
+    # @param [Proc; optional] block any code that should be executed as an
+    # action on or within the window
+    #
+    # @example
+    #   page.within_window(title: "Report Page")
+    #   page.within_window(url: report.html)
+    def within_window(locator, &block)
+      @platform.within_window(locator, &block)
+    end
+
     # Used to identify a web object as existing within an enclosing object
     # like a frame or an iframe. It is possible to nest by passing in parent
     # enclosers as the second parameter.
@@ -35,8 +51,8 @@ module Symbiont
     #   @page.wait_for(5, 'page with expected title not found') do
     #     @page.title.should == "Test App"
     #   end
-    def wait_for(message=nil, timeout=10, &block)
-      @platform.wait_for(message, timeout, &block)
+    def wait_for(timeout=Symbiont.page_level_wait, message=nil, &block)
+      @platform.wait_for(timeout, message, &block)
     end
     
     # Provides a context for an action that will generate a JavaScript alert

data/lib/symbiont/evaluators.rb

@@ -59,7 +59,10 @@ module Symbiont
     def wait_for_pending_requests(timeout=30, message=nil)
       end_time = ::Time.now + timeout
       until ::Time.now > end_time
-        return if @browser.run_script('return jQuery.active') == 0
+        begin
+          return if @browser.execute_script('return jQuery.active') == 0
+        rescue ReferenceError
+        end
         sleep 0.5
       end
       message = "Pending requests never indicated completion" unless message

data/lib/symbiont/platform_watir/platform_object.rb

@@ -67,10 +67,18 @@ module Symbiont
         
         # Platform method to wait for an action to complete in a given time.
         # @see Symbiont::Enclosers#wait_for
-        def wait_for(message="wait condition not found", timeout, &block)
+        def wait_for(timeout, message="wait condition not found", &block)
           @browser.wait_until(timeout, message, &block)
         end
-        
+
+        # Platform method to reference web objects in the context of a
+        # window.
+        # @see Symbiont::Enclosers#within_window
+        def within_window(locator, &block)
+          identifier = {locator.keys.first => /#{Regexp.escape(locator.values.first)}/}
+          @browser.window(identifier).use(&block)
+        end
+
         # Platform method to handle an alert message box.
         # @see Symbiont::Enclosers#will_alert
         def will_alert(&block)

data/lib/symbiont/version.rb

@@ -1,3 +1,3 @@
 module Symbiont
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/symbiont/web_objects/_common.rb

@@ -24,7 +24,7 @@ module Symbiont
       end
       
       def visible?
-        @web_object.visible?
+        @web_object.present?
       end
       
       def text
@@ -51,6 +51,22 @@ module Symbiont
         @web_object.tag_name
       end
       
+      def id
+        @web_object.id
+      end
+      
+      def value
+        @web_object.value
+      end
+      
+      def inspect
+        @web_object.inspect
+      end
+      
+      def flash
+        @web_object.flash
+      end
+      
       def when_actionable(timeout=5)
         @web_object.wait_until_present(timeout)
         self

data/lib/symbiont/web_objects/checkbox.rb

@@ -2,7 +2,19 @@ module Symbiont
   module WebObjects
 
     class CheckBox < WebObject
-
+      
+      def check
+        @web_object.set
+      end
+      
+      def uncheck
+        @web_object.clear
+      end
+      
+      def checked?
+        @web_object.set?
+      end
+      
     end # class: CheckBox
     
     ::Symbiont::WebObjects.class_for_type[:checkbox] = ::Symbiont::WebObjects::CheckBox

data/spec/symbiont/enclosers_spec.rb

@@ -15,7 +15,7 @@ describe Symbiont::Enclosers do
     
     it "should wait for a condition to be true" do
       watir_browser.should_receive(:wait_until).with(5, "some condition")
-      watir_definition.wait_for("some condition", 5)
+      watir_definition.wait_for(5, "some condition")
     end
   
     it "should handle alert message boxes" do
@@ -38,5 +38,17 @@ describe Symbiont::Enclosers do
       watir_definition.will_prompt("Question") do
       end
     end
+
+    it "attaches to a window by using the title" do
+      watir_browser.should_receive(:window).with(:title => /Display\ Results/).and_return(watir_browser)
+      watir_browser.should_receive(:use)
+      watir_definition.within_window(title: "Display Results")
+    end
+
+    it "attaches to a window by using the url" do
+      watir_browser.should_receive(:window).with(:url => /results\.html/).and_return(watir_browser)
+      watir_browser.should_receive(:use)
+      watir_definition.within_window(url: "results.html")
+    end
   end
 end

data/spec/symbiont/evaluators_spec.rb

@@ -56,13 +56,13 @@ describe Symbiont::Enclosers do
       end
       
       it "should wait for jquery pending requests to finish" do
-        watir_browser.should_receive(:run_script).with('return jQuery.active').and_return(0)
+        watir_browser.should_receive(:execute_script).with('return jQuery.active').and_return(0)
         watir_definition.wait_for_pending_requests
       end
       
       it "should return an exception if pending requests did not finish" do
-        watir_browser.should_receive(:run_script).with('return jQuery.active')
-        watir_browser.should_receive(:run_script).with('return jQuery.active').and_return(1)
+        watir_browser.should_receive(:execute_script).with('return jQuery.active')
+        watir_browser.should_receive(:execute_script).with('return jQuery.active').and_return(1)
         expect { watir_definition.wait_for_pending_requests(1) }.to raise_error
       end
     end

data/spec/symbiont/symbiont_spec.rb

@@ -4,4 +4,14 @@ describe Symbiont do
   it "should return version information" do
     Symbiont.version.should == "Symbiont v#{Symbiont::VERSION}"
   end
+
+  it "should provide a page level wait default" do
+    Symbiont.instance_variable_set("@page_wait", 10)
+    Symbiont.page_level_wait.should == 10
+  end
+
+  it "should set the page level wait default to 15" do
+    Symbiont.instance_variable_set("@page_wait", nil)
+    Symbiont.page_level_wait.should == 15
+  end
 end

data/spec/symbiont/web_object_spec.rb

@@ -27,6 +27,26 @@ describe "Web Objects" do
     watir_definition.tag.should == "div"
   end
   
+  it "should retrieve the id of a web object" do
+    watir_browser.should_receive(:id).and_return("id")
+    watir_definition.id.should == "id"
+  end
+  
+  it "should retrieve the value of a web object" do
+    watir_browser.should_receive(:value).and_return("value")
+    watir_definition.value.should == "value"
+  end
+  
+  it "should be able to inspect a web object" do
+    watir_browser.should_receive(:inspect).and_return(watir_definition)
+    watir_definition.inspect.should be_instance_of Symbiont::WebObjects::WebObject
+  end
+  
+  it "should be able to flash a web_object" do
+    watir_browser.should_receive(:flash).and_return(watir_definition)
+    watir_definition.flash.should be_instance_of Symbiont::WebObjects::WebObject
+  end
+  
   it "should determine if a web object is enabled" do
     watir_browser.should_receive(:enabled?).and_return(true)
     watir_definition.enabled?.should == true
@@ -48,12 +68,12 @@ describe "Web Objects" do
   end
   
   it "should determine if a web object is visible" do
-    watir_browser.should_receive(:visible?).and_return(true)
+    watir_browser.should_receive(:present?).and_return(true)
     watir_definition.visible?.should == true
   end
   
   it "should determine if a web object is not visible" do
-    watir_browser.should_receive(:visible?).and_return(false)
+    watir_browser.should_receive(:present?).and_return(false)
     watir_definition.visible?.should == false
   end
   
@@ -85,23 +105,23 @@ describe "Web Objects" do
   end
   
   it "should wait for a web object to become visible" do
-    watir_browser.should_receive(:visible?).and_return(true)
+    watir_browser.should_receive(:present?).and_return(true)
     watir_definition.when_visible(5)
   end
   
   it "should reference a web object when it is visible" do
-    watir_browser.should_receive(:visible?).and_return(true)
+    watir_browser.should_receive(:present?).and_return(true)
     web_object = watir_definition.when_visible(5)
     web_object.should === watir_definition
   end
   
   it "should wait for a web object to become invisible" do
-    watir_browser.should_receive(:visible?).and_return(false)
+    watir_browser.should_receive(:present?).and_return(false)
     watir_definition.when_not_visible(5)
   end
   
   it "should reference a web object when it is not visible" do
-    watir_browser.stub(:visible?).and_return(false)
+    watir_browser.stub(:present?).and_return(false)
     web_object = watir_definition.when_not_visible(5)
     web_object.should === watir_definition
   end

data/spec/symbiont/web_objects/checkbox_spec.rb

@@ -3,9 +3,25 @@ require 'spec_helper'
 describe Symbiont::WebObjects::CheckBox do
   describe "implementation" do
     let(:checkbox_object) { double('checkbox_object') }
+    let(:checkbox_definition) { Symbiont::WebObjects::CheckBox.new(checkbox_object) }
     
     it "should register with a submit type" do
       ::Symbiont::WebObjects.get_class_for(:input, :checkbox).should == ::Symbiont::WebObjects::CheckBox
     end
+    
+    it "should be able to check the definition" do
+      checkbox_object.should_receive(:set)
+      checkbox_definition.check
+    end
+    
+    it "should be able to uncheck the definition" do
+      checkbox_object.should_receive(:clear)
+      checkbox_definition.uncheck
+    end
+    
+    it "should be able to determine if the definition is checked" do
+      checkbox_object.should_receive(:set?).and_return(true)
+      checkbox_definition.checked?
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symbiont
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-30 00:00:00.000000000 Z
+date: 2012-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec