glimmer-dsl-opal 0.0.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbf51689c9728f9af6a7670f703584c79def82be3f74085556f91cbc9f02cd51
-  data.tar.gz: e73b3c81aa113ca61e080a5c0fce7299c0812c04883aaf8864bdec5dc80fad00
+  metadata.gz: 4149153253dd59829bf590c406ff2e5b18c11a62cbbaf7130877f2046a04d2a1
+  data.tar.gz: f82f4d9c0bff2625f1f4ef8bef4be2703789a72aed847d4c851697d916cf48c4
 SHA512:
-  metadata.gz: 98c27b51a8de0e218ed4e888660fb6dbf110deda9b1444b7fd75dc72d5477a5eaa277d2a64d92f223bcf0d3b8c398bf2da369a26e000c2544c34952c9fd7f8ad
-  data.tar.gz: 05725471322ba4a5e55115360fa2a970e69c6f076c36480b3354c86968ac796e63c0e0c1250ca2639f100a329363c51fc7a0254b66a918aa7ed4130f538c2ce4
+  metadata.gz: 202c4686ab1a2bf31377cbe4ee6f173c92318460e0758cb74356132323c571b381f3bd69d0d47933ac44c54a79fd24520ce7c2e1ffa1412db903ae2c27ce259b
+  data.tar.gz: 182085ad652639b3d83b9853bf993702839cb8066074b92e5377b5b8aa1998d659d925ef0d1f5cac0c659241bd97cf7fe109d2008142e0f5b34165f49e93bc67

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Change Log
 
+## 0.2.0
+
+- Color support
+- Font support
+- Custom Widget Support
+- Hello, Custom Widget! sample
+- Updated Hello, Combo! sample to match the latest changes in Glimmer DSL for SWT
+- `SWT` full re-implementation in Opal as `Glimmer::SWT` with all the `SWT` style constants
+
+## 0.1.0
+
+- Code redesign to better match the glimmer-dsl-swt APIs
+- opal-jquery refactoring
+- opal-rspec test coverage
+
+## 0.0.9
+
+- Upgraded to glimmer gem v0.9.3
+- Fixed issue with missing Glimmer::Opal::ElementProxy#id=(value) method breaking Contact Manager sample Find feature
+
+## 0.0.8
+
+- Contact Manager sample support
+
+## 0.0.7
+
+- Tic Tac Toe sample support
+- Login sample support
+
+## 0.0.6
+
+- Hello, Tab! sample support
+
+## 0.0.5
+
+- Hello, Browser! sample support
+
+## 0.0.4
+
+- Hello, List Single Selection! sample support
+- Hello, List Multi Selection! sample support
+
+## 0.0.3
+
+- Hello, Computed! sample support
+
+## 0.0.2
+
+- Hello, Combo! sample support
+
 ## 0.0.1
 
 - Initial support for webifying Glimmer SWT apps

data/README.md

@@ -1,12 +1,14 @@
-# <img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=65 /> Glimmer DSL for Opal 0.0.6 (Web GUI for Desktop Apps)
+# [<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 Opal 0.2.0 (Webify Desktop Apps)
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-opal.svg)](http://badge.fury.io/rb/glimmer-dsl-opal)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for Opal is a web GUI adaptor for desktop apps built with [Glimmer](https://github.com/AndyObtiva/glimmer) & [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt).
+### You can finally live in pure Ruby land even on the web!
 
-It enables running [Glimmer](https://github.com/AndyObtiva/glimmer) desktop apps on the web via [Rails](https://rubyonrails.org/) 5 and [Opal](https://opalrb.com/) 1.
+[Glimmer](https://github.com/AndyObtiva/glimmer) DSL for [Opal](https://opalrb.com/) is an experimental proof-of-concept web GUI adapter for [Glimmer](https://github.com/AndyObtiva/glimmer) desktop apps (i.e. apps built with [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt)). It webifies them via [Rails](https://rubyonrails.org/), allowing Ruby desktop apps to run on the web via [Opal Ruby](https://opalrb.com/) without changing a line of code. Apps may then be custom-styled for the web with standard CSS by web designers. 
 
-NOTE: Alpha Version 0.0.6 only supports Hello sample capabilities (detailed under [Examples](#examples)):
+Glimmer DSL for Opal webifier successfully reuses the entire [Glimmer](https://github.com/AndyObtiva/glimmer) core DSL engine in [Opal Ruby](https://opalrb.com/) inside a web browser, and as such inherits the full range of powerful Glimmer desktop [data-binding](https://github.com/AndyObtiva/glimmer#data-binding) capabilities for the web.
+
+NOTE: Alpha Version 0.2.0 only supports bare-minimum capabilities for the following [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) [samples](https://github.com/AndyObtiva/glimmer#samples):
 - [Hello, World!](#hello-world)
 - [Hello, Combo!](#hello-combo)
 - [Hello, Computed!](#hello-computed)
@@ -14,9 +16,14 @@ NOTE: Alpha Version 0.0.6 only supports Hello sample capabilities (detailed unde
 - [Hello, List Multi Selection!](#hello-list-multi-selection)
 - [Hello, Browser!](#hello-browser)
 - [Hello, Tab!](#hello-tab)
-
-Other Glimmer DSL gems:
-- [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (Desktop GUI)
+- [Hello, Custom Widget!](#hello-custom-widget)
+- [Login](#login)
+- [Tic Tac Toe](#tic-tac-toe)
+- [Contact Manager](#contact-manager)
+
+Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
+- [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (JRuby Desktop Development GUI Library)
+- [glimmer-dsl-tk](https://github.com/AndyObtiva/glimmer-dsl-tk): Glimmer DSL for Tk (Ruby Desktop Development GUI Library)
 - [glimmer-dsl-xml](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML)
 - [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS (Cascading Style Sheets)
 
@@ -24,6 +31,7 @@ Other Glimmer DSL gems:
 
 The following keywords from [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) have partial support in Opal:
 
+Widgets:
 - `shell`
 - `label`
 - `combo`
@@ -33,51 +41,111 @@ The following keywords from [glimmer-dsl-swt](https://github.com/AndyObtiva/glim
 - `list` & `list(:multi)`
 - `tab_folder`
 - `tab_item`
-- `on_widget_selected`
-- `on_modify_text`
+- `table`
+- `table_column`
+- `message_box`
+
+Graphics:
+- `color`
+- `font`
+
+Layouts:
 - `grid_layout`
+- `row_layout`
+- `fill_layout`
 - `layout_data`
 
+Data-Binding/Observers:
+- `bind`
+- `observe`
+- `on_widget_selected`
+- `on_modify_text`
+
+Event loop:
+- `async_exec`
+
 ## Pre-requisites
 
 - Rails 5: [https://github.com/rails/rails/tree/5-2-stable](https://github.com/rails/rails/tree/5-2-stable)
 - Opal 1: [https://github.com/opal/opal-rails](https://github.com/opal/opal-rails)
+- jQuery 3: [https://code.jquery.com/](https://code.jquery.com/) (jQuery 3.5.1 is included in the [glimmer-dsl-opal](https://rubygems.org/gems/glimmer-dsl-opal) gem)
 
 ## Setup
 
-Please follow these instructions to make Glimmer desktop apps work in Opal inside Rails 5
+(NOTE: if you run into issues, keep in mind this is a very early experimental and incomplete alpha. Also, there is a slight chance issues you encounter are fixed in master or some other branch that you could check out instead)
+
+Please install a Rails 5 gem (e.g. `gem install rails -v5.2.4.3` )
 
 Start a new Rails 5 app:
 
 ```
-rails new hello_world
+rails new glimmer_app
 ```
 
-Follow instructions to setup opal with a rails application: config/initializers/assets.rb
+Add the following to `Gemfile`:
 
-Add the following to `Gemfile` (NOTE: if you run into issues, they are probably fixed in master or development/wip branch, you may check out instead):
 ```
-gem 'opal-rails'
-gem 'opal-browser'
-gem 'glimmer-dsl-opal', '~> 0.0.6', require: false
+gem 'opal-rails', '~> 1.1.2'
+gem 'opal-async', '~> 1.1.1'
+gem 'opal-jquery', '~> 0.4.4'
+gem 'glimmer-dsl-opal', '~> 0.2.0', require: false
+gem 'glimmer-dsl-xml', '~> 1.0.0', require: false
+gem 'glimmer-dsl-css', '~> 1.0.0', require: false
+
 ```
 
-Edit `config/initializers/assets.rb` and add:
+Follow (opal-rails)[https://github.com/opal/opal-rails] instructions, basically the configuration of: config/initializers/assets.rb
+
+Edit `config/initializers/assets.rb` and add the following at the bottom:
 ```
 Opal.use_gem 'glimmer-dsl-opal'
 ```
 
-Add the following line to the top of an empty `app/assets/javascripts/application.js.rb`
+Add the following line to the top of an empty `app/assets/javascripts/application.rb` (replacing `application.js`)
 
 ```ruby
-require 'glimmer-dsl-opal' # brings opal and opal browser too
+require 'glimmer-dsl-opal' # brings opal and other dependencies automatically
+```
+
+Run:
+
+```
+rails g scaffold welcome
 ```
 
-## Examples
+Modify `config/routes.rb`:
 
-### Hello, World!
+```ruby
+root to: 'welcome#index'
+```
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+Add more code to `app/assets/javascripts/application.rb` inside a `Document.ready?` block from one of the samples below or a [Glimmer](https://github.com/AndyObtiva/glimmer) [app](https://github.com/AndyObtiva/glimmer#app)/[custom-shell gem](https://github.com/AndyObtiva/glimmer#custom-shell-gem).
+
+```ruby
+Document.ready? do
+  # require-statement/code goes here.
+end
+```
+
+## Samples
+
+Follow the instructions below to try out [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) samples webified via [glimmer-dsl-opal](https://rubygems.org/gems/glimmer-dsl-opal)
+
+Also, this external sample app contains all the samples mentioned below configured inside a Rails 5 [Opal](https://opalrb.com/) app with all the pre-requisites ready to go for convenience:
+
+[https://github.com/AndyObtiva/sample-glimmer-dsl-opal-rails5-app](https://github.com/AndyObtiva/sample-glimmer-dsl-opal-rails5-app)
+
+### Hello Samples
+
+#### Hello, World!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_world'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 include Glimmer
@@ -87,7 +155,7 @@ shell {
   label {
     text 'Hello, World!'
   }
-}
+}.open
 ```
 
 Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
@@ -107,39 +175,53 @@ You should see "Hello, World!"
 
 ![Glimmer DSL for Opal Hello World](images/glimmer-dsl-opal-hello-world.png)
 
-### Hello, Combo!
+#### Hello, Combo!
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_combo'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 class Person
   attr_accessor :country, :country_options
-  
+
   def initialize
-    self.country_options=["", "Canada", "US", "Mexico"]
-    self.country = "Canada"
+    self.country_options = ['', 'Canada', 'US', 'Mexico']
+    reset_country
   end
 
   def reset_country
-    self.country = "Canada"
+    self.country = 'Canada'
   end
 end
 
 class HelloCombo
   include Glimmer
+  
   def launch
     person = Person.new
+    
     shell {
-      composite {
-        combo(:read_only) {
-          selection bind(person, :country)
-        }
-        button {
-          text "Reset"
-          on_widget_selected do
-            person.reset_country
-          end
-        }
+      row_layout(:vertical) {
+        pack false
+      }        
+      
+      text 'Hello, Combo!'      
+      
+      combo(:read_only) {
+        selection bind(person, :country)
+      }
+      
+      button {
+        text 'Reset Selection'
+        
+        on_widget_selected do
+          person.reset_country
+        end
       }
     }.open
   end
@@ -164,9 +246,16 @@ You should see "Hello, Combo!"
 
 ![Glimmer DSL for Opal Hello Combo](images/glimmer-dsl-opal-hello-combo.png)
 
-### Hello, Computed!
+#### Hello, Computed!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_computed'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 class HelloComputed
@@ -196,15 +285,15 @@ class HelloComputed
 
   def initialize
     @contact = Contact.new(
-      first_name: "Barry",
-      last_name: "McKibbin",
+      first_name: 'Barry',
+      last_name: 'McKibbin',
       year_of_birth: 1985
     )
   end
 
   def launch
     shell {
-      text "Hello Computed"
+      text 'Hello, Computed!'
       composite {
         grid_layout {
           num_columns 2
@@ -212,44 +301,44 @@ class HelloComputed
           horizontal_spacing 20
           vertical_spacing 10
         }
-        label {text "First &Name: "}
+        label {text 'First &Name: '}
         text {
           text bind(@contact, :first_name)
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "&Last Name: "}
+        label {text '&Last Name: '}
         text {
           text bind(@contact, :last_name)
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "&Year of Birth: "}
+        label {text '&Year of Birth: '}
         text {
           text bind(@contact, :year_of_birth)
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "Name: "}
+        label {text 'Name: '}
         label {
           text bind(@contact, :name, computed_by: [:first_name, :last_name])
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
-        label {text "Age: "}
+        label {text 'Age: '}
         label {
           text bind(@contact, :age, on_write: :to_i, computed_by: [:year_of_birth])
           layout_data {
-            horizontalAlignment :fill
-            grabExcessHorizontalSpace true
+            horizontal_alignment :fill
+            grab_excess_horizontal_space true
           }
         }
       }
@@ -276,9 +365,16 @@ You should see "Hello, Computed!"
 
 ![Glimmer DSL for Opal Hello Computed](images/glimmer-dsl-opal-hello-computed.png)
 
-### Hello, List Single Selection!
+#### Hello, List Single Selection!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_list_single_selection'
+```
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 class Person 
@@ -318,7 +414,7 @@ HelloListSingleSelection.new.launch
 ```
 Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
 
-![Glimmer DSL for SWT Hello List Single Selection](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-list-single-selection.png)
+![Glimmer DSL for SWT Hello List Single Selection](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-list-single-selection.png)
 
 Glimmer app on the web (using `glimmer-dsl-opal` gem):
 
@@ -333,9 +429,15 @@ You should see "Hello, List Single Selection!"
 
 ![Glimmer DSL for Opal Hello List Single Selection](images/glimmer-dsl-opal-hello-list-single-selection.png)
 
-### Hello, List Multi Selection!
+#### Hello, List Multi Selection!
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_list_multi_selection'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 class Person
@@ -385,7 +487,7 @@ HelloListMultiSelection.new.launch
 ```
 Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
 
-![Glimmer DSL for SWT Hello List Multi Selection](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-list-multi-selection.png)
+![Glimmer DSL for SWT Hello List Multi Selection](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-list-multi-selection.png)
 
 Glimmer app on the web (using `glimmer-dsl-opal` gem):
 
@@ -400,9 +502,15 @@ You should see "Hello, List Multi Selection!"
 
 ![Glimmer DSL for Opal Hello List Multi Selection](images/glimmer-dsl-opal-hello-list-multi-selection.png)
 
-### Hello, Browser!
+#### Hello, Browser!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_browser'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 include Glimmer
@@ -416,7 +524,7 @@ shell {
 ```
 Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
 
-![Glimmer DSL for SWT Hello Browser](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-browser.png)
+![Glimmer DSL for SWT Hello Browser](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-browser.png)
 
 Glimmer app on the web (using `glimmer-dsl-opal` gem):
 
@@ -431,9 +539,15 @@ You should see "Hello, Browser!"
 
 ![Glimmer DSL for Opal Hello Browser](images/glimmer-dsl-opal-hello-browser.png)
 
-### Hello, Tab!
+#### Hello, Tab!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_tab'
+```
 
-Add the following Glimmer code to `app/assets/javascripts/application.js.rb`
+Or add the Glimmer code directly if you prefer to play around with it:
 
 ```ruby
 class HelloTab
@@ -463,8 +577,8 @@ HelloTab.new.launch
 ```
 Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
 
-![Glimmer DSL for SWT Hello Tab English](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-tab-english.png)
-![Glimmer DSL for SWT Hello Tab French](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-tab-french.png)
+![Glimmer DSL for SWT Hello Tab English](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-tab-english.png)
+![Glimmer DSL for SWT Hello Tab French](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-tab-french.png)
 
 Glimmer app on the web (using `glimmer-dsl-opal` gem):
 
@@ -480,6 +594,807 @@ You should see "Hello, Tab!"
 ![Glimmer DSL for Opal Hello Tab English](images/glimmer-dsl-opal-hello-tab-english.png)
 ![Glimmer DSL for Opal Hello Tab French](images/glimmer-dsl-opal-hello-tab-french.png)
 
+#### Hello, Custom Widget!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_custom_widget'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
+
+```ruby
+# This class declares a `greeting_label` custom widget (by convention)
+class GreetingLabel
+  include Glimmer::UI::CustomWidget
+  
+  # multiple options without default values
+  options :name, :colors
+  
+  # single option with default value
+  option :greeting, default: 'Hello'
+  
+  # internal attribute (not a custom widget option)
+  attr_accessor :color
+  
+  before_body {
+    @font = {height: 24, style: :bold}
+    @color = :black
+  }
+  
+  after_body {
+    return if colors.nil?
+    
+    Thread.new {
+      colors.cycle { |color|
+        async_exec {
+          self.color = color
+        }
+        sleep(1)
+      }
+    }
+  }
+  
+  body {
+    # pass received swt_style through to label to customize (e.g. :center to center text)
+    label(swt_style) {
+      text "#{greeting}, #{name}!"
+      font @font
+      foreground bind(self, :color)
+    }
+  }
+  
+end
+
+# including Glimmer enables the Glimmer DSL syntax, including auto-discovery of the `greeting_label` custom widget
+include Glimmer
+
+shell {
+  fill_layout :vertical
+  
+  minimum_size 215, 215
+  text 'Hello, Custom Widget!'
+  
+  # custom widget options are passed in a hash
+  greeting_label(name: 'Sean')
+  
+  # pass :center SWT style followed by custom widget options hash
+  greeting_label(:center, name: 'Laura', greeting: 'Aloha') #
+  
+  greeting_label(:right, name: 'Rick') {
+    # you can nest attributes under custom widgets just like any standard widget
+    foreground :red
+  }
+  
+  # the colors option cycles between colors for the label foreground every second
+  greeting_label(:center, name: 'Mary', greeting: 'Aloha', colors: [:red, :dark_green, :blue])
+}.open
+```
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Hello Custom Widget](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-custom-widget.gif)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Hello, Custom Widget!"
+
+![Glimmer DSL for Opal Hello Custom Widget](images/glimmer-dsl-opal-hello-custom-widget.gif)
+
+### Elaborate Samples
+
+#### Login
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/elaborate/login'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
+
+```ruby
+require "observer"
+
+#Presents login screen data
+class LoginPresenter
+
+  attr_accessor :user_name
+  attr_accessor :password
+  attr_accessor :status
+
+  def initialize
+    @user_name = ""
+    @password = ""
+    @status = "Logged Out"
+  end
+
+  def status=(status)
+    @status = status
+
+    #TODO add feature to bind dependent properties to master property (2017-07-25 nested data binding)
+    notify_observers("logged_in")
+    notify_observers("logged_out")
+  end
+
+  def logged_in
+    self.status == "Logged In"
+  end
+
+  def logged_out
+    !self.logged_in
+  end
+
+  def login
+    self.status = "Logged In"
+  end
+
+  def logout
+    self.user_name = ""
+    self.password = ""
+    self.status = "Logged Out"
+  end
+
+end
+
+#Login screen
+class Login
+  include Glimmer
+
+  def launch
+    presenter = LoginPresenter.new
+    @shell = shell {
+      text "Login"
+      composite {
+        grid_layout 2, false #two columns with differing widths
+
+        label { text "Username:" } # goes in column 1
+        text {                     # goes in column 2
+          text bind(presenter, :user_name)
+          enabled bind(presenter, :logged_out)
+        }
+
+        label { text "Password:" }
+        text(:password, :border) {
+          text bind(presenter, :password)
+          enabled bind(presenter, :logged_out)
+        }
+
+        label { text "Status:" }
+        label { text bind(presenter, :status) }
+
+        button {
+          text "Login"
+          enabled bind(presenter, :logged_out)
+          on_widget_selected { presenter.login }
+        }
+
+        button {
+          text "Logout"
+          enabled bind(presenter, :logged_in)
+          on_widget_selected { presenter.logout }
+        }
+      }
+    }
+    @shell.open
+  end
+end
+
+Login.new.launch
+```
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Login](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-login.png)
+![Glimmer DSL for SWT Login Filled In](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-login-filled-in.png)
+![Glimmer DSL for SWT Login Logged In](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-login-logged-in.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Login" dialog
+
+![Glimmer DSL for Opal Login](images/glimmer-dsl-opal-login.png)
+![Glimmer DSL for Opal Login Filled In](images/glimmer-dsl-opal-login-filled-in.png)
+![Glimmer DSL for Opal Login Logged In](images/glimmer-dsl-opal-login-logged-in.png)
+
+#### Tic Tac Toe
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/elaborate/tic_tac_toe'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
+
+```ruby
+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
+
+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
+
+class TicTacToe
+  include Glimmer
+
+  def initialize
+    @tic_tac_toe_board = Board.new
+    @shell = shell {
+      text "Tic-Tac-Toe"
+      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)
+              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
+
+  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
+```
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Tic Tac Toe](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-tic-tac-toe.png)
+![Glimmer DSL for SWT Tic Tac Toe In Progress](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-tic-tac-toe-in-progress.png)
+![Glimmer DSL for SWT Tic Tac Toe Game Over](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-tic-tac-toe-game-over.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Tic Tac Toe"
+
+![Glimmer DSL for Opal Tic Tac Toe](images/glimmer-dsl-opal-tic-tac-toe.png)
+![Glimmer DSL for Opal Tic Tac Toe In Progress](images/glimmer-dsl-opal-tic-tac-toe-in-progress.png)
+![Glimmer DSL for Opal Tic Tac Toe Game Over](images/glimmer-dsl-opal-tic-tac-toe-game-over.png)
+
+#### Contact Manager
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/elaborate/contact_manager'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
+
+```ruby
+class ContactManager
+  class Contact
+    attr_accessor :first_name, :last_name, :email
+  
+    def initialize(attribute_map)
+      @first_name = attribute_map[:first_name]
+      @last_name = attribute_map[:last_name]
+      @email = attribute_map[:email]
+    end
+  end
+end
+
+class ContactManager
+  class ContactRepository
+    NAMES_FIRST = %w[
+      Liam
+      Noah
+      William
+      James
+      Oliver
+      Benjamin
+      Elijah
+      Lucas
+      Mason
+      Logan
+      Alexander
+      Ethan
+      Jacob
+      Michael
+      Daniel
+      Henry
+      Jackson
+      Sebastian
+      Aiden
+      Matthew
+      Samuel
+      David
+      Joseph
+      Carter
+      Owen
+      Wyatt
+      John
+      Jack
+      Luke
+      Jayden
+      Dylan
+      Grayson
+      Levi
+      Isaac
+      Gabriel
+      Julian
+      Mateo
+      Anthony
+      Jaxon
+      Lincoln
+      Joshua
+      Christopher
+      Andrew
+      Theodore
+      Caleb
+      Ryan
+      Asher
+      Nathan
+      Thomas
+      Leo
+      Isaiah
+      Charles
+      Josiah
+      Hudson
+      Christian
+      Hunter
+      Connor
+      Eli
+      Ezra
+      Aaron
+      Landon
+      Adrian
+      Jonathan
+      Nolan
+      Jeremiah
+      Easton
+      Elias
+      Colton
+      Cameron
+      Carson
+      Robert
+      Angel
+      Maverick
+      Nicholas
+      Dominic
+      Jaxson
+      Greyson
+      Adam
+      Ian
+      Austin
+      Santiago
+      Jordan
+      Cooper
+      Brayden
+      Roman
+      Evan
+      Ezekiel
+      Xaviar
+      Jose
+      Jace
+      Jameson
+      Leonardo
+      Axel
+      Everett
+      Kayden
+      Miles
+      Sawyer
+      Jason
+      Emma
+      Olivia
+    ]
+    NAMES_LAST = %w[
+      Smith
+      Johnson
+      Williams
+      Brown
+      Jones
+      Miller
+      Davis
+      Wilson
+      Anderson
+      Taylor
+    ]
+    def initialize(contacts = nil)
+      @contacts = contacts || 100.times.map do |n|
+        random_first_name_index = (rand*NAMES_FIRST.size).to_i
+        random_last_name_index = (rand*NAMES_LAST.size).to_i
+        first_name = NAMES_FIRST[random_first_name_index]
+        last_name = NAMES_LAST[random_last_name_index]
+        email = "#{first_name}@#{last_name}.com".downcase
+        Contact.new(
+          first_name: first_name,
+          last_name: last_name,
+          email: email
+        )
+      end
+    end
+  
+    def find(attribute_filter_map)
+      @contacts.find_all do |contact|
+        match = true
+        attribute_filter_map.keys.each do |attribute_name|
+          contact_value = contact.send(attribute_name).downcase
+          filter_value = attribute_filter_map[attribute_name].downcase
+          match = false unless contact_value.match(filter_value)
+        end
+        match
+      end
+    end
+  end
+end
+
+class ContactManager
+  class ContactManagerPresenter
+    attr_accessor :results
+    @@contact_attributes = [:first_name, :last_name, :email]
+    @@contact_attributes.each {|attribute_name| attr_accessor attribute_name}
+  
+    def initialize(contact_repository = nil)
+      @contact_repository = contact_repository || ContactRepository.new
+      @results = []
+    end
+  
+    def list
+      self.results = @contact_repository.find({})
+    end
+  
+    def find
+      filter_map = {}
+      @@contact_attributes.each do |attribute_name|
+        filter_map[attribute_name] = self.send(attribute_name) if self.send(attribute_name)
+      end
+      self.results = @contact_repository.find(filter_map)
+      @sort_attribute_name = nil
+      @sort_direction_ascending = nil
+    end
+  
+    def toggle_sort(attribute_name)
+      @sort_attribute_name = attribute_name
+      @sort_direction_ascending = !@sort_direction_ascending
+      sorted_results = self.results.sort_by {|contact| contact.send(attribute_name).downcase}
+      sorted_results = sorted_results.reverse unless @sort_direction_ascending
+      self.results = sorted_results
+    end
+  end
+end
+
+class ContactManager
+  include Glimmer
+
+  def initialize
+    @contact_manager_presenter = ContactManagerPresenter.new
+    @contact_manager_presenter.list
+  end
+
+  def launch
+    shell {
+      text "Contact Manager"
+      composite {
+        composite {
+          grid_layout 2, false
+          label {text "First &Name: "}
+          text {
+            text bind(@contact_manager_presenter, :first_name)
+            on_key_pressed {|key_event|
+              @contact_manager_presenter.find if key_event.keyCode == Glimmer::SWT::SWTProxy[:cr]
+            }
+          }
+          label {text "&Last Name: "}
+          text {
+            text bind(@contact_manager_presenter, :last_name)
+            on_key_pressed {|key_event|
+              @contact_manager_presenter.find if key_event.keyCode == Glimmer::SWT::SWTProxy[:cr]
+            }
+          }
+          label {text "&Email: "}
+          text {
+            text bind(@contact_manager_presenter, :email)
+            on_key_pressed {|key_event|
+              @contact_manager_presenter.find if key_event.keyCode == Glimmer::SWT::SWTProxy[:cr]
+            }
+          }
+          composite {
+            grid_layout 2, false
+            button {
+              text "&Find"
+              on_widget_selected {
+                @contact_manager_presenter.find
+              }
+            }
+            button {
+              text "&List All"
+              on_widget_selected {
+                @contact_manager_presenter.list
+              }
+            }
+          }
+        }
+
+        table(:multi) { |table_proxy|
+          layout_data {
+            horizontal_alignment :fill
+            vertical_alignment :fill
+            grab_excess_horizontal_space true
+            grab_excess_vertical_space true
+            height_hint 200
+          }
+          table_column {
+            text "First Name"
+            width 80
+            on_widget_selected {
+              @contact_manager_presenter.toggle_sort(:first_name)
+            }
+          }
+          table_column {
+            text "Last Name"
+            width 80
+            on_widget_selected {
+              @contact_manager_presenter.toggle_sort(:last_name)
+            }
+          }
+          table_column {
+            text "Email"
+            width 200
+            on_widget_selected {
+              @contact_manager_presenter.toggle_sort(:email)
+            }
+          }
+          items bind(@contact_manager_presenter, :results), column_properties(:first_name, :last_name, :email)
+          on_mouse_down { |event|
+            table_proxy.edit_table_item(event.table_item, event.column_index)
+          }
+        }
+      }
+    }.open
+  end
+end
+
+ContactManager.new.launch
+
+```
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+Glimmer DSL for SWT Contact Manager
+
+![Glimmer DSL for SWT Contact Manager](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-contact-manager.png)
+
+Glimmer DSL for SWT Contact Manager Find
+
+![Glimmer DSL for SWT Contact Manager Find](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-contact-manager-find.png)
+
+Glimmer DSL for SWT Contact Manager Edit Started
+
+![Glimmer DSL for SWT Contact Manager Edit Started](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-contact-manager-edit-started.png)
+
+Glimmer DSL for SWT Contact Manager Edit In Progress
+
+![Glimmer DSL for SWT Contact Manager Edit In Progress](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-contact-manager-edit-in-progress.png)
+
+Glimmer DSL for SWT Contact Manager Edit Done
+
+![Glimmer DSL for SWT Contact Manager Edit Done](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-contact-manager-edit-done.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Tic Tac Toe"
+
+Glimmer DSL for Opal Contact Manager
+
+![Glimmer DSL for Opal Contact Manager](images/glimmer-dsl-opal-contact-manager.png)
+
+Glimmer DSL for Opal Contact Manager Find
+
+![Glimmer DSL for Opal Contact Manager Find](images/glimmer-dsl-opal-contact-manager-find.png)
+
+Glimmer DSL for Opal Contact Manager Edit Started
+
+![Glimmer DSL for Opal Contact Manager Edit Started](images/glimmer-dsl-opal-contact-manager-edit-started.png)
+
+Glimmer DSL for Opal Contact Manager Edit In Progress
+
+![Glimmer DSL for Opal Contact Manager Edit In Progress](images/glimmer-dsl-opal-contact-manager-edit-in-progress.png)
+
+Glimmer DSL for Opal Contact Manager Edit Done
+
+![Glimmer DSL for Opal Contact Manager Edit Done](images/glimmer-dsl-opal-contact-manager-edit-done.png)
+
 ## Help
 
 ### Issues
@@ -514,5 +1429,11 @@ These features have been suggested. You might see them in a future version of Gl
 
 ## License
 
-Copyright (c) 2020 Andy Maleh.
-See LICENSE.txt for further details.
+[MIT](https://opensource.org/licenses/MIT)
+
+Copyright (c) 2020 - Andy Maleh. 
+See [LICENSE.txt](LICENSE.txt) for further details.
+
+--
+
+[<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 />](https://github.com/AndyObtiva/glimmer) Built for [Glimmer](https://github.com/AndyObtiva/glimmer) (Ruby Desktop Development GUI Library).