symbiont 0.1.2 → 0.1.3

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    symbiont (0.1.0)
-      watir-webdriver (= 0.5.8)
+    symbiont (0.1.2)
+      watir-webdriver (= 0.6.1)
 
 GEM
   remote: http://rubygems.org/
@@ -24,7 +24,7 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.10.1)
     rubyzip (0.9.8)
-    selenium-webdriver (2.21.2)
+    selenium-webdriver (2.22.1)
       childprocess (>= 0.2.5)
       ffi (~> 1.0)
       libwebsocket (~> 0.1.3)
@@ -34,8 +34,9 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    watir-webdriver (0.5.8)
+    watir-webdriver (0.6.1)
       selenium-webdriver (>= 2.18.0)
+    yard (0.8.2.1)
 
 PLATFORMS
   x86-mingw32
@@ -44,3 +45,4 @@ DEPENDENCIES
   rspec (= 2.10.0)
   simplecov (= 0.6.4)
   symbiont!
+  yard (= 0.8.2.1)

data/HISTORY.md

@@ -1,6 +1,14 @@
 Change Log and History
 ======================
 
+Version 0.1.3 / 2012-07-15
+--------------------------
+
+This release introduces a lot of low-hanging fruit. For example there is now the ability to get the title, markup and the active URL of a page. There is also the ability to get a screenshot. It is also possible to get the tag name from a web object. As far as web objects, the ability to get and set values for text fields is now in place. I've also added the ability to execute specific JavaScript calls against the browser. This helps determine what web object currently has focus, as just one example.
+
+A DataSetter module has been added to allow for easier population of data elements. The idea here is that a using method -- called against a page or activity definition -- can send data directly to web objects on that definition. This is just the start of a streamlined approach for populating data a bit easier than was previously the case. I have also made sure to update to the latest watir-webdriver.
+
+
 Version 0.1.2 / 2012-06-06
 --------------------------
 

data/Rakefile

@@ -1,15 +1,22 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new do |c|
-  options = ["--color"]
+  options  = ["--color"]
   options += ["--format", "documentation"]
   options += ["--format", "nested", "--out output/rspec-report.txt"]
   options += ["--format", "html", "--out output/rspec-report.html"]
   c.rspec_opts = options
 end
 
+desc "Generate API documentation"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--title', 'Symbiont']
+end
+
 namespace :spec do
   desc "Get code coverage for spec execution"
   RSpec::Core::RakeTask.new('cov') do |c|

data/app/views/test_page.erb

@@ -41,6 +41,11 @@
 		<br/>
 		<input id="bookTitleID" class="bookTitleClass" name="bookTitleName" size="40" type="text">
 		<br/>
+    <br />
+    <label id="book_author"><strong>Book Author:</strong></label>
+    <br />
+    <input id="bookAuthorID" size="40" type="text">
+    <br />
 		<br/>
 		<label id=book_summary"><strong>Book Summary:</strong></label>
 		<br/>
@@ -163,7 +168,7 @@
     
     <div class="group">
         <div id="divTextID" name="divTextName" class="divTextClass">This text is within a div tag.</div>
-        <span id="spanTextID" name="spanTextName" class="spanTextClass">This text is within a span tag.</div>
+        <span id="spanTextID" name="spanTextName" class="spanTextClass">This text is within a span tag.</span>
     </div>
     
 </section>

data/lib/symbiont/data_setter.rb

@@ -0,0 +1,49 @@
+module Symbiont
+	module DataSetter
+		
+		def using(data)
+			data.each do |key, value|
+				use_text_data_with(key, value) if text_settable_for(key) and object_enabled_for(key)
+        use_check_data_with(key, value) if value_checkable_for(key) and object_enabled_for(key)
+        use_select_data_with(key, value) if value_selectable_for(key) and object_enabled_for(key)
+			end
+		end
+
+		alias :using_data :using
+		alias :using_values :using
+		alias :use_data :using
+		alias :use_values :using
+		
+		private
+		
+		def use_text_data_with(key, value)
+			self.send "#{key}=", value
+		end
+		
+    def use_check_data_with(key, value)
+      return self.send "check_#{key}" if value
+      return self.send "uncheck_#{key}"
+    end
+    
+    def use_select_data_with(key, value)
+      return self.send "select_#{key}" if value
+    end
+    
+    def text_settable_for(key)
+      respond_to?("#{key}=".to_sym)
+    end
+    
+    def value_checkable_for(key)
+      respond_to?("check_#{key}".to_sym)
+    end
+    
+    def value_selectable_for(key)
+      respond_to?("select_#{key}".to_sym)
+    end
+    
+    def object_enabled_for(key)
+      self.send("#{key}_object").enabled?
+    end
+    
+	end # module: DataSetter
+end # module: Symbiont

