glimmer-dsl-opal 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73ea5888d9b6351e59225c868c98bf3c5f8d7bf20e1314bf2289be1528cd5d65
-  data.tar.gz: 0d5420f934e0d29a8fcdb15e68f2e30365f2d70d9d89e2dc19bbd24d14a91626
+  metadata.gz: 8ceab7c0ff7d7ef07cca7f798cfd6f1aa6d4e18b2aaa23d34ded024c491becec
+  data.tar.gz: cf4474df385496aad3d0519bd45f69cc51d185a0c7c60e0f941796bfd623cca7
 SHA512:
-  metadata.gz: 79e7aae7f3b6e5342e2231f08330cf50e2c5574444b3f07c86b2166722e356e18ca6fb89a2ad21509951360432a42e8f6c449a19b5ff5737b08f521b8f473b79
-  data.tar.gz: 6f4be96f8c26c160b0d8d8d2dfc92d40cfa95fc79a76cfe886567cd2f55671861adf9b19cfdbc5d1f6fa78a1ce516f7ab46c330bdef2821a1a312b8b165c91cc
+  metadata.gz: 99bb2e0b9a22b384eb78774d814ff9b15e6662d89f5e2ad402fc980da644cb3392b0c567d861b696ddbd77a889f40393b64ec8ed0059622114e1f703f52bfbb7
+  data.tar.gz: 4b3a76c993f70c32d0133678d5424ead94925836ffe1a45994879df165b008827bd5c9a6e8b107c32717bfeca82a86dad699363a9a36b640d2c1e5929eb91e38

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.17.0
+
+- Support `menu` `visible` attribute to enable programmatic display of menu
+- Support `arrow` widget
+- Hello, Arrow! sample
+
 ## 0.16.2
 
 - Support `grid_layout` `margin_top`, `margin_right`, `margin_bottom`, and `margin_left` attributes

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.16.2 (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.17.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)
 
@@ -143,7 +143,7 @@ Hello, Table! Game Booked
 
 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.16.2 only supports bare-minimum capabilities for the included [samples](https://github.com/AndyObtiva/glimmer-dsl-opal#samples) (originally written for [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt))
+**Alpha Version** 0.17.0 only supports bare-minimum capabilities for the included [samples](https://github.com/AndyObtiva/glimmer-dsl-opal#samples) (originally written for [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt))
 
 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 Framework)
@@ -153,7 +153,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 
 ## Table of Contents
 
-- [Glimmer DSL for Opal 0.16.2 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0162-pure-ruby-web-gui)
+- [Glimmer DSL for Opal 0.17.0 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0170-pure-ruby-web-gui)
   - [Principles](#principles)
   - [Background](#background)
   - [Pre-requisites](#pre-requisites)
@@ -257,7 +257,7 @@ gem 'opal', '1.0.4'
 gem 'opal-rails', '1.1.2'
 gem 'opal-async', '~> 1.2.0'
 gem 'opal-jquery', '~> 0.4.4'
-gem 'glimmer-dsl-opal', '~> 0.16.2'
+gem 'glimmer-dsl-opal', '~> 0.17.0'
 gem 'glimmer-dsl-xml', '~> 1.2.0', require: false
 gem 'glimmer-dsl-css', '~> 1.2.0', require: false
 
@@ -321,6 +321,7 @@ shell {
 The following keywords from [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) have fully functional partial support in Opal:
 
 Widgets:
+- `arrow`: featured in [Hello, Arrow!](#hello-arrow)
 - `button`: featured in [Hello, Checkbox!](#hello-checkbox) / [Hello, Button!](#hello-button) / [Hello, Table!](#hello-table) / [Hello, Radio Group!](#hello-radio-group) / [Hello, Radio!](#hello-radio) / [Hello, Message Box!](#hello-message-box) / [Hello, List Single Selection!](#hello-list-single-selection) / [Hello, List Multi Selection!](#hello-list-multi-selection) / [Hello, Group!](#hello-group) / [Hello, Combo!](#hello-combo) / [Hello, Checkbox Group!](#hello-checkbox-group) / [Contact Manager](#contact-manager) / [Tic Tac Toe](#tic-tac-toe) / [Login](#login)
 - `browser`: featured in [Hello, Browser!](#hello-browser)
 - `calendar`: featured in [Hello, Date Time!](#hello-date-time)
@@ -759,6 +760,39 @@ 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, Arrow!
+
+Add the following require statement to `app/assets/javascripts/application.rb`
+
+```ruby
+require 'glimmer-dsl-opal/samples/hello/hello_arrow'
+```
+
+Glimmer app on the desktop (using [`glimmer-dsl-swt`](https://github.com/AndyObtiva/glimmer-dsl-swt) gem):
+
+![Glimmer DSL for SWT Hello Arrow](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-arrow.png)
+
+![Glimmer DSL for SWT Hello Arrow](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-arrow-menu.png)
+
+![Glimmer DSL for SWT Hello Arrow](https://github.com/AndyObtiva/glimmer-dsl-swt/raw/master/images/glimmer-hello-arrow-item-selected.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, Arrow!"
+
+![Glimmer DSL for Opal Hello Arrow](images/glimmer-dsl-opal-hello-arrow.png)
+
+![Glimmer DSL for Opal Hello Arrow](images/glimmer-dsl-opal-hello-arrow-menu.png)
+
+![Glimmer DSL for Opal Hello Arrow](images/glimmer-dsl-opal-hello-arrow-item-selected.png)
+
 #### Hello, Browser!
 
 Add the following require statement to `app/assets/javascripts/application.rb`

data/VERSION

@@ -1 +1 @@
-0.16.2
+0.17.0

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

@@ -0,0 +1,65 @@
+# Copyright (c) 2020-2021 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 {
+  row_layout(:vertical) {
+    fill true
+    center true
+  }
+  
+  text 'Hello, Arrow!'
+  
+  label(:center) {
+    text 'Click the arrow to get a menu.'
+  }
+  
+  arrow { # can be customized by passing `:arrow` SWT style + `:left`, `:right`, `:up`, or `:down` (default)
+    @menu = menu {
+      menu_item {
+        text 'Item &1'
+        
+        on_widget_selected do
+          message_box {
+            text 'Item 1'
+            message 'Item 1 selected!'
+          }.open
+        end
+      }
+      menu_item {
+        text 'Item &2'
+        
+        on_widget_selected do
+          message_box {
+            text 'Item 2'
+            message 'Item 2 selected!'
+          }.open
+        end
+      }
+    }
+    
+    on_widget_selected do |event|
+      event.widget.menu.visible = true
+    end
+  }
+    
+}.open

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

@@ -37,6 +37,9 @@ 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/arrow_proxy.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2020-2021 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 'glimmer/swt/widget_proxy'
+require 'glimmer/swt/button_proxy'
+
+module Glimmer
+  module SWT
+    class ArrowProxy < ButtonProxy
+      def initialize(parent, args, block)
+        if args.to_a.include?(:left)
+          @text = '<'
+        elsif args.to_a.include?(:right)
+          @text = '>'
+        elsif args.to_a.include?(:up)
+          @text = '^'
+        else
+          @text = 'v'
+        end
+        super(parent, args, block)
+      end
+    end
+  end
+end

data/lib/glimmer/swt/button_proxy.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2020-2021 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 'glimmer/swt/widget_proxy'
 require 'glimmer/swt/radio_proxy'
 require 'glimmer/swt/checkbox_proxy'
@@ -11,6 +32,8 @@ module Glimmer
             RadioProxy.new(parent, args, block)
           elsif args.to_a.include?(:check)
             CheckboxProxy.new(parent, args, block)
+          elsif args.to_a.include?(:arrow)
+            ArrowProxy.new(parent, args, block)
           else
             new(parent, args, block)
           end
@@ -29,9 +52,21 @@ module Glimmer
       end
 
       def observation_request_to_event_mapping
+        myself = self
         {
           'on_widget_selected' => {
-            event: 'click'
+            event: 'click',
+            event_handler: -> (event_listener) {
+              -> (event) {
+                event.define_singleton_method(:widget) {myself}
+                doit = true
+                event.define_singleton_method(:doit=) do |value|
+                  doit = value
+                end
+                event.define_singleton_method(:doit) { doit }
+                event_listener.call(event)
+              }
+            }
           },
         }
       end

data/lib/glimmer/swt/menu_proxy.rb

@@ -218,6 +218,21 @@ module Glimmer
         end
       end
       
+      def visible=(value)
+        @visible = value
+        if @visible
+          parent.menu_requested = true
+          parent.dom_element.css('position', 'relative')
+          render
+          dom_element.css('position', 'absolute')
+          dom_element.css('left', parent.menu_x - parent.dom_element.offset.left)
+          dom_element.css('top', parent.menu_y - parent.dom_element.offset.top)
+          parent.menu_requested = false
+        else
+          close
+        end
+      end
+      
       def render(custom_parent_dom_element: nil, brand_new: false)
         # TODO attach to top nav bar if parent is shell
         # TODO attach listener to parent to display on right click
@@ -226,7 +241,7 @@ module Glimmer
           if root_menu? && !bar?
             `$(#{path}).menu();`
             @close_event_handler = lambda do |event|
-              close if event.target.parents('.ui-menu').empty?
+              close if event.target != parent.dom_element && event.target.parents('.ui-menu').empty?
             end
             Element['body'].on('click', &@close_event_handler)
           end
@@ -236,6 +251,7 @@ module Glimmer
       def close
         dom_element.remove
         Element['body'].off('click', &@close_event_handler)
+        @visible = false
       end
       
       def root_menu?

data/lib/glimmer/swt/widget_proxy.rb

@@ -31,8 +31,8 @@ module Glimmer
       include Glimmer
       include PropertyOwner
       
-      attr_reader :parent, :args, :path, :children, :enabled, :foreground, :background, :font, :focus, :disposed?, :rendered, :menu_requested
-      attr_accessor :menu
+      attr_reader :parent, :args, :path, :children, :enabled, :foreground, :background, :font, :focus, :disposed?, :rendered
+      attr_accessor :menu, :menu_requested, :menu_x, :menu_y
       alias isDisposed disposed?
       alias is_disposed disposed?
       alias rendered? rendered
@@ -133,17 +133,16 @@ module Glimmer
       # Executes at the closing of a parent widget curly braces after all children/properties have been added/set
       def post_add_content
         if !menu.nil? && !is_a?(MenuProxy) && !is_a?(MenuItemProxy)
-          on_mouse_down { |mouse_event|
+          # TODO consider in the future retaining listener registrations to deregister on unsetting of the menu
+          on_mouse_move do |mouse_event|
+            self.menu_x = mouse_event.x
+            self.menu_y = mouse_event.y
+          end
+          on_mouse_down do |mouse_event|
             if mouse_event.button == 3 # right-click
-              @menu_requested = true
-              dom_element.css('position', 'relative')
-              menu&.render
-              menu.dom_element.css('position', 'absolute')
-              menu.dom_element.css('left', mouse_event.x - parent.get_layout&.margin_width.to_i) # TODO - parent.get_layout&.margin_left.to_i)
-              menu.dom_element.css('top', mouse_event.y - parent.get_layout&.margin_height.to_i - 5) # TODO - parent.get_layout&.margin_top.to_i)
-              @menu_requested = false
+              menu.visible = true
             end
-          }
+          end
         end
       end
       
@@ -321,10 +320,12 @@ module Glimmer
       end
       
       def default_observation_request_to_event_mapping
+        myself = self
         mouse_event_handler = -> (event_listener) {
           -> (event) {
             # TODO generalize this solution to all widgets that support key presses
             # TODO support event.location once DOM3 is supported by opal-jquery
+            event.define_singleton_method(:widget) {myself}
             event.define_singleton_method(:button, &event.method(:which))
             event.define_singleton_method(:count) {1} # TODO support double-click count of 2 in the future by using ondblclick
             event.define_singleton_method(:x, &event.method(:page_x))
@@ -345,6 +346,31 @@ module Glimmer
 #               event.prevent
 #               event.stop
 #               event.stop_immediate
+#             end
+          }
+        }
+        mouse_move_event_handler = -> (event_listener) {
+          -> (event) {
+            # TODO generalize this solution to all widgets that support key presses
+            # TODO support event.location once DOM3 is supported by opal-jquery
+            event.define_singleton_method(:widget) {myself}
+            event.define_singleton_method(:button, &event.method(:which))
+            event.define_singleton_method(:count) {1} # TODO support double-click count of 2 in the future by using ondblclick
+            event.define_singleton_method(:x, &event.method(:page_x))
+            event.define_singleton_method(:y, &event.method(:page_y))
+            doit = true
+            event.define_singleton_method(:doit=) do |value|
+              doit = value
+            end
+            event.define_singleton_method(:doit) { doit }
+            
+            event_listener.call(event)
+            
+            # TODO Imlement doit properly for all different kinds of events
+#             unless doit
+#               event.prevent
+#               event.stop
+#               event.stop_immediate
 #             end
           }
         }
@@ -352,6 +378,7 @@ module Glimmer
           -> (event) {
             # TODO generalize this solution to all widgets that support key presses
             # TODO support event.location once DOM3 is supported by opal-jquery
+            event.define_singleton_method(:widget) {myself}
             event.define_singleton_method(:button, &event.method(:which))
             event.define_singleton_method(:count) {1} # TODO support double-click count of 2 in the future by using ondblclick
             event.define_singleton_method(:x, &event.method(:page_x))
@@ -366,7 +393,6 @@ module Glimmer
               event.prevent
               event_listener.call(event)
             end
-            
             # TODO Imlement doit properly for all different kinds of events
 #             unless doit
 #               event.prevent
@@ -382,6 +408,12 @@ module Glimmer
           'on_focus_lost' => {
             event: 'blur',
           },
+          'on_mouse_move' => [
+            {
+              event: 'mousemove',
+              event_handler: mouse_move_event_handler,
+            },
+          ],
           'on_mouse_up' => [
             {
               event: 'mouseup',
@@ -428,6 +460,7 @@ module Glimmer
               -> (event) {
                 # TODO generalize this solution to all widgets that support key presses
                 # TODO support event.location once DOM3 is supported by opal-jquery
+                event.define_singleton_method(:widget) {myself}
                 event.define_singleton_method(:keyCode) {event.which}
                 event.define_singleton_method(:key_code, &event.method(:keyCode))
                 event.define_singleton_method(:character) {event.which.chr}
@@ -464,6 +497,7 @@ module Glimmer
               -> (event) {
                 # TODO generalize this solution to all widgets that support key presses
                 # TODO support event.location once DOM3 is supported by opal-jquery
+                event.define_singleton_method(:widget) {myself}
                 event.define_singleton_method(:keyCode) {event.which}
                 event.define_singleton_method(:key_code, &event.method(:keyCode))
                 event.define_singleton_method(:character) {event.which.chr}
@@ -500,6 +534,7 @@ module Glimmer
               -> (event) {
                 # TODO generalize this solution to all widgets that support key presses
                 # TODO support event.location once DOM3 is supported by opal-jquery
+                event.define_singleton_method(:widget) {myself}
                 event.define_singleton_method(:keyCode) {event.which}
                 event.define_singleton_method(:key_code, &event.method(:keyCode))
                 event.define_singleton_method(:character) {event.which.chr}
@@ -536,6 +571,7 @@ module Glimmer
               -> (event) {
                 # TODO generalize this solution to all widgets that support key presses
                 # TODO support event.location once DOM3 is supported by opal-jquery
+                event.define_singleton_method(:widget) {myself}
                 event.define_singleton_method(:keyCode) {event.which}
                 event.define_singleton_method(:key_code, &event.method(:keyCode))
                 event.define_singleton_method(:character) {event.which.chr}
@@ -924,6 +960,7 @@ end
 require 'glimmer/swt/display_proxy'
 require 'glimmer/swt/browser_proxy'
 require 'glimmer/swt/button_proxy'
+require 'glimmer/swt/arrow_proxy'
 require 'glimmer/swt/combo_proxy'
 require 'glimmer/swt/checkbox_proxy'
 require 'glimmer/swt/composite_proxy'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-opal
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - AndyMaleh
@@ -284,6 +284,7 @@ files:
 - lib/glimmer-dsl-opal/samples/elaborate/tic_tac_toe/board.rb
 - lib/glimmer-dsl-opal/samples/elaborate/tic_tac_toe/cell.rb
 - lib/glimmer-dsl-opal/samples/elaborate/weather.rb
+- lib/glimmer-dsl-opal/samples/hello/hello_arrow.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_browser.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_button.rb
 - lib/glimmer-dsl-opal/samples/hello/hello_checkbox.rb
@@ -370,6 +371,7 @@ files:
 - lib/glimmer/dsl/opal/widget_listener_expression.rb
 - lib/glimmer/engine.rb
 - lib/glimmer/swt.rb
+- lib/glimmer/swt/arrow_proxy.rb
 - lib/glimmer/swt/browser_proxy.rb
 - lib/glimmer/swt/button_proxy.rb
 - lib/glimmer/swt/checkbox_proxy.rb