unobtainium 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62dde544dbbf73a7c92b1c34bade67318bfa8852
-  data.tar.gz: 2ffcd21462aef14d31031e0d26fcb562f61690af
+  metadata.gz: e3149f2511fbd2ecbbd5af9d19bb097251bdcac9
+  data.tar.gz: 95e5ab479135ada464f851c6ebaaea775033d440
 SHA512:
-  metadata.gz: 14d68f7c5d72f352338c5fd914585b9bba184bd8a38ae76e4fdc0e87a9d03e91e15a2e1706ae8fdfd3b9eba70ebb9510c9b52c475788142f63dfc2e43d82b88f
-  data.tar.gz: eeec64dacd68be00b4a402e705aff209af4313d0ecac8a7824b4ceee479e1bd5edf7368c7c4ff4fa2b863d5a31a0ae1293d83e5916c60b64470222ef89327921
+  metadata.gz: 3a8d32ef7e4162537270294802f1c57ad6a18e736b5c6d0a93dba3e586b8c54d18d184ae611a3892da14cb4c76b28cc4c10ee8d646f3bd4b2b4310000b973bca
+  data.tar.gz: 19c21152cb0c4b0268695cdb577f230da3c42994f48b2b457d29df8a8e5e733c8f5d3b3abb81c7ae9d8e6496694ef7b17b3f5c42e51b0f5d7e653ec539b30f75

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    unobtainium (0.5.1)
+    unobtainium (0.6.0)
+      collapsium-config (~> 0.1)
       sys-proctable (~> 1.0)
 
 GEM
@@ -20,6 +21,9 @@ GEM
       ffi (~> 1.0, >= 1.0.11)
     codeclimate-test-reporter (0.5.0)
       simplecov (>= 0.7.1, < 1.0.0)
+    collapsium (0.1.0)
+    collapsium-config (0.1.1)
+      collapsium (~> 0.1)
     cucumber (2.3.3)
       builder (>= 2.1.2)
       cucumber-core (~> 1.4.0)

data/README.md

@@ -46,8 +46,9 @@ the `Unobtainium::World` module.
 - 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 = Driver.create(:firefox) # uses Selenium and Firefox
+    drv = Driver.create(:android) # uses Appium (browser or device)
+    drv = Driver.create(:phantomjs) # use Selenium and PhantomJS
 
     drv.navigate.to "..." # delegates to Selenium or Appium
     ```

data/lib/unobtainium.rb

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

data/lib/unobtainium/driver.rb

@@ -125,7 +125,7 @@ module Unobtainium
         label = label.to_sym
 
         if not opts.nil?
-          if not (opts.is_a? Hash or opts.is_a? ::Unobtainium::PathedHash)
+          if not opts.is_a? Hash
             raise ArgumentError, "The second argument is expected to be an "\
               "options Hash!"
           end
@@ -166,11 +166,15 @@ module Unobtainium
             klass = Object.const_get(klassname)
             Driver.register_implementation(klass, fpath)
           rescue LoadError => err
+            # :nocov:
             raise LoadError, "#{err.message}: unknown problem loading driver, "\
               "aborting!"
+            # :nocov:
           rescue NameError => err
+            # :nocov:
             raise LoadError, "#{err.message}: unknown problem loading driver, "\
               "aborting!"
+            # :nocov:
           end
         end
       end
@@ -222,7 +226,9 @@ module Unobtainium
       if not @impl.nil? and @impl.respond_to?(meth)
         return @impl.send(meth.to_s, *args, &block)
       end
+      # :nocov:
       return super
+      # :nocov:
     end
 
     private

data/lib/unobtainium/runtime.rb

@@ -27,9 +27,11 @@ module Unobtainium
 
       # Create our own finalizer
       ObjectSpace.define_finalizer(self) do
+        # :nocov:
         @objects.keys.each do |key|
           delete(key)
         end
+        # :nocov:
       end
     end
 

data/lib/unobtainium/support/runner.rb

@@ -131,10 +131,6 @@ module Unobtainium
           to_send += children.collect(&:pid)
         end
 
-        if to_send.empty?
-          raise "This should not happen. I have no pids to send a signal to!"
-        end
-
         # Alright, send the signal!
         to_send.each do |pid|
           # rubocop:disable Lint/HandleExceptions

data/lib/unobtainium/version.rb

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

data/lib/unobtainium/world.rb

@@ -8,8 +8,9 @@
 #
 require 'unobtainium'
 
+require 'collapsium-config'
+
 require 'unobtainium/driver'
-require 'unobtainium/config'
 require 'unobtainium/runtime'
 
 module Unobtainium
@@ -17,32 +18,50 @@ 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.
+    # Modules can have class methods, too, but it's a little more verbose to
+    # provide them.
     module ClassMethods
-      # Set the config file path.
+      # Set the configuration file
       def config_file=(name)
-        @config_file = name
+        ::Collapsium::Config.config_file = name
       end
 
       # @return [String] the config file path, defaulting to 'config/config.yml'
       def config_file
-        return @config_file || "config/config.yml"
+        return ::Collapsium::Config.config_file
       end
-    end # module ClassMethods
-    extend ClassMethods
 
-    ##
-    # Return the global configuration, loaded from `World#config_file`
-    def config
-      return ::Unobtainium::Runtime.instance.store_with_if(:config) do
-        begin
-          ::Unobtainium::Config.load_config(::Unobtainium::World.config_file)
-        rescue Errno::ENOENT
-          {}
+      # In order for Unobtainium::World to include Collapsium::Config
+      # functionality, it has to be inherited when the former is
+      # included...
+      def included(klass)
+        set_config_path_default
+
+        klass.class_eval do
+          include ::Collapsium::Config
         end
       end
