unobtainium 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 194953d1b77be115316598397b69e99037647085
-  data.tar.gz: 9194ccf829bcf5c6e98027251716b8598ea1979b
+  metadata.gz: 9464c7e860902fed8b6f41813261a19368aea2aa
+  data.tar.gz: f9498b642d79da6d09cbebd854bda897c6b737d1
 SHA512:
-  metadata.gz: 2e43f762d2c90323173cdfeedc2d57e764114558282066bd28a9208ed1fb175deb71917b23cbc135e8f476770e5c396414a572dcb2814ecd5e93449999cb1a8a
-  data.tar.gz: 58fd4916229bf0528304c9cb18541f5b6f2431e958da9f7154b70f1a553ffc04e26be791a02442c0e858ce45e1d42e98bb8c8f9f48e6f9a7fa6866843432baac
+  metadata.gz: 07d45f57984c9ffe4d7c12d8fa7a189a6e22e0638a4dab0bed898f423ba73a9ae0f484247d0c23824513bf93f3eedfc32b7e4212e6515d751611c2b1c34eaee7
+  data.tar.gz: c1378459dc8affa7f5d2a2ce96cfcf5d240b2bf45c83158be0a1d3bf81795ae5024821c99eb3cd3e00617e606cea21c6b43f7ea3eda29b70213a43c5a78f3d30

data/.codeclimate.yml

@@ -0,0 +1,33 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    exclude_fingerprints:
+      - d85d6f12c93d79ccd43868b8315d8816
+      - a8e2b4ccb258f16eda697c5f98e21823
+      - 442a316695836b4f4693fe3786cd3396
+      - 1c24bb5da72323796b645814cc006684
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.rubocop.yml

@@ -52,3 +52,6 @@ Style/IfUnlessModifier:
 
 Style/TrailingCommaInLiteral:
   Enabled: false
+
+Style/FirstParameterIndentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+addons:
+  code_climate:
+    repo_token: 5dcf014e3a26ded8ffe8ff8bc70f98d49523e4851613123d8359035d44937953

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in unobtainium.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,16 +1,35 @@
 PATH
   remote: .
   specs:
-    unobtainium (0.0.1)
+    unobtainium (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.2.0)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
     parser (2.3.0.7)
       ast (~> 2.2)
     powerpack (0.1.1)
     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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     rubocop (0.39.0)
       parser (>= 2.3.0.7, < 3.0)
       powerpack (~> 0.1)
@@ -18,6 +37,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     unicode-display_width (1.0.3)
 
 PLATFORMS
@@ -25,7 +49,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.11)
+  codeclimate-test-reporter
+  rake (~> 11.1)
+  rspec (~> 3.4)
   rubocop (~> 0.39)
+  simplecov (~> 0.11)
   unobtainium!
 
 BUNDLED WITH

data/README.md

@@ -13,6 +13,63 @@ Some additional useful functionality for the maintenance of test suites is
 also added.
 
 [![Gem Version](https://badge.fury.io/rb/unobtainium.svg)](https://badge.fury.io/rb/unobtainium)
+[![Build status](https://travis-ci.org/jfinkhaeuser/unobtainium.svg?branch=master)](https://travis-ci.org/jfinkhaeuser/unobtainium)
+[![Code Climate](https://codeclimate.com/github/jfinkhaeuser/unobtainium/badges/gpa.svg)](https://codeclimate.com/github/jfinkhaeuser/unobtainium)
+[![Test Coverage](https://codeclimate.com/github/jfinkhaeuser/unobtainium/badges/coverage.svg)](https://codeclimate.com/github/jfinkhaeuser/unobtainium/coverage)
+
+# Usage
+
+You can use unobtainium on its own, or use it as part of a
+[cucumber](https://cucumber.io/) test suite.
+
+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, and allows config paths to be overridden by
+  environment variables: `FOO_BAR` overrides the "foo.bar" path.
+
+  You can use JSON as environment variable values.
+- 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
+  to have to implement the Singleton pattern itself.
+- The `Driver` class, of course, wraps either of Appium or Selenium drivers:
+  ```ruby
+  drv = Driver.create(:firefox) # uses Selenium
+  drv = Driver.create(:android) # uses Appium
+
+  drv.navigate.to "..." # delegates to Selenium or Appium
+  ```
+
+## World
+
+The World module combines all of the above by providing a simple entry point
+for everything:
+
+- `World.config_file` can be set to the path of a config file to be loaded,
+  defaulting to `config/config.yml`.
+- `World#config` is a `Config` instance containing the above file's contents.
+- `World#driver` returns a Driver, initialized to the settings contained in
+  the configuration file.
+
+For a simple usage example of the World module, see the [cuke](./cuke)
+subdirectory (used with cucumber).
+
+## Configuration File
+
+The configuration file knows two configuration variables:
+
+- `driver` is expected to be a string, specifying the driver to use as if it
+  was passed to `Driver.create` (see above), e.g. "android", "chrome", etc.
+- `drivers` (note the trailing s) is a Hash. Under each key you can nest an
+  options hash you might otherwise pass to `Driver.create` as the second
+  parameter.
 
 # Credits
 This gem is inspired by [LapisLazuli](https://github.com/spriteCloud/lapis-lazuli),

data/Rakefile

@@ -0,0 +1,17 @@
+# Rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+# Rspec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# Combined test task
+desc "Test the code"
+task :test do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:spec].invoke
+end
+
+# Default is the test task
+task default: :test

data/cuke/.gitignore

@@ -0,0 +1,2 @@
+C:\\nppdf32Log\\debuglog.txt
+config/*-local.yml

data/cuke/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+# Cucumber
+gem 'cucumber'
+
+# For drivers
+gem 'appium_lib'
+gem 'selenium-webdriver'
+
+# unobtainium itself; test code should point to the current repo and branch
+repo = `git config --get remote.origin.url`.strip
+branch = `git rev-parse --abbrev-ref HEAD`.strip
+gem 'unobtainium', git: repo, branch: branch

data/cuke/README.md

@@ -0,0 +1,2 @@
+This directory contains tests for the integration with cucumber. You can also
+run limited tests with the Selenium and Appium drivers from here.

data/cuke/config/config.yml

@@ -0,0 +1,6 @@
+---
+drivers:
+  firefox:
+  android:
+    browser: chrome
+driver: firefox

data/cuke/features/step_definitions/steps.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+
+Given(/^I navigate to the best website in the world$/) do
+  driver.navigate.to "http://finkhaeuser.de"
+end

data/cuke/features/support/env.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+require 'unobtainium'
+
+World(Unobtainium::World)

data/cuke/features/world.feature

@@ -0,0 +1,4 @@
+Feature: World
+
+  Scenario: Driver and configuration loading
+    Given I navigate to the best website in the world

data/lib/unobtainium.rb

@@ -10,3 +10,6 @@
 require 'unobtainium/version'
 
 require 'unobtainium/driver'
+require 'unobtainium/config'
+require 'unobtainium/runtime'
+require 'unobtainium/world'

data/lib/unobtainium/config.rb

@@ -14,9 +14,9 @@ require 'unobtainium/pathed_hash'
 module Unobtainium
   ##
   # The Config class extends PathedHash by two main pieces of functionality:
-  # a) it loads configuration files and turns them into pathed hashes, and
-  # b) it treats environment variables as overriding anything contained in
-  #    the configuration file.
+  # - it loads configuration files and turns them into pathed hashes, and
+  # - it treats environment variables as overriding anything contained in
+  #   the configuration file.
   #
   # For configuration file loading, a named configuration file will be laoaded
   # if present. A file with the same name but '-local' appended before the
@@ -34,7 +34,8 @@ module Unobtainium
   #
   # Note: if your configuration file's top-level structure is an array, it will
   # be returned as a hash with a 'config' key that maps to your file's contents.
-  #
+  # That means that if you are trying to merge a hash with an array config, the
+  # result may be unexpected.
   class Config < PathedHash
     # Very simple YAML parser
     class YAMLParser
@@ -97,29 +98,22 @@ module Unobtainium
         # Load base and local configuration files
         base, config = load_base_config(path)
         _, local_config = load_local_config(base)
-
-        # We can't sensibly merge arrays and hashes, so bail if the two classes
-        # don't match.
-        if config.class != local_config.class
-          raise ArgumentError, "Config file and local override file do not have "\
-                "the same top-level structure (hash or array), and therefore "\
-                "cannot be merged!"
+        if local_config.nil?
+          return Config.new(config)
         end
 
         # Merge
-        if config.is_a? Array
-          config = { ARRAY_KEY => config.push(*local_config) }
-        elsif config.is_a? Hash
-          # rubocop:disable Style/CaseEquality
-          merger = proc do |_, v1, v2|
-            Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2
+        merger = proc do |_, v1, v2|
+          # rubocop:disable Style/GuardClause
+          if v1.is_a? Hash and v2.is_a? Hash
+            next v1.merge(v2, &merger)
+          elsif v1.is_a? Array and v2.is_a? Array
+            next v1 + v2
           end
-          # rubocop:enable Style/CaseEquality
-          config.merge!(local_config, &merger)
-        else
-          raise "Unexpected top-level structure in configuration file: "\
-                "#{config.class}"
+          next v2
+          # rubocop:enable Style/GuardClause
         end
+        config.merge!(local_config, &merger)
 
         return Config.new(config)
       end
@@ -143,7 +137,7 @@ module Unobtainium
         # Parse the contents.
         config = FILE_TO_PARSER[base.extname].parse(contents)
 
-        return base, config
+        return base, hashify(config)
       end
 
       def load_local_config(base)
@@ -151,9 +145,8 @@ module Unobtainium
         local = Pathname.new(base.dirname)
         local = local.join(base.basename(base.extname).to_s + "-local" +
             base.extname)
-        puts local
         if not local.exist?
-          return Config.new(config)
+          return local, nil
         end
 
         # We know the local override file exists, but we do want to let any errors
@@ -163,7 +156,17 @@ module Unobtainium
 
         local_config = FILE_TO_PARSER[base.extname].parse(contents)
 
-        return local, local_config
+        return local, hashify(local_config)
+      end
+
+      def hashify(data)
+        if data.nil?
+          return {}
+        end
+        if data.is_a? Array
+          data = { ARRAY_KEY => data }
+        end
+        return data
       end
     end # class << self
   end # class Config

data/lib/unobtainium/driver.rb

@@ -132,7 +132,7 @@ module Unobtainium
 
       options = nil
       if args.length > 1
-        if not args[1].is_a? Hash
+        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

data/lib/unobtainium/runtime.rb

@@ -28,7 +28,7 @@ module Unobtainium
       # Create our own finalizer
       ObjectSpace.define_finalizer(self) do
         @objects.keys.each do |key|
-          unset(key)
+          delete(key)
         end
       end
     end
@@ -53,8 +53,8 @@ module Unobtainium
     # If a destructor is passed, it is used to destroy the *new* object only.
     # If no destructor is passed and the object responds to a :destroy method, that
     # method is called.
-    def set(name, object, destructor = nil)
-      unset(name)
+    def store(name, object, destructor = nil)
+      delete(name)
 
       @objects[name] = [object, destructor]
 
@@ -65,8 +65,8 @@ module Unobtainium
     # Store the object returned by the block, if any. If no object is returned
     # or no block is given, this function does nothing.
     #
-    # Otherwise it works much like :set above.
-    def set_with(name, destructor = nil, &block)
+    # Otherwise it works much like :store above.
+    def store_with(name, destructor = nil, &block)
       object = nil
       if not block.nil?
         object = yield
@@ -76,12 +76,30 @@ module Unobtainium
         return
       end
 
-      return set(name, object, destructor)
+      return store(name, object, destructor)
     end
 
     ##
-    # Unsets (and destroys) any object found under the given name.
-    def unset(name)
+    # Like :store, but only stores the object if none exists for that key yet.
+    def store_if(name, object, destructor = nil)
+      if has?(name)
+        return self[name]
+      end
+      return store(name, object, destructor)
+    end
+
+    ##
+    # Like :store_if, but as a block version similar to :store_with.
+    def store_with_if(name, destructor = nil, &block)
+      if has?(name)
+        return self[name]
+      end
+      return store_with(name, destructor, &block)
+    end
+
+    ##
+    # Deletes (and destroys) any object found under the given name.
+    def delete(name)
       if not @objects.key?(name)
         return
       end
@@ -95,14 +113,23 @@ module Unobtainium
     # Returns the object with the given name, or the default value if no such
     # object exists.
     def fetch(name, default = nil)
-      return @objects.fetch(name, default)
+      return @objects.fetch(name)[0]
+    rescue KeyError
+      if default.nil?
+        raise
+      end
+      return default
     end
 
     ##
     # Similar to :fetch, but always returns nil for an object that could not
     # be found.
     def [](name)
-      return @objects[name]
+      val = @objects[name]
+      if val.nil?
+        return nil
+      end
+      return val[0]
     end
 
     private
@@ -111,8 +138,7 @@ module Unobtainium
     # Destroy the given object with the destructor provided.
     def destroy(object, destructor)
       if not destructor.nil?
-        destructor.call
-        return
+        return destructor.call(object)
       end
 
       if not object.respond_to?(:destroy)

data/lib/unobtainium/version.rb

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

data/lib/unobtainium/world.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+require 'unobtainium'
+
+require 'unobtainium/driver'
+require 'unobtainium/config'
+require 'unobtainium/runtime'
+
+module Unobtainium
+  ##
+  # The World module combines other modules, defining simpler entry points
+  # into the gem's functionality.
+  module World
+    ##
+    # Modules can have class methods, too.
+    module ClassMethods
+      # Configuration related
+      def config_file=(name)
+        @config_file = name
+      end
+
+      def config_file
+        return @config_file || "config/config.yml"
+      end
+    end # module ClassMethods
+    extend ClassMethods
+
+    ##
+    # Return the global configuration, loaded from :config_file
+    def config
+      return ::Unobtainium::Runtime.instance.store_with_if(:config) do
+        ::Unobtainium::Config.load_config(::Unobtainium::World.config_file)
+      end
+    end
+
+    ##
+    # 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)
+      # Make sure we have a label for the driver
+      if label.nil?
+        label = config["driver"]
+      end
+
+      # Make sure we have options matching the driver
+      if options.nil?
+        options = config["drivers.#{label}"]
+      end
+
+      # 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 }
+      require 'digest/sha1'
+      key = Digest::SHA1.hexdigest(key.to_s)
+      key = "driver-#{key}"
+
+      # Only create a driver with this exact configuration once
+      dtor = ::Unobtainium::World.method(:driver_destructor)
+      return ::Unobtainium::Runtime.instance.store_with_if(key, dtor) do
+        ::Unobtainium::Driver.create(label, options)
+      end
+    end
+
+    class << self
+      def driver_destructor(the_driver = nil)
+        if the_driver.nil?
+          return
+        end
+        the_driver.close
+      end
+    end
+  end # module World
+end # module Unobtainium

data/spec/config_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/config'
+
+describe ::Unobtainium::Config do
+  before :each do
+    @data_path = File.join(File.dirname(__FILE__), 'data')
+  end
+
+  it "fails to load a nonexistent file" do
+    expect { ::Unobtainium::Config.load_config("_nope_.yaml") }.to \
+      raise_error Errno::ENOENT
+  end
+
+  it "is asked to load an unrecognized extension" do
+    expect { ::Unobtainium::Config.load_config("_nope_.cfg") }.to \
+      raise_error ArgumentError
+  end
+
+  it "loads a yaml config with a top-level hash correctly" do
+    config = File.join(@data_path, 'hash.yml')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    expect(cfg["foo"]).to eql "bar"
+    expect(cfg["baz"]).to eql "quux"
+  end
+
+  it "loads a yaml config with a top-level array correctly" do
+    config = File.join(@data_path, 'array.yaml')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    expect(cfg["config"]).to eql %w(foo bar)
+  end
+
+  it "loads a JSON config correctly" do
+    config = File.join(@data_path, 'test.json')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    expect(cfg["foo"]).to eql "bar"
+    expect(cfg["baz"]).to eql 42
+  end
+
+  it "merges a hashed config correctly" do
+    config = File.join(@data_path, 'hashmerge.yml')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    expect(cfg["asdf"]).to eql 1
+    expect(cfg["foo.bar"]).to eql "baz"
+    expect(cfg["foo.quux"]).to eql [1, 42]
+    expect(cfg["foo.baz"]).to eql 3.14
+    expect(cfg["blargh"]).to eql false
+  end
+
+  it "merges an array config correctly" do
+    config = File.join(@data_path, 'arraymerge.yaml')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    expect(cfg["config"]).to eql %w(foo bar baz)
+  end
+
+  it "merges an array and hash config" do
+    config = File.join(@data_path, 'mergefail.yaml')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    expect(cfg["config"]).to eql %w(array in main config)
+    expect(cfg["local"]).to eql "override is a hash"
+  end
+
+  it "overrides configuration variables from the environment" do
+    config = File.join(@data_path, 'hash.yml')
+    cfg = ::Unobtainium::Config.load_config(config)
+
+    ENV["BAZ"] = "override"
+    expect(cfg["foo"]).to eql "bar"
+    expect(cfg["baz"]).to eql "override"
+  end
+
+  it "treats an empty YAML file as an empty hash" do
+    config = File.join(@data_path, 'empty.yml')
+    cfg = ::Unobtainium::Config.load_config(config)
+    expect(cfg).to be_empty
+  end
+end

data/spec/data/array.yaml

@@ -0,0 +1,3 @@
+---
+- foo
+- bar

data/spec/data/arraymerge-local.yaml

@@ -0,0 +1,2 @@
+---
+- baz

data/spec/data/arraymerge.yaml

@@ -0,0 +1,3 @@
+---
+- foo
+- bar

data/spec/data/empty.yml

@@ -0,0 +1 @@
+---

data/spec/data/hash.yml

@@ -0,0 +1,3 @@
+---
+foo: bar
+baz: quux

data/spec/data/hashmerge-local.yml

@@ -0,0 +1,4 @@
+---
+blargh: false
+foo:
+  baz: 3.14

data/spec/data/hashmerge.yml

@@ -0,0 +1,7 @@
+---
+asdf: 1
+foo:
+  bar: baz
+  quux:
+    - 1
+    - 42

data/spec/data/mergefail-local.yaml

@@ -0,0 +1,2 @@
+---
+local: override is a hash

data/spec/data/mergefail.yaml

@@ -0,0 +1,5 @@
+---
+- array
+- in
+- main
+- config

data/spec/data/test.json

@@ -0,0 +1,4 @@
+{
+  "foo": "bar",
+  "baz": 42
+}

data/spec/data/world.yml

@@ -0,0 +1,5 @@
+---
+drivers:
+  mock:
+    option: value
+driver: mock

data/spec/driver_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/driver'
+require_relative './mock_driver.rb'
+
+class FakeDriver
+end # class FakeDriver
+
+describe ::Unobtainium::Driver do
+  before :each do
+    ::Unobtainium::Driver.register_implementation(MockDriver, "mock_driver.rb")
+  end
+
+  it "refuses to register a driver with missing methods" do
+    expect do
+      ::Unobtainium::Driver.register_implementation(FakeDriver, __FILE__)
+    end.to raise_error(LoadError)
+  end
+
+  it "refuses to register the same driver twice from different locations" do
+    expect do
+      ::Unobtainium::Driver.register_implementation(MockDriver, __FILE__)
+    end.to raise_error(LoadError)
+  end
+
+  it "verifies arguments" do
+    expect { ::Unobtainium::Driver.create }.to raise_error(ArgumentError)
+
+    expect do
+      ::Unobtainium::Driver.create(:mock, 1)
+    end.to raise_error(ArgumentError)
+
+    expect do
+      ::Unobtainium::Driver.create(:mock, [])
+    end.to raise_error(ArgumentError)
+
+    expect do
+      ::Unobtainium::Driver.create(:mock, "foo")
+    end.to raise_error(ArgumentError)
+  end
+
+  it "creates no driver with an unknown label" do
+    expect { ::Unobtainium::Driver.create(:nope) }.to raise_error(LoadError)
+  end
+
+  it "fails preconditions correctly" do
+    expect do
+      ::Unobtainium::Driver.create(:raise_mock)
+    end.to raise_error(RuntimeError)
+  end
+
+  it "creates a driver correctly" do
+    ::Unobtainium::Driver.create(:mock)
+  end
+
+  it "delegates to created driver class" do
+    drv = ::Unobtainium::Driver.create(:mock, foo: 42)
+    expect(drv.respond_to?(:passed_options)).to be_truthy
+    _ = drv.passed_options
+  end
+
+  it "passes options through correctly" do
+    drv = ::Unobtainium::Driver.create(:mock, foo: 42)
+    expect(drv.passed_options).to eql foo: 42
+  end
+end

data/spec/mock_driver.rb

@@ -0,0 +1,27 @@
+class Mock
+  attr_accessor :passed_options
+
+  def initialize(opts)
+    @passed_options = opts
+  end
+end
+
+# rubocop:disable Style/GuardClause
+class MockDriver
+  class << self
+    def matches?(label)
+      label == :mock || label == :raise_mock
+    end
+
+    def ensure_preconditions(label, _)
+      if label == :raise_mock
+        raise "something"
+      end
+    end
+
+    def create(_, options)
+      Mock.new(options)
+    end
+  end
+end # class MockDriver
+# rubocop:enable Style/GuardClause

data/spec/pathed_hash_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/pathed_hash'
+
+describe ::Unobtainium::PathedHash do
+  describe "#initialize" do
+    it "can be constructed without values" do
+      ph = ::Unobtainium::PathedHash.new
+      expect(ph.empty?).to eql true
+    end
+
+    it "can be constructed with values" do
+      ph = ::Unobtainium::PathedHash.new(foo: 42)
+      expect(ph.empty?).to eql false
+      expect(ph[:foo]).to eql 42
+    end
+  end
+
+  describe "Hash-like" do
+    it "responds to Hash functions" do
+      ph = ::Unobtainium::PathedHash.new
+      [:invert, :delete, :fetch].each do |meth|
+        expect(ph.respond_to?(meth)).to eql true
+      end
+    end
+
+    it "can be used like a hash" do
+      ph = ::Unobtainium::PathedHash.new(foo: 42)
+      inverted = ph.invert
+      expect(inverted.empty?).to eql false
+      expect(inverted[42]).to eql :foo
+    end
+  end
+
+  it "can recursively read entries via a path" do
+    sample = {
+      "foo" => 42,
+      "bar" => {
+        "baz" => "quux",
+        "blah" => [1, 2],
+      }
+    }
+    ph = ::Unobtainium::PathedHash.new(sample)
+
+    expect(ph["foo"]).to eql 42
+    expect(ph["bar.baz"]).to eql "quux"
+    expect(ph["bar.blah"]).to eql [1, 2]
+
+    expect(ph["nope"]).to eql nil
+    expect(ph["bar.nope"]).to eql nil
+  end
+
+  it "can recursively write entries via a path" do
+    ph = ::Unobtainium::PathedHash.new
+    ph["foo.bar"] = 42
+    expect(ph["foo.bar"]).to eql 42
+  end
+
+  it "has the same string representation as the hash it's initialized from" do
+    h = { foo: 42 }
+    ph = ::Unobtainium::PathedHash.new(h)
+    expect(ph.to_s).to eql h.to_s
+  end
+end

data/spec/runtime_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/runtime'
+
+# rubocop:disable Style/ClassVars
+class Foo
+  @@instances = 0
+
+  class << self
+    def instances
+      @@instances ||= 0
+    end
+
+    def instances=(value)
+      @@instances = value
+    end
+  end
+
+  def initialize
+    Foo.instances += 1
+  end
+
+  def destroy
+    Foo.instances -= 1
+  end
+end # class Foo
+# rubocop:enable Style/ClassVars
+
+describe ::Unobtainium::Runtime do
+  it "is a singleton" do
+    expect { ::Unobtainium::Runtime.new }.to raise_error(NoMethodError)
+    first = ::Unobtainium::Runtime.instance
+    second = ::Unobtainium::Runtime.instance
+    expect(first).to eql second
+  end
+
+  it "can store objects" do
+    ::Unobtainium::Runtime.instance.store("foo", 42)
+
+    expect(::Unobtainium::Runtime.instance.has?("foo")).to be_truthy
+    expect(::Unobtainium::Runtime.instance.length).to eql 1
+    expect(::Unobtainium::Runtime.instance.fetch("foo")).to eql 42
+    expect(::Unobtainium::Runtime.instance["foo"]).to eql 42
+  end
+
+  it "deals well with default values" do
+    expect(::Unobtainium::Runtime.instance["bar"]).to be_nil
+    expect { ::Unobtainium::Runtime.instance.fetch("bar") }.to raise_error(
+        KeyError)
+    expect(::Unobtainium::Runtime.instance.fetch("bar", 123)).to eql 123
+  end
+
+  it "destroys deleted objects" do
+    expect(Foo.instances).to eql 0
+
+    ::Unobtainium::Runtime.instance.store("foo", Foo.new)
+    expect(Foo.instances).to eql 1
+
+    ::Unobtainium::Runtime.instance.delete("foo")
+    expect(Foo.instances).to eql 0
+  end
+
+  it "can use custom destructors" do
+    called = false
+    ::Unobtainium::Runtime.instance.store("foo", 666, proc { called = true })
+    expect(called).to be_falsy
+
+    ::Unobtainium::Runtime.instance.delete("foo")
+    expect(called).to be_truthy
+  end
+
+  it "can store objects created from a block" do
+    ::Unobtainium::Runtime.instance.store_with("foo") { 123 }
+    expect(::Unobtainium::Runtime.instance.fetch("foo")).to eql 123
+  end
+
+  it "ignores nil objects created from a block" do
+    ::Unobtainium::Runtime.instance.store_with("_nope_") { nil }
+    expect { ::Unobtainium::Runtime.instance.fetch("_nope_") }.to raise_error(
+        KeyError)
+  end
+
+  it "stores objects with :store_if" do
+    ::Unobtainium::Runtime.instance.store_if("store_if", 42)
+    expect(::Unobtainium::Runtime.instance.fetch("store_if")).to eql 42
+  end
+
+  it "does not overwrite objects with :store_if" do
+    ::Unobtainium::Runtime.instance.store("foo", 42)
+    ::Unobtainium::Runtime.instance.store_if("foo", 123)
+    expect(::Unobtainium::Runtime.instance.fetch("foo")).to eql 42
+  end
+
+  it "stores objects with :store_with_if" do
+    ::Unobtainium::Runtime.instance.store_with_if("store_with_if") do
+      42
+    end
+    expect(::Unobtainium::Runtime.instance.fetch("store_with_if")).to eql 42
+  end
+
+  it "does not overwrite objects with :store_with_if" do
+    ::Unobtainium::Runtime.instance.store("foo", 42)
+    called = false
+    ::Unobtainium::Runtime.instance.store_with_if("foo") do
+      called = true
+      123
+    end
+    expect(::Unobtainium::Runtime.instance.fetch("foo")).to eql 42
+    expect(called).to be_falsy
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'unobtainium/drivers'
+end
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start

data/spec/world_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require_relative '../lib/unobtainium/world'
+require_relative './mock_driver.rb'
+
+class Tester
+  include ::Unobtainium::World
+end # class Tester
+
+describe ::Unobtainium::World do
+  before :each do
+    # Set configuration
+    path = File.join(File.dirname(__FILE__), 'data', 'world.yml')
+    ::Unobtainium::World.config_file = path
+
+    # Load MockDriver
+    ::Unobtainium::Driver.register_implementation(MockDriver, "mock_driver.rb")
+
+    # Create tester object
+    @tester = Tester.new
+  end
+
+  it "loads the global config" do
+    expect(@tester.config["drivers.mock.option"]).to eql "value"
+  end
+
+  it "creates a mock driver parameters" do
+    expect(@tester.driver.respond_to?(:passed_options)).to be_truthy
+  end
+
+  it "passed the config file options to the driver" do
+    expect(@tester.driver.passed_options["option"]).to eql "value"
+  end
+end

data/unobtainium.gemspec

@@ -37,12 +37,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9'
+  spec.required_ruby_version = '>= 2.0'
 
   spec.requirements  = "Either or all of 'selenium-webdriver', 'appium_lib'"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rubocop", "~> 0.39"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.11"
 end
 # rubocop:enable Style/SpaceAroundOperators
 # rubocop:enable Style/UnneededPercentQ, Style/ExtraSpacing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unobtainium
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.39'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 description: "\n    Unobtainium wraps Selenium and Appium in a simple driver abstraction
   so that\n    test code can more easily cover desktop browsers, mobile browsers and
   mobile\n    apps.\n\n    Some additional useful functionality for the maintenance
@@ -48,12 +90,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
+- cuke/.gitignore
+- cuke/Gemfile
+- cuke/README.md
+- cuke/config/config.yml
+- cuke/features/step_definitions/steps.rb
+- cuke/features/support/env.rb
+- cuke/features/world.feature
 - lib/unobtainium.rb
 - lib/unobtainium/config.rb
 - lib/unobtainium/driver.rb
@@ -62,6 +114,25 @@ files:
 - lib/unobtainium/pathed_hash.rb
 - lib/unobtainium/runtime.rb
 - lib/unobtainium/version.rb
+- lib/unobtainium/world.rb
+- spec/config_spec.rb
+- spec/data/array.yaml
+- spec/data/arraymerge-local.yaml
+- spec/data/arraymerge.yaml
+- spec/data/empty.yml
+- spec/data/hash.yml
+- spec/data/hashmerge-local.yml
+- spec/data/hashmerge.yml
+- spec/data/mergefail-local.yaml
+- spec/data/mergefail.yaml
+- spec/data/test.json
+- spec/data/world.yml
+- spec/driver_spec.rb
+- spec/mock_driver.rb
+- spec/pathed_hash_spec.rb
+- spec/runtime_spec.rb
+- spec/spec_helper.rb
+- spec/world_spec.rb
 - unobtainium.gemspec
 homepage: https://github.com/jfinkhaeuser/unobtainium
 licenses:
@@ -75,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -88,5 +159,23 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: 'Obtain the unobtainable: test code covering multiple platforms'
-test_files: []
+test_files:
+- spec/config_spec.rb
+- spec/data/array.yaml
+- spec/data/arraymerge-local.yaml
+- spec/data/arraymerge.yaml
+- spec/data/empty.yml
+- spec/data/hash.yml
+- spec/data/hashmerge-local.yml
+- spec/data/hashmerge.yml
+- spec/data/mergefail-local.yaml
+- spec/data/mergefail.yaml
+- spec/data/test.json
+- spec/data/world.yml
+- spec/driver_spec.rb
+- spec/mock_driver.rb
+- spec/pathed_hash_spec.rb
+- spec/runtime_spec.rb
+- spec/spec_helper.rb
+- spec/world_spec.rb
 has_rdoc: