unobtainium 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3149f2511fbd2ecbbd5af9d19bb097251bdcac9
-  data.tar.gz: 95e5ab479135ada464f851c6ebaaea775033d440
+  metadata.gz: d69617dc2a12c35e334b4d4e85b680237aef970c
+  data.tar.gz: fed5f537d65ca9dfe6c5282e6ed5eae2701414a9
 SHA512:
-  metadata.gz: 3a8d32ef7e4162537270294802f1c57ad6a18e736b5c6d0a93dba3e586b8c54d18d184ae611a3892da14cb4c76b28cc4c10ee8d646f3bd4b2b4310000b973bca
-  data.tar.gz: 19c21152cb0c4b0268695cdb577f230da3c42994f48b2b457d29df8a8e5e733c8f5d3b3abb81c7ae9d8e6496694ef7b17b3f5c42e51b0f5d7e653ec539b30f75
+  metadata.gz: 94ec3a3a6520ddfa7a24349c92c50ff603a34afe62a24e0b8bb7e82668e4181f2aaf1d23dc1d84dbfec66b9327628520d48055ed16e0a213cf3b682531d90496
+  data.tar.gz: 964c731c3fc82ff0c0357ed7f43b0aabbba5ec2d02425180ee0ee3672ff505763391ab8ad796bb5ee7d207d7a3c5008a4e5cf465b312c71bea24cf251f3aab55

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    unobtainium (0.6.0)
+    unobtainium (0.7.0)
+      collapsium (~> 0.3)
       collapsium-config (~> 0.1)
-      sys-proctable (~> 1.0)
+      ptools (~> 1.3)
+      sys-proctable (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -14,78 +16,87 @@ GEM
       nokogiri (~> 1.6.6)
       selenium-webdriver (~> 2.49)
       tomlrb (~> 1.1)
-    ast (2.2.0)
-    awesome_print (1.6.1)
+    archive-zip (0.7.0)
+      io-like (~> 0.3.0)
+    ast (2.3.0)
+    awesome_print (1.7.0)
     builder (3.2.2)
     childprocess (0.5.9)
       ffi (~> 1.0, >= 1.0.11)
-    codeclimate-test-reporter (0.5.0)
+    chromedriver-helper (1.0.0)
+      archive-zip (~> 0.7.0)
+      nokogiri (~> 1.6)
+    codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
-    collapsium (0.1.0)
+    collapsium (0.3.0)
     collapsium-config (0.1.1)
       collapsium (~> 0.1)
-    cucumber (2.3.3)
+    cucumber (2.4.0)
       builder (>= 2.1.2)
-      cucumber-core (~> 1.4.0)
+      cucumber-core (~> 1.5.0)
       cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 3.2.0)