data/lib/symbiont/enclosers.rb

@@ -39,14 +39,48 @@ module Symbiont
       @platform.wait_for(timeout, message, &block)
     end
     
+    # Provides a context for an action that will generate a JavaScript alert
+    # message box. The alert invocation will be overridden by the platform.
+    #
+    # @param [Proc] block the code that generates the alert
+    # @return [String] the message contained in the alert message box
+    #
+    # @example
+    #   response = @page.will_alert do
+    #     @page.submitForm
+    #   end
     def will_alert(&block)
       @platform.will_alert(&block)
     end
     
+    # Provides a context for an action that will generate a JavaScript
+    # confirmation message box. The confirmation invocation will be
+    # overridden by the platform.
+    #
+    # @param [bool] true to accept the confirmation, false to cancel it
+    # @param [Proc] block the code that generates the confirmation
+    # @return [String] the message contained in the confirmation message box
+    #
+    # @example
+    #   response = @page.will_confirm(true) do
+    #     @page.areYouSure
+    #   end
     def will_confirm(response, &block)
       @platform.will_confirm(response, &block)
     end
     
+    # Provides a context for an action that will generate a JavaScript prompt
+    # message box. The prompt invocation will be overridden by the platform.
+    #
+    # @param [String] response the value to be used in the prompt
+    # @param [Proc] block the code that generates the prompt
+    # @return [Hash] :message for the prompt message, :default_value for
+    # the value that the prompt had before the response was applied
+    #
+    # @example
+    #   response = @page.will_prompt("use this") do
+    #     @page.useValue
+    #   end
     def will_prompt(response, &block)
       @platform.will_prompt(response, &block)
     end

data/lib/symbiont/evaluators.rb

@@ -8,10 +8,48 @@ module Symbiont
       @platform.visit(url)
     end
     
-    # Returns the text of the current page.
+    # Returns the text of the current page. This is the text minus any
+    # markup.
     def text
       @platform.text
     end
     
+    # Returns the markup of the current page.
+    def markup
+      @platform.markup
+    end
+    
+    alias :html :markup
+    
+    # Returns the title of the current page.
+    def title
+      @platform.title
+    end
+    
+    # Returns the URL of the active page.
+    def url
+      @platform.url
+    end
+    
+    # Save a snapshot of the current screen to a provided file location.
+    # The file will be saved as a PNG file in the path specified or in the
+    # location where the tests are being run from.
+    # @param [String] file the file name to save the image as
+    def screenshot(file)
+      @platform.screenshot file
+    end    
+    
+    # Returns the web object that currently has focus.
+    def focus
+      @platform.focus
+    end
+    
+    # Executes JavaScript against the browser instance.
+    def run_script(script)
+      @platform.run_script(script)
+    end
+    
+    alias :execute_script :run_script
+    
   end # module: Evaluators
 end # module: Symbiont

data/lib/symbiont/platform_watir/platform_object.rb

@@ -16,6 +16,24 @@ module Symbiont
           @browser.goto(url)
         end
         
+        # Platform method to get the URL of the active page.
+        # See Symbiont#url
+        def url
+          @browser.url
+        end
+        
+        # Platform method to save the current screenshot to a file.
+        # See Symbiont#screenshot
+        def screenshot(file)
+          @browser.wd.save_screenshot(file)
+        end
+        
+        # Platform method to run a script against the browser.
+        # See Symbiont#run_script
+        def run_script(script)
+          @browser.execute_script(script)
+        end
+        
         ## Page-Level Actions ##
         
         # Platform method to retrieve text from the current page.
@@ -24,6 +42,27 @@ module Symbiont
           @browser.text
         end
         
+        # Platform method to retrieve markup from the current page.
+        # See Symbiont#markup
+        def markup
+          @browser.html
+        end
+
+        # Platform method to get the title of the current page.
+        # See Symbiont#title
+        def title
+          @browser.title
+        end
+        
+        # Platform method to get the web object that has focus.
+        # See Symbiont#focus
+        def focus
+          web_object = @browser.execute_script("return document.activeElement")
+          type = web_object.type.to_sym if web_object.tag_name.to_sym == :input
+          object_class = ::Symbiont::WebObjects.get_class_for(web_object.tag_name, type)
+          object_class.new(web_object)
+        end
+        
         ## Encloser Methods ##
         
         # Platform method to wait for an action to complete in a given time.
@@ -433,4 +472,5 @@ module Symbiont
   end # module: Platforms
 end # module: Symbiont
 
+require 'symbiont/web_objects'
 Dir["#{File.dirname(__FILE__)}/../web_objects/**/*.rb"].sort.each { |file| require file }

data/lib/symbiont/platforms.rb

@@ -6,6 +6,9 @@ module Symbiont
     # This module determines what execution platform Symbiont will use.
     # The decision is based on the browser that has been established for
     # the execution profile.
+    #
+    # @param [Object] browser the browser to establish the platform for
+    # @returns [Object] a platform object to execute tests against
     def get_platform_for(browser)
       if browser.is_a?(Watir::Browser)
         return @platform = Symbiont::Platforms::WatirWebDriver::PlatformObject.new(@browser)

data/lib/symbiont/version.rb

@@ -1,3 +1,3 @@
 module Symbiont
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/symbiont/web_objects/_common.rb

@@ -43,6 +43,10 @@ module Symbiont
         @web_object.style(property)
       end
       
+      def tag
+        @web_object.tag_name
+      end
+      
       def when_actionable(timeout=5)
         @web_object.wait_until_present(timeout)
         self

data/lib/symbiont/web_objects/button.rb

@@ -4,6 +4,8 @@ module Symbiont
     class Button < WebObject
 
     end # class: Button
-
+    
+    ::Symbiont::WebObjects.class_for_type[:submit] = ::Symbiont::WebObjects::Button
+    ::Symbiont::WebObjects.class_for_type[:button] = ::Symbiont::WebObjects::Button
   end # module: WebObjects
-end # module: Symbiont
+end # module: Symbiont

data/lib/symbiont/web_objects/checkbox.rb

@@ -4,6 +4,8 @@ module Symbiont
     class CheckBox < WebObject
 
     end # class: CheckBox
-
+    
+    ::Symbiont::WebObjects.class_for_type[:checkbox] = ::Symbiont::WebObjects::CheckBox
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/div.rb

@@ -5,5 +5,7 @@ module Symbiont
       
     end # class: Div
     
+    ::Symbiont::WebObjects.class_for_tag[:div] = ::Symbiont::WebObjects::Div
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/link.rb

@@ -4,6 +4,8 @@ module Symbiont
     class Link < WebObject
 
     end # class: Link
-
+    
+    ::Symbiont::WebObjects.class_for_tag[:a] = ::Symbiont::WebObjects::Link
+    
   end # module: WebObjects
-end # module: Symbiont
+end # module: Symbiont

data/lib/symbiont/web_objects/radio.rb

@@ -5,5 +5,7 @@ module Symbiont
       
     end # class: Radio
     
+    ::Symbiont::WebObjects.class_for_type[:radio] = ::Symbiont::WebObjects::Radio
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/select_list.rb

@@ -5,5 +5,7 @@ module Symbiont
       
     end # class: SelectList
     
+    ::Symbiont::WebObjects.class_for_tag[:select] = ::Symbiont::WebObjects::SelectList
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/span.rb

@@ -5,5 +5,7 @@ module Symbiont
       
     end # class: Span
     
+    ::Symbiont::WebObjects.class_for_tag[:span] = ::Symbiont::WebObjects::Span
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/table.rb

@@ -53,5 +53,7 @@ module Symbiont
       
     end # class: Table
     
+    ::Symbiont::WebObjects.class_for_tag[:table] = ::Symbiont::WebObjects::Table
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/table_cell.rb

@@ -5,5 +5,8 @@ module Symbiont
       
     end # class: TableCell
     