-    end
+
+      # ... and when it's extended.
+      def extended(world)
+        # :nocov:
+        set_config_path_default
+
+        world.extend(::Collapsium::Config)
+        # :nocov:
+      end
+
+      def set_config_path_default
+        # Override collapsium-config's default config path
+        if ::Collapsium::Config.config_file == \
+           ::Collapsium::Config::DEFAULT_CONFIG_PATH
+          ::Collapsium::Config.config_file = 'config/config.yml'
+        end
+      end
+    end # module ClassMethods
+    extend ClassMethods
 
     ##
     # (see Driver#create)
@@ -89,12 +108,14 @@ module Unobtainium
       # gets created or not.
       at_end = config.fetch("at_end", "quit")
       dtor = proc do |the_driver|
+        # :nocov:
         if the_driver.nil?
           return
         end
 
         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)

data/spec/driver_spec.rb

@@ -37,17 +37,19 @@ describe ::Unobtainium::Driver 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
+  describe "driver registration" do
+    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__ + '1')
-      ::Unobtainium::Driver.register_implementation(MockDriver, __FILE__ + '2')
-    end.to raise_error(LoadError)
+    it "refuses to register the same driver twice from different locations" do
+      expect do
+        ::Unobtainium::Driver.register_implementation(MockDriver, __FILE__ + '1')
+        ::Unobtainium::Driver.register_implementation(MockDriver, __FILE__ + '2')
+      end.to raise_error(LoadError)
+    end
   end
 
   it "verifies arguments" do
@@ -66,29 +68,39 @@ describe ::Unobtainium::Driver do
     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
+  describe "driver creation" do
+    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 "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 "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
+    it "does not create a driver with a nil label" do
+      expect do
+        ::Unobtainium::Driver.create(nil)
+      end.to raise_error(ArgumentError)
+    end
   end
 
-  it "passes options through correctly" do
-    drv = ::Unobtainium::Driver.create(:mock, foo: 42)
-    expect(drv.passed_options).to eql foo: 42
+  describe "driver behaviour" do
+    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
 
   describe 'modules' do

data/spec/runner_spec.rb

@@ -63,4 +63,23 @@ describe ::Unobtainium::Support::Runner do
     expect { runner.start }.to raise_error(RuntimeError)
     runner.wait
   end
+
+  it "kills when destroyed" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(sleep 30))
+    runner.start
+    expect(runner.pid).not_to be_nil
+    runner.destroy
+    expect(runner.pid).to be_nil
+  end
+
+  it "cannot be killed twice" do
+    runner = ::Unobtainium::Support::Runner.new("foo", %w(sleep 30))
+    runner.start
+    expect(runner.pid).not_to be_nil
+    runner.kill
+
+    expect do
+      runner.kill
+    end.to raise_error
+  end
 end

data/spec/spec_helper.rb

@@ -8,4 +8,5 @@ end
 require 'simplecov'
 SimpleCov.start do
   add_filter 'unobtainium/drivers'
+  add_filter 'spec'
 end

data/unobtainium.gemspec

@@ -54,6 +54,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "cucumber"
 
   spec.add_dependency "sys-proctable", "~> 1.0"
+  spec.add_dependency "collapsium-config", "~> 0.1"
 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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: collapsium-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 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
@@ -192,35 +206,21 @@ files:
 - features/support/env.rb
 - features/world.feature
 - lib/unobtainium.rb
