wxruby3 0.9.2 → 0.9.4

data/tests/test_event_handling.rb

@@ -13,10 +13,13 @@ class EventHandlingTests < Test::Unit::TestCase
     end
   end
 
+  CLIENT_DATA = {one: 'first'}
+
   class TestCmdEvent < Wx::CommandEvent
     EVT_TEST_CMD_EVENT = Wx::EvtHandler.register_class(self, nil, 'evt_test_cmd_event', 0)
     def initialize(id=0)
       super(EVT_TEST_CMD_EVENT, id)
+      set_client_object(CLIENT_DATA.dup) if id > 0
     end
   end
 
@@ -27,11 +30,18 @@ class EventHandlingTests < Test::Unit::TestCase
         super(parent)
         @test_event = false
         @test_cmd_event = false
+        @test_client_data = false
 
         evt_test_event { |evt| @test_event = true; evt.skip if evt.id > 0 }
-        evt_test_cmd_event { |evt| @test_cmd_event = true; evt.skip if evt.id > 0 }
+        evt_test_cmd_event do |evt|
+          @test_cmd_event = true
+          if evt.id > 0
+            @test_client_data = (evt.get_client_data == CLIENT_DATA)
+            evt.skip
+          end
+        end
       end
-      attr_reader :test_event, :test_cmd_event
+      attr_reader :test_event, :test_cmd_event, :test_client_data
 
       def reset
         @test_event = false
@@ -83,85 +93,93 @@ class EventHandlingTests < Test::Unit::TestCase
 
   def test_cmd_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.child.event_handler.process_event(TestCmdEvent.new)
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_false(win.child.test_client_data)
     win.reset
     win.child.event_handler.process_event(TestCmdEvent.new(1))
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_true(win.child.test_client_data)
     win.reset
     win.event_handler.process_event(TestCmdEvent.new)
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
   def test_queue_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.child.event_handler.queue_event(TestCmdEvent.new)
     Wx.get_app.yield
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_false(win.child.test_client_data)
     win.reset
     win.child.event_handler.queue_event(TestCmdEvent.new(1))
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_true(win.child.test_client_data)
     win.reset
     win.event_handler.queue_event(TestCmdEvent.new)
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
   def test_pending_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.child.event_handler.add_pending_event(TestCmdEvent.new)
     Wx.get_app.yield
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_false(win.child.test_client_data)
     win.reset
     win.child.event_handler.add_pending_event(TestCmdEvent.new(1))
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_true(win.child.test_client_data)
     win.reset
     win.event_handler.add_pending_event(TestCmdEvent.new)
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end
 
   def test_post_event
     win = TestFrame.new
-    assert(!win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     Wx.post_event(win.child.event_handler, TestCmdEvent.new)
     Wx.get_app.yield
-    assert(!win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_false(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_false(win.child.test_client_data)
     win.reset
     Wx.post_event(win.child.event_handler, TestCmdEvent.new(1))
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_true(win.child.test_cmd_event)
+    assert_true(win.child.test_client_data)
     win.reset
     Wx.post_event(win.event_handler, TestCmdEvent.new)
     Wx.get_app.yield
-    assert(win.test_cmd_event)
-    assert(!win.child.test_cmd_event)
+    assert_true(win.test_cmd_event)
+    assert_false(win.child.test_cmd_event)
     win.destroy
     Wx.get_app.yield
   end

data/tests/test_events.rb

@@ -20,19 +20,26 @@ class EventTests < Test::Unit::TestCase
   end
 
   def test_command_event
+    GC.start
     evt = Wx::CommandEvent.new(100, 1)
+    evt.set_client_object({one: 'first'})
     assert_equal(100, evt.event_type)
     assert_equal(1, evt.id)
+    assert_equal({one: 'first'}, evt.get_client_object)
     assert(evt.should_propagate)
+    GC.start
     evt.skip
     assert(evt.skipped)
     evt.string = 'CommandEvent Test'
     assert_equal('CommandEvent Test', evt.string)
     evt_dup = evt.clone
+    GC.start
     assert_not_equal(evt, evt_dup)
     assert_equal(evt.event_type, evt_dup.event_type)
     assert_equal(evt.id, evt_dup.id)
     assert_equal(evt.string, evt_dup.string)
+    assert_equal({one: 'first'}, evt.get_client_object)
+    assert_equal({one: 'first'}, evt_dup.get_client_object)
   end
 
   def test_event_clone

data/tests/test_item_data.rb

@@ -22,6 +22,9 @@ class TestItemData < Test::Unit::TestCase
   end
 
   def do_control_with_items_assertions(f)
+    f.control.set_client_object([:client, :object])
+    assert_equal([:client, :object], f.control.client_object)
+
     assert_retrievable_data(f.control, 0, { 'b' => 'B' })
     assert_retrievable_data(f.control, 1, 'string item data')
     assert_retrievable_data(f.control, 2, 42.3)
@@ -87,10 +90,31 @@ class TestItemData < Test::Unit::TestCase
 
     GC.start
 
+    klass = Class.new do
+      def initialize(list)
+        @list = list
+        @list << self
+      end
+      def client_data_unlinked
+        @list.delete(self)
+      end
+    end
+    data_list = []
+    10.times { |i| f.control.append("test #{i}", klass.new(data_list)) }
+
+    assert_equal(10, data_list.size)
+    assert_equal(28, f.control.count)
+    assert_kind_of(klass, f.control.get_item_data(27))
+
     # clear all
     f.control.clear
     assert_equal(0, f.control.count)
 
+    assert_equal(0, data_list.size)
+
+    # still there?
+    assert_equal([:client, :object], f.control.client_object)
+
     GC.start
   end
 

data/tests/test_persistence.rb

@@ -0,0 +1,142 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+
+class TopLevelPersistenceTests < WxRuby::Test::GUITests
+
+  PERSIST_ROOT = 'Persistent_Options'
+
+  def run_frame_props_tests
+    Wx.persistent_register_and_restore(frame_win, 'TestFrame')
+
+    frame_win.size = [450, 350]
+    frame_win.position = [100, 150]
+
+    Wx::PersistenceManager.get.save_and_unregister(frame_win)
+
+    cfg = Wx::ConfigBase.get
+    assert_kind_of(Wx::ConfigBase, cfg)
+    grp = cfg.get(PERSIST_ROOT)
+    assert_kind_of(cfg.class::Group, grp)
+    grp = grp.get('Window')
+    assert_kind_of(cfg.class::Group, grp)
+    grp = grp.get('TestFrame')
+    assert_kind_of(cfg.class::Group, grp)
+
+    assert_equal(100, Integer(grp['x']))
+    assert_equal(150, Integer(grp['y']))
+    assert_equal(450, Integer(grp.w))
+    assert_equal(350, Integer(grp.h))
+
+    grp.x = 110
+    grp.y = 140
+
+    assert_equal(110, Integer(grp['x']))
+    assert_equal(140, Integer(grp['y']))
+
+    Wx.persistent_register_and_restore(frame_win, 'TestFrame')
+
+    assert_equal(Wx::Point.new(110, 140), frame_win.position)
+
+    Wx::PersistenceManager.get.unregister(frame_win)
+  end
+
+  def test_frame_props_ruby_config
+    # force creation of hash based Wx::Config instance
+    Wx::ConfigBase.create(true, use_hash_config: true)
+
+    run_frame_props_tests
+
+    Wx::ConfigBase.get.clear
+  end
+
+  # default registry based config does not seem to do well in CI build env
+  unless is_ci_build? && Wx::PLATFORM == 'WXMSW'
+
+  def test_frame_props_default_config
+    # force creation of default C++ config instance
+    Wx::ConfigBase.create(true)
+
+    run_frame_props_tests
+
+    Wx::ConfigBase.get.clear
+  end
+
+  end
+
+  class PersistentButton < Wx::PersistentWindowBase
+
+    def get_kind
+      'Button'
+    end
+
+    def save
+      save_value('w', get.size.width)
+      save_value('h', get.size.height)
+      save_value('label', get.label)
+      save_value('my_custom_value', get.my_custom_value)
+    end
+
+    def restore
+      get.size = [Integer(restore_value('w')), Integer(restore_value('h'))]
+      get.label = restore_value('label')
+      get.my_custom_value = Float(restore_value('my_custom_value'))
+      true
+    end
+
+  end
+
+  class MyButton < Wx::Button
+
+    def initialize(parent=nil, name)
+      super(parent, label: '', name: name)
+      @my_custom_value = ''
+    end
+
+    attr_accessor :my_custom_value
+
+    def create_persistent_object
+      PersistentButton.new(self)
+    end
+
+  end
+
+  def test_custom_persistent_object
+    # force creation of hash based Wx::Config instance
+    Wx::ConfigBase.create(true, use_hash_config: true)
+
+    assert_false(Wx::ConfigBase.get.has_group?(PERSIST_ROOT))
+
+    btn = MyButton.new(frame_win, 'AButton')
+    btn.label = 'Hello world'
+    btn.my_custom_value = 3.14
+
+    Wx::PersistenceManager.get.register(btn)
+
+    assert_false(Wx::ConfigBase.get.has_group?(PERSIST_ROOT))
+
+    # destroying window should save and unregister
+    btn.destroy
+    btn = nil
+
+
+    assert_true(Wx::ConfigBase.get.has_group?(PERSIST_ROOT))
+
+    cfg = Wx::ConfigBase.get[PERSIST_ROOT]['Button']['AButton']
+    assert_true(cfg.has_entry?('w'))
+    assert_true(cfg.has_entry?('h'))
+    assert_true(cfg.has_entry?('label'))
+    assert_true(cfg.has_entry?('my_custom_value'))
+
+
+    btn = MyButton.new(frame_win, 'AButton')
+
+    Wx::PersistenceManager.get.register_and_restore(btn)
+
+    assert_equal('Hello world', btn.label)
+    assert_equal(3.14, btn.my_custom_value)
+  end
+
+end

data/tests/test_sizer.rb

@@ -52,8 +52,51 @@ class SizerTests < WxRuby::Test::GUITests
     assert_true(children[1].spacer?)
     assert_true(children[2].sizer?)
     frame_win.sizer.each_child do |si|
-      assert_equal(children.shift, si)
+      assert_equal(children.shift.ptr_addr, si.ptr_addr)
     end
   end
 
+  def test_user_data
+    frame_win.get_sizer.add(Wx::HBoxSizer.new, 0, 0, 0, 'This is user data')
+    frame_win.get_sizer.add(5,5, 0,0,0, %w[This is user data])
+    frame_win.get_sizer.add(Wx::VBoxSizer.new, 0, 0, 0, {1 => 'This', 2 => 'is', 3 => 'user', 4 => 'data'})
+
+    GC.start
+
+    assert_equal(3, frame_win.sizer.item_count)
+    children = frame_win.sizer.get_children
+    assert_equal(3, children.size)
+    assert_kind_of(::String, children[0].user_data)
+    assert_equal('This is user data', children[0].user_data)
+    assert_kind_of(::Array, children[1].user_data)
+    assert_equal(%w[This is user data], children[1].user_data)
+    assert_kind_of(::Hash, children[2].user_data)
+    assert_equal({1 => 'This', 2 => 'is', 3 => 'user', 4 => 'data'}, children[2].user_data)
+
+    klass = Class.new do
+      def initialize
+        @unlinked = false
+      end
+      def client_data_unlinked
+        @unlinked = true
+      end
+      attr_reader :unlinked
+    end
+
+    frame_win.get_sizer.add(Wx::HBoxSizer.new, 0, 0, 0, klass.new)
+
+    GC.start
+
+    assert_equal(4, frame_win.sizer.item_count)
+    assert_kind_of(klass, frame_win.get_sizer.get_item(3).user_data)
+    user_data = frame_win.get_sizer.get_item(3).user_data
+    assert_false(user_data.unlinked)
+    frame_win.get_sizer.get_item(3).set_user_data(nil)
+
+    GC.start
+
+    assert_true(user_data.unlinked)
+    assert_nil(frame_win.get_sizer.get_item(3).user_data)
+  end
+
 end