wxruby3 0.9.5 → 0.9.8

data/lib/wx/wxruby/cmd/setup.rb

@@ -0,0 +1,125 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+# wxruby setup command handler
+#--------------------------------------------------------------------
+
+require 'fileutils'
+
+module WxRuby
+  module Commands
+    class Setup
+
+      DESC = 'Run wxRuby3 post-install setup.'
+
+      def self.description
+        "    setup -h|[options]\t\t\t#{DESC}"
+      end
+
+      def self.options
+        Commands.options['setup'] ||= { verbose: Commands.options[:verbose] }
+      end
+
+      def self.parse_args(args)
+        opts = OptionParser.new
+        opts.banner = "#{DESC}\n\nUsage: wxruby setup -h|--help OR wxruby setup [options]\n\n"
+        opts.separator ''
+        opts.on('--wxwin=path',
+                "the installation root for the wxWidgets libraries and headers if not using the system default",
+                "(use '@system' to force using system default only)") do |v|
+          Setup.options['wxwin'] = (v.downcase == '@system') ? v : File.expand_path(v)
+        end
+        opts.on('--wxxml=path',
+                "the path to the doxygen generated wxWidgets XML interface specs if not using bootstrap")  {|v| Setup.options['wxxml'] = File.expand_path(v)}
+        opts.on('--with-wxwin',
+                "build a local copy of wxWidgets for use with wxRuby [false]")  {|v| Setup.options['with-wxwin'] = true}
+        opts.on('--swig=path',
+                "the path to swig executable [swig]")  {|v| Setup.options['swig'] = v}
+        opts.on('--doxygen=path',
+                "the path to doxygen executable [doxygen]")  {|v| Setup.options['doxygen'] = v}
+        opts.on('--git=path',
+                "the path to git executable [git]")  {|v| Setup.options['git'] = v}
+        opts.on('--[no-]autoinstall',
+                "do (not) attempt to automatically install any required packages")  {|v| Setup.options['autoinstall'] = !!v }
+        opts.on('--log=PATH',
+                "write log to PATH/setup.log (PATH must exist) and do not remove when finished")  {|v| Setup.options['log'] = v }
+        opts.on('-h', '--help',
+                'Show this message.') do |v|
+          puts opts
+          puts
+          exit(0)
+        end
+        opts.parse!(args) rescue ($stderr.puts $!.message; exit(127))
+      end
+
+      def self.run(argv)
+        return description if argv == :describe
+
+        parse_args(argv)
+
+        cfg_args = []
+        cfg_args << "--wxwin=#{Setup.options['wxwin']}" if Setup.options['wxwin']
+        cfg_args << "--wxxml=#{Setup.options['wxxml']}" if Setup.options['wxxml']
+        cfg_args << '--with-wxwin' if Setup.options['with-wxwin']
+        cfg_args << "--swig=#{Setup.options['swig']}" if Setup.options['swig']
+        cfg_args << "--doxygen=#{Setup.options['doxygen']}" if Setup.options['doxygen']
+        cfg_args << "--git=#{Setup.options['git']}" if Setup.options['git']
+        unless Setup.options['autoinstall'].nil?
+          cfg_args << (Setup.options['autoinstall'] ? '--autoinstall' : '--no-autoinstall')
+        end
+        cfg_cmd = 'rake configure'
+        cfg_cmd << "[#{cfg_args.join(',')}]" unless cfg_args.empty?
+
+        result = false
+        FileUtils.chdir(WxRuby::ROOT) do
+          steps = 0
+          actions_txt = if Setup.options['autoinstall'] != false
+                          steps = 1
+                          '(possibly) install required software'
+                        else
+                          ''
+                        end
+          if Setup.options['with-wxwin'] || Setup.options['wxwin'].nil?
+            actions_txt << ', ' if steps>0
+            actions_txt << 'build the wxWidgets libraries (if needed), '
+            actions_txt << "\n" if steps>0
+            steps += 1
+          else
+            actions_txt << ',' if steps>0
+          end
+          actions_txt << 'build the native wxRuby3 extensions '
+          actions_txt << "\n" if steps==1
+          actions_txt << 'and generate the wxRuby3 reference documentation.'
+          $stdout.puts <<~__INFO_TXT
+
+            ---            
+            Now running wxRuby3 post-install setup.
+            This will #{actions_txt}
+            Please be patient as this may take quite a while depending on your system.
+            ---
+
+            __INFO_TXT
+          log_file = File.join(WxRuby::ROOT, 'setup.log')
+          if Setup.options['log']
+            if File.directory?(Setup.options['log']) && File.writable?(Setup.options['log'])
+              log_file = File.join(Setup.options['log'], 'setup.log')
+            else
+              $stderr.puts "ERROR: cannot write log to #{Setup.options['log']}. Log path must exist and be writable."
+              exit(1)
+            end
+          end
+          run_env = {'WXRUBY_RUN_SILENT' => "#{log_file}"}
+          run_env['WXRUBY_VERBOSE'] = '1' if Setup.options[:verbose]
+          # can't rely on FileUtils#chdir returning the block result (bug in older Rubies) so assign result here
+          result = system(run_env, "#{cfg_cmd} && rake -m wxruby:gem:setup#{Setup.options['log'] ? '[:keep_log]' : ''} && gem rdoc wxruby3 --overwrite")
+        end
+        exit(result ? 0 : 1)
+      end
+    end
+
+    unless self.setup_done?
+      self.register('setup', Setup)
+    end
+  end
+end

data/lib/wx/wxruby/cmd/test.rb

@@ -10,21 +10,71 @@ require 'fileutils'
 module WxRuby
   module Commands
     class Test
+
+      DESC = 'Run wxRuby3 regression tests.'
+
       def self.description
-        "    test\t\t\tRun wxRuby3 regression tests."
+        "    test -h|[options] [TEST [...]]\t#{DESC}"
+      end
+
+      def self.options
+        Commands.options['test'] ||= { verbose: Commands.options[:verbose], excludes: [] }
+      end
+
+      def self.parse_args(args)
+        opts = OptionParser.new
+        opts.banner = "#{DESC}\n\nUsage: wxruby test -h|--help OR wxruby test [options] [TEST [...]]\n\n" +
+          "TEST == test name\n" +
+          "Runs all tests (except any specified to exclude) if no test specified.\n\n"
+        opts.separator ''
+        opts.on('--list',
+                "display the list of names of the installed tests")  do |v|
+          tests = Dir[File.join(WxRuby::ROOT, 'tests', '*.rb')].collect { |t| File.basename(t, '.*') }
+          $stdout.puts <<~__INFO
+            Installed wxRuby tests:
+              #{tests.join(', ')}
+
+            __INFO
+          exit(0)
+        end
+        opts.on('--exclude=TEST',
+                "exclude the specified test from running")  {|v| Test.options[:excludes] << v }
+        opts.on('-h', '--help',
+                'Show this message.') do |v|
+          puts opts
+          puts
+          exit(0)
+        end
+        opts.parse!(args) rescue ($stderr.puts $!.message; exit(127))
       end
 
       def self.run(argv)
-        if argv == :describe
-          description
-        else
-          Dir[File.join(WxRuby::ROOT, 'tests', '*.rb')].each do |test|
+        return description if argv == :describe
+
+        parse_args(argv)
+
+        tests = if argv.empty?
+                  Dir[File.join(WxRuby::ROOT, 'tests', '*.rb')]
+                else
+                  argv.collect do |a|
+                    fn = File.join(WxRuby::ROOT, 'tests', a+'.rb')
+                    unless File.file?(fn)
+                      $stderr.puts "ERROR: Invalid test [#{a}] specified."
+                      exit(1)
+                    end
+                    fn
+                  end
+                end
+        tests.each do |test|
+          unless Test.options[:excludes].include?(File.basename(test, '.*'))
             exit(1) unless system(RUBY, test)
           end
         end
       end
     end
 
-    self.register('test', Test)
+    if self.setup_done?
+      self.register('test', Test)
+    end
   end
 end

data/rakelib/bin.rake

@@ -0,0 +1,48 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 rake file
+###
+
+require 'rake/clean'
+
+require_relative './bin'
+
+directory 'bin'
+
+file File.join('bin', 'wxruby') => 'bin' do |t|
+  File.open(t.name, 'w') { |f| f.puts WXRuby3::Bin.wxruby }
+  File.chmod(0755, t.name)
+end
+
+namespace :wxruby do
+
+  namespace :bin do
+
+    task :build => ['wxruby:bin:check', File.join('bin', 'wxruby')]
+
+    task :check do
+      WXRuby3::Bin.binaries.each do |bin|
+        if File.exist?(File.join('bin', bin))
+          content = IO.read(File.join('bin', bin))
+          rm_f(File.join('bin', bin)) unless content == WXRuby3::Bin.__send__(bin.gsub('.','_').to_sym)
+        end
+      end
+    end
+  end
+end
+
+CLOBBER.include File.join('bin', 'wxruby')
+
+if WXRuby3.config.windows?
+
+  file File.join('bin', 'wxruby.bat') => ['bin'] do |t|
+    File.open(t.name, 'w') { |f| f.puts WXRuby3::Bin.wxruby_bat }
+  end
+  Rake::Task['wxruby:bin:build'].enhance [File.join('bin', 'wxruby.bat')]
+
+  CLOBBER.include File.join('bin', 'wxruby.bat')
+
+end

data/rakelib/bin.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 rake bin support
+###
+
+require_relative './lib/config'
+
+module WXRuby3
+
+  module Bin
+
+    class << self
+      def wxruby
+        <<~_SH_TXT
+          #!#{WXRuby3.config.windows? ? '/bin/' : (`which env`).strip+' '}#{RB_CONFIG['ruby_install_name']}
+          #---------------------------------
+          # This file is generated
+          #---------------------------------
+          module WxRuby
+            ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+          end
+          require 'wx/wxruby/base'
+          WxRuby.run
+          _SH_TXT
+      end
+
+      def wxruby_bat
+        <<~_BAT_TXT
+          @echo off
+          if not "%~f0" == "~f0" goto WinNT
+          #{RB_CONFIG['ruby_install_name']} -Sx "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
+          goto endofruby
+          :WinNT
+          if not exist "%~d0%~p0#{RB_CONFIG['ruby_install_name']}" goto rubyfrompath
+          if exist "%~d0%~p0#{RB_CONFIG['ruby_install_name']}" "%~d0%~p0#{RB_CONFIG['ruby_install_name']}" -x "%~f0" %*
+          goto endofruby
+          :rubyfrompath
+          #{RB_CONFIG['ruby_install_name']} -x "%~f0" %*
+          goto endofruby
+          #!/bin/#{RB_CONFIG['ruby_install_name']}
+          #
+          module WxRuby
+            ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+          end
+          require 'wx/wxruby/base'
+          WxRuby.run
+          __END__
+          :endofruby
+          _BAT_TXT
+      end
+
+      def binaries
+        %w{wxruby}
+      end
+    end
+
+  end
+
+end

data/rakelib/build.rb

@@ -11,8 +11,11 @@ require_relative './lib/config'
 
 if WXRuby3.is_bootstrapped?
 
-  Rake.application.options.always_multitask =
-    Rake.application.top_level_tasks.size == 1 && Rake.application.top_level_tasks.first == 'build'
+  # only if not part of installed Gem
+  if File.file?(File.join(__dir__, 'package.rake'))
+    Rake.application.options.always_multitask =
+      Rake.application.top_level_tasks.size == 1 && Rake.application.top_level_tasks.first == 'build'
+  end
 
   require_relative './lib/director'
 
@@ -102,22 +105,23 @@ if WXRuby3.is_bootstrapped?
 
   file WXRuby3::Director.enum_cache_control_path do |t_|
     WXRuby3::Director.all_packages.each { |p| p.extract(genint: false) }
-    touch(WXRuby3::Director.enum_cache_control_path)
+    touch(WXRuby3::Director.enum_cache_control_path, verbose: !WXRuby3.config.run_silent?)
   end
 
   # Compile an object file from a generated c++ source
   rule ".#{WXRuby3.config.obj_ext}" => [
     proc { |tn| "#{WXRuby3.config.src_dir}/#{File.basename(tn, ".*")}.cpp" }
   ] do | t |
-    sh "#{WXRuby3.config.cpp} -c #{WXRuby3.config.verbose_flag} " +
-         "#{WXRuby3.config.cxxflags} #{WXRuby3::Director.cpp_flags(t.source)} " +
-         "#{WXRuby3.config.cpp_out_flag}#{t.name} #{t.source}"
+    WXRuby3.config.sh "#{WXRuby3.config.cpp} -c #{WXRuby3.config.verbose_flag} " +
+                        "#{WXRuby3.config.cxxflags} #{WXRuby3::Director.cpp_flags(t.source)} " +
+                        "#{WXRuby3.config.cpp_out_flag}#{t.name} #{t.source}",
+                      fail_on_error: true
   end
 
   if WXRuby3.config.windows?
     # compile an object file from the standard wxRuby resource file
     file File.join(WXRuby3.config.obj_dir, 'wx_rc.o') => File.join(WXRuby3.config.swig_dir, 'wx.rc') do |t|
-      sh "#{WXRuby3.config.rescomp} -i#{t.source} -o#{t.name}"
+      WXRuby3.config.sh "#{WXRuby3.config.rescomp} -i#{t.source} -o#{t.name}", fail_on_error: true
     end
   end
 

data/rakelib/config.rake

@@ -33,7 +33,9 @@ namespace :wxruby do
     end
 
     WXRuby3.config.build_paths.each do |p|
-      directory p
+      directory p do
+        mkdir_p(p, verbose: !WXRuby3.config.run_silent?)
+      end
     end
   end
 

data/rakelib/configure.rb

@@ -57,19 +57,36 @@ module WXRuby3
         opts.on('--sodir=path',
                 "the directory for ruby extensions [#{get_config('sodir')}]")  {|v| CONFIG['sodir'] = v}
         opts.on('--wxwin=path',
-                "the installation root for the wxWidgets libraries and headers if not using the system default")  {|v| CONFIG['wxwin'] = File.expand_path(v)}
+                "the installation root for the wxWidgets libraries and headers if not using the system default",
+                "(use '@system' to force using system default only)")  { |v|
+          if v.downcase == '@system'
+            CONFIG[WXW_SYS_KEY] = true
+            CONFIG['wxwin'] = nil
+            CONFIG['with-wxwin'] = false
+          else
+            CONFIG['wxwin'] = File.expand_path(v)
+            CONFIG[WXW_SYS_KEY] = false
+          end
+        }
         opts.on('--wxxml=path',
                 "the path to the doxygen generated wxWidgets XML interface specs if not using bootstrap")  {|v| CONFIG['wxxml'] = File.expand_path(v)}
         opts.on('--wxwininstdir=path',
-                "the directory where the wxWidgets dlls are to be installed for wxRuby [#{instance.get_config('wxwininstdir')}]") {|v| CONFIG['wxwininstdir'] = v}
+                "the directory where the wxWidgets dlls are installed (do not change if not absolutely needed) [#{instance.get_config('wxwininstdir')}]") {|v| CONFIG['wxwininstdir'] = v}
         opts.on('--with-wxwin',
-                "build a local copy of wxWidgets for use with wxRuby [false]")  {|v| CONFIG['with-wxwin'] = true}
+                "build a local copy of wxWidgets for use with wxRuby [false]")  { |v|
+          CONFIG['with-wxwin'] = true
+          CONFIG[WXW_SYS_KEY] = false
+        }
         opts.on('--with-debug',
                 "build with debugger support [#{instance.get_config('with-debug')}]")  {|v| CONFIG['with-debug'] = true}
         opts.on('--swig=path',
                 "the path to swig executable [#{get_config('swig')}]")  {|v| CONFIG['swig'] = v}
         opts.on('--doxygen=path',
                 "the path to doxygen executable [#{get_config('doxygen')}]")  {|v| CONFIG['doxygen'] = v}
+        opts.on('--git=path',
+                "the path to git executable [#{get_config('git')}]")  {|v| CONFIG['git'] = v}
+        opts.on('--[no-]autoinstall',
+                "do (not) attempt to automatically install any required packages")  {|v| CONFIG['autoinstall'] = !!v }
 
         opts.separator ""
 
@@ -80,53 +97,64 @@ module WXRuby3
     def self.check
       instance.init # re-initialize
 
-      if Dir[File.join('ext', 'wxruby_*.so')].empty? # Don't check for wxWidgets installation when executed for binary gem install
+      # should we try to use a system or user defined wxWidgets installation?
+      if !get_config('with-wxwin')
 
-        if !get_config('with-wxwin')
-          # check if a user defined wxWidgets location is specified or we're using a system standard install
-          if get_cfg_string('wxwin').empty?
-            # assume system standard install; will be checked below
-            set_config('wxwininstdir', get_cfg_string('libdir')) if get_cfg_string('wxwininstdir').empty?
-          elsif get_cfg_string('wxwininstdir').empty?
-            if instance.windows?
-              set_config('wxwininstdir', File.join(get_cfg_string('wxwin'), 'bin'))
-            else
-              set_config('wxwininstdir', File.join(get_cfg_string('wxwin'), 'lib'))
-            end
-          end
-        elsif !get_cfg_string('wxwin').empty?
-          if get_cfg_string('wxwininstdir').empty?
-            if instance.windows?
-              set_config('wxwininstdir', File.join(get_cfg_string('wxwin'), 'bin'))
-            else
-              set_config('wxwininstdir', File.join(get_cfg_string('wxwin'), 'lib'))
-            end
+        # check if a user defined wxWidgets location is specified or should be using a system standard install
+        if get_cfg_string('wxwin').empty?
+          # assume/force system standard install; will be checked below
+          set_config('wxwininstdir', get_cfg_string('libdir')) if get_cfg_string('wxwininstdir').empty?
+        elsif get_cfg_string('wxwininstdir').empty? # if not explicitly specified derive from 'wxwin'
+          if instance.windows?
+            set_config('wxwininstdir', File.join(get_cfg_string('wxwin'), 'bin'))
+          else
+            set_config('wxwininstdir', File.join(get_cfg_string('wxwin'), 'lib'))
           end
-        else
-          set_config('wxwininstdir', get_cfg_string('sodir')) if get_cfg_string('wxwininstdir').empty?
         end
 
-        if !get_cfg_string('wxwin').empty? || !get_config('with-wxwin')
-          # check wxWidgets availability through 'wx-config' command
-          if instance.check_wx_config
-            if instance.wx_config("--version") < '3.2.0'
+      # or should we use an embedded (automatically built) wxWidgets installation
+      else
+
+        set_config('wxwininstdir', instance.ext_dir)
+
+      end
+
+      if !get_cfg_string('wxwin').empty? || !get_config('with-wxwin')
+        # check wxWidgets availability through 'wx-config' command
+        if instance.check_wx_config
+          if instance.wx_config("--version") < '3.2.0'
+            if get_cfg_string('wxwin').empty? && get_cfg_string('wxxml').empty? && !get_config(WXW_SYS_KEY)
+              # no custom (or forced system) wxWidgets build specified so switch to assuming we should include building wxWidgets ourselves
+              set_config('with-wxwin', true)
+            else
+              # if someone wants to customize they HAVE to do it right
               STDERR.puts "ERROR: Incompatible wxWidgets version. wxRuby requires a wxWidgets >= 3.2.0 release."
               exit(1)
             end
+          end
+        else
+          if get_cfg_string('wxwin').empty? && get_cfg_string('wxxml').empty? && !get_config(WXW_SYS_KEY)
+            # no custom (or forced system) wxWidgets build specified so switch to assuming we should include building wxWidgets ourselves
+            set_config('with-wxwin', true)
           else
+            # if someone wants to customize they HAVE to do it right
             STDERR.puts "ERROR: Cannot find wxWidgets. wxRuby requires a wxWidgets >= 3.2.0 release."
             exit(1)
           end
-        # else we're are assumed to build wxWidgets ourselves so cannot test anything yet
         end
+      # else we're assumed to build wxWidgets ourselves so cannot test anything yet
+      end
 
-        if get_cfg_string('wxxml').empty?
-          # no pre-generated XML specified so we are going to need Git and Doxygen
-          instance.check_git
-          instance.check_doxygen
+      if get_cfg_string('wxxml').empty? && !get_cfg_string('wxwin').empty?
+        # in case of a custom wxWidgets build and no explicit xml path check if the custom build holds this
+        xml_path = File.join(get_cfg_string('wxwin'), 'docs', 'doxygen', 'out', 'xml')
+        # if not there see if the standard setup 'wxw_root/<install dir>' was used
+        xml_path = File.join(get_cfg_string('wxwin'), '..', 'docs', 'doxygen', 'out', 'xml') unless File.directory?(xml_path)
+        if File.directory?(xml_path) && !Dir.glob(File.join(xml_path, '*.xml')).empty?
+          set_config('wxxml', xml_path)
         end
-
       end
+
     end
 
   end

data/rakelib/doc.rake

@@ -16,7 +16,9 @@ namespace :wxruby do
 
 end
 
-directory WXRuby3.config.rb_docgen_path
+directory WXRuby3.config.rb_docgen_path do
+  mkdir_p(WXRuby3.config.rb_docgen_path, verbose: !WXRuby3.config.run_silent?)
+end
 
 file File.join(WXRuby3.config.rb_docgen_path, 'window.rb') => [WXRuby3.config.rb_docgen_path, *all_doc_targets]