wxruby3 0.9.5 → 0.9.8

data/rakelib/gem.rake

@@ -0,0 +1,199 @@
+# 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]
+
+    # this task only exists for installed (source) gems (where run tasks have been removed)
+    unless File.file?(File.join(__dir__, 'run.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 explorer 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::Gem.manifest do
+  gemspec = WXRuby3::Gem.define_spec 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.extensions = ['ext/mkrf_conf_ext.rb']
+    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.add_dependency 'plat4m', '~> 1.0'
+    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",
+      "homepage_uri"      => "https://github.com/mcorino/wxRuby3",
+      "documentation_uri" => "https://mcorino.github.io/wxRuby3",
+      "github_repo"       => "https://github.com/mcorino/wxRuby3"
+    }
+    gem.post_install_message = <<~__MSG
+
+      The wxRuby3 Gem has been successfully installed including the 'wxruby' utility.
+
+      In case no suitable binary release package was available for your platform you  
+      will need to run the post-install setup process by executing:
+
+      $ wxruby setup
+
+      To check whether wxRuby3 is ready to run or not you can at any time execute the 
+      following command:
+
+      $ wxruby check
+
+      Run 'wxruby check -h' for more information.
+
+      When the wxRuby3 setup has been fully completed you can start using wxRuby3.
+ 
+      You can run the regression tests to verify the installation by executing:
+
+      $ wxruby test
+
+      The wxRuby3 sample explorer can be run by executing:
+
+      $ wxruby sampler
+
+      Have fun using wxRuby3.
+
+      Run 'wxruby -h' to see information on the available commands.
+
+      __MSG
+  end
+  WXRuby3::Gem.build_gem(gemspec)
+end
+
+desc 'Build wxRuby 3 gem'
+task :gem => 'wxruby:gem:srcgem'
+
+# these tasks do not exist for installed (source) gems (where run tasks have been removed)
+if File.file?(File.join(__dir__, 'run.rake'))
+
+  if WXRuby3.is_bootstrapped?
+
+    namespace :wxruby do
+
+      namespace :gem do
+        task :binpkg => ['wxruby:build', 'wxruby:doc', 'bin:build', WXRuby3::Gem.bin_pkg_file]
+      end
+
+    end
+
+    # binary package file
+    file WXRuby3::Gem.bin_pkg_file => WXRuby3::Gem.bin_pkg_manifest do |t|
+      WXRuby3::Install.install_wxwin_shlibs
+      begin
+        # create bin package
+        WXRuby3::Gem.build_bin_pkg
+      ensure
+        # cleanup
+        WXRuby3::Install.remove_wxwin_shlibs
+      end
+    end
+
+    desc 'Build wxRuby 3 binary release package'
+    task :binpkg => 'wxruby:gem:binpkg'
+
+  end
+
+else # in case of installed source gem the following tasks exist
+
+  namespace :wxruby do
+
+    namespace :gem do
+      kwargs = {}
+      no_prebuilt = false
+      task :install do |_, args|
+        argv = args.extras
+        until argv.empty?
+          switch = argv.shift
+          case switch
+          when '--prebuilt'
+            kwargs[:prebuilt_only] = true
+          when '--no-prebuilt'
+            no_prebuilt = true unless kwargs[:package]
+          when '--package'
+            fail "Missing value for '--package' argument for wxruby:gem:install." if argv.empty?
+            kwargs[:package] = argv.shift
+            no_prebuilt = false
+          else
+            fail "Invalid argument #{switch} for wxruby:gem:install."
+          end
+        end
+        unless no_prebuilt # do not even try to find&install a binary package
+          if WXRuby3::Gem.install_gem(**kwargs)
+            # binaries have been installed -> finish install
+            Rake::Task['wxruby:post:binpkg'].invoke
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/rakelib/gem.rb

@@ -0,0 +1,334 @@
+# 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 'zlib'
+require 'tempfile'
+require 'json'
+require 'uri'
+require 'net/https'
+require 'fileutils'
+require 'digest/sha2'
+
+require_relative './lib/config'
+require_relative './install'
+
+module WXRuby3
+
+  module Gem
+
+    BINPKG_EXT = '.pkg'
+    DIGEST_EXT = '.sha'
+
+    class << self
+
+      # Gem helpers
+
+      def manifest
+        # 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/**/*]
+        manifest.exclude "lib/*.#{WXRuby3.config.dll_mask}"
+        manifest.include 'ext/mkrf_conf_ext.rb', '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 %w{LICENSE README.md CREDITS.md INSTALL.md .yardopts}
+        manifest
+      end
+
+      def define_spec(&block)
+        gemspec = ::Gem::Specification.new('wxruby3', WXRuby3::WXRUBY_VERSION)
+        gemspec.required_rubygems_version = ::Gem::Requirement.new(">= 0") if gemspec.respond_to? :required_rubygems_version=
+        block.call(gemspec) if block_given?
+        gemspec
+      end
+
+      def gem_name
+        define_spec.full_name
+      end
+      private :gem_name
+
+      def gem_file
+        File.join('pkg', "#{gem_name}.gem")
+      end
+
+      def 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
+
+      # Binary package helpers
+
+      def bin_pkg_manifest
+        # create MANIFEST list with included files
+        manifest = Rake::FileList.new
+        manifest.include "lib/*.#{WXRuby3.config.dll_mask}"
+        manifest.include 'lib/wx/**/events/*.rb', 'lib/wx/**/ext/*.rb', 'lib/wx/core/font/*.rb'
+        manifest.include "lib/wx/doc/gen/**/*.rb"
+        if WXRuby3.config.get_config('with-wxwin')
+          manifest.include "ext/*.#{WXRuby3.config.dll_mask}"
+        end
+        manifest
+      end
+
+      def make_bin_name
+        os = WXRuby3.config.sysinfo.os
+        case os.id
+        when :windows
+          "wxruby3_#{os.distro}_ruby#{WXRuby3::Config.rb_ver_major}#{WXRuby3::Config.rb_ver_minor}"
+        else
+          "wxruby3_#{os.distro}_#{os.release || '0'}_ruby#{WXRuby3::Config.rb_ver_major}#{WXRuby3::Config.rb_ver_minor}"
+        end
+      end
+      private :make_bin_name
+
+      def bin_pkg_name
+        gemspec = ::Gem::Specification.new(make_bin_name, WXRuby3::WXRUBY_VERSION)
+        platform = ::Gem::Platform.new(RB_CONFIG["arch"])
+        if platform.os == 'darwin'
+          # loose the version for darwin kernels as that does not seem to affect wxRuby runtime compatibility
+          # (until proven otherwise)
+          platform.version = nil
+        end
+        gemspec.platform = platform.to_s
+        gemspec.full_name
+      end
+      private :bin_pkg_name
+
+      def bin_pkg_file
+        File.join('pkg', bin_pkg_name+BINPKG_EXT)
+      end
+
+      def build_bin_pkg
+        # make sure pkg directory exists
+        FileUtils.mkdir_p('pkg')
+
+        fname = bin_pkg_file
+
+        # package registry and essential config
+        registry = []
+        config = %w{wxwininstdir with-wxwin}.reduce({}) { |h, k| h[k] = WXRuby3.config.get_config(k); h }
+        # package temp deflate stream
+        deflate_stream = Tempfile.new(File.basename(fname, '.*'), binmode: true)
+        begin
+          # pack binaries into temp deflate stream
+          bin_pkg_manifest.each do |path|
+            registry << pack_file(deflate_stream, path)
+          end
+          # convert registry and config to deflated json string
+          registry_json_z = Zlib::Deflate.deflate(registry.to_json)
+          config_json_z = Zlib::Deflate.deflate(config.to_json)
+
+          # create final package archive
+          deflate_stream.rewind
+          digest = Digest::SHA256.new
+          File.open(fname, 'w', binmode: true) do |fout|
+            # pack config
+            data = [config_json_z.size].pack('Q')
+            digest << data
+            fout.write(data)
+            digest << config_json_z
+            fout.write(config_json_z)
+            # pack registry
+            data = [registry_json_z.size].pack('Q')
+            digest << data
+            fout.write(data)
+            digest << registry_json_z
+            fout.write(registry_json_z)
+            # pack files
+            registry.each do |entry|
+              if entry[2] > 0
+                data = deflate_stream.read(entry[2])
+                digest << data
+                fout.write(data)
+              end
+            end
+          end
+          sha_file = File.join('pkg', bin_pkg_name+DIGEST_EXT)
+          File.open(sha_file, 'w') { |fsha| fsha << digest.hexdigest! }
+        ensure
+          deflate_stream.close(true)
+        end
+      end
+
+      def pack_file(os, path)
+        pack = true
+        entry = [path, File.stat(path).mode, 0]
+        unless WXRuby3.config.windows?
+          if File.symlink?(path)
+            pack = false
+            entry << File.readlink(path)
+          end
+        end
+        if pack
+          offs = os.tell
+          os.write(Zlib::Deflate.deflate(File.read(path, binmode: true)))
+          entry[2] = os.tell - offs # packed data size
+        end
+        entry
+      end
+      private :pack_file
+
+      # Gem installation helpers
+
+      def install_gem(prebuilt_only: false, package: nil)
+        # check if a user specified binary package is to be used
+        if package
+          uri = File.file?(package) ? nil : URI(package)
+          if uri.nil? || uri.scheme == 'file'
+            filename = package
+            if uri
+              filename = uri.host ? "#{uri.host}:#{uri.path}" : uri.path
+              filename = nil unless File.file?(filename)
+            end
+            if filename
+              $stdout.puts "Installing user package #{filename}..."
+              exit(1) unless install_bin_pkg(filename)
+              $stdout.puts 'Done!'
+              true
+            else
+              $stderr.puts "ERROR: Cannot access file #{package}."
+              exit(1)
+            end
+          elsif uri.scheme == 'http' || uri.scheme == 'https'
+            # download the binary release package
+            $stdout.puts "Downloading #{uri.path}..."
+            filename = File.basename(uri.path)
+            if WXRuby3.config.download_file(uri.path, filename)
+              sha_file = File.basename(filename, '.*')+DIGEST_EXT
+              uri.path = File.join(File.dirname(uri.path), sha_file)
+              unless WXRuby3.config.download_file(uri.path, sha_file)
+                $stderr.puts "ERROR: Unable to download digest signature for binary release package : #{package}"
+                exit(1)
+              end
+              exit(1) unless install_bin_pkg(filename)
+              true
+            else
+              $stderr.puts "ERROR: Unable to download binary release package (#{package})!"
+              exit(1)
+            end
+          else
+          end
+        # check if there exists a pre-built binary release package for the current platform
+        elsif has_release_package?
+          # download the binary release package
+          $stdout.puts "Downloading #{bin_pkg_url(BINPKG_EXT)}..."
+          if WXRuby3.config.download_file(bin_pkg_url(BINPKG_EXT), bin_pkg_name+BINPKG_EXT)
+            unless WXRuby3.config.download_file(bin_pkg_url(DIGEST_EXT), bin_pkg_name+DIGEST_EXT)
+              $stderr.puts "ERROR: Unable to download digest signature for binary release package : #{bin_pkg_name}"
+              exit(1)
+            end
+            exit(1) unless install_bin_pkg(bin_pkg_name+BINPKG_EXT)
+            true
+          else
+            if prebuilt_only
+              $stderr.puts "ERROR: Unable to download binary release package (#{bin_pkg_name})!"
+              exit(1)
+            end
+            $stdout.puts "WARNING: Unable to download binary release package (#{bin_pkg_name})! Reverting to source install."
+            false
+          end
+        else
+          if prebuilt_only
+            $stderr.puts "ERROR: No binary release package available!"
+            exit(1)
+          end
+          false
+        end
+      end
+
+      def bin_pkg_url(ext)
+        # which package are we looking for
+        pkg_name = bin_pkg_name
+        "https://github.com/mcorino/wxRuby3/releases/download/v#{WXRuby3::WXRUBY_VERSION}/#{pkg_name}#{ext}"
+      end
+      private :bin_pkg_url
+
+      def has_release_package?
+        # check if the release package exists on Github
+        uri = URI(bin_pkg_url(BINPKG_EXT))
+        $stdout.print "Checking #{uri.to_s}..." if WXRuby3.config.verbose?
+        response = Net::HTTP.start('github.com', use_ssl: true) do |http|
+          request = Net::HTTP::Head.new(uri)
+          http.request(request)
+        end
+        $stdout.puts "response #{response}" if WXRuby3.config.verbose?
+        # directly found or with redirect
+        Net::HTTPOK === response || Net::HTTPRedirection === response
+      end
+      private :has_release_package?
+
+      def install_bin_pkg(fname)
+        # first get digest signature (if available)
+        sha_file = File.join(File.dirname(fname), File.basename(fname, '.*')+DIGEST_EXT)
+        unless File.file?(sha_file)
+          $stderr.puts "ERROR: Cannot access package digest signature file : #{sha_file}."
+          return false
+        end
+        sha_sig = File.read(sha_file)
+        File.open(fname, 'r', binmode: true) do |fin|
+          # check digest signature
+          digest = Digest::SHA256.new
+          while (data = fin.read(1024*1024))
+            digest << data
+          end
+          if sha_sig != digest.hexdigest!
+            $stderr.puts 'ERROR: Package digest signature does NOT match.'
+            return false
+          end
+          fin.rewind
+          # get packed config size
+          config_size = fin.read(8).unpack('Q').shift
+          # unpack config
+          config = JSON.parse!(Zlib::Inflate.inflate(fin.read(config_size)))
+          # get packed registry size
+          registry_size = fin.read(8).unpack('Q').shift
+          # unpack registry
+          registry = JSON.parse!(Zlib::Inflate.inflate(fin.read(registry_size)))
+          # unpack and create binaries
+          registry.each do |entry|
+            path, mode, size, symlink = entry
+            if symlink
+              FileUtils.mkdir_p(File.dirname(symlink))
+              FileUtils.ln_s(symlink, path)
+            else
+              FileUtils.mkdir_p(File.dirname(path))
+              File.open(path, 'w', binmode: true) do |fbin|
+                fbin << Zlib::Inflate.inflate(fin.read(size))
+              end
+              File.chmod(mode, path)
+            end
+          end
+          # merge config
+          config.each_pair { |k,v| WXRuby3.config.set_config(k, v) }
+        end
+        true
+      end
+      private :install_bin_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|
@@ -66,7 +67,7 @@ module WXRuby3
               FileUtils.ln_s(File.join('.', File.basename(src_shlib)), File.join('ext', File.basename(shlib)))
             else
               FileUtils.cp(shlib, inshlib = File.join('ext', File.basename(shlib)))
-              unless WXRuby3.config.patch_rpath(inshlib, WXRuby3.config.get_rpath_origin)
+              unless WXRuby3.config.update_shlib_loadpaths(inshlib)
                 # cleanup and exit
                 FileUtils.rm_f(Dir["ext/*.#{WXRuby3.config.dll_mask}"])
                 exit(1)
@@ -76,19 +77,20 @@ module WXRuby3
           end
           # prepare wxRuby shared libs
           Dir["lib/*.#{WXRuby3.config.dll_mask}"].each do |shlib|
-            unless WXRuby3.config.patch_rpath(shlib, WXRuby3.config.get_rpath_origin, "#{WXRuby3.config.get_rpath_origin}/../ext")
+            unless WXRuby3.config.update_shlib_loadpaths(shlib) && WXRuby3.config.update_shlib_ruby_libpath(shlib)
               # cleanup and exit
               FileUtils.rm_f(Dir["ext/*.#{WXRuby3.config.dll_mask}"])
               exit(1)
             end
           end
           (wxwin_inshlibs + Dir["lib/*.#{WXRuby3.config.dll_mask}"]).each do |shlib|
-            unless WXRuby3.config.update_shlib_loadpaths(shlib, WXRuby3::Install.wxwin_shlibs)
+            unless WXRuby3.config.update_shlib_wxwin_libpaths(shlib, WXRuby3::Install.wxwin_shlibs)
               # cleanup and exit
               FileUtils.rm_f(Dir["ext/*.#{WXRuby3.config.dll_mask}"])
               exit(1)
             end
           end
+          $stdout.puts 'done!' if WXRuby3.config.run_silent?
         end
       end
 

data/rakelib/lib/config/{cygwin.rb → freebsd.rb}

@@ -6,4 +6,4 @@
 # wxRuby3 buildtools configuration
 ###
 
-raise "Cygwin platform is unsupported as yet."
+raise "Freebsd platform is unsupported as yet."

data/rakelib/lib/config/linux.rb

@@ -7,6 +7,7 @@
 ###
 
 require_relative './unixish'
+require_relative 'pkgman/linux'
 
 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,15 +33,16 @@ 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
             true
           end
+          protected :check_rpath_patch
 
           def patch_rpath(shlib, *rpath)
             if check_rpath_patch
@@ -48,6 +51,27 @@ module WXRuby3
             end
             false
           end
+          protected :patch_rpath
+
+          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