symbiote 0.1.0 → 0.2.0

data/lib/symbiote.rb

@@ -1,65 +1,40 @@
-require 'symbiote/version'
-require 'symbiote/logger'
-require 'symbiote/errors'
-require 'symbiote/platforms'
-require 'symbiote/generators'
+require "symbiote/version"
 
-require 'watir-webdriver'
-require 'selenium-webdriver'
+require "symbiote/data_setter"
+require "symbiote/situation"
+require "symbiote/elements"
+require "symbiote/factory"
+require "symbiote/pages"
 
 module Symbiote
-  include Platforms
+  module_function
 
-  # @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}"
+
+  def included(caller)
+    caller.extend Symbiote::Elements
+    caller.extend Symbiote::Pages::Assertion
+    caller.__send__ :include, Symbiote::Elements::Accessor
+    caller.__send__ :include, Symbiote::Pages
+    caller.__send__ :include, Symbiote::DataSetter
+  end
+
+  def initialize(browser = nil, &block)
+    @browser = Symbiote.browser unless Symbiote.browser.nil?
+    @browser = browser if Symbiote.browser.nil?
+    instance_eval(&block) if block
   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
+  def set_browser(app = :chrome, *args)
+    @browser = Watir::Browser.new(app, *args)
+    Symbiote.browser = @browser
   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)
+  def browser=(browser)
     @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)
+  def browser
+    @browser
   end
-  
 end

data/lib/symbiote/data_setter.rb

@@ -0,0 +1,51 @@
+class Object
+  def chain(method_chain, arg = nil)
+    return self if method_chain.empty?
+    method_chain.split('.').inject(self) do |o, m|
+      if arg.nil?
+        o.send(m.intern)
+      else
+        o.send(m.intern, arg)
+      end
+    end
+  end
+end
+
+module Symbiote
+  module DataSetter
+    def using(data)
+      data.each do |key, value|
+        use_data_with(key, value) if object_enabled_for(key)
+      end
+    end
+
+    alias using_data using
+    alias use_data using
+    alias using_values using
+    alias use_values using
+
+    private
+
+    def use_data_with(key, value)
+      element = send(key.to_s)
+      set_and_select(key, element, value)
+      check_and_uncheck(key, element, value)
+    end
+
+    def set_and_select(key, element, value)
+      chain("#{key}.set", value)    if element.class == Watir::TextField
+      chain("#{key}.set")           if element.class == Watir::Radio
+      chain("#{key}.select", value) if element.class == Watir::Select
+    end
+
+    def check_and_uncheck(key, element, value)
+      return chain("#{key}.check") if element.class == Watir::CheckBox && value
+      chain("#{key}.uncheck")      if element.class == Watir::CheckBox
+    end
+
+    def object_enabled_for(key)
+      web_element = send(key.to_s)
+      web_element.enabled? && web_element.visible?
+    end
+  end
+end

data/lib/symbiote/elements.rb

@@ -0,0 +1,60 @@
+require "watir"
+require "watir-webdriver"
+
+module Symbiote
+  include Situation
+
+  module_function
+
+  def elements
+    @elements = Watir::Container.instance_methods unless @elements
+  end
+
+  def hosts?(method)
+    Symbiote.elements.include? method.to_sym
+  end
+
+  module Elements
+    module Accessor
+      def reference_element(element, locator)
+        browser.send(element, *locator).to_subtype
+      rescue NoMethodError
+        browser.send(element, *locator)
+      end
+    end
+
+    def method_missing(method, *args)
+      abort("The method '#{method}' is not a recognized element method.")
+      super
+    end
+
+    def respond_to_missing?(method)
+      super
+    end
+
+    Symbiote.elements.each do |element|
+      define_method(element) do |*signature, &block|
+        identifier, locator = parse_signature(signature)
+        define_element_accessor(identifier, locator, element, &block)
+      end
+    end
+
+    private
+
+    def define_element_accessor(identifier, *locator, element, &block)
+      define_method(identifier.to_s.to_sym) do |*values|
+        if block_given?
+          instance_exec(*values, &block)
+        else
+          no_locator(self.class, identifier) if empty_locator(locator, values)
+          locator = values if locator[0].nil?
+          reference_element(element, locator)
+        end
+      end
+    end
+
+    def parse_signature(signature)
+      [signature.shift, signature.shift]
+    end
+  end
+end

data/lib/symbiote/factory.rb

@@ -0,0 +1,24 @@
+module Symbiote
+  module Factory
+    # Creates a definition context for actions. If an existing context
+    # exists, that context will be re-used.
+    def on(definition, visit = false, &block)
+      unless @context.is_a?(definition)
+        @context = definition.new(@browser) if @browser
+        @context = definition.new unless @browser
+        @context.visit if visit
+      end
+
+      yield @context if block
+      @context
+    end
+
+    # Creates a definition context for actions and establishes the
+    # context for execution.
+    def on_view(definition, &block)
+      on(definition, true, &block)
+    end
+
+    alias on_visit on_view
+  end
+end

