bryan-ash-wx-nobbie 0.0.3.5 → 0.0.4

data/{README.txt → README.rdoc}

@@ -13,14 +13,14 @@ ways to find components and subsequently multiple ways to interact with them, No
 (Note: if you can't sleep without the ability to find things using xpath or whatever, there are hooks to specify your
 own component finding strategies).
 
-With this in mind, Nobbie provides a simple method of {finding components}[link:classes/Nobbie/Wx/ElementPathBuilder.html]
-and a simple set of {Operations}[link:classes/Nobbie/Wx/Operations.html] to perform on them.
+With this in mind, Nobbie provides a simple method of finding components (using ElementPathBuilder)
+and a simple set of <tt>Operations</tt> to perform on them.
 
 A quick overview with examples:
 
 * Paths ...
 
-  In order to perform operations[link:classes/Nobbie/Wx/Operations.html] on a component, you need to first find it.
+  In order to perform operations on a component, you need to first find it.
   Only very simple 'named' paths are supported by default (but you can implement your own by providing an object that
   responds to 'find_component'). When specifying a path, if you do not provide an object that responds to
   'find_component', Nobbie will attempt to coerce the path into the default path type: Nobbie::Wx::ElementPathBuilder.
@@ -35,69 +35,66 @@ A quick overview with examples:
    :text_ctrl
 
 
-* Typing[link:classes/Nobbie/Wx/Operations.html#type] ...
+* Typing ...
 
    type(value, path)
 
   e.g.
 
    type('fred', in_('first_name'))
-   
+
   ...or if you're one of those DSL/anglification people
-   
+
    type 'fred', :in => 'first_name'
    type 'fred', 'first_name'
    type 'fred', :first_name
-   
+
   This will find the component named 'first_name' and type 'fred' into it.
-  ...this works for anything you can type into, see:
-  {supported components}[link:classes/Nobbie/Wx/Operations.html#type].
+  ...this works for anything you can type into.
 
 
-* Selecting[link:classes/Nobbie/Wx/Operations.html#selection] ...
+* Selecting ...
 
    selection(path).choose(value)
 
   e.g.
 
    selection(in_('title')).choose('Mr')
-   
+
   ...or
-   
+
    selection(:in => 'title').choose 'Mr'
    selection('title').choose 'Mr'
    selection(:title).choose 'Mr'
 
   This will find the component named 'title' and select 'Mr'.
   ...this works for anything where you can make a selection from a number of options
-  (which is quite a lot of things), see:
-  {supported components}[link:classes/Nobbie/Wx/SelectOperations.html#selection].
+  (which is quite a lot of things).
 
   You can get the value of the current selection using:
 
    selection(path).selected_value
 
 
-* Clicking[link:classes/Nobbie/Wx/Operations.html#click] ...
+* Clicking ...
 
    click(path) (for buttons you can also use the label instead of a path)
 
   e.g.
 
    click('save')
-   
+
   ...or
-   
+
    click 'save'
    click :save
    etc
-   
+
   This will find the component named (or labelled) 'save' and click it.
-  ...this works for anything you can click, see:
-  {supported components}[link:classes/Nobbie/Wx/Operations.html#click].
+  ...this works for anything you can click.
 
 
-* Choosing[link:classes/Nobbie/Wx/Operations.html#choosable] ...
+* Choosing ...
 
    choosable(path).choose
 
@@ -112,15 +109,14 @@ A quick overview with examples:
    choosable(:female).choose
 
   This will find the component named 'female' and choose it
-  ...this works for anything that has a chosen/non-chosen state, see:
-  {supported components}[link:classes/Nobbie/Wx/ChoosableOperations.html#choose].
+  ...this works for anything that has a chosen/non-chosen state.
 
   You can determine if a component is currently chosen using:
 
    choosable(path).chosen?
 
 Hopefully that makes some degree of sense, there are a few other operations available, that should be self
-explanatory from the documentation[link:classes/Nobbie/Wx/Operations.html].
+explanatory from the documentation.
 
 * Writing that first test ...
 

data/Rakefile

@@ -0,0 +1,59 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'spec/rake/spectask'
+require 'cucumber/rake/task'
+require 'rcov/rcovtask'
+
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+task :verify_rcov => [:spec, :features]
+task :default => :verify_rcov
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  unless ENV['NO_RCOV']
+    t.rcov = true
+    t.rcov_opts << '--text-report'
+    t.rcov_opts << '--exclude features\/,spec\/'
+    t.rcov_opts << '--sort coverage'
+  end
+end
+
+desc "Run Cucumber features"
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = '--format pretty'
+  t.rcov = true
+  t.rcov_opts << '-o coverage'
+  t.rcov_opts << '--text-report'
+  t.rcov_opts << '--exclude features\/,spec\/'
+  t.rcov_opts << '--sort coverage'
+end
+
+desc "Run unit tests"
+Rcov::RcovTask.new(:test) do |t|
+  t.pattern = FileList['test/all_tests.rb']
+  t.verbose = true
+  t.rcov_opts << '--sort coverage'
+end
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /(FIXME|todo|TBD)/
+end

data/features/acceptance_test.feature

@@ -2,7 +2,42 @@ In order to test drive a WxRuby application
 As a developer
 I want Nobbie to provide acceptance test access to the application
 
-Scenario: An application is provided
-  Given a test application exists
-  When a Nobbie acceptance test is started on the application
-  Then the application is running
+  Scenario: Choosing a radio button
+    Then "radio_button" is not chosen
+    When I choose "radio_button"
+    Then "radio_button" is chosen
+
+  Scenario: Choosing a check box
+    Then "check_box" is not chosen
+    When I choose "check_box"
+    Then "check_box" is chosen
+
+  Scenario: Type into a text control
+    When I type "123" into "text_ctrl"
+    Then I should see "123" in "text_ctrl"
+
+  Scenario: Type into a combo box
+    When I type "456" into "combo_box"
+    Then I should see "456" in "combo_box"
+
+  Scenario: Click on a button
+    When I click on "button"
+
+  Scenario Outline: Working with selectables
+    Given "<selectable>" includes "<value>"
+    When I select "<value>" on the "<selectable>"
+    Then "<value>" on the "<selectable>" should be selected
+
+  Examples:
+    | selectable           | value          |
+    | combo_box_with_items | combo_box_item |
+    | list_box_with_items  | list_box_item  |
+    | test_notebook        | click          |
+
+  Scenario: Enabled controls
+    Then "text_ctrl" is enabled
+    Then "disabled_text_ctrl" is not enabled
+
+  Scenario: Working with menus
+    When I select "&New..." on the "&File"
+

data/features/step_definitions/acceptance_test_steps.rb

@@ -1,11 +1,48 @@
-Given /^a test application exists$/ do
-  @app = ExampleApp.new
+When /^I choose "(.*)"$/ do |item|
+  choosable(item).choose
 end
 
-When /^a Nobbie acceptance test is started on the application$/ do
-  Nobbie::Wx::ApplicationLauncher.new(@app).start
+When /^I type "(.*)" into "(.*)"$/ do |value, item|
+  type value, :in => item
+end
+
+When /^I click on "(.*)"$/ do |item|
+  click item
+end
+
+When /^I select "(.*)" on the "(.*)"$/ do |value, selectable|
+  selection(:in => selectable).choose value
+end
+
+Then /^I should see "(.*)" in "(.*)"$/ do |value, item|
+  text(item).should == value
 end
 
 Then /^the application is running$/ do
   @app.is_main_loop_running.should be_true
 end
+
+Then /^"(.*)" is chosen$/ do |item|
+  choosable(item).should be_chosen
+end
+
+Then /^"(.*)" is not chosen$/ do |item|
+  choosable(item).should_not be_chosen
+end
+
+Then /^"(.*)" on the "(.*)" should be selected$/ do |value, selectable|
+  selection(:in => selectable).selected_value.should == value
+end
+
+Then /^"(.*)" includes "(.*)"$/ do |selectable, value|
+  selection(:in => selectable).options.should include(value)
+end
+
+Then /^"(.*)" is enabled$/ do |item|
+  enabled?(item).should be_true
+end
+
+Then /^"(.*)" is not enabled$/ do |item|
+  enabled?(item).should_not be_true
+end
+

data/features/support/env.rb

@@ -1,12 +1,9 @@
+require 'rubygems'
 require 'spec'
 
-$LOAD_PATH.unshift File.dirname(__FILE__) + "/../../lib"
-$LOAD_PATH.unshift File.dirname(__FILE__) + "/../../test/suite"
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+require 'nobbie/wx'
 
-require 'example_app'
+require File.dirname(__FILE__) + '/../../test/suite/example_app'
 
-require 'nobbie/wx/application_launcher'
-
-After do
-  @app.exit_main_loop unless @app.nil?
-end
+Nobbie::Wx::ApplicationLauncher.new(ExampleApp.new(false)).run

data/lib/nobbie/wx.rb

@@ -0,0 +1,5 @@
+require 'nobbie/wx/platform'
+require 'nobbie/wx/application_launcher'
+require 'nobbie/wx/operations'
+
+include Nobbie::Wx::Operations

data/lib/nobbie/wx/application_launcher.rb

@@ -17,22 +17,23 @@ module Nobbie
 
     class ApplicationLauncher #:nodoc:
 
-      AUT_NOT_WX_APP = "APPLICATION_UNDER_TEST must be an instance of a Wx::App"
+      AUT_NOT_WX_APP = "application_under_test must be an instance of a Wx::App"
 
       def initialize(application_under_test)
         @app = application_under_test
         Kernel.raise(AUT_NOT_WX_APP) unless @app.is_a?(Wxruby2::App)
       end
 
-      def with_application
+      def run
         start
-        result = yield
+        set_top_window_for_use_in_operations
+        Thread.pass
         stop
-        result
       end
 
+      private
+
       def start
-        puts "\n>> Starting application: #{@app.class}"
         start = Time.now
 
         @app_thread = Thread.new {
@@ -44,19 +45,20 @@ module Nobbie
         @app_thread.priority = -1
 
         sleep 1
-        finish = Time.now
-        puts "\n>> Took #{finish-start} seconds to start application"
         Thread.pass
       end
 
       def stop
-        puts "\n>> Stopping application: #{@app.class}\n"
-
-        #todo: tbis would seem a polite way to exit .. but causes Bus/Segmentation Errors on OSX.
+        #todo: this would seem a polite way to exit .. but causes Bus/Segmentation Errors on OSX.
         #@app.top_window.destroy
         #@app.exit_main_loop
         #@app = nil
       end
+
+      def set_top_window_for_use_in_operations
+        Nobbie::Wx::Operations.const_set("TOP_WINDOW",  @app.get_top_window)
+      end
+
     end
 
   end

data/lib/nobbie/wx/command.rb

@@ -34,12 +34,8 @@ module Nobbie
 
           begin
             unless [Menu, Panel].include?(component.class)
-              #puts "highlight on: #{component.class} - #{component.name}"
               original_colour = component.background_colour
               component.background_colour = Colour.from_hex('#FFFF00')
-
-              #todo: these were previously disabled
-#              component.refresh
               component.update
             end
             result = yield component
@@ -49,10 +45,8 @@ module Nobbie
             return result
           ensure
             unless [Menu, Panel].include?(component.class)
-              #puts "highlight off: #{component.class} - #{component.name}"
               component.background_colour = original_colour
               component.refresh
-              #component.update
             end
           end
         end

data/lib/nobbie/wx/command/console_reporter.rb

@@ -0,0 +1,30 @@
+
+require 'nobbie/wx/command/reporter'
+
+module Nobbie
+  module Wx
+    module Command
+
+      class ConsoleReporter < Reporter #:nodoc:
+
+        def before_executing_command(command)
+          STDOUT.puts "\n> #{command.describe}"
+        end
+
+        def after_executing_command(result)
+          STDOUT.puts "< #{render(result)}"
+        end
+
+        private
+
+        def render(component)
+          #todo: this needs improving to support other components
+          return '' if component.nil?
+          return component.value if component.respond_to?(:get_value)
+          return component.inspect
+        end
+      end
+
+    end
+  end
+end

data/lib/nobbie/wx/command/executor.rb

@@ -0,0 +1,25 @@
+
+require 'nobbie/wx/command/reporter'
+
+module Nobbie
+  module Wx
+    module Command
+
+      class Executor #:nodoc:
+
+        def initialize(reporter = Reporter.new)
+          @reporter = reporter
+        end
+
+        def execute(command)
+          @reporter.before_executing_command(command)
+          result = command.execute
+          @reporter.after_executing_command(result)
+          result
+        end
+
+      end
+
+    end
+  end
+end

data/lib/nobbie/wx/command/reporter.rb

@@ -0,0 +1,17 @@
+module Nobbie
+  module Wx
+    module Command
+
+      class Reporter #:nodoc:
+
+        def before_executing_command(command)
+        end
+
+        def after_executing_command(result)
+        end
+
+      end
+
+    end
+  end
+end