glimmer-dsl-libui 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48926d5aab22eec664c80bc9ebe5a94a841e4b6173cca343ad9876fb33924b03
-  data.tar.gz: 890dba3f171225448aad354ec767819faaf3cb59e48764adc63b0f35bcbc0fe3
+  metadata.gz: a5ccd1c22e43fbb8401dff62f07008895ad88522452f079112998d0e10f58d72
+  data.tar.gz: 9820c416164d39189ca3d6cfc90076b566b68b3c5e50b293e85d97edd2d4d04b
 SHA512:
-  metadata.gz: 94650e60ccb1ed496dd682f937e4a91a3cffad37cfc3da17c462fd2db7349e06af9572c425f1b90d8a3a522c09eddd2b7eed6b4982c31a77fff97322aff6bbed
-  data.tar.gz: fc41c1e9882b42155729547ee2d83e43a40a64ae56c2523ff880cd2f818357fb42328a72b79810ccfb75fc7356ac70910e1d4202249488cb4f8aef9d3a8034fe
+  metadata.gz: 545d81430224a9e197ddc4cd15168af5a3cd5f0d24c20f405bb5db3bbe499e38fa0339697e254dd100d7a76aa733fc98f7c3d3f9a8f824dc45a0fc13c4651b24
+  data.tar.gz: 41f91f675dab3a0ecc4004ddc6670db3770127e03dce01143c5be0996894abe9960ee7c6c2ef89166f88faaa6529e24a437821f6b59ce4f764a6c3f7407313cd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.5.7
+
+- Support Custom Window keywords (aka Applications) using `Glimmer::LibUI::CustomWindow` or alias of `Glimmer::LibUI::Application`
+- Refactor examples/class_based_custom_controls.rb to use `Glimmer::LibUI::Application` (alias: `Glimmer::LibUI::CustomWindow`)
+
 ## 0.5.6
 
 - Upgrade to glimmer 2.7.1 and document its support for keyed data-binding

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 LibUI 0.5.6
+# [<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 LibUI 0.5.7
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
 [![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)
@@ -577,7 +577,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.5.6'
+gem 'glimmer-dsl-libui', '~> 0.5.7'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -1704,6 +1704,136 @@ window('Method-Based Custom Keyword') {
 
 ![glimmer-dsl-libui-mac-method-based-custom-keyword.png](images/glimmer-dsl-libui-mac-method-based-custom-keyword.png)
 
+You can also define Custom Window keywords, that is custom controls with `window` being the body root. These are also known as Applications. To define a Custom Window, you `include Glimmer::LibUI::CustomWindow` or `include Glimmer:LibUI::Application` and then you can invoke the `::launch` method on the class.
+
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb)):
+
+```ruby
+require 'glimmer-dsl-libui'
+require 'facets'
+
+Address = Struct.new(:street, :p_o_box, :city, :state, :zip_code)
+
+class FormField
+  include Glimmer::LibUI::CustomControl
+  
+  options :model, :attribute
+  
+  body {
+    entry { |e|
+      label attribute.to_s.underscore.split('_').map(&:capitalize).join(' ')
+      text <=> [model, attribute]
+    }
+  }
+end
+
+class AddressForm
+  include Glimmer::LibUI::CustomControl
+  
+  options :address
+  
+  body {
+    form {
+      form_field(model: address, attribute: :street)
+      form_field(model: address, attribute: :p_o_box)
+      form_field(model: address, attribute: :city)
+      form_field(model: address, attribute: :state)
+      form_field(model: address, attribute: :zip_code)
+    }
+  }
+end
+
+class LabelPair
+  include Glimmer::LibUI::CustomControl
+  
+  options :model, :attribute, :value
+  
+  body {
+    horizontal_box {
+      label(attribute.to_s.underscore.split('_').map(&:capitalize).join(' '))
+      label(value.to_s) {
+        text <= [model, attribute]
+      }
+    }
+  }
+end
+
+class AddressView
+  include Glimmer::LibUI::CustomControl
+  
+  options :address
+  
+  body {
+    vertical_box {
+      address.each_pair do |attribute, value|
+        label_pair(model: address, attribute: attribute, value: value)
+      end
+    }
+  }
+end
+
+class ClassBasedCustomControls
+  include Glimmer::LibUI::Application # alias: Glimmer::LibUI::CustomWindow
+  
+  before_body do
+    @address1 = Address.new('123 Main St', '23923', 'Denver', 'Colorado', '80014')
+    @address2 = Address.new('2038 Park Ave', '83272', 'Boston', 'Massachusetts', '02101')
+  end
+  
+  body {
+    window('Class-Based Custom Keyword') {
+      margined true
+      
+      horizontal_box {
+        vertical_box {
+          label('Address 1') {
+            stretchy false
+          }
+          
+          address_form(address: @address1)
+          
+          horizontal_separator {
+            stretchy false
+          }
+          
+          label('Address 1 (Saved)') {
+            stretchy false
+          }
+          
+          address_view(address: @address1)
+        }
+        
+        vertical_separator {
+          stretchy false
+        }
+        
+        vertical_box {
+          label('Address 2') {
+            stretchy false
+          }
+          
+          address_form(address: @address2)
+          
+          horizontal_separator {
+            stretchy false
+          }
+          
+          label('Address 2 (Saved)') {
+            stretchy false
+          }
+          
+          address_view(address: @address2)
+        }
+      }
+    }
+  }
+end
+
+ClassBasedCustomControls.launch
+```
+
+![glimmer-dsl-libui-mac-method-based-custom-keyword.png](images/glimmer-dsl-libui-mac-method-based-custom-keyword.png)
+
 The [`area`](#area-api) control can be utilized to build non-native custom controls from scratch by leveraging vector graphics, formattable text, keyboard events, and mouse events. This is demonstrated in the [Area-Based Custom Controls](#area-based-custom-controls) example.
 
 Defining custom keywords enables unlimited extension of the [Glimmer GUI DSL](#glimmer-gui-dsl). The sky is the limit on what can be done with custom keywords as a result. You can compose new visual vocabulary to build applications in any domain from higher concepts rather than [mere standard controls](#supported-keywords). For example, in a traffic signaling app, you could define `street`, `light_signal`, `traffic_sign`, and `car` as custom keywords and build your application from these concepts directly, saving enormous time and achieving much higher productivity.

data/VERSION

@@ -1 +1 @@
-0.5.6
+0.5.7

data/examples/class_based_custom_controls.rb

@@ -1,8 +1,6 @@
 require 'glimmer-dsl-libui'
 require 'facets'
 
-include Glimmer
-
 Address = Struct.new(:street, :p_o_box, :city, :state, :zip_code)
 
 class FormField
@@ -63,51 +61,61 @@ class AddressView
   }
 end
 
-address1 = Address.new('123 Main St', '23923', 'Denver', 'Colorado', '80014')
-address2 = Address.new('2038 Park Ave', '83272', 'Boston', 'Massachusetts', '02101')
-
-window('Class-Based Custom Keyword') {
-  margined true
+class ClassBasedCustomControls
+  include Glimmer::LibUI::Application # alias: Glimmer::LibUI::CustomWindow
   
-  horizontal_box {
-    vertical_box {
-      label('Address 1') {
-        stretchy false
-      }
-      
-      address_form(address: address1)
-      
-      horizontal_separator {
-        stretchy false
-      }
-      
-      label('Address 1 (Saved)') {
-        stretchy false
-      }
-      
-      address_view(address: address1)
-    }
-    
-    vertical_separator {
-      stretchy false
-    }
-    
-    vertical_box {
-      label('Address 2') {
-        stretchy false
-      }
-      
-      address_form(address: address2)
-      
-      horizontal_separator {
-        stretchy false
-      }
+  before_body do
+    @address1 = Address.new('123 Main St', '23923', 'Denver', 'Colorado', '80014')
+    @address2 = Address.new('2038 Park Ave', '83272', 'Boston', 'Massachusetts', '02101')
+  end
+  
+  body {
+    window('Class-Based Custom Keyword') {
+      margined true
       
-      label('Address 2 (Saved)') {
-        stretchy false
+      horizontal_box {
+        vertical_box {
+          label('Address 1') {
+            stretchy false
+          }
+          
+          address_form(address: @address1)
+          
+          horizontal_separator {
+            stretchy false
+          }
+          
+          label('Address 1 (Saved)') {
+            stretchy false
+          }
+          
+          address_view(address: @address1)
+        }
+        
+        vertical_separator {
+          stretchy false
+        }
+        
+        vertical_box {
+          label('Address 2') {
+            stretchy false
+          }
+          
+          address_form(address: @address2)
+          
+          horizontal_separator {
+            stretchy false
+          }
+          
+          label('Address 2 (Saved)') {
+            stretchy false
+          }
+          
+          address_view(address: @address2)
+        }
       }
-      
-      address_view(address: address2)
     }
   }
-}.show
+end
+
+ClassBasedCustomControls.launch

data/lib/glimmer/dsl/libui/custom_control_expression.rb

@@ -24,6 +24,7 @@ require 'glimmer/dsl/expression'
 require 'glimmer/dsl/parent_expression'
 require 'glimmer/dsl/top_level_expression'
 require 'glimmer/libui/custom_control'
+require 'glimmer/libui/custom_window'
 
 module Glimmer
   module DSL

data/lib/glimmer/libui/custom_control.rb

@@ -21,6 +21,7 @@
 
 require 'super_module'
 require 'glimmer'
+require 'glimmer/error'
 require 'glimmer/proc_tracker'
 require 'glimmer/data_binding/observer'
 require 'glimmer/data_binding/observable_model'
@@ -33,8 +34,10 @@ module Glimmer
 
       super_module_included do |klass|
         # TODO clear memoization of WidgetProxy.libui_class_for for a keyword if a custom control was defined with that keyword
-        klass.include(Glimmer)
-        Glimmer::LibUI::CustomControl.add_custom_control_namespaces_for(klass)
+        unless klass.name.include?('Glimmer::LibUI::CustomWindow')
+          klass.include(Glimmer)
+          Glimmer::LibUI::CustomControl.add_custom_control_namespaces_for(klass)
+        end
       end
     
       class << self

data/lib/glimmer/libui/custom_window.rb

@@ -0,0 +1,61 @@
+# Copyright (c) 2021-2022 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 'super_module'
+require 'glimmer/libui/custom_control'
+require 'glimmer/error'
+
+module Glimmer
+  module LibUI
+    module CustomWindow
+      include SuperModule
+      include Glimmer::LibUI::CustomControl
+      
+      class << self
+        def launch(*args, &content)
+          launched_custom_shell = send(keyword, *args, &content)
+          launched_custom_shell.show
+        end
+      end
+      
+      def initialize(parent, *swt_constants, options, &content)
+        super
+        raise Glimmer::Error, 'Invalid custom window body root! Must be a window, another custom window, or a custom control with window as its body root!' unless body_root.is_a?(Glimmer::LibUI::ControlProxy::WindowProxy) || body_root.is_a?(Glimmer::LibUI::CustomWindow) || (body_root.is_a?(Glimmer::LibUI::CustomControl) && body_root.body_root.is_a?(Glimmer::LibUI::ControlProxy::WindowProxy))
+      end
+      
+      # Classes may override
+      def show
+        body_root.show
+      end
+
+      # TODO consider using Forwardable instead
+      def destroy
+        body_root.destroy
+      end
+
+      def destroying?
+        body_root.destroying?
+      end
+    end
+    
+    Application = CustomWindow
+  end
+end

data/lib/glimmer-dsl-libui/ext/glimmer.rb

@@ -0,0 +1,7 @@
+module Glimmer
+  class << self
+    def included(klass)
+      klass.extend(Glimmer)
+    end
+  end
+end

data/lib/glimmer-dsl-libui.rb

@@ -37,7 +37,7 @@ require 'libui'
 
 # Internal requires
 # require 'ext/glimmer/config'
-# require 'ext/glimmer'
+require 'glimmer-dsl-libui/ext/glimmer'
 require 'glimmer/dsl/libui/dsl'
 require 'glimmer/libui'
 Glimmer::Config.loop_max_count = -1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -358,6 +358,7 @@ files:
 - icons/blank.png
 - icons/glimmer.png
 - lib/glimmer-dsl-libui.rb
+- lib/glimmer-dsl-libui/ext/glimmer.rb
 - lib/glimmer/dsl/libui/bind_expression.rb
 - lib/glimmer/dsl/libui/control_expression.rb
 - lib/glimmer/dsl/libui/custom_control_expression.rb
@@ -443,6 +444,7 @@ files:
 - lib/glimmer/libui/control_proxy/triple_column.rb
 - lib/glimmer/libui/control_proxy/window_proxy.rb
 - lib/glimmer/libui/custom_control.rb
+- lib/glimmer/libui/custom_window.rb
 - lib/glimmer/libui/data_bindable.rb
 - lib/glimmer/libui/image_path_renderer.rb
 - lib/glimmer/libui/parent.rb