wxruby3 1.6.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25ead08d281891ae9ad295a8181908c163677a4b9e0686249185941866118d49
-  data.tar.gz: 552bef0440f00907f30b273411dbfed19b8430bfbf49538efac2cd6104e6021b
+  metadata.gz: 36b9eb0db175364b374a899f3458497f09dddbfbc981c08b36f0c43c83d225b7
+  data.tar.gz: ac07b0f69b8878db1ee966d4ec2b79f4ee0122ee173a70a5ef7a4a274c634c6e
 SHA512:
-  metadata.gz: 598918c1e5d613797115ede72de7cc8024bf6468ee81a51b567297c153df12da11390740fca827b67c15dae9e2e874b38969088bf27e808b644fc810abb1a6c0
-  data.tar.gz: bf26ee5eebeef682e88831df0a0bb7b260138e4cae2c6f41425a327133c7f60fce0b5897bb722b5eb05acbdbefa92fb6e860235d2942cd0e35ef42919ca2354d
+  metadata.gz: b369e2270784db0220735194f98d047a97f0a277c7bba518627800e3c7ed70245a428a650aa531877314acae6c003ffad899295dcbdb36c9e1dcfb1714b46926
+  data.tar.gz: 0f86862841afe346ee8ee0218ef5a4259c9c22aa6109659e41e2e499575402aad3519a9bae99ea32150785fe8d278a5513e5a66d4ad21599ab4e9ad8c67c2f50

data/CREDITS.md

@@ -9,6 +9,13 @@ Martin Corino established the wxRuby3 project in 2022.
 
 Martin Corino: mcorino at m2c-software dot nl
 
+### Contributors
+
+Andy Maleh \
+Brandon Zylstra \
+Johnny Willemsen \
+Jacob Miner
+
 ## wxRuby 2
 
 In 2005 Kevin Smith established the wxRuby 2.0 project of which parts are still
@@ -19,31 +26,31 @@ feature requests.
 The alphabetic list shows (some of) those who've contributed code to
 wxRuby 2.0.
 
-Albin Holmgren
-Alex Fenton
-Artur Kuptel
-Cezar Espinola
-Chauk-Mean Proum
-Christophe Bludau
-Curt Hibbs
-Dale Edmons
-Daniel Savarese
-David Whetstone
-Dirk Traulsen
-Hawley Waldman
-Jani Monoses
-Joe Seeley
-Jonathan Maasland
-Kevin Smith
-Mario Steele
-Nic
-Pascal Hurni
-Robert Carlin
-Roy Sutton
-Ryuichi Sakamoto
-Sean Lindsay
-Sean Long
-Tobias Gruetzmacher
+Albin Holmgren \
+Alex Fenton \
+Artur Kuptel \
+Cezar Espinola \
+Chauk-Mean Proum \
+Christophe Bludau \
+Curt Hibbs \
+Dale Edmons \
+Daniel Savarese \
+David Whetstone \
+Dirk Traulsen \
+Hawley Waldman \
+Jani Monoses \
+Joe Seeley \
+Jonathan Maasland \
+Kevin Smith \
+Mario Steele \
+Nic \
+Pascal Hurni \
+Robert Carlin \
+Roy Sutton \
+Ryuichi Sakamoto \
+Sean Lindsay \
+Sean Long \
+Tobias Gruetzmacher \
 Zach Dennis
 
 ## wxWidgets

data/INSTALL.md

@@ -27,7 +27,7 @@ should always result in a successfully installed wxRuby3 version.
 > The user is therefor required to install a Ruby interpreter using either [MacPorts](https://www.macports.org/) (both 
 > privileged and user installations are supported) or [Homebrew](https://brew.sh/) or Ruby installers/version managers 
 > like [ruby-install](https://github.com/postmodern/ruby-install) or [RVM](https://rvm.io) (only user installations 
-> supported) .
+> supported) or [rbenv](https://rbenv.org).
 
 [Below](INSTALL.md#installing-software-requirements) more details regarding the software requirements for wxRuby3, the 
 setup procedure and various options to tweak and customize the installation (including platform specific details for 
@@ -78,8 +78,14 @@ The following tables lists the packages provided by the current wxRuby3 release
 | Linux   | Debian (at least latest stable)        | x86_64 <b>and</b> ARM64 | Distro provided Ruby <b>and</b> Latest stable Ruby |  
 | Linux   | Ubuntu (at least latest stable)        | x86_64 <b>and</b> ARM64 | Distro provided Ruby <b>and</b> Latest stable Ruby |
 | Windows | NA                                     | x86_64                  | Latest stable Ruby                                 |
-| OSX     | MacOSX 13                              | x86_64 <b>and</b> ARM64 | Latest stable Ruby                                 |
-| OSX     | MacOSX 14                              | ARM64                   | Latest stable Ruby                                 |
+| OSX     | MacOS 14                               | ARM64                   | Latest stable Ruby                                 |
+| OSX     | MacOS 15                               | x86_64 <b>and</b> ARM64 | Latest stable Ruby                                 |
+| OSX     | MacOS 26                               | x86_64 <b>and</b> ARM64 | Latest stable Ruby                                 |
+
+### Additional packages
+
+Some additional packages built from local resources may be added to the standard release artifacts (like for example for 
+LinuxMint x86_64) but this will also depend on available time and resources.
 
 ### User created packages
 
@@ -101,7 +107,7 @@ The software requirements for setting up a wxRuby3 runtime environment are:
 
 | Sofware                                       | Notes                                                                                                                                                                                                                                                                                                                        |
 |-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Ruby >= 2.7                                   | A supported version of the Ruby interpreter needs to be installed. This is an absolute requirement for any installation as one cannot install gems without Ruby and building from source requires Ruby to drive the build process.                                                                                           |
+| Ruby >= 3.0                                   | A supported version of the Ruby interpreter needs to be installed. This is an absolute requirement for any installation as one cannot install gems without Ruby and building from source requires Ruby to drive the build process.                                                                                           |
 | C++ compiler<br>(incl. dev tools like `make`) | Required for a source based installation to build wxWidgets (optionally) and the wxRuby extension libraries.<br/>On linux a recent version of the GNU C++ compiler (with c++-14 support) is required.<br>On Windows the RubyInstaller MSYS2-Devkit would be required.<br>On MacOS XCode with commandline tools would be required. |
 | Git version control toolkit                   | Required for a source based installation in to (possibly) clone a copy of the wxWidgets Github repository or to clone the Github repository of wxRuby3 itself for a fully source based installation.                                                                                                                         |
 | Doxygen (>= 1.9.1)                            | Required for building the wxRuby3 extension libraries for a source based installation. [**1**]                                                                                                                                                                                                                               |
@@ -115,7 +121,7 @@ But of course any of these requirements can also be fulfilled explicitly with se
 wxRuby3 installation procedure. See the platform specific sections of [Installing software requirements](INSTALL.md#installing-software-requirements) for details on 
 how to go about that. 
 
-[**1**] The wxRuby3 build process needs doxygen to generated XML files containing wxWidgets interface specs which are used to 
+[**1**] The wxRuby3 build process needs doxygen to generate XML files containing wxWidgets interface specs which are used to 
 generate interface definitions for SWIG
 
 [**2**] The wxRuby3 build process uses SWIG to generate C++ source code for the wrapper interfaces from
@@ -336,7 +342,19 @@ the `--with-wxwin` option like this:
 wxruby setup --with-wxwin
 ```
 
-This will force the setup procedure to build and install an embedded wxWidgets version for wxRuby3.
+This will force the setup procedure to build and install an embedded wxWidgets version for wxRuby3. By default the 
+latest stable wxWidgets release will be embedded. 
+
+#### Specify specific embedded wxWidgets release
+
+When using `--with-wxwin` a specific wxWidgets release version can be specified like this:
+
+```shell
+wxruby setup --with-wxwin --wxversion=3.2.9
+```
+
+Note that both `--with-wxwin` and `--wxversion` are required. Also note that the release version must be specified
+as '<major version nr>.<minor version number>.<release number>' without any 'v' (or other) prefix.
 
 #### Force embedded wxWidgets head installation
 
@@ -347,12 +365,34 @@ be started with the `--with-wxhead` option like this:
 wxruby setup --with-wxhead
 ```
 
+Note that in this case `--with-wxwin` is implied.
+
 > **NOTE**<br>
 > Although wxRuby3 endeavors to keep up to date with the wxWidgets master branch your mileage may vary depending on
 > the development state of the wxWidgets master branch. You can check the latest results of the wxRuby3 CI master build 
 > workflows of the [wxRuby3 Github Actions](https://github.com/mcorino/wxRuby3/actions) to get a feel of the current 
 > integration state. 
 
+#### Controlling included modules for embedded wxWidgets
+
+When building wxRuby3 with embedded wxWidgets (implicit or explicit) there are some setup arguments to control the
+modules included in the wxRuby3 installation.
+If none of these options are specified __all__ modules will be included by default.
+
+Note that these option only have effect if building with embedded wxWidgets. When building for wxWidgets system or user 
+installation, module support will be determined by the build options supplied when building that wxWidgets installation.
+
+##### WebView module
+
+To explicitly include the wxWidgets WebView library for the Wx::WEB::WebView module (the default) add the 
+`--with-webview` option. To explicitly specify which WebView backends should be supported it is possible to use the
+option like `--with-webview=<backend>[,<backend>`.
+On Windows __<backend\>__ can be `edge` and/or `ie`. By default, if no backend is specified, only the `edge` backend
+will be supported on Windows.
+On Linux and MacOS currently only the `webkit` backend is supported.
+
+To explicitly exclude WebView support add the `--without-webview` option. 
+
 #### Setup with user installed wxWidgets
 
 In case of a (custom) user installation of wxWidgets the `--wxwin` (and optionally `--wxxml`) option(s) can be used to

data/README.md

@@ -65,7 +65,7 @@ Wx::App.run { TheFrame.new('Hello world!').show }
 ## wxRuby3 licence
 
 wxRuby3 is free and open-source. It is distributed under the liberal
-MIT licence which is compatible with both free and commercial development.
+MIT license which is compatible with both free and commercial development.
 See [LICENSE](LICENSE) for more details.
 
 ### wxRuby3 and wxWidgets
@@ -76,7 +76,7 @@ those requirements do not impose any serious restrictions.
 
 ### wxWidgets License Summary (from wxWidgets)
 
-In summary, the licence is LGPL plus a clause allowing unrestricted
+In summary, the license is LGPL plus a clause allowing unrestricted
 distribution of application binaries. To answer a FAQ, you don't have to
 distribute any source if you wish to write commercial applications using
 wxWidgets.
@@ -97,23 +97,23 @@ of these products.
  
 ### What platforms and operating systems are supported in wxRuby3?
 
-Currently the following are fully supported:
+Currently, the following are fully supported:
 
-| Platform                                                                                                                           | Ruby version(s)                                     | wxWidgets version(s) |
-|------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|----------------------|
-| Windows >= 10                                                                                                                      | Ruby >= 2.7<br>(RubyInstaller MSYS2-DevKit)         | wxWidgets >= 3.2     |
-| Linux (tested; all major AMD64 and ARM64 distributions: Ubuntu, Debian, Fedora, OpenSuSE and ArchLinux)<br>(most likely also i686) | Ruby >= 2.7                                         | wxWidgets >= 3.2     |
-| MacOS >= 10.10 using Cocoa (tested on AMD64 and ARM64 M1/M2 Chip)                                                                  | Ruby >= 2.7 (MacPorts, Homebrew, ruby-install, RVM) | wxWidgets >= 3.2     |
+| Platform                                                                                                                                               | Ruby version(s)                                            | wxWidgets version(s) |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------------------|
+| Windows >= 10                                                                                                                                          | Ruby >= 3.0<br>(RubyInstaller MSYS2-DevKit)                | wxWidgets >= 3.2     |
+| Linux (tested; all major AMD64 and ARM64 distributions: Ubuntu, Debian, Fedora, OpenSuSE, LinuxMint, Manjaro and ArchLinux)<br>(most likely also i686) | Ruby >= 3.0                                                | wxWidgets >= 3.2     |
+| MacOS >= 14 (MacOS 13 most likely also works) using Cocoa (tested on AMD64 and ARM64 M1/M2 Chip)                                                       | Ruby >= 3.0 (MacPorts, Homebrew, ruby-install, RVM, Rbenv) | wxWidgets >= 3.2     |
 
 Support for other platforms is not being actively developed at present,
 but patches are welcome. It is likely to be much simpler to get wxRuby
-working on similar modern systems (eg FreeBSD or Solaris with GTK) than
-on legacy systems (eg Windows 98, Mac OS 9).
+working on similar modern systems (e.g. FreeBSD or Solaris with GTK) than
+on legacy systems (e.g. Windows 98, macOS 9).
 
 ### How can I install wxRuby3?
 
 wxRuby3 is distributed as a Ruby gem on [RubyGems](https://rubygems.org). This gem can also be downloaded from the release 
-assets on [Github](https://github.com/mcorino/wxRuby3/releases).
+assets on [GitHub](https://github.com/mcorino/wxRuby3/releases).
 
 The wxRuby3 gem provides a **worry-free** installation procedure for all supported platforms.  
 
@@ -124,7 +124,7 @@ supported version of the Ruby interpreter. So the following command is all it ta
 gem install wxruby3
 ```
 
-The wxRuby3 installation procedure will check the availability of a, prebuilt, binary package matching the platform
+The wxRuby3 installation procedure will check the availability of a prebuilt, binary package matching the platform
 being installed on and if found will download and install that package resulting in a ready-to-run wxRuby3 installation.<br>
 If no matching package is found the installation reverts to a source installation which will require an additional setup
 step to finalize the wxRuby3 installation by executing the following command:
@@ -135,7 +135,7 @@ wxruby setup
 
 This last command is a fully automated setup procedure provided by the wxRuby3 **CLI** installed with the gem. This 
 procedure (by default) will analyze your system and install (after asking your consent) any missing software 
-requirements and build the wxRuby3 extension libraries (including a embedded copy of wxWidgets if necessary). It may 
+requirements and build the wxRuby3 extension libraries (including an embedded copy of wxWidgets if necessary). It may 
 take quite a while depending on your system (around 10-15 minutes on a modern PC but could be significantly longer
 on 'older' PC's) but you can mostly sit back and relax.
 
@@ -146,11 +146,11 @@ on 'older' PC's) but you can mostly sit back and relax.
 > on like the nokogiri gem).
 
 The wxRuby3 CLI also provides a 'check' command with which the runtime status of the wxRuby3 installation can be checked
-at any time. By default running `wxruby check` will display a message reporting the runtime and suggestions on finalizing
+at any time. By default, running `wxruby check` will display a message reporting the runtime and suggestions on finalizing
 the installation if not finalized yet. No message is displayed if wxRuby3 is ready to run. Run `wxruby check -h` for 
 details concerning this command. 
 
-A selection of (prebuilt) binary packages is provided as release assets on [Github](https://github.com/mcorino/wxRuby3/releases).
+A selection of (prebuilt) binary packages is provided as release assets on [GitHub](https://github.com/mcorino/wxRuby3/releases).
 See the [INSTALL](INSTALL.md#binary-packages) document for more details.
 
 This install procedure can of course be tweaked and customized with commandline arguments.
@@ -158,7 +158,7 @@ See the [INSTALL](INSTALL.md) document for more details.
 
 ### Where can I ask a question, or report a bug?
 
-Use GitHUb Issues.
+Use GitHub Issues.
 
 When asking a question, if something is not working as you expect,
 please provide a *minimal*, *runnable* sample of code that demonstrates
@@ -215,7 +215,7 @@ stopped in early 2005, in favour of what became wxRuby 2.0. This project
 in turn stopped being supported in 2013.
 Several years of development have passed for wxWidgets and Ruby respectively,
 improving code quality, adding new classes and new language features.
-In 2022 I finally found the time and the inspiration to pick up this project
+In 2022, I finally found the time and the inspiration to pick up this project
 with the idea of reviving it to build some applications I had in mind.
 wxRuby 3 intends to provide Ruby interfaces for all relevant (!) wxWidget
 classes of the latest version 3.2 and beyond.