symbiont 0.2.1 → 0.3.0

data/spec/symbiont/factory_spec.rb

@@ -1,174 +1,114 @@
 require 'spec_helper'
-require 'symbiont/factory'
-
-module AppModule
-  class TestDefinitionInModule
-    include Symbiont
-    url_is "http://localhost:9292"
-  end
-end
-
-class TestFactory
-  include Symbiont::Factory
-
-  attr_accessor :browser
-  attr_accessor :active
-end
-
-class TestFactoryPage
-  include Symbiont
-
-  url_is "http://localhost:9292"
-end
-
-class TestFactoryWithURL
-  include Symbiont
-
-  url_is "http://localhost:9292"
-end
-
-class TestFactorySecond
-  include Symbiont
-end
-
-class TestFactoryThird
-  include Symbiont
-end
 
 describe Symbiont::Factory do
   before(:each) do
     @factory = TestFactory.new
-    @factory.browser = mock_browser_for_watir
+    @factory.driver = mock_browser_for_watir
   end
 
-  it "should create a new definition object, using on" do
-    @factory.browser.should_not_receive(:goto)
-    @factory.on DefinitionTest do |page|
-      page.should be_instance_of DefinitionTest
-    end
-
-    @factory.on "DefinitionTest" do |page|
-      page.should be_instance_of DefinitionTest
-    end
-
-    @factory.on "AppModule::TestDefinitionInModule" do |page|
-      page.should be_instance_of AppModule::TestDefinitionInModule
-    end
+  it 'will create a new definition and view it, using on_view' do
+    @factory.driver.should_receive(:goto)
+    @factory.on_view(ValidPage)
   end
 
-  it "should create a new definition object, using during" do
-    @factory.browser.should_not_receive(:goto)
-    @factory.during DefinitionTest do |page|
-      page.should be_instance_of DefinitionTest
-    end
-
-    @factory.during "DefinitionTest" do |page|
-      page.should be_instance_of DefinitionTest
+  it 'will create a new definition and view it, using on_view and a block' do
+    @factory.driver.should_receive(:goto)
+    @factory.on_view ValidPage do |page|
+      page.should be_instance_of ValidPage
     end
+  end
 
-    @factory.during "AppModule::TestDefinitionInModule" do |page|
-      page.should be_instance_of AppModule::TestDefinitionInModule
+  it 'will create a new definition, using on and a block with a parameter' do
+    @factory.driver.should_not_receive(:goto)
+    @factory.on ValidPage do |page|
+      page.should be_instance_of ValidPage
     end
   end
 
-  it "should create a new definition object and view it, using on_view" do
-    @factory.browser.should_receive(:goto).exactly(5).times
-    @factory.on_view DefinitionTest do |page|
-      page.should be_instance_of DefinitionTest
+  it 'will create a new definition, using on and a block without a parameter' do
+    @factory.driver.should_not_receive(:goto)
+    @factory.on ValidPage do
+      @factory.active.should be_instance_of ValidPage
     end
+  end
 
-    @factory.on_view "DefinitionTest" do |page|
-      page.should be_instance_of DefinitionTest
-    end
+  it 'will use an existing object reference with on' do
+    @factory.driver.should_receive(:goto)
+    obj1 = @factory.on_view ValidPage
+    obj2 = @factory.on ValidPage
+    obj1.should == obj2
+  end
 
-    @factory.on_view "AppModule::TestDefinitionInModule" do |page|
-      page.should be_instance_of AppModule::TestDefinitionInModule
-    end
+  it 'will not use an existing object reference with on_new' do
+    @factory.driver.should_receive(:goto)
+    obj1 = @factory.on_view ValidPage
+    obj2 = @factory.on_new ValidPage
+    obj1.should_not == obj2
   end
 
-  it "should create a new definition object and view it, using start_activity" do
-    @factory.browser.should_receive(:goto).exactly(5).times
-    @factory.start_activity DefinitionTest do |page|
-      page.should be_instance_of DefinitionTest
+  it 'will create a new definition, using on_set' do
+    @factory.driver.should_not_receive(:goto)
+    @factory.on_set ValidPage do |page|
+      page.should be_instance_of ValidPage
     end
+  end
 
-    @factory.start_activity "DefinitionTest" do |page|
-      page.should be_instance_of DefinitionTest
-    end
+  it 'will set a reference to be used outside the factory' do
+    active = @factory.on ValidPage
+    current = @factory.instance_variable_get '@active'
+    current.should === active
+  end
 
-    @factory.start_activity "AppModule::TestDefinitionInModule" do |page|
-      page.should be_instance_of AppModule::TestDefinitionInModule
-    end
+  it 'will use an existing object reference with on_set' do
+    @factory.driver.should_receive(:goto)
+    obj1 = @factory.on_view ValidPage
+    obj2 = @factory.on_set ValidPage
+    obj1.should == obj2
   end
 
-  it "should create a new definition object and view it, using start_on" do
-    @factory.browser.should_receive(:goto).exactly(5).times
-    @factory.start_on DefinitionTest do |page|
-      page.should be_instance_of DefinitionTest
+  it 'will use an existing context using on after using on_set' do
+    @factory.on_set ValidPage do |page|
+      @obj1 = page  # obj1 is CONTEXT, ACTIVE
     end
 
-    @factory.start_on "DefinitionTest" do |page|
-      page.should be_instance_of DefinitionTest
+    @factory.on ValidPageNewContext do |page|
+      @obj2 = page  # obj2 is ACTIVE
     end
 
-    @factory.start_on "AppModule::TestDefinitionInModule" do |page|
-      page.should be_instance_of AppModule::TestDefinitionInModule
+    @factory.on ValidPage do |page|
+      @obj3 = page  # obj1 CONTEXT is still set
     end
-  end
 
-  it "should set a reference to be used outside the factory" do
-    active = @factory.on DefinitionTest
-    current = @factory.instance_variable_get "@active"
-    current.should === active
+    @obj1.should_not == @obj2
+    @obj1.should == @obj3
   end
 
-  it "should use an existing definition when that definition is already active" do
-    @factory.instance_variable_set "@active", TestFactorySecond.new(@factory.browser)
-
-    used = false
-    @factory.if_on(TestFactorySecond) do |page|
-      page.should be_instance_of TestFactorySecond
-      used = true
+  it 'will use an existing context using on_new of a different class after using on_set' do
+    @factory.on_set ValidPage do |page|
+      @obj1 = page  # obj1 is CONTEXT, ACTIVE
     end
-    used.should be true
 
-    used = false
-    @factory.if_on("TestFactorySecond") do |page|
-      page.should be_instance_of TestFactorySecond
-      used = true
+    @factory.on_new ValidPageNewContext do |page|
+      @obj2 = page  # ACTIVE nil, obj1 no longer ACTIVE, but is CONTEXT
     end
-    used.should be true
 
-    used = false
-    @factory.instance_variable_set "@active", AppModule::TestDefinitionInModule.new(@factory.browser)
-    @factory.if_on("AppModule::TestDefinitionInModule") do |page|
-      page.should be_instance_of AppModule::TestDefinitionInModule
-      used = true
+    @factory.on ValidPage do |page|
+      @obj3 = page  # CONTEXT is set to obj1
     end
-    used.should be true
-  end
 
-  it "should not execute block if definition is not the active definition" do
-    @factory.instance_variable_set "@active", TestFactorySecond.new(@factory.browser)
-    @factory.if_on(TestFactoryThird) do |page|
-      fail
-    end
+    @obj1.should_not == @obj2
+    @obj1.should == @obj3
+  end
 
-    @factory.if_on("TestFactoryThird") do |page|
-      fail
+  it 'will clear existing context using on_new after using on_set' do
+    @factory.on_set ValidPage do |page|
+      @obj1 = page   # obj1 is CONTEXT, ACTIVE
     end
 
-    @factory.if_on("AppModule::TestDefinitionInModule") do |page|
-      fail
+    @factory.on_new ValidPage do |page|
+      @obj2 = page   # ACTIVE nil; since page is same, CONTEXT is nil
     end
-  end
 
-  it "should return the @active instance if asking for another page" do
-    expected = TestFactoryWithURL.new(@factory.browser)
-    @factory.instance_variable_set "@active", expected
-    @factory.if_on(TestFactoryPage).should == expected
-    @factory.if_on("TestFactoryPage").should == expected
-    @factory.if_on("AppModule::TestDefinitionInModule").should == expected
+    @obj1.should_not == @obj2
   end
-
-end
+end

data/spec/symbiont/page_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Symbiont::Page do
+  include_context :page
+
+  context 'a page definition being used - url' do
+    it 'will establish no default url' do
+      expect(empty_definition.url).to be_nil
+    end
+
+    it 'will establish a page url with the url_is assertion' do
+      expect(watir_definition).to respond_to :url
+      expect(watir_definition.url).to eq('http://localhost:9292')
+    end
+
+    it 'will not view a page if the url_is assertion has not been set' do
+      expect { empty_definition.view }.to raise_error Symbiont::Errors::NoUrlForDefinition
+    end
+  end
+
+  context 'a page definition being used - url match' do
+    it 'will establish no default url matcher' do
+      expect(empty_definition.url_match).to be_nil
+    end
+
+    it 'will establish a url matcher with the url_matches assertion' do
+      expect(watir_definition).to respond_to :url_match
+      expect(watir_definition.url_match).to eq(/:\d{4}/)
+    end
+
+    it 'will not verify a url if the url_matches assertion has not been set' do
+      expect { empty_definition.has_correct_url? }.to raise_error Symbiont::Errors::NoUrlMatchForDefinition
+    end
+  end
+
+  context 'a page definition being used - title' do
+    it 'will establish no default title' do
+      expect(empty_definition.page_title).to be_nil
+    end
+
+    it 'will establish a page title with the title_is assertion' do
+      expect(watir_definition).to respond_to :page_title
+      expect(watir_definition.page_title).to eq('Dialogic')
+    end
+
+    it 'will not verify a title if the title_is assertion has not been set' do
+      expect { empty_definition.has_correct_title? }.to raise_error Symbiont::Errors::NoTitleForDefinition
+    end
+  end
+end

data/symbiont.gemspec

@@ -1,27 +1,52 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/symbiont/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name        = "symbiont"
-  gem.version     = Symbiont::VERSION
-  gem.platform    = Gem::Platform::RUBY
-  gem.license     = "MIT"
-  gem.authors     = ["Jeff Nyman"]
-  gem.email       = ["jeffnyman@gmail.com"]
-  gem.homepage    = "https://github.com/jnyman/symbiont"
-  gem.summary     = gem.description
-  gem.description = "An endosymbiotic facultative library for web application testing."
-
-  gem.add_runtime_dependency "watir-webdriver", ">= 0.6.2"
-  gem.add_runtime_dependency "selenium-webdriver", ">= 2.31.0"
-
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "simplecov"
-
-  gem.required_ruby_version = '>= 1.9.2'
-
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,specs,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.require_paths = ["lib"]
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'symbiont/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'symbiont'
+  spec.version       = Symbiont::VERSION
+  spec.authors       = ['Jeff Nyman']
+  spec.email         = ['jeffnyman@gmail.com']
+  spec.summary       = %q{An Endosymbiotic Facultative Semantically Clean Fluent Interface Test Framework}
+  spec.description   = %q{
+    Symbiont is a framework that allows you to describe your application in
+    terms of activity and page definitions. Those definitions can then be
+    referenced by test libraries using the DSL that Symbiont provides. The
+    DSL allows web elements to be proxied to a driver library.
+
+    The DSL provides a fluent interface that can be used for constructing
+    test execution logic. This fluent interface promotes the idea of
+    compressibility of your test logic, allowing for more factoring, more
+    reuse, and less repetition.
+
+    You can use Symbiont directly as an automated test library or you can
+    use it with other tools such as RSpec, Cucumber, or my own Lucid tool.
+  }
+  spec.homepage      = 'https://github.com/jnyman/symbiont'
+  spec.license       = 'MIT'
+  spec.requirements  << 'Watir-WebDriver, Colorize'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|specs|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_rubygems_version = '>= 1.8.29'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.14'
+
+  spec.add_runtime_dependency 'colorize', '>= 0.7.2'
+  spec.add_runtime_dependency 'watir-webdriver', '>= 0.6.9'
+
+  spec.post_install_message = %{
+    (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+
+      Symbiont #{Symbiont::VERSION} has been installed.
+
+    (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  }
+end

data/test/symbiont-script.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+$: << './lib'
+
+require 'rspec'
+include RSpec::Matchers
+
+require 'watir-webdriver'
+
+require 'symbiont'
+include Symbiont::Factory
+
+#========================================
+
+class Dialogic
+  attach Symbiont
+
+  url_is 'http://localhost:9292'
+end
+
+class Weight
+  attach Symbiont
+
+  url_is 'http://localhost:9292/weight'
+
+  text_field :weight,    id: 'wt', index: 0
+  button     :calculate, id: 'calculate'
+
+  def convert(value)
+    weight.set value
+  end
+end
+
+class Practice
+  attach Symbiont
+
+  url_is 'http://localhost:9292/practice'
+  url_matches /:\d{4}/
+  title_is 'Dialogic - Practice Page'
+
+  link :view_in_frame, id: 'framed_page'
+
+  iframe :boxframe, class: 'fancybox-iframe'
+
+  text_field :weight, -> { boxframe.text_field(id: 'wt') }
+
+  article :practice, id: 'practice'
+
+  a :page_link do |text|
+    practice.a(text: text)
+  end
+end
+
+@driver = Watir::Browser.new
+
+def non_framed
+  @page = Weight.new(@driver)
+  @page.view
+  @page.weight.set '200'
+  @page.calculate.click
+end
+
+def framed
+  @page = Practice.new(@driver)
+  @page.view
+  #@page.view_in_frame.click
+  @page.page_link('View Weight Calculator in Frame').click
+  @page.weight.set '200'
+end
+
+def basic
+  @page = Practice.new(@driver)  
+  @page.should be_a_kind_of(Symbiont)
+  @page.should be_an_instance_of(Practice)
+
+  @page.view
+  @page.has_correct_url?
+  @page.has_correct_title?
+
+  @page.should have_correct_url
+  @page.should have_correct_title
+end
+
+#basic
+
+on_view(Weight)
+on(Weight).convert('200')
+on(Weight).calculate.click
+
+on(Weight) do
+  @active.convert('200')
+  @active.calculate.click
+end
+
+on(Weight) do |page|
+  page.convert('200')
+  page.calculate.click
+end