glimmer-dsl-opal 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c18e541c8e9442edb881c4a2209b920ec5891c770901cd4474d93875d6a9d785
-  data.tar.gz: aadee7ddedd9a598e32784105d408b619c8503ef7aeb58d18253d1a505115e8a
+  metadata.gz: 97eeea7b6d32426394bf3cb88a2a3cf8d7e8559913bda30fd70e002ea99ec803
+  data.tar.gz: 3a23091312b5279776f5c287554de323007c72a5e4f754fe6d0716090777e8c8
 SHA512:
-  metadata.gz: 3d0efad3abf372c53a9f214fe6e9ad2a9b4a4f18413acded585411742f1eb0fdd3dff3939bb2e64e905f55c59c5c0c686e7715fd2f01ed70c7f6a4005e67ac3a
-  data.tar.gz: 247c8c74ca777009bee85b89eb8ba137d5a389a55cb6f845f70d49b6b331184e625196c9dd1b07797730bc1c853ba87f7eae437356ef2e56fa26240854d5c706
+  metadata.gz: 1b6b902e2e66ef6c65ef4c007acaf812e3cfb10f20b5ef4e1d72e995dc252a809c892eb22d24b83e95d5587ab9b6b135a6e92e748869905abcf02915a224ab29
+  data.tar.gz: 1cbee2b67c0d8b3fcb18a95dbe0db665b8c179fb1561c3c0c1f404b4f66bc5e7a46e1c7553e62099f88b8ef3f68dca7512f20cb2be744c4f137beda6294bed77

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 0.8.0
+
+- Hello, Pop Up Context Menu! Sample
+- Hello Message Box!
+- Update hello list samples
+- Support context menus `menu`/`menu_item` directly under a widget (using jQuery UI)
+- Support generating new lines when entering `label` `text` with \n (auto-converting to <br />)
+- Support generating new lines when entering `message_box` `message` with \n (auto-converting to <br />)
+- Support having any widget contribute static CSS to ShellProxy
+- Add Kernel#include_package shim to allow running JRuby include_package from Glimmer DSL for SWT without failing
+- Add WidgetProxy#swt_widget to allow running include_package from Glimmer DSL for SWT without failing
+
 ## 0.7.5
 
 - Update login sample from Glimmer DSL for SWT's latest changes

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Opal 0.7.5 (Pure Ruby Web GUI)
+# [<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.8.0 (Pure Ruby Web GUI)
 [![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)
 
@@ -58,7 +58,9 @@ Tic Tac Toe on the desktop with the same exact code (using the [glimmer-dsl-swt]
 ![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)
 
-NOTE: **Alpha Version** 0.7.5 only supports bare-minimum capabilities for the following [samples](https://github.com/AndyObtiva/glimmer-dsl-opal#samples) (originally made for [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt)):
+NOTE: Glimmer DSL for Opal is an alpha project. Please help make better by contributing, adopting for small or low risk projects, and providing feedback. It is still an early alpha, so the more feedback and issues you report the better.
+
+**Alpha Version** 0.8.0 only supports bare-minimum capabilities for the following [samples](https://github.com/AndyObtiva/glimmer-dsl-opal#samples) (originally written in [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt)):
 
 [Hello samples](#hello-samples):
 
@@ -79,6 +81,8 @@ NOTE: **Alpha Version** 0.7.5 only supports bare-minimum capabilities for the fo
 - [Hello, Date Time!](#hello-date-time)
 - [Hello, Table!](#hello-table)
 - [Hello, Button!](#hello-button)
+- [Hello, Message Box!](#hello-message-box)
+- [Hello, Pop Up Context Menu!](#hello-pop-up-context-menu)
 
 [Elaborate samples](#elaborate-samples):
 
@@ -101,17 +105,31 @@ Other [Glimmer](https://github.com/AndyObtiva/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`
 - `button`
-- `text`
+- `browser`
+- `calendar`
+- `checkbox`
+- `checkbox_group`
+- `combo`
 - `composite`
-- `list` & `list(:multi)`
+- `date`
+- `date_drop_down`
+- `group`
+- `label`
+- `list` (w/ optional `:multi` SWT style)
+- `menu`
+- `menu_item`
+- `message_box`
+- `radio`
+- `radio_group`
+- `scrolled_composite`
+- `shell`
 - `tab_folder`
 - `tab_item`
 - `table`
 - `table_column`
+- `text`
+- `time`
 - `message_box`
 - Glimmer::UI::CustomWidget: ability to define any keyword as a custom widget
 - Glimmer::UI::CustomShell: ability to define any keyword as a custom shell (aka custom window) that opens in a new browser window (tab) automatically unless there is no shell open in the current browser window (tab)
@@ -122,15 +140,21 @@ Layouts:
 - `fill_layout`
 - `layout_data`
 
-Graphics:
+Graphics/Style:
 - `color`
 - `font`
+- `Point` class used in setting location on widgets
+- `swt` and `SWT` class to set SWT styles on widgets
 
 Data-Binding/Observers:
 - `bind`
 - `observe`
 - `on_widget_selected`
 - `on_modify_text`
+- `on_key_pressed` (and SWT alias `on_swt_keydown`)
+- `on_key_released` (and SWT alias `on_swt_keyup`)
+- `on_mouse_down` (and SWT alias `on_swt_mousedown`)
+- `on_mouse_up` (and SWT alias `on_swt_mouseup`)
 
 Event loop:
 - `display`
@@ -138,9 +162,10 @@ Event loop:
 
 ## Principles
 
-- **Live purely in Rubyland via the Glimmer GUI DSL**, completely oblivious to web browser technologies.
+- **Live purely in Rubyland via the Glimmer GUI DSL**, completely oblivious to inferior web browser technologies.
 - **Forget Routers!** Glimmer DSL for Opal supports auto-routing of custom shells (windows), which are opened as separate tabs in a web browser with automatically generated routes and bookmarkable URLs.
-- **HTML is strictly made for creating documents not interactive applications**. As such, software engineers can avoid it and focus on creating web applications more productively with Glimmer DSL for Opal in pure Ruby (just like they do in desktop development) while content creators and web designers can be the ones responsible for creating HTML documents for web content purposes only as HTML was originally intended. Web designers may also style Glimmer DSL for Opal applications since they auto-generate symantic markup. That way, Glimmer web GUI is used and embedded in web pages that provide users with applications while the rest of the web pages are maintained by non-engineers. This achieves a correct separation of responsibilities and better productivity and maintainability.
+- **HTML is strictly made for creating documents not interactive applications**. As such, software engineers can avoid it and focus on creating web applications more productively with Glimmer DSL for Opal in pure Ruby instead (just like they do in desktop development) while content creators and web designers can be the ones responsible for creating HTML documents for web content purposes only as HTML was originally intended. That way, Glimmer web GUI is used and embedded in web pages when providing users with applications while the rest of the web pages are maintained by non-engineers as pure HTML. This achieves a correct separation of responsibilities and better productivity and maintainability.
+- **Approximate styles by developers via the Glimmer GUI DSL. Perfect styles by designers via pure CSS**. Developers can simply build GUI with approximate styling similar to desktop GUI without worrying about pixel-perfect aethetics. Web designers can take styling further with pure CSS since every HTML element auto-generated by Glimmer DSL for Opal has a predictable ID and CSS class. This achieves a proper separation of responsibilities between developers and designers.
 - **Web servers are used just like servers in traditional client/server architecture**, meaning they simply provide RMI services to enable centralizing some of the application logic and data in the cloud to make available everywhere and enable data-sharing with others.
 
 ## Background
@@ -187,7 +212,7 @@ Add the following to `Gemfile`:
 gem 'opal-rails', '~> 1.1.2'
 gem 'opal-async', '~> 1.2.0'
 gem 'opal-jquery', '~> 0.4.4'
-gem 'glimmer-dsl-opal', '~> 0.7.5'
+gem 'glimmer-dsl-opal', '~> 0.8.0'
 gem 'glimmer-dsl-xml', '~> 1.1.0', require: false
 gem 'glimmer-dsl-css', '~> 1.1.0', require: false
 
@@ -256,7 +281,9 @@ end
 
 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)
 
-The [Hello samples](#hello-samples) demonstrate tiny building blocks for building full fledged applications. The [Elaborate samples](#elaborate-samples) demonstrate more advanced sample applications that assemble multiple building blocks.
+The [Hello samples](#hello-samples) demonstrate tiny building blocks (widgets) for building full fledged applications.
+
+The [Elaborate samples](#elaborate-samples) demonstrate more advanced sample applications that assemble multiple building blocks.
 
 This external sample app contains all the samples mentioned below configured inside a Rails [Opal](https://opalrb.com/) app with all the pre-requisites ready to go for convenience:
 
@@ -1961,6 +1988,149 @@ You should see "Hello, Button!"
 ![Glimmer DSL for Opal Hello Button](images/glimmer-dsl-opal-hello-button.png)
 ![Glimmer DSL for Opal Hello Button](images/glimmer-dsl-opal-hello-button-incremented.png)
 
+#### Hello, Message Box!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_message_box'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
+
+```ruby
+include Glimmer
+
+shell {
+  text 'Hello, Message Box!'
+  
+  button {
+    text 'Please Click To Win a Surprise'
+    
+    on_widget_selected {
+      message_box {
+        text 'Surprise'
+        message "Congratulations!\n\nYou won $1,000,000!"
+      }.open
+    }
+  }
+}.open
+```
+
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Message Box](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-message-box.png)
+![Glimmer DSL for SWT Message Box Dialog](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-message-box-dialog.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Hello, Message Box!"
+
+![Glimmer DSL for Opal Hello Message Box](images/glimmer-dsl-opal-hello-message-box.png)
+![Glimmer DSL for Opal Hello Message Box Dialog](images/glimmer-dsl-opal-hello-message-box-dialog.png)
+
+#### Hello, Pop Up Context Menu!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_pop_up_context_menu'
+```
+
+Or add the Glimmer code directly if you prefer to play around with it:
+
+```ruby
+include Glimmer
+
+shell {
+  grid_layout {
+    margin_width 0
+    margin_height 0
+  }
+  
+  text 'Hello, Pop Up Context Menu!'
+  
+  label {
+    text "Right-Click on the Text to\nPop Up a Context Menu"
+    font height: 50
+    
+    menu {
+      menu {
+        text '&History'
+        menu {
+          text '&Recent'
+          menu_item {
+            text 'File 1'
+            on_widget_selected {
+              message_box {
+                text 'File 1'
+                message 'File 1 Contents'
+              }.open
+            }
+          }
+          menu_item {
+            text 'File 2'
+            on_widget_selected {
+              message_box {
+                text 'File 2'
+                message 'File 2 Contents'
+              }.open
+            }
+          }
+        }
+        menu {
+          text '&Archived'
+          menu_item {
+            text 'File 3'
+            on_widget_selected {
+              message_box {
+                text 'File 3'
+                message 'File 3 Contents'
+              }.open
+            }
+          }
+          menu_item {
+            text 'File 4'
+            on_widget_selected {
+              message_box {
+                text 'File 4'
+                message 'File 4 Contents'
+              }.open
+            }
+          }
+        }
+      }
+    }
+  }
+}.open
+```
+
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Hello Pop Up Context Menu Popped Up](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-pop-up-context-menu.png)
+![Glimmer DSL for SWT Hello Pop Up Context Menu](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-pop-up-context-menu-popped-up.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Hello, Pop Up Context Menu!"
+
+![Glimmer DSL for Opal Hello Pop Up Context Menu](images/glimmer-dsl-opal-hello-pop-up-context-menu.png)
+![Glimmer DSL for Opal Hello Pop Up Context Menu Popped Up](images/glimmer-dsl-opal-hello-pop-up-context-menu-popped-up.png)
+
 
 ### Elaborate Samples
 

data/VERSION

@@ -1 +1 @@
-0.7.5
+0.8.0

data/lib/glimmer-dsl-opal.rb

@@ -33,6 +33,11 @@ if RUBY_ENGINE == 'opal'
   # TODO look into making append_path work (causing some trouble right now)
 #   Opal.append_path File.expand_path('../glimmer-dsl-opal/missing', __FILE__)
 #   Opal.append_path GLIMMER_DSL_OPAL_MISSING
+  module Kernel
+    def include_package(package)
+      # No Op (just a shim)
+    end
+  end
   
   require 'opal-parser'
   require 'native' # move this to opal-async
@@ -49,8 +54,11 @@ if RUBY_ENGINE == 'opal'
 #   require 'glimmer-dsl-opal/vendor/jquery-ui/jquery-ui.structure.min.css'
 #   require 'glimmer-dsl-opal/vendor/jquery-ui/jquery-ui.theme.min.css'
   require 'opal-jquery'
+  require 'opal/jquery/local_storage'
  
   require 'facets/hash/symbolize_keys'
+  require 'glimmer-dsl-opal/ext/class'
+  require 'glimmer-dsl-opal/ext/file'
   require 'glimmer-dsl-opal/ext/struct'
   require 'glimmer'
   require 'glimmer-dsl-opal/ext/exception'

data/lib/glimmer-dsl-opal/ext/class.rb

@@ -0,0 +1,10 @@
+class Class
+  def inherited(klass)
+    @descendants ||= []
+    @descendants << klass
+  end
+  
+  def descendants
+    @descendants.to_collection.map { |klass| [klass] + (klass.descendants if klass.respond_to?(:descendants)).to_a }.flatten.compact
+  end
+end

data/lib/glimmer-dsl-opal/samples/hello/hello_browser.rb

@@ -1,7 +1,30 @@
+# Copyright (c) 2020 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 include Glimmer
 
 shell {
+  text 'Hello, Browser!'
   minimum_size 1024, 860
+  
   browser {
     url 'https://brightonresort.com/about'
   }

data/lib/glimmer-dsl-opal/samples/hello/hello_computed.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2020 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 require_relative 'hello_computed/contact'
 
 class HelloComputed
@@ -14,6 +35,7 @@ class HelloComputed
   def launch
     shell {
       text 'Hello, Computed!'
+      
       composite {
         grid_layout {
           num_columns 2
@@ -21,6 +43,7 @@ class HelloComputed
           horizontal_spacing 20
           vertical_spacing 10
         }
+        
         label {text 'First &Name: '}
         text {
           text bind(@contact, :first_name)
@@ -29,6 +52,7 @@ class HelloComputed
             grab_excess_horizontal_space true
           }
         }
+        
         label {text '&Last Name: '}
         text {
           text bind(@contact, :last_name)
@@ -37,6 +61,7 @@ class HelloComputed
             grab_excess_horizontal_space true
           }
         }
+        
         label {text '&Year of Birth: '}
         text {
           text bind(@contact, :year_of_birth)
@@ -45,6 +70,7 @@ class HelloComputed
             grab_excess_horizontal_space true
           }
         }
+        
         label {text 'Name: '}
         label {
           text bind(@contact, :name, computed_by: [:first_name, :last_name])
@@ -53,6 +79,7 @@ class HelloComputed
             grab_excess_horizontal_space true
           }
         }
+        
         label {text 'Age: '}
         label {
           text bind(@contact, :age, on_write: :to_i, computed_by: [:year_of_birth])

data/lib/glimmer-dsl-opal/samples/hello/hello_list_multi_selection.rb

@@ -1,41 +1,71 @@
-class Person
-  attr_accessor :provinces, :provinces_options
-
-  def initialize
-    self.provinces_options=[
-      "",
-      "Quebec",
-      "Ontario",
-      "Manitoba",
-      "Saskatchewan",
-      "Alberta",
-      "British Columbia",
-      "Nova Skotia",
-      "Newfoundland"
-    ]
-    self.provinces = ["Quebec", "Manitoba", "Alberta"]
-  end
-
-  def reset_provinces
-    self.provinces = ["Quebec", "Manitoba", "Alberta"]
-  end
-end
+# Copyright (c) 2020 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 class HelloListMultiSelection
+  class Person
+    attr_accessor :provinces, :provinces_options
+  
+    def initialize
+      self.provinces_options = [
+        '',
+        'Alberta',
+        'British Columbia',
+        'Manitoba',
+        'New Brunswick',
+        'Newfoundland and Labrador',
+        'Northwest Territories',
+        'Nova Scotia',
+        'Nunavut',
+        'Ontario',
+        'Prince Edward Island',
+        'Quebec',
+        'Saskatchewan',
+        'Yukon'
+      ]
+      reset_provinces
+    end
+  
+    def reset_provinces
+      self.provinces = ['Quebec', 'Manitoba', 'Alberta']
+    end
+  end
+  
   include Glimmer
+  
   def launch
     person = Person.new
+    
     shell {
-      composite {
-        list(:multi) {
-          selection bind(person, :provinces)
-        }
-        button {
-          text "Reset"
-          on_widget_selected do
-            person.reset_provinces
-          end
-        }
+      grid_layout
+      
+      text 'Hello, List Multi Selection!'
+      
+      list(:multi) {
+        selection bind(person, :provinces)
+      }
+      
+      button {
+        text 'Reset Selections To Default Values'
+        
+        on_widget_selected { person.reset_provinces }
       }
     }.open
   end