fluent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 517921e222ad7a40ccb585b10e1b951e014a8959
-  data.tar.gz: b4685be3d80ab1d3602f83fcbf0bfca5fde45ebd
+  metadata.gz: 865fd6926b13f1303315bd27fdf75450a651bd96
+  data.tar.gz: 2580430caa258e3d409a0b231d7b39a18d804f66
 SHA512:
-  metadata.gz: a390c6b5f7273ea9c881a52dfb4c357f6e839afdd1988d143979a82fc3e4b3374209a221ce238180c2c6085e6535d540947c1556f64c300f2e4f8973a836a3a9
-  data.tar.gz: e327f85cd71bc75d8364668b3c90d6cb98fb3397057132874f5aa1534e2548d18ebab0fa25f1cbeba11a6eac23745c2df5c4209b79030dac410cdf9dc86aac60
+  metadata.gz: 28d8369390312cf460c41cce6fe3cb321cdef0af8b22418477bf222be8e062e7a92d9ce1297a3b7b8f8220a6f09094823e77234e1333a930cb9cf3edbf2be6e9
+  data.tar.gz: aaa9eb4cef3b0ab94213c3e408703bcf93663c9ce6baa89151809ae6fa682e6e5a98a4f27959eceda43a7f331c829cd487c081ee40005d3ad22d74301bad3d99

data/HISTORY.md

@@ -1,6 +1,27 @@
 Change Log and History
 ======================
 
+Version 0.2.0 / 2013-10-21
+--------------------------
+
+This is a significant update of Fluent. Some of the highlights:
+
+* The Selenium platform object is now supported. This is *only* to show that multiple platforms can be supported. Selenium is not fully supported to the same level that Watir-WebDriver is.
+
+* New web elements are handled as part of the generators mechanism. The new elements are: div, span, ordered and unordered lists along with their list items, text areas, and tables along with their cells.
+
+* A new mechanism called "enclosers" has been introduced. One aspect of this is that frames and iframes are now supported. More specifically, elements within frames can be specified in element definitions. Another aspect of this is that it is possible to handle JavaScript messages in terms of alerts, confirmations, and prompts.
+
+* A new mechanism called "evaluators" has been introduced. The idea of this is that you can evaluate aspects at the page level or the browser level. The evaluators provided are: url, remove cookies, refresh, run script, screenshot, markup, title, text, wait for app, and wait for pending requests.
+
+* Element and page level wait states have been added. A 'wait until' method is provided for both page-level and element-level concerns. Element level wait states are also provided by 'when present' (also: 'when actionable'), 'when not present' (also: 'when not actionable'), 'when visible', and 'when not visible'.
+
+* A factory mechanism has been provided so that context methods can be used to provide a more concise interface for using page and activity definitions. Currently the factory methods provided are 'on view' and 'on'.
+
+* Various generic web element methods have been exposed: tag name, html, flash, style, attribute, fire event, class name, value, id, send keys, scroll into view, focus, hover, double click, and clear. These are provided so that you can use Fluent similar to how you would use Watir-WebDriver directly.
+
+* A start has been made at providing specific web element methods. For example, for text fields, checkboxes, radios, and select lists, you can call methods against those objects just as you would if using Watir-WebDriver.
+
 Version 0.1.0 / 2013-10-18
 --------------------------
 

data/lib/fluent.rb

@@ -1,7 +1,10 @@
 require 'fluent/version'
 require 'fluent/errors'
 require 'fluent/logger'
+require 'fluent/factory'
 require 'fluent/platforms'
+require 'fluent/enclosers'
+require 'fluent/evaluators'
 require 'fluent/generators'
 
 require 'watir-webdriver'
@@ -9,6 +12,8 @@ require 'selenium-webdriver'
 
 module Fluent
   include Platforms
+  include Evaluators
+  include Enclosers
   
   # Browser drivers will be:
   # [Watir::Browser] or [Selenium::WebDriver::Driver]
@@ -39,7 +44,7 @@ module Fluent
     
     Fluent.trace("#{caller.class} #{caller} is now Fluent.")
   end
-
+  
   # The initialize method will be invoked when a definition includes Fluent.
   # A few key things are happening here that are critical to everything
   # working properly:
@@ -47,7 +52,7 @@ module Fluent
   #   (2) A platform object is created for that browser.
   #
   # @param browser [Object] a browser instance with a tool driver
-  def initialize(browser=nil)
+  def initialize(browser=nil, visit=nil)
     @browser = browser
     @browser = Watir::Browser.new if browser.nil? or browser == :watir
     @browser = Selenium::WebDriver.for :firefox if browser == :selenium
@@ -55,6 +60,28 @@ module Fluent
     Fluent::trace("Fluent attached to browser: #{@browser}")
     
     establish_platform_object_for @browser
+    
+    view if visit && respond_to?(:view)
+  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
+
+  def self.page_level_wait=(value)
+    @page_wait = value
+  end
+  
+  # Returns the default wait value for elements on a page. This value is
+  # the default value beyond which a timeout is assumed.
+  def self.element_level_wait
+    @element_wait ||= 5
+  end
+
+  def self.element_level_wait=(value)
+    @element_wait = value
   end
   
   def self.can_be_enabled

data/lib/fluent/enclosers.rb

@@ -0,0 +1,35 @@
+module Fluent
+  module Enclosers
+
+    # Provides a context for an action that will generate a JavaScript alert
+    # message box. The alert invocation will be overridden by the platform.
+    #
+    # @param block [Proc] the code that generates the alert
+    # @return [String] the message contained in the alert message box
+    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 response [Boolean] true to accept the confirmation, false to cancel it
+    # @param block [Proc] the code that generates the confirmation
+    # @return [String] the message contained in the confirmation message box
+    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 response [String] the value to be used in the prompt
+    # @param block [Proc] 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
+    def will_prompt(response, &block)
+      platform.will_prompt(response, &block)
+    end
+  end
+end

data/lib/fluent/evaluators.rb

@@ -0,0 +1,82 @@
+module Fluent
+  module Evaluators
+
+    ## Browser-Level Actions ##
+    
+    def url
+      platform.url
+    end
+
+    def remove_cookies
+      platform.remove_cookies
+    end
+
+    def refresh
+      platform.refresh
+    end
+
+    def run_script(script)
+      platform.run_script(script)
+    end
+
+    def screenshot(file)
+      platform.screenshot file
+    end
+    
+    alias_method :current_url, :url
+    alias_method :clear_cookies, :remove_cookies
+    alias_method :refresh_page, :refresh
+    alias_method :execute_script, :run_script
+    alias_method :save_screenshot, :screenshot
+    
+    ## Page-Level Actions ##
+    
+    def markup
+      platform.markup
+    end
+    
+    def title
+      platform.title
+    end
+
+    def text
+      platform.text
+    end
+
+    def wait_for_app(value=1)
+      sleep value
+    end
+    
+    # Attempts to wait for pending jQuery requests and indicate if the
+    # requests did not occur in a given time period.
+    #
+    # @param time_limit [Numeric] time to wait for the block to return true
+    # @param message_if_timeout [String] the message to include with the error
+    def wait_for_pending_requests(time_limit=30, message_if_timeout=nil)
+      end_time = ::Time.now + time_limit
+      until ::Time.now > end_time
+        return if browser.execute_script('return jQuery.active') == 0
+        wait_for_app 0.5
+      end
+      message = 'Pending jQuery requests never indicated completion.' unless message_if_timeout
+      raise message
+    end
+
+    # Provides a context for an action that must succeed within a given time
+    # period. The logic here is simply that the result of the action will be
+    # true (meaning the action was carried out) or false, which means the
+    # action did not succeed in the time allotted.
+    #
+    # @param timeout [Integer] the amount of time in seconds to wait
+    # @param message [String] the text to return if the action did not occur in time
+    # @param block [Proc] the code that calls the desired action
+    def wait_until(timeout=Fluent.page_level_wait, message=nil, &block)
+      platform.wait_until(timeout, message, &block)
+    end
+    
+    alias_method :html, :markup
+    alias_method :page_title, :title
+    alias_method :page_text, :text
+    alias_method :wait_for, :wait_until
+  end
+end

data/lib/fluent/factory.rb

@@ -0,0 +1,31 @@
+module Fluent
+  module Factory
+
+    # Creates a definition context for actions.
+    #
+    # @param definition [Class] the name of a definition class
+    # @param block [Proc] logic to execute within the context of the definition
+    # @return [Object] instance of the definition
+    def on(definition, visit=false, &block)
+      return @active if @active.kind_of?(definition)
+      @active = definition.new(@browser, visit)
+      block.call @active if block
+      @active
+    end
+
+    alias_method :on_page, :on
+    alias_method :while_on, :on
+
+    # Creates a definition context for actions and establishes the
+    # context for display.
+    #
+    # @param definition [Class] the name of a definition class
+    # @param block [Proc] logic to execute within the context of the definition
+    def on_view(definition, &block)
+      on(definition, true, &block)
+    end
+
+    alias_method :on_visit, :on_view
+    
+  end
+end

data/lib/fluent/generators.rb

@@ -22,10 +22,29 @@ module Fluent
         valid_title
       end
     end
+
+    def look_for(widget, timeout=::Fluent.element_level_wait)
+      define_method('check_objects') do
+        if self.respond_to? "#{widget}_object"
+          self.send("#{widget}_object").when_present(timeout)
+        else
+          raise "\n\nThe '#{widget}' object was not declared and could not be checked."
+        end
+      end
+    end
+    
+    # This is required to allow declaring element definitions as being
+    # within a frame in a page definition. The logic here makes sure that
+    # the enclosed element definitions have their actions generated.
+    def within_frame(locator, &block)
+      frame = []
+      frame << locator
+      block.call(frame)
+    end
     
     def link(identifier, locator)
       define_method(identifier) do
-        return platform.link_click(locator)
+        return platform.link_click(locator.clone)
       end
       
       common_definition_methods(identifier, locator, __method__)
@@ -33,7 +52,23 @@ module Fluent
     
     def paragraph(identifier, locator)
       define_method(identifier) do
-        return platform.paragraph_text(locator)
+        return platform.paragraph_text(locator.clone)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def div(identifier, locator)
+      define_method(identifier) do
+        return platform.div_text(locator.clone)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def span(identifier, locator)
+      define_method(identifier) do
+        return platform.span_text(locator.clone)
       end
       
       common_definition_methods(identifier, locator, __method__)
@@ -41,7 +76,7 @@ module Fluent
     
     def button(identifier, locator)
       define_method(identifier) do
-        return platform.button_click(locator)
+        return platform.button_click(locator.clone)
       end
       
       common_definition_methods(identifier, locator, __method__)
@@ -49,11 +84,23 @@ module Fluent
     
     def text_field(identifier, locator)
       define_method(identifier) do
-        return platform.text_field_get(locator)
+        return platform.text_field_get(locator.clone)
       end
       
       define_method("#{identifier}=") do |value|
-        return platform.text_field_set(locator, value)
+        return platform.text_field_set(locator.clone, value)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def text_area(identifier, locator)
+      define_method(identifier) do
+        return platform.text_area_get(locator.clone)
+      end
+
+      define_method("#{identifier}=") do |value|
+        return platform.text_area_set(locator.clone, value)
       end
       
       common_definition_methods(identifier, locator, __method__)
@@ -61,15 +108,15 @@ module Fluent
     
     def checkbox(identifier, locator)
       define_method("#{identifier}_checked?") do
-        return platform.checkbox_check_state(locator)
+        return platform.checkbox_check_state(locator.clone)
       end
 
       define_method("check_#{identifier}") do
-        return platform.checkbox_check(locator)
+        return platform.checkbox_check(locator.clone)
       end
 
       define_method("uncheck_#{identifier}") do