+    ::Symbiont::WebObjects.class_for_tag[:td] = ::Symbiont::WebObjects::TableCell
+    ::Symbiont::WebObjects.class_for_tag[:th] = ::Symbiont::WebObjects::TableCell
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/table_row.rb

@@ -43,5 +43,7 @@ module Symbiont
       
     end # class: TableRow
     
+    ::Symbiont::WebObjects.class_for_tag[:tr] = ::Symbiont::WebObjects::TableRow
+    
   end # module: WebObjects
 end # module: Symbiont

data/lib/symbiont/web_objects/text_field.rb

@@ -2,8 +2,23 @@ module Symbiont
   module WebObjects
 
     class TextField < WebObject
-
+      # Get the value of a text field.
+      def value
+        @web_object.value
+      end
+      
+      # Set the value of a text field.
+      def value=(value)
+        @web_object.set value
+      end
+      
+      # Append text to a text field.
+      def append(text)
+        @web_object.send_keys text
+      end
     end # class: TextField
-
+    
+    ::Symbiont::WebObjects.class_for_type[:text] = ::Symbiont::WebObjects::TextField
+    ::Symbiont::WebObjects.class_for_type[:password] = ::Symbiont::WebObjects::TextField
   end # module: WebObjects
-end # module: Symbiont
+end # module: Symbiont

data/lib/symbiont/web_objects.rb

@@ -0,0 +1,22 @@
+module Symbiont
+  module WebObjects
+    
+    class << self
+      def class_for_tag
+        @class_for_tag ||= {}
+      end
+      
+      def class_for_type
+        @class_for_type ||= {}
+      end
+      
+      def get_class_for(tag, type=nil)
+        return class_for_type[type.to_sym] if type
+        class_for_tag[tag.to_sym] || ::Symbiont::WebObjects::WebObject
+      end
+    end
+    
+  end # module: WebObjects
+end # module: Symbiont
+
+require 'symbiont/web_objects/_common'

data/lib/symbiont.rb

@@ -5,12 +5,14 @@ require 'symbiont/generators'
 require 'symbiont/enclosers'
 require 'symbiont/evaluators'
 require 'symbiont/locators'
+require 'symbiont/data_setter'
 
 module Symbiont
   include Platforms
   include Enclosers
   include Evaluators
   include Locators
+	include DataSetter
   
   # Used to make a platform object accessible. Will hold object
   # references like these:

data/spec/symbiont/data_setter_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Symbiont::DataSetter do
+	let(:watir_browser) { mock_browser_for_watir }
+  let(:watir_definition) { DefinitionTest.new(watir_browser) }
+	
+	it "should set data in a text field" do
+		watir_definition.should_receive(:login_name=).with('jnyman')
+    watir_definition.should_receive(:object_enabled_for).and_return(true)
+		watir_definition.using('login_name' => 'jnyman')
+	end
+  
+  it "should not set data in a non-existent text field" do
+    watir_browser.should_not_receive(:text_field)
+    watir_definition.using('fake_field' => 'fake data')
+  end
+  
+  it "should not set data in a disabled text field" do
+    watir_definition.should_not_receive(:login_name=)
+    watir_definition.should_receive(:login_name_object).and_return(watir_browser)
+    watir_browser.should_receive(:enabled?).and_return(false)
+    watir_definition.using('login_name' => 'test data')
+  end
+  
+  it "should set data in a select list field" do
+    watir_definition.should_receive(:concepts=).with('physics')
+    watir_definition.should_receive(:object_enabled_for).and_return(true)
+    watir_definition.using('concepts' => 'physics')
+  end
+  
+  it "should check a checkbox field" do
+    watir_definition.should_receive(:check_apply_tax)
+    watir_definition.should_receive(:object_enabled_for).and_return(true)
+    watir_definition.using('apply_tax' => true)
+  end
+  
+  it "should uncheck a checkbox field" do
+    watir_definition.should_receive(:uncheck_apply_tax)
+    watir_definition.should_receive(:object_enabled_for).and_return(true)
+    watir_definition.using('apply_tax' => false)
+  end
+  
+  it "should not check data in a disabled checkbox field" do
+    watir_definition.should_not_receive(:check_apply_tax)
+    watir_definition.should_receive(:apply_tax_object).and_return(watir_browser)
+    watir_browser.should_receive(:enabled?).and_return(false)
+    watir_definition.using('apply_tax' => true)
+  end
+  
+  it "should select a radio field" do
+    watir_definition.should_receive(:select_include_tax)
+    watir_definition.should_receive(:object_enabled_for).and_return(true)
+    watir_definition.using('include_tax' => true)
+  end
+  
+  it "should not select data in a disable radio field" do
+    watir_definition.should_not_receive(:select_include_tax)
+    watir_definition.should_receive(:include_tax_object).and_return(watir_browser)
+    watir_browser.should_receive(:enabled?).and_return(false)
+    watir_definition.using('include_tax' => true)
+  end
+end

data/spec/symbiont/evaluators_spec.rb

@@ -10,6 +10,23 @@ describe Symbiont::Enclosers do
         watir_browser.should_receive(:goto).with("http://localhost:4567")
         watir_definition.visit("http://localhost:4567")
       end
+      
+      it "should get the active url" do
+        watir_browser.should_receive(:url).and_return("http://localhost:4567")
+        watir_definition.url.should == "http://localhost:4567"
+      end
+      
+      it "should get a screenshot" do
+        watir_browser.should_receive(:wd).and_return(watir_browser)
+        watir_browser.should_receive(:save_screenshot)
+        watir_definition.screenshot("testing.png")
+      end
+      
+      it "should run a script against the browser" do
+        watir_browser.should_receive(:execute_script).twice.and_return("input")
+        watir_definition.run_script("return document.activeElement").should == "input"
+        watir_definition.execute_script("return document.activeElement").should == "input"
+      end
     end
   end
   
@@ -19,6 +36,24 @@ describe Symbiont::Enclosers do
         watir_browser.should_receive(:text).and_return("page text")
         watir_definition.text.should == "page text"
       end
+      
+      it "should return all the markup on a page" do
+        watir_browser.should_receive(:html).twice.and_return("<h1>Page Title</h1>")
+        watir_definition.markup.should == "<h1>Page Title</h1>"
+        watir_definition.html.should == "<h1>Page Title</h1>"
+      end
+      
+      it "should return the title of a page" do
+        watir_browser.should_receive(:title).and_return("Page Title")
+        watir_definition.title.should == "Page Title"
+      end
+      
+      it "should return the web object that has focus" do
+        watir_browser.should_receive(:execute_script).and_return(watir_browser)
+        watir_browser.should_receive(:tag_name).twice.and_return(:input)
+        watir_browser.should_receive(:type).and_return(:submit)
+        watir_definition.focus.class.should == Symbiont::WebObjects::Button
+      end
     end
   end
 end

data/spec/symbiont/web_object_spec.rb

@@ -14,6 +14,11 @@ describe "Web Objects" do
     watir_definition.style('display').should == 'none'
   end
   
+  it "should retrieve the tag of a web object" do
+    watir_browser.should_receive(:tag_name).and_return("div")
+    watir_definition.tag.should == "div"
+  end
+  
   it "should determine if a web object is enabled" do
     watir_browser.should_receive(:enabled?).and_return(true)
     watir_definition.enabled?.should == true

data/spec/symbiont/web_objects/button_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Symbiont::WebObjects::Button do
+  describe "implementation" do
+    let(:button_object) { double('button_object') }
+    
+    it "should register with a submit type" do
+      ::Symbiont::WebObjects.get_class_for(:input, :submit).should == ::Symbiont::WebObjects::Button
+    end
+    
+    it "should register with a button type" do
+      ::Symbiont::WebObjects.get_class_for(:input, :button).should == ::Symbiont::WebObjects::Button
+    end
+  end
+end

data/spec/symbiont/web_objects/checkbox_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Symbiont::WebObjects::CheckBox do
+  describe "implementation" do
+    let(:checkbox_object) { double('checkbox_object') }
+    
+    it "should register with a submit type" do
+      ::Symbiont::WebObjects.get_class_for(:input, :checkbox).should == ::Symbiont::WebObjects::CheckBox
+    end
+  end
+end

data/spec/symbiont/web_objects/div_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Symbiont::WebObjects::Div do
+  describe "implementation" do
+    let(:div_object) { double('div_object') }
+    
+    it "should register with a div tag" do
+      ::Symbiont::WebObjects.get_class_for(:div).should == ::Symbiont::WebObjects::Div
+    end
+  end
+end