+      gherkin (~> 4.0)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
-    cucumber-core (1.4.0)
-      gherkin (~> 3.2.0)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
     cucumber-wire (0.0.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    ffi (1.9.10)
-    gherkin (3.2.0)
+    ffi (1.9.14)
+    gherkin (4.0.0)
+    io-like (0.3.0)
     json (1.8.3)
-    mini_portile2 (2.0.0)
-    multi_json (1.12.0)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
     multi_test (0.1.2)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    parser (2.3.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    parser (2.3.1.2)
       ast (~> 2.2)
     phantomjs (2.1.1.0)
+    pkg-config (1.1.7)
     powerpack (0.1.1)
+    ptools (1.3.3)
     rainbow (2.1.0)
-    rake (11.1.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubocop (0.40.0)
-      parser (>= 2.3.1.0, < 3.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.41.2)
+      parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.0)
+    ruby-progressbar (1.8.1)
     rubyzip (1.2.0)
-    selenium-webdriver (2.53.0)
+    selenium-webdriver (2.53.4)
       childprocess (~> 0.5)
       rubyzip (~> 1.0)
       websocket (~> 1.0)
-    simplecov (0.11.2)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sys-proctable (1.0.0)
-    tomlrb (1.2.1)
-    unicode-display_width (1.0.5)
+    sys-proctable (1.1.1)
+    tomlrb (1.2.2)
+    unicode-display_width (1.1.0)
     websocket (1.2.3)
-    yard (0.8.7.6)
+    yard (0.9.0)
 
 PLATFORMS
   ruby
@@ -93,16 +104,17 @@ PLATFORMS
 DEPENDENCIES
   appium_lib
   bundler (~> 1.12)
+  chromedriver-helper
   codeclimate-test-reporter
   cucumber
   phantomjs
-  rake (~> 11.1)
-  rspec (~> 3.4)
-  rubocop (~> 0.40)
+  rake (~> 11.2)
+  rspec (~> 3.5)
+  rubocop (~> 0.41)
   selenium-webdriver
-  simplecov (~> 0.11)
+  simplecov (~> 0.12)
   unobtainium!
-  yard (~> 0.8)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   1.12.3
+   1.12.5

data/README.md

@@ -29,16 +29,6 @@ You can use unobtainium on its own, or use it as part of a
 Unobtainium's functionality is in standalone classes, but it's all combined in
 the `Unobtainium::World` module.
 
-- The `PathedHash` class extends `Hash` by allowing paths to nested values, e.g.:
-
-    ```ruby
-    h = PathedHash.new { "foo" => { "bar" => 42 }}
-    h["foo.bar"] == 42 # true
-    ```
-
-- The `Config` class is a `PathedHash`, but also reads JSON or YAML files to
-  initialize itself with values. See the documentation on [configuration features](docs/CONFIGURATION.md)
-  for details.
 - The `Runtime` class is a singleton and a `Hash`-like container (but simpler),
   that destroys all of its contents at the end of a script, calling custom
   destructors if required. That allows for clean teardown and avoids everything
@@ -53,6 +43,9 @@ the `Unobtainium::World` module.
     drv.navigate.to "..." # delegates to Selenium or Appium
     ```
 
+See the documentation on [configuration features](docs/CONFIGURATION.md) for
+details on configuration.
+
 ## World
 
 The World module combines all of the above by providing a simple entry point

data/lib/unobtainium/drivers/appium.rb

@@ -7,6 +7,8 @@
 # All rights reserved.
 #
 
+require 'collapsium'
+
 require_relative '../support/util'
 
 module Unobtainium
@@ -19,7 +21,6 @@ module Unobtainium
     class Appium
       # Recognized labels for matching the driver
       LABELS = {
-        appium: [],
         ios: [:iphone, :ipad],
         android: [],
       }.freeze
@@ -57,18 +58,31 @@ module Unobtainium
         ##
         # Sanitize options, and expand the :browser key, if present.
         def resolve_options(label, options)
-          # The label specifies the platform, if no other platform is given.
+          # Normalize label and options
           normalized = normalize_label(label)
+          options = ::Collapsium::UberHash.new(options || {})
 
-          if not options.is_a? Hash
-            options = {}
-          end
-          if not options['caps'].is_a? Hash
-            options['caps'] = {}
+          # Merge 'caps' and 'desired_capabilities', letting the former win
+          options[:caps] =
+            ::Collapsium::UberHash.new(options[:desired_capabilities])
+                                  .recursive_merge(options[:caps])
+          options.delete(:desired_capabilities)
+          options.delete('desired_capabilities')
+
+          # The label specifies the platform, if no other platform is given.
+          if options['caps.platformName']
+            options['caps.platformName'] = normalized.to_s
           end
 
-          if options['caps']['platformName'].nil?
-            options['caps']['platformName'] = normalized.to_s
+          # Make the appium driver behave a little more like Selenium by using
+          # the :url key if the normalized label is remote, and setting
+          # appropriate options.
+          set_url = options['appium_lib.server_url']
+          if set_url and not set_url == options['url']
+            warn "You have the remote URL '#{set_url}' set in your options, "\
+              "so we're not replacing it with '#{options['url']}'!"
+          else
+            options['appium_lib.server_url'] = options['url']
           end
 
           # If no app is given, but a browser is requested, we can supplement
@@ -99,7 +113,7 @@ module Unobtainium
           browser = options['browser'].downcase.to_sym
 
           # Platform
-          platform = options['caps']['platformName'].to_s.downcase.to_sym
+          platform = options['caps.platformName'].to_s.downcase.to_sym
 
           # If we have supplement data matching the platform and browser, great!
           data = BROWSER_MATCHES[platform][browser]
@@ -109,12 +123,9 @@ module Unobtainium
 
           # We do have to check that we're not overwriting any of the keys.
           data.each do |key, value|
-            key_s = key.to_s
             option_value = nil
             if options['caps'].key?(key)
               option_value = options['caps'][key]
-            elsif options['caps'].key?(key_s)
-              option_value = options['caps'][key_s]
             end
 
             if option_value.nil? or option_value == value

data/lib/unobtainium/drivers/selenium.rb

@@ -7,6 +7,8 @@
 # All rights reserved.
 #
 
+require 'collapsium'
+
 require_relative '../support/util'
 
 module Unobtainium
@@ -22,10 +24,17 @@ module Unobtainium
         firefox: [:ff,],
         internet_explorer: [:internetexplorer, :explorer, :ie,],
         safari: [],
-        chrome: [:chromium],
-        remote: [],
+        chrome: [],
+        chromium: [],
       }.freeze
 
+      # When :chromium is selected, search for these executables. The
+      # resulting label will be :chrome, but with an executable path
+      # set in the options.
+      CHROMIUM_EXECUTABLES = [
+        'chromium-browser'
+      ].freeze
+
       class << self
         include ::Unobtainium::Support::Utility
 
@@ -49,15 +58,23 @@ module Unobtainium
         ##
         # Selenium really wants symbol keys for the options
         def resolve_options(label, options)
-          new_opts = {}
+          # Normalize label and options
+          normalized = normalize_label(label)
+          options = ::Collapsium::UberHash.new(options || {})
 
-          if not options.nil?
-            options.each do |key, value|
-              new_opts[key.to_sym] = value
-            end
-          end
+          # Merge 'caps' and 'desired_capabilities', letting the latter win
+          options[:desired_capabilities] =
+            ::Collapsium::UberHash.new(options[:caps])
+                                  .recursive_merge(options[:desired_capabilities])
+          options.delete(:caps)
+          options.delete('caps')
+
+          # Chromium is chrome, but with a different binary. Help with that.
+          label, options = supplement_chromium(normalized, options)
 
-          options = new_opts
+          # Selenium expects the first level keys to be symbols *only*, so
+          # indifferent access from UberHash isn't good. We have to fix that.
+          options = fix_options(options)
 
           return label, options
         end
@@ -68,6 +85,61 @@ module Unobtainium
           driver = ::Selenium::WebDriver.for(normalize_label(label), options)
           return driver
         end
+
+        private
+
+        ##
+        # If the driver was :chromium, try to use the :chrome driver with
+        # options pointing to the chromium binary.
+        def supplement_chromium(label, options)
+          # Only applies to :chromium
+          if :chromium != label
+            return label, options
+          end
+
+          # Try to find a chromium binary
+          binary = nil
+          require 'ptools'
+          CHROMIUM_EXECUTABLES.each do |name|
+            location = File.which(name)
+            if not location.nil?
+              binary = location
+              break
+            end
+          end
+
+          # If we found a chromium binary, we can modify the options.
+          # Otherwise, we don't do a thing and let selenium fail.
+          if binary.nil?
+            return label, options
+          end
+
+          set_binary = options['desired_capabilities.chromeOptions.binary']
+          if set_binary and not set_binary == binary
+            # There's already a binary set. We should warn about this, but
+            # otherwise leave this choice.
+            warn "You have the chrome binary '#{set_binary}' set in your "\
+              "options, so we're not replacing it with '#{binary}'!"
+          else
+            options['desired_capabilities.chromeOptions.binary'] = binary
+          end
+
+          # Selenium doesn't recognize :chromium, but :chrome with the above
+          # options works.
+          return :chrome, options
+        end
+
+        # Selenium expects the first level keys to be symbols *only*, so
+        # indifferent access from UberHash isn't good. We have to fix that.
+        def fix_options(options)
+          result = {}
+
+          options.each do |key, value|
+            result[key.to_sym] = value
+          end
+
+          return result
+        end
       end # class << self
     end # class Selenium
 

data/lib/unobtainium/version.rb

@@ -8,5 +8,5 @@
 #
 module Unobtainium
   # The current release version
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/unobtainium.gemspec

@@ -43,17 +43,20 @@ Gem::Specification.new do |spec|
                        "'phantomjs'"
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rubocop", "~> 0.40"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "simplecov", "~> 0.11"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "rubocop", "~> 0.41"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+  spec.add_development_dependency "yard", "~> 0.9"
   spec.add_development_dependency "appium_lib"
   spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "chromedriver-helper"
   spec.add_development_dependency "phantomjs"
   spec.add_development_dependency "cucumber"
 
-  spec.add_dependency "sys-proctable", "~> 1.0"
+  spec.add_dependency "sys-proctable", "~> 1.1"
+  spec.add_dependency "ptools", "~> 1.3"
+  spec.add_dependency "collapsium", "~> 0.3"
   spec.add_dependency "collapsium-config", "~> 0.1"
 end
 # rubocop:enable Style/SpaceAroundOperators

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0.41'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0.41'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !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.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: appium_lib
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: phantomjs
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +170,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: collapsium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: collapsium-config
   requirement: !ruby/object:Gem::Requirement