-        return platform.checkbox_uncheck(locator)
+        return platform.checkbox_uncheck(locator.clone)
       end
       
       common_definition_methods(identifier, locator, __method__)
@@ -77,13 +124,13 @@ module Fluent
     
     def select_list(identifier, locator)
       define_method(identifier) do
-        return platform.select_list_get_selected(locator)
+        return platform.select_list_get_selected(locator.clone)
       end
 
       alias_method "#{identifier}_option?".to_sym, "#{identifier}".to_sym
       
       define_method("#{identifier}=") do |value|
-        return platform.select_list_set(locator, value)
+        return platform.select_list_set(locator.clone, value)
       end
 
       define_method("#{identifier}_options?") do
@@ -92,7 +139,7 @@ module Fluent
       end
 
       define_method("#{identifier}_value?") do
-        return platform.select_list_get_value(locator)
+        return platform.select_list_get_value(locator.clone)
       end
       
       common_definition_methods(identifier, locator, __method__)
@@ -100,11 +147,11 @@ module Fluent
     
     def radio(identifier, locator)
       define_method("select_#{identifier}") do
-        return platform.radio_select(locator)
+        return platform.radio_select(locator.clone)
       end
 
       define_method("#{identifier}_selected?") do
-        return platform.radio_check_state(locator)
+        return platform.radio_check_state(locator.clone)
       end
 
       alias_method "#{identifier}_set?".to_sym, "#{identifier}_selected?".to_sym
@@ -112,20 +159,71 @@ module Fluent
       
       common_definition_methods(identifier, locator, __method__)
     end
+    
+    def ordered_list(identifier, locator)
+      define_method(identifier) do
+        return platform.ordered_list_text(locator.clone)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+      common_definition_methods(identifier, locator, 'ol')
+    end
+
+    def unordered_list(identifier, locator)
+      define_method(identifier) do
+        return platform.unordered_list_text(locator.clone)
+      end
+
+      common_definition_methods(identifier, locator, __method__)
+      common_definition_methods(identifier, locator, 'ul')
+    end
+    
+    def list_item(identifier, locator)
+      define_method(identifier) do
+        return platform.list_item_text(locator.clone)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+      common_definition_methods(identifier, locator, 'li')
+    end
+    
+    def table(identifier, locator)
+      define_method(identifier) do
+        return platform.table_text(locator.clone)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+
+    def cell(identifier, locator)
+      define_method(identifier) do
+        return platform.cell_text(locator.clone)
+      end
 
-    alias_method :radio_button, :radio
+      common_definition_methods(identifier, locator, __method__)
+      common_definition_methods(identifier, locator, 'td')
+    end
+    
+    alias_method :radio_button, :radio ###
+    alias_method :textarea, :text_area ###
+    alias_method :textfield, :text_field ###
+    alias_method :a, :link ###
+    alias_method :ol, :ordered_list
+    alias_method :ul, :unordered_list
+    alias_method :li, :list_item
+    alias_method :td, :cell
     
     def common_definition_methods(identifier, locator, method)
       define_method("#{identifier}_object") do
-        platform.send(method, locator)
+        platform.send(method, locator.clone)
       end
       
       define_method("#{identifier}_exists?") do
-        platform.send(method, locator).exists?
+        platform.send(method, locator.clone).exists?
       end
 
       define_method("#{identifier}_visible?") do
-        platform.send(method, locator).visible?
+        platform.send(method, locator.clone).visible?
       end
             
       alias_method "#{identifier}_#{method}".to_sym, "#{identifier}_object".to_sym
@@ -142,7 +240,7 @@ module Fluent
       
       if Fluent.can_be_enabled?(method)
         define_method("#{identifier}_enabled?") do
-          platform.send(method, locator).enabled?
+          platform.send(method, locator.clone).enabled?
         end
 
         alias_method "#{identifier}!".to_sym, "#{identifier}_enabled?".to_sym