symbiote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ec0549216f3d55f7e16bd2b37aed307395e9f60
+  data.tar.gz: cf2d54e3824dcafa388cb6efa9539670f4bbb9b4
+SHA512:
+  metadata.gz: 0539a73d3ee9cdd64a84dff6bec77b3ca78b648c4206be051c2839fd32bdaf5f4a33d8e053fe705b9532228ddd6fa39c2d0822e830db0ab64c7010f6ebd15eca
+  data.tar.gz: e84ee2e270ca6c58a3166cbe00f9eecbdb7ff30343156a42e74687f8ce9c80464b991c5e79f340f1db05992ab44f891b2d77aaa5c8f5b8f5c6bae89c01d71e31

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.idea
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+output/
+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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in symbiote.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/HISTORY.md

@@ -0,0 +1,7 @@
+Change Log and History
+======================
+
+Version 0.1.0 / 2013-10-06
+--------------------------
+
+Initial development release of Symbiote. This initial release handles browser drivers, platform objects, and the start of the generators mechanism. Support is in place for both Watir-WebDriver and Selenium-WebDriver.

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,46 @@
+Symbiote
+========
+
+[![Build Status](https://secure.travis-ci.org/jnyman/symbiote.png)](http://travis-ci.org/jnyman/symbiote)
+[![Dependency Status](https://gemnasium.com/jnyman/symbiote.png)](https://gemnasium.com/jnyman/symbiote)
+[![Gem Version](https://badge.fury.io/rb/symbiote.png)](http://badge.fury.io/rb/symbiote)
+[![Coverage Status](https://coveralls.io/repos/jnyman/symbiote/badge.png?branch=master)](https://coveralls.io/r/jnyman/symbiote)
+
+Description
+-----------
+
+Symbiote is designed to be a more streamlined version of Symbiont. Specifically, it will be streamlined in terms of its feature set, based on lessons I learned during the development of Symbiont. The general interface that Symbiont exposed will still be available.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'symbiote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install symbiote
+
+Using Symbiote
+--------------
+
+See the [Symbiote wiki](https://github.com/jnyman/symbiote/wiki) for details on how to use the tool.
+
+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,22 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  desc 'Get file output for spec execution'
+  RSpec::Core::RakeTask.new('detail') do |config|
+    options  = %w(--color)
+    options += %w(--format documentation)
+    options += %w(--format nested --out output/rspec-report.txt)
+    options += %w(--format html --out output/rspec-report.html)
+    config.rspec_opts = options
+  end
+end
+
+RSpec::Core::RakeTask.new do |config|
+  options  = %w(--color)
+  options += %w(--format documentation)
+  config.rspec_opts = options
+end
+
+task :default => :spec

data/lib/symbiote/errors.rb

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

data/lib/symbiote/generators.rb

@@ -0,0 +1,21 @@
+module Symbiote
+  module Generators
+    
+    def url_is(url)
+      define_method('view') do
+        platform.visit(url)
+      end
+    end
+    
+    def title_is(title)
+      define_method('has_title?') do
+        validation_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 Errors::TitleNotMatched, validation_msg unless valid_title
+        valid_title
+      end
+    end
+    
+  end
+end

data/lib/symbiote/logger.rb

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

data/lib/symbiote/platform_selenium/platform_object.rb

@@ -0,0 +1,21 @@
+module Symbiote
+  module Platforms
+    module SeleniumWebDriver
+      class PlatformObject
+        
+        attr_reader :browser
+        
+        def initialize(browser)
+          @browser = browser
+        end
+        
+        ## Browser-Level Actions ##
+        
+        def visit(url)
+          browser.navigate.to(url)
+        end
+        
+      end
+    end
+  end
+end

data/lib/symbiote/platform_selenium.rb

@@ -0,0 +1,18 @@
+module Symbiote
+  module Platforms
+    module SeleniumWebDriver
+
+      def self.create_platform_object_for(browser)
+        require 'symbiote/platform_selenium/platform_object'
+        return SeleniumWebDriver::PlatformObject.new(browser)
+      end
+
+      def self.works_with(browser)
+        browser.is_a?(::Selenium::WebDriver::Driver)
+      end
+      
+    end
+  end
+end
+
+Symbiote::Platforms.register(:selenium_webdriver, Symbiote::Platforms::SeleniumWebDriver)

data/lib/symbiote/platform_watir/platform_object.rb

@@ -0,0 +1,21 @@
+module Symbiote
+  module Platforms
+    module WatirWebDriver
+      class PlatformObject
+        
+        attr_reader :browser
+        
+        def initialize(browser)
+          @browser = browser
+        end
+        
+        ## Browser-Level Actions ##
+        
+        def visit(url)
+          browser.goto(url)
+        end
+        
+      end
+    end
+  end
+end

data/lib/symbiote/platform_watir.rb

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

data/lib/symbiote/platforms.rb

@@ -0,0 +1,31 @@
+module Symbiote
+  module Platforms
+    
+    @drivers = {}
+    
+    def self.list
+      @drivers
+    end
+    
+    def self.register(driver, platform)
+      @drivers[driver] = platform
+    end
+
+    # This module determines what execution platform Symbiote 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)
+      Symbiote::Platforms.list.each_value do |driver|
+        return driver.create_platform_object_for(browser) if driver.works_with(browser)
+      end
+      raise Errors::UnableToCreatePlatform, "Unable to create a platform object for #{browser}"
+    end
+    
+  end
+end
+
+require 'symbiote/platform_watir'
+require 'symbiote/platform_selenium'

data/lib/symbiote/version.rb

@@ -0,0 +1,3 @@
+module Symbiote
+  VERSION = '0.1.0'
+end

data/lib/symbiote.rb

@@ -0,0 +1,65 @@
+require 'symbiote/version'
+require 'symbiote/logger'
+require 'symbiote/errors'
+require 'symbiote/platforms'
+require 'symbiote/generators'
+
+require 'watir-webdriver'
+require 'selenium-webdriver'
+
+module Symbiote
+  include Platforms
+
+  # @return [Object] platform reference
+  # [Symbiont::Platforms::WatirWebDriver::PlatformObject]
+  # [Symbiont::Platforms::SeleniumWebDriver::PlatformObject]
+  attr_reader :platform
+  
+  # @return [Object] browser reference
+  # [Watir::Browser]
+  # [Selenium::WebDriver::Driver]
+  attr_reader :browser
+  
+  def self.version
+    "Symbiote v#{Symbiote::VERSION}"
+  end
+
+  # The included callback is used to provide the core functionality of the
+  # library to any class or module that includes the Symbiote library. The
+  # calling class or module is extended with logic that the library makes
+  # available as class methods. Those methods will be available only in
+  # the context of the class (definition) that included Symbiote.
+  def self.included(caller)
+    Symbiote.trace("#{caller.class} #{caller} attached the Symbiote")
+    caller.extend Symbiote::Generators
+  end
+
+  # The initialize method will be invoked when a page definition includes
+  # Symbiote. 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 [Object] browser 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
+    
+    Symbiote::trace("Symbiote attached to browser: #{@browser}")
+    
+    establish_platform_object_for(@browser)
+  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 [Object] browser a browser instance with a tool driver
+  def establish_platform_object_for(browser)
+    @platform = get_platform_for(browser)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'coveralls'
+Coveralls.wear!
+
+unless ENV['CI']
+  require 'simplecov'
+  
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start
+end
+
+require 'symbiote'
+require 'watir-webdriver'
+require 'selenium-webdriver'
+
+def mock_browser_for_watir
+  watir_browser = double('watir')
+  watir_browser.stub(:is_a?).with(Watir::Browser).and_return(true)
+  watir_browser.stub(:is_a?).with(Selenium::WebDriver::Driver).and_return(false)
+  watir_browser
+end
+
+def mock_browser_for_selenium
+  selenium_browser = double('selenium')
+  selenium_browser.stub(:is_a?).with(Watir::Browser).and_return(false)
+  selenium_browser.stub(:is_a?).with(Selenium::WebDriver::Driver).and_return(true)
+  selenium_browser
+end

data/spec/symbiote/generators_spec.rb

@@ -0,0 +1,63 @@
+require_relative '../spec_helper'
+
+class PageGenerators
+  include Symbiote
+  
+  url_is 'http://localhost:4567'
+  title_is 'Symbiote'
+end
+
+describe Symbiote::Generators do
+  let(:watir_browser)    { mock_browser_for_watir }
+  let(:watir_definition) { PageGenerators.new(watir_browser) }
+
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:selenium_definition) { PageGenerators.new(selenium_browser) }
+  
+  context 'any page definition' do
+    context 'providing a page title to be verified' do
+      it 'should specify and verify the page title' do
+        watir_browser.should_receive(:title).twice.and_return('Symbiote')
+        watir_definition.has_title?
+
+        selenium_browser.should_receive(:title).twice.and_return('Symbiote')
+        selenium_definition.has_title?
+      end
+      
+      it 'should raise an error if the page title is not verified' do
+        msg = "Expected title: 'Symbiote'; Actual title: 'Testing'"
+        watir_browser.should_receive(:title).twice.and_return('Testing')
+        expect { watir_definition.has_title? }.to raise_error(Symbiote::Errors::TitleNotMatched, msg)
+      end
+
+      it 'should validate the title if provided a regular expression' do
+        class QuickDefinition
+          include Symbiote
+          title_is (/\w+/)
+        end
+
+        selenium_browser.should_receive(:title).twice.and_return('Symbiote')
+        QuickDefinition.new(selenium_browser).has_title?
+      end
+    end
+  end
+  
+  context 'a definition using watir-webdriver' do
+    context 'providing a url' do
+      it 'should navigate to the page when viewed' do
+        watir_browser.should_receive(:goto)
+        watir_definition.view
+      end
+    end
+  end
+  
+  context 'a definition using selenium-webdriver' do
+    context 'providing a url' do
+      it 'should navigate to the page when viewed' do
+        selenium_browser.should_receive(:navigate).and_return(selenium_browser)
+        selenium_browser.should_receive(:to)
+        selenium_definition.view
+      end
+    end
+  end
+end

data/spec/symbiote/platform_object_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../spec_helper'
+
+class PageDefinition
+  include Symbiote
+end
+
+describe Symbiote do
+  let(:watir_browser) { mock_browser_for_watir }
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:watir_definition) { PageDefinition.new(watir_browser) }
+  let(:selenium_definition) { PageDefinition.new(selenium_browser) }
+
+  context 'a definition using watir-webdriver' do
+    it 'should return a watir platform object' do
+      watir_definition.platform.should be_kind_of Symbiote::Platforms::WatirWebDriver::PlatformObject
+    end
+  end
+
+  context 'a definition using selenium-webdriver' do
+    it 'should return a selenium platform object' do
+      selenium_definition.platform.should be_kind_of Symbiote::Platforms::SeleniumWebDriver::PlatformObject
+    end
+  end
+
+  context 'a definition using an unrecognized driver' do
+    it 'should raise an exception' do
+      msg = 'Unable to create a platform object for unknown_browser'
+      expect { PageDefinition.new(:unknown_browser) }.to raise_error(Symbiote::Errors::UnableToCreatePlatform, msg)
+    end
+  end
+end

data/spec/symbiote/symbiote_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../spec_helper'
+
+describe Symbiote do
+  it 'should return version information' do
+    Symbiote.version.should == "Symbiote v#{Symbiote::VERSION}"
+  end
+end

data/symbiote.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'symbiote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'symbiote'
+  spec.version       = Symbiote::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.author        = 'Jeff Nyman'
+  spec.email         = 'jeffnyman@gmail.com'
+  spec.description   = 'Provides a DSL to construct a fluent interface for test execution libraries.'
+  spec.summary       = 'An endosymbiotic facultative library for web application testing.'
+  spec.homepage      = 'https://github.com/jnyman/symbiote'
+  spec.license       = 'MIT'
+
+  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.14.1'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+
+  spec.add_runtime_dependency 'watir-webdriver', '0.6.4'
+  spec.add_runtime_dependency 'selenium-webdriver', '2.35.1'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: symbiote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Nyman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.35.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.35.1
+description: Provides a DSL to construct a fluent interface for test execution libraries.
+email: jeffnyman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- HISTORY.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/symbiote.rb
+- lib/symbiote/errors.rb
+- lib/symbiote/generators.rb
+- lib/symbiote/logger.rb
+- lib/symbiote/platform_selenium.rb
+- lib/symbiote/platform_selenium/platform_object.rb
+- lib/symbiote/platform_watir.rb
+- lib/symbiote/platform_watir/platform_object.rb
+- lib/symbiote/platforms.rb
+- lib/symbiote/version.rb
+- spec/spec_helper.rb
+- spec/symbiote/generators_spec.rb
+- spec/symbiote/platform_object_spec.rb
+- spec/symbiote/symbiote_spec.rb
+- symbiote.gemspec
+homepage: https://github.com/jnyman/symbiote
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: An endosymbiotic facultative library for web application testing.
+test_files:
+- spec/spec_helper.rb
+- spec/symbiote/generators_spec.rb
+- spec/symbiote/platform_object_spec.rb
+- spec/symbiote/symbiote_spec.rb
+has_rdoc: