symbiont 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05110d9c5eeb8d6971262bff19bad09cc4ed6086
+  data.tar.gz: 589f9bbbf1eb5d49a919486bf7a31b89b952d4ab
+SHA512:
+  metadata.gz: 298a058116b50448144fd72a1101951ffbe85fd6b57a246de08be66aad13b309905a0f61552632a24a2f20b476c5dc40ca933fc88fd75d217fe7420a719c82d1
+  data.tar.gz: ef93ec40a82704bd0e00b3e8d85c566ba725f2e8ce39db1d1670903c9abf8387e6f4cacadd25cea103c556f82b4a7f2a6e4d6b2bb92b12c5e9fe05c656dca9a5

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: 'travis-ci'

data/.gitignore

@@ -1,22 +1,22 @@
-*.db
-*.gem
-*.rbc
-*.swo
-*.swp
-.idea
-.bundle
-.config
-.yardoc
-.DS_Store
-InstalledFiles
-_yardoc
-coverage
-output/
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -1,14 +1,25 @@
-script: "rake"
-
-rvm:
-  - 1.9.2
-  - 1.9.3
-  
-branches:
-  only:
-      - master
-      - develop
-      
-notifications:
-  recipients:
-      - jeffnyman@gmail.com
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+
+branches:
+  except:
+    - experimental
+
+branches:
+  only:
+    - master
+    - develop
+
+notifications:
+  recipients:
+    - jeffnyman@gmail.com
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby-19mode

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
+
+gem 'simplecov', '~> 0.8.0'
+gem 'coveralls', require: false
 
-# Specify your gem's dependencies in symbiont.gemspec
 gemspec

data/{LICENSE → LICENSE.txt}

@@ -1,22 +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.
+Copyright (c) 2014 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

@@ -1,65 +1,57 @@
-Symbiont [![Build Status](https://secure.travis-ci.org/jnyman/symbiont.png)](http://travis-ci.org/jnyman/symbiont) [![Dependency Status](https://gemnasium.com/jnyman/symbiont.png)](https://gemnasium.com/jnyman/symbiont)
-========
-
-Description
------------
-
-The Symbiont gem is designed to provide an open framework for running automated tests against a browser using popular web testing interfaces.
-
-Right now the best information on the purpose of this project and how it works can be found on [my Symbiont-tagged blog posts](http://testerstories.com/?cat=16).
-
-
-Installation
-------------
-
-Add this line to your application's Gemfile:
-
-    gem 'symbiont'
-    
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install symbiont
-
-
-Using Symbiont
---------------
-
-Check out the [Symbiont Wiki](https://github.com/jnyman/symbiont/wiki) for details on how to use Symbiont.
-
-
-Why call it Symbiont?
----------------------
-
-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.
-
-
-Contributing
-------------
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-
-Credits
--------
-
-Thanks to Jeff Morgan (http://www.cheezyworld.com/) for his page-object gem, Alister Scott (http://watirmelon.com) for his watir-page-helper gem, and Nat Ritmeyer (http://www.natontesting.com/) for his SitePrism gem. I learned a lot from analyzing their code and working to craft my own solution around theirs. Rather than fork their projects, my changes were systemic enough to warrant creating a new project.
-
-
-Copyright
----------
-
-See the LICENSE file for details.
-
-In short, Lucid is under an MIT license. Since I'm borrowing from many other people, just as they borrowed from many other people before them, I'm just establishing I wrote _this_ particular version. (If nothing else, this means you know who to blame.)
+# Symbiont
+
+[![Gem Version](https://badge.fury.io/rb/symbiont.svg)](http://badge.fury.io/rb/symbiont)
+[![Build Status](https://secure.travis-ci.org/jnyman/symbiont.png)](http://travis-ci.org/jnyman/symbiont)
+[![Coverage Status](https://coveralls.io/repos/jnyman/symbiont/badge.png?branch=master)](https://coveralls.io/r/jnyman/symbiont?branch=master)
+[![Code Climate](https://codeclimate.com/github/jnyman/symbiont.png)](https://codeclimate.com/github/jnyman/symbiont)
+[![Dependency Status](https://gemnasium.com/jnyman/symbiont.png)](https://gemnasium.com/jnyman/symbiont)
+
+Symbiont provides a semantic domain-specific language that can be used to construct a fluent interface for test execution libraries. The initial focus will be on using the [watir-webdriver](https://github.com/watir/watir-webdriver) API as the underlying driver library.
+
+[![Gitter chat](https://badges.gitter.im/jnyman/symbiont.png)](https://gitter.im/jnyman/symbiont)
+[![endorse](https://api.coderwall.com/jnyman/endorsecount.png)](https://coderwall.com/jnyman)
+
+
+## Installation
+
+You can use Symbiont as part of another project, in which case you can add the following to your Gemfile:
+
+    gem 'symbiont'
+
+And then execute:
+
+    $ bundle
+
+You can also install Symbiont just as you would any other gem:
+
+    $ gem install symbiont
+
+## Usage
+
+Instructions on how to use Symbiont will be available as the interface is defined. You can check out the [Symbiont test script](https://github.com/jnyman/symbiont/blob/master/test/symbiont-script.rb) for an idea of how the library can be interacted with. Do note that the test script requires a local copy of [Dialogic](https://github.com/jnyman/dialogic) to be running. To execute the test script:
+
+    $ rake test:script
+
+## Why call it Symbiont?
+
+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 library as a facultative, endosymbiotic organism that lives within your test logic, giving it strength and sustenance.
+
+## Contributing
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create a feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Credits
+
+Thanks to Jeff Morgan ([http://www.cheezyworld.com/](http://www.cheezyworld.com/)) for his [page-object](https://github.com/cheezy/page-object) gem, Alister Scott ([http://watirmelon.com](http://watirmelon.com)) for his [watir-page-helper](https://github.com/alisterscott/watir-page-helper) gem, Alex Rodionov ([(http://p0deje.blogspot.com/](http://p0deje.blogspot.com/)) for his [watirsome](https://github.com/p0deje/watirsome) gem, and Nat Ritmeyer ([http://www.natritmeyer.com/](http://www.natritmeyer.com/)) for his [SitePrism](https://github.com/natritmeyer/site_prism/) gem.
+
+## Copyright
+
+Symbiont is distributed under the MIT license. See the [LICENSE](https://github.com/jnyman/symbiont/blob/master/LICENSE.txt) file for details.

data/Rakefile

@@ -1,34 +1,28 @@
-#!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'cucumber/rake/task'
-require 'yard'
-
-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
-
-desc "Generate API documentation"
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
-  t.options = ['--title', 'Symbiont']
-end
-
-namespace :spec do
-  desc "Get code coverage for spec execution"
-  RSpec::Core::RakeTask.new('cov') do |c|
-    ENV['COVERAGE'] = "on"
-  end
-end
-
-namespace :specs do
-  Cucumber::Rake::Task.new(:watir, "Run Cucumber with Watir") do |config|
-    config.profile = 'default'
-  end
-end
-
-task :default => :spec
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+namespace :test do
+  desc 'Run the Symbiont script.'
+  task :script do
+    system('ruby ./test/symbiont-script.rb')
+  end
+end
+
+namespace :spec do
+  desc 'Clean all generated reports'
+  task :clean do
+    system('rm -rf spec/reports')
+  end
+
+  RSpec::Core::RakeTask.new(:all => :clean) do |config|
+    options  = %w(--color)
+    options += %w(--format documentation)
+    options += %w(--format html --out spec/reports/symbiont-test-report.html)
+    options += %w(--format nested --out spec/reports/symbiont-test-report.txt)
+
+    config.rspec_opts = options
+  end
+end
+
+task default: %w(spec:all)

data/lib/symbiont/accessor.rb

@@ -0,0 +1,7 @@
+module Symbiont
+  module Accessor
+    def reference_element(element, locator)
+      driver.send(element, locator)
+    end
+  end
+end

data/lib/symbiont/assertions.rb

@@ -0,0 +1,33 @@
+module Symbiont
+  module Assertion
+    include Helpers
+
+    def url_is(url=nil)
+      url_is_empty if url.nil? or url.empty?
+      @url = url
+    end
+
+    def url_matches(pattern=nil)
+      url_match_is_empty if pattern.nil?
+      url_match_is_empty if pattern.is_a?(String) and pattern.empty?
+      @url_match = pattern
+    end
+
+    def title_is(title=nil)
+      title_is_empty if title.nil? or title.empty?
+      @title = title
+    end
+    
+    def url
+      @url
+    end
+
+    def url_match
+      @url_match
+    end
+
+    def page_title
+      @title
+    end
+  end
+end

data/lib/symbiont/elements.rb

@@ -0,0 +1,69 @@
+module Symbiont
+  # Calls the Watir module to get a list of the factory methods that
+  # Watir uses to reference and access web objects.
+  #
+  # @return [Array] factory method list
+  def self.elements
+    unless @elements
+      @elements = Watir::Container.instance_methods
+    end
+    @elements
+  end
+
+  module Element
+    # Iterates through Watir factory methods. Each method is defined
+    # as a method that can be called on a page class. This is what
+    # allows element definitions to be created.
+    Symbiont.elements.each do |element|
+      define_method element do |*signature, &block|
+        identifier, locator = parse_signature(signature)
+        context = context_from_signature(locator, &block)
+        define_element_accessor(identifier, locator, element, &context)
+      end
+    end
+
+    private
+
+    # @param identifier [String] friendly name of element definition
+    # @param locator [Array] locators for referencing the element
+    # @param element [String] name of Watir-based object
+    # @param block [Proc] a context block
+    #
+    # @example
+    #   enable, {:id => 'enableForm'}, checkbox
+    def define_element_accessor(identifier, locator, element, &block)
+      define_method "#{identifier}".to_sym do |*values|
+        #puts "*** *values: #{values}"
+
+        if block_given?
+          instance_exec(*values, &block)
+        else
+          reference_element(element, locator)
+        end
+      end
+    end
+
+    # Returns the identifier and locator portions of an element definition.
+    #
+    # @param signature [Array] full element definition
+    # @return [String] identifier and locator portions
+    def parse_signature(signature)
+      return signature.shift, signature.shift
+    end
+
+    # Returns the block or proc that serves as a context for an element
+    # definition.
+    #
+    # @param locator [Array] locators from element definition
+    # @param block [Proc] a context block
+    def context_from_signature(*locator, &block)
+      if block_given?
+        block
+      else
+        context = locator.shift
+        context.is_a?(Proc) && locator.empty? ? context : nil
+      end
+    end
+
+  end
+end

data/lib/symbiont/errors.rb

@@ -0,0 +1,7 @@
+module Symbiont
+  module Errors
+    class NoUrlForDefinition < StandardError; end
+    class NoUrlMatchForDefinition < StandardError; end
+    class NoTitleForDefinition < StandardError; end
+  end
+end

data/lib/symbiont/factory.rb

@@ -1,46 +1,75 @@
-module Symbiont
-  module Factory
-    
-    # Creates a definition context for actions.
-    #
-    # @param [Class] definition The name of a definition class
-    # @param [optional] block Logic to execute within the context of the
-    # definition
-    # @return [Object] instance of the definition
-    def on(definition, visit=false, &block)
-      definition = get_object_for(definition) if definition.is_a? String
-      @active = definition.new(@browser, visit)
-      block.call @active if block
-      @active
-    end
-    
-    # Creates a definition context for actions and establishes the
-    # context for display.
-    #
-    # @param [Class] definition The name of a definition class
-    # @param [optional] block Logic to execute within the context of the
-    # definition
-    # @return [Object] instance of the definition
-    def on_view(definition, &block)
-      on(definition, true, &block)
-    end
-
-    def if_on(definition, &block)
-      definition = get_object_for(definition) if definition.is_a? String
-      return @active unless @active.class == definition
-      on(definition, false, &block)
-    end
-
-    alias_method :during, :on
-    alias_method :start_activity, :on_view
-    alias_method :start_on, :on_view
-
-  private
-
-    def get_object_for(definition)
-      definition.split('::').inject(Object) do |obj, name|
-        obj.const_get(name)
-      end
-    end
-  end # module: Factory
-end # module: Symbiont
+module Symbiont
+  module Factory
+
+    # Creates a definition context for actions. If an existing context
+    # exists, that context will be re-used.
+    #
+    # @param definition [Class] the name of a definition class
+    # @param visit [Boolean] true if the context needs to be called into view
+    # @param block [Proc] logic to execute in the context of the definition
+    # @return [Object] instance of the definition
+    def on(definition, visit=false, &block)
+      if @active.kind_of?(definition)
+        block.call @active if block
+        return @active
+      end
+
+      if @context.kind_of?(definition)
+        block.call @context if block
+        return @context
+      end
+
+      @active = definition.new(@driver)
+      @active.view if visit == true
+      block.call @active if block
+
+      @active
+    end
+
+    alias_method :on_page, :on
+    alias_method :while_on, :on
+
+    # Creates a definition context for actions and establishes the
+    # context for display.
+    #
+    # @param definition [Class] the name of a definition class
+    # @param block [Proc] logic to execute in the context of the definition
+    # @return [Object] instance of the definition
+    def on_view(definition, &block)
+      on(definition, true, &block)
+    end
+
+    alias_method :on_visit, :on_view
+
+    # Creates a definition context for actions. Unlike the on() factory,
+    # on_new will always create a new context and will never re-use an
+    # existing one.
+    #
+    # @param definition [Class] the name of a definition class
+    # @param block [Proc] logic to execute in the context of the definition
+    # @return [Object] instance of the definition
+    def on_new(definition, &block)
+      @active = nil
+
+      if @context.kind_of?(definition)
+        @context = nil
+      end
+      
+      on(definition, &block)
+    end
+
+    # Creates a definition context for actions. If an existing context
+    # exists, that context will be re-used. This also sets a context that
+    # will be used for that definition even if the active definition
+    # changes.
+    #
+    # @param definition [Class] the name of a definition class
+    # @param block [Proc] logic to execute within the context of the definition
+    # @return [Object] instance of the definition
+    def on_set(definition, &block)
+      on(definition, &block)
+      @context = @active
+      @active
+    end
+  end
+end

data/lib/symbiont/helpers.rb

@@ -0,0 +1,49 @@
+module Symbiont
+  module Helpers
+    def url_is_empty
+      puts "\nERROR".on_red
+      puts "The url_is assertion is empty on the definition #{retrieve_class(caller)}.".cyan
+      raise Symbiont::Errors::NoUrlForDefinition
+    end
+
+    def url_match_is_empty
+      puts "\nERROR".on_red
+      puts "The url_matches assertion is empty on the definition #{retrieve_class(caller)}.".cyan
+      raise Symbiont::Errors::NoUrlMatchForDefinition
+    end
+
+    def title_is_empty
+      puts "\nERROR".on_red
+      puts "The title_is assertion is empty on the definition #{retrieve_class(caller)}.".cyan
+      raise Symbiont::Errors::NoTitleForDefinition
+    end
+
+    def no_url_is_provided
+      puts "\nERROR".on_red
+      puts "You called a '#{retrieve_method(caller)}' action but the definition #{self.class} does not have a url_is assertion.".cyan
+      raise Symbiont::Errors::NoUrlForDefinition
+    end
+
+    def no_url_matches_is_provided
+      puts "\nERROR".on_red
+      puts "You called a '#{retrieve_method(caller)}' action but the definition #{self.class} does not have a url_matches assertion.".cyan
+      raise Symbiont::Errors::NoUrlMatchForDefinition
+    end
+
+    def no_title_is_provided
+      puts "\nERROR".on_red
+      puts "You called a '#{retrieve_method(caller)}' action but the definition #{self.class} does not have a title_is assertion.".cyan
+      raise Symbiont::Errors::NoTitleForDefinition
+    end
+
+    private
+
+    def retrieve_class(caller)
+      caller[1][/`.*'/][8..-3]
+    end
+
+    def retrieve_method(caller)
+      caller[0][/`.*'/][1..-2]
+    end
+  end
+end

data/lib/symbiont/logging.rb

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