kookaburra 0.25.0 → 0.26.0

data/Gemfile

@@ -13,4 +13,5 @@ group :development do
   gem 'jeweler'
   gem 'reek'
   gem 'sinatra'
+  gem 'find_a_port', '>= 1.0.1'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.7)
+    addressable (2.3.2)
     capybara (1.1.2)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -9,23 +9,24 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    childprocess (0.3.1)
-      ffi (~> 1.0.6)
+    childprocess (0.3.4)
+      ffi (~> 1.0, >= 1.0.6)
     diff-lcs (1.1.3)
-    ffi (1.0.11)
+    ffi (1.1.0)
+    find_a_port (1.0.1)
     git (1.2.5)
-    jeweler (1.8.3)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.6.6)
-    json_pure (1.7.3)
-    libwebsocket (0.1.3)
+    json (1.7.4)
+    json_pure (1.7.4)
+    libwebsocket (0.1.5)
       addressable
-    mime-types (1.18)
-    multi_json (1.2.0)
-    nokogiri (1.5.2)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
     patron (0.4.18)
     rack (1.4.1)
     rack-protection (1.2.0)
@@ -36,31 +37,33 @@ GEM
     rdoc (3.12)
       json (~> 1.4)
     redcarpet (1.17.2)
-    reek (1.2.8)
-      ruby2ruby (~> 1.2)
+    reek (1.2.12)
+      ripper_ruby_parser (~> 0.0.7)
+      ruby2ruby (~> 1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
+    ripper_ruby_parser (0.0.8)
+      sexp_processor (~> 3.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    ruby2ruby (1.3.1)
+    rspec-mocks (2.11.1)
+    ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
-    rubyzip (0.9.7)
-    selenium-webdriver (2.21.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
       childprocess (>= 0.2.5)
-      ffi (~> 1.0)
       libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)
       rubyzip
-    sexp_processor (3.1.0)
+    sexp_processor (3.2.0)
     sinatra (1.3.2)
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
@@ -68,13 +71,14 @@ GEM
     tilt (1.3.3)
     xpath (0.1.4)
       nokogiri (~> 1.3)
-    yard (0.7.5)
+    yard (0.8.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   capybara
+  find_a_port (>= 1.0.1)
   jeweler
   json_pure
   patron

data/VERSION

@@ -1 +1 @@
-0.25.0
+0.26.0

data/kookaburra.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "kookaburra"
-  s.version = "0.25.0"
+  s.version = "0.26.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger", "Sam Livingston-Gray", "Ravi Gadad"]
-  s.date = "2012-07-08"
+  s.date = "2012-07-27"
   s.description = "Cucumber + Capybara = Kookaburra? It made sense at the time."
   s.email = "johnwilger@gmail.com"
   s.extra_rdoc_files = [
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/kookaburra/mental_model_matcher.rb",
     "lib/kookaburra/test_helpers.rb",
     "lib/kookaburra/ui_driver.rb",
+    "lib/kookaburra/ui_driver/has_ui_components.rb",
     "lib/kookaburra/ui_driver/ui_component.rb",
     "lib/kookaburra/ui_driver/ui_component/address_bar.rb",
     "spec/integration/test_a_rack_application_spec.rb",
@@ -53,6 +54,7 @@ Gem::Specification.new do |s|
     "spec/kookaburra/ui_driver/ui_component_spec.rb",
     "spec/kookaburra/ui_driver_spec.rb",
     "spec/kookaburra_spec.rb",
+    "spec/support/shared_examples/it_can_have_ui_components.rb",
     "spec/support/shared_examples/it_can_make_assertions.rb",
     "spec/support/shared_examples/it_has_a_dependency_accessor.rb"
   ]
@@ -75,6 +77,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<reek>, [">= 0"])
       s.add_development_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<find_a_port>, [">= 1.0.1"])
     else
       s.add_dependency(%q<patron>, [">= 0"])
       s.add_dependency(%q<json_pure>, [">= 0"])
