unobtainium 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9464c7e860902fed8b6f41813261a19368aea2aa
-  data.tar.gz: f9498b642d79da6d09cbebd854bda897c6b737d1
+  metadata.gz: c5ce28fc39781ca3d3ad6b7116e93f3b194e44d2
+  data.tar.gz: 58b285e599f453331bfe7c7382158fa09d591f1e
 SHA512:
-  metadata.gz: 07d45f57984c9ffe4d7c12d8fa7a189a6e22e0638a4dab0bed898f423ba73a9ae0f484247d0c23824513bf93f3eedfc32b7e4212e6515d751611c2b1c34eaee7
-  data.tar.gz: c1378459dc8affa7f5d2a2ce96cfcf5d240b2bf45c83158be0a1d3bf81795ae5024821c99eb3cd3e00617e606cea21c6b43f7ea3eda29b70213a43c5a78f3d30
+  metadata.gz: 8e8d24aae8e1143ca3ec5a7d6043968f6c0bc6f1ced20bd35f868bf2c5ca74cc669caada417a58d23509987bdeca92e18abcc92abaa78b37d02cd936c549569f
+  data.tar.gz: 4ee5af3d346f55488f65f33929a37cc18a39c6ba42337db2ad25c94fc695d133f72975566d3c9804c5f584dd3d3a5460ce661782db5f3b7a5f72d54925dcabd5

data/.rubocop.yml

@@ -24,6 +24,9 @@ Metrics/PerceivedComplexity:
 Metrics/CyclomaticComplexity:
   Max: 15
 
+Metrics/ClassLength:
+  Max: 300
+
 # Style
 
 Style/StringLiterals:

data/lib/unobtainium/driver.rb

@@ -61,6 +61,83 @@ module Unobtainium
       end
 
       private :new
+
+      ##
+      # Ensures arguments are according to expectations.
+      def sanitize_options(*args)
+        if args.empty?
+          raise ArgumentError, "Need at least one argument specifying the driver!"
+        end
+
+        label = args[0].to_sym
+
+        options = nil
+        if args.length > 1
+          if not args[1].nil? and not args[1].is_a? Hash
+            raise ArgumentError, "The second argument is expected to be an "\
+              "options hash!"
+          end
+          options = args[1]
+        end
+
+        # Determine the driver class, if any
+        load_drivers
+
+        driver_klass = get_driver(label)
+        if not driver_klass
+          raise LoadError, "No driver implementation matching #{@label} found, "\
+            "aborting!"
+        end
+
+        # Sanitize options according to the driver's idea
+        if driver_klass.respond_to?(:sanitize_options)
+          label, options = driver_klass.sanitize_options(label, options)
+        end
+
+        return label, options
+      end
+
+      ##
+      # Load drivers; this loads all driver implementations included in this gem.
+      # You can register external implementations with the :register_implementation
+      # method.
+      def load_drivers
+        pattern = File.join(File.dirname(__FILE__), 'drivers', '*.rb')
+        Dir.glob(pattern).each do |fpath|
+          # Determine class name from file name
+          fname = File.basename(fpath, '.rb')
+          fname = fname.split('_').map(&:capitalize).join
+
+          begin
+            require fpath
+            klassname = 'Unobtainium::Drivers::' + fname
+            klass = Object.const_get(klassname)
+            Driver.register_implementation(klass, fpath)
+          rescue LoadError => err
+            raise LoadError, "#{err.message}: unknown problem loading driver, "\
+              "aborting!"
+          rescue NameError => err
+            raise LoadError, "#{err.message}: unknown problem loading driver, "\
+              "aborting!"
+          end
+        end
+      end
+
+      ##
+      # Out of the loaded drivers, returns the one matching the label (if any)
+      def get_driver(label)
+        # Of all the loaded classes, choose the first (unsorted) to match the
+        # requested driver label
+        impl = nil
+        @@drivers.keys.each do |klass|
+          if klass.matches?(label)
+            impl = klass
+            break
+          end
+        end
+
+        return impl
+      end
     end # class << self
 
     ############################################################################
@@ -89,13 +166,14 @@ module Unobtainium
     # Initializer
     def initialize(*args)
       # Load drivers
-      load_drivers
+      ::Unobtainium::Driver.load_drivers
 
       # Sanitize options
-      @label, @options = sanitize_options(*args)
+      @label, @options = ::Unobtainium::Driver.sanitize_options(*args)
 
-      # Determine the driver class, if any
-      driver_klass = get_driver(@label)
+      # Get the driver class. We kind of know this works because
+      # sanitize_options does the same, but let's be strict.
+      driver_klass = ::Unobtainium::Driver.get_driver(label)
       if not driver_klass
         raise LoadError, "No driver implementation matching #{@label} found, "\
           "aborting!"
@@ -120,68 +198,5 @@ module Unobtainium
       :ensure_preconditions,
       :create
     ].freeze
-
-    ##
-    # Ensures arguments are according to expectations.
-    def sanitize_options(*args)
-      if args.empty?
-        raise ArgumentError, "Need at least one argument specifying the driver!"
-      end
-
-      label = args[0].to_sym
-
-      options = nil
-      if args.length > 1
-        if not args[1].nil? and not args[1].is_a? Hash
-          raise ArgumentError, "The second argument is expected to be an options "\
-            "hash!"
-        end
-        options = args[1]
-      end
-
-      return label, options
-    end
-
-    ##
-    # Load drivers; this loads all driver implementations included in this gem.
-    # You can register external implementations with the :register_implementation
-    # method.
-    def load_drivers
-      pattern = File.join(File.dirname(__FILE__), 'drivers', '*.rb')
-      Dir.glob(pattern).each do |fpath|
-        # Determine class name from file name
-        fname = File.basename(fpath, '.rb')
-        fname = fname.split('_').map(&:capitalize).join
-
-        begin
-          require fpath
-          klassname = 'Unobtainium::Drivers::' + fname
-          klass = Object.const_get(klassname)
-          Driver.register_implementation(klass, fpath)
-        rescue LoadError => err
-          raise LoadError, "#{err.message}: unknown problem loading driver, "\
-            "aborting!"
-        rescue NameError => err
-          raise LoadError, "#{err.message}: unknown problem loading driver, "\
-            "aborting!"
-        end
-      end
-    end
-
-    ##
-    # Out of the loaded drivers, returns the one matching the label (if any)
-    def get_driver(label)
-      # Of all the loaded classes, choose the first (unsorted) to match the
-      # requested driver label
-      impl = nil
-      @@drivers.keys.each do |klass|
-        if klass.matches?(label)
-          impl = klass
-          break
-        end
-      end
-
-      return impl
-    end
   end # class Driver
 end # module Unobtainium

data/lib/unobtainium/drivers/appium.rb

@@ -49,8 +49,8 @@ module Unobtainium
         end
 
         ##
-        # Create and return a driver instance
-        def create(label, options)
+        # Sanitize options, and expand the :browser key, if present.
+        def sanitize_options(label, options)
           # The label specifies the platform, if no other platform is given.
           normalized = normalize_label(label)
 
@@ -69,6 +69,14 @@ module Unobtainium
           # some information
           options = supplement_browser(options)
 
+          return label, options
+        end
+
+        ##
+        # Create and return a driver instance
+        def create(label, options)
+          _, options = sanitize_options(label, options)
+
           # Create the driver
           driver = ::Appium::Driver.new(options).start_driver
           return driver
@@ -106,6 +114,9 @@ module Unobtainium
             return options
           end
 
+          # We have data, so we can remove the browser key itself
+          options.delete('browser')
+
           # We do have to check that we're not overwriting any of the keys.
           data.keys.each do |key|
             key_s = key.to_s
@@ -114,7 +125,7 @@ module Unobtainium
             end
             raise ArgumentError, "You specified the browser option as, "\
               "'#{options['browser']}', but you also have the key "\
-              "'#{key}' set in your requested capabilities. Use one or the"\
+              "'#{key}' set in your requested capabilities. Use one or the "\
               "other."
           end
 

data/lib/unobtainium/version.rb

@@ -7,5 +7,5 @@
 # All rights reserved.
 #
 module Unobtainium
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/lib/unobtainium/world.rb

@@ -53,6 +53,10 @@ module Unobtainium
         options = config["drivers.#{label}"]
       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.sanitize_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 = { label: label, options: options }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler