symbiont 0.2.1 → 0.3.0

data/lib/symbiont/pages.rb

@@ -0,0 +1,32 @@
+module Symbiont
+  module Page
+    include Helpers
+
+    def view
+      no_url_is_provided if url.nil?
+      driver.goto(url)
+    end
+
+    def has_correct_url?
+      no_url_matches_is_provided if url_match.nil?
+      !(driver.url =~ url_match).nil?
+    end
+
+    def has_correct_title?
+      no_title_is_provided if page_title.nil?
+      !(driver.title.match(page_title)).nil?
+    end
+
+    def url
+      self.class.url
+    end
+
+    def url_match
+      self.class.url_match
+    end
+
+    def page_title
+      self.class.page_title
+    end
+  end
+end

data/lib/symbiont/platform.rb

@@ -0,0 +1,12 @@
+module Symbiont
+  module Platform
+    # @return [Object] browser driver reference
+    attr_reader :driver
+
+    # @param driver [Object] a tool driver instance
+    def initialize(driver)
+      Symbiont.trace("Dialect attached to driver:\n\t#{driver.inspect}")
+      @driver = driver
+    end
+  end
+end

data/lib/symbiont/version.rb

@@ -1,3 +1,3 @@
-module Symbiont
-  VERSION = "0.2.1"
-end
+module Symbiont
+  VERSION = '0.3.0'
+end

data/lib/symbiont.rb

@@ -1,92 +1,34 @@
-require 'symbiont/version'
-require 'symbiont/logger'
-require 'symbiont/platforms'
-require 'symbiont/generators'
-require 'symbiont/factory'
-require 'symbiont/enclosers'
-require 'symbiont/evaluators'
-require 'symbiont/locators'
-require 'symbiont/data_setter'
-
-module Symbiont
-  include Platforms
-  include Enclosers
-  include Evaluators
-  include Locators
-  include DataSetter
-
-  # Used to make a platform object accessible. Will hold object
-  # references like these:
-  # <Symbiont::Platforms::WatirWebDriver::PlatformObject:0x2cbe8a0>
-  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)
-    Symbiont::trace("#{caller.class} #{caller} attached the Symbiont")
-    caller.extend Symbiont::Generators
-    caller.extend Symbiont::Enclosers
-  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
-
-  # 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
-  # @param [boolean] visit if true, a definition will be navigated to
-  def initialize(browser, visit=nil)
-    Symbiont::trace("Symbiont attached to browser: #{browser}")
-    @browser = browser
-    establish_platform_object_for(browser)
-    view if visit && respond_to?(:view)
-    start if visit && respond_to?(:start)
-  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
-
-  # This method processes a block with single or multiple parameters.
-  #
-  # @param [Proc] block the block to process
-  def process_block(&block)
-    block.arity == 1 ? block.call(self) : self.instance_eval(&block)
-  end
-
-end
+require 'watir-webdriver'
+
+require 'symbiont/version'
+require 'symbiont/logging'
+require 'symbiont/errors'
+require 'symbiont/helpers'
+
+require 'colorize'
+
+require 'symbiont/platform'
+require 'symbiont/assertions'
+require 'symbiont/pages'
+require 'symbiont/elements'
+require 'symbiont/accessor'
+require 'symbiont/factory'
+
+module Symbiont
+  include Platform
+  
+  # @param caller [Class] the class including the framework
+  def self.included(caller)
+    caller.extend Symbiont::Assertion
+    caller.extend Symbiont::Element
+    
+    caller.send :include, Symbiont::Page
+    caller.send :include, Symbiont::Accessor
+
+    Symbiont.trace("#{caller.class} #{caller} has attached the Symbiont.")
+  end
+end
+
+def attach(mod=Symbiont)
+  include mod
+end

data/spec/fixtures/element_definitions.rb

@@ -0,0 +1,32 @@
+shared_examples_for 'element generator for' do |elements|
+  elements.each do |element|
+
+    context "#{element} on the watir-webdriver platform" do
+      it "will locate a specific #{element} with a single locator" do
+        expect(watir_browser).to receive(element).with(id: element).and_return(watir_element)
+        expect(watir_definition.send "#{element}").to eq(watir_element)
+      end
+
+      it "will locate a specific #{element} with a proc" do
+        expect(watir_browser).to receive(element).with(id: element).and_return(watir_element)
+        expect(watir_definition.send "#{element}_proc").to eq(watir_element)
+      end
+
+      it "will locate a specific #{element} with a lambda" do
+        expect(watir_browser).to receive(element).with(id: element).and_return(watir_element)
+        expect(watir_definition.send "#{element}_lambda").to eq(watir_element)
+      end
+
+      it "will locate a specific #{element} with a block" do
+        expect(watir_browser).to receive(element).with(id: element).and_return(watir_element)
+        expect(watir_definition.send "#{element}_block", element).to eq(watir_element)
+      end
+
+      it "will locate a specific #{element} with a block and argument" do
+        expect(watir_browser).to receive(element).with(id: element).and_return(watir_element)
+        expect(watir_definition.send "#{element}_block_arg", element).to eq(watir_element)
+      end
+    end
+
+  end
+end

data/spec/fixtures/mock_drivers.rb

@@ -0,0 +1,8 @@
+require 'watir-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

data/spec/fixtures/page_definitions.rb

@@ -0,0 +1,36 @@
+class PageWithMissingAssertions
+  attach Symbiont
+end
+
+class TestFactory
+  include Symbiont::Factory
+  attr_accessor :driver
+  attr_accessor :active
+end
+
+class ValidPageNewContext
+  attach Symbiont
+end
+
+class ValidPage
+  attach Symbiont
+  
+  url_is 'http://localhost:9292'
+  url_matches /:\d{4}/
+  title_is 'Dialogic'
+
+  %w(text_field button).each do |element|
+    send element, :"#{element}", id: element
+
+    send element, :"#{element}_proc", proc { driver.send(element, id: element) }
+    send element, :"#{element}_lambda", -> { driver.send(element, id: element) }
+
+    send element, :"#{element}_block" do
+      driver.send(element, id: element)
+    end
+
+    send element, :"#{element}_block_arg" do |id|
+      driver.send(element, id: id)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,98 +1,49 @@
-$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+require 'simplecov'
+require 'coveralls'
 
-require 'watir-webdriver'
+Coveralls.wear!
 
-require 'simplecov'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+]
 
 SimpleCov.start do
-  add_filter "/spec/"
-  coverage_dir "output/coverage"
-end if ENV['COVERAGE']
+  add_filter '/spec'
+  coverage_dir "#{SimpleCov.root}/spec/reports/coverage"
+  minimum_coverage 90
+  maximum_coverage_drop 5
+end
 
 require 'symbiont'
 
-class DefinitionTest
-  include Symbiont
-
-  url_is "http://localhost:9292"
-  begin_at "http://localhost:9292"
-  title_is "Symbiote"
-
-  look_for :name
-
-  text_field :name, id: "name"
-  text_field :email do |element|
-    "email"
+RSpec.configure do |config|
+  original_stderr = $stderr
+  original_stdout = $stdout
+  config.before(:all) do
+    $stderr = File.new(File.join(File.dirname(__FILE__), 'reports/symbiont-output.txt'), 'w')
+    $stdout = File.new(File.join(File.dirname(__FILE__), 'reports/symbiont-output.txt'), 'w')
   end
-
-  text_area :summary, id: "summary"
-  text_area :description do |element|
-    "description"
+  config.after(:all) do
+    $stderr = original_stderr
+    $stdout = original_stdout
   end
 
-  hidden_field :ssn, id: "ssn"
-  hidden_field :visa do |element|
-    "visa"
-  end
-
-  paragraph :first, id: "first"
-  p :last, id: "last"
-  paragraph :middle do |element|
-    "middle"
-  end
+  config.alias_it_should_behave_like_to :provides_an, 'when providing an'
 
-  link :welcome, id: "welcome"
-  link :greetings do |element|
-    "greetings"
-  end
-
-  button :login, id: "login"
-  button :logout do |element|
-    "logout"
-  end
-
-  checkbox :apply_tax, id: "apply_tax"
-  checkbox :apply_fee do |element|
-    "apply_fee"
-  end
-
-  select_list :concepts, id: "concepts"
-  select_list :topics do |element|
-    "topics"
-  end
-
-  radio :include_tax, id: "include_tax"
-  radio :include_fee do |element|
-    "include_fee"
-  end
-
-  div :section, id: "section"
-  div :aside do |element|
-    "aside"
-  end
-
-  span :inline, id: "inline"
-  span :part do |element|
-    "part"
-  end
-
-  table :accounts, id: "accounts"
-  table :invoices do |element|
-    "invoices"
-  end
+  shared_context :page do
+    let(:watir_browser)        { mock_browser_for_watir }
+    let(:watir_definition)     { ValidPage.new(watir_browser) }
 
-  cell :total, id: "total"
-  cell :sum do |element|
-    "sum"
+    let(:empty_definition)     { PageWithMissingAssertions.new(watir_browser) }
+    let(:no_driver_definition) { ValidPage.new(:unknown) }
   end
 
-  frame(id: "frame") do |frame|
-    text_field :framedLoginName, id: "framedLoginName", frame: frame
+  shared_context :element do
+    let(:watir_element) { double('element') }
   end
 end
 
-def mock_browser_for_watir
-  watir_browser = double('watir')
-  watir_browser.stub(:is_a?).with(Watir::Browser).and_return(true)
-  watir_browser
+Dir['spec/fixtures/**/*.rb'].each do |file|
+  require file.sub(/spec\//, '')
 end

data/spec/symbiont/assertion_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Symbiont::Assertion do
+  context 'a definition with valid assertions' do
+    it 'will allow a url to be asserted' do
+      expect {
+        class PageWithUrl
+          attach Symbiont
+          url_is 'http://localhost:9292'
+        end
+      }.not_to raise_error
+    end
+
+    it 'will allow a url match pattern to be asserted' do
+      expect {
+        class PageWithUrlMatches
+          attach Symbiont
+          url_matches /localhost/
+        end
+      }.not_to raise_error
+    end
+
+    it 'will allow a title to be asserted' do
+      expect {
+        class PageWithTitle
+          attach Symbiont
+          title_is 'Dialogic'
+        end
+      }.not_to raise_error
+    end
+  end
+
+  context 'a definition with missing assertion values' do
+    it 'will indicate a missing url_is assertion value' do
+      expect {
+        class PageWithMissingUrl
+          attach Symbiont
+          url_is
+        end
+      }.to raise_error Symbiont::Errors::NoUrlForDefinition
+    end
+
+    it 'will indicate an empty url_is assertion value' do
+      expect {
+        class PageWithEmptyUrl
+          attach Symbiont
+          url_is ''
+        end
+      }.to raise_error Symbiont::Errors::NoUrlForDefinition
+    end
+
+    it 'will indicate a missing url_matches assertion value' do
+      expect {
+        class PageWithMissingUrlMatch
+          attach Symbiont
+          url_matches
+        end
+      }.to raise_error Symbiont::Errors::NoUrlMatchForDefinition
+    end
+
+    it 'will indicate an empty url_matches assertion value' do
+      expect {
+        class PageWithEmptyUrlMatch
+          attach Symbiont
+          url_matches ''
+        end
+      }.to raise_error Symbiont::Errors::NoUrlMatchForDefinition
+    end
+
+    it 'will indicate a missing title_is assertion value' do
+      expect {
+        class PageWithMissingTitle
+          attach Symbiont
+          title_is
+        end
+      }.to raise_error Symbiont::Errors::NoTitleForDefinition
+    end
+
+    it 'will indicate an empty title_is assertion value' do
+      expect {
+        class PageWithEmptyTitle
+          attach Symbiont
+          title_is ''
+        end
+      }.to raise_error Symbiont::Errors::NoTitleForDefinition
+    end
+  end
+end

data/spec/symbiont/driver_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'Page Definitions' do
+  include_context :page
+
+  context 'a definition using watir-webdriver' do
+    context 'with a url_is assertion' do
+      it 'will call the driver navigation method when viewed' do
+        watir_browser.should_receive(:goto).twice
+        expect { watir_definition.view }.not_to raise_error
+        watir_definition.view
+      end
+    end
+
+    context 'with a url_matches assertion' do
+      it 'will verify a url if the url_matches assertion has been set' do
+        watir_browser.should_receive(:url).twice.and_return('http://localhost:9292')
+        expect { watir_definition.has_correct_url? }.not_to raise_error
+        watir_definition.has_correct_url?.should be_true
+      end
+
+      it 'will not verify a url if the url does not match the url_matches assertion' do
+        watir_browser.should_receive(:url).and_return('http://127.0.0.1')
+        watir_definition.has_correct_url?.should be_false
+      end
+    end
+
+    context 'with a title_is assertion' do
+      it 'will verify a title if the title_is assertion has been set' do
+        watir_browser.should_receive(:title).twice.and_return 'Dialogic'
+        expect { watir_definition.has_correct_title? }.not_to raise_error
+        watir_definition.has_correct_title?.should be_true
+      end
+
+      it 'will not verify a title if the title does not match the title_is assertion' do
+        watir_browser.should_receive(:title).and_return('Page Title')
+        watir_definition.has_correct_title?.should be_false
+      end
+    end
+  end
+end

data/spec/symbiont/element_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Symbiont::Element do
+  include_context :page
+  include_context :element
+
+  provides_an 'element generator for', %w{text_field button}
+end