glimmer-dsl-libui 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68aa91e5f6012112c0ad1ad21492b650e63335ea60f3e2b0a9b7040e94b92030
-  data.tar.gz: ac76c9b9683c69422139b6957f0d966b7a870236408f096c89059b32ee1fa8b9
+  metadata.gz: 686f778cb2f5ec48ff536ba285ea078eaca725dbc9f244630c277de89698909c
+  data.tar.gz: 232094e072370a3d9aa10902659a78ceb61195ad20c897894fc22dc9bdbbcb0b
 SHA512:
-  metadata.gz: 58115e4fba45bffea3cc5645285742e6a5d4d7b8a0e4515365cd722001b5c386e16ff126f9c3800caedfc95508402633af8be0c1644303eb5cae7499bdbc0bac
-  data.tar.gz: b656e89bf37d3e2743dfb5752cdb5e1f482f128b1c078346f8a70f1fdbf97ad38a708956f694a2171c83f3c83a20fe673b50508925a5f5da0540032d9bb5076b
+  metadata.gz: cb9a14df6b910961466bcc4ee970f186e13113991534853d7fdcad8bc4524d61cd0166016ff91f00a9e02d0bcd18708af719f6e3621db9c46d7a55e8867bda6d
+  data.tar.gz: 9d38221eb5e1fe6446febb706b07fb3800e739fc4cf28f6580cb90163256710d78d235669d24c71551f5dc21cf2fa23a6eab556dbbcb11d75bc52cab48f9adab

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.0.2
+
+- Support `vertical_box` and `horizontal_box`
+- Support examples/basic_entry.rb
+
 ## 0.0.1
 
 - LibUI general control and window support

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.0.1
+# [<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.0.2
 ## Dependency-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)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ce2853efdbecf6ebdc73/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-libui/maintainability)
