wxruby3 0.9.4-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

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

@@ -0,0 +1,122 @@
+# 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#{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")  {|v| Setup.options['wxwin'] = File.expand_path(v)}
+        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)
+      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)
       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/install.rb

@@ -57,6 +57,7 @@ module WXRuby3
 
       def install_wxwin_shlibs
         if WXRuby3.config.get_config('with-wxwin')
+          $stdout.print "Installing wxRuby3 extensions..." if WXRuby3.config.run_silent?
           # prepare required wxWidgets shared libs
           wxwin_inshlibs = []
           WXRuby3::Install.wxwin_shlibs.each do |shlib|
@@ -89,6 +90,7 @@ module WXRuby3
               exit(1)
             end
           end
+          $stdout.puts 'done!' if WXRuby3.config.run_silent?
         end
       end
 

data/rakelib/lib/config/linux.rb

@@ -7,6 +7,7 @@
 ###
 
 require_relative './unixish'
+require_relative 'pkgman/base'
 
 module WXRuby3
 
@@ -17,6 +18,7 @@ module WXRuby3
       def self.included(base)
         base.class_eval do
           include Config::UnixLike
+
           alias :base_ldflags :ldflags
           def ldflags(target)
             "-Wl,-soname,#{File.basename(target)} #{base_ldflags(target)}"
@@ -31,10 +33,10 @@ module WXRuby3
 
           def check_rpath_patch
             unless @rpath_patch
-              if system('which patchelf > /dev/null 2>&1')
+              if system('command -v patchelf > /dev/null')
                 @rpath_patch = 'patchelf --set-rpath'
               else
-                STDERR.puts 'Installation of binary gem with-wxwin requires an installed version of either the patchelf utility.'
+                STDERR.puts 'Installation of binary gem with-wxwin requires an installed version of the patchelf utility.'
                 return false
               end
             end
@@ -48,6 +50,26 @@ module WXRuby3
             end
             false
           end
+
+          def check_tool_pkgs
+            pkg_deps = super
+            # need g++ to build wxRuby3 extensions in any case
+            pkg_deps << 'g++' unless system('command -v g++>/dev/null')
+            # do we need to build wxWidgets?
+            if get_config('with-wxwin') && get_cfg_string('wxwin').empty?
+              pkg_deps << 'patchelf' unless system('command -v patchelf>/dev/null')
+              pkg_deps << 'make' unless system('command -v make>/dev/null')
+              pkg_deps << 'git' unless system('command -v git>/dev/null')
+            end
+            pkg_deps
+          end
+
+          def install_prerequisites
+            pkg_deps = check_tool_pkgs
+            PkgManager.install(pkg_deps)
+            []
+          end
+
         end
       end
 

data/rakelib/lib/config/macosx.rb

@@ -7,6 +7,7 @@
 ###
 
 require_relative './unixish'
+require_relative 'pkgman/macosx'
 
 module WXRuby3
 
@@ -53,6 +54,21 @@ module WXRuby3
             true
           end
 
+          def check_tool_pkgs
+            pkg_deps = super
+            # need g++ to build wxRuby3 extensions in any case
+            pkg_deps << 'gcc' unless system('command -v g++>/dev/null')
+            # need this to build anything (like wxRuby3 extensions itself)
+            pkg_deps << 'xcode' unless system('command -v install_name_tool>/dev/null')
+            pkg_deps
+          end
+
+          def install_prerequisites
+            pkg_deps = check_tool_pkgs
+            PkgManager.install(pkg_deps)
+            []
+          end
+
           def get_wx_libs
             wx_libset = ::Set.new
             lib_list = wx_config("--libs all").split(' ')

data/rakelib/lib/config/mingw.rb

@@ -8,6 +8,9 @@
 
 require_relative './unixish'
 
+require 'uri'
+
+
 if ENV['RI_DEVKIT'].nil?
   begin
     require 'devkit'
@@ -23,6 +26,13 @@ module WXRuby3
 
     module Platform
 
+      SWIG_URL = 'https://sourceforge.net/projects/swig/files/swigwin/swigwin-4.2.0/swigwin-4.2.0.zip/download'
+      SWIG_ZIP = 'swigwin-4.2.0.zip'
+
+      DOXYGEN_URL = 'https://www.doxygen.nl/files/doxygen-1.10.0.windows.x64.bin.zip'
+
+      GIT_URL = 'https://github.com/git-for-windows/git/releases/download/v2.43.0.windows.1/MinGit-2.43.0-64-bit.zip'
+
       def self.included(base)
         base.class_eval do
           include Config::UnixLike
@@ -65,20 +75,79 @@ module WXRuby3
             ftmp.unlink # cleanup
           end
 
-          private
-
-          def wx_make
-            bash('make && make install')
+          def check_tool_pkgs
+            pkg_deps = []
+            pkg_deps << 'doxygen' if expand("which #{get_cfg_string('doxygen')} 2>/dev/null").strip.empty?
+            pkg_deps << 'swig' if expand("which #{get_cfg_string('swig')} 2>/dev/null").strip.empty?
+            pkg_deps << 'git' if expand("which #{get_cfg_string('git')} 2>/dev/null").strip.empty?
+            pkg_deps
           end
 
-          def wx_generate_xml
-            chdir(File.join(ext_path, 'wxWidgets', 'docs', 'doxygen')) do
-              sh({ 'WX_SKIP_DOXYGEN_VERSION_CHECK' => '1' }, 'regen.bat xml')
+          def install_prerequisites
+            pkg_deps = super
+            unless pkg_deps.empty?
+              # autoinstall or not?
+              unless wants_autoinstall?
+                STDERR.puts <<~__ERROR_TXT
+                  ERROR: This system lacks installed versions of the following required software packages:
+                    #{pkg_deps.join(', ')}
+                    
+                    Install these packages and try again.
+                  __ERROR_TXT
+                exit(1)
+              end
+              # if SWIG was not found in the PATH
+              if pkg_deps.include?('swig')
+                $stdout.print 'Installing SWIG...' if run_silent?
+                # download and install SWIG
+                fname = download_and_install(SWIG_URL, SWIG_ZIP, 'swig.exe')
+                $stdout.puts 'done!' if run_silent?
+                Config.instance.log_progress("Installed #{fname}")
+                set_config('swig', fname)
+                Config.save
+              end
+              # if doxygen was not found in the PATH
+              if pkg_deps.include?('doxygen')
+                $stdout.print 'Installing Doxygen...' if run_silent?
+                # download and install doxygen
+                fname = download_and_install(DOXYGEN_URL, File.basename(URI(DOXYGEN_URL).path), 'doxygen.exe', 'doxygen')
+                $stdout.puts 'done!' if run_silent?
+                Config.instance.log_progress("Installed #{fname}")
+                set_config('doxygen', fname)
+                Config.save
+              end
+              # if git was not found in the PATH
+              if pkg_deps.include?('git')
+                $stdout.print 'Installing Git...' if run_silent?
+                # download and install doxygen
+                fname = download_and_install(GIT_URL, File.basename(URI(GIT_URL).path), 'git.exe', 'git')
+                $stdout.puts 'done!' if run_silent?
+                Config.instance.log_progress("Installed #{fname}")
+                set_config('git', fname)
+                Config.save
+              end
             end
+            []
           end
 
-          def respawn_rake(argv = ARGV)
-            Kernel.exec('rake', *argv)
+          # only called after src gem build
+          def cleanup_prerequisites
+            tmp_tool_root = File.join(ENV['HOME'].gsub("\\", '/'), '.wxruby3')
+            path = get_cfg_string('swig')
+            unless path.empty? || !path.start_with?(tmp_tool_root)
+              path = File.dirname(path) while File.dirname(path) != tmp_tool_root
+              rm_rf(path)
+            end
+            path = get_cfg_string('doxygen')
+            unless path.empty? || !path.start_with?(tmp_tool_root)
+              path = File.dirname(path) while File.dirname(path) != tmp_tool_root
+              rm_rf(path)
+            end
+            path = get_cfg_string('git')
+            unless path.empty? || !path.start_with?(tmp_tool_root)
+              path = File.dirname(path) while File.dirname(path) != tmp_tool_root
+              rm_rf(path)
+            end
           end
 
           def expand(cmd)
@@ -93,6 +162,61 @@ module WXRuby3
             super(*cmd, **kwargs)
           end
 
+          private
+
+          def download_and_install(url, zip, exe, unpack_to=nil)
+            # make sure the download destination exists
+            tmp_tool_root = File.join(ENV['HOME'].gsub("\\", '/'), '.wxruby3')
+            dest = unpack_to ? File.join(tmp_tool_root, unpack_to) : File.join(tmp_tool_root, File.basename(zip, '.*'))
+            mkdir(tmp_tool_root) unless File.directory?(tmp_tool_root)
+            # download
+            chdir(tmp_tool_root) do
+              unless sh("curl -L #{url} --output #{zip}")
+                STDERR.puts "ERROR: Failed to download installation package for #{exe}"
+                exit(1)
+              end
+              # unpack
+              unless sh("powershell Expand-Archive -LiteralPath '#{zip}' -DestinationPath #{dest} -Force")
+                STDERR.puts "ERROR: Failed to unpack installation package for #{exe}"
+                exit(1)
+              end
+              # cleanup
+              rm_f(zip)
+            end
+            # find executable
+            find_exe(dest, exe)
+          end
+
+          def find_exe(path, exe)
+            fp = Dir.glob(File.join(path, '*')).find { |p| File.file?(p) && File.basename(p) == exe }
+            unless fp
+              Dir.glob(File.join(path, '*')).each do |p|
+                fp = find_exe(p, exe) if File.directory?(p)
+                return fp if fp
+              end
+            end
+            fp
+          end
+
+          def wx_make
+            bash('make && make install')
+          end
+
+          def wx_generate_xml
+            doxygen = get_cfg_string("doxygen")
+            doxygen = nix_path(doxygen) unless doxygen == 'doxygen'
+            chdir(File.join(ext_path, 'wxWidgets', 'docs', 'doxygen')) do
+              unless bash({ 'DOXYGEN' => doxygen,  'WX_SKIP_DOXYGEN_VERSION_CHECK' => '1' }, './regen.sh', 'xml')
+                $stderr.puts 'ERROR: Failed to generate wxWidgets XML API specifications for parsing by wxRuby3.'
+                exit(1)
+              end
+            end
+          end
+
+          def respawn_rake(argv = ARGV)
+            Kernel.exec('rake', *argv)
+          end
+
           def nix_path(winpath)
             (winpath.nil? || winpath.empty?) ? '' : `cygpath -a -u #{winpath}`.strip
           end

data/rakelib/lib/config/pkgman/arch.rb

@@ -0,0 +1,53 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 buildtools platform pkg manager for Arch Linux type systems
+###
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      module PkgManager
+
+        PLATFORM_DEPS = %w[pkg-config gtk3 webkit2gtk gspell libunwind gstreamer curl libsecret libnotify libpng12]
+
+        class << self
+
+          private
+
+          def do_install(distro, pkgs)
+            run_pacman(make_install_cmd(pkgs))
+          end
+
+          def add_platform_pkgs(pkgs)
+            if pkgs.include?('g++')
+              pkgs.delete('g++')
+              pkgs << 'gcc'
+            end
+            # find pkgs we need
+            PLATFORM_DEPS.inject(pkgs) { |list, pkg| list << pkg unless system("pacman -Qq #{pkg} >/dev/null 2>&1"); list }
+          end
+
+          def run_pacman(cmd)
+            run("pacman -q --noconfirm #{cmd}")
+          end
+
+          def make_install_cmd(pkgs)
+            # create install command
+            "-S --needed #{ pkgs.join(' ') }"
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end