glimmer-dsl-opal 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9eec417d33069c8ecf49c9450b46f7552702d2e83993334f7289739c4b61440
-  data.tar.gz: 2d3a8606327d4686ef21d18e605a29679a8f47663959b6e971777fca928b2fe4
+  metadata.gz: 3a5328b8fd90117a9774e990256d5650ab8c15cd2745a29a466384261a1ead8a
+  data.tar.gz: 2cfceae33c796f8aea84036dba490aa55ca94b5f7785c0c2f75dbc5e27535259
 SHA512:
-  metadata.gz: d5b668bd3ddf0629e4c335de3c530622d30a4aeb472ac6e615bc5aca62798552b652ca8f6b4a6a4e90421f06231364a1ffa88ab9b339805f053e387de7ffefec
-  data.tar.gz: 397097b8640b63d2ef8e9b72c4be169c79fa276c46f0aad3cb8d0f69b0fec3716d710498b35309dcd58c3f951711a1bb3d011a27533e452107958189333932f0
+  metadata.gz: e574405ade34c331a168a3dd2814112269dff90a72d58678f06246d94246e2a1c7bfc7e56163df61c2805fc58764a5da48687273ce98ce5c10cf27cf52fb5d51
+  data.tar.gz: 297d37971d6939413fa2dd2535169b486a7c5332395f34b5d2f2c0697f41fce67c61c613dba83575b88e5904ef128354f5846e9e7e96963aa065f93050f2476d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 0.12.0
+
+- Support CustomShell.launch opening in the same window if no other shell is open or DisplayProxy.open_custom_shells_in_current_window = true is set
+- Support CustomShell.launch opening a new window if a shell is already open
+- Support passing `table` data-binding column properties as `column_properties` or `column_attributes` an extra hash option to `bind` method call
+- Support Shine data-binding syntax in `table`
+- Update Hello, Custom Shell!, Hello, Table!, Contact Manager, and Login samples to use Shine data-binding syntax
+
 ## 0.11.0
 
 - Upgrade to glimmer 2.0.0

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.10.3 (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.12.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)
 
@@ -141,7 +141,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.10.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))
+**Alpha Version** 0.12.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)
@@ -151,7 +151,7 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
 
 ## Table of Contents
 
-- [Glimmer DSL for Opal 0.10.3 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0101-pure-ruby-web-gui)
+- [Glimmer DSL for Opal 0.12.0 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0110-pure-ruby-web-gui)
   - [Principles](#principles)
   - [Background](#background)
   - [Pre-requisites](#pre-requisites)
@@ -252,9 +252,9 @@ 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.10.3'
-gem 'glimmer-dsl-xml', '~> 1.1.0', require: false
-gem 'glimmer-dsl-css', '~> 1.1.0', require: false
+gem 'glimmer-dsl-opal', '~> 0.12.0'
+gem 'glimmer-dsl-xml', '~> 1.2.0', require: false
+gem 'glimmer-dsl-css', '~> 1.2.0', require: false
 
 ```
 
@@ -468,7 +468,7 @@ class HelloCombo
       text 'Hello, Combo!'
       
       combo(:read_only) {
-        selection bind(person, :country)
+        selection <=> [person, :country]
       }
       
       button {
@@ -533,9 +533,7 @@ class HelloComputed
       0
     end
   end
-end
 
-class HelloComputed
   include Glimmer
 
   def initialize
@@ -549,6 +547,7 @@ class HelloComputed
   def launch
     shell {
       text 'Hello, Computed!'
+      
       composite {
         grid_layout {
           num_columns 2
@@ -556,41 +555,46 @@ class HelloComputed
           horizontal_spacing 20
           vertical_spacing 10
         }
+        
         label {text 'First &Name: '}
         text {
-          text bind(@contact, :first_name)
+          text <=> [@contact, :first_name]
           layout_data {
             horizontal_alignment :fill
             grab_excess_horizontal_space true
           }
         }
+        
         label {text '&Last Name: '}
         text {
-          text bind(@contact, :last_name)
+          text <=> [@contact, :last_name]
           layout_data {
             horizontal_alignment :fill
             grab_excess_horizontal_space true
           }
         }
+        
         label {text '&Year of Birth: '}
         text {
-          text bind(@contact, :year_of_birth)
+          text <=> [@contact, :year_of_birth]
           layout_data {
             horizontal_alignment :fill
             grab_excess_horizontal_space true
           }
         }
+        
         label {text 'Name: '}
         label {
-          text bind(@contact, :name, computed_by: [:first_name, :last_name])
+          text <= [@contact, :name, computed_by: [:first_name, :last_name]]
           layout_data {
             horizontal_alignment :fill
             grab_excess_horizontal_space true
           }
         }
+        
         label {text 'Age: '}
         label {
-          text bind(@contact, :age, on_write: :to_i, computed_by: [:year_of_birth])
+          text <= [@contact, :age, on_write: :to_i, computed_by: [:year_of_birth]]
           layout_data {
             horizontal_alignment :fill
             grab_excess_horizontal_space true

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.0

data/lib/display.rb

@@ -24,8 +24,11 @@ class Display
     def setAppName(app_name)
       # No Op in Opal
     end
+    alias app_name= setAppName
+    
     def setAppVersion(version)
       # No Op in Opal
     end
+    alias app_version= setAppVersion
   end
 end

data/lib/glimmer-dsl-opal/samples/elaborate/contact_manager.rb

@@ -1,14 +1,16 @@
+require 'glimmer-dsl-swt'
+
 require_relative "contact_manager/contact_manager_presenter"
 
 class ContactManager
-  include Glimmer
+  include Glimmer::UI::CustomShell
 
-  def initialize
+  before_body {
     @contact_manager_presenter = ContactManagerPresenter.new
     @contact_manager_presenter.list
-  end
+  }
 
-  def launch
+  body {
     shell {
       text "Contact Manager"
       composite {
@@ -28,7 +30,7 @@ class ContactManager
           }
           text {
             layout_data :fill, :center, true, false
-            text bind(@contact_manager_presenter, :first_name)
+            text <=> [@contact_manager_presenter, :first_name]
             on_key_pressed {|key_event|
               @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
             }
@@ -41,7 +43,7 @@ class ContactManager
           }
           text {
             layout_data :fill, :center, true, false
-            text bind(@contact_manager_presenter, :last_name)
+            text <=> [@contact_manager_presenter, :last_name]
             on_key_pressed {|key_event|
               @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
             }
@@ -54,7 +56,7 @@ class ContactManager
           }
           text {
             layout_data :fill, :center, true, false
-            text bind(@contact_manager_presenter, :email)
+            text <=> [@contact_manager_presenter, :email]
             on_key_pressed {|key_event|
               @contact_manager_presenter.find if key_event.keyCode == swt(:cr)
             }
@@ -87,7 +89,7 @@ class ContactManager
           }
         }
 
-        table(:multi) { |table_proxy|
+        table(:editable, :multi) { |table_proxy|
           layout_data {
             horizontal_alignment :fill
             vertical_alignment :fill
@@ -95,6 +97,7 @@ class ContactManager
             grab_excess_vertical_space true
             height_hint 200
           }
+          
           table_column {
             text "First Name"
             width 80
@@ -107,15 +110,16 @@ class ContactManager
             text "Email"
             width 200
           }
-          items bind(@contact_manager_presenter, :results),
-          column_properties(:first_name, :last_name, :email)
+          
+          items <=> [@contact_manager_presenter, :results, column_attributes: [:first_name, :last_name, :email]]
+          
           on_mouse_up { |event|
             table_proxy.edit_table_item(event.table_item, event.column_index)
           }
         }
       }
-    }.open
-  end
+    }
+  }
 end
 
-ContactManager.new.launch
+ContactManager.launch

data/lib/glimmer-dsl-opal/samples/elaborate/login.rb

@@ -1,4 +1,25 @@
-require "observer"
+# 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-dsl-swt'
 
 class LoginPresenter
 
@@ -14,29 +35,26 @@ class LoginPresenter
 
   def status=(status)
     @status = status
-
-    notify_observers("logged_in")
-    notify_observers("logged_out")
   end
   
   def valid?
     !@user_name.to_s.strip.empty? && !@password.to_s.strip.empty?
   end
 
-  def logged_in
+  def logged_in?
     self.status == "Logged In"
   end
 
-  def logged_out
-    !self.logged_in
+  def logged_out?
+    !self.logged_in?
   end
 
-  def login
+  def login!
     return unless valid?
     self.status = "Logged In"
   end
 
-  def logout
+  def logout!
     self.user_name = ""
     self.password = ""
     self.status = "Logged Out"
@@ -45,19 +63,24 @@ class LoginPresenter
 end
 
 class Login
-  include Glimmer
+  include Glimmer::UI::CustomShell
+  
+  before_body {
+    @presenter = LoginPresenter.new
+  }
 
-  def launch
-    presenter = LoginPresenter.new
-    @shell = shell {
+  body {
+    shell {
       text "Login"
+      
       composite {
         grid_layout 2, false #two columns with differing widths
 
         label { text "Username:" } # goes in column 1
         @user_name_text = text {   # goes in column 2
-          text <=> [presenter, :user_name]
-          enabled <= [presenter, :logged_out]
+          text <=> [@presenter, :user_name]
+          enabled <= [@presenter, :logged_out?, computed_by: :status]
+          
           on_key_pressed { |event|
             @password_text.set_focus if event.keyCode == swt(:cr)
           }
@@ -65,40 +88,44 @@ class Login
 
         label { text "Password:" }
         @password_text = text(:password, :border) {
-          text <=> [presenter, :password]
-          enabled <= [presenter, :logged_out]
+          text <=> [@presenter, :password]
+          enabled <= [@presenter, :logged_out?, computed_by: :status]
+          
           on_key_pressed { |event|
-            presenter.login if event.keyCode == swt(:cr)
+            @presenter.login! if event.keyCode == swt(:cr)
           }
         }
 
         label { text "Status:" }
-        label { text <= [presenter, :status] }
+        label { text <= [@presenter, :status] }
 
         button {
           text "Login"
-          enabled <= [presenter, :logged_out]
-          on_widget_selected { presenter.login }
+          enabled <= [@presenter, :logged_out?, computed_by: :status]
+          
+          on_widget_selected { @presenter.login! }
           on_key_pressed { |event|
-            presenter.login if event.keyCode == swt(:cr)
+            if event.keyCode == swt(:cr)
+              @presenter.login!
+            end
           }
         }
 
         button {
           text "Logout"
-          enabled <= [presenter, :logged_in]
-          on_widget_selected { presenter.logout }
+          enabled <= [@presenter, :logged_in?, computed_by: :status]
+          
+          on_widget_selected { @presenter.logout! }
           on_key_pressed { |event|
             if event.keyCode == swt(:cr)
-              presenter.logout
+              @presenter.logout!
               @user_name_text.set_focus
             end
           }
         }
       }
     }
-    @shell.open
-  end
+  }
 end
 
-Login.new.launch
+Login.launch

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

@@ -137,7 +137,7 @@ class HelloCustomShell
           width 360
         }
         
-        items bind(@email_system, :emails), column_properties(:date, :subject, :from)
+        items <=> [@email_system, :emails, column_attributes: [:date, :subject, :from]]
         
         on_mouse_up { |event|
           email = event.table_item.get_data

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

@@ -237,10 +237,10 @@ class HelloTable
         }
         
         # Data-bind table items (rows) to a model collection property, specifying column properties ordering per nested model
-        items bind(BaseballGame, :schedule), column_properties(:game_date, :game_time, :ballpark, :home_team, :away_team, :promotion)
+        items <=> [BaseballGame, :schedule, column_attributes: [:game_date, :game_time, :ballpark, :home_team, :away_team, :promotion]]
         
         # Data-bind table selection
-        selection bind(BaseballGame, :selected_game)
+        selection <=> [BaseballGame, :selected_game]
         
         # Default initial sort property
         sort_property :date

data/lib/glimmer/data_binding/table_items_binding.rb

@@ -15,8 +15,8 @@ module Glimmer
         @last_populated_model_collection = nil
         @table = parent
         @model_binding = model_binding
-#         @column_properties = model_binding.binding_options[:column_attributes] || model_binding.binding_options[:column_properties] || column_properties # TODO
-        @column_properties = column_properties
+        @column_properties = model_binding.binding_options[:column_attributes] || model_binding.binding_options[:column_properties] || column_properties # TODO
+        @table.editable = false if model_binding.binding_options[:read_only]
         @table.data = @model_binding
         ##@table.on_widget_disposed do |dispose_event| # doesn't seem needed within Opal
         ##  unregister_all_observables

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

@@ -12,10 +12,10 @@ module Glimmer
           keyword == "items" and
             block.nil? and
             parent.is_a?(Glimmer::SWT::TableProxy) and
-            args.size == 2 and
+            args.size.between?(1, 2) and
             args[0].is_a?(DataBinding::ModelBinding) and
             args[0].evaluate_property.is_a?(Array) and
-            args[1].is_a?(Array)
+            (args[1].nil? or args[1].is_a?(Array))
         end
   
         def interpret(parent, keyword, *args, &block)

data/lib/glimmer/swt/layout_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/property_owner'
 
 module Glimmer
@@ -13,9 +34,8 @@ module Glimmer
         end
         
         def layout_class(keyword)
-          class_name_alternative = keyword.camelcase(:upper)
-          class_name_main = "#{class_name_alternative}Proxy"
-          a_layout_class = Glimmer::SWT.const_get(class_name_main.to_sym) rescue Glimmer::SWT.const_get(class_name_alternative.to_sym)
+          class_name_main = "#{keyword.camelcase(:upper)}Proxy"
+          a_layout_class = Glimmer::SWT.const_get(class_name_main.to_sym)
           a_layout_class if a_layout_class.ancestors.include?(Glimmer::SWT::LayoutProxy)
         rescue => e
           Glimmer::Config.logger.debug "Layout #{keyword} was not found!"

data/lib/glimmer/swt/table_proxy.rb

@@ -257,9 +257,7 @@ module Glimmer
         @table_editor.minimumWidth = 90
         @table_editor.minimumHeight = 20
         if editable?
-          on_mouse_up { |event|
-            edit_table_item(event.table_item, event.column_index)
-          }
+          add_editable_event_listener
         end
       end
       
@@ -311,6 +309,24 @@ module Glimmer
       end
       alias editable editable?
       
+      def editable=(value)
+        if value
+          args.push(:editable)
+          dom_element.addClass('editable')
+          add_editable_event_listener
+        else
+          args.delete(:editable)
+          dom_element.removeClass('editable')
+          @editable_on_mouse_up_event_listener.deregister # TODO see why table event listener deregistration is not working
+        end
+      end
+      
+      def add_editable_event_listener
+        @editable_on_mouse_up_event_listener = on_mouse_up { |event|
+          edit_table_item(event.table_item, event.column_index) if editable?
+        }
+      end
+      
       def selection
         @selection.to_a
       end

data/lib/glimmer/ui/custom_shell.rb

@@ -29,15 +29,12 @@ module Glimmer
       include Glimmer::UI::CustomWidget
       
       module ClassMethods
+        include Glimmer
         attr_reader :custom_shell
         
         def launch
-          @custom_shell = send(self.name.underscore.gsub('::', '__'))
-          @custom_shell.open
-        end
-        
-        def shutdown
-          @custom_shell.close
+          custom_shell = send(self.name.underscore.gsub('::', '__'))
+          custom_shell.open
         end
       end
       
@@ -73,11 +70,17 @@ module Glimmer
         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
 
-      # Classes may override
-      def open
-        # TODO consider the idea of delaying rendering till the open method
-        body_root.open
+      def open(async: true)
+        work = lambda do
+          body_root.open
+        end
+        if async
+          Glimmer::SWT::DisplayProxy.instance.async_exec(&work)
+        else
+          work.call
+        end
       end
+      
 
       # DO NOT OVERRIDE. JUST AN ALIAS FOR `#open`. OVERRIDE `#open` INSTEAD.
       def show

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-opal
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer