unobtainium 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c48a4bbdaf69ce31be6eb42f8a10bd4af462fafb
-  data.tar.gz: f4f811e06460e1a124769e97dadb0d79de82ba93
+  metadata.gz: 7a47708be130d105fbf6be7bbdd7f00406882929
+  data.tar.gz: 81128ec3068eb4e880c7b314e6c7cd2e3d7d6c3a
 SHA512:
-  metadata.gz: 2582d432e5fc1c6d35cacee66c8eb71ec87437313f1ab3f8706dd457d4925ccb07cac952e535bba1898eb8e1e6b9cb1becaf3e90f2ab36d78c1a2d33e97ab575
-  data.tar.gz: 9e610ebc5b157cb7828a4be8f7208687b8df5acb2ebd7ee9f023173132dd3a0c4d285d1eaf725ea8f2b13ca6c7c2b0c41c71aec11fca49a41082303081ba8e0b
+  metadata.gz: 2ffd14ee0d6b4958e4238a437530726e3ed18d278f8ff462db70d2a58b63f7e2423bee73aa958358fcccd85fd2f673f389d34dceab480464b6d94a0c420305c3
+  data.tar.gz: be670c898c0fff253dc79bd3e8ff3841d44ebac6e7b494d6a6d9a7e873c545acb8e32d8a2b0477f4e99b840f6bf31d139a148dc2f44c32ca3bdeb22b82bf0e26

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unobtainium (0.9.0)
+    unobtainium (0.10.0)
       collapsium (~> 0.8)
       collapsium-config (~> 0.4)
       ptools (~> 1.3)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    appium_lib (8.1.0)
+    appium_lib (8.2.1)
       awesome_print (~> 1.6)
       json (~> 1.8)
       nokogiri (~> 1.6.6)
@@ -28,7 +28,7 @@ GEM
       nokogiri (~> 1.6)
     codeclimate-test-reporter (1.0.3)
       simplecov
-    collapsium (0.8.0)
+    collapsium (0.8.2)
     collapsium-config (0.4.3)
       collapsium (~> 0.7)
     cucumber (2.4.0)
@@ -53,7 +53,7 @@ GEM
     multi_test (0.1.2)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-    parser (2.3.2.0)
+    parser (2.3.3.1)
       ast (~> 2.2)
     phantomjs (2.1.1.0)
     powerpack (0.1.1)
@@ -73,7 +73,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.45.0)
+    rubocop (0.46.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
@@ -108,7 +108,7 @@ DEPENDENCIES
   phantomjs
   rake (~> 11.3)
   rspec (~> 3.5)
-  rubocop (~> 0.45)
+  rubocop (~> 0.46)
   selenium-webdriver
   simplecov (~> 0.12)
   unobtainium!

data/features/step_definitions/steps.rb

@@ -7,6 +7,51 @@
 # All rights reserved.
 #
 
+def store_ids(the_driver = driver)
+  @driver_ids ||= []
+  @driver_ids << the_driver.object_id
+
+  @driver_impl_ids ||= []
+  @driver_impl_ids << the_driver.impl.object_id
+end
+
+Given(/^I have no driver IDs stored$/) do
+  @driver_ids = []
+  @driver_impl_ids = []
+end
+
 Given(/^I navigate to the best website in the world$/) do
   driver.navigate.to "http://finkhaeuser.de"
+  store_ids
+end
+
+When(/^I navigate to the best website in the world again$/) do
+  driver.navigate.to "http://finkhaeuser.de"
+  store_ids
+end
+
+Then(/^I expect the driver in each case to be the same$/) do
+  if not @driver_ids[0] == @driver_ids[1]
+    raise "Driver instance changed!"
+  end
+  if not @driver_impl_ids[0] == @driver_impl_ids[1]
+    raise "Driver implementation instance changed!"
+  end
+end
+
+When(
+    /^I navigate to the best website in the world with another driver instance$/
+) do
+  new_driver = driver(:headless, desired_capabilities: { something: :new })
+  new_driver.navigate.to "http://finkhaeuser.de"
+  store_ids(new_driver)
+end
+
+Then(/^I expect to have two driver instances$/) do
+  if @driver_ids[0] == @driver_ids[1]
+    raise "Driver instance the same!"
+  end
+  if @driver_impl_ids[0] == @driver_impl_ids[1]
+    raise "Driver implementation instance the same!"
+  end
 end

data/features/world.feature

@@ -1,4 +1,17 @@
 Feature: World
 
+  Background:
+    Given I have no driver IDs stored
+
   Scenario: Driver and configuration loading
     Given I navigate to the best website in the world
+
+  Scenario: Driver re-use
+    Given I navigate to the best website in the world
+    When I navigate to the best website in the world again
+    Then I expect the driver in each case to be the same
+
+  Scenario: Multiple drivers
+    Given I navigate to the best website in the world
+    When I navigate to the best website in the world with another driver instance
+    Then I expect to have two driver instances

data/lib/unobtainium/version.rb

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

data/lib/unobtainium/world.rb

@@ -72,6 +72,52 @@ module Unobtainium
     # Returns a driver instance with the given options. If no options are
     # provided, options from the global configuration are used.
     def driver(label = nil, options = nil)
+      # Resolve unique options
+      label, options = resolve_options(label, options)
+
+      # Create a key for the label and options. This should always
+      # return the same key for the same label and options.
+      key = options['unobtainium_instance_id']
+      if key.nil?
+        key = identifier('driver', label, options)
+      end
+
+      # Only create a driver with this exact configuration once. Unfortunately
+      # We'll have to bind the destructor to whatever configuration exists at
+      # this point in time, so we have to create a proc here - whether the Driver
+      # gets created or not.
+      at_end = config.fetch("at_end", "quit")
+      dtor = proc do |the_driver|
+        # :nocov:
+        if the_driver.nil?
+          return
+        end
+
+        # We'll rescue Exception here because we really want all destructors
+        # to run.
+        # rubocop:disable Lint/RescueException
+        begin
+          meth = at_end.to_sym
+          the_driver.send(meth)
+        rescue Exception => err
+          puts "Exception in destructor: [#{err.class}] #{err}"
+        end
+        # rubocop:enable Lint/RescueException
+        # :nocov:
+      end
+      return ::Unobtainium::Runtime.instance.store_with_if(key, dtor) do
+        ::Unobtainium::Driver.create(label, options)
+      end
+    end
+
+    private
+
+    ##
+    # World's own option resolution ensures that the same options always get
+    # resolved the same, by storing anything resolved from Driver in the Runtime
+    # instance (i.e. asking the Driver only once per unique set of label and
+    # options).
+    def resolve_options(label, options)
       # Make sure we have a label for the driver
       if label.nil?
         label = config["driver"]
@@ -106,35 +152,21 @@ module Unobtainium
         options.delete("base")
       end
 
-      # The driver may modify the options; if so, we should let it do that
-      # here. That way our key (below) is based on the expanded options.
-      label, options, _ = ::Unobtainium::Driver.resolve_options(label, options)
-
-      # Create a key for the label and options. This should always
-      # return the same key for the same label and options.
-      key = options['unobtainum_instance_id']
-      if key.nil?
-        key = identifier('driver', label, options)
+      # Do we have options already resolved?
+      option_key = identifier('options', label, options)
+      begin
+        stored_opts = ::Unobtainium::Runtime.instance.fetch(option_key)
+        options = ::Collapsium::UberHash.new(options)
+        options.recursive_merge!(stored_opts)
+      rescue KeyError
+        label, options, _ = ::Unobtainium::Driver.resolve_options(label, options)
       end
 
-      # Only create a driver with this exact configuration once. Unfortunately
-      # We'll have to bind the destructor to whatever configuration exists at
-      # this point in time, so we have to create a proc here - whether the Driver
-      # gets created or not.
-      at_end = config.fetch("at_end", "quit")
-      dtor = proc do |the_driver|
-        # :nocov:
-        if the_driver.nil?
-          return
-        end
+      # The driver may modify the options; if so, we should let it do that
+      # here. That way our key (below) is based on the expanded options.
+      ::Unobtainium::Runtime.instance.store(option_key, options)
 
-        meth = at_end.to_sym
-        the_driver.send(meth)
-        # :nocov:
-      end
-      return ::Unobtainium::Runtime.instance.store_with_if(key, dtor) do
-        ::Unobtainium::Driver.create(label, options)
-      end
+      return label, options
     end
   end # module World
 end # module Unobtainium

data/spec/driver_spec.rb

@@ -13,8 +13,7 @@ module TestModule
     end
   end # class << self
 
-  def my_module_func
-  end
+  def my_module_func; end
 end # module TestModule
 
 module NonMatchingTestModule
@@ -25,8 +24,7 @@ module NonMatchingTestModule
     end
   end # class << self
 
-  def does_not_exist
-  end
+  def does_not_exist; end
 end # module NonMatchingTestModule
 
 module FakeModule

data/spec/drivers_phantom_spec.rb

@@ -137,6 +137,16 @@ describe ::Unobtainium::Drivers::Phantom do
         expect(resolved['unobtainium_instance_id']).not_to be_nil
       end
 
+      context "defaults" do
+        it "generates the same ID and port if no input is given" do
+          _, resolved1 = tester.resolve_options(:phantomjs, nil)
+          expect(resolved1['phantomjs.generated_port']).to eql 9134
+
+          _, resolved2 = tester.resolve_options(:phantomjs, nil)
+          expect(resolved2['phantomjs.generated_port']).to eql 9134
+        end
+      end
+
       it "generates new IDs for new options" do
         opts = ::Collapsium::UberHash.new(
           phantomjs: {

data/spec/mock_driver.rb

@@ -4,6 +4,8 @@ class Mock
   def initialize(opts)
     @passed_options = opts
   end
+
+  def quit; end
 end
 
 # rubocop:disable Style/GuardClause

data/unobtainium.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
                        "'phantomjs'"
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rubocop", "~> 0.45"
+  spec.add_development_dependency "rubocop", "~> 0.46"
   spec.add_development_dependency "rake", "~> 11.3"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "simplecov", "~> 0.12"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0.46'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0.46'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement