wxruby3 0.9.2 → 0.9.4

data/samples/xrc/custom_xrc_sample.rb

@@ -11,51 +11,57 @@
 
 require 'wx'
 
-# Basic Frame Class. This creates the dialog window
-class SimpleFrame < Wx::Frame 
-  def initialize
-    super nil, :title => "Custom XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
-
-    txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
-    Wx::StaticText.new self, :label => txt, :pos => [20, 20]
-
-    # Create a new menu
-    self.menu_bar = Wx::MenuBar.new
-    menu = Wx::Menu.new
-    menu.append Wx::ID_OPEN, "Open Dialog"
-    menu.append Wx::ID_EXIT, "Quit"
-    menu_bar.append(menu,"File")
-    
-    # Assign the menu events
-    evt_menu(Wx::ID_OPEN) { (dlg = $xml.load_dialog(self, 'SAMPLE_DIALOG').setup_dialog).show_modal; dlg.destroy }
-    evt_menu(Wx::ID_EXIT) { close }
+module XrcCustom
+
+  # Basic Frame Class. This creates the dialog window
+  class SimpleFrame < Wx::Frame
+    def initialize
+      super nil, :title => "Custom XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
+
+      self.icon = Wx.Icon(:sample, Wx::BITMAP_TYPE_XPM, art_path: File.join(__dir__, '..'))
+
+      txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
+      Wx::StaticText.new self, :label => txt, :pos => [20, 20]
+
+      # Create a new menu
+      self.menu_bar = Wx::MenuBar.new
+      menu = Wx::Menu.new
+      menu.append Wx::ID_OPEN, "Open Dialog"
+      menu.append Wx::ID_EXIT, "Quit"
+      menu_bar.append(menu,"File")
+
+      # Assign the menu events
+      evt_menu(Wx::ID_OPEN) { (dlg = $xml.load_dialog(self, 'SAMPLE_DIALOG').setup_dialog).show_modal; dlg.destroy }
+      evt_menu(Wx::ID_EXIT) { close }
+    end
   end
-end
 
-# Dialog subclass. The components within the dialog are loaded from XRC.
-class CustomDialog < Wx::Dialog
-  def setup_dialog
-    # Get the buttons. The xrcid method turns a string identifier
-    # used in an xml file into a numeric identifier as used in
-    # wxruby. 
-    @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
-    @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
-    @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
-
-    # Bind the buttons to event handlers
-    evt_button(@ok) { end_modal(Wx::ID_OK) }
-    evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
-    evt_button(@message) do
-      Wx::message_box("And now a message from our sponsors.")
+  # Dialog subclass. The components within the dialog are loaded from XRC.
+  class CustomDialog < Wx::Dialog
+    def setup_dialog
+      # Get the buttons. The xrcid method turns a string identifier
+      # used in an xml file into a numeric identifier as used in
+      # wxruby.
+      @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
+      @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
+      @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
+
+      # Bind the buttons to event handlers
+      evt_button(@ok) { end_modal(Wx::ID_OK) }
+      evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
+      evt_button(@message) do
+        Wx::message_box("And now a message from our sponsors.")
+      end
+      self
     end
-    self
   end
-end
 
-class CustomDialogXmlFactory < Wx::XmlSubclassFactory
-  def create(subclass)
-    subclass == 'CustomDialog' ? CustomDialog.new : nil
+  class CustomDialogXmlFactory < Wx::XmlSubclassFactory
+    def create(subclass)
+      subclass == 'CustomDialog' ? CustomDialog.new : nil
+    end
   end
+
 end
 
 module CustomXrcSample
@@ -71,13 +77,13 @@ module CustomXrcSample
 
   def self.activate
     # add the CustomDialog XML factory
-    Wx::XmlResource.add_subclass_factory(CustomDialogXmlFactory.new)
+    Wx::XmlResource.add_subclass_factory(XrcCustom::CustomDialogXmlFactory.new)
     # Get a new resources object
     xrc_file = File.join( File.dirname(__FILE__), 'custom_dialog.xrc' )
     $xml = Wx::XmlResource.new(xrc_file)
 
     # Show the main frame.
-    main = SimpleFrame.new
+    main = XrcCustom::SimpleFrame.new
     main.show(true)
     main
   end

data/samples/xrc/xrc_sample.rb

@@ -11,56 +11,62 @@
 
 require 'wx'
 
-# Basic Frame Class. This creates the dialog window
-class SimpleFrame < Wx::Frame 
-  def initialize()
-    super nil, :title => "XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
-
-    txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
-    Wx::StaticText.new self, :label => txt, :pos => [20, 20]
-
-    # Create a new menu
-    self.menu_bar = Wx::MenuBar.new
-    menu = Wx::Menu.new
-    menu.append Wx::ID_OPEN, "Open Dialog"
-    menu.append Wx::ID_EXIT, "Quit"
-    menu_bar.append(menu,"File")
-    
-    # Assign the menu events
-    evt_menu(Wx::ID_OPEN) { SimpleDialog(self) }
-    evt_menu(Wx::ID_EXIT) { close }
+module Xrc
+
+  # Basic Frame Class. This creates the dialog window
+  class SimpleFrame < Wx::Frame
+    def initialize()
+      super nil, :title => "XRC Dialog Sample", :pos => [50, 50], :size => [300, 300]
+
+      self.icon = Wx.Icon(:sample, Wx::BITMAP_TYPE_XPM, art_path: File.join(__dir__, '..'))
+
+      txt = "Choose 'Open Dialog' from the menu to see a dialog made with XRC"
+      Wx::StaticText.new self, :label => txt, :pos => [20, 20]
+
+      # Create a new menu
+      self.menu_bar = Wx::MenuBar.new
+      menu = Wx::Menu.new
+      menu.append Wx::ID_OPEN, "Open Dialog"
+      menu.append Wx::ID_EXIT, "Quit"
+      menu_bar.append(menu,"File")
+
+      # Assign the menu events
+      evt_menu(Wx::ID_OPEN) { Xrc.SimpleDialog(self) }
+      evt_menu(Wx::ID_EXIT) { close }
+    end
   end
-end
 
-# Dialog subclass. The components within the dialog are loaded from XRC.
-class SimpleDialog < Wx::Dialog
-  def initialize(parent)
-    # To load a layout defined in XRC into a Ruby subclass of Dialog,
-    # first call the empty constructor. All the details of size,
-    # title, position and so on are loaded from the XRC by the call to 
-    # load_frame_subclass. Using a non-empty constructor will cause
-    # errors on GTK.
-    super()
-    
-    # Load the dialog from XRC. We define $xml in on_init.
-    # We could use XmlResource.get() over and over again, but
-    # honestly, thats just too much work.
-    $xml.load_dialog_subclass(self,parent,'SAMPLE_DIALOG')
-
-    # Get the buttons. The xrcid method turns a string identifier
-    # used in an xml file into a numeric identifier as used in
-    # wxruby. 
-    @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
-    @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
-    @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
-
-    # Bind the buttons to event handlers
-    evt_button(@ok) { end_modal(Wx::ID_OK) }
-    evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
-    evt_button(@message) do
-      Wx::message_box("And now a message from our sponsors.")
+  # Dialog subclass. The components within the dialog are loaded from XRC.
+  class SimpleDialog < Wx::Dialog
+    def initialize(parent)
+      # To load a layout defined in XRC into a Ruby subclass of Dialog,
+      # first call the empty constructor. All the details of size,
+      # title, position and so on are loaded from the XRC by the call to
+      # load_frame_subclass. Using a non-empty constructor will cause
+      # errors on GTK.
+      super()
+
+      # Load the dialog from XRC. We define $xml in on_init.
+      # We could use XmlResource.get() over and over again, but
+      # honestly, that's just too much work.
+      $xml.load_dialog_subclass(self,parent,'SAMPLE_DIALOG')
+
+      # Get the buttons. The xrcid method turns a string identifier
+      # used in an xml file into a numeric identifier as used in
+      # wxruby.
+      @ok      = find_window_by_id( Wx::xrcid('wxID_OK') )
+      @cancel  = find_window_by_id( Wx::xrcid('wxID_CANCEL') )
+      @message = find_window_by_id( Wx::xrcid('SAMPLE_MESSAGE') )
+
+      # Bind the buttons to event handlers
+      evt_button(@ok) { end_modal(Wx::ID_OK) }
+      evt_button(@cancel) { end_modal(Wx::ID_CANCEL) }
+      evt_button(@message) do
+        Wx::message_box("And now a message from our sponsors.")
+      end
     end
   end
+
 end
 
 module XrcSample
@@ -79,7 +85,7 @@ module XrcSample
     $xml = Wx::XmlResource.new(xrc_file)
 
     # Show the main frame.
-    main = SimpleFrame.new()
+    main = Xrc::SimpleFrame.new()
     main.show(true)
     main
   end

data/tests/test_config.rb

@@ -13,21 +13,21 @@ class TestConfig < Test::Unit::TestCase
     'RootEntry4' => 3.14,
     'Group1' => {
       'Group1Entry' => 'Group1 string',
-      'Group1.1' => {
-        'Group1.1Integer' => 999,
-        'Group1.1Bignum' => 2**999,
-        'Group1.1Float' => (2**999)-0.1
+      'Group1_1' => {
+        'Group1_1Integer' => 999,
+        'Group1_1Bignum' => 2**999,
+        'Group1_1Float' => (2**999)-0.1
       }
     },
     'Group2' => {
-      'Group2.1' => {
-        'Group2.1.1' => {
+      'Group2_1' => {
+        'Group2_1_1' => {
           'String' => 'hello'
         },
-        'Group2.1.2' => {
+        'Group2_1_2' => {
           'String' => 'world'
         },
-        'Group2.1.3' => {
+        'Group2_1_3' => {
           'True' => true,
           'False' => false
         }
@@ -35,79 +35,222 @@ class TestConfig < Test::Unit::TestCase
     }
   }
 
+  def stringified_entry(val)
+    case val
+    when TrueClass,FalseClass
+      val ? '1' : '0'
+    when Float
+      '%g' % val
+    else
+      val.to_s
+    end
+  end
+
+  def stringified(val)
+    val.is_a?(::Hash) ? val.inject({}) { |hash, pair| hash[pair.first] = stringified(pair.last); hash } : stringified_entry(val)
+  end
+
+  def assert_true_cfg(val)
+    assert_block('expected "1" or true') do
+      val == '1' || val == 1 || val == true
+    end
+  end
+
+  def assert_false_cfg(val)
+    assert_block("expected '0' or false") do
+      val == '0' || val == 0 || val == false
+    end
+  end
+
+  def assert_equal_cfg(expected, val)
+    assert_block("expected #{expected.is_a?(::Hash) ? stringified(expected) : %Q['#{stringified(expected)}']} \nor #{expected}\nbut got #{val}") do
+      expected == val || stringified(expected) == stringified(val)
+    end
+  end
+
   def run_config_tests(cfg)
-    assert_equal(DEMO_CONFIG, cfg.to_h)
+    assert_equal_cfg(DEMO_CONFIG, cfg.to_h)
 
-    assert_equal(4, cfg.number_of_entries)
-    assert_equal(2, cfg.number_of_groups)
-    assert_equal(12, cfg.number_of_entries(recurse: true))
-    assert_equal(7, cfg.number_of_groups(recurse: true))
+    assert_equal_cfg(4, cfg.number_of_entries)
+    assert_equal_cfg(2, cfg.number_of_groups)
+    assert_equal_cfg(12, cfg.number_of_entries(recurse: true))
+    assert_equal_cfg(7, cfg.number_of_groups(recurse: true))
 
     assert_true(cfg.has_entry?('/RootEntry2'))
     assert_true(cfg.has_entry?('/Group1/Group1Entry'))
-    assert_true(cfg.has_entry?('/Group2/Group2.1/Group2.1.2/String'))
+    assert_true(cfg.has_entry?('/Group2/Group2_1/Group2_1_2/String'))
 
-    assert_false(cfg.has_entry?('/Group2/Group2.2/Group2.1.2/String'))
+    assert_false(cfg.has_entry?('/Group2/Group2.2/Group2_1_2/String'))
 
     assert_true(cfg.has_group?('/Group2'))
-    assert_true(cfg.has_group?('/Group1/Group1.1'))
-    assert_true(cfg.has_group?('/Group2/Group2.1/Group2.1.2'))
+    assert_true(cfg.has_group?('/Group1/Group1_1'))
+    assert_true(cfg.has_group?('/Group2/Group2_1/Group2_1_2'))
 
-    assert_false(cfg.has_group?('/Group2/Group2.1/Group2.1.2/String'))
+    assert_false(cfg.has_group?('/Group2/Group2_1/Group2_1_2/String'))
 
-    grp = cfg['/Group1/Group1.1']
+    grp = cfg['/Group1/Group1_1']
 
-    assert_equal(DEMO_CONFIG['Group1']['Group1.1'], grp.to_h)
+    assert_equal_cfg(DEMO_CONFIG['Group1']['Group1_1'], grp.to_h)
 
     assert_equal(3, grp.number_of_entries)
     assert_equal(0, grp.number_of_groups)
 
-    assert_true(grp.has_entry?('Group1.1Integer'))
+    assert_true(grp.has_entry?('Group1_1Integer'))
     assert_false(grp.has_entry?('Group1Entry'))
     assert_true(grp.has_entry?('../Group1Entry'))
 
-    assert_true(grp.has_group?('/Group2/Group2.1/Group2.1.2'))
+    assert_true(grp.has_group?('/Group2/Group2_1/Group2_1_2'))
 
     assert_equal('This is a string value', cfg['/RootEntry1'])
-    assert_equal(true, cfg['/RootEntry2'])
-    assert_equal(101, cfg['/RootEntry3'])
-    assert_equal(3.14, cfg['/RootEntry4'])
+    assert_equal_cfg(true, cfg['/RootEntry2'])
+    assert_equal_cfg(101, cfg['/RootEntry3'])
+    assert_equal_cfg(3.14, cfg['/RootEntry4'])
 
-    grp = cfg['/Group2/Group2.1/Group2.1.3']
-    assert_true(grp.get('True'))
-    assert_false(grp.get('False'))
-    assert_nil(grp.get('../Group2.1.2/String'))
+    grp = cfg['/Group2/Group2_1/Group2_1_3']
+    assert_true_cfg(grp.get('True'))
+    assert_false_cfg(grp.get('False'))
+    assert_raise(ArgumentError) { grp.get('../Group2_1_2/String') }
 
-    assert_true(grp['True'])
-    assert_false(grp['False'])
-    assert_equal('world', grp['../Group2.1.2/String'])
+    assert_true_cfg(grp['True'])
+    assert_false_cfg(grp['False'])
+    assert_equal('world', grp['../Group2_1_2/String'])
 
     cfg.set('RootEntry1', 'Altered string value')
     assert_equal('Altered string value', cfg['RootEntry1'])
     assert_equal('Altered string value', cfg['/RootEntry1'])
     assert_equal('Altered string value', cfg.get('RootEntry1'))
 
-    cfg.set('RootEntry3', cfg.get('RootEntry3')+99)
-    assert_equal(200, cfg['/RootEntry3'])
+    cfg.set('RootEntry3', cfg.read('RootEntry3', ::Integer)+99)
+    assert_equal_cfg(200, cfg['/RootEntry3'])
+
+    cfg.set('Group1', { 'Group1_2' => { 'Integer' => 777 }})
+    assert_equal_cfg(777, cfg['/Group1/Group1_2/Integer'])
+
+    cfg['/Group1/Group1_2/Integer'] = 666
+    assert_equal_cfg(666, cfg['/Group1/Group1_2'].get('Integer'))
+
+    cfg['/Group1/Group1_2'] = { 'Float' => 0.3330 }
+    assert_equal_cfg(0.3330, cfg['/Group1/Group1_2'].get('Float'))
+
+    assert_equal(0.3330, cfg.read('/Group1/Group1_2/Float').to_f)
+    assert_equal(0.3330, cfg.read('/Group1/Group1_2/Float', Float))
+    assert_equal(0.3330, cfg.read('/Group1/Group1_2/Float', ->(v) { v.to_f }))
+
+    cfg.replace(DEMO_CONFIG) # reset
+  end
+
+  def run_auto_accessor_tests(cfg)
+    assert_not_nil(cfg.RootEntry2)
+    assert_not_nil(cfg.Group1.Group1Entry)
+    assert_not_nil(cfg.Group2.Group2_1.Group2_1_2.String)
+
+    assert_nil(cfg.Group2.Group2_1.Group2_1_2.AString)
+
+    assert_kind_of(cfg.class::Group, cfg.Group2)
+    assert_kind_of(cfg.class::Group, cfg.Group1.Group1_1)
+    assert_kind_of(cfg.class::Group, cfg.Group2.Group2_1.Group2_1_2)
+
+    assert_not_kind_of(cfg.class::Group, cfg.Group2.Group2_1.Group2_1_2.String)
+
+    grp = cfg.Group1
+
+    assert_equal_cfg(DEMO_CONFIG['Group1'], grp.to_h)
+
+    assert_not_nil(grp.Group1Entry)
+    assert_nil(grp.Group1_1Integer)
+
+    assert_kind_of(grp.class, grp.Group1_1)
+    assert_not_nil(grp.Group1_1.Group1_1Integer)
+
+    assert_true(grp.has_entry?('../RootEntry1'))
+
+    assert_true(grp.has_group?('/Group2/Group2_1/Group2_1_2'))
+
+    assert_equal_cfg('This is a string value', cfg.RootEntry1)
+    assert_equal_cfg(true, cfg.RootEntry2)
+    assert_equal_cfg(101, cfg.RootEntry3)
+    assert_equal_cfg(3.14, cfg.RootEntry4)
 
-    cfg.set('Group1', { 'Group1.2' => { 'Integer' => 777 }})
-    assert_equal(777, cfg['/Group1/Group1.2/Integer'])
+    grp = cfg.Group2.Group2_1.Group2_1_3
+    assert_true_cfg(grp.True)
+    assert_false_cfg(grp.False)
 
-    cfg['/Group1/Group1.2/Integer'] = 666
-    assert_equal(666, cfg['/Group1/Group1.2'].get('Integer'))
+    assert_true_cfg(grp['True'])
+    assert_false_cfg(grp['False'])
+    assert_equal_cfg('world', grp['../Group2_1_2/String'])
 
-    cfg['/Group1/Group1.2'] = { 'Float' => 0.3330 }
-    assert_equal(0.3330, cfg['/Group1/Group1.2'].get('Float'))
+    cfg.RootEntry1 = 'Altered string value'
+    assert_equal_cfg('Altered string value', cfg['RootEntry1'])
+    assert_equal_cfg('Altered string value', cfg['/RootEntry1'])
+    assert_equal_cfg('Altered string value', cfg.get('RootEntry1'))
+    assert_equal_cfg('Altered string value', cfg.RootEntry1)
+
+    cfg.RootEntry3 = (Kernel.Integer(cfg.RootEntry3) rescue 0)+99
+    assert_equal_cfg(200, cfg.RootEntry3)
+
+    cfg.Group1 = { 'Group1_2' => { 'Integer' => 777 }}
+    assert_equal_cfg(777, cfg.Group1.Group1_2.Integer)
+
+    cfg.Group1.Group1_2.Integer = 666
+    assert_equal_cfg(666, cfg.Group1.Group1_2.get('Integer'))
+
+    cfg.Group1.Group1_2 = { 'Float' => 0.3330 }
+    assert_equal_cfg(0.3330, cfg.Group1.Group1_2.get('Float'))
+
+    cfg.replace(DEMO_CONFIG) # reset
+  end
+
+  def run_env_var_tests(cfg)
+    # by default expansion is on
+
+    # add a number of entries for env var in new group 'Environment'
+    cfg['/Environment/HOME'] = '$HOME'
+    cfg['Environment'].USER = Wx::PLATFORM == 'WXMSW' ? '%USERNAME%' : '${USER}'
+    cfg['/Environment/PATH'] = '$(PATH)'
+
+    assert_equal(ENV['HOME'], cfg.Environment['HOME'])
+    assert_equal(ENV[Wx::PLATFORM == 'WXMSW' ?  'USERNAME' : 'USER'], cfg['/Environment/USER'])
+    assert_equal(ENV['PATH'], cfg.Environment.PATH)
+
+    # test escaping
+    cfg['/Environment/Escaped_HOME'] = '\$HOME'
+    cfg['/Environment/Escaped_HOME2'] = '\\$HOME'
+    cfg['/Environment/Escaped_HOME3'] = '\\\$HOME'
+
+    assert_equal('$HOME', cfg.Environment['Escaped_HOME'])
+    assert_equal('$HOME', cfg.Environment['Escaped_HOME2'])
+    assert_equal('\$HOME', cfg.Environment['Escaped_HOME3'])
+
+    cfg['/Environment/NONSENSE'] = '${NonExistingLongNonsenseVariable}'
+
+    assert_equal('${NonExistingLongNonsenseVariable}', cfg.Environment['NONSENSE'])
+
+    cfg['/Environment/MULTIPLE'] = "$HOME / #{Wx::PLATFORM == 'WXMSW' ? '%USERNAME%' : '${USER}'}"
+
+    assert_equal("#{ENV['HOME']} / #{Wx::PLATFORM == 'WXMSW' ? ENV['USERNAME'] : ENV['USER']}", cfg.Environment['MULTIPLE'])
+
+    # disable env var expansion
+    cfg.expand_env_vars = false
+    begin
+      assert_equal('$HOME', cfg.Environment['HOME'])
+    ensure
+      # re-enable
+      cfg.set_expand_env_vars(true)
+    end
   end
 
   def test_basic
     cfg = Wx::Config.new(DEMO_CONFIG)
 
     run_config_tests(cfg)
+    run_auto_accessor_tests(cfg)
+    run_env_var_tests(cfg)
   end
 
   def test_global
-    cfg = Wx::ConfigBase.create
+    cfg = Wx::ConfigBase.create(true, use_hash_config: true)
+
+    assert_kind_of(Wx::Config, cfg)
 
     cfg.replace(DEMO_CONFIG)
 
@@ -116,6 +259,8 @@ class TestConfig < Test::Unit::TestCase
     assert_equal(cfg, Wx::ConfigBase.get(false))
 
     run_config_tests(cfg)
+    run_auto_accessor_tests(cfg)
+    run_env_var_tests(cfg)
 
     cfg_old = Wx::ConfigBase.set(nil)
 
@@ -123,8 +268,28 @@ class TestConfig < Test::Unit::TestCase
     assert_nil(Wx::ConfigBase.get(false))
   end
 
+  # default registry based config does not seem to do well in CI build env
+  unless is_ci_build? && Wx::PLATFORM == 'WXMSW'
+
+  def test_default_wx
+    Wx::ConfigBase.set(nil) # reset global instance
+    cfg = Wx::ConfigBase.get # forced auto creation of default config
+
+    assert_kind_of(Wx::ConfigWx, cfg)
+
+    cfg.replace(DEMO_CONFIG)
+
+    run_config_tests(cfg)
+    run_auto_accessor_tests(cfg)
+    run_env_var_tests(cfg)
+
+    assert_true(cfg.clear) # cleanup
+  end
+
+  end
+
   def test_html_help
-    cfg = Wx::ConfigBase.create
+    cfg = Wx::ConfigBase.create(true, use_hash_config: true)
 
     assert_true(cfg.to_h.empty?)