@@ -6,6 +6,8 @@
 
 [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is a dependency-free Ruby desktop development GUI library. No need to pre-install any pre-requisites. Just install the gem and have platform-independent GUI that just works!
 
+The main trade-off against [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) and [Glimmer DSL for Tk](https://github.com/AndyObtiva/glimmer-dsl-tk) is the fact that [SWT](https://www.eclipse.org/swt/) and [Tk](https://www.tcl.tk/) are more mature than [LibUI](https://github.com/kojix2/LibUI) as GUI toolkits. Still, if there is only a need to build a small simple application, [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) could be a pretty good choice due to having zero external dependencies beyond what is included in the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui).
+
 [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui) aims to provide a DSL similar to the [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) to enable more productive desktop development in Ruby with:
 - Declarative DSL syntax that visually maps to the GUI widget hierarchy
 - Convention over configuration via smart defaults and automation of low-level details
@@ -15,6 +17,28 @@
 - Scaffolding for new custom widgets, apps, and gems
 - Native-Executable packaging on Mac, Windows, and Linux
 
+Example:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('hello world', 300, 200, 1).show
+```
+
+![glimmer-dsl-libui-basic-window-mac.png](images/glimmer-dsl-libui-basic-window-mac.png)
+![glimmer-dsl-libui-basic-window-linux.png](images/glimmer-dsl-libui-basic-window-linux.png)
+
+NOTE: [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is in early alpha mode. 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.
+
+Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interested in:
+- [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)
+- [glimmer-dsl-opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps)
+- [glimmer-dsl-xml](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML)
+- [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS
+- [glimmer-dsl-tk](https://github.com/AndyObtiva/glimmer-dsl-tk): Glimmer DSL for Tk (MRI Ruby Desktop Development GUI Library)
+
 ## Glimmer GUI DSL Concepts
 
 The Glimmer GUI DSL provides a declarative syntax for [LibUI](https://github.com/kojix2/LibUI) that:
@@ -70,6 +94,18 @@ window('hello world', 300, 200, 1) {
 
 ## Usage
 
+Install [glimmer-dsl-libui](https://rubygems.org/gems/glimmer-dsl-libui) gem directly:
+
+```
+gem install glimmer-dsl-libui
+```
+ 
+Or install via Bundler `Gemfile`:
+
+```ruby
+gem 'glimmer-dsl-libui', '~> 0.0.2'
+```
+
 Add `require 'glimmer-dsl-libui'` at the top, and then `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
 
 Example (you may copy/paste in [`girb`](#girb-glimmer-irb)):
@@ -87,10 +123,6 @@ class Application
           puts 'Button Clicked'
         end
       }
-      
-      on_closing do
-        puts 'Bye Bye'
-      end
     }.show
   end
 end
@@ -127,12 +159,24 @@ Gotcha: On the Mac, when you close a window opened in `girb`, it remains open un
 
 ## Examples
 
-These examples reimplement the ones in the [LibUI](https://github.com/kojix2/LibUI) project utilizing the shorter Glimmer GUI DSL syntax.
+These examples reimplement the ones in the [LibUI](https://github.com/kojix2/LibUI) project utilizing the Glimmer GUI DSL.
 
 ### Basic Window
 
 [examples/basic_window.rb](examples/basic_window.rb)
 
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_window.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_window'"
+```
+
 Mac
 
 ![glimmer-dsl-libui-basic-window-mac.png](images/glimmer-dsl-libui-basic-window-mac.png)
@@ -183,6 +227,18 @@ window('hello world', 300, 200, 1) {
 
 [examples/basic_button.rb](examples/basic_button.rb)
 
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_button.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_button'"
+```
+
 Mac
 
 ![glimmer-dsl-libui-basic-button-mac.png](images/glimmer-dsl-libui-basic-button-mac.png)
@@ -244,6 +300,107 @@ window('hello world', 300, 200, 1) { |w|
 }.show
 ```
 
+### Basic Entry
+
+[examples/basic_entry.rb](examples/basic_entry.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_entry.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_entry'"
+```
+
+Mac
+
+![glimmer-dsl-libui-basic-entry-mac.png](images/glimmer-dsl-libui-basic-entry-mac.png)
+![glimmer-dsl-libui-basic-entry-msg-box-mac.png](images/glimmer-dsl-libui-basic-entry-msg-box-mac.png)
+
+Linux
+
+![glimmer-dsl-libui-basic-entry-linux.png](images/glimmer-dsl-libui-basic-entry-linux.png)
+![glimmer-dsl-libui-basic-entry-msg-box-linux.png](images/glimmer-dsl-libui-basic-entry-msg-box-linux.png)
+
+[LibUI](https://github.com/kojix2/LibUI) Original Version:
+
+```ruby
+require 'libui'
+
+UI = LibUI
+
+UI.init
+
+main_window = UI.new_window('Basic Entry', 300, 50, 1)
+UI.window_on_closing(main_window) do
+  puts 'Bye Bye'
+  UI.control_destroy(main_window)
+  UI.quit
+  0
+end
+
+hbox = UI.new_horizontal_box
+UI.window_set_child(main_window, hbox)
+
+entry = UI.new_entry
+UI.entry_on_changed(entry) do
+  puts UI.entry_text(entry).to_s
+  $stdout.flush # For Windows
+end
+UI.box_append(hbox, entry, 1)
+
+button = UI.new_button('Button')
+UI.button_on_clicked(button) do
+  text = UI.entry_text(entry).to_s
+  UI.msg_box(main_window, 'You entered', text)
+  0
+end
+
+UI.box_append(hbox, button, 0)
+
+UI.control_show(main_window)
+UI.main
+UI.quit
+```
+
+[Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Basic Entry', 300, 50, 1) { |w|
+  horizontal_box {
+    e = entry {
+      stretchy 1
+    
+      on_changed do
+        puts e.text
+        $stdout.flush # For Windows
+      end
+    }
+    
+    button('Button') {
+      stretchy 0
+      
+      on_clicked do
+        text = e.text
+        msg_box(w, 'You entered', text)
+      end
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show
+```
+
 ## Contributing to glimmer-dsl-libui
 
 -   Check out the latest master to make sure the feature hasn't been

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/basic_entry.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('Basic Entry', 300, 50, 1) { |w|
+  horizontal_box {
+    e = entry {
+      stretchy 1
+    
+      on_changed do
+        puts e.text
+        $stdout.flush # For Windows
+      end
+    }
+    
+    button('Button') {
+      stretchy 0
+      
+      on_clicked do
+        text = e.text
+        msg_box(w, 'You entered', text)
+      end
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

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

@@ -46,5 +46,8 @@ module Glimmer
   end
 end
 
+# TODO Consider moving all controls underneath Control namespace
 require 'glimmer/libui/control_proxy'
 require 'glimmer/libui/window_proxy'
+require 'glimmer/libui/horizontal_box_proxy'
+require 'glimmer/libui/vertical_box_proxy'

data/lib/glimmer/libui/box.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 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.
+
+module Glimmer
+  module LibUI
+    module Box
+      APPEND_PROPERTIES = %w[stretchy]
+      
+      def post_initialize_child(child)
+        child.stretchy = 1 if child.stretchy.nil?
+        ::LibUI.box_append(@libui, child.libui, child.stretchy)
+      end
+    end
+  end
+end

data/lib/glimmer/libui/control_proxy.rb

@@ -30,8 +30,8 @@ module Glimmer
           ::LibUI.respond_to?("new_#{keyword}") || ::LibUI.respond_to?(keyword)
         end
         
-        def create(keyword, parent, args)
-          widget_proxy_class(keyword).new(keyword, parent, args)
+        def create(keyword, parent, args, &block)
+          widget_proxy_class(keyword).new(keyword, parent, args, &block)
         end
         
         def widget_proxy_class(keyword)
@@ -51,16 +51,24 @@ module Glimmer
         @keyword = keyword
         @parent_proxy = parent
         @args = args
+        @block = block
         build_control
-        if @parent_proxy.is_a?(WindowProxy)
-          ::LibUI.window_set_child(@parent_proxy.libui, @libui)
+        if @parent_proxy.class.constants.include?(:APPEND_PROPERTIES)
+          @parent_proxy.class::APPEND_PROPERTIES
         end
+        post_add_content if @block.nil?
       end
       
+      # Subclasses may override to perform post add_content work (normally must call super)
       def post_add_content
-        # No Op by default
+        @parent_proxy&.post_initialize_child(self)
       end
       
+      # Subclasses may override to perform post initialization work on an added child
+      def post_initialize_child(child)
+        # No Op by default
+      end
+
       def can_handle_listener?(listener_name)
         ::LibUI.respond_to?("control_#{listener_name}") || ::LibUI.respond_to?("#{@keyword}_#{listener_name}")
       end
@@ -74,7 +82,9 @@ module Glimmer
       end
       
       def respond_to?(method_name, *args, &block)
-        respond_to_libui?(method_name, *args, &block) || super
+        respond_to_libui?(method_name, *args, &block) ||
+          (append_properties.include?(method_name.to_s) || append_properties.include?(method_name.to_s.sub(/=$/, ''))) ||
+          super
       end
       
       def respond_to_libui?(method_name, *args, &block)
@@ -87,6 +97,8 @@ module Glimmer
       def method_missing(method_name, *args, &block)
         if respond_to_libui?(method_name, *args, &block)
           send_to_libui(method_name, *args, &block)
+        elsif (append_properties.include?(method_name.to_s) || append_properties.include?(method_name.to_s.sub(/=$/, '')))
+          append_property(method_name, *args)
         else
           super
         end
@@ -106,6 +118,20 @@ module Glimmer
         end
       end
       
+      def append_properties
+        @parent_proxy&.class&.constants&.include?(:APPEND_PROPERTIES) ? @parent_proxy.class::APPEND_PROPERTIES : []
+      end
+      
+      def append_property(property, value = nil)
+        property = property.to_s.sub(/=$/, '')
+        @append_property_hash ||= {}
+        if value.nil?
+          @append_property_hash[property]
+        else
+          @append_property_hash[property] = value
+        end
+      end
+      
       private
       
       def build_control

data/lib/glimmer/libui/horizontal_box_proxy.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 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/libui/control_proxy'
+require 'glimmer/libui/box'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI Window objects
+    #
+    # Follows the Proxy Design Pattern
+    class HorizontalBoxProxy < ControlProxy
+      include Box
+    end
+  end
+end

data/lib/glimmer/libui/vertical_box_proxy.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 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/libui/control_proxy'
+require 'glimmer/libui/box'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI Window objects
+    #
+    # Follows the Proxy Design Pattern
+    class VerticalBoxProxy < ControlProxy
+      include Box
+    end
+  end
+end

data/lib/glimmer/libui/window_proxy.rb

@@ -27,6 +27,10 @@ module Glimmer
     #
     # Follows the Proxy Design Pattern
     class WindowProxy < ControlProxy
+      def post_initialize_child(child)
+        ::LibUI.window_set_child(@libui, child.libui)
+      end
+    
       def show
         send_to_libui('show')
         unless @shown_at_least_once

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -161,6 +161,7 @@ files:
 - bin/girb
 - bin/girb_runner.rb
 - examples/basic_button.rb
+- examples/basic_entry.rb
 - examples/basic_window.rb
 - glimmer-dsl-libui.gemspec
 - lib/glimmer-dsl-libui.rb
@@ -168,7 +169,10 @@ files:
 - lib/glimmer/dsl/libui/dsl.rb
 - lib/glimmer/dsl/libui/listener_expression.rb
 - lib/glimmer/dsl/libui/property_expression.rb
+- lib/glimmer/libui/box.rb
 - lib/glimmer/libui/control_proxy.rb
+- lib/glimmer/libui/horizontal_box_proxy.rb
+- lib/glimmer/libui/vertical_box_proxy.rb
 - lib/glimmer/libui/window_proxy.rb
 homepage: http://github.com/AndyObtiva/glimmer-dsl-libui
 licenses: