ae_page_objects 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a18e3851747da830279cb221c6e8396be49bd7f
-  data.tar.gz: d928b79a0cf1c1803fe6fe5dfaa11bdf09be89da
+  metadata.gz: 5334b6a4fd2514a439fa323284a5893cb21005ca
+  data.tar.gz: 64a263fd884d0e933ebf8000ad88ed689dc3f601
 SHA512:
-  metadata.gz: d3c1e84440a35294ddb0b75e980c604e76f79bfdc79161cbd37808afa0c59e35ba43d6024c2babe4e4cd5f24584787c2d610d1225ede69dc1ff567f95f28d0bb
-  data.tar.gz: de8501df5e1f010dc72ef281fbc5038fca1cf683b8ba61c3c62b84585537afbe8811ac2cfdf8e4a6d0147d91a6a068b2e8deaeb589568a03e1609bebc1905588
+  metadata.gz: 3af8bd7d6c91c8865641f2673cba8244ccc4d5db142bc95591f70dc57fdc2ecec8f924dfc71fe6fc38627b36fc5e1a1e8007d970b06a65ff17113f5b7f915fe3
+  data.tar.gz: 2b3d973eb84a26923bd6db1dcbec1bcdc18a85a923f98e3f60dfeed2b44e7ffaffa886fb88c6bc9695f565baa12fc5a0ea7a3818e311ff004a299072388b1e6f

data/lib/ae_page_objects.rb

@@ -23,17 +23,49 @@ module AePageObjects
     autoload :Staleable,        'ae_page_objects/concerns/staleable'
     autoload :Visitable,        'ae_page_objects/concerns/visitable'
   end
-  
+
+  module MultipleWindows
+    autoload :Browser,                   'ae_page_objects/multiple_windows/browser'
+    autoload :Window,                    'ae_page_objects/multiple_windows/window'
+    autoload :CrossWindowLoaderStrategy, 'ae_page_objects/multiple_windows/cross_window_loader_strategy'
+    autoload :WindowList,                'ae_page_objects/multiple_windows/window_list'
+    autoload :WindowHandleManager,       'ae_page_objects/multiple_windows/window_handle_manager'
+  end
+
+  module SingleWindow
+    autoload :Browser,                   'ae_page_objects/single_window/browser'
+    autoload :Window,                    'ae_page_objects/single_window/window'
+    autoload :SameWindowLoaderStrategy,  'ae_page_objects/single_window/same_window_loader_strategy'
+  end
+
   autoload :Window,            'ae_page_objects/window'
+  
+  autoload :DocumentQuery,     'ae_page_objects/document_query'
+  autoload :DocumentLoader,    'ae_page_objects/document_loader'
+
   autoload :Node,              'ae_page_objects/node'
   autoload :Document,          'ae_page_objects/document'
+  autoload :DocumentProxy,     'ae_page_objects/document_proxy'
   autoload :Element,           'ae_page_objects/element'
   autoload :ElementProxy,      'ae_page_objects/element_proxy'
   
   autoload :Collection,        'ae_page_objects/elements/collection'
   autoload :Form,              'ae_page_objects/elements/form'
   autoload :Select,            'ae_page_objects/elements/select'
-  autoload :Checkbox,          'ae_page_objects/elements/checkbox'  
+  autoload :Checkbox,          'ae_page_objects/elements/checkbox'
+
+  def self.browser
+    @browser ||= begin
+      driver = Capybara.current_session.driver
+
+      case driver
+      when Capybara::Selenium::Driver then
+        MultipleWindows::Browser.new
+      else
+        SingleWindow::Browser.new
+      end
+    end
+  end
 end
 
 require 'ae_page_objects/core_ext/module'

data/lib/ae_page_objects/core/application_router.rb

@@ -93,6 +93,19 @@ module AePageObjects
           [url, router]
         end
       end
