fluent 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 831ffd392a614908ecb6463d83c08722cc6db46e
-  data.tar.gz: b77b255e808fa50a53e782a6c0e516d0694109ae
+  metadata.gz: e7b289657c5c2713886307bdc023c6fdcaf9bbcb
+  data.tar.gz: 38bb9627501b8de39e237a5394075f2777160098
 SHA512:
-  metadata.gz: c5220df18eb53a74fdafcdcfbb38e89b02e8085cbe321db5a5f6117d842603201ed7f9b75f89d6851c06054d4d8e168319e1d555cb312647d4314026b97d38d9
-  data.tar.gz: a628d1f6c4436395a4c04435800892a45b92619723a827d729bcd36cc2412974ac17eb3c53352d2c3ba0664fc01f902b6a7178645fb7dffd1d461944219f95dd
+  metadata.gz: a092ca78215b22f6b0b62918db49bf3adf109133dc3552df6c0c05cddc52b86863b06121a0a2403c5e62a399a5532cac4f8feee00b215f02fdcb7c9f0cebdd08
+  data.tar.gz: a640ce119c147c73d3acf21f50b5e6ad1bbef349de59b3d9b9ec7dcbcb9a7ad4568d3c8df4394b641ac6218de7574bd3c6dc93a3825429a1ffa0250201e5f952

data/HISTORY.md

@@ -1,6 +1,17 @@
 Change Log and History
 ======================
 
+Version 0.7.0 / 2013-12-06
+--------------------------
+
+This release adds some key new features:
+
+* The ability to create workflows and have those workflows automatically executed. The workflow mechanism relies entirely on the factory module in order to create the context by which a set of actions can be taken against a page definition or activity definition.
+
+* Two new enclosers have been added: "within_modal" and "within_window". These allow you to work within the context of a modal box or a different browser window.
+
+* A data configuration module has been added that allows you to more easily call upon environment or configuration data as part of your test execution.
+
 Version 0.6.0 / 2013-11-26
 --------------------------
 

data/README.md

@@ -5,6 +5,7 @@ Fluent
 [![Dependency Status](https://gemnasium.com/jnyman/fluent.png)](https://gemnasium.com/jnyman/fluent)
 [![Gem Version](https://badge.fury.io/rb/fluent.png)](http://badge.fury.io/rb/fluent)
 [![Coverage Status](https://coveralls.io/repos/jnyman/fluent/badge.png?branch=master)](https://coveralls.io/r/jnyman/fluent)
+[![Code Climate](https://codeclimate.com/github/jnyman/fluent.png)](https://codeclimate.com/github/jnyman/fluent)
 
 Fluent provides a semantic domain-specific language that can be used to construct a fluent interface for test execution libraries.
 

data/lib/fluent.rb

@@ -7,8 +7,10 @@ require 'fluent/enclosers'
 require 'fluent/evaluators'
 require 'fluent/generators'
 require 'fluent/locators'
+require 'fluent/workflows'
 require 'fluent/data_setter'
 require 'fluent/data_builder'
+require 'fluent/data_config'
 
 require 'watir-webdriver'
 require 'selenium-webdriver'
@@ -21,6 +23,7 @@ module Fluent
   include Locators
   include DataSetter
   include DataBuilder
+  include DataConfig
   
   # Browser drivers will be:
   # [Watir::Browser] or [Selenium::WebDriver::Driver]

data/lib/fluent/data_config.rb

@@ -0,0 +1,49 @@
+require 'fluent/data_reader'
+
+module Fluent
+  module DataConfigHelper
+
+    # This is being used in order to allow a call to any key in a config
+    # file. The key will be treated as a method. Since no such method
+    # will exist, the method_missing call will handle finding the key
+    # in a file.
+    def method_missing(*args, &block)
+      determine_data_source unless @data_source
+      
+      key = args.first
+
+      value = @data_source[key.to_s]
+      value = args[1] unless value
+      
+      value
+    end
+    
+    # Determines what data source to use. If this is being called, it
+    # means no data source was specified. If an environment variable
+    # has been set, that will be used. If no data source can be
+    # established, a default data file will be referenced.
+    def determine_data_source
+      @data_source = nil
+      @data_source = YAML.load_file "#{data_path}/#{ENV['FLUENT_CONFIG_FILE']}" if ENV['FLUENT_CONFIG_FILE']
+      
+      Fluent::DataConfig.load 'config-data.yml' if @data_source.nil?
+    end
+    
+  end
+
+  module DataConfig
+    extend DataReader
+    extend DataConfigHelper
+    
+    class << self
+      attr_accessor :data_source
+    end
+    
+    def self.default_data_path
+      'common/data'
+    end
+    
+  end
+
+  
+end

data/lib/fluent/enclosers.rb

@@ -31,5 +31,36 @@ module Fluent
     def will_prompt(response, &block)
       platform.will_prompt(response, &block)
     end
+
+    # Used to identify a web element or action on a web element 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 locator [Hash] the :title or :url of the window
+    # @param block [Proc] any code that should be executed as an
+    # action on or within the window
+    def within_window(locator, &block)
+      platform.within_window(locator, &block)
+    end
+    
+    alias_method :select_window, :within_window
+    alias_method :attach_to, :within_window
+    
+    # Used to identify a web element as existing within an enclosing object
+    # like a modal dialog box. What this does is override the normal call to
+    # showModalDialog and opens a window instead. In order to use this new
+    # window, you have to attach to it.
+    def within_modal(&block)
+      convert_modal_to_window = %Q{
+        window.showModalDialog = function(sURL, vArguments, sFeatures) {
+          window.dialogArguments = vArguments;
+          modalWin = window.open(sURL, 'modal', sFeatures);
+          return modalWin;
+        }
+      }
+      driver.execute_script(convert_modal_to_window)
+      yield if block_given?
+    end
   end
 end

data/lib/fluent/errors.rb

@@ -5,5 +5,7 @@ module Fluent
     class TitleNotMatched < StandardError; end
     class UrlNotMatched < StandardError; end
     class UnableToCreatePlatform < StandardError; end
+    class WorkflowPathNotFound < StandardError; end
+    class WorkflowActionNotFound < StandardError; end
   end
 end

data/lib/fluent/evaluators.rb

@@ -2,6 +2,12 @@ module Fluent
   module Evaluators
 
     ## Browser-Level Actions ##
+
+    def visit(url)
+      platform.visit(url)
+    end
+
+    alias_method :navigate_to, :visit
     
     def url
       platform.url
@@ -47,6 +53,12 @@ module Fluent
       sleep value
     end
     
+    def focused
+      platform.focused
+    end
+
+    alias_method :what_has_focus?, :focused
+    
     # Attempts to wait for pending jQuery requests and indicate if the
     # requests did not occur in a given time period.
     #

data/lib/fluent/factory.rb

@@ -1,6 +1,9 @@
+require 'fluent/workflows'
+
 module Fluent
   module Factory
-
+    include Workflow
+    
     # Creates a definition context for actions. If an existing context
     # exists, that context will be re-used.
     #
@@ -11,7 +14,11 @@ module Fluent
     def on(definition, visit=false, &block)
       definition = get_object_for(definition) if definition.is_a? String
       
-      return @active if @active.kind_of?(definition)
+      if @active.kind_of?(definition)
+        block.call @active if block
+        return @active
+      end
+      
       @active = definition.new(@driver, visit)
       block.call @active if block
       

data/lib/fluent/platform_watir/platform_object.rb

@@ -53,6 +53,13 @@ module Fluent
           driver.wait_until(timeout, message, &block)
         end
         
+        def focused
+          web_element = driver.execute_script('return document.activeElement')
+          type = web_element.type.to_sym if web_element.tag_name.to_sym == :input
+          object_class = ::Fluent::WebElements.get_class_for(web_element.tag_name, type)
+          object_class.new(web_element, :platform => :watir_webdriver)
+        end
+        
         ## Encloser Actions ##
         
         def will_alert(&block)
@@ -84,6 +91,11 @@ module Fluent
           result
         end
         
+        def within_window(locator, &block)
+          identifier = {locator.keys.first => /#{Regexp.escape(locator.values.first)}/}
+          driver.window(identifier).use(&block)
+        end
+        
         ## Generator Actions ##
         
         def link(locator)

data/lib/fluent/version.rb

@@ -1,3 +1,3 @@
 module Fluent
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/fluent/workflows.rb

@@ -0,0 +1,75 @@
+module Fluent
+  module WorkflowPaths
+    def paths
+      @paths
+    end
+
+    def paths=(workflow_path)
+      @paths = workflow_path
+    end
+  end
+
+  module Workflow
+    
+    def self.included(caller)
+      Fluent.trace("#{caller.class} #{caller} is using workflows.")
+      caller.extend WorkflowPaths
+      @def_caller = caller
+    end
+    
+    def self.def_caller
+      @def_caller
+    end
+    
+    # This provides a workflow for a given workflow path, using a
+    # specific definition that is part of that workflow path.
+    #
+    # @param definition [Object] definition object using the workflow
+    # @param path_name [Hash] the name of the path to be used
+    # @param block [Proc] a block to be executed as part of the workflow
+    # @return [Object] the definition being interacted with
+    def workflow_for(definition, path_name = {:using => :default}, &block)
+      path_name[:using] = :default unless path_name[:using]
+      
+      path_workflow = workflow_path_for(path_name)
+      
+      workflow_goal = work_item_index_for(path_workflow, definition)
+      
+      workflow_start = path_name[:from] ? path_workflow.find_index { |item| item[0] == path_name[:from]} : 0
+      
+      perform_workflow(path_workflow[workflow_start..workflow_goal])
+      
+      on(definition, &block)
+    end
+    
+    def workflow_path_for(path_name)
+      # Since I am dealing with an array that contains a hash that, in
+      # turn, contains an array of arrays, below I need to make sure I
+      # index into the array before keying into the hash. That's the
+      # purpose of the [0].
+      path = Workflow.def_caller.paths[0][path_name[:using]]
+      
+      raise Fluent::Errors::WorkflowPathNotFound,
+            "Workflow path '#{path_name[:using].to_s}' not found." unless path
+      
+      path
+    end
+    
+    def work_item_index_for(path_workflow, definition)
+      path_workflow.find_index { |item| item[0] == definition }
+    end
+    
+    def perform_workflow(definitions)
+      definitions.each do |definition, action, *args|
+        active = on(definition)
+        
+        raise Fluent::Errors::WorkflowActionNotFound,
+              "Workflow action '#{action}' not defined on #{definition}." unless active.respond_to? action
+        
+        active.send action unless args
+        active.send action, *args if args
+      end
+    end
+    
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/fluent/data_builder.rb
+- lib/fluent/data_config.rb
 - lib/fluent/data_reader.rb
 - lib/fluent/data_setter.rb
 - lib/fluent/enclosers.rb
@@ -168,6 +169,7 @@ files:
 - lib/fluent/web_elements/unordered_list.rb
 - lib/fluent/web_elements/web_element.rb
 - lib/fluent/web_elements.rb
+- lib/fluent/workflows.rb
 - lib/fluent.rb
 - LICENSE.txt
 - README.md