kookaburra 2.0.0 → 3.0.0

data/Rakefile

@@ -3,8 +3,17 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-task :default => :spec
-RSpec::Core::RakeTask.new
+task :default => [:spec, 'spec:slow']
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = "-t ~slow"
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:slow) do |t|
+    t.rspec_opts = "-t slow"
+  end
+end
 
 desc 'Runs reek to detect code smells'
 task :reek do

data/kookaburra.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "uuid"
   spec.add_development_dependency "find_a_port"
   spec.add_development_dependency "json"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/kookaburra.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'kookaburra/exceptions'
 require 'kookaburra/mental_model'
 require 'kookaburra/api_driver'
@@ -17,21 +18,31 @@ require 'kookaburra/configuration'
 #
 # @see Kookaburra::TestHelpers
 class Kookaburra
+  extend Forwardable
+
   class << self
     # Stores the configuration object that is used by default when creating new
     # instances of Kookaburra
     #
-    # @return [Kookaburra::Configuration] return value is memoized
+    # @return [Kookaburra::Configuration]
     def configuration
       @configuration ||= Configuration.new
     end
 
-    # Yields the current configuration so that it can be modified
+    # Yields a new configuration so that it can be modified
+    #
+    # The new configuration object will now be used by default when creating
+    # instances of Kookaburra.
     #
     # @yield [Kookaburra::Configuration]
     def configure(&blk)
+      self.configuration = Configuration.new
       blk.call(configuration)
     end
+
+    private
+
+    attr_writer :configuration
   end
 
   # Returns a new Kookaburra instance that wires together your application's
@@ -39,10 +50,7 @@ class Kookaburra
   #
   # @param [Kookaburra::Configuration] configuration (Kookaburra.configuration)
   def initialize(configuration = Kookaburra.configuration)
-    @configuration = configuration
-    @configuration.mental_model = MentalModel.new
-    @api_driver_class = configuration.api_driver_class
-    @ui_driver_class = configuration.ui_driver_class
+    self.configuration = configuration
   end
 
   # Returns an instance of your APIDriver class configured to share test
@@ -50,7 +58,7 @@ class Kookaburra
   #
   # @return [Kookaburra::APIDriver]
   def api
-    @api ||= @api_driver_class.new(@configuration)
+    @api ||= api_driver_class.new(configuration)
   end
 
   # Returns an instance of your UIDriver class configured to share test fixture
@@ -59,7 +67,7 @@ class Kookaburra
   #
   # @return [Kookaburra::UIDriver]
   def ui
-    @ui ||= @ui_driver_class.new(@configuration)
+    @ui ||= ui_driver_class.new(configuration)
   end
 
   # Returns a deep-dup of the specified {MentalModel::Collection}.
@@ -75,6 +83,13 @@ class Kookaburra
   #
   # @return [Kookaburra::MentalModel::Collection]
   def get_data(collection_name)
-    @configuration.mental_model.send(collection_name).dup
+    mental_model.send(collection_name).dup
   end
+
+  private
+
+  attr_accessor :configuration
+
+  def_delegators :configuration, :api_driver_class, :ui_driver_class,
+    :mental_model
 end

data/lib/kookaburra/api_client.rb

@@ -7,7 +7,7 @@ class Kookaburra
   #
   # You will create a subclass of {APIClient} in your testing
   # implementation to be used with you subclass of
-  # {Kookaburra::APIDriver}. While the {GivenDriver} implements the
+  # {Kookaburra::APIDriver}. While the {APIDriver} implements the
   # "business domain" DSL for setting up your application state, the
   # {APIClient} maps discreet operations to your application's web
   # service API and can (optionally) handle encoding input data and

data/lib/kookaburra/api_driver.rb

@@ -36,7 +36,7 @@ class Kookaburra
     extend Forwardable
 
     # It is unlikely that you would call #initialize yourself; your APIDriver
-    # object is instantiated for you by {Kookaburra#given}.
+    # object is instantiated for you by {Kookaburra#api}.
     #
     # @param [Kookaburra::Configuration] configuration
     def initialize(configuration)

data/lib/kookaburra/assertion.rb

@@ -18,7 +18,7 @@ class Kookaburra
     #
     # @raise [Kookaburra::AssertionFailed] raised if test evaluates to false
     def assert(test, message = "You might want to provide a better message, eh?")
-      test or raise AssertionFailed, message
+      (!!test == true) or raise AssertionFailed, message
     end
   end
 end

data/lib/kookaburra/configuration.rb

@@ -1,6 +1,8 @@
 require 'ostruct'
 require 'delegate'
 require 'kookaburra/dependency_accessor'
+require 'kookaburra/mental_model'
+require 'kookaburra/configuration/proxy'
 
 class Kookaburra
   # Provides access to the configuration data used throughout Kookaburra
@@ -38,15 +40,6 @@ class Kookaburra
     #   without it having been set
     dependency_accessor :app_host
 
-    # This is the {Kookaburra::MentalModel} that is shared between your
-    # APIDriver and your UIDriver. This attribute is managed by {Kookaburra},
-    # so you shouldn't need to change it yourself.
-    #
-    # @attribute [rw] mental_model
-    # @raise [Kookaburra::ConfigurationError] if you try to read this attribute
-    #   without it having been set
-    dependency_accessor :mental_model
-
     # This is the logger to which Kookaburra will send various messages
     # about its operation. This would generally be used to allow
     # UIDriver subclasses to provide detailed failure information.
@@ -84,5 +77,28 @@ class Kookaburra
     def app_host_uri
       URI.parse(app_host)
     end
+
+    # This is the {Kookaburra::MentalModel} that is shared between your
+    # APIDriver and your UIDriver. This attribute is managed by {Kookaburra},
+    # so you shouldn't need to change it yourself.
+    def mental_model
+      @mental_model ||= MentalModel.new
+    end
+
+    attr_writer :mental_model
+
+    def application(name, &block)
+      proxy = Proxy.new(name: name, basis: self)
+      block.call(proxy) if block_given?
+      applications[name] = Kookaburra.new(proxy)
+    end
+
+    def applications
+      @applications ||= {}
+    end
+
+    def has_named_applications?
+      !applications.empty?
+    end
   end
 end

data/lib/kookaburra/configuration/proxy.rb

@@ -0,0 +1,55 @@
+require 'delegate'
+
+class Kookaburra
+  class Configuration
+    # Used to manage configuration for a named application
+    #
+    # `Configuration::Proxy` objects delegate to their basis object to retrieve
+    # default values. This allows a base configuration to be specified and
+    # inherited by each application configuration.
+    #
+    # @see Kookaburra::Configuration#application
+    # @private
+    class Proxy < DelegateClass(Configuration)
+      attr_reader :name
+
+      # Builds a new Proxy
+      #
+      # @param [String] name An (arbitrary) identifier for this configuration
+      # @param [Kookaburra::Configuration] The object that will be used as the source for default values
+      def initialize(name:, basis:)
+        self.name = name
+        self.basis = basis
+        __setobj__(basis)
+      end
+
+      private
+
+      attr_writer :name
+      attr_accessor :basis
+
+      def method_missing(method_name, *args, &block)
+        define_proxy_override(method_name, args.first) \
+          || super
+      end
+
+      def define_proxy_override(writer_name, value)
+        return false unless valid_attr_writer?(writer_name)
+        reader_name = reader_name_for writer_name
+        (class << self; self; end).class_eval do
+          define_method(reader_name) { value }
+        end
+        return true
+      end
+
+      def valid_attr_writer?(writer_name)
+        basis.respond_to?(writer_name) \
+          && /=$/ =~ writer_name.to_s
+      end
+
+      def reader_name_for(writer_name)
+        writer_name.to_s.sub(/=$/, '')
+      end
+    end
+  end
+end

data/lib/kookaburra/dependency_accessor.rb

@@ -12,13 +12,20 @@ class Kookaburra
     private
 
     def define_dependency_accessor(name)
+      define_attr_reader(name)
+      define_attr_writer(name)
+    end
+
+    def define_attr_reader(name)
       define_method(name) do
         class_name = self.class.name
         class_name.sub!(/^$/, 'an Anonymous Class!!!')
         instance_variable_get("@#{name}") or raise "No %s object was set on %s initialization." \
           % [name, class_name]
       end
+    end
 
+    def define_attr_writer(name)
       define_method("#{name}=") do |value|
         instance_variable_set("@#{name}", value)
       end

data/lib/kookaburra/exceptions.rb

@@ -1,14 +1,22 @@
 class Kookaburra
+  # Raised when accessing unknown mental model data
   # @private
   class UnknownKeyError < ArgumentError; end
+
+  # Raised when there is a problem with the Kookaburra runtime configuration
   # @private
   class ConfigurationError < StandardError; end
+
+  # Raised when an API or UI request results in an enexpected HTTP response
   # @private
   class UnexpectedResponse < RuntimeError; end
+
+  # Raised when an assertion fails inside the drivers.
   # @private
   class AssertionFailed < RuntimeError; end
+
+  # Raised when calling `api` or `ui` test helpers and named applications are
+  # configured
   # @private
-  class ComponentNotFound < RuntimeError; end
-  # @private
-  class NullBrowserError < ConfigurationError; end
+  class AmbiguousDriverError < StandardError; end
 end

data/lib/kookaburra/mental_model.rb

@@ -28,7 +28,7 @@ class Kookaburra
     # MentalModel instances respond to everything.
     #
     # @see #method_missing
-    def respond_to?
+    def respond_to?(_)
       true
     end
 
@@ -53,12 +53,12 @@ class Kookaburra
       # @param [String] name The name of the collection. Used to provide
       #   helpful error messages when unknown keys are accessed.
       # @param [Hash] init_data Preloads specific data into the collection
-      def initialize(name, init_data = nil)
+      def initialize(name, init_data = {})
         self.name = name
         data = Hash.new do |hash, key|
           raise UnknownKeyError, "Can't find mental_model.#{@name}[#{key.inspect}]. Did you forget to set it?"
         end
-        data.merge!(init_data) unless init_data.nil?
+        data.merge!(init_data)
         super(data)
       end
 
@@ -132,8 +132,8 @@ class Kookaburra
       #
       # @return [Hash] the key/value pairs still remaining after the deletion
       def delete_if(&block)
-        move = lambda { |k,v| deleted[k] = v; true }
-        super { |k,v| block.call(k,v) && move.call(k,v) }
+        move = ->(key, value) { deleted[key] = value; true }
+        super { |key, value| block.call(key, value) && move.call(key, value) }
       end
 
       def dup

data/lib/kookaburra/rack_app_server.rb

@@ -49,16 +49,11 @@ class Kookaburra::RackAppServer
   # will then monitor that port and only return once the app server is
   # responding (or after the timeout period specified on {#initialize}).
   def boot
-    if defined?(JRUBY_VERSION)
-      thread_app_server
-    else
-      fork_app_server
-    end
+    fork_app_server
     wait_for_app_to_respond
   end
 
   def shutdown
-    return if defined?(JRUBY_VERSION)
     Process.kill(9, rack_server_pid)
     Process.wait
   end
@@ -68,10 +63,6 @@ class Kookaburra::RackAppServer
   attr_accessor :rack_app_initializer, :rack_server_pid, :startup_timeout
   attr_writer :port
 
-  def thread_app_server
-    Thread.new { start_server }
-  end
-
   def fork_app_server
     self.rack_server_pid = fork do
       start_server
@@ -98,8 +89,8 @@ class Kookaburra::RackAppServer
   end
 
   def running?
-    res = Net::HTTP.start('localhost', port) { |http| http.get('/__identify__') }
-    if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+    case (Net::HTTP.start('localhost', port) { |http| http.get('/__identify__') })
+    when Net::HTTPSuccess, Net::HTTPRedirection
       true
     else
       false

data/lib/kookaburra/test_helpers.rb

@@ -82,21 +82,62 @@ class Kookaburra
   module TestHelpers
     extend Forwardable
 
-    # The {Kookaburra} instance to be used by your tests. It gets configured
-    # using the options set in {Kookaburra.configuration}, and the result is
-    # memoized.
+    # @method api
+    # Delegates to main {Kookaburra} instance
+    #
+    # @note This method will only be available when no named applications have
+    #   been defined. (See {Kookaburra::Configuration#application}.)
+    #
+    # @raise [Kookaburra::AmbiguousDriverError] if named applications have been
+    #   configured.
+    def_delegator :kookaburra, :api
+
+    # @method ui
+    # Delegates to main {Kookaburra} instance
     #
-    # @return [Kookaburra]
-    def k
-      @k ||= Kookaburra.new
+    # @note This method will only be available when no named applications have
+    #   been defined. (See {Kookaburra::Configuration#application}.)
+    #
+    # @raise [Kookaburra::AmbiguousDriverError] if named applications have been
+    #   configured.
+    def_delegator :kookaburra, :ui
+
+    # Delegates to main {Kookaburra} instance
+    def get_data(*args)
+      main_kookaburra.get_data(*args)
     end
 
-    # @method api
-    # Delegates to {#k}
-    def_delegator :k, :api
+    # Will return the {Kookaburra} instance for any configured applications
+    #
+    # After an application is configured via
+    # {Kookaburra::Configuration#application}, the TestHelpers will respond to
+    # the name of that application by returning the associated Kookaburra
+    # instance. (Messages that do not match the name of a configured application
+    # will be handled with the usual #method_missing semantics.)
+    #
+    # @see [Kookaburra::Configuration#application]
+    def method_missing(method_name, *args, &block)
+      Kookaburra.configuration.applications[method_name.to_sym] \
+        || super
+    end
 
-    # @method ui
-    # Delegates to {#k}
-    def_delegator :k, :ui
+    # @see [Kookaburra::TestHelpers#method_missing]
+    def respond_to?(method_name)
+      Kookaburra.configuration.applications.has_key?(method_name) \
+        || super
+    end
+
+    private
+
+    def kookaburra
+      if Kookaburra.configuration.has_named_applications?
+        raise AmbiguousDriverError
+      end
+      main_kookaburra
+    end
+
+    def main_kookaburra
+      @kookaburra ||= Kookaburra.new
+    end
   end
 end

data/lib/kookaburra/ui_driver/ui_component.rb

@@ -106,15 +106,22 @@ class Kookaburra
       end
 
       # Is the component's element found on the page and is it considered
-      # "visible" by the browser driver.
+      # "visible" by the browser driver?
       def visible?
-        visible = browser.has_css?(component_locator, :visible)
+        visible = browser.has_css?(component_locator, visible: true)
         unless visible
           detect_server_error!
         end
         visible
       end
 
+      # The opposite of {#visible?}
+      #
+      # @note This does not check for a server error.
+      def not_visible?
+        browser.has_no_css?(component_locator, visible: true)
+      end
+
       # Returns the full URL by appending {#component_path} to the value of the
       # {Kookaburra::Configuration#app_host} from the initialized configuration.
       def url(*args)