+
+      class Rails4 < Rails32
+
+        private
+        def url_and_router(url)
+          require 'action_dispatch/journey'
+          url = ActionDispatch::Journey::Router::Utils.normalize_path(url) unless url =~ %r{://}
+          router = Rails.application.routes.router
+
+          [url, router]
+        end
+      end
+
     end
 
     def path_recognizes_url?(path, url)
@@ -121,6 +134,9 @@ module AePageObjects
           Recognizer::Rails3.new
         elsif Rails.version =~ /\A3\.2/
           Recognizer::Rails32.new
+        elsif Rails.version =~ /\A4\.[01]/
+          warn "[WARNING]: AePageObjects works but is not thoroughly tested against Rails 4. Caveat emptor."
+          Recognizer::Rails4.new
         else
           warn "[WARNING]: AePageObjects is not tested against Rails #{Rails.version} and may behave in an undefined manner."
           Recognizer::Rails32.new

data/lib/ae_page_objects/document.rb

@@ -2,25 +2,23 @@ module AePageObjects
   class Document < Node
     include Concerns::Visitable
 
+    attr_reader :window
+
     def initialize
       super(Capybara.current_session)
-    end
 
-    if defined? Selenium::WebDriver
-      attr_reader :window
-    
-      def initialize
-        super(Capybara.current_session)
+      @window = browser.current_window
+      @window.current_document = self
+    end
 
-        @window = Window.current
-        @window.current_document = self
-      end
+    def browser
+      AePageObjects.browser
     end
-    
+
     def document
       self
     end
-    
+
     class << self
     private
       def site
@@ -28,4 +26,4 @@ module AePageObjects
       end
     end
   end
-end
+end

data/lib/ae_page_objects/document_loader.rb

@@ -0,0 +1,30 @@
+module AePageObjects
+  class DocumentLoader
+    def initialize(query, strategy)
+      @query    = query
+      @strategy = strategy
+    end
+
+    def default_document_class
+      @default_document_class ||= @query.conditions.first.document_class
+    end
+
+    def permitted_types_dump
+      @permitted_types_dump ||= @query.conditions.map(&:document_class).map(&:name).inspect
+    end
+
+    def load
+      Waiter.wait_for do
+        @query.conditions.each do |document_condition|
+          if document = @strategy.load_document_with_condition(document_condition)
+            return document
+          end
+        end
+
+        nil
+      end
+
+      raise @strategy.document_not_loaded_error(self)
+    end
+  end
+end

data/lib/ae_page_objects/document_proxy.rb

@@ -0,0 +1,47 @@
+module AePageObjects
+  class DocumentProxy
+
+    # Remove all instance methods so even things like class()
+    # get handled by method_missing(). <lifted from activerecord>
+    instance_methods.each do |m|
+      unless m.to_s =~ /^(?:nil\?|send|object_id|to_a|tap)$|^__|^respond_to|is_a?|instance_variable_get/
+        undef_method m
+      end
+    end
+
+    def initialize(loaded_page, document_loader)
+      @loaded_page     = loaded_page
+      @document_loader = document_loader
+    end
+
+    def is_a?(document_class)
+      super || @loaded_page.is_a?(document_class)
+    end
+
+    def as_a(document_class)
+      if @loaded_page.is_a?(document_class)
+        return @loaded_page
+      end
+
+      raise DocumentLoadError, "#{document_class.name} not expected. Allowed types: #{@document_loader.permitted_types_dump}"
+    end
+
+  private
+
+    def implicit_document
+      @implicit_document ||= as_a(implicit_document_class)
+    end
+
+    def implicit_document_class
+      @implicit_document_class ||= @document_loader.default_document_class
+    end
+
+    def method_missing(name, *args, &block)
+      implicit_document.__send__(name, *args, &block)
+    end
+
+    def respond_to?(*args)
+      super || implicit_document_class.allocate.respond_to?(*args)
+    end
+  end
+end

data/lib/ae_page_objects/document_query.rb

@@ -0,0 +1,68 @@
+module AePageObjects
+  class DocumentQuery
+    class Condition
+      attr_reader :document_class, :document_conditions
+
+      def initialize(document_class, document_conditions = {}, &block_condition)
+        @document_class    = document_class
+
+        @document_conditions = document_conditions || {}
+        @document_conditions[:block] = block_condition if block_condition
+      end
+
+      def match?(document)
+        @document_conditions.each do |type, value|
+          case type
+          when :title then
+            return false unless Capybara.current_session.driver.browser.title.include?(value)
+          when :url then
+            return false unless document.current_url.include?(value)
+          when :block then
+            return false unless value.call(document)
+          end
+        end
+
+        true
+      end
+    end
+
+    attr_reader :conditions
+
+    def initialize(*document_classes, &block)
+      @conditions = []
+
+      if document_classes.empty?
+        raise ArgumentError, "block expected" if block.nil?
+        block.call(self)
+
+        raise ArgumentError, "conditions expected" if @conditions.empty?
+      else
+
+        all_documents = document_classes.all? do |document_class|
+          document_class.is_a?(Class) && document_class < Document
+        end
+
+        if all_documents
+          if document_classes.size == 1
+            matches(document_classes.first, {}, &block)
+          else
+            raise ArgumentError, "block unexpected for multiple documents" unless block.nil?
+
+            document_classes.each do |document_class|
+              matches(document_class)
+            end
+          end
+        else
+          raise ArgumentError, "Expected (Document, document_options)" unless document_classes.size == 2
+          raise ArgumentError, "Expected (Document, document_options)" unless (document_classes.first < Document) && document_classes.last.is_a?(Hash)
+
+          matches(document_classes.first, document_classes.last, &block)
+        end
+      end
+    end
+
+    def matches(document_class, conditions = {}, &block_condition)
+      @conditions << Condition.new(document_class, conditions, &block_condition)
+    end
+  end
+end

data/lib/ae_page_objects/element.rb

@@ -28,6 +28,14 @@ module AePageObjects
       end
     end
 
+    def browser
+      @browser ||= document.browser
+    end
+
+    def window
+      @window ||= document.window
+    end
+
     def __full_name__
       if parent.respond_to?(:__full_name__)
         name_parts = [ parent.__full_name__, __name__ ].compact

data/lib/ae_page_objects/exceptions.rb

@@ -1,10 +1,15 @@
 module AePageObjects
-  class StalePageObject < StandardError
+  class Error < StandardError; end
+
+  class StalePageObject < Error
+  end
+
+  class LoadingFailed < Error
   end
 
-  class LoadingFailed < StandardError
+  class PathNotResolvable < Error
   end
 
-  class PathNotResolvable < StandardError
+  class DocumentLoadError < Error
   end
 end

data/lib/ae_page_objects/multiple_windows/browser.rb

@@ -0,0 +1,22 @@
+module AePageObjects
+  module MultipleWindows
+    class Browser
+      attr_reader :windows
+
+      def initialize
+        @windows = WindowList.new
+      end
+
+      def current_window
+        @windows.current_window
+      end
+
+      def find_document(*document_classes, &block)
+        query           = DocumentQuery.new(*document_classes, &block)
+        document_loader = DocumentLoader.new(query, CrossWindowLoaderStrategy.new(@windows))
+
+        DocumentProxy.new(document_loader.load, document_loader)
+      end
+    end
+  end
+end

data/lib/ae_page_objects/multiple_windows/cross_window_loader_strategy.rb

@@ -0,0 +1,49 @@
+module AePageObjects
+  module MultipleWindows
+    class CrossWindowLoaderStrategy
+
+      def initialize(window_list)
+        @window_list     = window_list
+        @original_window = window_list.current_window
+
+        @current_window_loader = SingleWindow::SameWindowLoaderStrategy.new
+      end
+
+      def load_document_with_condition(condition)
+        # Look in the current window first unless told not to
+        unless condition.document_conditions[:ignore_current]
+          @original_window.switch_to
+
+          if document = @current_window_loader.load_document_with_condition(condition)
+            return document
+          end
+        end
+
+        # Loop through all the windows and attempt to instantiate the Document. Continue to loop around
+        # until finding a Document that can be instantiated or timing out.
+        @window_list.opened.each do |window|
+          next if window == @original_window
+
+          window.switch_to
+
+          if document = @current_window_loader.load_document_with_condition(condition)
+            return document
+          end
+        end
+
+        @original_window.switch_to
+
+        nil
+      end
+
+      def document_not_loaded_error(document_loader)
+        all_windows = @window_list.opened.map do |window|
+          name = window.current_document && window.current_document.to_s || "<none>"
+          {:window_handle => window.handle, :document => name }
+        end
+
+        DocumentLoadError.new("Couldn't find document with type in #{document_loader.permitted_types_dump} in any of the open windows: #{all_windows.inspect}")
+      end
+    end
+  end
+end

data/lib/ae_page_objects/multiple_windows/window.rb

@@ -0,0 +1,28 @@
+module AePageObjects
+  module MultipleWindows
+    class Window < SingleWindow::Window
+      attr_reader :handle
+
+      def initialize(registry, handle)
+        @registry = registry
+        @handle   = handle
+
+        @registry.add(self)
+
+        super()
+      end
+
+      def switch_to
+        WindowHandleManager.switch_to(handle)
+        current_document
+      end
+
+      def close
+        if WindowHandleManager.close(@handle)
+          self.current_document = nil
+          @registry.remove(self)
+        end
+      end
+    end
+  end
+end

data/lib/ae_page_objects/multiple_windows/window_handle_manager.rb

@@ -0,0 +1,50 @@
+module AePageObjects
+  module MultipleWindows
+    class WindowHandleManager
+      def self.all
+        browser.window_handles
+      end
+
+      def self.current
+        # Accessing browser.window_handle tries to find an existing page, which will blow up
+        # if there isn't one. So... we look at the collection first as a guard.
+        if all.empty?
+          nil
+        else
+          browser.window_handle
+        end
+      end
+
+      def self.switch_to(handle)
+        browser.switch_to.window(handle)
+      end
+
+      def self.browser
+        Capybara.current_session.driver.browser
+      end
+
+      def self.close(handle)
+        all_handles_before_close = all()
+        more_than_one_window     = (all_handles_before_close.size > 1)
+
+        # We must protect against closing the last window as doing so will quit the entire browser
+        # which would mess up subsequent tests.
+        # http://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/WebDriver.html#close()
+        return false unless more_than_one_window
+
+        current_handle_before_switch = current
+
+        # switch to the window to close
+        switch_to(handle)
+
+        browser.close
+
+        # need to switch back to something. Use whatever was switched from originally unless we just
+        # closed that window, in which case just pick something else.
+        switch_to(current_handle_before_switch == handle ?  all.first : current_handle_before_switch)
+
+        true
+      end
+    end
+  end
+end

data/lib/ae_page_objects/multiple_windows/window_list.rb

@@ -0,0 +1,43 @@
+module AePageObjects
+  module MultipleWindows
+    class WindowList
+      def initialize
+        @windows = {}
+      end
+
+      def add(window)
+        @windows[window.handle] = window
+      end
+
+      def remove(window)
+        @windows.delete(window.handle)
+      end
+
+      def opened
+        WindowHandleManager.all.map do |handle|
+          find(handle)
+        end
+      end
+
+      def current_window
+        current_handle = WindowHandleManager.current
+
+        find(current_handle) if current_handle
+      end
+
+      def close_all
+        opened.each(&:close)
+      end
+
+    private
+
+      def find(handle)
+        @windows[handle] || create_window(handle)
+      end
+
+      def create_window(handle)
+        Window.new(self, handle)
+      end
+    end
+  end
+end

data/lib/ae_page_objects/single_window/browser.rb

@@ -0,0 +1,11 @@
+module AePageObjects
+  module SingleWindow
+    class Browser
+      attr_reader :current_window
+
+      def initialize
+        @current_window = Window.new
+      end
+    end
+  end
+end

data/lib/ae_page_objects/single_window/same_window_loader_strategy.rb

@@ -0,0 +1,33 @@
+module AePageObjects
+  module SingleWindow
+    class SameWindowLoaderStrategy
+      def load_document_with_condition(condition)
+        document = load_document(condition.document_class)
+
+        if document && condition_matches?(document, condition)
+          document
+        else
+          nil
+        end
+      end
+
+      def document_not_loaded_error(document_loader)
+        DocumentLoadError.new("Current window does not contain document with type in #{document_loader.permitted_types_dump}.")
+      end
+
+    private
+
+      def load_document(document_class)
+        document_class.new
+      rescue AePageObjects::LoadingFailed
+        nil
+      end
+
+      def condition_matches?(document, condition)
+        condition.match?(document)
+      rescue Capybara::ElementNotFound
+        false
+      end
+    end
+  end
+end

data/lib/ae_page_objects/single_window/window.rb

@@ -0,0 +1,23 @@
+module AePageObjects
+  module SingleWindow
+    class Window
+      attr_reader :current_document
+
+      def initialize
+        @current_document = nil
+      end
+
+      def current_document=(document)
+        @current_document.send(:stale!) if @current_document
+        @current_document = document
+      end
+
+      def change_to(*document_classes, &block)
+        query           = DocumentQuery.new(*document_classes, &block)
+        document_loader = DocumentLoader.new(query, SameWindowLoaderStrategy.new)
+
+        DocumentProxy.new(document_loader.load, document_loader)
+      end
+    end
+  end
+end

data/lib/ae_page_objects/version.rb

@@ -1,3 +1,3 @@
 module AePageObjects
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/ae_page_objects/window.rb

@@ -1,125 +1,18 @@
+unless AePageObjects.respond_to?(:browser)
+  raise "Deprecation warnings out of date."
+end
+
 module AePageObjects
   class Window
-
-    class Registry < Hash
-      def [](window_or_handle)
-        if window_or_handle.is_a?(Window)
-          super(window_or_handle.handle)
-        else
-          super(window_or_handle)
-        end
-      end
-
-      def add(window)
-        self[window.handle] = window
-      end
-
-      def remove(window)
-        self.delete(window.handle)
-      end
-    end
-
-    class HandleManager
-      def self.all
-        browser.window_handles
-      end
-
-      def self.current
-        # Accessing browser.window_handle tries to find an existing page, which will blow up
-        # if there isn't one. So... we look at the collection first as a guard.
-        if all.empty?
-          nil
-        else
-          browser.window_handle
-        end
-      end
-
-      def self.switch_to(handle)
-        browser.switch_to.window(handle)
-      end
-
-      def self.browser
-        Capybara.current_session.driver.browser
-      end
-
-      def self.close(handle)
-        all_handles_before_close = all()
-        more_than_one_window     = (all_handles_before_close.size > 1)
-
-        # We must protect against closing the last window as doing so will quit the entire browser
-        # which would mess up subsequent tests.
-        # http://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/WebDriver.html#close()
-        return false unless more_than_one_window
-
-        current_handle_before_switch = current
-
-        # switch to the window to close
-        switch_to(handle)
-
-        browser.close
-
-        # need to switch back to something. Use whatever was switched from originally unless we just
-        # closed that window, in which case just pick something else.
-        switch_to(current_handle_before_switch == handle ?  all.first : current_handle_before_switch)
-
-        true
-      end
-    end
-
     class << self
-      def registry
-        @registry ||= Registry.new
-      end
-
-      def close_all
-        all.each(&:close)
-      end
-
       def all
-        HandleManager.all.map do |handle|
-          find(handle)
-        end
-      end
-
-      def find(handle)
-        registry[handle] || create(handle)
-      end
-
-      def current
-        current_handle = HandleManager.current
-
-        find(current_handle) if current_handle
+        warn "[DEPRECATION WARNING]: AePageObjects::Window.all is deprecated. Use AePageObjects.browser.windows()"
+        AePageObjects.browser.windows
       end
 
-      def create(handle)
-        new(registry, handle)
-      end
-    end
-
-    attr_reader :current_document, :handle
-
-    def initialize(registry, handle)
-      @registry         = registry
-      @handle           = handle
-      @current_document = nil
-
-      @registry.add(self)
-    end
-
-    def current_document=(document)
-      @current_document.send(:stale!) if @current_document
-      @current_document = document
-    end
-
-    def switch_to
-      HandleManager.switch_to(handle)
-      current_document
-    end
-
-    def close
-      if HandleManager.close(@handle)
-        self.current_document = nil
-        @registry.remove(self)
+      def close_all
+        warn "[DEPRECATION WARNING]: AePageObjects::Window.close_all is deprecated. Use AePageObjects.browser.windows.close_all()"
+        all.close_all
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_page_objects
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Donnie Tognazzini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -49,6 +49,9 @@ files:
 - lib/ae_page_objects/core/universe.rb
 - lib/ae_page_objects/core_ext/module.rb
 - lib/ae_page_objects/document.rb
+- lib/ae_page_objects/document_loader.rb
+- lib/ae_page_objects/document_proxy.rb
+- lib/ae_page_objects/document_query.rb
 - lib/ae_page_objects/element.rb
 - lib/ae_page_objects/element_proxy.rb
 - lib/ae_page_objects/elements/checkbox.rb
@@ -56,7 +59,15 @@ files:
 - lib/ae_page_objects/elements/form.rb
 - lib/ae_page_objects/elements/select.rb
 - lib/ae_page_objects/exceptions.rb
+- lib/ae_page_objects/multiple_windows/browser.rb
+- lib/ae_page_objects/multiple_windows/cross_window_loader_strategy.rb
+- lib/ae_page_objects/multiple_windows/window.rb
+- lib/ae_page_objects/multiple_windows/window_handle_manager.rb
+- lib/ae_page_objects/multiple_windows/window_list.rb
 - lib/ae_page_objects/node.rb
+- lib/ae_page_objects/single_window/browser.rb
+- lib/ae_page_objects/single_window/same_window_loader_strategy.rb
+- lib/ae_page_objects/single_window/window.rb
 - lib/ae_page_objects/util/hash_symbolizer.rb
 - lib/ae_page_objects/util/inflector.rb
 - lib/ae_page_objects/util/internal_helpers.rb