glimmer-dsl-opal 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5328b8fd90117a9774e990256d5650ab8c15cd2745a29a466384261a1ead8a
-  data.tar.gz: 2cfceae33c796f8aea84036dba490aa55ca94b5f7785c0c2f75dbc5e27535259
+  metadata.gz: d4c1b8623cfb624fda19e969ff546ad75a41d32331c9c5c3cabd267a74c96b62
+  data.tar.gz: 4b84ff762bbc5cecc3eefbf4e0dbd7f95501658523751e2a2936405974a662a6
 SHA512:
-  metadata.gz: e574405ade34c331a168a3dd2814112269dff90a72d58678f06246d94246e2a1c7bfc7e56163df61c2805fc58764a5da48687273ce98ce5c10cf27cf52fb5d51
-  data.tar.gz: 297d37971d6939413fa2dd2535169b486a7c5332395f34b5d2f2c0697f41fce67c61c613dba83575b88e5904ef128354f5846e9e7e96963aa065f93050f2476d
+  metadata.gz: da478774923d89f49c1fbc050f9234f24a728781dddc7f38a1790795efdf5f1d9228982859e6027fd4e90d3ad61d8254275df4882a9453c61f0bbfcf16c7e089
+  data.tar.gz: f8a46956d0caf08f7ab94bb183e02131acd808f4e17d084d961e15c79ea044c9dc16cb20a436e94ea63a26446cc6ce6b5467878634c04960a8464b38ee26666d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.13.0
+
+- Support Shine data-binding syntax in custom widgets
+- Update Hello, Checkbox!, Hello, Checkbox Group!, Hello, Radio! and Hello, Radio Group! to utilize Shine data-binding syntax from latest glimmer-dsl-swt
+
 ## 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

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.12.0 (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.13.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.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))
+**Alpha Version** 0.13.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.12.0 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0110-pure-ruby-web-gui)
+- [Glimmer DSL for Opal 0.13.0 (Pure Ruby Web GUI)](#-glimmer-dsl-for-opal-0130-pure-ruby-web-gui)
   - [Principles](#principles)
   - [Background](#background)
   - [Pre-requisites](#pre-requisites)
@@ -252,7 +252,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.12.0'
+gem 'glimmer-dsl-opal', '~> 0.13.0'
 gem 'glimmer-dsl-xml', '~> 1.2.0', require: false
 gem 'glimmer-dsl-css', '~> 1.2.0', require: false
 
@@ -1294,7 +1294,7 @@ class HelloRadioGroup
       
       radio_group {
         row_layout :horizontal
-        selection bind(person, :gender)
+        selection <=> [person, :gender]
       }
             
       label {
@@ -1304,7 +1304,7 @@ class HelloRadioGroup
       
       radio_group {
         row_layout :horizontal
-        selection bind(person, :age_group)
+        selection <=> [person, :age_group]
       }
       
       button {
@@ -1383,12 +1383,12 @@ class HelloGroup
         
         radio {
           text 'Male'
-          selection bind(person, :male)
+          selection <=> [person, :male]
         }
         
         radio {
           text 'Female'
-          selection bind(person, :female)
+          selection <=> [person, :female]
         }
       }
       
@@ -1585,7 +1585,7 @@ class HelloCheckboxGroup
       }
       
       checkbox_group {
-        selection bind(person, :activities)
+        selection <=> [person, :activities]
       }
     
       button {

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0

data/lib/glimmer-dsl-opal.rb

@@ -84,7 +84,7 @@ if RUBY_ENGINE == 'opal'
   Element.alias_native :select
   Element.alias_native :dialog
   
-  Glimmer::Config.loop_max_count = 300 # TODO disable
+  Glimmer::Config.loop_max_count = 250 # TODO disable
   
   original_logger_level = Glimmer::Config.logger.level
   Glimmer::Config.logger = Glimmer::Config::OpalLogger.new(STDOUT)

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

@@ -1,5 +1,3 @@
-require 'glimmer-dsl-swt'
-
 require_relative "contact_manager/contact_manager_presenter"
 
 class ContactManager

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

@@ -24,10 +24,10 @@ class HelloCheckbox
     attr_accessor :skiing, :snowboarding, :snowmobiling, :snowshoeing
     
     def initialize
-      reset_activities
+      reset_activities!
     end
     
-    def reset_activities
+    def reset_activities!
       self.skiing = false
       self.snowboarding = true
       self.snowmobiling = false
@@ -35,11 +35,13 @@ class HelloCheckbox
     end
   end
   
-  include Glimmer
+  include Glimmer::UI::CustomShell
   
-  def launch
-    person = Person.new
-    
+  before_body {
+    @person = Person.new
+  }
+  
+  body {
     shell {
       text 'Hello, Checkbox!'
       row_layout :vertical
@@ -52,22 +54,22 @@ class HelloCheckbox
       composite {
         checkbox {
           text 'Skiing'
-          selection <=> [person, :skiing]
+          selection <=> [@person, :skiing]
         }
         
         checkbox {
           text 'Snowboarding'
-          selection <=> [person, :snowboarding]
+          selection <=> [@person, :snowboarding]
         }
         
         checkbox {
           text 'Snowmobiling'
-          selection <=> [person, :snowmobiling]
+          selection <=> [@person, :snowmobiling]
         }
         
         checkbox {
           text 'Snowshoeing'
-          selection <=> [person, :snowshoeing]
+          selection <=> [@person, :snowshoeing]
         }
       }
       
@@ -75,11 +77,11 @@ class HelloCheckbox
         text 'Reset Activities'
         
         on_widget_selected do
-          person.reset_activities
+          @person.reset_activities!
         end
       }
-    }.open
-  end
+    }
+  }
 end
 
-HelloCheckbox.new.launch
+HelloCheckbox.launch

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

@@ -19,6 +19,9 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# This sample demonstrates the use of a `checkbox_group` (aka `check_group`) in Glimmer, which provides terser syntax
+# than HelloCheckbox for representing multiple checkbox buttons (`button(:check)`) by relying on data-binding to
+# automatically spawn the `checkbox` widgets (`button(:check)`) based on available options on the model.
 class HelloCheckboxGroup
   class Person
     attr_accessor :activities
@@ -36,11 +39,13 @@ class HelloCheckboxGroup
     end
   end
   
-  include Glimmer
+  include Glimmer::UI::CustomShell
   
-  def launch
-    person = Person.new
-    
+  before_body {
+    @person = Person.new
+  }
+  
+  body {
     shell {
       text 'Hello, Checkbox Group!'
       row_layout :vertical
@@ -51,18 +56,18 @@ class HelloCheckboxGroup
       }
       
       checkbox_group {
-        selection bind(person, :activities)
+        selection <=> [@person, :activities]
       }
     
       button {
         text 'Reset Activities'
         
         on_widget_selected do
-          person.reset_activities
+          @person.reset_activities
         end
       }
-    }.open
-  end
+    }
+  }
 end
 
-HelloCheckboxGroup.new.launch
+HelloCheckboxGroup.launch

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

@@ -24,10 +24,11 @@ require 'date'
 # This class declares an `email_shell` custom shell, aka custom window (by convention)
 # Used to view an email message
 class EmailShell
+  # including Glimmer::UI::CustomShell enables declaring as an `email_shell` custom widget Glimmer GUI DSL keyword
   include Glimmer::UI::CustomShell
   
   # multiple options without default values
-  options :date, :subject, :from, :message
+  options :parent_shell, :date, :subject, :from, :message
   
   # single option with default value
   option :to, default: '"John Irwin" <john.irwin@example.com>'
@@ -38,7 +39,7 @@ class EmailShell
   
   body {
     # pass received swt_style through to shell to customize it (e.g. :dialog_trim for a blocking shell)
-    shell(swt_style) {
+    shell(parent_shell, swt_style) {
       grid_layout(2, false)
       
       text subject
@@ -73,7 +74,7 @@ class EmailShell
 
       label {
         layout_data(:fill, :fill, true, true) {
-          horizontal_span 2 #TODO implement
+          horizontal_span 2
           vertical_indent 10
         }
         
@@ -86,9 +87,8 @@ class EmailShell
 end
 
 class HelloCustomShell
-  # including Glimmer enables the Glimmer DSL syntax, including auto-discovery of the `email_shell` custom widget
   include Glimmer
-  
+
   Email = Struct.new(:date, :subject, :from, :message, keyword_init: true)
   EmailSystem = Struct.new(:emails, keyword_init: true)
   
@@ -106,7 +106,7 @@ class HelloCustomShell
   end
   
   def launch
-    shell {
+    shell { |shell_proxy|
       grid_layout
       
       text 'Hello, Custom Shell!'
@@ -141,11 +141,15 @@ class HelloCustomShell
         
         on_mouse_up { |event|
           email = event.table_item.get_data
-          Thread.new do
-            async_exec {
-              email_shell(date: email.date, subject: email.subject, from: email.from, message: email.message).open
-            }
-          end
+          
+          # open a custom email shell
+          email_shell(
+            parent_shell: shell_proxy,
+            date: email.date,
+            subject: email.subject,
+            from: email.from,
+            message: email.message
+          ).open
         }
       }
     }.open

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

@@ -55,7 +55,7 @@ class GreetingLabel
     label(swt_style) {
       text "#{greeting}, #{name}!"
       font @font
-      foreground bind(self, :color)
+      foreground <= [self, :color]
     }
   }
   

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

@@ -24,10 +24,10 @@ class HelloRadio
     attr_accessor :male, :female, :child, :teen, :adult, :senior
     
     def initialize
-      reset
+      reset!
     end
     
-    def reset
+    def reset!
       self.male = nil
       self.female = nil
       self.child = nil
@@ -37,11 +37,13 @@ class HelloRadio
     end
   end
   
-  include Glimmer
+  include Glimmer::UI::CustomShell
   
-  def launch
-    person = Person.new
-    
+  before_body {
+    @person = Person.new
+  }
+  
+  body {
     shell {
       text 'Hello, Radio!'
       row_layout :vertical
@@ -56,12 +58,12 @@ class HelloRadio
         
         radio {
           text 'Male'
-          selection <=> [person, :male]
+          selection <=> [@person, :male]
         }
         
         radio {
           text 'Female'
-          selection <=> [person, :female]
+          selection <=> [@person, :female]
         }
       }
       
@@ -75,22 +77,22 @@ class HelloRadio
         
         radio {
           text 'Child'
-          selection <=> [person, :child]
+          selection <=> [@person, :child]
         }
         
         radio {
           text 'Teen'
-          selection <=> [person, :teen]
+          selection <=> [@person, :teen]
         }
         
         radio {
           text 'Adult'
-          selection <=> [person, :adult]
+          selection <=> [@person, :adult]
         }
         
         radio {
           text 'Senior'
-          selection <=> [person, :senior]
+          selection <=> [@person, :senior]
         }
       }
       
@@ -98,11 +100,11 @@ class HelloRadio
         text 'Reset'
         
         on_widget_selected do
-          person.reset
+          @person.reset!
         end
       }
-    }.open
-  end
+    }
+  }
 end
 
-HelloRadio.new.launch
+HelloRadio.launch

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

@@ -19,12 +19,15 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# This sample demonstrates the use of a `radio_group` in Glimmer, which provides terser syntax
+# than HelloRadio for representing multiple radio buttons by relying on data-binding to
+# automatically spawn the `radio` widgets based on available options on the model.
 class HelloRadioGroup
   class Person
     attr_accessor :gender, :age_group
     
     def initialize
-      reset
+      reset!
     end
     
     def gender_options
@@ -35,17 +38,19 @@ class HelloRadioGroup
       ['Child', 'Teen', 'Adult', 'Senior']
     end
     
-    def reset
+    def reset!
       self.gender = nil
       self.age_group = 'Adult'
     end
   end
 
-  include Glimmer
+  include Glimmer::UI::CustomShell
   
-  def launch
-    person = Person.new
-    
+  before_body {
+    @person = Person.new
+  }
+  
+  body {
     shell {
       text 'Hello, Radio Group!'
       row_layout :vertical
@@ -57,7 +62,7 @@ class HelloRadioGroup
       
       radio_group {
         row_layout :horizontal
-        selection bind(person, :gender)
+        selection <=> [@person, :gender]
       }
             
       label {
@@ -67,18 +72,18 @@ class HelloRadioGroup
       
       radio_group {
         row_layout :horizontal
-        selection bind(person, :age_group)
+        selection <=> [@person, :age_group]
       }
       
       button {
         text 'Reset'
         
         on_widget_selected do
-          person.reset
+          @person.reset!
         end
       }
-    }.open
-  end
+    }
+  }
 end
 
-HelloRadioGroup.new.launch
+HelloRadioGroup.launch

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

@@ -196,7 +196,7 @@ class HelloTable
       
       combo(:read_only) {
         layout_data :center, :center, true, false
-        selection bind(BaseballGame, :playoff_type)
+        selection <=> [BaseballGame, :playoff_type]
         font height: 16
       }
       
@@ -263,7 +263,7 @@ class HelloTable
         text 'Book Selected Game'
         layout_data :center, :center, true, false
         font height: 16
-        enabled bind(BaseballGame, :selected_game)
+        enabled <=> [BaseballGame, :selected_game]
         
         on_widget_selected {
           book_selected_game

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

@@ -87,8 +87,8 @@ module Glimmer
   
         def add_content(parent, keyword, *args, &block)
           return unless parent.is_a?(Glimmer::UI::CustomWidget)
-          # TODO consider avoiding source_location
-          if block.source_location == parent.content&.__getobj__.source_location
+          # TODO consider avoiding source_location since it does not work in Opal
+          if block.source_location && (block.source_location == parent.content&.__getobj__&.source_location)
             parent.content.call(parent) unless parent.content.called?
           else
             super

data/lib/glimmer/ui/custom_widget.rb

@@ -83,6 +83,16 @@ module Glimmer
           @after_body_blocks ||= []
           @after_body_blocks << block
         end
+        
+        def keyword
+          self.name.underscore.gsub('::', '__')
+        end
+        
+        # Returns shortcut keyword to use for this custom widget (keyword minus namespace)
+        def shortcut_keyword
+          self.name.underscore.gsub('::', '__').split('__').last
+        end
+        
       end
       
       class << self
@@ -143,7 +153,6 @@ module Glimmer
         def reset_custom_widget_namespaces
           @custom_widget_namespaces = Set[Object, Glimmer::UI]
         end
-
       end
       # <- end of class methods
       
@@ -259,7 +268,7 @@ module Glimmer
       # Otherwise, if a block is passed, it adds it as content to this custom widget
       def content(&block)
         if block_given?
-          body_root.content(&block)
+          Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Opal::CustomWidgetExpression.new, self.class.keyword, &block)
         else
           @content
         end

metadata

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