-- lib/unobtainium/config.rb
 - lib/unobtainium/driver.rb
 - lib/unobtainium/drivers/appium.rb
 - lib/unobtainium/drivers/phantom.rb
 - lib/unobtainium/drivers/selenium.rb
-- lib/unobtainium/pathed_hash.rb
-- lib/unobtainium/recursive_merge.rb
 - lib/unobtainium/runtime.rb
 - lib/unobtainium/support/port_scanner.rb
 - lib/unobtainium/support/runner.rb
 - lib/unobtainium/support/util.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
+- media/screenshot.jpg
+- media/video.ogv
 - spec/data/driverconfig.yml
-- 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/port_scanner_spec.rb
 - spec/runner_spec.rb
 - spec/runtime_spec.rb
@@ -257,22 +257,9 @@ test_files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - features/world.feature
-- spec/config_spec.rb
-- spec/data/array.yaml
-- spec/data/arraymerge-local.yaml
-- spec/data/arraymerge.yaml
 - spec/data/driverconfig.yml
-- 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/port_scanner_spec.rb
 - spec/runner_spec.rb
 - spec/runtime_spec.rb

data/lib/unobtainium/config.rb

@@ -1,304 +0,0 @@
-# coding: utf-8
-#
-# unobtainium
-# https://github.com/jfinkhaeuser/unobtainium
-#
-# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
-# All rights reserved.
-#
-
-require 'pathname'
-
-require 'unobtainium/pathed_hash'
-
-module Unobtainium
-  ##
-  # The Config class extends PathedHash by two main pieces of functionality:
-  #
-  # - 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
-  # extension will be loaded as well, overriding any values in the original
-  # configuration file.
-  #
-  # For environment variable support, any environment variable named like a
-  # path into the configuration hash, but with separators transformed to
-  # underscore and all letters capitalized will override values from the
-  # configuration files under that path, i.e. `FOO_BAR` will override `'foo.bar'`.
-  #
-  # Environment variables can contain JSON *only*; if the value can be parsed
-  # as JSON, it becomes a Hash in the configuration tree. If it cannot be parsed
-  # as JSON, it remains a string.
-  #
-  # **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
-    # @api private
-    # Very simple YAML parser
-    class YAMLParser
-      require 'yaml'
-
-      # @return parsed string
-      def self.parse(string)
-        YAML.load(string)
-      end
-    end
-    private_constant :YAMLParser
-
-    # @api private
-    # Very simple JSON parser
-    class JSONParser
-      require 'json'
-
-      # @return parsed string
-      def self.parse(string)
-        JSON.parse(string)
-      end
-    end
-    private_constant :JSONParser
-
-    PathedHash::READ_METHODS.each do |method|
-      # Wrap all read functions into something that checks for environment
-      # variables first.
-      define_method(method) do |*args, &block|
-        # If there are no arguments, there's nothing to do with paths. Just
-        # delegate to the hash.
-        if args.empty?
-          return super(*args, &block)
-        end
-
-        # We'll make it rather simple: since the first argument is a key, we
-        # will just transform it to the matching environment variable name,
-        # and see if that environment variable is set.
-        env_name = args[0].to_s.upcase.gsub(split_pattern, '_')
-        contents = nil
-        if env_name != '_'
-          contents = ENV[env_name]
-        end
-
-        # No environment variable set? Fine, just do the usual thing.
-        if contents.nil? or contents.empty?
-          return super(*args, &block)
-        end
-
-        # With an environment variable, we will try to parse it as JSON first.
-        begin
-          return JSONParser.parse(contents)
-        rescue JSON::ParserError
-          return contents
-        end
-      end
-    end
-
-    class << self
-      # @api private
-      # Mapping of file name extensions to parser types.
-      FILE_TO_PARSER = {
-        '.yml'  => YAMLParser,
-        '.yaml' => YAMLParser,
-        '.json' => JSONParser,
-      }.freeze
-      private_constant :FILE_TO_PARSER
-
-      # @api private
-      # If the config file contains an Array, this is what they key of the
-      # returned Hash will be.
-      ARRAY_KEY = 'config'.freeze
-      private_constant :ARRAY_KEY
-
-      ##
-      # Loads a configuration file with the given file name. The format is
-      # detected based on one of the extensions in FILE_TO_PARSER.
-      #
-      # @param path [String] the path of the configuration file to load.
-      # @param resolve_extensions [Boolean] flag whether to resolve configuration
-      #   hash extensions. (see `#resolve_extensions`)
-      def load_config(path, resolve_extensions = true)
-        # Load base and local configuration files
-        base, config = load_base_config(path)
-        _, local_config = load_local_config(base)
-
-        # Merge local configuration
-        config.recursive_merge!(local_config)
-
-        # Create config from the result
-        cfg = Config.new(config)
-
-        # Now resolve config hashes that extend other hashes.
-        if resolve_extensions
-          cfg.resolve_extensions!
-        end
-
-        return cfg
-      end
-
-      private
-
-      def load_base_config(path)
-        # Make sure the format is recognized early on.
-        base = Pathname.new(path)
-        formats = FILE_TO_PARSER.keys
-        if not formats.include?(base.extname)
-          raise ArgumentError, "Files with extension '#{base.extname}' are not"\
-                " recognized; please use one of #{formats}!"
-        end
-
-        # Don't check the path whether it exists - loading a nonexistent
-        # file will throw a nice error for the user to catch.
-        file = base.open
-        contents = file.read
-
-        # Parse the contents.
-        config = FILE_TO_PARSER[base.extname].parse(contents)
-
-        return base, PathedHash.new(hashify(config))
-      end
-
-      def load_local_config(base)
-        # Now construct a file name for a local override.
-        local = Pathname.new(base.dirname)
-        local = local.join(base.basename(base.extname).to_s + "-local" +
-            base.extname)
-        if not local.exist?
-          return local, nil
-        end
-
-        # We know the local override file exists, but we do want to let any errors
-        # go through that come with reading or parsing it.
-        file = local.open
-        contents = file.read
-
-        local_config = FILE_TO_PARSER[base.extname].parse(contents)
-
-        return local, PathedHash.new(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
-
-    ##
-    # Resolve extensions in configuration hashes. If your hash contains e.g.:
-    #
-    # ```yaml
-    #   foo:
-    #     bar:
-    #       some: value
-    #     baz:
-    #       extends: bar
-    # ```
-    #
-    # Then `'foo.baz.some'` will equal `'value'` after resolving extensions. Note
-    # that `:load_config` calls this function, so normally you don't need to call
-    # it yourself. You can switch this behaviour off in `:load_config`.
-    #
-    # Note that this process has some intended side-effects:
-    #
-    # 1. If a hash can't be extended because the base cannot be found, an error
-    #    is raised.
-    # 1. If a hash got successfully extended, the `extends` keyword itself is
-    #    removed from the hash.
-    # 1. In a successfully extended hash, an `base` keyword, which contains
-    #    the name of the base. In case of multiple recursive extensions, the
-    #    final base is stored here.
-    #
-    # Also note that all of this means that :extends and :base are reserved
-    # keywords that cannot be used in configuration files other than for this
-    # purpose!
-    def resolve_extensions!
-      recursive_merge("", "")
-    end
-
-    ##
-    # Same as `dup.resolve_extensions!`
-    def resolve_extensions
-      dup.resolve_extensions!
-    end
-
-    private
-
-    def recursive_merge(parent, key)
-      loop do
-        full_key = "#{parent}#{separator}#{key}"
-
-        # Recurse down to the remaining root of the hierarchy
-        base = full_key
-        derived = nil
-        loop do
-          new_base, new_derived = resolve_extension(parent, base)
-
-          if new_derived.nil?
-            break
-          end
-
-          base = new_base
-          derived = new_derived
-        end
-
-        # If recursion found nothing to merge, we're done!
-        if derived.nil?
-          break
-        end
-
-        # Otherwise, merge what needs merging and continue
-        merge_extension(base, derived)
-      end
-    end
-
-    def resolve_extension(grandparent, parent)
-      fetch(parent, {}).each do |key, value|
-        # Recurse into hash values
-        if value.is_a? Hash
-          recursive_merge(parent, key)
-        end
-
-        # No hash, ignore any keys other than the special "extends" key
-        if key != "extends"
-          next
-        end
-
-        # If the key is "extends", return a normalized version of its value.
-        full_value = value.dup
-        if not full_value.start_with?(separator)
-          full_value = "#{grandparent}#{separator}#{value}"
-        end
-
-        if full_value == parent
-          next
-        end
-        return full_value, parent
-      end
-
-      return nil, nil
-    end
-
-    def merge_extension(base, derived)
-      # Remove old 'extends' key, but remember the value
-      extends = self[derived]["extends"]
-      self[derived].delete("extends")
-
-      # Recursively merge base into derived without overwriting
-      self[derived].extend(::Unobtainium::RecursiveMerge)
-      self[derived].recursive_merge!(self[base], false)
-
-      # Then set the "base" keyword, but only if it's not yet set.
-      if not self[derived]["base"].nil?
-        return
-      end
-      self[derived]["base"] = extends
-    end
-  end # class Config
-end # module Unobtainium