@@ -85,6 +88,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<reek>, [">= 0"])
       s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<find_a_port>, [">= 1.0.1"])
     end
   else
     s.add_dependency(%q<patron>, [">= 0"])
@@ -96,6 +100,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<reek>, [">= 0"])
     s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<find_a_port>, [">= 1.0.1"])
   end
 end
 

data/lib/kookaburra/ui_driver/has_ui_components.rb

@@ -0,0 +1,28 @@
+class Kookaburra
+  class UIDriver
+    # Classes that can contain reerences to {UIComponent} instances
+    # (i.e. {UIDriver} and {UIDriver::UIComponent} subclasses are
+    # extended by this module in order to set up those references.
+    # `UIDriver` and `UIComponent` are already extended, so you
+    # shouldn't need to do so elsewhere.
+    #
+    # Instances of the extending class must define a `#configuration`
+    # method that returns the current Kookaburra::Configuration
+    module HasUIComponents
+
+      # Tells the extending UIDriver or UIComponent about your {UIComponent} subclasses.
+      #
+      # @param [Symbol] component_name Will create an instance method of this
+      #   name that returns an instance of the component_class
+      # @param [Class] component_class The {UIComponent} subclass that defines
+      #   this component.
+      # @param [Hash] options An extra options hash that will be passed
+      #   to the `UIComponent` on initialization.
+      def ui_component(component_name, component_class, options = {})
+        define_method(component_name) do
+          component_class.new(configuration, options)
+        end
+      end
+    end
+  end
+end

data/lib/kookaburra/ui_driver/ui_component.rb

@@ -1,5 +1,6 @@
 require 'kookaburra/exceptions'
 require 'kookaburra/assertion'
+require 'kookaburra/ui_driver/has_ui_components'
 
 class Kookaburra
   class UIDriver
@@ -67,6 +68,15 @@ class Kookaburra
     #   override the {#component_path} method.
     class UIComponent
       include Assertion
+      extend HasUIComponents
+
+      # The {Kookaburra::Configuration} with which the component
+      # instance was instantiated.
+      attr_reader :configuration
+
+      # The options Hash with which the component instance was
+      # instantiated.
+      attr_reader :options
 
       # New UIComponent instances are typically created for you by your
       # {Kookaburra::UIDriver} instance.
@@ -74,7 +84,11 @@ class Kookaburra
       # @see Kookaburra::UIDriver.ui_component
       #
       # @param [Kookaburra::Configuration] configuration
-      def initialize(configuration)
+      # @param [Hash] options An options hash that can be used to
+      #   further configure a `UIComponent`'s behavior.
+      def initialize(configuration, options = {})
+        @configuration = configuration
+        @options = options
         @browser = configuration.browser
         @app_host = configuration.app_host
         @server_error_detection = configuration.server_error_detection

data/lib/kookaburra/ui_driver.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'kookaburra/assertion'
+require 'kookaburra/ui_driver/has_ui_components'
 require 'kookaburra/ui_driver/ui_component'
 require 'kookaburra/ui_driver/ui_component/address_bar'
 
@@ -60,20 +61,9 @@ class Kookaburra
   class UIDriver
     include Assertion
     extend Forwardable
+    extend HasUIComponents
 
     class << self
-      # Tells the UIDriver about your {UIComponent} subclasses.
-      #
-      # @param [Symbol] component_name Will create an instance method of this
-      #   name that returns an instance of the component_class
-      # @param [Class] component_class The {UIComponent} subclass that defines
-      #   this component.
-      def ui_component(component_name, component_class)
-        define_method(component_name) do
-          component_class.new(@configuration)
-        end
-      end
-
       # Tells the UIDriver about sub-drivers (other {UIDriver} subclasses).
       #
       # @param [Symbol] driver_name Will create an instance method of this

data/spec/integration/test_a_rack_application_spec.rb

@@ -2,22 +2,14 @@ require 'kookaburra/test_helpers'
 require 'kookaburra/json_api_driver'
 require 'capybara'
 require 'thwait'
+require 'find_a_port'
 
 # These are required for the Rack app used for testing
 require 'sinatra/base'
 require 'json'
 
-# You'd think there would be a better way to do this, but if there is, I
-# can't find it.
-def find_available_port
-  server = TCPServer.new('127.0.0.1', 0)
-  server.addr[1]
-ensure
-  server.close if server
-end
-
 # The server port to which the application server will attach
-APP_PORT = find_available_port
+APP_PORT = FindAPort.available_port
 
 describe "testing a Rack application with Kookaburra" do
   describe "with an HTML interface" do
@@ -234,7 +226,33 @@ describe "testing a Rack application with Kookaburra" do
         end
       end
 
+      class WidgetDataContainer
+        def initialize(element)
+          @element = element
+        end
+
+        def to_hash
+          {
+            'id' => @element.find('.id').text,
+            'name' => @element.find('.name').text
+          }
+        end
+      end
+
+      class LastWidgetCreated < Kookaburra::UIDriver::UIComponent
+        def component_locator
+          @options[:component_locator]
+        end
+
+        def data
+          raise "Foo" unless visible?
+          WidgetDataContainer.new(self).to_hash
+        end
+      end
+
       class WidgetList < Kookaburra::UIDriver::UIComponent
+        ui_component :last_widget_created, LastWidgetCreated, :component_locator => '#widget_list .last_widget.created'
+
         def component_path
           '/widgets'
         end
@@ -245,15 +263,10 @@ describe "testing a Rack application with Kookaburra" do
 
         def widgets
           all('.widget_summary').map do |el|
-            extract_widget_data(el)
+            WidgetDataContainer.new(el).to_hash
           end
         end
 
-        def last_widget_created
-          element = find('.last_widget.created')
-          extract_widget_data(element)
-        end
-
         def choose_to_create_new_widget
           click_on 'New Widget'
         end
@@ -261,15 +274,6 @@ describe "testing a Rack application with Kookaburra" do
         def choose_to_delete_widget(widget_data)
           find("#delete_#{widget_data['id']}").click_button('Delete')
         end
-
-        private
-
-        def extract_widget_data(element)
-          {
-            'id' => element.find('.id').text,
-            'name' => element.find('.name').text
-          }
-        end
       end
 
       class WidgetForm < Kookaburra::UIDriver::UIComponent
@@ -301,7 +305,7 @@ describe "testing a Rack application with Kookaburra" do
           assert widget_list.visible?, "Widget list is not visible!"
           widget_list.choose_to_create_new_widget
           widget_form.submit('name' => 'My Widget')
-          mental_model.widgets[name] = widget_list.last_widget_created
+          mental_model.widgets[name] = widget_list.last_widget_created.data
         end
 
         def delete_widget(name)
@@ -352,6 +356,7 @@ describe "testing a Rack application with Kookaburra" do
 
         ui.create_new_widget(:widget_c, :name => 'Bar')
 
+
         # As above, these are equivalent, but the second line is preferred.
         ui.widget_list.widgets.should == k.get_data(:widgets).values_at(:widget_a, :widget_b, :widget_c)
         ui.widget_list.widgets.should match_mental_model_of(:widgets)

data/spec/kookaburra/json_api_driver_spec.rb

@@ -50,7 +50,7 @@ describe Kookaburra::JsonApiDriver do
     end
 
     it 'returns the JSON-decoded response body' do
-      json.post('/foo', 'bar').should == {'foo' => 'bar'}
+      json.post('/foo', :bar => :baz).should == {'foo' => 'bar'}
     end
   end
 
@@ -63,7 +63,7 @@ describe Kookaburra::JsonApiDriver do
     end
 
     it 'returns the JSON-decoded response body' do
-      json.put('/foo', 'bar').should == {'foo' => 'bar'}
+      json.put('/foo', :bar => :baz).should == {'foo' => 'bar'}
     end
   end
 

