glimmer-dsl-swt 4.24.3.1 → 4.24.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c7406f9588caef592b17f889b509db88771e545300a916f44ea1a928a89937
-  data.tar.gz: 2933dfdf3e5e1479849793cec5bbfdf3558768bb34b4c828847339c95559242a
+  metadata.gz: 89250fa7cc394da176eb7cd91a17c7ad388607c69927a7e22b6b1be62333a0b8
+  data.tar.gz: e7e09c62b782c682c0abdb8722001c8925268cfe4bab49b536eb58f3f32fb697
 SHA512:
-  metadata.gz: 6d13f0eaa866f47c449caa5ce3e3ae652025940769b8f419c0b4b66df0e1e67b3a4e3494ab539cb81d21de79ac44d81e3982f59083c9bd0453201e1231073ee0
-  data.tar.gz: 53fe039d009a4d3476bbc2a5d96f11ca3ab4fdb442b790bafd0b9bc920943bb4cc6bc475522f1f040d355da8029cd693a76179d4e247fa9e4bd59fcd2637fe80
+  metadata.gz: 136c2625e94629b690a325bdc3c8669a36c612f9f651b04faa5be3dcbcc86b57ae5345c23fcce1b10656b9dca5e8a4e96a318147907785a5bff18eac3dd4b130
+  data.tar.gz: 6d1c069b332ccd3139cf0c6377dd64b5341ccd84cc4dda3c72f5255c0eaeff0639bbfcdea35cb6b66baa84fb9ed1093143cafb4897f6ba2b2198dd494e0033c3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 4.24.3.2
+
+- Have `table` data-binding infer model attribute names from column names by convention (no need to specify `column_properties`)
+- Support `table` data-binding `column_properties` mapping of column names to model attribute names via a `Hash`
+- Support `table` data-binding alias of `column_attributes` in place of `column_properties` because the word 'attribute' is more Ruby-idiomatic than 'property' in the Ruby world
+- Handle boundary condition of font height reaching 0 on repeated zoom out of `code_text`
+- Battleship Video Tutorial in Glimmer Meta-Sample
+
 ## 4.24.3.1
 
 - `code_text` default behavior support of zoom in (CMD+= on Mac, CTRL+= on Win/Linux), zoom out (CMD+- on Mac, CTRL+- on Win/Linux), and restore original font height (CMD+0 on Mac, CTRL+0 on Win/Linux).

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.24.3.1
+# [<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.24.3.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)
@@ -21,7 +21,7 @@ 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.24.3.1 includes [SWT 4.24](https://download.eclipse.org/eclipse/downloads/drops4/R-4.24-202206070700/), which was released on June 7, 2022. 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.
+[Glimmer DSL for SWT](https://rubygems.org/gems/glimmer-dsl-swt) 4.24.3.2 includes [SWT 4.24](https://download.eclipse.org/eclipse/downloads/drops4/R-4.24-202206070700/), which was released on June 7, 2022. 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.
 
 **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. That was [originally conceived back in 2007](https://andymaleh.blogspot.com/2007/12/data-shining-in-glimmer.html).
 
@@ -338,7 +338,7 @@ jgem install glimmer-dsl-swt
 
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.24.3.1
+jgem install glimmer-dsl-swt -v 4.24.3.2
 ```
 
 `jgem` is JRuby's version of `gem` command.
@@ -366,7 +366,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.24.3.1'
+gem 'glimmer-dsl-swt', '~> 4.24.3.2'
 ```
 
 And, then run:
@@ -389,7 +389,7 @@ glimmer
 ```
 
 ```
-Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.24.3.1
+Glimmer (JRuby Desktop Development GUI Framework) - JRuby Gem: glimmer-dsl-swt v4.24.3.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.24.3.1
+4.24.3.2

data/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md

@@ -3996,13 +3996,13 @@ You may learn more about Glimmer's data-binding syntax by reading the code under
 
 The SWT Tree widget renders a multi-column data table, such as a contact listing or a sales report.
 
-To data-bind a Table, you need the main model, the collection property, and the text display attribute for each table column.
+To data-bind a Table, you need the main model and the collection property. The text for each row cell will be inferred from column names as underscored model attributes. For example, for a column named "Full Name", it is assumed by convention that the model has a `full_name` attribute.
 
-This involves using the `<=>` operator in addition to a special `column_properties` kwarg that takes an array that maps table columns to model attributes.
+Data-binding involves using the `<=` operator (one-way data-binding) or `<=>` operator (two-way data-binding), and an optional `column_attributes` kwarg (alias: `column_properties`) that takes an array that maps table columns to model attributes or a hash that maps column name strings to model attributes.
 
 It assumes you have already defined table columns via the `table_column` `table`-nested widget.
 
-Example:
+Example (automatically inferring table items' [rows'] model attributes by convention from column names):
 
 ```ruby
 shell {
@@ -4019,8 +4019,10 @@ shell {
       text "Adult"
       width 120
     }
-    items <=> [group, :people, column_properties: [:name, :age, :adult]]
+    
+    items <=> [group, :people]
     selection <=> [group, :selected_person]
+    
     on_mouse_up do |event|
       @table.edit_table_item(event.table_item, event.column_index)
     end
@@ -4028,15 +4030,71 @@ shell {
 }
 ```
 
-The code above includes two data-bindings:
-- Table `items`, which first data-binds to the model collection property (group.people), and then maps each column property (name, age, adult) for displaying each table item column.
+The code above includes two data-bindings and a listener:
+- Table `items`, which first data-binds to the model collection property (group.people), and then maps each column to a model attribute (name, age, adult) for displaying each table item column.
 - Table `selection`, which data-binds the single table item (row) selected by the user to the model attribute denoted by `<=>` (or data-binds multiple table items to a model attribute array value for a table with `:multi` SWT style)
 - The `on_mouse_up` event handler invokes `@table.edit_table_item(event.table_item, event.column_index)` to start edit mode on the clicked table item cell, and then saves or cancel depending on whether the user hits ENTER or ESC once done editing (or focus-out after either making a change or not making any changes.)
 
+Example (specifying `column_attributes` explicitly because some diverge from column names):
+
+```ruby
+shell {
+  @table = table {
+    table_column {
+      text "Full Name"
+      width 120
+    }
+    table_column {
+      text "Age in Years"
+      width 120
+    }
+    table_column {
+      text "Adult"
+      width 120
+    }
+    
+    items <=> [group, :people, column_attributes: {'Full Name' => :name, 'Age in Years' => :age}]
+    selection <=> [group, :selected_person]
+    
+    on_mouse_up do |event|
+      @table.edit_table_item(event.table_item, event.column_index)
+    end
+  }
+}
+```
+
+Example (specifying `column_attributes` explicitly because all diverge from column names):
+
+```ruby
+shell {
+  @table = table {
+    table_column {
+      text "Full Name"
+      width 120
+    }
+    table_column {
+      text "Age in Years"
+      width 120
+    }
+    table_column {
+      text "Is Adult"
+      width 120
+    }
+    
+    items <=> [group, :people, column_attributes: [:name, :age, :adult]]
+    selection <=> [group, :selected_person]
+    
+    on_mouse_up do |event|
+      @table.edit_table_item(event.table_item, event.column_index)
+    end
+  }
+}
+```
+
 Additionally, Table `items` data-binding automatically stores each row model in the [SWT `TableItem`](https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/TableItem.html) object representing it, by using the `set_data` method. This enables things like searchability.
 
-The table widget in Glimmer is represented by a subclass of `WidgetProxy` called `TableProxy`.
-TableProxy includes a `search` method that takes a block to look for a table item.
+The table widget in Glimmer is represented by a subclass of `Glimmer::SWT::WidgetProxy` called `Glimmer::SWT::TableProxy`.
+`Glimmer::SWT::TableProxy` includes a `search` method that takes a block to look for a table item.
 
 Example:
 
@@ -4055,7 +4113,7 @@ It automatically persists the change to `items` data-bound model on ENTER/FOCUS-
 
 When data-binding a `table`'s `items`, extra [`TableItem` properties](https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/TableItem.html) are data-bound automatically by convention for `background` color, `foreground` color, `font`, and `image` if corresponding properties (attributes) are available on the model.
 
-That means that if `column_properties` were `[:name, :age, :adult]`, then the following [`TableItem` properties](https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/TableItem.html) are also data-bound by convention:
+That means that if `column_attributes` were `[:name, :age, :adult]`, then the following [`TableItem` properties](https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/TableItem.html) are also data-bound by convention:
 - `background` to `:name_background, :age_background, :adult_background` model attributes
 - `foreground` to `:name_foreground, :age_foreground, :adult_foreground` model attributes
 - `font` to `:name_font, :age_font, :adult_font` model attributes
@@ -4104,7 +4162,7 @@ shell {
       text "Adult"
       width 120
     }
-    items bind(group, :people), column_properties(:name, :age, :adult)
+    items <=> [group, :people]
     selection bind(group, :selected_person)
   }
 }
@@ -4131,7 +4189,7 @@ shell {
       width 120
       editor :checkbox
     }
-    items bind(group, :people), column_properties(:name, :age, :adult)
+    items <=> [group, :people]
     selection bind(group, :selected_person)
   }
 }
@@ -4170,7 +4228,7 @@ shell {
       # assume there is a `Person#industry_options` property method on the model to provide items to the `combo`
       editor :combo, :read_only # passes :ready_only SWT style to `combo` widget
     }
-    items bind(group, :people), column_properties(:formatted_date, :industry)
+    items <=> [group, :people, column_attributes: {'Date of Birth' => :formatted_date}]
     selection bind(group, :selected_person)
   }
 }
@@ -4229,7 +4287,7 @@ Example:
       sort { |d1, d2| d1.to_date <=> d2.to_date }
     }
     additional_sort_properties :project_name, :duration_in_hours, :name
-    items bind(Task, :list), column_properties(:name, :project_name, :duration, :priority, :start_date)
+    items <=> [Task, :list, column_attributes: [:name, :project_name, :duration, :priority, :start_date]]
     # ...
   }
 # ...
@@ -4242,7 +4300,7 @@ Here is an explanation of the example above:
 - Task Start Date table column has a custom sort comparator block
 - Additional (secondary) sort properties are applied when sorting by Task, Project, or Duration in the order specified
 
-`bind(model, :property, read_only_sort: true)` could be used with items to make sorting not propagate sorting changes to model.
+`<= [model, :property, read_only_sort: true]` could be used with items to make sorting not propagate sorting changes to model.
 
 #### Tree
 

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -42,12 +42,14 @@ module Glimmer
         @table = parent
         @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
+        column_properties = @model_binding.binding_options[:column_properties] || @model_binding.binding_options[:column_attributes] || column_properties
+        if @table.is_a?(Glimmer::SWT::TableProxy)
+          @table.column_properties = column_properties
+          @column_properties = @table.column_properties # normalized column properties
         else # assume custom widget
           @table.body_root.column_properties = @column_properties
+          @column_properties = @table.body_root.column_properties # normalized column properties
         end
         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
           @table.swt_widget.data = @model_binding

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

@@ -349,7 +349,7 @@ module Glimmer
         
         def bump_font_height_down
           @original_font_height ||= font_datum.height
-          new_font_height = font_datum.height - 1
+          new_font_height = (font_datum.height - 1) == 0 ? font_datum.height : (font_datum.height - 1)
           update_font_height(new_font_height)
         end
         

data/lib/glimmer/swt/table_proxy.rb

@@ -246,7 +246,8 @@ module Glimmer
       end
       
       attr_reader :table_editor, :table_editor_widget_proxy, :sort_property, :sort_direction, :sort_block, :sort_type, :sort_by_block, :additional_sort_properties, :editor, :editable
-      attr_accessor :column_properties
+      attr_writer :column_properties
+      alias column_attributes= column_properties=
       alias editable? editable
       
       def initialize(underscored_widget_name, parent, args)
@@ -258,6 +259,19 @@ module Glimmer
         @table_editor.minimumHeight = 20
         self.editable = editable_style
       end
+      
+      def column_properties
+        if @column_properties.nil?
+          swt_widget.columns.to_a.map(&:text).map(&:underscore)
+        elsif @column_properties.is_a?(Hash)
+          @column_properties = swt_widget.columns.to_a.map(&:text).map do |column_name|
+            @column_properties[column_name] || column_name.underscore
+          end
+        else
+          @column_properties
+        end
+      end
+      alias column_attributes column_properties
 
       def items
         auto_exec do

data/samples/elaborate/contact_manager.rb

@@ -144,7 +144,7 @@ class ContactManager
             width 200
           }
           
-          items <=> [@contact_manager_presenter, :results, column_properties: [:first_name, :last_name, :email]]
+          items <=> [@contact_manager_presenter, :results]
           
           on_mouse_up do |event|
             table_proxy.edit_table_item(event.table_item, event.column_index)

data/samples/elaborate/meta_sample/tutorials.yml

@@ -29,3 +29,4 @@ Parking: kw-6icVgDR4
 Hello, Custom Widget!: aJHLo5yLDZc
 Hello, Custom Shell!: c8Eb8GWM_XQ
 Hello, Custom Shape!: H3J8ecp30Ak
+Battleship: b00OWeLZOt8

data/samples/elaborate/meta_sample.rb

@@ -41,9 +41,11 @@ class Sample
     
     def ensure_user_glimmer_directory
       unless @ensured_glimmer_directory
-        FileUtils.rm_rf(user_glimmer_directory)
-        FileUtils.cp_r(glimmer_directory, user_glimmer_directory)
-        @ensured_glimmer_directory = true
+        Thread.new do
+          FileUtils.rm_rf(user_glimmer_directory)
+          FileUtils.cp_r(glimmer_directory, user_glimmer_directory)
+          @ensured_glimmer_directory = true
+        end
       end
     end
     
@@ -123,11 +125,11 @@ class Sample
   end
     
   def file_relative_path
-    file.sub(self.class.glimmer_directory, '')
+    file.sub(Sample.glimmer_directory, '')
   end
   
   def user_file
-    File.join(self.class.user_glimmer_directory, file_relative_path)
+    File.join(Sample.user_glimmer_directory, file_relative_path)
   end
     
   def user_file_parent_directory
@@ -209,10 +211,10 @@ class SampleDirectory
       @samples.each do |sample|
         observe(sample, :selected) do |new_selected_value|
           if new_selected_value
-            self.class.all_samples.reject {|a_sample| a_sample.name == sample.name}.each do |other_sample|
+            SampleDirectory.all_samples.reject {|a_sample| a_sample.name == sample.name}.each do |other_sample|
               other_sample.selected = false
             end
-            self.class.selected_sample = sample
+            SampleDirectory.selected_sample = sample
           end
         end
       end
@@ -227,8 +229,8 @@ class SampleDirectory
   def selected_sample_name=(selected_name)
     @selected_sample_name = selected_name
     unless selected_name.nil?
-      (self.class.sample_directories - [self]).each { |sample_dir| sample_dir.selected_sample_name = nil }
-      self.class.selected_sample = samples.detect { |sample| sample.name == @selected_sample_name }
+      (SampleDirectory.sample_directories - [self]).each { |sample_dir| sample_dir.selected_sample_name = nil }
+      SampleDirectory.selected_sample = samples.detect { |sample| sample.name == @selected_sample_name }
     end
   end
   

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

@@ -66,7 +66,7 @@ class Tetris
               text 'Level'
             }
             
-            items <=> [game, :high_scores, read_only_sort: true, column_properties: [:name, :score, :lines, :level]]
+            items <=> [game, :high_scores, read_only_sort: true]
           }
           composite {
             row_layout :horizontal

data/samples/hello/hello_custom_shell.rb

@@ -157,19 +157,19 @@ class HelloCustomShell
         layout_data :fill, :fill, true, true
       
         table_column {
-          text 'Date:'
+          text 'Date'
           width 180
         }
         table_column {
-          text 'Subject:'
+          text 'Subject'
           width 180
         }
         table_column {
-          text 'From:'
+          text 'From'
           width 360
         }
         
-        items <=> [@email_system, :emails, column_properties: [:date, :subject, :from]]
+        items <=> [@email_system, :emails]
         selection <=> [@email_system, :selected_email]
         
         on_mouse_up do |event|

data/samples/hello/hello_table.rb

@@ -302,15 +302,16 @@ class HelloTable
         }
         
         # Data-bind table items (rows) to a model collection (BaseballGame.schedule),
-        # mapping columns in declaration order to row model properties (attributes)
-        # By convention, every column property can be accompanied by extra properties
-        # with the following suffixes: `_background`, `_foreground`, `_font`, and `_image`
-        # For example, for `game_date`, model could also implement these related properties:
+        # automatically inferring model attributes from column names by convention
+        # (e.g. 'Home Team' column assumes a `home_team` attribute on models)
+        #
+        # By convention, every inferred model attribute can be accompanied by extra
+        # model attributes to set extra table properties with the following suffixes:
+        # `_background`, `_foreground`, `_font`, and `_image`
+        #
+        # For example, for :game_date, model could also implement these related properties:
         # `game_date_background`, `game_date_foreground`, `game_date_font`, `game_date_image`
-        # That is done in order to let the table widget set extra properties if needed.
-        items <=> [BaseballGame, :schedule,
-                    column_properties: [:game_date, :game_time, :ballpark, :home_team, :away_team, :promotion]
-                  ]
+        items <=> [BaseballGame, :schedule]
         
         # Data-bind table selection
         selection <=> [BaseballGame, :selected_game]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-swt
 version: !ruby/object:Gem::Version
-  version: 4.24.3.1
+  version: 4.24.3.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-28 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement