glimmer-dsl-opal 0.25.4 → 0.26.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d82f0649f5baefa289ee1facb6102608e4d84e5a98e84a775ab1112f1698cc3d
-  data.tar.gz: da29c7ccd153e217867d2dd47afc7611311d79511461bb9395529a6561551cca
+  metadata.gz: cabde097ac994643d49e0af9b78fc1bbc7b2eb15857deb8741c557f4e676a4da
+  data.tar.gz: a198b93dc21bc2ea93e8542a84bbb83919be9ad0d63355f27dcf1fe4991b682c
 SHA512:
-  metadata.gz: 427deabace568823bb59fc9e09dbbbdc7c37c22c25dd131daa41fa61a88cc61a7cc746480d733b2862055fe798a05728ca1a809bacba839068ae346f9ce005da
-  data.tar.gz: bf34f31729b7c49c25442f12292042c92faf9eeb97e02582d87ad25f548a201ba574af4d00d5280166235c157509b95c2e5412a9e06f3f3924ea2738c6a3555a
+  metadata.gz: b77f3a496e6dd8e8afea59185ba46306b07e9cb0e4fb5e41b97151886292ab1735008e5a58f08251874e25ede8b781f819498f2ef0c84ba4f357f8c13b7c2c0a
+  data.tar.gz: bc9646367d1cd6476f60edf98cf2a94ff24dd6bff14756b3bcbc1365e79a3cb22869c626bc897f94784c59e3cffe30fe5c5e8fe90915a23fc042d3b4f836ffae

data/CHANGELOG.md

@@ -1,8 +1,31 @@
 # Change Log
 
+## 0.26.3
+
+- Support key_event.key_location in all key capturing widgets, not just display
+
+## 0.26.2
+
+- Support key_event.key_location to distinguish between left and right alt/shift/command/ctrl buttons
+- Use right/left alt/shift keys in Tetris for rotate right and rotate left
+
+## 0.26.1
+
+- Support display on_swt_keydown event keyCode/key_code values for arrow keys and alt/shift/ctrl
+- Use arrow keys for movement in Tetris
+- Use alt/shift keys for rotate right in Tetris
+
+## 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

@@ -145,7 +145,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.25.4 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.26.3 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)
@@ -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,11 +265,11 @@ 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'
-gem 'glimmer-dsl-opal', '~> 0.25.4'
+gem 'glimmer-dsl-opal', '~> 0.26.3'
 gem 'glimmer-dsl-xml', '~> 1.2.0', require: false
 gem 'glimmer-dsl-css', '~> 1.2.0', require: false
 
@@ -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.3

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/combo_proxy.rb

@@ -55,45 +55,6 @@ module Glimmer
               }
             }
           },
-          'on_key_pressed' => {
-            event: 'keydown',
-            event_handler: -> (event_listener) {
-              -> (event) {
-                @last_key_pressed_event = event
-                @text = event.target.value
-                # 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(:keyCode) {event.which}
-                event.define_singleton_method(:key_code, &event.method(:keyCode))
-                event.define_singleton_method(:character) {event.which.chr}
-                event.define_singleton_method(:stateMask) do
-                  state_mask = 0
-                  state_mask |= SWTProxy[:alt] if event.alt_key
-                  state_mask |= SWTProxy[:ctrl] if event.ctrl_key
-                  state_mask |= SWTProxy[:shift] if event.shift_key
-                  state_mask |= SWTProxy[:command] if event.meta_key
-                  state_mask
-                end
-                event.define_singleton_method(:state_mask, &event.method(:stateMask))
-                doit = true
-                event.define_singleton_method(:doit=) do |value|
-                  doit = value
-                end
-                event.define_singleton_method(:doit) { doit }
-                event_listener.call(event)
-                
-                  # TODO Fix doit false, it's not stopping input
-                unless doit
-                  event.prevent
-                  event.prevent_default
-                  event.stop_propagation
-                  event.stop_immediate_propagation
-                end
-                
-                doit
-              }
-            }
-          },
         }
       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/date_time_proxy.rb

@@ -136,43 +136,6 @@ module Glimmer
               }
             },
           ],
-          'on_key_pressed' => {
-            event: 'keydown',
-            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(:keyCode) {event.which}
-                event.define_singleton_method(:key_code, &event.method(:keyCode))
-                event.define_singleton_method(:character) {event.which.chr}
-                event.define_singleton_method(:stateMask) do
-                  state_mask = 0
-                  state_mask |= SWTProxy[:alt] if event.alt_key
-                  state_mask |= SWTProxy[:ctrl] if event.ctrl_key
-                  state_mask |= SWTProxy[:shift] if event.shift_key
-                  state_mask |= SWTProxy[:command] if event.meta_key
-                  state_mask
-                end
-                event.define_singleton_method(:state_mask, &event.method(:stateMask))
-                doit = true
-                event.define_singleton_method(:doit=) do |value|
-                  doit = value
-                end
-                event.define_singleton_method(:doit) { doit }
-                event_listener.call(event)
-                
-                  # TODO Fix doit false, it's not stopping input
-                unless doit
-                  event.prevent
-                  event.prevent_default
-                  event.stop_propagation
-                  event.stop_immediate_propagation
-                end
-                
-                doit
-              }
-            }
-          },
         }
       end
       

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

@@ -1,4 +1,5 @@
 require 'glimmer/swt/widget_proxy'
+require 'glimmer/swt/swt_proxy'
 
 module Glimmer
   module SWT
@@ -85,89 +86,6 @@ module Glimmer
       # sync_exec kept for API compatibility reasons
       alias sync_exec async_exec
       
-      def observation_request_to_event_mapping
-        {
-          'on_swt_keydown' => [
-            {
-              event: 'keypress',
-              event_handler: -> (event_listener) {
-                -> (event) {
-                  event.singleton_class.define_method(:character) do
-                    which || key_code
-                  end
-                  event.define_singleton_method(:keyCode) {event.which}
-                  event.define_singleton_method(:key_code, &event.method(:keyCode))
-                  event.define_singleton_method(:character) {event.which.chr}
-                  event.define_singleton_method(:stateMask) do
-                    state_mask = 0
-                    state_mask |= SWTProxy[:alt] if event.alt_key
-                    state_mask |= SWTProxy[:ctrl] if event.ctrl_key
-                    state_mask |= SWTProxy[:shift] if event.shift_key
-                    state_mask |= SWTProxy[:command] if event.meta_key
-                    state_mask
-                  end
-                  event.define_singleton_method(:state_mask, &event.method(:stateMask))
-                  doit = true
-                  event.define_singleton_method(:doit=) do |value|
-                    doit = value
-                  end
-                  event.define_singleton_method(:doit) { doit }
-                  event_listener.call(event)
-                  
-                    # TODO Fix doit false, it's not stopping input
-                  unless doit
-                    event.prevent
-                    event.prevent_default
-                    event.stop_propagation
-                    event.stop_immediate_propagation
-                  end
-                  
-                  doit
-                }
-              }
-            },
-            {
-              event: 'keydown',
-              event_handler: -> (event_listener) {
-                -> (event) {
-                  event.singleton_class.define_method(:character) do
-                    which || key_code
-                  end
-                  event.define_singleton_method(:keyCode) {event.which}
-                  event.define_singleton_method(:key_code, &event.method(:keyCode))
-                  event.define_singleton_method(:character) {event.which.chr}
-                  event.define_singleton_method(:stateMask) do
-                    state_mask = 0
-                    state_mask |= SWTProxy[:alt] if event.alt_key
-                    state_mask |= SWTProxy[:ctrl] if event.ctrl_key
-                    state_mask |= SWTProxy[:shift] if event.shift_key
-                    state_mask |= SWTProxy[:command] if event.meta_key
-                    state_mask
-                  end
-                  event.define_singleton_method(:state_mask, &event.method(:stateMask))
-                  doit = true
-                  event.define_singleton_method(:doit=) do |value|
-                    doit = value
-                  end
-                  event.define_singleton_method(:doit) { doit }
-                  event_listener.call(event) if event.key_code != 13 && (event.key_code == 127 || event.key_code <= 31)
-                  
-                    # TODO Fix doit false, it's not stopping input
-                  unless doit
-                    event.prevent
-                    event.prevent_default
-                    event.stop_propagation
-                    event.stop_immediate_propagation
-                  end
-                  
-                  doit
-                }
-              }
-            }
-          ]
-        }
-      end
-      
       private
       
       def async_exec_queues

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