symbiont 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/*
+output/*
+.idea/*
+pkg/*
+*.gem
+*.swo
+*.swp
+.DS_Store
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in symbiont.gemspec
+gemspec

data/HISTORY.md

@@ -0,0 +1,7 @@
+Change Log and History
+======================
+
+Version 0.0.1 / 2012-03-02
+--------------------------
+
+This is a bare implementation of the Symbiont library. The Symbiont library is one part of what will be the Lucid testing framework. This release does nothing beyond establishing the gem and providing some basis for how the library will work.

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright © 2012 Jeff Nyman
+
+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,23 @@
+Symbiont
+========
+
+Description
+-----------
+
+The Symbiont gem is designed to provide an open framework for running automated tests against a browser using popular web testing interfaces.
+
+
+Meaning
+-------
+
+A "symbiont" is an organism in a symbiotic (mutually beneficial) relationship. Some of these relationships are called _obligate_, which means that both organisms need each other in order to survive. Other such relationships are called _facultative_, meaning that both organisms don't strictly need each other to survive, but they stand a better chance if they do.
+
+Symbiotic relationships include associations in which one organism lives on another organism -- _ectosymbiosis_ -- or where one organism lives inside the other -- _endosymbiosis_.
+
+So, with that bit of context, think of this gem as a facultative, endosymbiotic organism that lives within your test logic, giving it strength and sustenance.
+
+
+Copyright
+---------
+
+See the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |c|
+  options = ["--color"]
+  options += ["--format", "documentation"]
+  options += ["--format", "nested", "--out output/rspec-report.txt"]
+  options += ["--format", "html", "--out output/rspec-report.html"]
+  c.rspec_opts = options
+end
+
+namespace :spec do
+  desc "Get code coverage for spec execution"
+  RSpec::Core::RakeTask.new('cov') do |c|
+    ENV['COVERAGE'] = "on"
+  end
+end
+
+task :default => :spec

data/lib/symbiont/generators.rb

@@ -0,0 +1,19 @@
+module Symbiont
+  module Generators
+
+    # This method allows for a url_is() method in definitions that will
+    # define a direct means of accessing a resource. The most common
+    # example will be a URL for a web page, but any URI is valid. The
+    # URL provided can be navigated to using the generated view() method
+    # on a definition instance.
+    #
+    # @param [String] url the resource identifier to access
+    # @return [Nil]
+    def url_is(url)
+      define_method("view") do
+        @platform.visit(url)
+      end
+    end
+
+  end # module: Generators
+end # module: Symbiont

data/lib/symbiont/platform_selenium/platform_object.rb

@@ -0,0 +1,21 @@
+module Symbiont
+  module Platforms
+    module SeleniumWebDriver
+
+      class PlatformObject
+
+        def initialize(browser)
+          @browser = browser
+        end
+
+        # Platform method to make a call to a specified URL.
+        # See Symbiont::Generators#url_is
+        def visit(url)
+          @browser.navigate.to(url)
+        end
+
+      end # class: PlatformObject
+
+    end # module: SeleniumWebDriver
+  end # module: Platforms
+end # module: Symbiont

data/lib/symbiont/platform_selenium.rb

@@ -0,0 +1,9 @@
+module Symbiont
+  module Platforms
+    module SeleniumWebDriver
+
+      require_relative('platform_selenium/platform_object')
+
+    end # module: SeleniumWebDriver
+  end # module: Platforms
+end # module: Symbiont

data/lib/symbiont/platform_watir/platform_object.rb

@@ -0,0 +1,21 @@
+module Symbiont
+  module Platforms
+    module WatirWebDriver
+
+      class PlatformObject
+
+        def initialize(browser)
+          @browser = browser
+        end
+
+        # Platform method to make a call to a specified URL.
+        # See Symbiont::Generators#url_is
+        def visit(url)
+          @browser.goto(url)
+        end
+
+      end # class: PlatformObject
+
+    end # module: WatirWebDriver
+  end # module: Platforms
+end # module: Symbiont

data/lib/symbiont/platform_watir.rb

@@ -0,0 +1,9 @@
+module Symbiont
+  module Platforms
+    module WatirWebDriver
+
+      require_relative 'platform_watir/platform_object'
+
+    end # module: WatirWebDriver
+  end # module: Platforms
+end # module: Symbiont

data/lib/symbiont/platforms.rb

@@ -0,0 +1,24 @@
+module Symbiont
+  module Platforms
+
+    require 'watir-webdriver'
+    require 'selenium-webdriver'
+
+    # This module determines what execution platform Symbiont will use.
+    # The decision is based on the browser that has been established for
+    # the execution profile
+    def get_platform_for(browser)
+      if browser.is_a?(Watir::Browser)
+        return @platform = Symbiont::Platforms::WatirWebDriver::PlatformObject.new(@browser)
+      elsif browser.is_a?(Selenium::WebDriver::Driver)
+        return @platform = Symbiont::Platforms::SeleniumWebDriver::PlatformObject.new(@browser)
+      else
+        raise "Unable to create a platform object for #{browser}"
+      end
+    end
+
+  end # module: Platforms
+end # module: Symbiont
+
+require_relative 'platform_watir'
+require_relative 'platform_selenium'

data/lib/symbiont/version.rb

@@ -0,0 +1,3 @@
+module Symbiont
+  VERSION = "0.0.1"
+end

data/lib/symbiont.rb

@@ -0,0 +1,52 @@
+require 'symbiont/version'
+require 'symbiont/platforms'
+require 'symbiont/generators'
+
+module Symbiont
+  include Platforms
+
+  # Used to make a platform object accessible. Will hold object
+  # references like these:
+  # <Symbiont::Platforms::WatirWebDriver::PlatformObject:0x2cbe8a0>
+  # <Symbiont::Platforms::SeleniumWebDriver::PlatformObject:0x2cb9608>
+  attr_reader :platform
+
+  def self.version
+    "Symbiont v#{Symbiont::VERSION}"
+  end
+
+  # The included callback is used to provide the core functionality of the
+  # library to any class or module that includes the Symbiont 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 Symbiont.
+  def self.included(caller)
+    puts("#{caller.class} #{caller} attached the Symbiont")
+    caller.extend Symbiont::Generators
+  end
+
+  # The initialize method will be invoked when a page definition includes
+  # Symbiont. Some key things are happening here that are critical to
+  # Symbiont working correctly:
+  #   (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)
+    puts("Symbiont attached to browser: #{browser}")
+    @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,32 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'watir-webdriver'
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+  coverage_dir "output/coverage"
+end if ENV['COVERAGE']
+
+require 'symbiont'
+
+class DefinitionTest
+  include Symbiont
+
+  url_is "http://localhost:4567"
+end
+
+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/symbiont/generators_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Symbiont::Generators do
+  let(:watir_browser) { mock_browser_for_watir }
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:watir_definition) { DefinitionTest.new(watir_browser) }
+  let(:selenium_definition) { DefinitionTest.new(selenium_browser) }
+
+  context "a definition using watir-webdriver" do
+    describe "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
+    describe "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/symbiont/platform_object_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Symbiont do
+
+  let(:watir_browser) { mock_browser_for_watir }
+  let(:selenium_browser) { mock_browser_for_selenium }
+  let(:watir_definition) { DefinitionTest.new(watir_browser) }
+  let(:selenium_definition) { DefinitionTest.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 Symbiont::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 Symbiont::Platforms::SeleniumWebDriver::PlatformObject
+    end
+  end
+
+  context "an unrecognized browser" do
+    it "should raise an exception" do
+      expect { DefinitionTest.new(:unknown_browser) }.to raise_error
+    end
+  end
+
+end

data/spec/symbiont/symbiont_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Symbiont do
+  it "returns version information" do
+    Symbiont.version.should == "Symbiont v#{Symbiont::VERSION}"
+  end
+end

data/symbiont.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "symbiont/version"
+
+Gem::Specification.new do |s|
+  s.name        = "symbiont"
+  s.version     = Symbiont::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "MIT"
+  s.authors     = ["Jeff Nyman"]
+  s.email       = ["jeffnyman@gmail.com"]
+  s.homepage    = "https://github.com/jnyman/symbiont"
+  s.summary     = %q{An endosymbiotic facultative library for web application testing.}
+  s.description = %q{An endosymbiotic facultative library for web application testing.}
+
+  s.required_ruby_version = '>= 1.9.2'
+  s.rubyforge_project = "symbiont"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,specs,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', '>= 2.8.0'
+  s.add_development_dependency 'simplecov', '>= 0.6.1'
+
+  s.add_runtime_dependency 'watir-webdriver', '0.5.3'
+  s.add_runtime_dependency 'selenium-webdriver', '2.20.0'
+end

data/test/base.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'watir-webdriver'
+require 'symbiont'
+
+class Login
+  include Symbiont
+end
+
+@browser_watir = Watir::Browser.new(:firefox)
+watir_test = Login.new(@browser_watir)
+
+@browser_selenium = Selenium::WebDriver.for(:firefox)
+selenium_test = Login.new(@browser_selenium)
+
+@browser_watir.close
+@browser_selenium.close

data/test/symbiont_selenium.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'symbiont'
+
+class Login
+  include Symbiont
+
+  url_is "http://localhost:4567"
+end
+
+@browser_selenium = Selenium::WebDriver.for(:firefox)
+selenium_test = Login.new(@browser_selenium)
+selenium_test.view
+
+@browser_selenium.close

data/test/symbiont_watir.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'symbiont'
+
+class Login
+  include Symbiont
+
+  url_is "http://localhost:4567"
+end
+
+@browser_watir = Watir::Browser.new(:firefox)
+watir_test = Login.new(@browser_watir)
+watir_test.view
+
+@browser_watir.close

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: symbiont
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Nyman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &21048780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *21048780
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &21048504 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *21048504
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: &21048228 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *21048228
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: &28582476 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *28582476
+description: An endosymbiotic facultative library for web application testing.
+email:
+- jeffnyman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/symbiont.rb
+- lib/symbiont/generators.rb
+- lib/symbiont/platform_selenium.rb
+- lib/symbiont/platform_selenium/platform_object.rb
+- lib/symbiont/platform_watir.rb
+- lib/symbiont/platform_watir/platform_object.rb
+- lib/symbiont/platforms.rb
+- lib/symbiont/version.rb
+- spec/spec_helper.rb
+- spec/symbiont/generators_spec.rb
+- spec/symbiont/platform_object_spec.rb
+- spec/symbiont/symbiont_spec.rb
+- symbiont.gemspec
+- test/base.rb
+- test/symbiont_selenium.rb
+- test/symbiont_watir.rb
+homepage: https://github.com/jnyman/symbiont
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: symbiont
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: An endosymbiotic facultative library for web application testing.
+test_files: []
+has_rdoc: