glimmer-dsl-swt 4.21.2.5 → 4.22.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d379f6055bc86787c888142b3ae76c8cec195e558b00880bdcc2ca5849f0323d
-  data.tar.gz: 1c4c5a96157a4ddf59515a9a3399f505071d3e9caf8e32656fb6238157ed8d78
+  metadata.gz: d6fe5217a1c912fb15b8e361b77f974e705541e182e20449b2b1e348e22d92b6
+  data.tar.gz: c9064bb6e9e7abf29e0a4868bbc328253625649fb37df7110ab5943990478043
 SHA512:
-  metadata.gz: 076e3436c4b1258a11b291df10196a9ee18e34703b8769de3b3d5d5120ee66927290e15aa874b98850ca7c73c537469130c1a20d2013f21bcff67b076c771e0c
-  data.tar.gz: ab43d3b02470e200dc0b84c2649f96cae1058307b06923d15c63f6a89f69407d4c66371cdce479b19ba9e5d27071a72b78ab516fde4350c0fdf6f953beb7d528
+  metadata.gz: 68e034634d6eb05df11fdc741f8c5d76de07f1973411d32ea65f7210fec3977ea5be7093e6e504e9cff78656ffbe98a558c91d47be214c408296a3ccc5808797
+  data.tar.gz: 37aa870344fe03f4df807a6e6252ac332816486c2a54c2d79c12e160cacf2ecdf7755eaaac05fc458169c46973e1232815417343bd97f22e9c97ad49504c36d1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+### 4.22.0.0
+
+- Upgrade to SWT 4.22
+- Upgrade to JDK17
+- Upgrade to glimmer 2.5.4
+- Support new SWT 4.22 `sync_call` keyword, which is like `sync_exec`, but returns value of evaluating expression (though `sync_exec` was already enhanced by Glimmer to return the expression evaluated value just like `sync_call`)
+- More work regarding: Do not clean observers when disposing of a widget while closing the last shell  (e.g. when closing an app, it is not needed to clean observers, so it is better to exit faster)
+- Fix issue in Battleship sample caused by data-binding nil model, which is forbidden in glimmer 2.5.x
+- Fix issue with closing Stock Ticker sample taking too long
+
 ### 4.21.2.5
 
 - Hello, Scrolled Composite! sample

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for SWT 4.21.2.5
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for SWT 4.22.0.0
 ## JRuby Desktop Development GUI Framework
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-swt.svg)](http://badge.fury.io/rb/glimmer-dsl-swt)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-dsl-swt.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-dsl-swt)
@@ -17,9 +17,9 @@ Featured in JRuby Cookbook](http://shop.oreilly.com/product/9780596519650.do) an
 
 ![Eclipse SWT RCP NASA Mars Rover](/images/glimmer-eclipse-swt-rcp-nasa-mars-rover.png)
 
-[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.21.2.5 includes [SWT 4.21](https://download.eclipse.org/eclipse/downloads/drops4/R-4.21-202109060500/), which was released on September 6, 2021. Gem version numbers are in sync with the SWT library versions. The first two digits represent the SWT version number. The last two digits represent the minor and patch versions of Glimmer DSL for SWT. Note that SWT now supports AARCH64 on Mac and Linux, but it is not fully tested in Glimmer DSL for SWT yet, so deem its support experimental for the time being without guarantees for functionality until declared otherwise (please report any issues you may encounter).
+[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.22.0.0 includes [SWT 4.22](https://download.eclipse.org/eclipse/downloads/drops4/R-4.22-202111241800/), which was released on November 24, 2021. Gem version numbers are in sync with the SWT library versions. The first two digits represent the SWT version number. The last two digits represent the minor and patch versions of Glimmer DSL for SWT. Note that SWT now supports AARCH64 on Mac and Linux, but it is not fully tested in Glimmer DSL for SWT yet, so deem its support experimental for the time being without guarantees for functionality until declared otherwise (please report any issues you may encounter).
 
-**Starting in version 4.20.0.0, [Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) comes with the new [***Shine***](/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#shine) syntax** for highly intuitive and visually expressive View/Model Attribute Mapping, relying on `<=>` for bidirectional (two-way) data-binding and `<=` for unidirectional (one-way) data-binding, providing an alternative to the `bind` keyword (keep in mind that it is still a beta, so default back to `bind` whenever needed).
+**Starting in version 4.20.0.0, [Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) comes with the new [***Shine***](/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#shine) syntax** for highly intuitive and visually expressive View/Model Attribute Mapping, relying on `<=>` for bidirectional (two-way) data-binding and `<=` for unidirectional (one-way) data-binding, providing an alternative to the `bind` keyword.
 
 Please help make [Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) better by providing feedback and [contributing](#contributing) whenever possible. Any feature suggestions that are accepted could be implemented within weeks if not days.
 
@@ -293,10 +293,10 @@ https://www.eclipse.org/swt/faq.php
 
 ## Pre-requisites
 
-- JDK 16 (16.0.2) (find at https://www.oracle.com/java/technologies/javase/jdk16-archive-downloads.html / Ensure PATH includes Java bin directory for `jpackage` command to work when packaging Glimmer applications)
+- JDK 17 (17.0.1) (find at https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html / Ensure PATH includes Java bin directory for `jpackage` command to work when packaging Glimmer applications)
 - [RVM](http://rvm.io) on Mac & Linux (not available on Windows)
 - JRuby 9.3.1.0 (supporting Ruby 2.6.x syntax) (get via [RVM](http://rvm.io) on Mac and Linux by running `rvm install jruby-9.3.1.0`; On Windows, find at [https://www.jruby.org/download](https://www.jruby.org/download))
-- SWT 4.21 (already included in the [glimmer-dsl-swt](https://rubygems.org/gems/glimmer-dsl-swt) gem). Note that SWT now supports AARCH64 on Mac and Linux, but it is not fully tested with Glimmer DSL for SWT yet, so it is considered experimental until declared otherwise.
+- SWT 4.22 (already included in the [glimmer-dsl-swt](https://rubygems.org/gems/glimmer-dsl-swt) gem). Note that SWT now supports AARCH64 on Mac and Linux, but it is not fully tested with Glimmer DSL for SWT yet, so it is considered experimental until declared otherwise.
 - Git (comes with Mac and Linux. Install on Windows: https://git-scm.com/download/win )
 
 Glimmer might still work on other versions of Java, JRuby and SWT, but there are no guarantees, so it is best to stick to the pre-requisites outlined above.
@@ -325,7 +325,7 @@ jgem install glimmer-dsl-swt
 
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.21.2.5
+jgem install glimmer-dsl-swt -v 4.22.0.0
 ```
 
 `jgem` is JRuby's version of `gem` command.
@@ -353,7 +353,7 @@ Note: if you're using activerecord or activesupport, keep in mind that Glimmer u
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-swt', '~> 4.21.2.5'
+gem 'glimmer-dsl-swt', '~> 4.22.0.0'
 ```
 
 And, then run:
@@ -367,6 +367,8 @@ You may learn more about other Glimmer related gems ([`glimmer-dsl-opal`](https:
 
 ## Glimmer Command
 
+[docs/reference/GLIMMER_COMMAND.md](docs/reference/GLIMMER_COMMAND.md)
+
 You can use the glimmer command to scaffold new apps, run apps & samples, package native executables, and list Glimmer community gems.
 
 ```
@@ -374,7 +376,7 @@ glimmer
 ```
 
 ```
-Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.21.2.5
+Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.22.0.0
       
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
 
@@ -441,6 +443,8 @@ Learn more at:
 
 ## Glimmer GUI DSL Syntax
 
+[docs/reference/GLIMMER_GUI_DSL_SYNTAX.md](docs/reference/GLIMMER_GUI_DSL_SYNTAX.md)
+
 Here is a listing of supported widgets taken from the [SWT website](https://www.eclipse.org/swt/widgets/):
 
 [![SWT Widgets](/images/glimmer-swt-widgets.png)](https://www.eclipse.org/swt/widgets/)

data/VERSION

@@ -1 +1 @@
-4.21.2.5
+4.22.0.0

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -572,6 +572,10 @@ end
 
 `sync_exec {}` is required by SWT when running GUI update from a thread other than the GUI thread. In Glimmer, it is automatically invoked for you so that you wouldn't have to worry about it. It works just like `async_exec` except it executes the block synchronously at the earliest opportunity possible, waiting for the block to be finished.
 
+##### sync_call
+
+`sync_exec {}` is required by SWT when running GUI update from a thread other than the GUI thread. In Glimmer, it is automatically invoked for you so that you wouldn't have to worry about it. It works just like `async_exec` except it executes the block synchronously at the earliest opportunity possible, waiting for the block to be finished.
+
 ##### auto_exec
 
 `auto_exec(override_sync_exec:, override_async_exec) {}` only executes code block with `sync_exec` when necessary (running from a thread other than the GUI thread). It is used automatically all over the Glimmer DSL for SWT codebase, so you wouldn't need it unless you grab a direct handle on `swt_widget` from a widget proxy.
@@ -2408,59 +2412,67 @@ The [Glimmer Tetris](/docs/reference/GLIMMER_SAMPLES.md#tetris) sample provides
 
 ### Data-Binding
 
-Data-binding is done with `bind` command following widget property to bind and taking model and bindable attribute as arguments.
+Data-binding is done with either the [Shine](#shine) syntax `<=>` (bidirectional data-binding) & `<=` (unidirectional data-binding) or via the `bind` keyword, following widget property to bind and taking model and bindable attribute as arguments.
 
 #### General Examples
 
+`text <=> [contact, :first_name]`
+
+This example binds the text property of a widget like `label` to the first name of a contact model using Shine data-binding syntax (recommended).
+
 `text bind(contact, :first_name)`
 
-This example binds the text property of a widget like `label` to the first name of a contact model.
+This example binds the text property of a widget like `label` to the first name of a contact model (older style of data-binding, not recommended).
 
-`text bind(contact, 'address.street')`
+`text <=> [contact, 'address.street']`
 
 This example binds the text property of a widget like `label` to the nested street of
 the address of a contact. This is called nested property data binding.
 
-`text bind(contact, 'address.street', on_read: :upcase, on_write: :downcase)`
+`text <=> [contact, 'address.street', on_read: :upcase, on_write: :downcase]`
 
 This example adds on the one above it by specifying converters on read and write of the model property, like in the case of a `text` widget. The text widget will then displays the street upper case and the model will store it lower case. When specifying converters, read and write operations must be symmetric (to avoid an infinite update loop between the widget and the model since the widget checks first if value changed before updating)
 
-`text bind(contact, 'address.street', sync_exec: true)`
-
-This example forces GUI updates via [sync_exec](#sync_exec) assuming they are coming from another thread (different from the GUI thread)
-
-`text bind(contact, 'address.street', async_exec: true)`
-
-This example forces GUI updates via [async_exec](#async_exec) assuming they are coming from another thread (different from the GUI thread)
-
-`text bind(contact, 'address.street', on_read: lambda { |s| s[0..10] })`
+`text <=> [contact, 'address.street', on_read: ->(s) { s[0..10] }]`
 
 This example also specifies a converter on read of the model property, but via a lambda, which truncates the street to 10 characters only. Note that the read and write operations are assymetric. This is fine in the case of formatting data for a read-only widget like `label`
 
 `text bind(contact, 'address.street') { |s| s[0..10] }`
 
-This is a block shortcut version of the syntax above it. It facilitates formatting model data for read-only widgets since it's a very common view concern. It also saves the developer from having to create a separate formatter/presenter for the model when the view can be an active view that handles common simple formatting operations directly.
+This is a block shortcut version of the syntax above it. It facilitates formatting model data for read-only widgets since it's a very common view concern. It also saves the developer from having to create a separate formatter/presenter for the model when the view can be an active view that handles common simple formatting operations directly (older style of data-binding, not recommended).
 
-`text bind(contact, 'address.street', read_only: true)`
+`text <= [contact, 'address.street']`
 
 This is read-ohly data-binding. It doesn't update contact.address.street when widget text property is changed.
 
-`text bind(contact, 'addresses[1].street')`
+`text bind(contact, 'address.street', read_only: true)`
+
+This is read-ohly data-binding. It doesn't update contact.address.street when widget text property is changed (older style of data-binding, not recommended).
+
+`text <=> [contact, 'addresses[1].street']`
 
 This example binds the text property of a widget like `label` to the nested indexed address street of a contact. This is called nested indexed property data binding.
 
-`text bind(contact, :age, computed_by: :date_of_birth)`
+`text <=> [contact, :age, computed_by: :date_of_birth]`
 
 This example demonstrates computed value data binding whereby the value of `age` depends on changes to `date_of_birth`.
 
-`text bind(contact, :name, computed_by: [:first_name, :last_name])`
+`text <=> [contact, :name, computed_by: [:first_name, :last_name]]`
 
 This example demonstrates computed value data binding whereby the value of `name` depends on changes to both `first_name` and `last_name`.
 
-`text bind(contact, 'profiles[0].name', computed_by: ['profiles[0].first_name', 'profiles[0].last_name'])`
+`text <=> [contact, 'profiles[0].name', computed_by: ['profiles[0].first_name', 'profiles[0].last_name']]`
 
 This example demonstrates nested indexed computed value data binding whereby the value of `profiles[0].name` depends on changes to both nested `profiles[0].first_name` and `profiles[0].last_name`.
 
+`text <=> [contact, 'address.street', sync_exec: true]`
+
+This example forces GUI updates via [sync_exec](#sync_exec) assuming they are coming from another thread (different from the GUI thread)
+
+`text <=> [contact, 'address.street', async_exec: true]`
+
+This example forces GUI updates via [async_exec](#async_exec) assuming they are coming from another thread (different from the GUI thread)
+
 Example from [samples/hello/hello_combo.rb](samples/hello_combo.rb) sample (you may copy/paste in [`girb`](GLIMMER_GIRB.md)):
 
 #### Shine

data/lib/glimmer/data_binding/widget_binding.rb

@@ -49,7 +49,7 @@ module Glimmer
       def call(value)
         SWT::DisplayProxy.instance.auto_exec(override_sync_exec: @sync_exec, override_async_exec: @async_exec) do
           if @widget.respond_to?(:disposed?) && @widget.disposed?
-            deregister_all_observables
+            deregister_all_observables unless @widget.shell_proxy.last_shell_closing?
             return
           end
           # need the rescue false for a scenario with tree items not being equal to model objects raising an exception
@@ -61,7 +61,7 @@ module Glimmer
       
       def evaluate_property
         if @widget.respond_to?(:disposed?) && @widget.disposed?
-          deregister_all_observables
+          deregister_all_observables unless @widget.shell_proxy.last_shell_closing?
           return
         end
         @widget.get_attribute(@property)

data/lib/glimmer/dsl/swt/sync_call_expression.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/swt/exec_expression'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Synchronously executes code block against the SWT Event Loop
+      # to manipulate SWT UI objects on the UI thread safely with
+      # immediate priority when needed.
+      #
+      # Returns the value produced by evaluating the expression.
+      class SyncCallExpression < StaticExpression
+        include ExecExpression
+      end
+    end
+  end
+end

data/lib/glimmer/rake_task/package.rb

@@ -25,6 +25,8 @@ require 'os'
 module Glimmer
   module RakeTask
     module Package
+      JDK_VERSION = '17.0.1'
+      
       class << self
         attr_accessor :jpackage_extra_args
         
@@ -90,10 +92,10 @@ module Glimmer
         def native(native_type=nil, native_extra_args)
           puts "Generating native executable with jpackage..."
           java_version = `jruby -v`
-          if java_version.include?('16.0.2')
-            puts "Java Version 16.0.2 Detected!"
+          if java_version.include?(JDK_VERSION)
+            puts "Java Version #{JDK_VERSION} Detected!"
           else
-            puts "WARNING! Glimmer Packaging Pre-Requisite Java Version 16.0.2 Is Not Found!"
+            puts "WARNING! Glimmer Packaging Pre-Requisite Java Version #{JDK_VERSION} Is Not Found!"
           end
           require 'facets/string/titlecase'
           require 'facets/string/underscore'

data/lib/glimmer/swt/custom/drawable.rb

@@ -109,8 +109,10 @@ module Glimmer
         end
         
         def deregister_shape_painting
-          @paint_listener_proxy&.deregister
-          @resize_listener_proxy&.deregister
+          unless shell_proxy.last_shell_closing?
+            @paint_listener_proxy&.deregister
+            @resize_listener_proxy&.deregister
+          end
         end
         
         def setup_shape_painting

data/lib/glimmer/swt/shell_proxy.rb

@@ -88,7 +88,7 @@ module Glimmer
           end
           on_widget_disposed do
             @last_shell_closing = true if @display.shells.count == 1 && @display.shells.first == @swt_widget
-            clear_shapes
+            clear_shapes unless @last_shell_closing
           end
           @display ||= @swt_widget.getDisplay
         end

data/lib/glimmer/swt/widget_proxy.rb

@@ -175,8 +175,10 @@ module Glimmer
           @keyword = underscored_widget_name.to_s
           if respond_to?(:on_widget_disposed)
             on_widget_disposed {
-              clear_shapes
-              deregister_shape_painting
+              unless shell_proxy.last_shell_closing?
+                clear_shapes
+                deregister_shape_painting
+              end
             }
           end
         end
@@ -199,7 +201,11 @@ module Glimmer
       end
       
       def shell_proxy
-        @swt_widget.shell.get_data('proxy')
+        if @swt_widget.respond_to?(:shell)
+          @swt_widget.shell.get_data('proxy')
+        else
+          @parent_proxy&.shell_proxy
+        end
       end
       
       def extract_args(underscored_widget_name, args)

data/lib/glimmer/ui/custom_widget.rb

@@ -188,8 +188,10 @@ module Glimmer
         auto_exec { execute_hook('after_body') }
         auto_exec do
           @dispose_listener_registration = @body_root.on_widget_disposed do
-            observer_registrations.compact.each(&:deregister)
-            observer_registrations.clear
+            unless @body_root.shell_proxy.last_shell_closing?
+              observer_registrations.compact.each(&:deregister)
+              observer_registrations.clear
+            end
           end
         end
         post_add_content if content.nil?

data/samples/elaborate/battleship/view/cell.rb

@@ -54,10 +54,18 @@ class Battleship
           
           rectangle(0, 0, [:max, -1], [:max, -1])
           oval(:default, :default, 10, 10) {
-            foreground <= [model, :hit, on_read: ->(h) {h == nil ? COLOR_EMPTY : (h ? COLOR_HIT : COLOR_NO_HIT)}]
+            if model.nil?
+              foreground COLOR_EMPTY
+            else
+              foreground <= [model, :hit, on_read: ->(h) {h == nil ? COLOR_EMPTY : (h ? COLOR_HIT : COLOR_NO_HIT)}]
+            end
           }
           oval(:default, :default, 5, 5) {
-            background <= [model, :hit, on_read: ->(h) {h == nil ? COLOR_EMPTY : (h ? COLOR_HIT : COLOR_NO_HIT)}]
+            if model.nil?
+              background COLOR_EMPTY
+            else
+              background <= [model, :hit, on_read: ->(h) {h == nil ? COLOR_EMPTY : (h ? COLOR_HIT : COLOR_NO_HIT)}]
+            end
           }
           
           on_mouse_move do |event|

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-swt
 version: !ruby/object:Gem::Version
-  version: 4.21.2.5
+  version: 4.22.0.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: 2.5.4
   name: glimmer
   prerelease: false
   type: :runtime
@@ -23,7 +23,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: 2.5.4
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -466,6 +466,7 @@ files:
 - lib/glimmer/dsl/swt/shell_expression.rb
 - lib/glimmer/dsl/swt/shine_data_binding_expression.rb
 - lib/glimmer/dsl/swt/swt_expression.rb
+- lib/glimmer/dsl/swt/sync_call_expression.rb
 - lib/glimmer/dsl/swt/sync_exec_expression.rb
 - lib/glimmer/dsl/swt/tab_item_expression.rb
 - lib/glimmer/dsl/swt/table_items_data_binding_expression.rb