wxruby3 0.9.5 → 0.9.7

data/rakelib/gem.rake

@@ -0,0 +1,169 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 rake file
+###
+
+require_relative './gem'
+
+namespace :wxruby do
+
+  namespace :gem do
+
+    task :srcgem => ['bin:build', WXRuby3::Gem.gem_file('wxruby3', WXRuby3::WXRUBY_VERSION)]
+
+    if WXRuby3.is_bootstrapped?
+      task :bingem => ['bin:build', File.join(WXRuby3.config.rb_docgen_path, 'window.rb'), WXRuby3::Gem.gem_file('wxruby3', WXRuby3::WXRUBY_VERSION, :bin)]
+    end
+
+    # this task only exists for installed source gems (where package tasks have been removed)
+    unless File.file?(File.join(__dir__, 'package.rake'))
+
+      task :setup => 'config:bootstrap' do |_t, args|
+        begin
+          $stdout.print "Building wxRuby3 extensions..." if WXRuby3.config.run_silent?
+          WXRuby3.config.set_silent_run_incremental
+          Rake::Task['wxruby:build'].invoke
+          WXRuby3.config.set_silent_run_batched
+          $stdout.puts 'done!' if WXRuby3.config.run_silent?
+          Rake::Task['wxruby:post:srcgem'].invoke
+          # all is well -> cleanup
+          if args.extras.include?(':keep_log')
+            $stdout.puts "Log: #{WXRuby3.config.silent_log_name}"
+          else
+            rm_f(WXRuby3.config.silent_log_name, verbose: WXRuby3.config.verbose?)
+          end
+        rescue Exception => ex
+          $stderr.puts <<~__ERR_TXT
+            #{ex.message}#{WXRuby3.config.verbose? ? "\n#{ex.backtrace.join("\n")}" : ''}
+
+            For error details check #{WXRuby3.config.silent_log_name}
+            __ERR_TXT
+          exit(1)
+        end
+        $stdout.puts <<~__MSG
+      
+          wxRuby3 has been successfully installed including the 'wxruby' utility.
+      
+          You can run the regression tests to verify the installation by executing:
+      
+          $ ./wxruby test
+      
+          The wxRuby3 sample selector can be run by executing:
+      
+          $ ./wxruby sampler
+      
+          Have fun using wxRuby3.
+          __MSG
+      end
+    end
+
+  end
+
+end
+
+# source gem file
+file WXRuby3::Gem.gem_file('wxruby3', WXRuby3::WXRUBY_VERSION) => WXRuby3::Gem.manifest do
+  gemspec = WXRuby3::Gem.define_spec('wxruby3', WXRuby3::WXRUBY_VERSION) do |gem|
+    gem.summary = %Q{wxWidgets extension for Ruby}
+    gem.description = %Q{wxRuby3 is a Ruby library providing an extension for the wxWidgets C++ UI framework}
+    gem.email = 'mcorino@m2c-software.nl'
+    gem.homepage = "https://github.com/mcorino/wxRuby3"
+    gem.authors = ['Martin Corino']
+    gem.files = WXRuby3::Gem.manifest
+    gem.require_paths = %w{lib}
+    gem.bindir = 'bin'
+    gem.executables = WXRuby3::Bin.binaries
+    gem.required_ruby_version = '>= 2.5'
+    gem.licenses = ['MIT']
+    gem.add_dependency 'nokogiri', '~> 1.12'
+    gem.add_dependency 'rake'
+    gem.add_dependency 'minitest', '~> 5.15'
+    gem.add_dependency 'test-unit', '~> 3.5'
+    gem.rdoc_options <<
+      '--exclude=\\.dll' <<
+      '--exclude=\\.so' <<
+      '--exclude=lib/wx.rb' <<
+      '--exclude=lib/wx/*.rb' <<
+      "'--exclude=lib/wx/(aui|core|grid|html|pg|prt|rbn|rtc|stc|wxruby)/.*'"
+    gem.metadata = {
+      "bug_tracker_uri"   => "https://github.com/mcorino/wxRuby3/issues",
+      "source_code_uri"   => "https://github.com/mcorino/wxRuby3",
+      "documentation_uri" => "https://mcorino.github.io/wxRuby3",
+      "homepage_uri"      => "https://github.com/mcorino/wxRuby3",
+    }
+    gem.post_install_message = <<~__MSG
+
+      The wxRuby3 Gem has been successfully installed.
+      Before being able to use wxRuby3 you need to run the post-install setup process
+      by executing the command 'wxruby setup'.
+
+      Run 'wxruby setup -h' to see information on the available commandline options.
+
+      __MSG
+  end
+  WXRuby3::Gem.build_gem(gemspec)
+end
+
+desc 'Build wxRuby 3 gem'
+task :gem => 'wxruby:gem:srcgem'
+
+if WXRuby3.is_bootstrapped?
+
+  # binary gem file
+  file WXRuby3::Gem.gem_file('wxruby3', WXRuby3::WXRUBY_VERSION, :bin) => WXRuby3::Gem.manifest(:bin) + ['ext/mkrf_conf_bingem.rb'] do
+    WXRuby3::Install.install_wxwin_shlibs
+    begin
+      # create gemspec
+      gemspec = WXRuby3::Gem.define_spec('wxruby3', WXRuby3::WXRUBY_VERSION, :bin) do |gem|
+        gem.summary = %Q{wxWidgets extension for Ruby}
+        gem.description = %Q{wxRuby3 is a Ruby library providing an extension for the wxWidgets C++ UI framework}
+        gem.email = 'mcorino@m2c-software.nl'
+        gem.homepage = "https://github.com/mcorino/wxRuby3"
+        gem.authors = ['Martin Corino']
+        gem.files = WXRuby3::Gem.manifest(:bin)
+        gem.require_paths = %w{lib}
+        gem.require_paths << 'ext' if WXRuby3.config.get_config('with-wxwin')
+        gem.bindir = 'bin'
+        gem.executables = WXRuby3::Bin.binaries
+        gem.extensions = ['ext/mkrf_conf_bingem.rb']
+        gem.required_ruby_version = ">= #{WXRuby3::Config.rb_ver_major}.#{WXRuby3::Config.rb_ver_minor}",
+                                    "< #{WXRuby3::Config.rb_ver_major}.#{WXRuby3::Config.rb_ver_minor+1}"
+        gem.licenses = ['MIT']
+        gem.add_dependency 'rake'
+        gem.add_dependency 'minitest', '~> 5.15'
+        gem.add_dependency 'test-unit', '~> 3.5'
+        gem.rdoc_options << '--exclude=\\.dll' << '--exclude=\\.so'
+        gem.metadata = {
+          "bug_tracker_uri"   => "https://github.com/mcorino/wxRuby3/issues",
+          "source_code_uri"   => "https://github.com/mcorino/wxRuby3",
+          "documentation_uri" => "https://mcorino.github.io/wxRuby3",
+          "homepage_uri"      => "https://github.com/mcorino/wxRuby3",
+        }
+        gem.post_install_message = <<~__MSG
+    
+          wxRuby3 has been successfully installed including the 'wxruby' utility.
+    
+          You can run the regression tests to verify the installation by executing:
+    
+          $ ./wxruby test
+    
+          The wxRuby3 sample selector can be run by executing:
+    
+          $ ./wxruby sampler
+    
+          Have fun using wxRuby3.
+          __MSG
+      end
+      WXRuby3::Gem.build_gem(gemspec)
+    ensure
+      WXRuby3::Install.remove_wxwin_shlibs
+    end
+  end
+
+  desc 'Build wxRuby 3 binary gem'
+  task :bingem => 'wxruby:gem:bingem'
+
+end

data/rakelib/gem.rb

@@ -0,0 +1,82 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 rake gem support
+###
+
+require 'set'
+require 'rubygems'
+require 'rubygems/package'
+begin
+  require 'rubygems/builder'
+rescue LoadError
+end
+
+require_relative './lib/config'
+require_relative './install'
+
+module WXRuby3
+
+  module Gem
+
+    def self.manifest(gemtype = :src)
+      # create MANIFEST list with included files
+      manifest = Rake::FileList.new
+      manifest.include %w[bin/*] # *nix executables in bin/
+      manifest.exclude %w[bin/*.bat] unless WXRuby3.config.windows?
+      manifest.include %w[assets/**/* lib/**/* samples/**/* tests/**/*]
+      if gemtype == :bin
+        if WXRuby3.config.get_config('with-wxwin')
+          manifest.include "ext/*.#{WXRuby3.config.dll_mask}"
+        end
+        manifest.include 'ext/mkrf_conf_bingem.rb'
+        manifest.include %w[rakelib/prepost.* rakelib/install.rb rakelib/lib/config.rb rakelib/lib/config/**/* rakelib/lib/ext/**/* rakelib/yard/**/*]
+        manifest.include WXRuby3::BUILD_CFG
+      else
+        manifest.exclude "lib/*.#{WXRuby3.config.dll_mask}"
+        manifest.include 'ext/wxruby3/wxruby.ico', 'ext/wxruby3/swig/**/*', 'ext/wxruby3/include/**/*'
+        manifest.exclude 'ext/wxruby3/swig/classes/**/*'
+        manifest.include 'rakelib/**/*'
+        manifest.exclude %w[rakelib/run.* rakelib/help.* rakelib/package.* rakelib/memcheck.* rakelib/memcheck/**/*]
+        manifest.include 'rakefile'
+      end
+      manifest.include %w{LICENSE README.md CREDITS.md INSTALL.md .yardopts}
+      manifest
+    end
+
+    def self.define_spec(name, version, gemtype = :src, &block)
+      gemspec = ::Gem::Specification.new(name, version)
+      if gemtype == :bin
+        platform = ::Gem::Platform.local.to_s
+        gemspec.platform = platform
+      end
+      gemspec.required_rubygems_version = ::Gem::Requirement.new(">= 0") if gemspec.respond_to? :required_rubygems_version=
+      block.call(gemspec) if block_given?
+      gemspec
+    end
+
+    def self.gem_name(name, version, gemtype = :src)
+      define_spec(name, version, gemtype).full_name
+    end
+
+    def self.gem_file(name, version, gemtype = :src)
+      File.join('pkg', "#{WXRuby3::Gem.gem_name(name, version, gemtype)}.gem")
+    end
+
+    def self.build_gem(gemspec)
+      if defined?(::Gem::Package) && ::Gem::Package.respond_to?(:build)
+        gem_file_name = ::Gem::Package.build(gemspec)
+      else
+        gem_file_name = ::Gem::Builder.new(gemspec).build
+      end
+
+      FileUtils.mkdir_p('pkg')
+
+      FileUtils.mv(gem_file_name, 'pkg')
+    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