glimmer-dsl-swt 4.20.2.1 → 4.20.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba041a49dabbc3bbe0b3ac98cb5ba113b386087149563a331290fba998a45887
-  data.tar.gz: 042ea65040e8b874f8477fa87266ae48c88affd922b824f64e1ab891b28f85ff
+  metadata.gz: b0bba8c354a9db8c2792672663e9aa7831f38ad7b34fd5a3d928fdb12a64eba3
+  data.tar.gz: 671c5533d419dd32454f3dba595f7887f3b65d0643e89c7ef6db8dba44d3f4f7
 SHA512:
-  metadata.gz: 755a71479d44c7bcb3efd6a4f4ae1e0c6d378f25374584bca4f1fe7ede096d683b6770016eb4566bbacb2c40bf2b64300846e57408cf0ca5745910bba68801ac
-  data.tar.gz: 75617372b2e04e5064cfa0a408504e43a4defd25194f1b16f27a91ca8275865dd3337ac76397087ac74e9878f51d194d7626c227509b9ac93a823a14faba0a4f
+  metadata.gz: 448277d9a14e6dc86bb6685c5f6890090246147bdbf9099d9035ec6b9fc294f042cd2d211b107249d648eb002e4d80bd5c5f3d4349647619708ea5cd88a39719
+  data.tar.gz: a98582730c8ec1143e387cadb89cc80432b72aa1d50db2c935f5b3212403f8a13d3b9daa4292b09d9efcb0afceef108d40ccd8eb28bc6e286f3cd14c6cc26ef6

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+### 4.20.4.2
+
+- Hello, Label!
+
+### 4.20.4.1
+
+- Ensure a `table` with `:editable` style loses it if `items <= ...` one-way data-binding (having read_only: true option) was setup.
+- Tweak/refactor/improve samples
+
+### 4.20.4.0
+
+- Extracted Shine data-binding syntax and `BindExpression` to Glimmer 2
+
+### 4.20.3.0
+
+- Shine data-binding support for `custom widgets`, `custom shells`, and `custom shapes`
+- Update remaining samples with `bind` keyword to switch to Shine data-binding syntax
+- Switch scaffolded classes' data-binding to Shine
+- Fix `table` Shine syntax support for unidirectional (one-way) data-binding
+
 ### 4.20.2.1
 
 - Shine data-binding support for `animation` (also supporting `#content {}` method in `Animation`)

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.20.2.0
+# [<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.20.4.2
 ## 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)
@@ -15,9 +15,9 @@
 [<img src="https://covers.oreillystatic.com/images/9780596519650/lrg.jpg" width=105 /><br />
 Featured in JRuby Cookbook](http://shop.oreilly.com/product/9780596519650.do) and [Chalmers/Gothenburg University Software Engineering Master's Lecture Material](http://www.cse.chalmers.se/~bergert/slides/guest_lecture_DSLs.pdf)
 
-[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.20.2.0 includes [SWT 4.20](https://download.eclipse.org/eclipse/downloads/drops4/R-4.20-202106111600/), which was released on June 11, 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 (report any issues you may encounter).
+[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.20.4.2 includes [SWT 4.20](https://download.eclipse.org/eclipse/downloads/drops4/R-4.20-202106111600/), which was released on June 11, 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 (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 an early alpha, 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 (keep in mind that it is still a beta, so default back to `bind` whenever needed).
 
 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.
 
@@ -347,7 +347,7 @@ jgem install glimmer-dsl-swt
 
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.20.2.0
+jgem install glimmer-dsl-swt -v 4.20.4.2
 ```
 
 `jgem` is JRuby's version of `gem` command.
@@ -375,7 +375,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.20.2.0'
+gem 'glimmer-dsl-swt', '~> 4.20.4.2'
 ```
 
 And, then run:
@@ -396,7 +396,7 @@ glimmer
 ```
 
 ```
-Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.20.2.0
+Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.20.4.2
       
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
 

data/VERSION

@@ -1 +1 @@
-4.20.2.1
+4.20.4.2

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -2278,13 +2278,16 @@ Example from [samples/hello/hello_combo.rb](samples/hello_combo.rb) sample (you
 
 #### Shine
 
-**(EARLY ALPHA FEATURE)**
+**(BETA FEATURE)**
 
 The new Shine syntax for View/Model Attribute Mapping allows data-binding visually with simple arrow operators in Ruby.
 
 Use `<=> [model, attribute, options]` for bidirectional (two-way) data-binding instead of `bind(model, attribute, options)`.
 Use `<= [model, attribute, options]` for unidirectional (one-way) data-binding instead of `bind(model, attribute, read_only: true, more_options)`
 
+One thing special with the `table` widget is that `<=`, which makes data-binding unidirectional, stops the `table` from supporting automatic sorting by default since that involves modifying the model collection ordering (albeit not the content).
+To enable automatic sorting in a `table`, but still not permit edit actions to the data itself, you simply use `<=>` for bidirectional data-binding, but without passing the `:editable` style to the `table`.
+
 Examples:
 
 ```ruby
@@ -2299,7 +2302,7 @@ text <=> [@contact, :last_name]
 text <= [@contact, :name, computed_by: [:first_name, :last_name]]
 ```
 
-Note that `table`, `tree`, custom widgets, custom shapes, and animations are not supported by Shine syntax for data-binding yet, so continue to use `bind` with them for the time being.
+Given that Shine is new, if you encounter any issues, you can use `bind` instead.
 
 Check out [sample code](/samples) for more examples of Shine syntax in action, such as [Hello, Computed!](/docs/reference/GLIMMER_SAMPLES.md#hello-computed).
 

data/docs/reference/GLIMMER_SAMPLES.md

@@ -2,6 +2,7 @@
   - [Hello Samples](#hello-samples)
     - [Hello, World!](#hello-world)
     - [Hello, Button!](#hello-button)
+    - [Hello, Label!](#hello-label)
     - [Hello, Text!](#hello-text)
     - [Hello, Composite!](#hello-composite)
     - [Hello, Layout!](#hello-layout)
@@ -117,6 +118,28 @@ Hello, Button! Incremented 7 times!
 
 ![Hello Button Incremented](/images/glimmer-hello-button-incremented.png)
 
+#### Hello, Label!
+
+This sample demonstrates the use of the `label` widget in Glimmer.
+
+Code:
+
+[samples/hello/hello_label.rb](/samples/hello/hello_label.rb)
+
+![Hello Label Left Aligned](/images/glimmer-hello-label-left-aligned.png)
+
+![Hello Label Center Aligned](/images/glimmer-hello-label-center-aligned.png)
+
+![Hello Label Right Aligned](/images/glimmer-hello-label-right-aligned.png)
+
+![Hello Label Images](/images/glimmer-hello-label-images.png)
+
+![Hello Label Background Images](/images/glimmer-hello-label-background_images.png)
+
+![Hello Label Horizontal Separator](/images/glimmer-hello-label-horizontal-separator.png)
+
+![Hello Label Vertical Separator](/images/glimmer-hello-label-vertical-separator.png)
+
 #### Hello, Text!
 
 This sample demonstrates the use of the `text` widget in Glimmer, including data-binding (e.g. via the `<=>` operator) and event handling.

data/lib/glimmer-dsl-swt.rb

@@ -30,6 +30,7 @@ if !['', 'false'].include?(ENV['GLIMMER_BUNDLER_SETUP'].to_s.strip.downcase)
 end
 require 'java'
 require 'puts_debuggerer' if ("#{ENV['pd']}#{ENV['PD']}").to_s.downcase.include?('true')
+require 'concurrent-ruby' # ensures glimmer relies on Concurrent data-structure classes (e.g. Concurrent::Array)
 require 'glimmer'
 require 'logging'
 require 'nested_inherited_jruby_include_package'

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -39,6 +39,7 @@ module Glimmer
         @model_binding = model_binding
         @read_only_sort = @model_binding.binding_options[:read_only_sort]
         @column_properties = @model_binding.binding_options[:column_properties] || @model_binding.binding_options[:column_attributes] || column_properties
+        @table.editable = false if @model_binding.binding_options[:read_only]
         if @table.respond_to?(:column_properties=)
           @table.column_properties = @column_properties
         else # assume custom widget

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

@@ -1,5 +1,5 @@
 # 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
@@ -7,10 +7,10 @@
 # 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
@@ -20,6 +20,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/bind_expression'
 require 'glimmer/data_binding/model_binding'
 
 module Glimmer
@@ -30,28 +31,7 @@ module Glimmer
       # DataBindingCommandHandler for text and selection properties on Text and Spinner
       # or TableItemsDataBindingCommandHandler for items in a Table
       class BindExpression < StaticExpression
-        def can_interpret?(parent, keyword, *args, &block)
-          (
-            keyword == 'bind' and
-              (
-                (
-                  (args.size == 2) and
-                    textual?(args[1])
-                ) ||
-                  (
-                    (args.size == 3) and
-                      textual?(args[1]) and
-                      (args[2].is_a?(Hash))
-                  )
-              )
-          )
-        end
-  
-        def interpret(parent, keyword, *args, &block)
-          binding_options = args[2] || {}
-          binding_options[:on_read] = binding_options.delete(:on_read) || binding_options.delete('on_read') || block
-          DataBinding::ModelBinding.new(args[0], args[1].to_s, binding_options)
-        end
+        include Glimmer::DSL::BindExpression
       end
     end
   end

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

@@ -54,7 +54,7 @@ module Glimmer
         def add_content(parent, keyword, *args, &block)
           # TODO consider avoiding source_location
           return if block&.parameters&.count == 2
-          if block.source_location == parent.content&.__getobj__.source_location
+          if block.source_location == parent.content&.__getobj__&.source_location
             parent.content.call(parent) unless parent.content.called?
           else
             super

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

@@ -52,7 +52,7 @@ module Glimmer
           widget_binding.call(model_binding.evaluate_property)
           widget_binding.observe(model_binding)
   
-          raise(Glimmer::Error, "No radios found! Make sure radio selection is data-bound to a property having property_options as non-empty array!") if parent.items.empty?
+          raise(Glimmer::Error, "No radios found! Make sure radio selection is data-bound to a property having property_options as non-empty array!") if parent.get_items.empty?
           Glimmer::SWT::DisplayProxy.instance.auto_exec(override_sync_exec: model_binding.binding_options[:sync_exec], override_async_exec: model_binding.binding_options[:async_exec]) do
             parent.on_widget_selected do
               model_binding.call(widget_binding.evaluate_property)

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

@@ -38,8 +38,6 @@ module Glimmer
               (parent.respond_to?(:has_attribute?) and parent.has_attribute?(keyword)) or
               (parent.respond_to?(:swt_widget) and (parent.swt_widget.is_a?(Table) or parent.swt_widget.is_a?(Tree)))
             ) and
-            !parent.is_a?(Glimmer::UI::CustomWidget) and
-            !parent.is_a?(Glimmer::UI::CustomShape) and
             !(parent.respond_to?(:swt_widget) && parent.swt_widget.class == org.eclipse.swt.widgets.Canvas && keyword == 'image')
         end
   

data/lib/glimmer/rake_task/scaffold.rb

@@ -642,7 +642,7 @@ module Glimmer
             custom_shell_file_content += <<-MULTI_LINE_STRING
           grid_layout
           label(:center) {
-            text bind(self, :greeting)
+            text <= [self, :greeting]
             font height: 40
             layout_data :fill, :center, true, true
           }
@@ -712,7 +712,7 @@ module Glimmer
             ].each do |greeting_text|
               button(:radio) {
                 text greeting_text
-                selection bind(self, :greeting) { |g| g == greeting_text }
+                selection <= [self, :greeting, on_read: ->(g) { g == greeting_text }]
                 layout_data {
                   width 160
                 }

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

@@ -29,7 +29,7 @@ module Glimmer
         include Glimmer::UI::CustomWidget
         
         body {
-          composite # just an empty composite to hold checkboxs upon data-binding `selection`
+          composite {} # just an empty composite to hold checkboxs upon data-binding `selection`
         }
         
         def items=(text_array)

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

@@ -29,7 +29,7 @@ module Glimmer
         include Glimmer::UI::CustomWidget
         
         body {
-          composite # just an empty composite to hold radios upon data-binding `selection`
+          composite {} # just an empty composite to hold radios upon data-binding `selection`
         }
         
         def items=(text_array)
@@ -41,6 +41,7 @@ module Glimmer
         def items
           @items || []
         end
+        alias get_items items
         
         def selection=(text)
           radios.count.times do |index|

data/lib/glimmer/swt/proxy_properties.rb

@@ -81,7 +81,7 @@ module Glimmer
           end
         end
         unless swt_widget_operation
-          result = send(ruby_attribute_setter(attribute_name), args)
+          result = send(ruby_attribute_setter(attribute_name), args) if respond_to?(ruby_attribute_setter(attribute_name), args)
         end
         result
       end
@@ -102,10 +102,10 @@ module Glimmer
           end
         end
         unless swt_widget_operation
-          result = if respond_to?(ruby_attribute_getter(attribute_name))
-            send(ruby_attribute_getter(attribute_name))
-          else
-            send(attribute_name)
+          if respond_to?(ruby_attribute_getter(attribute_name))
+            result = send(ruby_attribute_getter(attribute_name))
+          elsif respond_to?(attribute_name)
+            result = send(attribute_name)
           end
         end
         result

data/lib/glimmer/swt/widget_proxy.rb

@@ -232,9 +232,12 @@ module Glimmer
       def has_attribute?(attribute_name, *args)
         # TODO test that attribute getter responds too
         widget_custom_attribute = widget_custom_attribute_mapping[attribute_name.to_s]
+        property_type_converter = property_type_converters[attribute_name.to_s.to_sym]
         auto_exec do
           if widget_custom_attribute
             @swt_widget.respond_to?(widget_custom_attribute[:setter][:name])
+          elsif property_type_converter
+            true
           else
             super
           end

data/lib/glimmer/ui/custom_shape.rb

@@ -248,7 +248,7 @@ module Glimmer
       # Otherwise, if a block is passed, it adds it as content to this custom shape
       def content(&block)
         if block_given?
-          body_root.content(&block)
+          Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::SWT::CustomShapeExpression.new, self.class.keyword, &block)
         else
           @content
         end

data/lib/glimmer/ui/custom_widget.rb

@@ -296,7 +296,7 @@ module Glimmer
       # Otherwise, if a block is passed, it adds it as content to this custom widget
       def content(&block)
         if block_given?
-          body_root.content(&block)
+          Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::SWT::CustomWidgetExpression.new, self.class.keyword, &block)
         else
           @content
         end

data/samples/elaborate/calculator.rb

@@ -45,7 +45,7 @@ class Calculator
       
       # Setting styled_text to multi in order for alignment options to activate
       styled_text(:multi, :wrap, :border) {
-        text bind(@presenter, :result)
+        text <= [@presenter, :result]
         alignment swt(:right)
         right_margin 5
         font height: 40

data/samples/elaborate/contact_manager.rb

@@ -110,7 +110,7 @@ class ContactManager
           }
         }
 
-        table(:multi) { |table_proxy|
+        table(:editable, :multi) { |table_proxy|
           layout_data {
             horizontal_alignment :fill
             vertical_alignment :fill

data/samples/elaborate/meta_sample.rb

@@ -226,7 +226,7 @@ class MetaSampleApplication
                   row_layout(:vertical) {
                     fill true
                   }
-                  selection bind(sample_directory, :selected_sample_name)
+                  selection <=> [sample_directory, :selected_sample_name]
                   font height: 20
                 }
               }
@@ -242,7 +242,7 @@ class MetaSampleApplication
             button {
               text 'Launch'
               font height: 25
-              enabled bind(SampleDirectory, 'selected_sample.launchable')
+              enabled <= [SampleDirectory, 'selected_sample.launchable']
               
               on_widget_selected {
                 begin
@@ -255,7 +255,7 @@ class MetaSampleApplication
             button {
               text 'Reset'
               font height: 25
-              enabled bind(SampleDirectory, 'selected_sample.editable')
+              enabled <= [SampleDirectory, 'selected_sample.editable']
               
               on_widget_selected {
                 SampleDirectory.selected_sample.reset_code!
@@ -277,8 +277,8 @@ class MetaSampleApplication
           line_numbers {
             background :white
           }
-          text bind(SampleDirectory, 'selected_sample.code', read_only: true)
-          editable bind(SampleDirectory, 'selected_sample.editable')
+          text <=> [SampleDirectory, 'selected_sample.code']
+          editable <= [SampleDirectory, 'selected_sample.editable']
           left_margin 7
           right_margin 7
         }

data/samples/elaborate/tetris/view/bevel.rb

@@ -35,44 +35,44 @@ class Tetris
       
       body {
         rectangle(x, y, size, size) {
-          background bind(self, :base_color)
+          background <= [self, :base_color]
           polygon(0, 0, size, 0, size - bevel_pixel_size, bevel_pixel_size, bevel_pixel_size, bevel_pixel_size) {
-            background bind(self, :base_color) { |color_value|
+            background <= [self, :base_color, on_read: ->(color_value) {
               unless color_value.nil?
                 color = color(color_value)
                 rgb(color.red + 4*BEVEL_CONSTANT, color.green + 4*BEVEL_CONSTANT, color.blue + 4*BEVEL_CONSTANT)
               end
-            }
+            }]
           }
           polygon(size, 0, size - bevel_pixel_size, bevel_pixel_size, size - bevel_pixel_size, size - bevel_pixel_size, size, size) {
-            background bind(self, :base_color) { |color_value|
+            background <= [self, :base_color, on_read: ->(color_value) {
               unless color_value.nil?
                 color = color(color_value)
                 rgb(color.red - BEVEL_CONSTANT, color.green - BEVEL_CONSTANT, color.blue - BEVEL_CONSTANT)
               end
-            }
+            }]
           }
           polygon(size, size, 0, size, bevel_pixel_size, size - bevel_pixel_size, size - bevel_pixel_size, size - bevel_pixel_size) {
-            background bind(self, :base_color) { |color_value|
+            background <= [self, :base_color, on_read: ->(color_value) {
               unless color_value.nil?
                 color = color(color_value)
                 rgb(color.red - 2*BEVEL_CONSTANT, color.green - 2*BEVEL_CONSTANT, color.blue - 2*BEVEL_CONSTANT)
               end
-            }
+            }]
           }
           polygon(0, 0, 0, size, bevel_pixel_size, size - bevel_pixel_size, bevel_pixel_size, bevel_pixel_size) {
-            background bind(self, :base_color) { |color_value|
+            background <= [self, :base_color, on_read: ->(color_value) {
               unless color_value.nil?
                 color = color(color_value)
                 rgb(color.red - BEVEL_CONSTANT, color.green - BEVEL_CONSTANT, color.blue - BEVEL_CONSTANT)
               end
-            }
+            }]
           }
           rectangle(0, 0, size, size) {
-            foreground bind(self, :base_color) { |color_value|
+            foreground <= [self, :base_color, on_read: ->(color_value) {
               # use gray instead of white for the border
               color_value == Model::Block::COLOR_CLEAR ? :gray : color_value
-            }
+            }]
           }
         }
       }