symbiont 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cfaf815aa4e5d2e137a959e075c008951d41982
-  data.tar.gz: 42e72aa8b6a3f1cc15ddfbb549de23e93b223da2
+  metadata.gz: 2f501abc5dee4a79e9327a94d825ebc19b821636
+  data.tar.gz: 7f3030071dfa29ec97fb617ee7038ee33870139f
 SHA512:
-  metadata.gz: ed69a62157cfe29f2ba6cb9512778959bca07147f663453e8be8a2923b83a6c963d6350dae35938ec960e22705347dcfa9d905b76f37c90d804f8dffcd8482a4
-  data.tar.gz: 29cd1a724214ee35954490f305a31446412840bf1fe70d1328944d060efe135777f8d7cd66e0b06771e804759838196e4749a3534b6fdfd7b39718e3c311f24a
+  metadata.gz: 070eb7b9e03d9a070b6a82d31561f32bede1a0a17b474f19e602f2035f230e23315aabbfd47c8dc554b45842f3e1a6ada8e371c01929f1815ff5f6ceee1de0de
+  data.tar.gz: 16f45a9497ed0d2c3f224fb1b1edb7f3788c1c9d5c49b63ba81f3fabbcc9aa1041b2efe7472ed5c99c93535f7ec832af5be21d52ea74be57c450edbad2a51e36

data/.gitignore

@@ -16,6 +16,7 @@ spec/reports
 spec/examples.txt
 test/tmp
 test/version_tmp
+test/symbiont-script.rb
 tmp
 *.bundle
 *.so

data/Rakefile

@@ -6,10 +6,19 @@ require 'rspec/core/rake_task'
 
 RuboCop::RakeTask.new
 
-namespace :test do
-  desc 'Run the Symbiont script.'
-  task :script do
-    system('ruby ./test/symbiont-script.rb')
+namespace :scripts do
+  desc 'Run the Symbiont Watir script.'
+  task :watir do
+    system('ruby ./test/symbiont-with-watir.rb')
+  end
+
+  desc 'Run the Symbiont Capybara script.'
+  task :capybara do
+    system('ruby ./test/symbiont-with-capybara.rb')
+  end
+
+  desc 'Run all Symbiont scripts'
+  task all: [:watir, :capybara] do
   end
 end
 

data/lib/symbiont.rb

@@ -20,12 +20,15 @@ require 'symbiont/data_builder'
 
 require 'symbiont/service_objects'
 
+require 'symbiont/capybara/page'
+require 'symbiont/capybara/region'
+
 module Symbiont
   # @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.extend Symbiont::Elements
+    caller.send :include, Symbiont::Pages
     caller.send :include, Symbiont::Accessor
     caller.send :include, Symbiont::DataSetter
     caller.send :include, Symbiont::DataBuilder
@@ -49,6 +52,7 @@ module Symbiont
 Symbiont v#{Symbiont::VERSION}
 Watir-WebDriver: #{Gem.loaded_specs['watir-webdriver'].version}
 Selenium-WebDriver: #{Gem.loaded_specs['selenium-webdriver'].version}
+Capybara: #{Gem.loaded_specs['capybara'].version}
     """
   end
 
@@ -70,6 +74,17 @@ Selenium-WebDriver: #{Gem.loaded_specs['selenium-webdriver'].version}
     @browser = Watir::Browser.new(app, *args)
     Symbiont.browser = @browser
   end
+
+  # Configure mechanism for Capybara
+  class << self
+    attr_accessor :use_implicit_waits
+
+    def configure
+      yield self
+    end
+  end
+
+  @use_implicit_waits = false
 end
 
 def attach(mod = Symbiont)

data/lib/symbiont/capybara/element.rb

@@ -0,0 +1,142 @@
+require 'timeout'
+
+module Symbiont
+  module Element
+    def element(name, *identifier)
+      build(name, *identifier) do
+        define_method(name.to_s) do |*options|
+          find_first(*identifier, *options)
+        end
+      end
+    end
+
+    def elements(name, *identifier)
+      build(name, *identifier) do
+        define_method(name.to_s) do |*options|
+          find_all(*identifier, *options)
+        end
+      end
+    end
+
+    def region(name, *identifier, &block)
+      region_class, region_args = extract_region_details(identifier, &block)
+
+      build(name, *region_args) do
+        define_method(name) do |*options|
+          region_class.new(self, find_first(*region_args, *options))
+        end
+      end
+    end
+
+    def regions(name, *identifier, &block)
+      region_class, region_args = extract_region_details(identifier, &block)
+
+      build(name, *region_args) do
+        define_method(name) do |*options|
+          find_all(*region_args, *options).map do |element|
+            region_class.new(self, element)
+          end
+        end
+      end
+    end
+
+    private
+
+    def build(name, *identifier)
+      add_to_mapped_elements(name)
+      yield
+      add_element_methods(name, *identifier)
+    end
+
+    def add_to_mapped_elements(name)
+      @mapped_elements ||= []
+      @mapped_elements << name.to_s
+    end
+
+    def add_element_methods(name, *identifier)
+      create_existence_check(name, *identifier)
+      create_nonexistence_check(name, *identifier)
+      create_wait_check(name, *identifier)
+      create_visible_check(name, *identifier)
+      create_invisible_check(name, *identifier)
+    end
+
+    def create_element_method(_name, *_identifier)
+      yield
+    end
+
+    def create_existence_check(name, *identifier)
+      method_name = "has_#{name}?"
+      create_element_method(method_name, *identifier) do
+        define_method(method_name) do |*args|
+          wait_time = Symbiont.use_implicit_waits ? Capybara.default_max_wait_time : 0
+          Capybara.using_wait_time(wait_time) do
+            element_exists?(*identifier, *args)
+          end
+        end
+      end
+    end
+
+    def create_nonexistence_check(name, *identifier)
+      method_name = "has_no_#{name}?"
+      create_element_method(method_name, *identifier) do
+        define_method(method_name) do |*args|
+          wait_time = Symbiont.use_implicit_waits ? Capybara.default_max_wait_time : 0
+          Capybara.using_wait_time(wait_time) do
+            element_does_not_exist?(*identifier, *args)
+          end
+        end
+      end
+    end
+
+    def create_wait_check(name, *identifier)
+      method_name = "wait_for_#{name}"
+      create_element_method(method_name, *identifier) do
+        define_method(method_name) do |timeout = nil, *args|
+          timeout = timeout.nil? ? Capybara.default_max_wait_time : timeout
+          Capybara.using_wait_time(timeout) do
+            element_exists?(*identifier, *args)
+          end
+        end
+      end
+    end
+
+    def create_visible_check(name, *identifier)
+      method_name = "wait_until_#{name}_visible"
+      create_element_method(method_name, *identifier) do
+        define_method(method_name) do |timeout = Capybara.default_max_wait_time, *args|
+          Timeout.timeout(timeout, Symbiont::Errors::ElementVisibleTimeout) do
+            Capybara.using_wait_time(0) do
+              sleep(0.05) until element_exists?(*identifier, *args, visible: true)
+            end
+          end
+        end
+      end
+    end
+
+    def create_invisible_check(name, *identifier)
+      method_name = "wait_until_#{name}_invisible"
+      create_element_method(name, *identifier) do
+        define_method(method_name) do |timeout = Capybara.default_max_wait_time, *args|
+          Timeout.timeout(timeout, Symbiont::Errors::ElementNonVisibleTimeout) do
+            Capybara.using_wait_time(0) do
+              sleep(0.05) while element_exists?(*identifier, *args, visible: true)
+            end
+          end
+        end
+      end
+    end
+
+    def extract_region_details(identifier, &block)
+      if identifier.first.is_a?(Class)
+        region_class = identifier.shift
+      elsif block_given?
+        region_class = Class.new(Symbiont::Region, &block)
+      else
+        fail(ArgumentError, 'Provide a region class either as a block or as the second argument.')
+      end
+
+      [region_class, identifier]
+    end
+  end
+end

data/lib/symbiont/capybara/page.rb

@@ -0,0 +1,95 @@
+require 'capybara'
+
+require 'symbiont/capybara/element'
+require 'symbiont/capybara/ready'
+
+module Symbiont
+  class Page
+    include Capybara::DSL
+    include Ready
+    extend Element
+
+    class << self
+      attr_reader :url
+
+      def url_is(url)
+        @url = url.to_s
+      end
+
+      def url_matches(url)
+        @url_matcher = url
+      end
+
+      def url_matcher
+        @url_matcher || url
+      end
+    end
+
+    def initialize(&block)
+      super
+      instance_eval(&block) if block
+    end
+
+    page_ready do
+      [displayed?, "Expected #{current_url} to match #{url_matcher} but it did not."]
+    end
+
+    def view(content = {}, &block)
+      self.ready = false
+
+      if content.is_a?(String)
+        @page = Capybara.string(content)
+      else
+        location = url
+        fail Symbiont::Errors::NoUrlForDefinition if location.nil?
+        visit url
+      end
+
+      when_ready(&block) if block_given?
+    end
+
+    alias_method :load, :view
+    alias_method :markup, :html
+    alias_method :run_script, :execute_script
+
+    def perform(*args)
+      view(*args)
+      self
+    end
+
+    def url
+      self.class.url
+    end
+
+    def url_matcher
+      self.class.url_matcher
+    end
+
+    def displayed?
+      fail Symbiont::Errors::NoUrlMatchForDefinition if url_matcher.nil?
+      true
+    end
+
+    def secure?
+      !current_url.match(/^https/).nil?
+    end
+
+    private
+
+    def find_first(*identifier)
+      find(*identifier)
+    end
+
+    def find_all(*identifier)
+      all(*identifier)
+    end
+
+    def element_exists?(*identifier)
+      has_selector?(*identifier)
+    end
+
+    def element_does_not_exist?(*identifier)
+      has_no_selector?(*identifier)
+    end
+  end
+end

data/lib/symbiont/capybara/ready.rb

@@ -0,0 +1,57 @@
+module Symbiont
+  module Ready
+    module ClassMethods
+      def ready_validations
+        if superclass.respond_to?(:ready_validations)
+          superclass.ready_validations + _ready_validations
+        else
+          _ready_validations
+        end
+      end
+
+      def page_ready(&block)
+        _ready_validations << block
+      end
+
+      alias_method :page_ready_when, :page_ready
+
+      def _ready_validations
+        @_ready_validations ||= []
+      end
+    end
+
+    attr_accessor :ready, :ready_error
+
+    def self.included(caller)
+      caller.extend(ClassMethods)
+    end
+
+    def when_ready(&block)
+      already_marked_ready = ready
+
+      fail(ArgumentError, 'A block is required for a when_ready action.') unless block_given?
+
+      unless self.ready = ready?
+        message = "Failed to validate because: #{ready_error || 'no reason provided'}"
+        fail(::Symbiont::Errors::PageNotValidatedError, message)
+      end
+      block.call self
+    ensure
+      self.ready = already_marked_ready
+    end
+
+    def ready?
+      self.ready_error = nil
+      return true if ready
+      ready_validations_pass?
+    end
+
+    def ready_validations_pass?
+      self.class.ready_validations.all? do |validation|
+        passed, message = instance_eval(&validation)
+        self.ready_error = message if message && !passed
+        passed
+      end
+    end
+  end
+end

data/lib/symbiont/capybara/region.rb

@@ -0,0 +1,25 @@
+require 'capybara'
+
+require 'symbiont/capybara/element'
+require 'symbiont/capybara/region'
+
+module Symbiont
+  class Region
+    include Capybara::DSL
+    include Ready
+    extend Element
+
+    attr_reader :region_element, :region_parent
+
+    def initialize(region_parent, region_element)
+      @region_parent = region_parent
+      @region_element = region_element
+    end
+
+    private
+
+    def find_first(*identifier)
+      region_element.find(*identifier)
+    end
+  end
+end

data/lib/symbiont/elements.rb

@@ -31,7 +31,7 @@ module Symbiont
     end
   end
 
-  module Element
+  module Elements
     # 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.

data/lib/symbiont/errors.rb

@@ -3,6 +3,9 @@ module Symbiont
     class NoUrlForDefinition < StandardError; end
     class NoUrlMatchForDefinition < StandardError; end
     class NoTitleForDefinition < StandardError; end
+    class ElementVisibleTimeout < StandardError; end
+    class ElementNonVisibleTimeout < StandardError; end
+    class PageNotValidatedError < StandardError; end
 
     class PageURLFromFactoryNotVerified < StandardError
       def message

data/lib/symbiont/factory.rb

@@ -8,20 +8,12 @@ module Symbiont
     # @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 @page.is_a?(definition)
-        block.call @page if block
-        return @page
+      unless @page.is_a?(definition)
+        @page = definition.new(@browser) if @browser
+        @page = definition.new unless @browser
+        @page.view if visit
       end
 
-      if @context.is_a?(definition)
-        block.call @context if block
-        @page = @context
-        return @context
-      end
-
-      @page = definition.new(@browser)
-      @page.view if visit
-
       if @page.class.instance_variable_get(:@url_match)
         raise Symbiont::Errors::PageURLFromFactoryNotVerified unless @page.has_correct_url?
       end
@@ -30,10 +22,7 @@ module Symbiont
         raise Symbiont::Errors::PageTitleFromFactoryNotVerified unless @page.has_correct_title?
       end
 
-      @model = @page
-
       block.call @page if block
-
       @page
     end
 
@@ -61,23 +50,7 @@ module Symbiont
     # @return [Object] instance of the definition
     def on_new(definition, &block)
       @page = nil
-      @model = nil
-
-      @context = nil if @context.is_a?(definition)
-      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 = @page
     end
   end
 end

data/lib/symbiont/pages.rb

@@ -1,5 +1,5 @@
 module Symbiont
-  module Page
+  module Pages
     include Helpers
 
     def view

data/lib/symbiont/version.rb

@@ -1,3 +1,3 @@
 module Symbiont
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/symbiont.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.requirements  << 'Watir-WebDriver, Savon'
+  spec.requirements  << 'Watir-WebDriver, Capybara, Savon'
 
   spec.required_ruby_version     = '>= 2.0'
   spec.required_rubygems_version = '>= 1.8.29'
@@ -47,6 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'watir-dom-wait'
   spec.add_runtime_dependency 'watir-scroll'
   spec.add_runtime_dependency 'savon'
+  spec.add_runtime_dependency 'capybara', ['>= 2.1', '< 3.0']
 
   spec.post_install_message = %{
 (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: symbiont
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: "\n    Symbiont is a framework that allows you to describe your application
   in\n    terms of activity and page definitions. Those definitions can then be\n
   \   referenced by test libraries using the DSL that Symbiont provides. The\n    DSL
@@ -194,6 +214,10 @@ files:
 - lib/symbiont.rb
 - lib/symbiont/accessor.rb
 - lib/symbiont/assertions.rb
+- lib/symbiont/capybara/element.rb
+- lib/symbiont/capybara/page.rb
+- lib/symbiont/capybara/ready.rb
+- lib/symbiont/capybara/region.rb
 - lib/symbiont/data_builder.rb
 - lib/symbiont/data_reader.rb
 - lib/symbiont/data_setter.rb
@@ -211,7 +235,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n
-  \ Symbiont 1.0.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::)
+  \ Symbiont 1.1.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -227,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.29
 requirements:
-- Watir-WebDriver, Savon
+- Watir-WebDriver, Capybara, Savon
 rubyforge_project: 
 rubygems_version: 2.4.5.1
 signing_key: