wx-nobbie 0.0.2

data/lib/nobbie/wx/operations.rb

@@ -0,0 +1,85 @@
+require 'nobbie/wx/platform'
+require 'nobbie/wx/command_factory'
+require 'nobbie/wx/launcher'
+
+impl = File.dirname(__FILE__) + File::SEPARATOR + 'impl'
+Dir.glob("#{impl}/**/*.rb") {|f| require "#{f}" }
+
+module Nobbie
+  module Wx
+
+    module Operations
+
+      # Types text into the component specified in the path.
+      #  Supported components: TextCtrl, ComboBox
+      def type(text, path)
+        execute(command_factory.create_type_into_command(coerce_path(path), text))
+      end
+
+      # Clicks the component specified in the path.
+      #  Supported components: Button
+      def click(path)
+        execute(command_factory.create_click_on_command(coerce_path(path)))
+      end
+
+      # Returns the component specified in the path.  Useful for performing operations that Nobbie does not
+      # currently support.
+      #  Supported components: Any
+      def component(path)
+        execute(command_factory.create_get_component_command(coerce_path(path)))
+      end
+
+      # Returns a SelectionOperations[link:classes/Nobbie/Wx/SelectOperations.html] for interacting with
+      # the component specified in the path
+      def selection(path)
+        SelectOperations.new(self, coerce_path(path))
+      end
+
+      # Returns a ChoosableOperations[link:classes/Nobbie/Wx/ChoosableOperations.html] for interacting with
+      # the component specified in the path
+      def choosable(path)
+        ChoosableOperations.new(self, coerce_path((path)))
+      end
+
+      # Determines if the component specified in the path is currently enabled.
+      #  Supported components: Any
+      def enabled?(path)
+        execute(command_factory.create_is_enabled_command(coerce_path(path)))
+      end
+
+      # Creates an instance of the default {path builder}[link:classes/Nobbie/Wx/ElementPathBuilder.html].
+      # Override this method if you wish to provide an alternative default path builder (because coerce_path
+      # uses in_() internally).
+      def in_(name)
+        ElementPathBuilder.new(name)
+      end
+
+      # Creates an instance of the default {command factory}[link:classes/Nobbie/Wx/CommandFactory.html].
+      # Override this method if you wish to provide an alternative command factory.
+      def command_factory
+        Command::Factory.new
+      end
+
+      private
+     
+      def coerce_path(path)
+        return path if path.respond_to?(:find_component)
+
+        if path.is_a?(Hash) && path.has_key?(:in)
+          return path[:in].is_a?(String) ? in_(path[:in]) : path[:in]
+        end
+
+        return in_(path.id2name) if path.is_a?(Symbol)
+        return in_(path) if path.is_a?(String)
+
+        Kernel.raise("Unable to coerce path: #{path}")
+      end
+     
+      #todo: pull up
+      def execute(command)
+        Command::Executor.new.execute(command)
+      end
+    end
+    
+  end
+end

data/lib/nobbie/wx/platform.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'wx'
+
+#todo: move this into Nobbie::Wx namespace ... once name clash is fixed
+class Platform #:nodoc:
+  include Wx
+
+  WINDOWS = 'WXMSW'
+  MAC = 'WXMAC'
+  SUPPORTED_PLATFORMS = [WINDOWS, MAC]
+
+  def self.windows?
+    name == WINDOWS
+  end
+
+  def self.ensure_supported
+    Kernel.raise "Sorry '#{name}' is not currently supported, Nobbie-Wx is only available for the following platforms: [#{SUPPORTED_PLATFORMS.join(',')}]" unless supported?
+  end
+
+  private
+
+  def self.supported?
+    SUPPORTED_PLATFORMS.include?(name)
+  end
+
+  def self.name
+    Wx::PLATFORM
+  end
+end
+
+Platform.ensure_supported

data/test/all_tests.rb

@@ -0,0 +1,6 @@
+
+require 'rubygems'
+require_gem 'nobbie-wx'
+require_all_in_directory [File.dirname(__FILE__), 'suite'].join(File::SEPARATOR)
+
+APPLICATION_UNDER_TEST = TestApp.new

data/test/suite/app.rb

@@ -0,0 +1,144 @@
+require 'rubygems'
+require 'wx'
+require 'wx_sugar'
+
+include Wx
+
+class TestFrame < Frame
+    def initialize(*args)
+      super
+
+      #todo: sort out all this :minsize => true stuff out .. need some way to specify defaults
+
+      panel = add(Panel, :proportion => 1)
+      panel.arrange_vertically(:padding => 4)
+
+      test_notebook = name('test_notebook', panel.add(Notebook, :minsize => true, :proportion => 2))
+
+      test_notebook.add_page(name('type', test_notebook.add(Panel) {|p| p.arrange_vertically
+        listen(:text, name('text_ctrl', p.add(TextCtrl[:value => 'text_ctrl'], :minsize => true)), :update)
+        listen(:text, name('readonly_text_ctrl', p.add(TextCtrl[:value => 'readonly_text_ctrl', :style => TE_READONLY], :minsize => true)), :update)
+        listen(:text, disable(name('disabled_text_ctrl', p.add(TextCtrl[:value => 'disabled_text_ctrl'], :minsize => true))), :update)
+
+        listen(:text, name('combo_box', p.add(ComboBox[:value => 'combo_box'], :minsize => true)), :update)
+        readonly_combo_box = name('readonly_combo_box', p.add(ComboBox[:style => CB_READONLY], :minsize => true))
+        readonly_combo_box.append('readonly_combo_box')
+        readonly_combo_box.selection = 0
+        listen(:text, readonly_combo_box, :update)
+        listen(:text, disable(name('disabled_combo_box', p.add(ComboBox[:value => 'disabled_combo_box'], :minsize => true))), :update)
+      }), 'type')
+
+      test_notebook.add_page(name('click', test_notebook.add(Panel, :minsize => true) {|p| p.arrange_vertically
+        listen(:button, name('button', p.add(Button[:label => 'regular_button'], :minsize => true)), :update)
+        listen(:button, name('labelled_button_name', p.add(Button[:label => 'labelled_button'], :minsize => true)), :update)
+        listen(:button, disable(name('disabled_button', p.add(Button[:label => 'disabled_button'], :minsize => true))), :update)
+        name('static_text', p.add(StaticText[:label => 'static_text'], :minsize => true))
+      }), 'click')
+
+      test_notebook.add_page(name('selection', test_notebook.add(Panel) {|p| p.arrange_vertically
+        notebook = name('notebook', p.add(Notebook, :minsize => true))
+        notebook.add_page(name('notebook_page1', notebook.add(Panel)), 'notebook_page1')
+        notebook.add_page(name('notebook_page2', notebook.add(Panel)), 'notebook_page2')
+        notebook.evt_notebook_page_changing(notebook.get_id()) {|e| update(e) }
+
+        disabled_notebook = disable(name('disabled_notebook', p.add(Notebook, :minsize => true)))
+        disabled_notebook.add_page(name('disabled_notebook_page1', disabled_notebook.add(Panel)), 'disabled_notebook_page1')
+        disabled_notebook.add_page(name('disabled_notebook_page2', disabled_notebook.add(Panel)), 'disabled_notebook_page2')
+        disabled_notebook.evt_notebook_page_changing(disabled_notebook.get_id()) {|e| update(e) }
+
+        #todo: make me have a visible name on screen
+        combo_box_with_items = name('combo_box_with_items', p.add(ComboBox, :minsize => true))
+        combo_box_with_items.append('combo_box_item')
+        listen(:combobox, combo_box_with_items, :update)
+
+        disabled_combo_box_with_items = disable(name('disabled_combo_box_with_items', p.add(ComboBox, :minsize => true)))
+        disabled_combo_box_with_items.append('disabled_combo_box_item1')
+        disabled_combo_box_with_items.append('disabled_combo_box_item2')
+        listen(:combobox, disabled_combo_box_with_items, :update)
+
+        list_box_with_items = name('list_box_with_items', p.add(ListBox, :minsize => true))
+        list_box_with_items.append('list_box_item')
+        listen(:listbox, list_box_with_items, :update)
+
+        disabled_list_box_with_items = disable(name('disabled_list_box_with_items', p.add(ListBox, :minsize => true)))
+        disabled_list_box_with_items.append('disabled_list_box_item1')
+        disabled_list_box_with_items.append('disabled_list_box_item2')
+        listen(:listbox, disabled_list_box_with_items, :update)
+
+        choice_with_items = name('choice_with_items', p.add(Choice, :minsize => true))
+        choice_with_items.append('choice_item')
+        listen(:choice, choice_with_items, :update)
+
+        disabled_choice_with_items = disable(name('disabled_choice_with_items', p.add(Choice, :minsize => true)))
+        disabled_choice_with_items.append('disabled_choice_item1')
+        disabled_choice_with_items.append('disabled_choice_item2')
+        listen(:choice, disabled_choice_with_items, :update)
+
+      }), 'selection')
+
+      test_notebook.add_page(name('choose', test_notebook.add(Panel) {|p| p.arrange_vertically
+        #todo: make me have a visible name on screen
+        listen(:radiobutton, name('radio_button', p.add(RadioButton, :minsize => true)), :update)
+
+        #todo: make me have a visible name on screen
+        listen(:radiobutton, disable(name('disabled_radio_button', p.add(RadioButton, :minsize => true))), :update)
+
+        #todo: make me have a visible name on screen
+        listen(:checkbox, name('check_box', p.add(CheckBox, :minsize => true)), :update)
+
+        #todo: make me have a visible name on screen
+        listen(:checkbox, disable(name('disabled_check_box', p.add(CheckBox, :minsize => true))), :update)
+
+      }), 'choose')
+
+      @log = name('log', panel.add(TextCtrl[:style => TE_READONLY | TE_MULTILINE], :minsize => true, :proportion => 1))
+
+      menu_bar = MenuBar.new
+      file_menu = Menu.new
+
+      #todo: remove these crappy id's ... there must be a nice sugary way to build menu's
+      file_new = file_menu.append(101, "&New...\tCtrl+N")
+      file_disabled = file_menu.append(102, "&disabled")
+
+      menu_bar.append(file_menu, '&File')
+      set_menu_bar(menu_bar)
+
+      #todo: make disable() handle menus ...
+      menu_bar.enable(102, false)
+
+      #todo: make update() handle menus ...
+      listen(:menu, @file_new) {|e| log('file_new') }
+   end
+
+  def on_init
+    self.update
+  end
+
+  private
+
+  def name(name, component)
+    component.name = name
+    component
+  end
+
+  def disable(component)
+    component.disable
+    component
+  end
+
+  def log(text)
+    @log.append_text(text)
+  end
+
+  def update(e)
+    @log.append_text("#{e.event_object.name}: #{e.string}\n")
+  end
+end
+
+class TestApp < App
+  def on_init
+    TestFrame.new(nil, :title => 'test', :size => [1024, 768]).show
+  end
+end
+
+TestApp.new.main_loop if __FILE__ == $0

data/test/suite/nobbie_test_case.rb

@@ -0,0 +1,46 @@
+module NobbieTestCase
+  include Nobbie::Wx
+
+  def setup
+    puts "\n[Started: #{name}]"
+    begin
+      select_tab_for_test
+    rescue ValueNotFoundException
+      #ok - this test doesn't have its own tab'
+    end
+  end
+
+  def teardown
+    puts "\n[Finished: #{name}]"
+  end
+  
+  def select_tab_for_test
+    clear_events
+    tab = self.class.name.gsub('Test', '').downcase
+    selection(:in => 'test_notebook').choose tab
+    assert_equal tab, selection(:in => 'test_notebook').selected_value
+  end
+
+  def text(component)
+    component.nil? ? nil : component.value
+  end
+
+  def clear_events
+    log.clear
+  end
+
+  def assert_exception(e)
+    assert_raise e do yield end
+    assert_events
+  end
+
+  def assert_events(expected_items=[])
+    expected_items = [expected_items] unless expected_items.is_a?(Array)
+    actual_items = text(log).split("\n")
+    assert_equal expected_items, actual_items
+  end
+
+  def log
+    component 'log'
+  end
+end

data/test/suite/test_choose.rb

@@ -0,0 +1,52 @@
+class TestChoose < Test::Unit::TestCase
+  include NobbieTestCase
+
+  #todo: rename file to choosable
+  #todo: should be TestChoosable
+  def test_choose_with_radio_button
+    assert !choosable('radio_button').chosen?
+    choosable('radio_button').choose
+    assert choosable('radio_button').chosen?
+    assert_events 'radio_button: '
+  end
+
+  def test_choose_with_check_box
+    assert !choosable('check_box').chosen?
+    choosable('check_box').choose
+    assert choosable('check_box').chosen?
+    assert_events 'check_box: '
+  end
+
+  def test_choose_with_component_disabled_radio_button
+    assert_exception ComponentDisabledException do choosable('disabled_radio_button').choose end
+  end
+
+  def test_choose_with_component_disabled_check_box
+    assert_exception ComponentDisabledException do choosable('disabled_check_box').choose end
+  end
+
+  def test_choose_with_unsupported_operation_for_component
+    assert_exception UnsupportedOperationForComponentException do choosable('button').choose end
+  end
+
+  def test_choose_with_component_not_found
+    assert_exception ComponentNotFoundException do choosable('missing').choose end
+  end
+
+  def test_chosen_with_unsupported_operation_for_component
+    assert_exception UnsupportedOperationForComponentException do choosable('button').chosen? end
+  end
+
+  def test_chosen_with_component_not_found
+    assert_exception ComponentNotFoundException do choosable('missing').chosen? end
+  end
+
+  def test_chosen_with_component_disabled_radio_button
+    assert !choosable('disabled_radio_button').chosen?
+  end
+
+  def test_chosen_with_component_disabled_check_box
+    assert !choosable('disabled_check_box').chosen?
+  end
+end
+

data/test/suite/test_click.rb

@@ -0,0 +1,28 @@
+class TestClick < Test::Unit::TestCase
+  include NobbieTestCase
+
+  def test_click_with_named_button
+    click 'button'
+    #todo: improve event detail
+    assert_events 'button: '
+  end
+
+  def test_click_with_labelled_button
+    click 'labelled_button'
+    #todo: improve event detail
+    assert_events 'labelled_button_name: '
+  end
+
+  def test_click_with_component_not_found
+    assert_exception ComponentNotFoundException do click 'missing' end
+  end
+  
+  def test_click_with_component_disabled
+    assert_exception ComponentDisabledException do click 'disabled_button' end
+  end
+
+  def test_click_with_unsupported_operation_for_component
+    assert_exception UnsupportedOperationForComponentException do click 'static_text' end
+  end
+end
+

data/test/suite/test_enabled.rb

@@ -0,0 +1,13 @@
+class TestEnabled < Test::Unit::TestCase
+  include NobbieTestCase
+
+  def test_enabled
+    assert enabled?('text_ctrl')
+    assert !enabled?('disabled_text_ctrl')
+  end
+
+  def test_enabled_with_component_not_found
+    assert_exception ComponentNotFoundException do enabled?('missing') end
+  end
+end
+

data/test/suite/test_launcher.rb

@@ -0,0 +1,22 @@
+class TestLauncher < Test::Unit::TestCase
+  
+  def test_application_under_test_is_not_defined
+    begin
+      Nobbie::Wx::ApplicationLauncher.module_eval('def get_application; raise NameError.new; end;')
+      Nobbie::Wx::ApplicationLauncher.new
+      fail
+    rescue RuntimeError => e
+      assert_equal Nobbie::Wx::ApplicationLauncher::AUT_NOT_DEFINED, e.message 
+    end
+  end
+
+  def test_application_under_test_is_not_a_wx_app
+    begin
+      Nobbie::Wx::ApplicationLauncher.module_eval('def get_application; String.new; end;')
+      Nobbie::Wx::ApplicationLauncher.new
+      fail
+    rescue RuntimeError => e
+      assert_equal Nobbie::Wx::ApplicationLauncher::AUT_NOT_WX_APP, e.message 
+    end
+  end
+end

data/test/suite/test_operations.rb

@@ -0,0 +1,27 @@
+class UserPathBuilder
+  def find_component
+    "something"
+  end
+end
+
+class TestOperations < Test::Unit::TestCase
+
+  def test_coerce_path
+    assert_path component('text_ctrl')
+    assert_path component(:in => 'text_ctrl')
+    assert_path component(in_('text_ctrl'))
+    assert_path component(Nobbie::Wx::ElementPathBuilder.new('text_ctrl'))
+    assert_path component(UserPathBuilder.new)
+    assert_path component(:text_ctrl)
+    begin
+      component(Hash.new)
+      fail
+    rescue RuntimeError => e
+      assert_equal 'Unable to coerce path: ', e.message
+    end
+  end
+  
+  def assert_path(path)
+    assert_not_nil path
+  end
+end