data/lib/symbiote/pages.rb

@@ -0,0 +1,65 @@
+module Symbiote
+  include Situation
+
+  module_function
+
+  module Pages
+    module Assertion
+      include Situation
+
+      def url_is(url)
+        url_is_empty if url.nil? || url.empty?
+        @url = url
+      end
+
+      def asserted_url
+        @url
+      end
+
+      def title_is(title)
+        title_is_empty if title.nil? || title.empty?
+        @title = title
+      end
+
+      def asserted_title
+        @title
+      end
+    end
+
+    def visit(url = nil)
+      no_url_provided if url.nil? && asserted_url.nil?
+      browser.goto(url) unless url.nil?
+      browser.goto(asserted_url) if url.nil?
+      self
+    end
+
+    alias perform visit
+    alias view visit
+    alias navigate_to visit
+    alias goto visit
+
+    def asserted_url
+      self.class.asserted_url
+    end
+
+    def asserted_title
+      self.class.asserted_title
+    end
+
+    def resize(width, height)
+      browser.window.resize_to(width, height)
+    end
+
+    def position(x, y)
+      browser.window.move_to(x, y)
+    end
+
+    def url
+      browser.url
+    end
+
+    def title
+      browser.title
+    end
+  end
+end

data/lib/symbiote/situation.rb

@@ -0,0 +1,53 @@
+module Symbiote
+  module Situation
+    private
+
+    def url_is_empty
+      puts "PROBLEM: url_is assertion empty."
+      puts "The url_is assertion is empty on"
+      puts "the definition #{retrieve_class(caller)}."
+      abort
+    end
+
+    def no_url_provided
+      puts "PROBLEM: No url provided."
+      puts "You called a '#{retrieve_method(caller)}' action but the "
+      puts "definition #{self.class} does not have a url_is assertion."
+      puts "Either provide the url_is assertion or pass the url as an"
+      puts "argument to the visit call."
+      abort
+    end
+
+    def title_is_empty
+      puts "PROBLEM: title_is assertion empty."
+      puts "The title_is assertion is empty on"
+      puts "the definition #{retrieve_class(caller)}."
+      abort
+    end
+
+    def no_title_is_provided
+      puts "PROBLEM: No title provided."
+      puts "You called a '#{retrieve_method(caller)}' action but the"
+      puts "definition #{self.class} does not have a title_is assertion."
+    end
+
+    def no_locator(definition, identifier)
+      puts "PROBLEM: No locator provided."
+      puts "You are using '#{identifier}' on '#{definition}'."
+      puts "But there is no locator provided with it."
+      abort
+    end
+
+    def empty_locator(locator, values)
+      locator[0].nil? && values.empty? && !values[0].is_a?(Hash)
+    end
+
+    def retrieve_class(caller)
+      caller[1][/`.*'/][8..-3]
+    end
+
+    def retrieve_method(caller)
+      caller[0][/`.*'/][1..-2]
+    end
+  end
+end

data/lib/symbiote/version.rb

@@ -1,3 +1,14 @@
 module Symbiote
-  VERSION = '0.1.0'
+  module_function
+
+  VERSION = "0.2.0".freeze
+
+  def version
+    """
+Symbiote v#{Symbiote::VERSION}
+watir: #{Gem.loaded_specs['watir'].version}
+watir-webdriver: #{Gem.loaded_specs['watir-webdriver'].version}
+selenium-webdriver: #{Gem.loaded_specs['selenium-webdriver'].version}
+    """
+  end
 end

data/symbiote.gemspec

@@ -4,28 +4,34 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'symbiote/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'symbiote'
+  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.authors       = ["Jeff Nyman"]
+  spec.email         = ["jeffnyman@gmail.com"]
 
-  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.summary       = %q{Provides a semantic DSL to construct fluent interfaces for test execution logic.}
+  spec.description   = %q{Provides a semantic DSL to construct fluent interfaces for test execution logic.}
+  spec.homepage      = "https://github.com/jnyman/symbiote"
+  spec.license       = "MIT"
 
-  spec.add_runtime_dependency 'watir-webdriver', '0.6.4'
-  spec.add_runtime_dependency 'selenium-webdriver', '2.35.1'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "watir"
+
+  spec.post_install_message = %{
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  Symbiote #{Symbiote::VERSION} has been installed.
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  }
 end

metadata

@@ -1,154 +1,152 @@
 --- !ruby/object:Gem::Specification
 name: symbiote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2016-10-20 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'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: watir-webdriver
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.35.1
+        version: '0'
   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
+        version: '0'
+description: Provides a semantic DSL to construct fluent interfaces for test execution
+  logic.
+email:
+- jeffnyman@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
-- HISTORY.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - 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/data_setter.rb
+- lib/symbiote/elements.rb
+- lib/symbiote/factory.rb
+- lib/symbiote/pages.rb
+- lib/symbiote/situation.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: 
+post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
+  \ Symbiote 0.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.5.1
 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: 
+summary: Provides a semantic DSL to construct fluent interfaces for test execution
+  logic.
+test_files: []