wxruby3 0.9.1 → 0.9.2

data/rakelib/yard/templates/default/fulldoc/html/setup.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+def init
+  # It seems YARD messes things up so that a number of classes are not properly
+  # registered in their enclosing namespaces.
+  # This hack makes sure that if that is the case we fix that here.
+  all_classes = Registry.all(:class)
+  all_classes.each do |c|
+    if (ns = c.namespace)
+      unless ns.children.any? { |nsc| nsc.path == c.path }
+        ns.children << c # class missing from child list of enclosing namespace -> add here
+      end
+    end
+    if (ns = Registry[c.namespace.path])
+      unless ns.children.any? { |nsc| nsc.path == c.path }
+        ns.children << c # class missing from child list of enclosing namespace -> add here
+      end
+    end
+  end
+  super
+end
+
+def stylesheets_full_list
+  super + %w(css/wxruby3.css)
+end
+
+def logo_and_version
+  wxver = Registry['Wx::WXRUBY_VERSION']
+  wxwver = Registry['Wx::WXWIDGETS_VERSION']
+  <<~__HTML
+  <div class='wxrb-logo'>
+    <img src='assets/logo.png' height='38'/>
+    <table><tbody>
+      <tr><td><span class='wxrb-name'><a href="https://github.com/mcorino/wxRuby3">wxRuby3</a></span></td><td><span class='wxrb-version'>Version: #{::Kernel.eval(wxver.value)}</span></td></tr>
+      <tr><td></td><td><span class="wxrb-wxver">(wxWidgets: #{::Kernel.eval(wxwver.value)})</span></td></tr>
+    </tbody></table>
+  </div>
+  __HTML
+end

data/rakelib/yard/templates/default/tags/html/wxrb_require.erb

@@ -0,0 +1,10 @@
+<% if object.has_tag?(:wxrb_require) %>
+  <p class="tag_title">Requires:</p>
+  <ul class="wxrb-require">
+    <% wxruby_requires.each do |req| %>
+      <li><div class='inline'>
+        <%= req.join(' or ') %>
+      </div></li>
+    <% end %>
+  </ul>
+<% end %>

data/rakelib/yard/templates/default/tags/setup.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+def wxrb_require
+  erb('wxrb_require')
+end
+
+def wxruby_requires
+  object.tags(:wxrb_require).inject([]) do |list, tag|
+    tag.text.split(',').each do |feature|
+      list << feature.split('|').collect do |s|
+        s.split('&').collect { |ss| %Q[<span class="wxrb-require">#{ss.strip}</span>] }.join('&amp;')
+      end
+    end
+    list
+  end
+end

data/rakelib/yard/yard-custom-templates.rb

@@ -1,2 +1,5 @@
 
+YARD::Tags::Library.define_tag("Requirements", :wxrb_require)
+YARD::Tags::Library.visible_tags.place(:wxrb_require).before(:author)
+
 YARD::Templates::Engine.register_template_path File.join(__dir__, 'templates')

data/samples/treectrl/treectrl.rb

@@ -369,7 +369,7 @@ class MyTreeCtrl < Wx::TreeCtrl
       set_item_font(root_id, Wx::ITALIC_FONT)
     end
 
-    ids = get_children(root_id)
+    ids = get_item_children(root_id)
 
     # make the first item blue
     set_item_text_colour(ids[0], Wx::BLUE)

data/tests/test_list_ctrl.rb

@@ -4,7 +4,7 @@
 
 require_relative './lib/wxframe_runner'
 
-class ButtonTests < WxRuby::Test::GUITests
+class ListCtrlTests < WxRuby::Test::GUITests
 
   def setup
     super

data/tests/test_media_ctrl.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+
+# test seems to deadlock for WXGTK
+if Wx.has_feature?(:USE_MEDIACTRL)
+
+require 'uri'
+
+class MediaCtrlTests < WxRuby::Test::GUITests
+
+  def setup
+    super
+    @media = Wx::MediaCtrl.new(frame_win)
+  end
+
+  def cleanup
+    @media.destroy
+    super
+  end
+
+  attr_reader :media
+
+  def test_uri
+    # just checking if Ruby URI is properly mapped
+    # it doesn't seem the mediactrl returns a very consistent result whether the resource is not a media file
+    # or if it is a non-existing file so only check whether it is a boolean return.
+    uri = URI("file://#{File.join(__dir__, 'media/beep_lo.wav')}")
+    assert_boolean(media.load(uri))
+    uri = URI("file://#{File.join(__dir__, 'art/test_art/image/wxruby.png')}")
+    assert_boolean(media.load(uri))
+  end
+
+end
+
+end

data/tests/test_menu.rb

@@ -0,0 +1,69 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+
+class MenuTests < WxRuby::Test::GUITests
+
+  def setup
+    super
+    @menu = Wx::Menu.new
+    @menu.append(Wx::ID_HIGHEST+1, 'Item 1', 'Test menuitem 1')
+    @menu.append(Wx::ID_HIGHEST+2, 'Item 2', 'Test menuitem 2')
+    @menu.append_separator
+    @menu.append_check_item(Wx::ID_HIGHEST+3, 'Check 3', 'Test menuitem 3')
+    @menu.append_separator
+    @menu.append_radio_item(Wx::ID_HIGHEST+4, 'Radio 4', 'Test menuitem 4')
+    @menu.append_radio_item(Wx::ID_HIGHEST+5, 'Radio 5', 'Test menuitem 5')
+    @menu.append_radio_item(Wx::ID_HIGHEST+6, 'Radio 6', 'Test menuitem 6')
+    frame_win.menu_bar = Wx::MenuBar.new
+    frame_win.menu_bar.append(@menu, "&Test")
+  end
+
+  def cleanup
+    frame_win.menu_bar = nil
+    super
+  end
+
+  attr_reader :menu
+
+  def test_basic
+    assert_equal(8, menu.get_menu_item_count)
+    check, pos = menu.find_child_item(Wx::ID_HIGHEST+3)
+    assert_not_nil(check)
+    assert_equal(3, pos)
+    assert_equal('Check 3', check.item_label)
+    assert_false(check.checked?)
+    check.check
+    assert_true(check.checked?)
+    radio, pos = menu.find_child_item(Wx::ID_HIGHEST+5)
+    assert_not_nil(radio)
+    assert_equal(6, pos)
+    assert_equal('Radio 5', radio.item_label)
+    assert_false(radio.checked?)
+    radio.check
+    assert_true(radio.checked?)
+    radio, pos = menu.find_child_item(Wx::ID_HIGHEST+4)
+    assert_false(radio.checked?)
+    radio, pos = menu.find_child_item(Wx::ID_HIGHEST+6)
+    assert_false(radio.checked?)
+    radio.check
+    assert_true(radio.checked?)
+    radio, pos = menu.find_child_item(Wx::ID_HIGHEST+5)
+    assert_false(radio.checked?)
+  end
+
+  def test_enumerate
+    radio, pos = menu.find_child_item(Wx::ID_HIGHEST+4)
+    assert_true(radio.checked?) # first by default checked
+    menu.each_item do |mi|
+      mi.check if mi.id == (Wx::ID_HIGHEST+5)
+    end
+    radio, pos = menu.find_child_item(Wx::ID_HIGHEST+4)
+    assert_false(radio.checked?)
+    radio = menu.each_item.detect { |mi| mi.id == (Wx::ID_HIGHEST+5) }
+    assert_true(radio.checked?)
+  end
+
+end

data/tests/test_pg.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+
+class PGChoicesTests < WxRuby::Test::GUITests
+
+  def test_enum_labels
+    texts = %w[Red Blue Green Yellow Black White]
+    choices = Wx::PG::PGChoices.new(texts)
+    choices.each_label { |lbl| assert_equal(texts.shift, lbl) }
+  end
+
+  def test_enum_entries
+    texts = %w[Flag1 Flag2 Flag3 Flag4]
+    choices = Wx::PG::PGChoices.new
+    texts.each_with_index do |s, i|
+      choices.add(s, 1 << i)
+    end
+    choices.each_entry.each_with_index do |entry, ix|
+      assert_equal(1 << ix, entry.value)
+      assert_equal(texts[ix], entry.get_text)
+    end
+  end
+
+end

data/tests/test_richtext.rb

@@ -67,6 +67,51 @@ class RichTextCtrlWriteTests < WxRuby::Test::GUITests
     assert_equal('Second Line', richtext.get_line_text(1))
   end
 
+  def test_enumerate_lines
+    richtext.write_text <<~__HEREDOC
+      This is line 1.
+      This is line 2.
+      This is line 3.
+      __HEREDOC
+    assert_equal(4, richtext.get_number_of_lines)
+    richtext.each_line.each_with_index do |txt, lnr|
+      if lnr < 3
+        assert("This is line #{lnr+1}.", txt)
+      else
+        assert('', txt)
+      end
+    end
+    line_enum = richtext.each_line
+    txt = line_enum.detect { |l| l.index('2') }
+    assert_equal('This is line 2.', txt)
+    para = richtext.buffer.get_child_at_position(0)
+    assert_kind_of(Wx::RTC::RichTextParagraph, para)
+    assert_equal(1, para.get_lines.size)
+    para.each_line do |rtl|
+      txt = para.get_text_for_range(rtl.get_range)
+      assert("This is line 1.", txt)
+    end
+  end
+
+  def test_enumerate_children
+    richtext.write_text <<~__HEREDOC
+      This is line 1.
+      This is line 2.
+      This is line 3.
+      __HEREDOC
+    richtext.write_image(Wx.Bitmap(:wxruby, Wx::BitmapType::BITMAP_TYPE_PNG, art_section: 'test_art'))
+    assert_equal(4, richtext.buffer.get_child_count)
+    richtext.buffer.each_child.each_with_index do |c, i|
+      if i<3
+        assert_kind_of(Wx::RTC::RichTextParagraph, c)
+        assert_equal(1, c.get_lines.size)
+      else
+        assert_equal(1, c.get_child_count)
+        c.each_child { |cc| assert_kind_of(Wx::RTC::RichTextImage, cc) }
+      end
+    end
+  end
+
   def test_write_image
     assert_nothing_raised { richtext.write_image(Wx.Bitmap(:wxruby, Wx::BitmapType::BITMAP_TYPE_PNG, art_section: 'test_art')) }
     img_obj = richtext.buffer.get_leaf_object_at_position(0)

data/tests/test_sizer.rb

@@ -40,4 +40,20 @@ class SizerTests < WxRuby::Test::GUITests
     assert_not_nil(frame_win.get_sizer.prepend(szr))
   end
 
+  def test_children
+    frame_win.get_sizer.add(Wx::HBoxSizer.new)
+    frame_win.get_sizer.add_spacer(5)
+    frame_win.get_sizer.add(Wx::VBoxSizer.new)
+
+    assert_equal(3, frame_win.sizer.item_count)
+    children = frame_win.sizer.get_children
+    assert_equal(3, children.size)
+    assert_true(children[0].sizer?)
+    assert_true(children[1].spacer?)
+    assert_true(children[2].sizer?)
+    frame_win.sizer.each_child do |si|
+      assert_equal(children.shift, si)
+    end
+  end
+
 end

data/tests/test_std_controls.rb

@@ -111,6 +111,34 @@ class TextCtrlTests < WxRuby::Test::GUITests
     assert_equal('', text.get_value)
   end
 
+  def test_stream_append
+    text << 'This is the number ' << 101 << '.'
+    assert_equal('This is the number 101.', text.get_value)
+  end
+
+  def test_enumerate_lines
+    text.destroy
+    @text = Wx::TextCtrl.new(frame_win, style: Wx::TE_MULTILINE, name: 'Text')
+    text << <<~__HEREDOC
+      This is line 1.
+      This is line 2.
+      This is line 3.
+      __HEREDOC
+    assert_equal(4, text.get_number_of_lines)
+    text.each_line.each_with_index do |txt, lnr|
+      if lnr < 3
+        assert("This is line #{lnr+1}.", txt)
+      else
+        assert('', txt)
+      end
+    end
+    txt = text.each_line { |l| break l if l.index('2')}
+    assert_equal('This is line 2.', txt)
+    line_enum = text.each_line
+    txt = line_enum.detect { |l| l.index('3') }
+    assert_equal('This is line 3.', txt)
+  end
+
   if has_ui_simulator?
   def test_max_length
     sim = get_ui_simulator
@@ -165,7 +193,7 @@ class ComboBoxTests < WxRuby::Test::GUITests
   def setup
     super
     @combo = Wx::ComboBox.new(frame_win, name: 'ComboBox', choices: %w[One Two Three])
-    @combo.clear
+    @combo.value = '' # don't use #clear as that also clears the choices
   end
 
   def cleanup
@@ -180,6 +208,19 @@ class ComboBoxTests < WxRuby::Test::GUITests
     assert_equal('', combo.get_value)
   end
 
+  def test_enumerate
+    strings = combo.get_strings
+    combo.each_string.each_with_index do |str, ix|
+      assert_equal(strings[ix], str)
+    end
+    combo.each_string { |s| assert_equal(strings.shift, s)}
+    str_enum = combo.each_string
+    assert_kind_of(::Enumerator, str_enum)
+    assert_true(str_enum.any? { |s| s == 'Three'})
+    assert_true(combo.each_string.none? { |s| s == 'Four'})
+    assert_equal('BREAK', combo.each_string { |_| break 'BREAK' })
+  end
+
 end
 
 class CheckBoxTests < WxRuby::Test::GUITests

data/tests/test_styled_text_ctrl.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+
+class StyledTextCtrlTests < WxRuby::Test::GUITests
+
+  def setup
+    super
+    @text = Wx::STC::StyledTextCtrl.new(frame_win, name: 'StyledText')
+  end
+
+  def cleanup
+    @text.destroy
+    super
+  end
+
+  attr_reader :text
+
+  def test_text
+    assert_equal('', text.get_value)
+  end
+
+  def test_enumerate_lines
+    text.write_text <<~__HEREDOC
+      This is line 1.
+      This is line 2.
+      This is line 3.
+      __HEREDOC
+    assert_equal(4, text.get_number_of_lines)
+    text.each_line.each_with_index do |txt, lnr|
+      if lnr < 3
+        assert("This is line #{lnr+1}.", txt)
+      else
+        assert('', txt)
+      end
+    end
+    txt = text.each_line { |l| break l if l.index('2')}
+    assert_equal('This is line 2.', txt)
+    line_enum = text.each_line
+    txt = line_enum.detect { |l| l.index('3') }
+    assert_equal('This is line 3.', txt)
+  end
+
+end

data/tests/test_tree_ctrl.rb

@@ -0,0 +1,138 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+
+class TreeCtrlTests < WxRuby::Test::GUITests
+
+  def setup
+    super
+    @tree = Wx::TreeCtrl.new(frame_win, name: 'TreeCtrl')
+  end
+
+  def cleanup
+    @tree.destroy
+    super
+  end
+
+  attr_reader :tree
+
+  def tog_style(flag)
+    style = tree.get_window_style ^ flag
+
+    if Wx.has_feature?(:WXMSW)
+      # treectrl styles can't be changed on the fly using the native
+      # control and the tree must be recreated
+      tree.destroy
+      @tree = Wx::TreeCtrl.new(frame_win, style: style, name: 'TreeCtrl')
+    else
+      tree.set_window_style(style)
+    end
+  end
+  private :tog_style
+
+  ITEMS = [
+     ['Cat1', [
+      'Item1.1',
+      'Item1.2',
+      'Item1.3'
+      ]
+     ],
+     ['Cat2', [
+       ['Cat2.1', %w[Item2.1.1 Item2.1.2] ],
+      'Item2.2',
+      'Item2.3'
+      ]
+     ],
+    'Item3',
+    'Item4'
+  ]
+
+  def add_tree_items(parent, items)
+    items.each do |itm|
+      if ::Array === itm
+        cat = tree.append_item(parent, itm.first.to_s)
+        add_tree_items(cat, itm.last)
+      else
+        tree.append_item(parent, itm.to_s)
+      end
+    end
+  end
+  private :add_tree_items
+
+  def build_tree
+    root = tree.add_root('root')
+    add_tree_items(root, ITEMS)
+  end
+  private :build_tree
+
+  def test_tree
+    build_tree
+
+    assert_equal(4, tree.get_item_children(tree.get_root_item).size)
+    cat1 = tree.get_item_children(tree.get_root_item)[0]
+    assert_equal(3, tree.get_item_children(cat1).size)
+    cat2 = tree.get_item_children(tree.get_root_item)[1]
+    assert_equal(3, tree.get_item_children(cat2).size)
+    cat21 = tree.get_item_children(cat2)[0]
+    assert_equal(2, tree.get_item_children(cat21).size)
+  end
+
+  def test_hidden_root
+    tog_style(Wx::TR_HIDE_ROOT)
+    build_tree
+
+    assert_equal(4, tree.get_root_items.size)
+    cat1 = tree.get_root_items[0]
+    assert_equal(3, tree.get_item_children(cat1).size)
+    cat2 = tree.get_root_items[1]
+    assert_equal(3, tree.get_item_children(cat2).size)
+    cat21 = tree.get_item_children(cat2)[0]
+    assert_equal(2, tree.get_item_children(cat21).size)
+  end
+
+  def test_enumerable
+    build_tree
+
+    item211 = tree.detect { |itmid| tree.item_text(itmid) == 'Item2.1.1'}
+    assert_not_nil(item211)
+    assert_true(item211.ok?)
+  end
+
+  def test_enumerate
+    build_tree
+
+    tree.each_item_child(tree.get_root_item) do |itmid|
+      if tree.item_text(itmid) == 'Cat2'
+        tree.each_item_child(itmid) do |sub_itmid|
+          if tree.item_text(sub_itmid) == 'Cat2.1'
+            new_itm = tree.append_item(sub_itmid, 'Another Item')
+            assert_not_nil(new_itm)
+            assert_true(new_itm.ok?)
+          end
+        end
+      end
+    end
+    assert_equal(4, tree.get_item_children(tree.get_root_item).size)
+    cat1 = tree.get_item_children(tree.get_root_item)[0]
+    assert_equal(3, tree.get_item_children(cat1).size)
+    cat2 = tree.get_item_children(tree.get_root_item)[1]
+    assert_equal(3, tree.get_item_children(cat2).size)
+    cat21 = tree.get_item_children(cat2)[0]
+    assert_equal(3, tree.get_item_children(cat21).size)
+  end
+
+  def test_enumerator
+    build_tree
+
+    root_enum = tree.each_item_child(tree.get_root_item)
+    assert_kind_of(::Enumerator, root_enum)
+    cat2 = root_enum.detect { |itmid| tree.item_text(itmid) == 'Cat2' }
+    assert_not_nil(cat2)
+    assert_true(cat2.ok?)
+    cat2_enum = tree.each_item_child(cat2)
+    assert_equal(3, cat2_enum.to_a.size)
+  end
+
+end

data/tests/test_window.rb

@@ -229,6 +229,18 @@ class WindowTests < WxRuby::Test::GUITests
     assert_equal(child1, window.find_window_by_id(Wx::ID_HIGHEST + 1))
     assert_equal(child1, window.find_window_by_name("child1"))
 
+    child1 = Wx::Window.new(window, Wx::ID_HIGHEST + 2)
+
+    children = window.get_children
+    window.each_child do |child|
+      assert_equal(child, children.shift)
+    end
+
+    children = window.get_children
+    enum = window.each_child
+    assert_equal(children.first, enum.find { |c| c.get_id == Wx::ID_HIGHEST + 1})
+    assert_equal(children.last, enum.find { |c| c.get_id == Wx::ID_HIGHEST + 2})
+
     window.destroy_children
 
     assert_equal(0, window.get_children.count)

data/tests/testapp_noframe.rb

@@ -21,7 +21,7 @@ class TestApp < Test::Unit::TestCase
     o = AppReturnsFalseFromInit.new
     o.run
     assert(o.did_call_on_init, "didn't call on_init?")
-    assert_equal("wxruby", o.the_app_name)
+    assert_equal("testapp_noframe", o.the_app_name)
   end
   
 end