RubyGems - glimmer-dsl-swt - Versions diffs - 4.17.2.2 → 4.17.4.1 - Mend

glimmer-dsl-swt 4.17.2.2 → 4.17.4.1

Files changed (23) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +50 -0
data/README.md +398 -523
data/VERSION +1 -1
data/glimmer-dsl-swt.gemspec +9 -6
data/lib/ext/glimmer/config.rb +1 -0
data/lib/glimmer-dsl-swt.rb +1 -0
data/lib/glimmer/data_binding/table_items_binding.rb +1 -0
data/lib/glimmer/dsl/swt/custom_widget_expression.rb +1 -0
data/lib/glimmer/dsl/swt/widget_expression.rb +1 -0
data/lib/glimmer/rake_task.rb +38 -21
data/lib/glimmer/rake_task/package.rb +21 -10
data/lib/glimmer/rake_task/scaffold.rb +146 -42
data/lib/glimmer/swt/custom/code_text.rb +95 -0
data/lib/glimmer/swt/image_proxy.rb +34 -11
data/lib/glimmer/swt/message_box_proxy.rb +1 -1
data/lib/glimmer/swt/sash_form_proxy.rb +53 -0
data/lib/glimmer/swt/style_constantizable.rb +2 -1
data/lib/glimmer/swt/widget_proxy.rb +99 -35
data/samples/elaborate/meta_sample.rb +166 -0
data/samples/hello/hello_sash_form.rb +137 -0
metadata +11 -8
data/lib/glimmer/rake_task/sample.rb +0 -115

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7523b15b5a850c249c3aff9ad499861ee10ecd051de1084221fbbe456237330
-  data.tar.gz: 5ac2fcb76137fe377268c8f38fd09f37fe94193351629213a30d1cc8b4b4707b
+  metadata.gz: 6cddf113bb01ca3a0023665a0005d6ae1b78745ee877178c19b8e55c53ff31ce
+  data.tar.gz: 147ec77329bcda0e0ff86b6a0443a4cdcc9b63f87b2cf29ccae2bc05bb5dd2db
 SHA512:
-  metadata.gz: ebf5035466675f7cb5b3151950c7d244a6deda09c0e0a0a7b516ca6a67a673f371377f706ec8377db62c0e1eb5a983789ac1e4e3627a660ba88322596af72388
-  data.tar.gz: 14a95141c001e279b305cee7ed90295bc620e1bb08fa897f5e72b90dc283d50abc242b7c71896d65c6c981de6785ab69f2d94c927c5fdc5320e793541f97d1fb
+  metadata.gz: 9d4b03838352129fb30d8ee1e5652bc0e41f9524613e2cdb03ec11acf3e5552804472c09aa33efffeef02279b6f92f7cad1b465046bb74e9f5d1a24087251dd3
+  data.tar.gz: 5b8c69a4ab87b47b1e024b764329e946da803949243f841bf62970c19153740298bc46628eec89da516958d4df5584a1120342ef4d515fbe00656961fea198be

data/CHANGELOG.md CHANGED

@@ -1,5 +1,55 @@
 # Change Log
+### 4.17.4.1
+- Optimize code_text line style listener algorithm or avoid setting code_text style via listener for performance reasons
+- Optimize code_text syntax highlighting by not lexing except when content changes (e.g. during scrolling, do not lex)
+### 4.17.4.0
+- Glimmer sample app to launch samples (sample of samples meta-sample)
+- Syntax Color Highlighting in meta-sample
+- Make sash_form weights accept splat array elements (not wrapped in [])
+- Make sash_form weights not get set till the closing of the sash_form (to allow putting it above content instead of below as originally required by SWT)
+- Replace dependency on tty-markdown gem with dependency on rouge gem instead
+- Remove rake tasks `sample:list`, `sample:code` and `sample:run`
+- Add rake task `samples` to point to the new Glimmer Meta-Sample
+- Have meta-sample load samples from gems
+### 4.17.3.0
+- `glimmer scaffold:desktopify[appname,website]` Mac
+- `glimmer scaffold:desktopify[appname,website]` Windows
+- `glimmer scaffold:desktopify[appname,website]` Linux (have scaffolding include the glimmer-cw-browser-chromium gem in scaffolded app on Linux)
+- Remove the native packaging from Linux scaffolding since it is not officially supported
+- Add gem packaging as part of scaffolding on Linux
+- Launch the app at the end of scaffolding in Linux
+- Provide a `glimmer package:gem` task
+- Add support for scaffolding "app/scaffolded_app/launch" and "lib/namespace/custom_shell/launch" to enable launching SWT apps in Glimmer DSL for Opal without changing a line of code
+- Add a binary executable shell in "app" mode (just like "custom shell gem" mode)
+- Have glimmer packaging check the Java version and give a warning if an unsupported version is used.
+### 4.17.2.4
+- New `glimmer run` glimmer command task.
+- Add built in support for handling jar file paths like that in ImageProxy code processing "uri:classloader" path
+- Document that gif background_image only works without on_top and no_trim styles in Windows
+- Give a good error message when Git is not properly setup for Glimmer Scaffolding
+- Give an error message when attempting to scaffold over an already scaffolded directory
+- Fix issue on Windows regarding use of the new EXPERIMENTAL Animated gif support in the `composite#background_image` property
+- Fix SWTProxy.deconstruct method
+### 4.17.2.3
+- Maintain image file path upon scaling an ImageProxy
+- Add a glimmer rake task that wraps the juwelier rake gemspec:generate task
+- Accept `ImageProxy` as arg for `image` and `background_image` property methods
+- (EXPERIMENTAL) Animate gif images when set as a `background_image` on a `composite`
+- Fix issue with table redraw after data-binding changes leaving old removed table items visible (even if user cannot interact with anymore)
+- Fix issue with running package rake task from `glimmer` command TUI
 ### 4.17.2.2
 - Small updates/refactorings in samples

data/README.md CHANGED

@@ -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.17.2.2
+# [<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.17.4.1
 ## JRuby Desktop Development GUI Library
 [![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)
@@ -10,7 +10,7 @@
 (The Original Glimmer Library Since 2007. Beware of Imitators!)
-[**Glimmer**](https://rubygems.org/gems/glimmer) is a native-GUI cross-platform desktop development library written in [JRuby](https://www.jruby.org/), an OS-threaded faster version of [Ruby](https://www.ruby-lang.org/en/). [Glimmer](https://rubygems.org/gems/glimmer)'s main innovation is a declarative [Ruby DSL](#glimmer-dsl-syntax) that enables productive and efficient authoring of desktop application user-interfaces while relying on the robust [Eclipse SWT library](https://www.eclipse.org/swt/). [Glimmer](https://rubygems.org/gems/glimmer) additionally innovates by having built-in [data-binding](#data-binding) support, which greatly facilitates synchronizing the GUI with domain models, thus achieving true decoupling of object oriented components and enabling developers to solve business problems (test-first) without worrying about GUI concerns. To get started quickly, [Glimmer](https://rubygems.org/gems/glimmer) offers [scaffolding](#scaffolding) options for [Apps](#in-production), [Gems](#custom-shell-gem), and [Custom Widgets](#custom-widgets). [Glimmer](https://rubygems.org/gems/glimmer) also includes native-executable [packaging](#packaging--distribution) support, sorely lacking in other libraries, thus enabling the delivery of desktop apps written in [Ruby](https://www.ruby-lang.org/en/) as truly native DMG/PKG/APP files on the [Mac](https://www.apple.com/ca/macos) + [App Store](https://developer.apple.com/macos/distribution/), MSI/EXE files on [Windows](https://www.microsoft.com/en-ca/windows), and [Gem Packaged Shell Scripts](#custom-shell-gem) on [Linux](https://www.linux.org/).
+[**Glimmer**](https://github.com/AndyObtiva/glimmer) is a native-GUI cross-platform desktop development library written in [JRuby](https://www.jruby.org/), an OS-threaded faster version of [Ruby](https://www.ruby-lang.org/en/). [Glimmer](https://rubygems.org/gems/glimmer)'s main innovation is a declarative [Ruby DSL](#glimmer-dsl-syntax) that enables productive and efficient authoring of desktop application user-interfaces while relying on the robust [Eclipse SWT library](https://www.eclipse.org/swt/). [Glimmer](https://rubygems.org/gems/glimmer) additionally innovates by having built-in [data-binding](#data-binding) support, which greatly facilitates synchronizing the GUI with domain models, thus achieving true decoupling of object oriented components and enabling developers to solve business problems (test-first) without worrying about GUI concerns. To get started quickly, [Glimmer](https://rubygems.org/gems/glimmer) offers [scaffolding](#scaffolding) options for [Apps](#in-production), [Gems](#custom-shell-gem), and [Custom Widgets](#custom-widgets). [Glimmer](https://rubygems.org/gems/glimmer) also includes native-executable [packaging](#packaging--distribution) support, sorely lacking in other libraries, thus enabling the delivery of desktop apps written in [Ruby](https://www.ruby-lang.org/en/) as truly native DMG/PKG/APP files on the [Mac](https://www.apple.com/ca/macos) + [App Store](https://developer.apple.com/macos/distribution/), MSI/EXE files on [Windows](https://www.microsoft.com/en-ca/windows), and [Gem Packaged Shell Scripts](#custom-shell-gem) on [Linux](https://www.linux.org/).
 [Glimmer receives two updates per month](https://rubygems.org/gems/glimmer-dsl-swt/versions). You can trust [Glimmer](https://rubygems.org/gems/glimmer) with your Ruby desktop GUI development needs. Please make [Glimmer](https://rubygems.org/gems/glimmer) even better by providing feedback and [contributing](#contributing) when possible.
@@ -40,9 +40,10 @@ shell {
 }.open
 ```
-Run:
+Run via `glimmer samples` or directly:
 ```
-glimmer sample:run[hello_world]
+glimmer samples/hello/hello_world.rb
 ```
 Glimmer app:
@@ -85,10 +86,10 @@ Glimmer code (from [samples/elaborate/tic_tac_toe.rb](https://github.com/AndyObt
 # ...
 ```
-Run:
+Run via `glimmer samples` or directly:
 ```
-glimmer sample:run[tic_tac_toe]
+glimmer samples/elaborate/tic_tac_toe.rb
 ```
 Glimmer app:
@@ -210,10 +211,10 @@ Glimmer code (from [samples/elaborate/contact_manager.rb](https://github.com/And
 # ...
 ```
-Run:
+Run via `glimmer samples` or directly:
 ```
-glimmer sample:run[contact_manager]
+glimmer samples/elaborate/contact_manager.rb
 ```
 Glimmer App:
@@ -237,6 +238,7 @@ Glimmer App:
     - [Hello, World!](#hello-world)
     - [Tic Tac Toe](#tic-tac-toe)
     - [Contact Manager](#contact-manager)
+    - [Desktop Apps Built with Glimmer DSL for SWT](#desktop-apps-built-with-glimmer-dsl-for-swt)
   - [Table of contents](#table-of-contents)
   - [Background](#background)
   - [Platform Support](#platform-support)
@@ -247,12 +249,10 @@ Glimmer App:
   - [Glimmer Command](#glimmer-command)
     - [Basic Usage](#basic-usage)
     - [Advanced Usage](#advanced-usage)
-    - [Sample List/Run/Code](#sample-listruncode)
-      - [Sample List](#sample-list)
-      - [Sample Run](#sample-run)
-      - [Sample Code](#sample-code)
+    - [Samples](#samples)
     - [Scaffolding](#scaffolding)
       - [App](#app)
+      - [Desktopify](#desktopify)
       - [Custom Shell](#custom-shell)
       - [Custom Widget](#custom-widget)
       - [Custom Shell Gem](#custom-shell-gem)
@@ -268,9 +268,10 @@ Glimmer App:
   - [Glimmer GUI DSL Syntax](#glimmer-gui-dsl-syntax)
     - [DSL Auto-Expansion](#dsl-auto-expansion)
     - [Widgets](#widgets)
-      - [Display](#display)
       - [SWT Proxies](#swt-proxies)
       - [Dialog](#dialog)
+      - [Display](#display)
+      - [Multi-Threading](#multi-threading)
       - [Menus](#menus)
       - [ScrolledComposite](#scrolledcomposite)
     - [Widget Styles](#widget-styles)
@@ -280,6 +281,7 @@ Glimmer App:
     - [Widget Properties](#widget-properties)
       - [Color](#color)
       - [Font](#font)
+    - [Image](#image)
     - [Cursor](#cursor)
     - [Layouts](#layouts)
     - [Layout Data](#layout-data)
@@ -294,10 +296,10 @@ Glimmer App:
       - [Observing Models](#observing-models)
     - [Custom Widgets](#custom-widgets)
       - [Simple Example](#simple-example)
-      - [Lifecycle Hook Example](#lifecycle-hook-example)
+      - [Custom Widget Lifecycle Hooks](#custom-widget-lifecycle-hooks)
+      - [Lifecycle Hooks Example](#lifecycle-hooks-example)
       - [Custom Widget API](#custom-widget-api)
       - [Content/Options Example](#contentoptions-example)
-      - [Custom Widget Lifecycle Hooks](#custom-widget-lifecycle-hooks)
       - [Gotcha](#gotcha)
       - [Final Notes](#final-notes)
     - [Custom Shells](#custom-shells)
@@ -306,7 +308,9 @@ Glimmer App:
       - [Multi-DSL Support](#multi-dsl-support)
       - [Application Menu Items (About/Preferences)](#application-menu-items-aboutpreferences)
       - [App Name and Version](#app-name-and-version)
+      - [Code Text Widget](#code-text-widget)
       - [Video Widget](#video-widget)
+      - [Sash Form Widget](#sash-form-widget)
       - [Browser Widget](#browser-widget)
   - [Glimmer Configuration](#glimmer-configuration)
     - [logger](#logger)
@@ -335,6 +339,7 @@ Glimmer App:
       - [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu)
       - [Hello, Custom Widget!](#hello-custom-widget)
       - [Hello, Custom Shell!](#hello-custom-shell)
+      - [Hello, Sash Form!](#hello-sash-form)
     - [Elaborate Samples](#elaborate-samples)
       - [User Profile](#user-profile)
       - [Login](#login)
@@ -370,7 +375,7 @@ Glimmer App:
   - [Contributors](#contributors)
   - [Hire Me](#hire-me)
   - [License](#license)
 ## Background
 Ruby is a dynamically-typed object-oriented language, which provides great productivity gains due to its powerful expressive syntax and dynamic nature. While it is proven by the Ruby on Rails framework for web development, it currently lacks a robust platform-independent framework for building desktop applications. Given that Java libraries can now be utilized in Ruby code through JRuby, Eclipse technologies, such as SWT, JFace, and RCP can help fill the gap of desktop application development with Ruby.
@@ -428,7 +433,7 @@ jgem install glimmer-dsl-swt
 Or this command if you want a specific version:
 ```
-jgem install glimmer-dsl-swt -v 4.17.2.2
+jgem install glimmer-dsl-swt -v 4.17.4.1
 ```
 Note: 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.
@@ -439,7 +444,7 @@ Otherwise, you may also run `jruby -S gem install ...`
 If you are new to Glimmer and would like to continue learning the basics, you may continue to the [Glimmer Command](https://github.com/AndyObtiva/glimmer#glimmer-command) section.
-Otherwise, if you are ready to build a Glimmer app on the Mac, you can jump to the [Glimmer Scaffolding](https://github.com/AndyObtiva/glimmer#scaffolding) section next.
+Otherwise, if you are ready to build a Glimmer app, you can jump to the [Glimmer Scaffolding](https://github.com/AndyObtiva/glimmer#scaffolding) section next.
 Note: if you're using activerecord or activesupport, keep in mind that Glimmer unhooks ActiveSupport::Dependencies as it does not rely on it.
@@ -487,17 +492,18 @@ glimmer application.rb
 Runs a Glimmer application using JRuby, automatically preloading
 the glimmer ruby gem and SWT jar dependency.
-Example:
+Run Glimmer samples with:
 ```
-glimmer sample:run[hello_world]
+glimmer samples
 ```
-This runs the Glimmer "Hello, World!" sample.
+This brings up the [Glimmer Meta-Sample (The Sample of Samples)](#samples)
-If you cloned this project locally, you may run `bin/glimmer` instead.
+If you cloned this project locally instead of installing the gem, run `bin/glimmer` instead.
 Example:
 ```
-bin/glimmer sample:run[hello_world]
+bin/glimmer samples
 ```
 ### Advanced Usage
@@ -505,7 +511,7 @@ bin/glimmer sample:run[hello_world]
 Below are the full usage instructions that come up when running `glimmer` without args.
 ```
-Glimmer (Ruby Desktop Development GUI Library) - JRuby Gem: glimmer-dsl-swt v4.17.2.2
+Glimmer (Ruby Desktop Development GUI Library) - JRuby Gem: glimmer-dsl-swt v4.17.4.1
 Usage: glimmer [--bundler] [--pd] [--quiet] [--debug] [--log-level=VALUE] [[ENV_VAR=VALUE]...] [[-jruby-option]...] (application.rb or task[task_args]) [[application2.rb]...]
@@ -534,12 +540,12 @@ Select a Glimmer task to run: (Press ↑/↓ arrow to move, Enter to select and
   glimmer package[type]                                      # Package app for distribution (generating config, jar, and native files) (type is optional)
   glimmer package:clean                                      # Clean by removing "dist" and "packages" directories
   glimmer package:config                                     # Generate JAR config file
+  glimmer package:gemspec                                    # Generate gemspec
   glimmer package:jar                                        # Generate JAR file
   glimmer package:lock_jars                                  # Lock JARs
   glimmer package:native[type]                               # Generate Native files
-  glimmer sample:code[name]                                  # Outputs code for a Glimmer internal sample [included in gem] (name is required)
-  glimmer sample:list[query]                                 # Lists Glimmer internal samples [included in gem]. Filters by query if specified (query is optional)
-  glimmer sample:run[name]                                   # Runs a Glimmer internal sample [included in gem]. If no name is supplied, it runs all samples
+  glimmer run[app_path]                                      # Runs Glimmer app or custom shell gem in the current directory, unless app_path is specified, then runs it instead (app_path is optional)
+  glimmer samples                                            # Brings up the Glimmer Meta-Sample app to allow browsing, running, and viewing code of Glimmer samples
   glimmer scaffold[app_name]                                 # Scaffold Glimmer application directory structure to build a new app
   glimmer scaffold:customshell[name,namespace]               # Scaffold Glimmer::UI::CustomShell subclass (full window view) under app/views (namespace is optional) [alt: scaffold:cs]
   glimmer scaffold:customwidget[name,namespace]              # Scaffold Glimmer::UI::CustomWidget subclass (part of a view) under app/views (namespace is optional) [alt: scaffold:cw]
@@ -561,338 +567,22 @@ glimmer samples/hello/hello_world.rb samples/hello/hello_tab.rb
 Launches samples/hello/hello_world.rb and samples/hello_tab.rb at the same time, each in a separate JRuby thread.
-### Sample List/Run/Code
-#### Sample List
+### Glimmer Samples
 You can list available Glimmer samples by running:
 ```
-glimmer sample:list
-```
-This should output the following (providing the name of each sample, description, and command to run the sample and view its code):
-```
-$ glimmer sample:list
-  Glimmer Hello Samples:
-             Name                       Description                                 Run
-  hello_browser                 Hello Browser                 glimmer sample:run[hello_browser]
-  hello_combo                   Hello Combo                   glimmer sample:run[hello_combo]
-  hello_computed                Hello Computed                glimmer sample:run[hello_computed]
-  hello_drag_and_drop           Hello Drag And Drop           glimmer sample:run[hello_drag_and_drop]
-  hello_list_multi_selection    Hello List Multi Selection    glimmer sample:run[hello_list_multi_selection]
-  hello_list_single_selection   Hello List Single Selection   glimmer sample:run[hello_list_single_selection]
-  hello_menu_bar                Hello Menu Bar                glimmer sample:run[hello_menu_bar]
-  hello_message_box             Hello Message Box             glimmer sample:run[hello_message_box]
-  hello_pop_up_context_menu     Hello Pop Up Context Menu     glimmer sample:run[hello_pop_up_context_menu]
-  hello_tab                     Hello Tab                     glimmer sample:run[hello_tab]
-  hello_world                   Hello World                   glimmer sample:run[hello_world]
-  Glimmer Elaborate Samples:
-       Name           Description                     Run
-  contact_manager   Contact Manager   glimmer sample:run[contact_manager]
-  login             Login             glimmer sample:run[login]
-  tic_tac_toe       Tic Tac Toe       glimmer sample:run[tic_tac_toe]
-  user_profile      User Profile      glimmer sample:run[user_profile]
-```
-#### Sample Run
-A sample may be run via `glimmer sample:run[name]`. This also outputs the sample code so that you could take a look at it and compare to the GUI that launches.
-If the sample name is left empty (e.g. `glimmer sample:run`), then all samples are run.
-Example:
-```
-glimmer sample:run[hello_tab]
-```
-This will run the hello_tab sample and output its code:
-```
-$ glimmer sample:run[hello_tab]
-# /Users/User/.rvm/gems/jruby-9.2.13.0@glimmerapp/gems/glimmer-dsl-swt-4.17.2.2/samples/hello/hello_tab.rb
-class HelloTab
-  include Glimmer
-  def launch
-    shell {
-      text "Hello, Tab!"
-      tab_folder {
-        tab_item {
-          text "English"
-          label {
-            text "Hello, World!"
-          }
-        }
-        tab_item {
-          text "French"
-          label {
-            text "Bonjour, Univers!"
-          }
-        }
-      }
-    }.open
-  end
-end
-HelloTab.new.launch
-# # #
-```
-![Hello Tab English](images/glimmer-hello-tab-english.png)
-#### Sample Code
-You may output any sample code via this command: `glimmer sample:code[name]`
-This is very similar to the sample run command, except the name is required.
-It will not only output the main sample file, but any required supporting files as well.
-Example:
+glimmer samples
 ```
-$ glimmer sample:code[tic_tac_toe]
-# /Users/User/.rvm/gems/jruby-9.2.13.0@glimmerapp/gems/glimmer-dsl-swt-4.17.2.2/samples/elaborate/tic_tac_toe.rb
-require_relative "tic_tac_toe/board"
-class TicTacToe
-  include Glimmer
-  def initialize
-    @tic_tac_toe_board = Board.new
-    @shell = shell {
-      text "Tic-Tac-Toe"
-      minimum_size 150, 178
-      composite {
-        grid_layout 3, true
-        (1..3).each { |row|
-          (1..3).each { |column|
-            button {
-              layout_data :fill, :fill, true, true
-              text        bind(@tic_tac_toe_board[row, column], :sign)
-              enabled     bind(@tic_tac_toe_board[row, column], :empty)
-              font        style: :bold, height: 20
-              on_widget_selected {
-                @tic_tac_toe_board.mark(row, column)
-              }
-            }
-          }
-        }
-      }
-    }
-    observe(@tic_tac_toe_board, :game_status) { |game_status|
-      display_win_message if game_status == Board::WIN
-      display_draw_message if game_status == Board::DRAW
-    }
-  end
-  def display_win_message
-    display_game_over_message("Player #{@tic_tac_toe_board.winning_sign} has won!")
-  end
+This brings up the [Glimmer Meta-Sample (The Sample of Samples)](#samples):
-  def display_draw_message
-    display_game_over_message("Draw!")
-  end
-  def display_game_over_message(message_text)
-    message_box(@shell) {
-      text 'Game Over'
-      message message_text
-    }.open
-    @tic_tac_toe_board.reset
-  end
-  def open
-    @shell.open
-  end
-end
-TicTacToe.new.open
-# # #
-# /Users/User/.rvm/gems/jruby-9.2.13.0@glimmerapp/gems/glimmer-dsl-swt-4.17.2.2/samples/elaborate/tic_tac_toe/cell.rb
-class TicTacToe
-  class Cell
-    EMPTY = ""
-    attr_accessor :sign, :empty
-    def initialize
-      reset
-    end
-    def mark(sign)
-      self.sign = sign
-    end
-    def reset
-      self.sign = EMPTY
-    end
-    def sign=(sign_symbol)
-      @sign = sign_symbol
-      self.empty = sign == EMPTY
-    end
-    def marked
-      !empty
-    end
-  end
-end
-# # #
-# /Users/User/.rvm/gems/jruby-9.2.13.0@glimmerapp/gems/glimmer-dsl-swt-4.17.2.2/samples/elaborate/tic_tac_toe/board.rb
-require_relative 'cell'
-class TicTacToe
-  class Board
-    DRAW = :draw
-    IN_PROGRESS = :in_progress
-    WIN = :win
-    attr :winning_sign
-    attr_accessor :game_status
-    def initialize
-      @sign_state_machine = {nil => "X", "X" => "O", "O" => "X"}
-      build_grid
-      @winning_sign = Cell::EMPTY
-      @game_status = IN_PROGRESS
-    end
-    #row and column numbers are 1-based
-    def mark(row, column)
-      self[row, column].mark(current_sign)
-      game_over? #updates winning sign
-    end
-    def current_sign
-      @current_sign = @sign_state_machine[@current_sign]
-    end
-    def [](row, column)
-      @grid[row-1][column-1]
-    end
-    def game_over?
-       win? or draw?
-    end
-    def win?
-      win = (row_win? or column_win? or diagonal_win?)
-      self.game_status=WIN if win
-      win
-    end
-    def reset
-      (1..3).each do |row|
-        (1..3).each do |column|
-          self[row, column].reset
-        end
-      end
-      @winning_sign = Cell::EMPTY
-      @current_sign = nil
-      self.game_status=IN_PROGRESS
-    end
-    private
-    def build_grid
-      @grid = []
-      3.times do |row_index| #0-based
-        @grid << []
-        3.times { @grid[row_index] << Cell.new }
-      end
-    end
-    def row_win?
-      (1..3).each do |row|
-        if row_has_same_sign(row)
-          @winning_sign = self[row, 1].sign
-          return true
-        end
-      end
-      false
-    end
-    def column_win?
-      (1..3).each do |column|
-        if column_has_same_sign(column)
-          @winning_sign = self[1, column].sign
-          return true
-        end
-      end
-      false
-    end
-    #needs refactoring if we ever decide to make the board size dynamic
-    def diagonal_win?
-      if (self[1, 1].sign == self[2, 2].sign) and (self[2, 2].sign == self[3, 3].sign) and self[1, 1].marked
-        @winning_sign = self[1, 1].sign
-        return true
-      end
-      if (self[3, 1].sign == self[2, 2].sign) and (self[2, 2].sign == self[1, 3].sign) and self[3, 1].marked
-        @winning_sign = self[3, 1].sign
-        return true
-      end
-      false
-    end
-    def draw?
-      @board_full = true
-      3.times do |x|
-        3.times do |y|
-          @board_full = false if self[x, y].empty
-        end
-      end
-      self.game_status = DRAW if @board_full
-      @board_full
-    end
-    def row_has_same_sign(number)
-      row_sign = self[number, 1].sign
-      [2, 3].each do |column|
-        return false unless row_sign == (self[number, column].sign)
-      end
-      true if self[number, 1].marked
-    end
-    def column_has_same_sign(number)
-      column_sign = self[1, number].sign
-      [2, 3].each do |row|
-        return false unless column_sign == (self[row, number].sign)
-      end
-      true if self[1, number].marked
-    end
-  end
-end
-# # #
-```
+![Glimmer Meta-Sample](images/glimmer-meta-sample.png)
 ### Scaffolding
 Glimmer borrows from Rails the idea of Scaffolding, that is generating a structure for your app files that
-helps you get started just like true buildinThis g scaffolding helps construction workers, civil engineers, and architects.
+helps you get started just like true building scaffolding helps construction workers, civil engineers, and architects.
 Glimmer scaffolding goes beyond just scaffolding the app files that Rails does. It also packages it and launches it,
 getting you to a running and delivered state of an advanced "Hello, World!" Glimmer application right off the bat.
@@ -908,7 +598,7 @@ letting Glimmer scaffolding take care of initial app file structure concerns, su
 - Icon (under `package/{platform}/{App Name}.{icon_extension}` for `macosx` .icns, `windows` .ico, and `linux` .png)
 - Bin file for starting application (`bin/{app_name}.rb`)
-NOTE: Scaffolding supports Mac and Windows packaging at the moment.
+You need to have your Git `user.name` and `github.user` configured before scaffolding since Glimmer uses Juwelier, which relies on them in creating a Git repo for your Glimmer app.
 #### App
@@ -920,7 +610,7 @@ To scaffold a Glimmer app from scratch, run the following command:
 glimmer scaffold[AppName]
 ```
-This will generate an advanced "Hello, World!" app, package it as a Mac native file (DMG/PKG/APP), and launch it all in one fell swoop.
+This will generate an advanced "Hello, World!" app, package it as a Mac DMG/PKG/APP, Windows APP, or Linux GEM, and launch it all in one fell swoop.
 Suppose you run:
@@ -978,12 +668,119 @@ And, here is the Windows version of the boilerplate Preferences dialog.
 ![Glimmer Scaffold App Windows Preferences](images/glimmer-scaffolding-app-windows-preferences.png)
-In order to run the app after making changes, you must run the `glimmer` command and pass it the generated script under the `bin` directory as an argument:
+In order to run the app after making changes, you must run the `glimmer run`. It automatically detects the generated run script under the `bin` directory and uses it as an argument.
+```
+glimmer run
+```
+Alternatively, to mantually run the app, you may type:
+```
+glimmer run[bin/greeter]
+```
+or:
 ```
 glimmer bin/greeter
 ```
+#### Desktopify
+This scaffolding mode enables you to desktopify a web app. Glimmer Scaffolding basically wraps the website with a [Browser Widget](#browser-widget).
+The desktopify app is similar to the standard scaffolded app. It can be extended and the [browser may even be instrumented](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/browser/Browser.html).
+The app even remembers your cookies if you log into the website, close the app, and reopen again.
+Note that on Linux, the default SWT browser, which runs on webkit, does not support HTML5 Video out of the box. If you need video support, open `Gemfile` after scaffolding and enable the line that has the `glimmer-cw-browser-chromium` gem then replace the `browser` in "app/views/snowboard_utah/app_view.rb" with `browser(:chromium)`
+Before you start, make sure you are in a JRuby environment with Glimmer gem installed as per "Direct Install" pre-requisites.
+To scaffold a Glimmer desktopify app from scratch, run the following command:
+```
+glimmer scaffold:desktopify[app_name,website]
+```
+This will generate a Glimmer app, package it as a Mac DMG/PKG/APP, Windows APP, or Linux GEM, and launch it all in one fell swoop.
+Suppose you run:
+```
+glimmer scaffold:desktopify[snowboard_utah,https://www.brightonresort.com]
+```
+You should see output like the following:
+```
+$ glimmer scaffold:desktopify[snowboard_utah,https://www.brightonresort.com]
+Fetching kamelcase-0.0.2.gem
+Fetching github_api-0.19.0.gem
+Fetching highline-2.0.3.gem
+Fetching juwelier-2.4.9.gem
+Fetching hashie-3.6.0.gem
+Fetching nokogiri-1.10.10-java.gem
+Fetching semver2-3.4.2.gem
+Successfully installed semver2-3.4.2
+Successfully installed kamelcase-0.0.2
+Successfully installed highline-2.0.3
+Successfully installed hashie-3.6.0
+Successfully installed github_api-0.19.0
+Successfully installed nokogiri-1.10.10-java
+Successfully installed juwelier-2.4.9
+7 gems installed
+	create	.gitignore
+	create	Rakefile
+	create	Gemfile
+	create	LICENSE.txt
+	create	README.markdown
+	create	.document
+	create	lib
+	create	lib/snowboard_utah.rb
+	create	.rspec
+Juwelier has prepared your gem in ./snowboard_utah
+Created snowboard_utah/.gitignore
+Created snowboard_utah/.ruby-version
+Created snowboard_utah/.ruby-gemset
+Created snowboard_utah/VERSION
+Created snowboard_utah/LICENSE.txt
+Created snowboard_utah/Gemfile
+Created snowboard_utah/Rakefile
+Created snowboard_utah/app/snowboard_utah.rb
+Created snowboard_utah/app/views/snowboard_utah/app_view.rb
+Created snowboard_utah/package/windows/Snowboard Utah.ico
+Created snowboard_utah/package/macosx/Snowboard Utah.icns
+Created snowboard_utah/package/linux/Snowboard Utah.png
+Created snowboard_utah/bin/snowboard_utah
+...
+```
+Eventually, it will launch a desktopified version of "https://www.brightonresort.com" having the title of ("Snowboard Utah").
+Desktopified App on Mac
+![Glimmer Scaffold App](images/glimmer-scaffolding-desktopify.png)
+It also comes with a boilerplate About dialog.
+![Glimmer Scaffold App About](images/glimmer-scaffolding-desktopify-about.png)
+Desktopified App on Windows
+![Glimmer Scaffold App](images/glimmer-scaffolding-desktopify-windows.png)
+Desktopified App on Linux
+![Glimmer Scaffold App](images/glimmer-scaffolding-desktopify-linux.png)
+In order to run the app after making changes, you must run the `glimmer run`. It automatically detects the generated run script under the `bin` directory and uses it as an argument.
+```
+glimmer run
+```
 #### Custom Shell
 To scaffold a Glimmer custom shell (full window view) for an existing Glimmer app, run the following command:
@@ -1040,7 +837,7 @@ Only official Glimmer gems created by the Glimmer project committers will have n
 Since custom shell gems are both an app and a gem, they provide two ways to run:
 - Run the `glimmer` command and pass it the generated script under the `bin` directory that matches the gem name (e.g. run `glimmer bin/glimmer-cs-calculator`)
-- Run the executable binary file that ships with the gem directly (without `glimmer`). It intentionally has a shorter name for convenience since it is meant to be used on the command line (not in a package), so you can leave out the `glimmer-cs-` prefix (e.g. run `bin/calculator` directly)
+- Run the executable shell script that ships with the gem directly (does not need the `glimmer` command). It intentionally has a shorter name for convenience since it is meant to be used on the command line (not in a package), so you can leave out the `glimmer-cs-` prefix (e.g. run `bin/calculator` directly). This is also used as the main way of running custom shell gems on Linux.
 Examples:
@@ -1190,9 +987,9 @@ Output:
   Name         Gem          Version    Author          Description
   Css    glimmer-dsl-css    1.1.0     AndyMaleh    Glimmer DSL for CSS
-  Opal   glimmer-dsl-opal   0.3.0     AndyMaleh    Glimmer DSL for Opal
-  Swt    glimmer-dsl-swt    4.17.2.2  AndyMaleh    Glimmer DSL for SWT
-  Tk     glimmer-dsl-tk     0.0.5     AndyMaleh    Glimmer DSL for Tk
+  Opal   glimmer-dsl-opal   0.4.0     AndyMaleh    Glimmer DSL for Opal
+  Swt    glimmer-dsl-swt    4.17.4.1  AndyMaleh    Glimmer DSL for SWT
+  Tk     glimmer-dsl-tk     0.0.6     AndyMaleh    Glimmer DSL for Tk
   Xml    glimmer-dsl-xml    1.1.0     AndyMaleh    Glimmer DSL for XML
 ```
@@ -1207,10 +1004,28 @@ On Linux, the Glimmer [Custom Shell Gem](#custom-shell-gem) approach provides a
 ### Raw JRuby Command
 If there is a need to run Glimmer directly via the `jruby` command, you
-may run the following:
+may run the following on Windows/Linux:
+```
+jruby -r glimmer-dsl-swt -S application.rb
+```
+Or, the following on Mac:
+```
+jruby -J-XstartOnFirstThread -r glimmer-dsl-swt -S application.rb
+```
+If you want to use a specific custom version of SWT, run the following on Windows/Linux:
+```
+jruby -J-classpath "path_to/swt.jar" -r glimmer-dsl-swt -S application.rb
+```
+Or, the following on Mac:
 ```
-jruby -J-classpath "path_to/swt.jar" -r glimmer -S application.rb
+jruby -J-XstartOnFirstThread -J-classpath "path_to/swt.jar" -r glimmer-dsl-swt -S application.rb
 ```
 The `-J-classpath` option specifies the `swt.jar` file path, which can be a
@@ -1228,7 +1043,7 @@ However, if there is a reason to use the raw `jruby` command directly instead of
 Example:
 ```
-jruby -J-XstartOnFirstThread -J-classpath "path_to/swt.jar" -r glimmer -S application.rb
+jruby -J-XstartOnFirstThread -J-classpath "path_to/swt.jar" -r glimmer-dsl-swt -S application.rb
 ```
 ## Girb (Glimmer irb) Command
@@ -1312,19 +1127,21 @@ Glimmer DSL syntax consists mainly of:
 ### DSL Auto-Expansion
-Glimmer supports a new and radical Ruby DSL concept called DSL Auto-Expansion. It is explained by first mentioning the two types of Glimmer GUI DSL keywords: static and dynamic.
+Glimmer supports a new and radical Ruby DSL concept called DSL Auto-Expansion. To explain, let's first mention the two types of Glimmer GUI DSL keywords: static and dynamic.
 Static keywords are pre-identified keywords in the Glimmer DSL, such as `shell`, `display`, `message_box`, `async_exec`, `sync_exec`, and `bind`.
-Dynamic keywords are dynamically figured out from currently imported (aka required/loaded) SWT widgets, custom widgets, and widget properties. Examples are: `label`, `combo`, and `list` for widgets and `enabled`, `text`, and `selection` for properties.
+Dynamic keywords are dynamically figured out from currently imported (aka required/loaded) SWT widgets and custom widgets. Examples are: `label`, `combo`, and `list` for SWT widgets and `c_date_time`, `video`, and `gantt_chart` for custom widgets.
+The only reason to distinguish between the two is to realize that importing new Glimmer [custom widgets](#custom-widgets) and Java SWT custom widget libraries automatically expands Glimmer's DSL vocabulary with new dynamic keywords.
-The only reason to distinguish between the two types of Glimmer DSL keywords is to realize that importing new Glimmer [custom widgets](#custom-widgets) and Java SWT custom widget libraries automatically expands Glimmer's DSL vocabulary via new dynamic keywords.
+For example, if a project adds this custom Java SWT library from the [Nebula Project](https://www.eclipse.org/nebula/):
-For example, if a project adds this custom Java SWT library:
+https://www.eclipse.org/nebula/widgets/gallery/gallery.php
-https://www.eclipse.org/nebula/widgets/cdatetime/cdatetime.php?page=operation
+Glimmer will automatically support using the keyword `gallery`
-Glimmer will automatically support using the keyword `c_date_time`
+This is what DSL Auto-Expansion is.
 You will learn more about widgets next.
@@ -1439,27 +1256,9 @@ shell {
 If you are new to Glimmer, you have learned enough to start running some [samples](#samples). Go ahead and run all Glimmer [samples](#samples), and come back to read the rest in any order you like since this material is more organized like a reference.
-#### Display
-SWT Display is a singleton in Glimmer. It is used in SWT to represent your display device, allowing you to manage GUI globally
-and access available monitors.
-It is automatically instantiated upon first instantiation of a `shell` widget.
-Alternatively, for advanced use cases, it can be created explicitly with Glimmer `display` keyword. When a `shell` is later declared, it
-automatically uses the display created earlier without having to explicitly hook it.
+If you are advanced and need more widgets, check out the [Nebula Project](https://www.eclipse.org/nebula/) for an extensive list of high quality custom widgets:
-```ruby
-@display = display {
-  cursor_location 300, 300
-  on_swt_keydown {
-    # ...
-  }
-  # ...
-}
-@shell = shell { # uses display created above
-}
-```
-The benefit of instantiating an SWT Display explicitly is to set [Properties](#widget-properties) or [Observers](#observer).
-Although SWT Display is not technically a widget, it has similar APIs in SWT and similar DSL support in Glimmer.
+https://www.eclipse.org/nebula/
 #### SWT Proxies
@@ -1476,7 +1275,26 @@ Glimmer follows Proxy Design Pattern by having Ruby proxy wrappers for all SWT o
 These proxy objects have an API and provide some convenience methods, some of which are mentioned below.
-##### `#content { ... }`
+##### swt_widget
+Glimmer SWT proxies come with the instance method `#swt_widget`, which returns the actual SWT `Widget` object wrapped by the Glimmer widget proxy. It is useful in cases you'd like to do some custom SWT programming outside of Glimmer.
+##### Shell widget proxy methods
+Shell widget proxy has extra methods specific to SWT Shell:
+- `#open`: Opens the shell, making it visible and active, and starting the SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). If shell was already open, but hidden, it makes the shell visible.
+- `#show`: Alias for `#open`
+- `#hide`: Hides a shell setting "visible" property to false
+- `#close`: Closes the shell
+- `#center`: Centers the shell within monitor it is in
+- `#start_event_loop`: (happens as part of `#open`) Starts SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). This method is not needed except in rare circumstances where there is a need to start the SWT Event Loop before opening the shell.
+- `#visible?`: Returns whether a shell is visible
+- `#opened_before?`: Returns whether a shell has been opened at least once before (additionally implying the SWT Event Loop has been started already)
+- `#visible=`: Setting to true opens/shows shell. Setting to false hides the shell.
+- `#pack`: Packs contained widgets using SWT's `Shell#pack` method
+- `#pack_same_size`: Packs contained widgets without changing shell's size when widget sizes change
+##### Widget Content Block
 Glimmer allows re-opening any widget and adding properties or extra content after it has been constructed already by using the `#content` method.
@@ -1502,7 +1320,31 @@ Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
 @shell.open
 ```
-##### `message_box`
+##### Shell Icon
+To set the shell icon, simply set the `image` property under the `shell` widget. This shows up in the operating system toolbar and app-switcher (e.g. CMD+TAB) (and application window top-left corner in Windows)
+Example:
+```ruby
+shell {
+  # ...
+  image 'path/to/image.png'
+  # ...
+}
+```
+###### Shell Icon Tip for Packaging on Windows
+When setting shell icon for a [packaged](#packaging--distribution) app, which has a JAR file at its core, you can reference the `ico` file that ships with the app by going one level up (e.g. `'../AppName.ico'`)
+#### Dialog
+Dialog is a variation on Shell. It is basically a shell that is modal (blocks what's behind it) and belongs to another shell. It only has a close button.
+Glimmer facilitates building dialogs by using the `dialog` keyword, which automatically adds the SWT.DIALOG_TRIM and SWT.APPLICATION_MODAL [widget styles](#widget-styles) needed for a dialog.
+##### message_box
 The Glimmer DSL `message_box` keyword is similar to `shell`, but renders a modal dialog with a title `text` property and main body `message` property. It may also be opened via the `#open` method.
@@ -1541,48 +1383,65 @@ message_box {
 }.open
 ```
-##### `#swt_widget`
-Glimmer widget objects come with an instance method `#swt_widget` that returns the actual SWT `Widget` object wrapped by the Glimmer widget object. It is useful in cases you'd like to do some custom SWT programming outside of Glimmer.
-##### Shell widget proxy methods
-Shell widget proxy has extra methods specific to SWT Shell:
-- `#open`: Opens the shell, making it visible and active, and starting the SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). If shell was already open, but hidden, it makes the shell visible.
-- `#show`: Alias for `#open`
-- `#hide`: Hides a shell setting "visible" property to false
-- `#close`: Closes the shell
-- `#center`: Centers the shell within monitor it is in
-- `#start_event_loop`: (happens as part of `#open`) Starts SWT Event Loop (you may learn more about it here: https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/widgets/Display.html). This method is not needed except in rare circumstances where there is a need to start the SWT Event Loop before opening the shell.
-- `#visible?`: Returns whether a shell is visible
-- `#opened_before?`: Returns whether a shell has been opened at least once before (additionally implying the SWT Event Loop has been started already)
-- `#visible=`: Setting to true opens/shows shell. Setting to false hides the shell.
-- `#pack`: Packs contained widgets using SWT's `Shell#pack` method
-- `#pack_same_size`: Packs contained widgets without changing shell's size when widget sizes change
+#### Display
-##### Shell Icon
+The SWT `Display` class is a singleton in Glimmer. It is used in SWT to represent your display device, allowing you to manage GUI globally
+and access available monitors. Additionally, it is responsible for the SWT event loop, which runs on the first thread the Glimmer application starts on. In multi-threaded programming, `Display` provides the methods `async_exec` and `sync_exec` to enable enqueuing GUI changes asynchronously or synchronously from threads other than the main (first) thread since direct GUI changes are forbidden from other threads by design.
-To set the shell icon, simply set the `image` property under the `shell` widget. This shows up in the operating system toolbar and app-switcher (e.g. CMD+TAB) (and application window top-left corner in Windows)
+`Display` is automatically instantiated upon first instantiation of a `shell` widget.
-Example:
+Alternatively, for advanced use cases, a `Display` can be created explicitly with the Glimmer `display` keyword. When a `shell` is later declared, it
+automatically uses the `display` created earlier without having to explicitly hook it.
 ```ruby
-shell {
-  # ...
-  image 'path/to/image.png'
+@display = display {
+  cursor_location 300, 300
+  on_swt_keydown {
+    # ...
+  }
   # ...
 }
+@shell = shell { # uses display created above
+}
 ```
+The benefit of instantiating an SWT Display explicitly is to set [Properties](#widget-properties) or [Observers](#observer).
+Although SWT Display is not technically a widget, it has similar APIs and DSL support.
-###### Shell Icon Tip for Packaging on Windows
+#### Multi-Threading
-When setting shell icon for a [packaged](#packaging--distribution) app, which has a JAR file at its core, you can reference the `ico` file that ships with the app by going one level up (e.g. `'../AppName.ico'`)
+[JRuby](https://www.jruby.org/) supports [truly parallel multi-threading](https://github.com/jruby/jruby/wiki/Concurrency-in-jruby) since it relies on the JVM (Java Virtual Machine). As such, it enables development of highly-interactive desktop applications that can do background work while the user is interacting with the GUI.
-#### Dialog
+##### async_exec
-Dialog is a variation on Shell. It is basically a shell that is modal (blocks what's behind it) and belongs to another shell. It only has a close button.
+`async_exec` is a Glimmer DSL keyword in addition to being a method on `display`. It accepts a block and when invoked, adds the block to the end of a queue of GUI events scheduled to run on the SWT event loop, executing asynchronously.
-Glimmer facilitates building dialogs by using the `dialog` keyword, which automatically adds the SWT.DIALOG_TRIM and SWT.APPLICATION_MODAL [widget styles](#widget-styles) needed for a dialog.
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+```
+@shell = shell {
+  text 'Glimmer'
+  @label = label {
+    text 'Hello, World!'
+  }
+}
+Thread.new {
+  [:red, :dark_green, :blue].cycle { |color|
+    async_exec {
+      @label.content {
+        foreground color if @shell.visible?
+      }
+    }
+    sleep(1)
+  }
+}
+@shell.open
+```
+##### sync_exec
+`sync_exec` works just like `async_exec` except it executes the block synchronously at the earliest opportunity possible, waiting for the block to be finished.
 #### Menus
@@ -1915,6 +1774,16 @@ Example:
 @font = font(name: 'Arial', height: 36, style: :normal)
 ```
+### Image
+The `image` keyword creates an instance of [org.eclipse.swt.graphics.Image](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/graphics/Image.html).
+It is a graphics `Image` object (not a widget), but is used used in setting the `image` property on `label` and `background_image` on `composite` (and subclasses)
+Glimmer recently included **EXPERIMENTAL** gif animation support for the `background_image` property on `composite' since SWT does not support animation by default. On Windows, it only works inside composites nested under standard shells, not ones that have the SWT styles :on_top or :no_trim
+Learn more about images in general at this SWT Image guide: https://www.eclipse.org/articles/Article-SWT-images/graphics-resources.html
 ### Cursor
 SWT widget `cursor` property represents the mouse cursor you see on the screen when you hover over that widget.
@@ -2636,7 +2505,9 @@ end
 Custom widgets are brand new Glimmer DSL keywords that represent aggregates of existing widgets (e.g. `address_form`), customized existing widgets (e.g. `greeting_label`), or brand new widgets (e.g. `oscilloscope`)
-Glimmer supports two ways of creating custom widgets with minimal code:
+You can find out about [published Glimmer Custom Widgets](https://github.com/AndyObtiva/glimmer-dsl-swt#gem-listing) by running the `glimmer list:gems:customwidget` command
+Glimmer supports three ways of creating custom widgets with minimal code:
 1. Method-based Custom Widgets (for single-view-internal reuse): Extract a method containing Glimmer DSL widget syntax. Useful for quickly eliminating redundant code within a single view.
 2. Class-based Custom Widgets (for multiple-view-external reuse): Create a class that includes the `Glimmer::UI::CustomWidget` module and Glimmer DSL widget syntax in a `body {}` block. This will automatically extend Glimmer's DSL syntax with an underscored lowercase keyword matching the class name by convention. Useful in making a custom widget available in many views.
@@ -2666,7 +2537,6 @@ shell {
 }.open
 ```
 ##### Class-Based Custom Widget Example
 Simply create a new class that includes `Glimmer::UI::CustomWidget` and put Glimmer DSL code in its `#body` block (its return value is stored in `#body_root` attribute). Glimmer will then automatically recognize this class by convention when it encounters a keyword matching the class name converted to underscored lowercase (and namespace double-colons `::` replaced with double-underscores `__`)
@@ -2842,6 +2712,8 @@ Custom shells are a kind of custom widgets that have shells only as the body roo
 They may also be chained in a wizard fashion.
+You can find out about [published Glimmer Custom Shells](https://github.com/AndyObtiva/glimmer-dsl-swt#gem-listing) by running the `glimmer list:gems:customshell` command
 Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
 ```ruby
@@ -3181,6 +3053,28 @@ shell(:no_resize) {
 Also, you may invoke `Display.setAppVersion('1.0.0')` if needed for OS app version identification reasons during development, replacing `'1.0.0'` with your application version.
+#### Code Text Widget
+`code_text` is a Glimmer built-in custom widget that displays syntax highlighted Ruby code in a customized SWT [StyledText](https://help.eclipse.org/2020-09/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/custom/StyledText.html) widget.
+It is used in the [Glimmer Meta-Sample (The Sample of Samples)](#samples):
+![Glimmer Meta-Sample](images/glimmer-meta-sample.png)
+Glimmer Meta-Sample Code Example:
+```ruby
+# ...
+code_text {
+  text bind(SampleDirectory, 'selected_sample.content')
+  editable false
+  caret nil
+}
+# ...
+```
+To use, simply use `code_text` in place of `text` or `styled_text` widget. If you set its `text` value to Ruby code, it automatically styles it with syntax highlighting.
 #### Video Widget
 [![Video Widget](images/glimmer-video-widget.png)](https://github.com/AndyObtiva/glimmer-cw-video)
@@ -3189,6 +3083,41 @@ Glimmer supports a [video custom widget](https://github.com/AndyObtiva/glimmer-c
 You may obtain via `glimmer-cw-video` gem.
+#### Sash Form Widget
+`sash_form` is an SWT built-in custom widget that provides a resizable sash that splits a window area into two or more panes.
+It can be customized with the `weights` attribute by setting initial weights to size the panes at first display.
+One noteworthy thing about the Glimmer implementation is that, unlike behavior in SWT, it allows declaring `weights` before the content of the `sash_form`, thus providing more natural and convenient syntax (Glimmer automatically takes care of sending that declaration to SWT at the end of declaring `sash_form` content as per the SWT requirements)
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+```ruby
+shell {
+  text 'Sash Form Example'
+  sash_form {
+    label {
+      text '(resize >>)'
+      background :dark_green
+      foreground :white
+      font height: 20
+    }
+    label {
+      text '(<< resize)'
+      background :red
+      foreground :white
+      font height: 20
+    }
+    weights 1, 2
+  }
+}.open
+```
+You may check out a more full-fledged example in [Hello, Sash Form!](#hello-sash-form)
+![Hello Sash Form](images/glimmer-hello-sash-form.png)
 #### Browser Widget
 ![Hello Browser](images/glimmer-hello-browser.png)
@@ -3461,16 +3390,32 @@ Here is an SWT Custom Widget guide:
 https://www.eclipse.org/articles/Article-Writing%20Your%20Own%20Widget/Writing%20Your%20Own%20Widget.htm
+Here is an SWT Image guide:
+https://www.eclipse.org/articles/Article-SWT-images/graphics-resources.html
+Here is an SWT Graphics / Canvas-Drawing guide:
+https://www.eclipse.org/articles/Article-SWT-graphics/SWT_graphics.html
+Here is the Nebula Project (custom widget library) homepage:
+https://www.eclipse.org/nebula/
 ## Samples
 Check the [samples](samples) directory in [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) for examples on how to write Glimmer applications. To run a sample, make sure to install the `glimmer` gem first and then use the `glimmer` command to run it (alternatively, you may clone the repo, follow [CONTRIBUTING.md](CONTRIBUTING.md) instructions, and run samples locally with development glimmer command: `bin/glimmer`).
-If you cloned the project and followed [CONTRIBUTING.md](CONTRIBUTING.md) instructions, you may run all samples in [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) at once via `samples/launch` command:
+You may run any sample via this command:
 ```
-samples/launch
+glimmer samples
 ```
+This brings up the [Glimmer Meta-Sample (The Sample of Samples)](samples/elaborate/meta_sample.rb)
+![Glimmer Meta-Sample](images/glimmer-meta-sample.png)
 ### Hello Samples
 For hello-type simple samples, check the following.
@@ -3481,12 +3426,6 @@ Code:
 [samples/hello/hello_world.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_world.rb)
-Run:
-```
-glimmer sample:run[hello_world]
-```
 ![Hello World](images/glimmer-hello-world.png)
 #### Hello, Tab!
@@ -3495,12 +3434,6 @@ Code:
 [samples/hello/hello_tab.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_tab.rb)
-Run:
-```
-glimmer sample:run[hello_tab]
-```
 ![Hello Tab English](images/glimmer-hello-tab-english.png)
 ![Hello Tab French](images/glimmer-hello-tab-french.png)
@@ -3512,12 +3445,6 @@ Code:
 [samples/hello/hello_combo.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_combo.rb)
-Run:
-```
-glimmer sample:run[hello_combo]
-```
 ![Hello Combo](images/glimmer-hello-combo.png)
 ![Hello Combo Expanded](images/glimmer-hello-combo-expanded.png)
@@ -3529,12 +3456,6 @@ Code:
 [samples/hello/hello_list_single_selection.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_list_single_selection.rb)
-Run:
-```
-glimmer sample:run[hello_list_single_selection]
-```
 ![Hello List Single Selection](images/glimmer-hello-list-single-selection.png)
 #### Hello, List Multi Selection!
@@ -3545,12 +3466,6 @@ Code:
 [samples/hello/hello_list_multi_selection.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_list_multi_selection.rb)
-Run:
-```
-glimmer sample:run[hello_list_multi_selection]
-```
 ![Hello List Multi Selection](images/glimmer-hello-list-multi-selection.png)
 #### Hello, Computed!
@@ -3561,12 +3476,6 @@ Code:
 [samples/hello/hello_computed.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_computed.rb)
-Run:
-```
-glimmer sample:run[hello_computed]
-```
 ![Hello Browser](images/glimmer-hello-computed.png)
 #### Hello, Message Box!
@@ -3577,12 +3486,6 @@ Code:
 [samples/hello/hello_message_box.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_message_box.rb)
-Run:
-```
-glimmer sample:run[hello_message_box]
-```
 ![Hello Message Box](images/glimmer-hello-message-box.png)
 ![Hello Message Box Dialog](images/glimmer-hello-message-box-dialog.png)
@@ -3594,12 +3497,6 @@ Code:
 [samples/hello/hello_browser.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_browser.rb)
-Run:
-```
-glimmer sample:run[hello_browser]
-```
 ![Hello Browser](images/glimmer-hello-browser.png)
 #### Hello, Drag and Drop!
@@ -3610,12 +3507,6 @@ Code:
 [samples/hello/hello_drag_and_drop.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_drag_and_drop.rb)
-Run:
-```
-glimmer sample:run[hello_drag_and_drop]
-```
 ![Hello Drag and Drop](images/glimmer-hello-drag-and-drop.gif)
 #### Hello, Menu Bar!
@@ -3626,12 +3517,6 @@ Code:
 [samples/hello/hello_menu_bar.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_menu_bar.rb)
-Run:
-```
-glimmer sample:run[hello_menu_bar]
-```
 ![Hello Menu Bar](images/glimmer-hello-menu-bar.png)
 ![Hello Menu Bar File Menu](images/glimmer-hello-menu-bar-file-menu.png)
 ![Hello Menu Bar History Menu](images/glimmer-hello-menu-bar-history-menu.png)
@@ -3644,12 +3529,6 @@ Code:
 [samples/hello/hello_pop_up_context_menu.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_pop_up_context_menu.rb)
-Run:
-```
-glimmer sample:run[hello_pop_up_context_menu]
-```
 ![Hello Pop Up Context Menu](images/glimmer-hello-pop-up-context-menu.png)
 ![Hello Pop Up Context Menu Popped Up](images/glimmer-hello-pop-up-context-menu-popped-up.png)
@@ -3661,12 +3540,6 @@ Code:
 [samples/hello/hello_custom_widget.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_custom_widget.rb)
-Run:
-```
-glimmer sample:run[hello_custom_widget]
-```
 ![Hello Custom Widget](images/glimmer-hello-custom-widget.gif)
 #### Hello, Custom Shell!
@@ -3677,17 +3550,43 @@ Code:
 [samples/hello/hello_custom_shell.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_custom_shell.rb)
-Run:
-```
-glimmer sample:run[hello_custom_shell]
-```
 ![Hello Custom Shell](images/glimmer-hello-custom-shell.png)
 ![Hello Custom Shell Email1](images/glimmer-hello-custom-shell-email1.png)
 ![Hello Custom Shell Email2](images/glimmer-hello-custom-shell-email2.png)
 ![Hello Custom Shell Email3](images/glimmer-hello-custom-shell-email3.png)
+#### Hello, Sash Form!
+This sample demonstrates the use of a `sash_form` in Glimmer.
+Code:
+[samples/hello/hello_sash_form.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/hello/hello_sash_form.rb)
+Hello, Sash Form! Horizontal Orientation
+![Hello Sash Form](images/glimmer-hello-sash-form.png)
+Hello, Sash Form! Resized
+![Hello Sash Form Resized](images/glimmer-hello-sash-form-resized.png)
+Hello, Sash Form! Sash Width Changed
+![Hello Sash Form Sash Width Changed](images/glimmer-hello-sash-form-sash-width-changed.png)
+Hello, Sash Form! Vertical Orientation
+![Hello Sash Form Vertical](images/glimmer-hello-sash-form-vertical.png)
+Hello, Sash Form! Green Label Maximized
+![Hello Sash Form Green Maximized](images/glimmer-hello-sash-form-green-maximized.png)
+Hello, Sash Form! Red Label Maximized
+![Hello Sash Form Red Maximized](images/glimmer-hello-sash-form-red-maximized.png)
 ### Elaborate Samples
 For more elaborate samples, check the following:
@@ -3702,12 +3601,6 @@ Code:
 [samples/elaborate/user_profile.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/elaborate/user_profile.rb)
-Run:
-```
-glimmer sample:run[user_profile]
-```
 ![User Profile](images/glimmer-user-profile.png)
 #### Login
@@ -3718,12 +3611,6 @@ Code:
 [samples/elaborate/login.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/elaborate/login.rb)
-Run:
-```
-glimmer sample:run[login]
-```
 ![Login](images/glimmer-login.png)
 ![Login Filled In](images/glimmer-login-filled-in.png)
 ![Login Logged In](images/glimmer-login-logged-in.png)
@@ -3738,12 +3625,6 @@ Code:
 [samples/elaborate/tic_tac_toe.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/elaborate/tic_tac_toe.rb)
-Run:
-```
-glimmer sample:run[tic_tac_toe]
-```
 ![Tic Tac Toe](images/glimmer-tic-tac-toe.png)
 ![Tic Tac Toe In Progress](images/glimmer-tic-tac-toe-in-progress.png)
 ![Tic Tac Toe Game Over](images/glimmer-tic-tac-toe-game-over.png)
@@ -3756,12 +3637,6 @@ Code:
 [samples/elaborate/contact_manager.rb](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/samples/elaborate/contact_manager.rb)
-Run:
-```
-glimmer sample:run[contact_manager]
-```
 Contact Manager
 ![Contact Manager](images/glimmer-contact-manager.png)
@@ -3833,7 +3708,7 @@ If you have a Glimmer app you would like referenced here, please mention in a Pu
 ## Packaging & Distribution
-Note: this section mostly applies to Mac and Windows. On Linux, the Glimmer [Custom Shell Gem](#custom-shell-gem) approach provides a [Gem Packaged Shell Script](#custom-shell-gem) (e.g. `calculator` command becomes available after installing the [glimmer-cs-calculator](https://github.com/AndyObtiva/glimmer-cs-calculator) gem)
+Note: this section mostly applies to Mac and Windows. On Linux, you can just run `glimmer package:gem` and after installing the gem, you get an executable matching the name of the app/custom-shell-gem you are building (e.g. `calculator` command becomes available after installing the [glimmer-cs-calculator](https://github.com/AndyObtiva/glimmer-cs-calculator) gem)
 Glimmer simplifies the process of native-executable packaging and distribution on Mac and Windows via a single `glimmer package` command:
@@ -3859,7 +3734,7 @@ require 'glimmer/rake_task'
 ```
 The Glimmer packaging process done in the `glimmer package` command consists of the following steps:
-1. Generate gemspec via [Juwelier](https://rubygems.org/gems/juwelier) (`rake gemspec:generate`): Having a gemspec is required by the [`jar-dependencies`](https://github.com/mkristian/jar-dependencies) JRuby gem, used by JRuby libraries to declare JAR dependencies.
+1. Generate gemspec via [Juwelier](https://rubygems.org/gems/juwelier) (`glimmer package:gemspec`): Having a gemspec is required by the [`jar-dependencies`](https://github.com/mkristian/jar-dependencies) JRuby gem, used by JRuby libraries to declare JAR dependencies.
 1. Lock JAR versions (`glimmer package:lock_jars`): This locks versions of JAR dependencies leveraged by the `jar-dependencies` JRuby gem, downloading them into the `./vendor` directory so they would get inside the top-level Glimmer app/gem JAR file.
 1. Generate [Warbler](https://github.com/jruby/warbler) config (`glimmer package:config`): Generates initial Warbler config file (under `./config/warble.rb`) to use for generating JAR file.
 1. Generate JAR file using [Warbler](https://github.com/jruby/warbler) (`glimmer package:jar`): Enables bundling a Glimmer app into a JAR file under the `./dist` directory