glimmer-dsl-opal 0.25.4 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d82f0649f5baefa289ee1facb6102608e4d84e5a98e84a775ab1112f1698cc3d
-  data.tar.gz: da29c7ccd153e217867d2dd47afc7611311d79511461bb9395529a6561551cca
+  metadata.gz: 0deb6c6d04586f92d01c22a4228072fcfa145359121f33d92265c580fc1abd91
+  data.tar.gz: fc11c74ce51115dc92548debd2bf3a1d590ba638915de71f33455ee62a82c5fb
 SHA512:
-  metadata.gz: 427deabace568823bb59fc9e09dbbbdc7c37c22c25dd131daa41fa61a88cc61a7cc746480d733b2862055fe798a05728ca1a809bacba839068ae346f9ce005da
-  data.tar.gz: bf34f31729b7c49c25442f12292042c92faf9eeb97e02582d87ad25f548a201ba574af4d00d5280166235c157509b95c2e5412a9e06f3f3924ea2738c6a3555a
+  metadata.gz: e7849b84f8ee8c749c69636abbe7490a3ac2585957fa7c526b1a2a322eb40d7d1bfdba66e344c8f1f3b76095fb1a2ed5210ae62c08db093828be823f10fd9e33
+  data.tar.gz: 12125b86cdd30f321311e3909b8f50e4383eb2fea2938b4983d02a5860f0d3a056d50dce9d94abe7a68f557d1c374d998e3fcfb25de90edc1d3b936cc033f1b6

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Change Log
 
+## 0.26.0
+
+- Tetris elaborate sample (minimal initial version of the one in Glimmer DSL for SWT)
+- Support `menu_item` `selection` attribute data-binding for `:check` and `:radio` SWT styles
+- Set 'custom_shell' data for custom shell on its body_root
+- Provide parent_proxy on custom widgets as an alternative to parent for compatibility with Glimmer DSL for SWT
+- Have custom widgets derive their parent from body root if not passed in explicitly
+
 ## 0.25.4
 
-- Upgrade to opal-async 1.4.0 
+- Upgrade to opal-async 1.4.0
 - Update Hello, Custom Widget! to utilize `Array#async_cycle` instead of `Array#cycle`
 
 ## 0.25.3

data/README.md

@@ -196,6 +196,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
     - [Elaborate Samples](#elaborate-samples)
       - [Login](#login)
       - [Contact Manager](#contact-manager)
+      - [Tetris](#tetris)
       - [Tic Tac Toe](#tic-tac-toe)
       - [User Profile](#user-profile)
       - [Weather](#weather)
@@ -235,7 +236,7 @@ Alternatively, web developers may directly use [Glimmer DSL for Opal](https://ru
 ## Pre-requisites
 
 - Rails 5.2: [https://github.com/rails/rails/tree/5-2-stable](https://github.com/rails/rails/tree/5-2-stable)
-- Opal 1.0.4: [https://github.com/opal/opal](https://github.com/opal/opal)
+- Opal 1.0.5: [https://github.com/opal/opal](https://github.com/opal/opal)
 - Opal-Rails 1.1.2: [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)
 - jQuery-UI 1.12: [https://code.jquery.com/](https://jqueryui.com/) (jQuery-UI 1.12.1 is included in the [glimmer-dsl-opal](https://rubygems.org/gems/glimmer-dsl-opal) gem)
@@ -252,7 +253,7 @@ Please follow the following steps to setup.
 Install a Rails 5 gem:
 
 ```
-gem install rails -v5.2.4.4
+gem install rails -v5.2.6
 ```
 
 Start a new Rails 5 app:
@@ -264,7 +265,7 @@ rails new glimmer_app_server
 Add the following to `Gemfile`:
 
 ```
-gem 'opal', '1.0.4'
+gem 'opal', '1.0.5'
 gem 'opal-rails', '1.1.2'
 gem 'opal-async', '~> 1.4.0'
 gem 'opal-jquery', '~> 0.4.4'
@@ -2584,6 +2585,40 @@ 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)
 
+#### Tetris
+
+This is a minimal initial version of the [Tetris seen in Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/docs/reference/GLIMMER_SAMPLES.md#glimmer-tetris).
+
+Note that while the Glimmer GUI DSL code is mostly the same, some of the behavioral code around threads is changed
+into async Opal code via the [opal-async](https://github.com/AndyObtiva/opal-async) gem due to the async nature of transpiled JavaScript.
+
+Still, this sample has done the remarkable feat of reusing all of the Tetris model/view logic from Glimmer DSL for SWT mostly unchanged.
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/elaborate/tetris'
+```
+
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Tetris](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-tetris.png)
+
+Glimmer app on the web (using `glimmer-dsl-opal` gem):
+
+Start the Rails server:
+```
+rails s
+```
+
+Visit `http://localhost:3000`
+
+You should see "Tetris" (a minimal version of the one in Glimmer DSL for SWT)
+
+![Glimmer DSL for Opal Tetris](images/glimmer-dsl-opal-tetris.png)
+
+![Glimmer DSL for Opal Tetris Video](images/glimmer-dsl-opal-tetris.gif)
+
 #### Tic Tac Toe
 
 Add the following require statement to `app/assets/javascripts/application.rb`

data/VERSION

@@ -1 +1 @@
-0.25.4
+0.26.0

data/lib/glimmer/dsl/opal/menu_expression.rb

@@ -37,9 +37,6 @@ module Glimmer
             if parent.is_a?(Glimmer::SWT::WidgetProxy)
               return true
             else
-              puts 'parent'
-              puts parent.class
-              puts parent
               raise Glimmer::Error, "menu may only be nested under a widget (like shell or another menu)!"
             end
           end

data/lib/glimmer/swt/control_editor.rb

@@ -27,8 +27,8 @@ module Glimmer
       ATTRIBUTES = [:grabHorizontal, :grabVertical, :horizontalAlignment, :verticalAlignment, :minimumWidth, :minimumHeight]
       attr_accessor(*ATTRIBUTES)
       ATTRIBUTES.each do |attribute|
-        alias_method attribute.underscore, attribute
-        alias_method "#{attribute.underscore}=", "#{attribute}="
+        alias_method attribute.to_s.underscore, attribute
+        alias_method "#{attribute.to_s.underscore}=", "#{attribute}="
       end
       
       # TODO consider supporting a java_attr_accessor to get around having to generate all the aliases manually

data/lib/glimmer/swt/dialog_proxy.rb

@@ -19,12 +19,13 @@
 # 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 'glimmer/swt/widget_proxy'
 require 'glimmer/swt/display_proxy'
+require 'glimmer/swt/widget_proxy'
+require 'glimmer/swt/shell_proxy'
 
 module Glimmer
   module SWT
-    class DialogProxy < CompositeProxy
+    class DialogProxy < ShellProxy
       STYLE = <<~CSS
         .ui-dialog .ui-dialog-content {
           background: rgb(235, 235, 235);
@@ -86,7 +87,7 @@ module Glimmer
         @open
       end
       
-      def open
+      def open(async: true)
         owned_proc = Glimmer::Util::ProcTracker.new(owner: self, invoked_from: :open) {
           shell.open(async: false) unless shell.open?
           unless @init
@@ -113,8 +114,13 @@ module Glimmer
             dom_element.dialog('open')
           end
           @open = true
+          listeners_for('swt_show').each {|listener| listener.call(Event.new(widget: self))}
         }
-        DisplayProxy.instance.async_exec(owned_proc)
+        if async
+          DisplayProxy.instance.async_exec(owned_proc)
+        else
+          owned_proc.call
+        end
       end
       
       def hide
@@ -129,6 +135,7 @@ module Glimmer
         dom_element.remove
         @open = false
         @init = false
+        listeners_for('swt_close').each {|listener| listener.call(Event.new(widget: self))}
         Element['.dialog-overlay'].add_class('hide') unless DisplayProxy.instance.dialogs.any?(&:open?)
         parent.children.delete(self)
         shell.close if shell.children.empty?

data/lib/glimmer/swt/display_proxy.rb

@@ -97,6 +97,7 @@ module Glimmer
                   end
                   event.define_singleton_method(:keyCode) {event.which}
                   event.define_singleton_method(:key_code, &event.method(:keyCode))
+                  # TODO support alt/ctrl/shift/command & arrow keys in keyCode
                   event.define_singleton_method(:character) {event.which.chr}
                   event.define_singleton_method(:stateMask) do
                     state_mask = 0
@@ -135,6 +136,7 @@ module Glimmer
                   end
                   event.define_singleton_method(:keyCode) {event.which}
                   event.define_singleton_method(:key_code, &event.method(:keyCode))
+                  # TODO support alt/ctrl/shift/command & arrow keys in keyCode
                   event.define_singleton_method(:character) {event.which.chr}
                   event.define_singleton_method(:stateMask) do
                     state_mask = 0

data/lib/glimmer/swt/shell_proxy.rb

@@ -69,6 +69,7 @@ module Glimmer
       HEIGHT_MIN = 0
       
       def initialize(args)
+        # TODO set parent
         @args = args
         @children = []
         render # TODO attach to specific element
@@ -78,7 +79,7 @@ module Glimmer
         self.minimum_size = Point.new(WIDTH_MIN, HEIGHT_MIN)
         DisplayProxy.instance.shells << self
       end
-      
+              
       def post_add_content
         `$( document ).tooltip()`
       end
@@ -128,6 +129,16 @@ module Glimmer
         dom_element.css('min-height', "#{@minimum_size.y}px")
       end
       
+      def handle_observation_request(keyword, original_event_listener)
+        case keyword
+        when 'on_swt_show', 'on_swt_close', 'on_shell_closed'
+          keyword = 'on_swt_close' if keyword == 'on_shell_closed'
+          listeners_for(keyword.sub(/^on_/, '')) << original_event_listener.to_proc
+        else
+          super(keyword, original_event_listener)
+        end
+      end
+      
       def style_dom_css
         <<~CSS
           .hide {
@@ -169,6 +180,7 @@ module Glimmer
             DisplayProxy.instance.shells.select(&:open?).reject {|s| s == self}.map(&:hide)
             dom_element.remove_class('hide')
             @open = true
+            listeners_for('swt_show').each {|listener| listener.call(Event.new(widget: self))}
           end
         end
         if async
@@ -177,6 +189,7 @@ module Glimmer
           work.call
         end
       end
+      alias show open
       
       def hide
         dom_element.add_class('hide')
@@ -187,11 +200,25 @@ module Glimmer
         DisplayProxy.instance.shells.delete(self)
         dom_element.remove
         @open = false
+        listeners_for('swt_close').each {|listener| listener.call(Event.new(widget: self))}
       end
       
       def open?
         @open
       end
+      
+      def visible
+        @open
+      end
+      alias visible? visible
+      
+      def visible=(value)
+        if value
+          show(async: false)
+        else
+          hide
+        end
+      end
     end
   end
 end

data/lib/glimmer/swt/table_item_proxy.rb

@@ -59,26 +59,6 @@ module Glimmer
         @text_array ||= []
       end
 
-      def get_data(key = nil)
-        if key.nil?
-          @data
-        else
-          data_hash[key]
-        end
-      end
-      
-      def set_data(key = nil, data_value)
-        if key.nil?
-          @data = data_value
-        else
-          data_hash[key] = data_value
-        end
-      end
-      
-      def data_hash
-        @data_hash ||= {}
-      end
-      
       def parent_path
         parent.items_path
       end

data/lib/glimmer/swt/table_proxy.rb

@@ -61,6 +61,10 @@ module Glimmer
                   on_focus_lost {
                     table_proxy.finish_edit!
                   }
+                  on_modify_text do |event|
+                    # No Op, just record @text changes on key up
+                    # TODO find a better solution than this in the future
+                  end
                   on_key_pressed { |key_event|
                     if key_event.keyCode == swt(:cr)
                       table_proxy.finish_edit!

data/lib/glimmer/swt/widget_proxy.rb

@@ -31,6 +31,8 @@ module Glimmer
       include Glimmer
       include PropertyOwner
       
+      Event = Struct.new(:widget, keyword_init: true)
+      
       SWT_CURSOR_TO_CSS_CURSOR_MAP = {
         wait: 'wait',
         sizenwse: 'nwse-resize',
@@ -140,7 +142,6 @@ module Glimmer
         # TODO consider changing children to an array (why is it a Set if order matters?)
         @children = Set.new # TODO consider moving to composite
         @enabled = true
-        @data = {}
         DEFAULT_INITIALIZERS[self.class.underscored_widget_name(self).to_s.to_sym]&.call(self)
         @parent.post_initialize_child(self) # TODO rename to post_initialize_child to be closer to glimmer-dsl-swt terminology
       end
@@ -172,18 +173,30 @@ module Glimmer
         end
       end
       
-      def set_data(key=nil, value)
-        @data[key] = value
+      def set_data(key = nil, value)
+        if key.nil?
+          @data = value
+        else
+          swt_data[key] = value
+        end
       end
       alias setData set_data
       alias data= set_data
       
-      def get_data(key=nil)
-        @data[key]
+      def get_data(key = nil)
+        if key.nil?
+          @data
+        else
+          swt_data[key]
+        end
       end
       alias getData get_data
       alias data get_data
       
+      def swt_data
+        @swt_data ||= {}
+      end
+      
       def css_classes
         dom_element.attr('class').to_s.split
       end
@@ -192,9 +205,9 @@ module Glimmer
         remove_all_listeners
         Document.find(path).remove
         parent&.post_dispose_child(self)
-        # TODO fire on_widget_disposed listener
 #         children.each(:dispose) # TODO enable this safely
         @disposed = true
+        listeners_for('widget_disposed').each {|listener| listener.call(Event.new(widget: self))}
       end
       
       def remove_all_listeners
@@ -733,6 +746,14 @@ module Glimmer
         @event_handling_suspended
       end
       
+      def listeners
+        @listeners ||= {}
+      end
+      
+      def listeners_for(listener_event)
+        listeners[listener_event.to_s] ||= []
+      end
+      
       def can_handle_observation_request?(observation_request)
         # TODO sort this out for Opal
         observation_request = observation_request.to_s
@@ -747,6 +768,15 @@ module Glimmer
       end
       
       def handle_observation_request(keyword, original_event_listener)
+        case keyword
+        when 'on_widget_disposed'
+          listeners_for(keyword.sub(/^on_/, '')) << original_event_listener.to_proc
+        else
+          handle_javascript_observation_request(keyword, original_event_listener)
+        end
+      end
+      
+      def handle_javascript_observation_request(keyword, original_event_listener)
         return unless effective_observation_request_to_event_mapping.keys.include?(keyword)
         event = nil
         delegate = nil
@@ -886,6 +916,18 @@ module Glimmer
 #               }
 #             end,
 #           },
+          MenuItemProxy => {
+            :selection => lambda do |observer|
+              on_widget_selected { |selection_event|
+                # TODO look into validity of this and perhaps move toggle logic to MenuItemProxy
+                if check?
+                  observer.call(!selection)
+                else
+                  observer.call(selection)
+                end
+              }
+            end
+          },
           ScaleProxy => {
             :selection => lambda do |observer|
               on_widget_selected { |selection_event|
@@ -1021,7 +1063,6 @@ require 'glimmer/swt/combo_proxy'
 require 'glimmer/swt/c_combo_proxy'
 require 'glimmer/swt/checkbox_proxy'
 require 'glimmer/swt/composite_proxy'
-require 'glimmer/swt/dialog_proxy'
 require 'glimmer/swt/date_time_proxy'
 require 'glimmer/swt/group_proxy'
 require 'glimmer/swt/label_proxy'

data/lib/glimmer/ui/custom_shell.rb

@@ -67,6 +67,8 @@ module Glimmer
       
       def initialize(parent, args, options, &content)
         super(parent, args, options, &content)
+        body_root.set_data('custom_shell', self)
+        body_root.set_data('custom_window', self)
         raise Error, 'Invalid custom shell body root! Must be a shell or another custom shell.' unless body_root.is_a?(Glimmer::SWT::ShellProxy) || body_root.is_a?(Glimmer::UI::CustomShell)
       end
 

data/lib/glimmer/ui/custom_widget.rb

@@ -158,6 +158,7 @@ module Glimmer
       
 
       attr_reader :body_root, :parent, :options, :swt_style
+      alias parent_proxy parent
 
       def initialize(parent, args, options, &content)
         @parent = parent
@@ -177,6 +178,7 @@ module Glimmer
         body_block = self.class.instance_variable_get("@body_block")
         raise Glimmer::Error, 'Invalid custom widget for having no body! Please define body block!' if body_block.nil?
         @body_root = instance_exec(&body_block)
+        @parent ||= @body_root.parent
         raise Glimmer::Error, 'Invalid custom widget for having an empty body! Please fill body block!' if @body_root.nil?
         execute_hooks('after_body')
       end