fluent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 517921e222ad7a40ccb585b10e1b951e014a8959
+  data.tar.gz: b4685be3d80ab1d3602f83fcbf0bfca5fde45ebd
+SHA512:
+  metadata.gz: a390c6b5f7273ea9c881a52dfb4c357f6e839afdd1988d143979a82fc3e4b3374209a221ce238180c2c6085e6535d540947c1556f64c300f2e4f8973a836a3a9
+  data.tar.gz: e327f85cd71bc75d8364668b3c90d6cb98fb3397057132874f5aa1534e2548d18ebab0fa25f1cbeba11a6eac23745c2df5c4209b79030dac410cdf9dc86aac60

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.idea
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+output/
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,14 @@
+script: "rake"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+branches:
+  only:
+    - master
+    - develop
+
+notifications:
+  recipients:
+    - jeffnyman@gmail.com

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+
+gemspec

data/HISTORY.md

@@ -0,0 +1,19 @@
+Change Log and History
+======================
+
+Version 0.1.0 / 2013-10-18
+--------------------------
+
+Initial development release of Fluent. At this point, the basic moving parts have been put in place in order for the framework to be usable.
+
+Fluent ...
+
+* ... can be included in page or activity definitions.
+
+* ... is able to create platform objects based on a driver library.
+
+* ... allows element definitions to be created.
+
+* ... uses generators to create actions based on element definitions.
+
+At this point, the only test library supported is Watir-WebDriver. The web elements that Fluent can recognize are button, checkbox, link, paragraph, radio, select_list, and text_field. The assertions that Fluent allows are url_is and title_is.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeff Nyman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+Fluent
+======
+
+[![Build Status](https://secure.travis-ci.org/jnyman/fluent.png)](http://travis-ci.org/jnyman/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)
+
+Fluent provides a semantic domain-specific language that can be used to construct a fluent interface for test execution libraries.
+
+See the [Fluent wiki](https://github.com/jnyman/fluent/wiki) for details on how to use the framework.
+
+Installation
+------------
+
+Generally you will just install Fluent as a gem:
+
+    $ gem install fluent
+
+If your application uses a Gemfile, add the following line to it:
+
+    gem 'fluent'
+
+And then execute:
+
+    $ bundle
+
+Contributing
+------------
+
+1. Fork the project.
+2. Create a branch for your change.
+3. Make your feature additions or bug fixes in your branch.
+4. Create unit tests (in spec) for your changes.
+5. Create acceptance tests (in specs) for your changes.
+6. Commit your changes.
+7. Push to the branch.
+8. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+Do note that pull requests are very welcome and are considered better than bug reports. Please create a topic branch for every separate change that you make. When you make commits, do not change the rakefile, version or history information.

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |config|
+  options  = %w(--color)
+  options += %w(--format documentation)
+  options += %w(--format nested --out output/fluent-test-report.txt)
+  options += %w(--format html --out output/fluent-test-report.html)
+  config.rspec_opts = options
+end
+
+task :default => :spec

data/fluent.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent'
+  spec.version       = Fluent::VERSION
+  spec.author        = 'Jeff Nyman'
+  spec.email         = 'jeffnyman@gmail.com'
+  spec.description   = %q{Provides a semantic DSL to construct a fluent interface for test execution libraries.}
+  spec.summary       = %q{A Semantically Clean Fluent Interface Test Framework}
+  spec.homepage      = 'https://github.com/jnyman/fluent'
+  spec.license       = 'MIT'
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+
+  spec.add_runtime_dependency 'watir-webdriver', '0.6.4'
+  spec.add_runtime_dependency 'selenium-webdriver', '2.37.0'
+end

data/lib/fluent.rb

@@ -0,0 +1,82 @@
+require 'fluent/version'
+require 'fluent/errors'
+require 'fluent/logger'
+require 'fluent/platforms'
+require 'fluent/generators'
+
+require 'watir-webdriver'
+require 'selenium-webdriver'
+
+module Fluent
+  include Platforms
+  
+  # Browser drivers will be:
+  # [Watir::Browser] or [Selenium::WebDriver::Driver]
+  #
+  # @return [Object] browser driver reference
+  attr_reader :browser
+
+  # Platform references will be:
+  # [Fluent::Platforms::WatirWebDriver::PlatformObject]
+  # [Fluent::Platforms::SeleniumWebDriver::PlatformObject]
+  #
+  # @return [Object] platform reference
+  attr_reader :platform
+  
+  def self.version
+    "Fluent v#{Fluent::VERSION}"
+  end
+
+  # The included callback is used to provide the core functionality of the
+  # library to any class or module that includes the Fluent library. The
+  # calling class or module is extended with logic that the library makes
+  # available as class methods. Those classes become page definitions or
+  # activity definitions.
+  #
+  # @param caller [Class] the class including the library
+  def self.included(caller)
+    caller.extend Fluent::Generators
+    
+    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:
+  #   (1) A browser instance is being created.
+  #   (2) A platform object is created for that browser.
+  #
+  # @param browser [Object] a browser instance with a tool driver
+  def initialize(browser=nil)
+    @browser = browser
+    @browser = Watir::Browser.new if browser.nil? or browser == :watir
+    @browser = Selenium::WebDriver.for :firefox if browser == :selenium
+
+    Fluent::trace("Fluent attached to browser: #{@browser}")
+    
+    establish_platform_object_for @browser
+  end
+  
+  def self.can_be_enabled
+    @can_be_enabled ||= [:button, :text_field, :checkbox, :select_list, :radio]
+  end
+  
+  def self.can_be_enabled?(method)
+    can_be_enabled.include? method.to_sym
+  end
+  
+  private
+
+  # This method is crucial in that it sets up the platform instance that
+  # will be used by just about every module that makes calls to any
+  # platform-specific functionality.
+  #
+  # @param browser [Object] a browser instance with a tool driver
+  # @return [Object] a platform object to execute tests against
+  def establish_platform_object_for(browser)
+    @platform = get_platform_for browser
+
+    Fluent::trace("Fluent platform object: #{@platform}")
+    @platform
+  end
+end

data/lib/fluent/errors.rb

@@ -0,0 +1,8 @@
+module Fluent
+  module Errors
+    class NoUrlForDefinition < StandardError; end
+    class NoTitleForDefinition < StandardError; end
+    class TitleNotMatched < StandardError; end
+    class UnableToCreatePlatform < StandardError; end
+  end
+end

data/lib/fluent/generators.rb

@@ -0,0 +1,155 @@
+module Fluent
+  module Generators
+    
+    def url_is(url=nil)
+      msg = "The url_is assertion is empty on the definition #{self}."
+      raise Fluent::Errors::NoUrlForDefinition, msg if url.nil?
+      
+      define_method('view') do
+        platform.visit(url)
+      end
+    end
+    
+    def title_is(title=nil)
+      msg = "The title_is assertion is empty on the definition #{self}."
+      raise Fluent::Errors::NoTitleForDefinition, msg if title.nil?
+      
+      define_method('check_title') do
+        msg  = "Expected title: '#{title}'; Actual title: '#{browser.title}'"
+        valid_title = title == browser.title if title.kind_of?(String)
+        valid_title = title =~ browser.title if title.kind_of?(Regexp)
+        raise Fluent::Errors::TitleNotMatched, msg unless valid_title
+        valid_title
+      end
+    end
+    
+    def link(identifier, locator)
+      define_method(identifier) do
+        return platform.link_click(locator)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def paragraph(identifier, locator)
+      define_method(identifier) do
+        return platform.paragraph_text(locator)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def button(identifier, locator)
+      define_method(identifier) do
+        return platform.button_click(locator)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def text_field(identifier, locator)
+      define_method(identifier) do
+        return platform.text_field_get(locator)
+      end
+      
+      define_method("#{identifier}=") do |value|
+        return platform.text_field_set(locator, value)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def checkbox(identifier, locator)
+      define_method("#{identifier}_checked?") do
+        return platform.checkbox_check_state(locator)
+      end
+
+      define_method("check_#{identifier}") do
+        return platform.checkbox_check(locator)
+      end
+
+      define_method("uncheck_#{identifier}") do
+        return platform.checkbox_uncheck(locator)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def select_list(identifier, locator)
+      define_method(identifier) do
+        return platform.select_list_get_selected(locator)
+      end
+
+      alias_method "#{identifier}_option?".to_sym, "#{identifier}".to_sym
+      
+      define_method("#{identifier}=") do |value|
+        return platform.select_list_set(locator, value)
+      end
+
+      define_method("#{identifier}_options?") do
+        web_object = self.send("#{identifier}_object")
+        (web_object && web_object.options) ? web_object.options.collect(&:text) : []
+      end
+
+      define_method("#{identifier}_value?") do
+        return platform.select_list_get_value(locator)
+      end
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+    
+    def radio(identifier, locator)
+      define_method("select_#{identifier}") do
+        return platform.radio_select(locator)
+      end
+
+      define_method("#{identifier}_selected?") do
+        return platform.radio_check_state(locator)
+      end
+
+      alias_method "#{identifier}_set?".to_sym, "#{identifier}_selected?".to_sym
+      alias_method "set_#{identifier}".to_sym, "select_#{identifier}".to_sym
+      
+      common_definition_methods(identifier, locator, __method__)
+    end
+
+    alias_method :radio_button, :radio
+    
+    def common_definition_methods(identifier, locator, method)
+      define_method("#{identifier}_object") do
+        platform.send(method, locator)
+      end
+      
+      define_method("#{identifier}_exists?") do
+        platform.send(method, locator).exists?
+      end
+
+      define_method("#{identifier}_visible?") do
+        platform.send(method, locator).visible?
+      end
+            
+      alias_method "#{identifier}_#{method}".to_sym, "#{identifier}_object".to_sym
+      alias_method "#{identifier}_element".to_sym, "#{identifier}_object".to_sym
+
+      alias_method "#{identifier}?".to_sym, "#{identifier}_exists?".to_sym
+      alias_method "#{identifier}_?".to_sym, "#{identifier}_visible?".to_sym
+      
+      alias_method "#{identifier}_#{method}_exists?".to_sym, "#{identifier}_exists?".to_sym
+      alias_method "#{identifier}_#{method}_visible?".to_sym, "#{identifier}_visible?".to_sym
+      
+      alias_method "#{identifier}_#{method}?".to_sym, "#{identifier}_exists?".to_sym
+      alias_method "#{identifier}_#{method}_?".to_sym, "#{identifier}_visible?".to_sym
+      
+      if Fluent.can_be_enabled?(method)
+        define_method("#{identifier}_enabled?") do
+          platform.send(method, locator).enabled?
+        end
+
+        alias_method "#{identifier}!".to_sym, "#{identifier}_enabled?".to_sym
+        alias_method "#{identifier}_#{method}_enabled?".to_sym, "#{identifier}_enabled?".to_sym
+        alias_method "#{identifier}_#{method}!".to_sym, "#{identifier}_exists?".to_sym
+      end
+    end
+    
+  end
+end

data/lib/fluent/logger.rb

@@ -0,0 +1,5 @@
+module Fluent
+  def self.trace(message, level=1)
+    puts('*' * level + " #{message}") if ENV['FLUENT_TRACE'] == 'on'
+  end
+end

data/lib/fluent/platform_watir.rb

@@ -0,0 +1,18 @@
+module Fluent
+  module Platforms
+    module WatirWebDriver
+      
+      def self.create_platform_object_for(browser)
+        require 'fluent/platform_watir/platform_object'
+        return WatirWebDriver::PlatformObject.new(browser)
+      end
+      
+      def self.works_with?(browser)
+        browser.is_a?(::Watir::Browser)
+      end
+      
+    end
+  end
+end
+
+Fluent::Platforms.register(:watir_webdriver, Fluent::Platforms::WatirWebDriver)