site_prism 2.11 → 2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e194be3ee7349ee99bb8704a35acca0d4bf963d9
-  data.tar.gz: 584fc98753ee4abfd4bbd1e220b537dfd2a10280
+  metadata.gz: 486bfe34bc7f4ab7dedc373ffdb850d146c731d8
+  data.tar.gz: 324a724708c627fbc2242bc783ac80a1626472e0
 SHA512:
-  metadata.gz: 4a6eb96791b4c5be970baa67ed782a14744066284ca8053fd0832ddf78325dc95aaedf5c97a488ef1e041b999d28e91b048c5be226d89a2c6308de15ec561d66
-  data.tar.gz: bad1b3076a2ca4a4b40430228d806dfc1e22a127f23451c46f2976c89fed03e8f9a804357dc6cb2244e4d158022edd3687b1efef180542317c631145f556f264
+  metadata.gz: 62687b2613246d5f2a9afc1623d961ec43249439dbb9f7d391758c723832a587524cd617e4893bdf53405ac42aed942656892eb4269d7a1092d08245573e2796
+  data.tar.gz: c8065b3bb3cd831bb3ee12e975c701e9b29d998a45d8e640bca5b15c895fe4bfb18012c6fa24dba3ed40af9a53100424ffbc23c9ea212755a7a73bf195fcd60a

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2016, Nathaniel Ritmeyer
+Copyright (c) 2011-2018, Nathaniel Ritmeyer
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -11,7 +11,7 @@ Make sure to add your project/company to https://github.com/natritmeyer/site_pri
 
 ## Supported Rubies / Browsers
 
-SitePrism is built and tested to work on Ruby 2.0 - 2.4. There is also some limited support for the Ruby 1.9 series.
+SitePrism is built and tested to work on Ruby 2.1 - 2.4. There is also some limited support for the Ruby 1.9/2.0 series.
 
 SitePrism should run on all major browsers. The gem's integration tests are ran on the latest version of Firefox.
 
@@ -1517,7 +1517,7 @@ end
 To expose the iframe, reference it from another page or class using the `iframe`
 method. The `iframe` method takes 3 arguments; the name by which you
 would like to reference the iframe, the page class that represents the
-iframe, and an ID or class by which you can locate the iframe. For example:
+iframe, and the CSS selector by which you can locate the iframe. For example:
 
 ```ruby
 class PageContainingIframe < SitePrism::Page
@@ -1525,8 +1525,21 @@ class PageContainingIframe < SitePrism::Page
 end
 ```
 
-The third argument to the `iframe` method must
-contain a selector that will locate the iframe node.
+### Locating an iframe
+
+While the above example uses a CSS selector to find the iframe, it is also
+possible to use an XPath expression or the index of the iframe in its parent
+(a shortcut for an `nth-of-type` CSS selector). For example:
+
+```ruby
+class PageContainingIframe < SitePrism::Page
+  # XPath Expression:
+  iframe :my_iframe, MyIframe, :xpath, '//iframe[@id="my_iframe_id"]'
+
+  # Index (nth-of-type) Selector:
+  iframe :my_iframe, MyIframe, 0
+end
+```
 
 ### Testing for an iframe's existence
 

data/lib/site_prism/addressable_url_matcher.rb

@@ -85,7 +85,8 @@ module SitePrism
         component_url = uri.public_send(component).to_s
         extracted_mappings = component_template.extract(component_url)
         unless extracted_mappings
-          # to support Addressable's expansion of queries, ensure it's parsing the fragment as appropriate (e.g. {?params*})
+          # to support Addressable's expansion of queries
+          # ensure it's parsing the fragment as appropriate (e.g. {?params*})
           prefix = COMPONENT_PREFIXES[component]
           return nil unless prefix && (extracted_mappings = component_template.extract(prefix + component_url))
         end

data/lib/site_prism/element_container.rb

@@ -48,15 +48,15 @@ module SitePrism
       end
     end
 
-    def iframe(iframe_name, iframe_page_class, selector)
-      element_selector = deduce_iframe_element_selector(selector)
-      scope_selector = deduce_iframe_scope_selector(selector)
+    def iframe(iframe_name, iframe_page_class, *args)
+      element_find_args = deduce_iframe_element_find_args(args)
+      scope_find_args = deduce_iframe_scope_find_args(args)
       add_to_mapped_items iframe_name
-      create_existence_checker iframe_name, element_selector
-      create_nonexistence_checker iframe_name, element_selector
-      create_waiter iframe_name, element_selector
+      create_existence_checker iframe_name, *element_find_args
+      create_nonexistence_checker iframe_name, *element_find_args
+      create_waiter iframe_name, *element_find_args
       define_method iframe_name do |&block|
-        within_frame scope_selector do
+        within_frame(*scope_find_args) do
           block.call iframe_page_class.new
         end
       end
@@ -69,7 +69,8 @@ module SitePrism
 
     def raise_if_block(obj, name, has_block)
       return unless has_block
-      raise SitePrism::UnsupportedBlock, "#{obj.class}##{name} does not accept blocks, did you mean to define a (i)frame?"
+
+      raise SitePrism::UnsupportedBlock, "#{obj.class}##{name}"
     end
 
     private
@@ -168,12 +169,26 @@ module SitePrism
       end
     end
 
-    def deduce_iframe_scope_selector(selector)
-      selector.is_a?(Integer) ? selector : selector.split('#').last
+    def deduce_iframe_scope_find_args(args)
+      case args[0]
+      when Integer
+        [args[0]]
+      when String
+        [:css, args[0]]
+      else
+        args
+      end
     end
 
-    def deduce_iframe_element_selector(selector)
-      selector.is_a?(Integer) ? "iframe:nth-of-type(#{selector + 1})" : selector
+    def deduce_iframe_element_find_args(args)
+      case args[0]
+      when Integer
+        "iframe:nth-of-type(#{args[0] + 1})"
+      when String
+        [:css, args[0]]
+      else
+        args
+      end
     end
 
     def extract_section_options(args, &block)
@@ -184,7 +199,7 @@ module SitePrism
       else
         raise ArgumentError, 'You should provide section class either as a block, or as the second argument.'
       end
-      return section_class, args
+      [section_class, args]
     end
   end
 end

data/lib/site_prism/exceptions.rb

@@ -14,6 +14,12 @@ module SitePrism
   class TimeoutException < StandardError; end
   class TimeOutWaitingForElementVisibility < StandardError; end
   class TimeOutWaitingForElementInvisibility < StandardError; end
-  class UnsupportedBlock < StandardError; end
+
+  class UnsupportedBlock < StandardError
+    def message
+      "#{super} does not accept blocks, did you mean to define a (i)frame?"
+    end
+  end
+
   NotLoadedError = Class.new(StandardError)
 end

data/lib/site_prism/section.rb

@@ -17,20 +17,21 @@ module SitePrism
       Capybara.within(@root_element) { yield(self) } if block_given?
     end
 
-    def visible?
-      root_element.visible?
+    # Capybara::DSL module "delegates" Capybara methods to the "page" method
+    def page
+      root_element || Capybara.current_session
     end
 
-    def text
-      root_element.text
+    def visible?
+      page.visible?
     end
 
     def execute_script(input)
-      Capybara.current_session.execute_script input
+      Capybara.current_session.execute_script(input)
     end
 
     def evaluate_script(input)
-      Capybara.current_session.evaluate_script input
+      Capybara.current_session.evaluate_script(input)
     end
 
     def parent_page
@@ -41,16 +42,16 @@ module SitePrism
       candidate_page
     end
 
+    def native
+      root_element.native
+    end
+
     private
 
     def find_first(*find_args)
       root_element.find(*find_args)
     end
 
-    def find_all(*find_args)
-      root_element.all(*find_args)
-    end
-
     def element_exists?(*find_args)
       root_element.has_selector?(*find_args) unless root_element.nil?
     end

data/lib/site_prism/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SitePrism
-  VERSION = '2.11'.freeze
+  VERSION = '2.12'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_prism
 version: !ruby/object:Gem::Version
-  version: '2.11'
+  version: '2.12'
 platform: ruby
 authors:
 - Nat Ritmeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -67,34 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '11.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -113,30 +99,50 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.1'
 description: |-
   SitePrism gives you a simple, clean and semantic DSL for describing your site.
   SitePrism implements the Page Object Model pattern on top of Capybara.