symbiont 0.1.5 → 0.1.6

data/HISTORY.md

@@ -1,6 +1,12 @@
 Change Log and History
 ======================
 
+Version 0.1.6 / 2012-09-30
+--------------------------
+
+This releases provides two bits of functionality. One is an ability to wait for pending Ajax requests. Currently this is very specific to jQuery only. The other ability is that of providing workflows. The idea behind this feature is that you can specify a workflow that starts with an action (method) on a particular definition (class). That workflow may have a series of steps that are required in order to allow the action to take place. This new logic will attempt to execute all of those steps. The rationale behind this addition is to make it easier to specify output-driven logic.
+
+
 Version 0.1.5 / 2012-09-12
 --------------------------
 

data/app/app.rb

@@ -175,7 +175,6 @@ module Symbiont
       end
       redirect '/db_users'
     end
-    
   end # class: TestApp
 end # module: Symbiont
 

data/app/views/test_events.erb

@@ -1,28 +1,28 @@
 <script type="text/javascript">
-    function unhide() {
-        document.getElementById("conditional").style.display="block";
-    }
+  function unhide() {
+    document.getElementById("conditional").style.display="block";
+  }
 
-    function hide() {
-        document.getElementById("conditional").style.display="none";
-    }
+  function hide() {
+    document.getElementById("conditional").style.display="none";
+  }
       
-    function addDiv() {
-        var button = document.createElement("input");
-        button.setAttribute("type", "button");
-        button.setAttribute("value", "Newly Created Button");
-        button.setAttribute("id", "new_button");
-        //document.body.appendChild(button);
-        var sectional = document.getElementById("created")
-        sectional.appendChild(button);
-    }
+  function addDiv() {
+    var button = document.createElement("input");
+    button.setAttribute("type", "button");
+    button.setAttribute("value", "Newly Created Button");
+    button.setAttribute("id", "new_button");
+    //document.body.appendChild(button);
+    var sectional = document.getElementById("created")
+    sectional.appendChild(button);
+  }
 
-    function removeDiv() {
-        var button = document.getElementById("new_button");
-        //document.body.removeChild(button);
-        var sectional = document.getElementById("created")
-        sectional.removeChild(button);
-    }
+  function removeDiv() {
+    var button = document.getElementById("new_button");
+    //document.body.removeChild(button);
+    var sectional = document.getElementById("created")
+    sectional.removeChild(button);
+  }
 </script>
 
 <section id="test_events">

data/lib/symbiont/enclosers.rb

@@ -35,8 +35,8 @@ module Symbiont
     #   @page.wait_for(5, 'page with expected title not found') do
     #     @page.title.should == "Test App"
     #   end
-    def wait_for(timeout=10, message=nil, &block)
-      @platform.wait_for(timeout, message, &block)
+    def wait_for(message=nil, timeout=10, &block)
+      @platform.wait_for(message, timeout, &block)
     end
     
     # Provides a context for an action that will generate a JavaScript alert

data/lib/symbiont/evaluators.rb

@@ -51,5 +51,20 @@ module Symbiont
     
     alias :execute_script :run_script
     
+    # Provides an evaluator that attempts to wait for any pending AJAX
+    # requests from the jQuery library.
+    #
+    # @param [Numeric] timeout amount of time to wait
+    # @param [String] message text to print if timeout period is exceeded
+    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
+        sleep 0.5
+      end
+      message = "Pending requests never indicated completion" unless message
+      raise message
+    end
+    
   end # module: Evaluators
 end # module: Symbiont

data/lib/symbiont/factory.rb

@@ -8,6 +8,7 @@ module Symbiont
     # definition
     # @return [Object] instance of the definition
     def on(definition, &block)
+      return @active if @active.class == definition
       @active = definition.new(@browser)
       block.call @active if block
       @active
@@ -29,5 +30,73 @@ module Symbiont
     alias :during :on
     alias :start_activity :on_view
     
+    # Starts a workflow, which is a set of predefined actions. You can use
+    # this to navigate through a set of actions (and thus a set of
+    # definitions). This is done by calling an action that is specified as
+    # part of the workflow path. This action will be called on the relevant
+    # definition at each point of the workflow.
+    #
+    # @param [Class] definition an instance of the definition; note this
+    # instance must have the workflow action defined on it.
+    # @param [Hash] elements a hash that contains an element with the
+    # key :using. This is used to lookup the actions for the workflow.
+    # @param [optional] block Logic to execute within the context of the
+    # workflow.
+    # @return [Object] the definition being used at that point of the
+    # workflow.
+    def start_workflow(definition, elements = {:using => :default}, &block)
+      path = workflow_path_for(elements)
+      to_element = find_element_for(path, definition) - 1
+      go_through_definitions(path[0..to_element])
+      on(definition, &block)
+    end    
+    
+    # This provides a way to start a workflow from somewhere other than the
+    # start of the workflow. Specifically, the workflow will start from whatever
+    # the active definition is.
+    #
+    # @param [Class] definition an instance of the definition; note this
+    # instance must have the workflow action defined on it.
+    # @param [Hash] elements a hash that contains an element with the
+    # key :using. This is used to lookup the actions for the workflow.
+    # @param [optional] block Logic to execute within the context of the
+    # workflow.
+    # @return [Object] the definition being used at that point of the
+    # workflow.
+    def continue_workflow(definition, elements = {:using => :default}, &block)
+      path = workflow_path_for(elements)
+      from_element = find_element_for(path, @active.class) + 1
+      to_element = find_element_for(path, definition) - 1
+      go_through_definitions(path[from_element..to_element])
+      on(definition, &block)
+    end
+    
+    def workflow_path_for(elements)
+      path = Symbiont::Factory.symbiont_workflow[elements[:using]]
+      fail("Factory workflow :#{elements[:using].to_s} does not exist.") if path.nil?
+      path
+    end
+    
+    def find_element_for(path, definition)
+      path.each_with_index { |each, index| return index if each[0] == definition }
+    end
+    
+    def go_through_definitions(elements)
+      elements.each do |definition, action|
+        element = on(definition)
+        fail("Action called #{action} not specified on #{definition}.") unless element.respond_to? action
+        element.send action
+      end
+    end
+    
+    class << self
+      attr_accessor :symbiont_workflow
+      
+      def workflow=(path)
+        raise("A default workflow path for a Factory workflow must exist.") unless path[:default]
+        @symbiont_workflow = path
+      end
+    end
+    
   end # module: Factory
 end # module: Symbiont

data/lib/symbiont/platform_watir/platform_object.rb

@@ -67,7 +67,7 @@ module Symbiont
         
         # Platform method to wait for an action to complete in a given time.
         # @see Symbiont::Enclosers#wait_for
-        def wait_for(timeout, message=nil, &block)
+        def wait_for(message="wait condition not found", timeout, &block)
           @browser.wait_until(timeout, message, &block)
         end
         

data/lib/symbiont/version.rb

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

data/lib/symbiont.rb

@@ -2,6 +2,7 @@ require 'symbiont/version'
 require 'symbiont/logger'
 require 'symbiont/platforms'
 require 'symbiont/generators'
+require 'symbiont/factory'
 require 'symbiont/enclosers'
 require 'symbiont/evaluators'
 require 'symbiont/locators'
@@ -12,7 +13,7 @@ module Symbiont
   include Enclosers
   include Evaluators
   include Locators
-	include DataSetter
+  include DataSetter
   
   # Used to make a platform object accessible. Will hold object
   # references like these:

data/spec/symbiont/enclosers_spec.rb

@@ -14,10 +14,10 @@ describe Symbiont::Enclosers do
     end
     
     it "should wait for a condition to be true" do
-      watir_browser.should_receive(:wait_until).with(5, "not quick enough")
-      watir_definition.wait_for(5, "not quick enough")
+      watir_browser.should_receive(:wait_until).with(5, "some condition")
+      watir_definition.wait_for("some condition", 5)
     end
-    
+  
     it "should handle alert message boxes" do
       watir_browser.should_receive(:wd).twice.and_return(watir_browser)
       watir_browser.should_receive(:execute_script).twice

data/spec/symbiont/evaluators_spec.rb

@@ -54,6 +54,17 @@ describe Symbiont::Enclosers do
         watir_browser.should_receive(:type).and_return(:submit)
         watir_definition.focus.class.should == Symbiont::WebObjects::Button
       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_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)
+        expect { watir_definition.wait_for_pending_requests(1) }.to raise_error
+      end
     end
   end
 end

data/spec/symbiont/factory_spec.rb

@@ -5,31 +5,118 @@ class TestFactory
   include Symbiont::Factory
   
   attr_accessor :browser
+  attr_accessor :active
+end
+
+class TestFactorySecond
+  include Symbiont
+end
+
+class TestFactoryThird
+  include Symbiont
 end
 
 describe Symbiont::Factory do
+  #let(:watir_browser) { mock_browser_for_watir }
+  #let(:factory) { TestFactory.new(watir_browser) }
+  
   before(:each) do
     @factory = TestFactory.new
     @factory.browser = mock_browser_for_watir
   end
   
-  it "should create a new definition object" do
+  it "should create a new definition object, using on" do
     @factory.on DefinitionTest do |page|
       page.should be_instance_of DefinitionTest
     end
   end
   
-  it "should create a new definition object and view it" do
+  it "should create a new definition object, using during" do
+    @factory.during DefinitionTest do |page|
+      page.should be_instance_of DefinitionTest
+    end
+  end
+  
+  it "should create a new definition object and view it, using on_view" do
     @factory.browser.should_receive(:goto).twice
     @factory.on_view DefinitionTest do |page|
       page.should be_instance_of DefinitionTest
     end
   end
   
+  it "should create a new definition object and view it, using start_activity" do
+    @factory.browser.should_receive(:goto).twice
+    @factory.start_activity DefinitionTest do |page|
+      page.should be_instance_of DefinitionTest
+    end
+  end
+  
   it "should set a reference to be used outside the factory" do
     active = @factory.on DefinitionTest
     current = @factory.instance_variable_get "@active"
     current.should === active
   end
   
+  it "should use an existing definition when that definition is already active" do
+    @factory.instance_variable_set "@active", TestFactorySecond.new(@factory.browser)
+    @factory.on(TestFactorySecond) do |page|
+      page.should be_instance_of TestFactorySecond
+    end
+  end
+  
+  it "should not execute block if definition is not the active definition" do
+    @factory.instance_variable_set "@active", TestFactorySecond.new(@factory.browser)
+    @factory.on(TestFactoryThird) do |page|
+      page.should_not be_instance_of TestFactorySecond
+      page.should be_instance_of TestFactoryThird
+    end
+  end
+  
+  it "should store a workflow path" do
+    workflow = ['stage1', 'stage2', 'stage3']
+    Symbiont::Factory.workflow = {default: workflow}
+    Symbiont::Factory.symbiont_workflow[:default].should == workflow
+  end
+  
+  it "should be unable to work without a default worfklow path" do
+    expect { Symbiont::Factory.workflow = {another: []} }.to raise_error
+  end
+  
+  it "should start a workflow path by using the default path" do
+    paths = [[TestFactory, :first_action], [TestFactorySecond, :second_action]]
+    Symbiont::Factory.workflow = {:default => paths}
+    mock_page = double("mock_page")
+    TestFactory.should_receive(:new).and_return(mock_page)
+    mock_page.should_receive(:first_action)
+    @factory.start_workflow(TestFactorySecond).class.should == TestFactorySecond
+  end
+  
+  it "should not start a workflow when there is no proper path" do
+    Symbiont::Factory.workflow = {:default => ['default'], :standard => ['standard']}
+    expect { @factory.start_workflow(TestFactory, :using => :invalid_path) }.to raise_error
+  end
+  
+  it "should not use a workflow when an action is not specified" do
+    Symbiont::Factory.workflow = {:default => [[TestFactory, :action_1], [TestFactorySecond, :action_2]]}
+    mock_page = double("mock_page")
+    TestFactory.should_receive(:new).and_return(mock_page)
+    mock_page.should_receive(:respond_to?).with(:action_1).and_return(false)
+    expect { @factory.start_workflow(TestFactorySecond) }.to raise_error
+  end
+  
+  it "should be able to continue along a workflow" do
+    Symbiont::Factory.workflow = {
+      :default => [[TestFactory, :action_1],
+                   [TestFactorySecond, :action_2],
+                   [TestFactoryThird, :action_3]]
+    }
+    mock_page = double("mock_page")
+    TestFactorySecond.should_receive(:new).and_return(mock_page)
+    mock_page.should_receive(:respond_to?).with(:action_2).and_return(true)
+    mock_page.should_receive(:action_2)
+    @factory.active = TestFactory.new()
+    TestFactory.should_not_receive(:new)
+    @factory.continue_workflow(TestFactoryThird).class.should == TestFactoryThird
+  end
+  
 end

data/specs/support/test_steps/action_steps_webobjects.rb

@@ -15,13 +15,13 @@ end
 Then (/^the reference ID text field should have a black background$/) do
   @web_object = @page.bookRefID_object
   @style = @web_object.style('background-color')
-  @style.should == "rgba(0,0,0,1)"
+  @style.should == "rgba(0, 0, 0, 1)"
 end
 
 Then (/^the reference ID text field should have yellow text$/) do
   @web_object = @page.bookRefID_object
   @style = @web_object.style('color')
-  @style.should == "rgba(255,255,0,1)"
+  @style.should == "rgba(255, 255, 0, 1)"
 end
 
 Then (/^the book title text field should be an input field$/) do

metadata

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