edsl-pageobject 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c1308f4b87e989cc86ca1f6539cbd8621db51f7f082386730975d2037e5538
-  data.tar.gz: 52e3124320fdb916fa4c410f8685f00447c3d6a3ae18ed81062aa077f40641cc
+  metadata.gz: 44d3414e16ec1b3da3c9f0ca13363af44a345cbe3372640a4ed572e50b7337bb
+  data.tar.gz: ef97de15b9cba8623ba435959f6d58fc30e5e632313dc91a46b9740f96147bff
 SHA512:
-  metadata.gz: 95c8755cb152df6b160f1dcb7943af7bca0288659a1e2bddccb68e5dd5685a42b61c295245e4a916b38513749d05c0e6f7d7a311c3e847a01393dc7ede666910
-  data.tar.gz: 125318710f26cfae63aab3850c98f15c155e9fa26fd6c8cbde37e031186a56785de5b3b80a49ed1081a5938d05516b0edda83af008f99b5fee215a9c7834ec55
+  metadata.gz: af4fde4408312d0d71321f186e026ac9f50c70b6caa3a994af48b35ecd3483b650f060a05bd25d6a5d46bbb089431edcd7ef71135b6eb06080002786959b00fd
+  data.tar.gz: 6541f0649773eab4b9646b95f54d468c46cc40806fe3cbdfde6e6493f1fad4c4fe1474f9b665df93d4fadba76e1b2bc990f60f3c2103893df01974137d3475d4

data/lib/edsl/page_object.rb

@@ -1,5 +1,6 @@
 require 'edsl'
 require_relative 'page_object/population'
+require_relative 'page_object/ajax_support'
 require_relative 'page_object/visitation'
 require_relative 'page_object/page'
 require_relative 'page_object/section'

data/lib/edsl/page_object/ajax_support.rb

@@ -0,0 +1,100 @@
+require 'edsl/page_object/javascript/jquery'
+require 'edsl/page_object/javascript/prototype'
+require 'edsl/page_object/javascript/yui'
+require 'edsl/page_object/javascript/angularjs'
+
+module EDSL
+  module PageObject
+    # Provide hooks into different common Javascript Frameworks.
+    # Currently this module only supports jQuery and Prototype but it
+    # has the ability for you to plug your own framework into it and
+    # therefore have it work with this gem.  You do this by calling the
+    # #add_framework method.  The module you provide must implement the
+    # necessary methods.  Please look at the jQuery or Prototype
+    # implementations to determine the necessary methods
+    #
+    module JavascriptFrameworkFacade
+
+      class << self
+        #
+        # Set the framework to use.
+        #
+        # @param[Symbol] the framework to use.  :jquery, :prototype, :yui,
+        # and :angularjs are supported
+        #
+        def framework=(framework)
+          initialize_script_builder unless @builder
+          raise unknown_framework(framework) unless @builder[framework]
+          @framework = framework
+        end
+
+        #
+        # Get the framework that will be used
+        #
+        def framework
+          @framework
+        end
+
+        #
+        # Add a framework and make it available to the system.
+        #
+        def add_framework(key, value)
+          raise invalid_framework unless value.respond_to? :pending_requests
+          initialize_script_builder unless @builder
+          @builder[key] = value
+        end
+
+        #
+        # get the javascript to determine number of pending requests
+        #
+        def pending_requests
+          script_builder.pending_requests
+        end
+
+        def script_builder
+          initialize_script_builder unless @builder
+          @builder[@framework]
+        end
+
+        private
+
+        def initialize_script_builder
+          @builder = {
+              :jquery => ::EDSL::PageObject::Javascript::JQuery,
+              :prototype => ::EDSL::PageObject::Javascript::Prototype,
+              :yui => ::EDSL::PageObject::Javascript::YUI,
+              :angularjs => ::EDSL::PageObject::Javascript::AngularJS
+          }
+        end
+
+        def unknown_framework(framework)
+          "You specified the Javascript framework #{framework} and it is unknown to the system"
+        end
+
+        def invalid_framework
+          "The Javascript framework you provided does not implement the necessary methods"
+        end
+      end
+    end
+
+    module AJAX
+      #
+      # Wait until there are no pending ajax requests.  This requires you
+      # to set the javascript framework in advance.
+      #
+      # @param [Numeric] the amount of time to wait for the block to return true.
+      # @param [String] the message to include with the error if we exceed
+      # the timeout duration.
+      #
+      def wait_for_ajax(timeout = 30, message = nil)
+        end_time = ::Time.now + timeout
+        until ::Time.now > end_time
+          return if browser.execute_script(::EDSL::PageObject::JavascriptFrameworkFacade.pending_requests) == 0
+          sleep 0.5
+        end
+        message = "Timed out waiting for ajax requests to complete" unless message
+        raise message
+      end
+    end
+  end
+end

data/lib/edsl/page_object/javascript/angularjs.rb

@@ -0,0 +1,16 @@
+module EDSL
+  module PageObject
+    module Javascript
+
+      module AngularJS
+        #
+        # return the number of pending ajax requests
+        #
+        def self.pending_requests
+          'return angular.element(document.body).injector().get(\'$http\').pendingRequests.length;'
+        end
+      end
+
+    end
+  end
+end

data/lib/edsl/page_object/javascript/jquery.rb

@@ -0,0 +1,16 @@
+module EDSL
+  module PageObject
+    module Javascript
+
+      module JQuery
+        #
+        # return the number of pending ajax requests
+        #
+        def self.pending_requests
+          'return jQuery.active'
+        end
+      end
+
+    end
+  end
+end

data/lib/edsl/page_object/javascript/prototype.rb

@@ -0,0 +1,16 @@
+module EDSL
+  module PageObject
+    module Javascript
+
+      module Prototype
+        #
+        # return the number of pending ajax requests
+        #
+        def self.pending_requests
+          'return Ajax.activeRequestCount'
+        end
+      end
+
+    end
+  end
+end

data/lib/edsl/page_object/javascript/yui.rb

@@ -0,0 +1,21 @@
+module EDSL
+  module PageObject
+    module Javascript
+
+      module YUI
+        #
+        # return the number of pending ajax requests
+        #
+        def self.pending_requests
+          "var inProgress=0
+         for(var i=0; i < YAHOO.util.Connect._transaction_id; i++) {
+           if(YAHOO.util.Connect.isCallInProgress(i))
+             inProgress++;
+         }
+         return inProgress;"
+        end
+      end
+
+    end
+  end
+end

data/lib/edsl/page_object/page.rb

@@ -12,6 +12,7 @@ module EDSL
     #
     class Page < ::EDSL::ElementContainer
       include EDSL::PageObject::Population
+      include EDSL::PageObject::AJAX
       extend EDSL::PageObject::Visitable
 
       attr_accessor :page_ready_limit

data/lib/edsl/page_object/population.rb

@@ -22,14 +22,14 @@ module EDSL
 
       # Returns the currently defined fixture fetch function or a lambda that returns nil
       def self.fixture_fetcher
-        @@fixture_fetcher = lambda.new { |_key| nil }
+        @@fixture_fetcher ||= lambda { |_key| nil }
       end
 
       # Fetch a value from our fixtures using a key.
       #
       # @param key [String, Symbol] What to fetch
       def fixture_fetch(key)
-        ff = fixture_fetcher
+        ff = EDSL::PageObject::Population.fixture_fetcher
         return ff.call(key) if ff.is_a?(Proc)
         send(ff, key)
       end
@@ -65,6 +65,10 @@ module EDSL
       def populate_key
         self.class.to_s.snakecase
       end
+
+      def populate
+        populate_with(fixture_fetch(populate_key))
+      end
     end
   end
 end

data/lib/edsl/page_object/section.rb

@@ -9,6 +9,8 @@ module EDSL
     #
     class Section < ElementContainer
       include EDSL::PageObject::Population
+      include EDSL::PageObject::AJAX
+
       # Create a new section
       def initialize(element, parent)
         super(element, parent)
@@ -35,8 +37,8 @@ module EDSL
 
       def sections(name, section_class, opts)
         i_sel = opts.delete(:item)
-        item_how = i_sel.delete(:how)
-        default_method = lambda { |_name, container| container.send(item_how, i_sel).map { |i| section_class.new(i, self) } }
+        item_how = i_sel.delete(:how) || :divs
+        default_method = lambda { |_name, container| container.send("#{name}_element").send(item_how, i_sel).map { |i| section_class.new(i, self) } }
         element(name, { how: :div,
                         default_method:  default_method }.merge(opts))
       end

data/lib/edsl/page_object/version.rb

@@ -1,5 +1,5 @@
 module EDSL
   module PageObject
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/edsl/page_object/visitation.rb

@@ -29,7 +29,6 @@ module EDSL
           erb           = ::ERB.new(%Q{#{lookup}})
           merged_params = self.class.instance_variable_get("@merged_params")
           params        = merged_params ? merged_params : self.class.params
-          binding.pry
           erb.result(binding)
         end
       end
@@ -79,6 +78,11 @@ module EDSL
       # Support 'on' for readability of usage
       alias_method :on, :on_page
 
+      def on_current_page(&block)
+        yield @current_page if block
+        @current_page
+      end
+
       #
       # Create a page object if and only if the current page is the same page to be created
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edsl-pageobject
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Donavan Stanley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,6 +157,11 @@ files:
 - edsl-pageobject.gemspec
 - examples/google_search
 - lib/edsl/page_object.rb
+- lib/edsl/page_object/ajax_support.rb
+- lib/edsl/page_object/javascript/angularjs.rb
+- lib/edsl/page_object/javascript/jquery.rb
+- lib/edsl/page_object/javascript/prototype.rb
+- lib/edsl/page_object/javascript/yui.rb
 - lib/edsl/page_object/page.rb
 - lib/edsl/page_object/population.rb
 - lib/edsl/page_object/section.rb