selenium_page 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab847fdc76365d1ffd7c7fb59a4088b87cfaa5b66745051e644905ef836be483
-  data.tar.gz: 459b3d3fea8f2ebcad887c082742100d994fc0cceb66e319bd986f28bb9057dd
+  metadata.gz: 44333331ba09a124b736b5ed176f43b35090ceeded473e6e81b0656d35d962e5
+  data.tar.gz: 114e74733a9d2750efe7adb8e4122b74178fa54515f287283d47641083d5e161
 SHA512:
-  metadata.gz: 7110393c893d10dd01cfeef086b9e8565ce20fbff1b16fc2d4eeee7474352317bb3420e6f7d630f2326dd0a631fac14422d44dea238596e73153f07093aa04a5
-  data.tar.gz: fb9cf871cf2c2f8f468208acb16eaff57734e40946bb8fe79811cb8361fb5d2fc00212b44ad268d32d39b4d8c2ebc9468b51c0814b90c1637a741c3697c39cb0
+  metadata.gz: a109add0a1cfc701c6f717950b4327ce8b2c93a92a07802c85502577cdb8b2f9ea46dada96803aeeda8d52bfc2d523245c7925216c869fb0061dac5be6e35b72
+  data.tar.gz: 0b5d748859aafa12be5cbaafbe5e79a94687813c6109a6ec591ced13c71cce3d46b0ffcd9dbe04d68441cf2ceecd1b6fbd772ea00ad3e3e10c4a19ffc4a9e82f

data/lib/selenium_page.rb

@@ -7,6 +7,9 @@ require 'selenium-webdriver'
 module SeleniumPage
   require_relative 'selenium_page/errors'
   require_relative 'selenium_page/page'
+  require_relative 'selenium_page/element'
+
+  @wait_time = 10
 
   def self.configure_scheme_and_authority(scheme_and_authority)
     unless scheme_and_authority.is_a? String
@@ -19,4 +22,14 @@ module SeleniumPage
   def self.scheme_and_authority
     @scheme_and_authority
   end
+
+  def self.configure_wait_time(wait_time)
+    raise Errors::UnexpectedWaitTime unless wait_time.is_a? Numeric
+
+    @wait_time = wait_time
+  end
+
+  def self.wait_time
+    @wait_time
+  end
 end

data/lib/selenium_page/element.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module SeleniumPage
+  # Element
+  class Element
+    require_relative 'element/errors'
+
+    def initialize(driver, base_element)
+      raise Errors::WrongDriver unless driver.is_a? Selenium::WebDriver::Driver
+      unless base_element.is_a? Selenium::WebDriver::Element
+        raise Errors::WrongBaseElement
+      end
+
+      @driver = driver
+      @base_element = base_element
+    end
+
+    attr_reader :driver
+    attr_reader :base_element
+
+    def method_missing(called_method, *args, &block)
+      # FIXME: should this catch some specific methods (to_s ?) ?
+      if base_element.respond_to?(called_method)
+        base_element.send(called_method, *args, &block)
+      else
+        super
+      end
+    end
+
+    # this fix the calls to :respond_to? in case of delegation to base_element
+    # the method will stay private
+    # rubocop best practice suggestion
+    def respond_to_missing?(called_method, *)
+      base_element.respond_to?(called_method) || super
+    end
+
+    def add_childrens(parent_selector, &block)
+      @parent_selector = parent_selector
+      instance_exec(&block) if block_given?
+    end
+
+    def element(element_name, element_selector, &block)
+      define_singleton_method(element_name) do
+        selector = @parent_selector + ' ' + element_selector
+        if block_given?
+          find_element(selector, &block)
+        else
+          find_element(selector)
+        end
+      end
+    end
+
+    def elements(collection_name, collection_selector, &block)
+      define_singleton_method(collection_name) do
+        selector = @parent_selector + ' ' + collection_selector
+        if block_given?
+          find_elements(selector, &block)
+        else
+          find_elements(selector)
+        end
+      end
+    end
+
+    private
+
+    def find_element(element_selector,
+                     waiter = Selenium::WebDriver::Wait.new(
+                       timeout: SeleniumPage.wait_time
+                     ), &block)
+      waiter.until do
+        result = SeleniumPage::Element.new(
+          @driver, @driver.find_element(:css, element_selector)
+        )
+        result.add_childrens(element_selector, &block)
+        result
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def find_elements(collection_selector,
+                      waiter = Selenium::WebDriver::Wait.new(
+                        timeout: SeleniumPage.wait_time
+                      ), &block)
+      waiter.until do
+        selenium_result = @driver.find_elements(:css, collection_selector)
+        result = []
+        selenium_result.each do |selenium_element|
+          result << SeleniumPage::Element.new(@driver, selenium_element)
+        end
+        result.each do |selenium_page_element|
+          selenium_page_element.add_childrens(collection_selector, &block)
+        end
+        result
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/selenium_page/element/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SeleniumPage
+  # Page
+  class Element
+    # Errors
+    class Errors
+      # WrongBaseElement
+      class WrongBaseElement < StandardError
+        def message
+          "Only 'Selenium::WebDriver::Element' are accepted " \
+          'as base_element parameter'
+        end
+      end
+
+      # WrongDriver
+      class WrongDriver < StandardError
+        def message
+          "Only 'Selenium::WebDriver::Driver' are accepted as driver parameter"
+        end
+      end
+    end
+  end
+end

data/lib/selenium_page/errors.rb

@@ -9,5 +9,12 @@ module SeleniumPage
         "Only 'String' are accepted"
       end
     end
+
+    # UnexpectedWaitTime
+    class UnexpectedWaitTime < StandardError
+      def message
+        "Only 'Numeric' are accepted"
+      end
+    end
   end
 end

data/lib/selenium_page/page.rb

@@ -15,10 +15,48 @@ module SeleniumPage
       @url
     end
 
+    # rubocop:disable Metrics/MethodLength
+    def self.element(element_name, element_selector, &block)
+      raise Errors::UnexpectedElementName unless element_name.is_a? Symbol
+      unless element_selector.is_a? String
+        raise Errors::UnexpectedElementSelector
+      end
+      if instance_methods.include?(element_name)
+        raise Errors::AlreadyDefinedElementName, element_name
+      end
+
+      define_method(element_name) do
+        if block_given?
+          find_element(element_selector, &block)
+        else
+          find_element(element_selector)
+        end
+      end
+    end
+
+    def self.elements(collection_name, collection_selector, &block)
+      raise Errors::UnexpectedElementName unless collection_name.is_a? Symbol
+      unless collection_selector.is_a? String
+        raise Errors::UnexpectedElementSelector
+      end
+      if instance_methods.include?(collection_name)
+        raise Errors::AlreadyDefinedElementName, collection_name
+      end
+
+      define_method(collection_name) do
+        if block_given?
+          find_elements(collection_selector, &block)
+        else
+          find_elements(collection_selector)
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
     def initialize(driver)
       raise Errors::WrongDriver unless driver.is_a? Selenium::WebDriver::Driver
 
-      @page = driver
+      @driver = driver
     end
 
     def url
@@ -31,7 +69,41 @@ module SeleniumPage
       scheme_and_authority = SeleniumPage.scheme_and_authority
       raise Errors::SchemeAndAuthorityNotSet unless scheme_and_authority
 
-      @page.get scheme_and_authority + self.class.url
+      @driver.get scheme_and_authority + self.class.url
+    end
+
+    private
+
+    def find_element(element_selector,
+                     waiter = Selenium::WebDriver::Wait.new(
+                       timeout: SeleniumPage.wait_time
+                     ), &block)
+      waiter.until do
+        result = SeleniumPage::Element.new(
+          @driver, @driver.find_element(:css, element_selector)
+        )
+        result.add_childrens(element_selector, &block)
+        result
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def find_elements(collection_selector,
+                      waiter = Selenium::WebDriver::Wait.new(
+                        timeout: SeleniumPage.wait_time
+                      ), &block)
+      waiter.until do
+        selenium_result = @driver.find_elements(:css, collection_selector)
+        result = []
+        selenium_result.each do |selenium_element|
+          result << SeleniumPage::Element.new(@driver, selenium_element)
+        end
+        result.each do |selenium_page_element|
+          selenium_page_element.add_childrens(collection_selector, &block)
+        end
+        result
+      end
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/selenium_page/page/errors.rb

@@ -5,6 +5,17 @@ module SeleniumPage
   class Page
     # Errors
     class Errors
+      # AlreadyDefinedElementName
+      class AlreadyDefinedElementName < StandardError
+        def initialize(element_name)
+          @element_name = element_name
+        end
+
+        def message
+          "The element '#{@element_name}' is already defined"
+        end
+      end
+
       # SchemeAndAuthorityNotSet
       class SchemeAndAuthorityNotSet < StandardError
         def message
@@ -13,6 +24,20 @@ module SeleniumPage
         end
       end
 
+      # UnexpectedElementName
+      class UnexpectedElementName < StandardError
+        def message
+          "Only 'Symbol' are accepted as element_name parameter"
+        end
+      end
+
+      # UnexpectedElementSelector
+      class UnexpectedElementSelector < StandardError
+        def message
+          "Only 'String' are accepted as element_selector parameter"
+        end
+      end
+
       # UnexpectedUrl
       class UnexpectedUrl < StandardError
         def message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_page
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Massimiliano De Vivo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: chromedriver-helper
   requirement: !ruby/object:Gem::Requirement
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -96,20 +96,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.56.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.56.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.56.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.56.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.27.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +180,8 @@ files:
 - LICENSE.md
 - README.md
 - lib/selenium_page.rb
+- lib/selenium_page/element.rb
+- lib/selenium_page/element/errors.rb
 - lib/selenium_page/errors.rb
 - lib/selenium_page/page.rb
 - lib/selenium_page/page/errors.rb