data/spec/kookaburra/ui_driver/ui_component_spec.rb

@@ -1,10 +1,13 @@
 require 'kookaburra/ui_driver/ui_component'
 require 'support/shared_examples/it_can_make_assertions'
+require 'support/shared_examples/it_can_have_ui_components'
 
 describe Kookaburra::UIDriver::UIComponent do
   let(:configuration) { stub('Configuration', :browser => nil, :app_host => nil, :server_error_detection => nil) }
   let(:component) { Kookaburra::UIDriver::UIComponent.new(configuration) }
 
+  it_behaves_like :it_can_have_ui_components, Kookaburra::UIDriver::UIComponent
+
   describe '#respond_to?' do
     let(:component) do
       klass = Class.new(Kookaburra::UIDriver::UIComponent) do

data/spec/kookaburra/ui_driver_spec.rb

@@ -1,23 +1,10 @@
 require 'kookaburra/ui_driver'
 require 'support/shared_examples/it_has_a_dependency_accessor'
 require 'support/shared_examples/it_can_make_assertions'
+require 'support/shared_examples/it_can_have_ui_components'
 
 describe Kookaburra::UIDriver do
-  describe '.ui_component' do
-    it 'adds an accessor method for the named component that defaults to an instance of the specified class' do
-      foo_component_class = mock(Class)
-      foo_component_class.should_receive(:new) \
-        .with(:configuration) \
-        .and_return(:a_foo_component)
-
-      ui_driver_class = Class.new(Kookaburra::UIDriver) do
-        ui_component :foo, foo_component_class
-      end
-
-      ui = ui_driver_class.new(:configuration)
-      ui.foo.should == :a_foo_component
-    end
-  end
+  it_behaves_like :it_can_have_ui_components, Kookaburra::UIDriver
 
   describe '.ui_driver' do
     it 'adds an accessor method for the named driver that defaults to an instance of the specified class' do

data/spec/support/shared_examples/it_can_have_ui_components.rb

@@ -0,0 +1,18 @@
+shared_examples_for :it_can_have_ui_components do |subject_class|
+  describe '.ui_component' do
+    it 'adds an accessor method for the named component that defaults to an instance of the specified class' do
+      configuration = stub('Kookaburra::Configuration').as_null_object
+      foo_component_class = mock(Class)
+      foo_component_class.should_receive(:new) \
+        .with(configuration, :option => :value) \
+        .and_return(:a_foo_component)
+
+      component_container_class = Class.new(subject_class) do
+        ui_component :foo, foo_component_class, :option => :value
+      end
+
+      component_container = component_container_class.new(configuration)
+      component_container.foo.should == :a_foo_component
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kookaburra
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-08 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -157,6 +157,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: find_a_port
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: Cucumber + Capybara = Kookaburra? It made sense at the time.
 email: johnwilger@gmail.com
 executables: []
@@ -188,6 +204,7 @@ files:
 - lib/kookaburra/mental_model_matcher.rb
 - lib/kookaburra/test_helpers.rb
 - lib/kookaburra/ui_driver.rb
+- lib/kookaburra/ui_driver/has_ui_components.rb
 - lib/kookaburra/ui_driver/ui_component.rb
 - lib/kookaburra/ui_driver/ui_component/address_bar.rb
 - spec/integration/test_a_rack_application_spec.rb
@@ -201,6 +218,7 @@ files:
 - spec/kookaburra/ui_driver/ui_component_spec.rb
 - spec/kookaburra/ui_driver_spec.rb
 - spec/kookaburra_spec.rb
+- spec/support/shared_examples/it_can_have_ui_components.rb
 - spec/support/shared_examples/it_can_make_assertions.rb
 - spec/support/shared_examples/it_has_a_dependency_accessor.rb
 homepage: http://github.com/projectdx/kookaburra
@@ -218,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3008907103704146289
+      hash: -40301256200075417
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: