glimmer-dsl-libui 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa989bad8bba6c9e59285e38a699b7842eb7f089a976782ac75363debfd829e
-  data.tar.gz: '081812a749e0ab795dfafcac60b58ab639f50933580f5ed3e404354691dd3d94'
+  metadata.gz: 709fb51692fedecbca6438b288711c2fb7f3a71cb5ce5f5f16e1a5c9629bc5fb
+  data.tar.gz: 2706858ead6f7bf47f042be22cc40b0546706de8c4c7cfbfdf7457aeb007fa3a
 SHA512:
-  metadata.gz: 2e189f2db6399f9f718a06ca68b82665c7d9b54031dc62a76af1a4bb056f1299f40fe9993940163594157bdfcd649635cc27967aaadb7b709286d0b630d9b584
-  data.tar.gz: 5289461f384cf3237add39dba3fba83448c117d63ca53ac8e5dcc0af33cb4683179e077a712e927615825fc226bf94b234b4088e45b3f8de6c7b97a0d480c3a4
+  metadata.gz: 8b501a86cf85fb6b1c488580b76336765cf1d2fbdf864edf16e3587bba80710a900a05186e0c9e3f67a667ab64fbaf3ebcf1ec54c4ebbfb8e41ddd7b77f93555
+  data.tar.gz: 5e1f94ad2479f71d54a163d69d6c266eac9f361909e3c305e04afc073c882178ac1dba80fbc9927a7037a93593000eb469e0c7a9e0342003ced8cf349ddfd6ae

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.10
+
+- Support examples/font_button.rb
+- Support `font_button` control
+- Add File -> Quit menu item to examples/meta_example.rb
+- Glimmer Style Guide added to README.md
+
 ## 0.0.9
 
 - Build a meta-example (example of examples)

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.9
+# [<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.10
 ## 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)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ce2853efdbecf6ebdc73/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer-dsl-libui/maintainability)
@@ -6,17 +6,17 @@
 
 [Glimmer](https://github.com/AndyObtiva/glimmer) DSL for [LibUI](https://github.com/kojix2/LibUI) is a prerequisite-free Ruby desktop development GUI library. No need to pre-install any prerequisites. Just install the gem and have platform-independent native GUI that just works!
 
-[LibUI](https://github.com/kojix2/LibUI) is a thin [Ruby](https://www.ruby-lang.org/en/) wrapper around [libui](https://github.com/andlabs/libui), a relatively new C GUI library that renders native widgets on every platform (similar to [SWT](https://www.eclipse.org/swt/), but without the heavy weight of the [Java Virtual Machine](https://www.java.com/en/)).
+[LibUI](https://github.com/kojix2/LibUI) is a thin [Ruby](https://www.ruby-lang.org/en/) wrapper around [libui](https://github.com/andlabs/libui), a relatively new C GUI library that renders native controls on every platform (similar to [SWT](https://www.eclipse.org/swt/), but without the heavy weight of the [Java Virtual Machine](https://www.java.com/en/)).
 
 The main trade-off in using [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) as opposed to [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) or [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 mid-alpha [libui](https://github.com/andlabs/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 good convenient choice due to having zero prerequisites beyond the dependencies included in the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui). Also, just like [Glimmer DSL for Tk](https://github.com/AndyObtiva/glimmer-dsl-tk), its apps start instantly and have a small memory footprint. [LibUI](https://github.com/kojix2/LibUI) is a promising new GUI toolkit that might prove quite worthy in the future.
 
 [Glimmer DSL for LibUI](https://rubygems.org/gems/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
+- Declarative DSL syntax that visually maps to the GUI control hierarchy
 - Convention over configuration via smart defaults and automation of low-level details
 - Requiring the least amount of syntax possible to build GUI
 - Bidirectional Data-Binding to declaratively wire and automatically synchronize GUI with Business Models
-- Custom Widget support
-- Scaffolding for new custom widgets, apps, and gems
+- Custom Control support
+- Scaffolding for new custom controls, apps, and gems
 - Native-Executable packaging on Mac, Windows, and Linux.
 
 Example:
@@ -43,7 +43,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 ## Table of Contents
 
-- [Glimmer DSL for LibUI 0.0.9](#-glimmer-dsl-for-libui-009)
+- [Glimmer DSL for LibUI 0.0.10](#-glimmer-dsl-for-libui-0010)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -54,6 +54,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Extra Operations](#extra-operations)
     - [Smart Defaults and Conventions](#smart-defaults-and-conventions)
     - [Original API](#original-api)
+  - [Glimmer Style Guide](#glimmer-style-guide)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Examples](#examples)
     - [Basic Window](#basic-window)
@@ -62,6 +63,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Simple Notepad](#simple-notepad)
     - [Midi Player](#midi-player)
     - [Control Gallery](#control-gallery)
+    - [Font Button](#font-button)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -76,9 +78,9 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
 
 The Glimmer GUI DSL provides object-oriented declarative hierarchical syntax for [LibUI](https://github.com/kojix2/LibUI) that:
 - Supports smart defaults (e.g. automatic `on_closing` listener that quits `window`)
-- Automates wiring of widgets (e.g. `button` is automatically set as child of `window`)
+- Automates wiring of controls (e.g. `button` is automatically set as child of `window`)
 - Hides lower-level details (e.g. `LibUI.main` loop is started automatically when triggering `show` on `window`)
-- Nests widgets according to their visual hierarchy
+- Nests controls according to their visual hierarchy
 - Requires the minimum amount of syntax needed to describe an app's GUI
 
 The Glimmer GUI DSL follows these simple concepts in mapping from [LibUI](https://github.com/kojix2/LibUI) syntax:
@@ -149,7 +151,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.9'
+gem 'glimmer-dsl-libui', '~> 0.0.10'
 ```
 
 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.
@@ -213,7 +215,7 @@ Control(Args) | Properties | Listeners
 `date_time_picker` | `time` (`LibUI::FFI::TM`) | `on_changed`
 `editable_combobox` | `items` (`Array` of `String`), `text` (`String`) | `on_changed`
 `entry` | `read_only` (Boolean), `text` (`String`) | `on_changed`
-`font_button` | `font` (`LibUI::FFI::FontDescriptor`) | `on_changed`
+`font_button` | `font` [read-only] (`Hash` of keys: `:family`, `:size`, `:weight`, `:italic`, `:stretch`) | `on_changed`
 `group(text as String)` | `margined` (Boolean), `title` (`String`) | None
 `horizontal_box` | `padded` (Boolean) | None
 `horizontal_separator` | None | None
@@ -276,12 +278,22 @@ Control(Args) | Properties | Listeners
 - All boolean property readers return `true` or `false` in Ruby instead of the [libui](https://github.com/andlabs/libui) original `0` or `1` in C.
 - All boolean property writers accept `true`/`false` in addition to `1`/`0` in Ruby
 - All string property readers return a `String` object in Ruby instead of the [libui](https://github.com/andlabs/libui) Fiddle pointer object.
+- Automatically allocate font descriptors upon instantiating `font_button` controls and free font descriptors when destorying `font_button` controls
 
 ### Original API
 
 To learn more about the [LibUI](https://github.com/kojix2/LibUI) API exposed through [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui),
 check out the [libui C headers](https://github.com/andlabs/libui/blob/master/ui.h)
 
+## Glimmer Style Guide
+
+- Control arguments are always wrapped inside parentheses
+- Control blocks are always declared with curly braces to clearly visualize hierarchical view code and separate from logic code
+- Control property declarations always have arguments and never take a block
+- Control property arguments are never wrapped inside parentheses
+- Control listeners are always declared starting with on_ prefix and affixing listener event method name afterwards in underscored lowercase form. Their multi-line blocks have a `do; end` style.
+- Pure logic multi-line blocks that do not constitute GUI DSL view elements have `do; end` style to clearly separate logic code from view code.
+
 ## Girb (Glimmer IRB)
 
 You can run the `girb` command (`bin/girb` if you cloned the project locally):
@@ -346,6 +358,10 @@ class MetaExample
   end
   
   def launch
+    menu('File') {
+      quit_menu_item
+    }
+    
     window('Meta-Example', 700, 500) { |w|
       margined true
       
@@ -1324,6 +1340,91 @@ MAIN_WINDOW = window('Control Gallery', 600, 500) {
 MAIN_WINDOW.show
 ```
 
+### Font Button
+
+[examples/font_button.rb](examples/font_button.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/font_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/font_button'"
+```
+
+Mac
+
+![glimmer-dsl-libui-mac-font-button.png](images/glimmer-dsl-libui-mac-font-button.png)
+![glimmer-dsl-libui-mac-font-button-selection.png](images/glimmer-dsl-libui-mac-font-button-selection.png)
+
+Linux
+
+![glimmer-dsl-libui-linux-font-button.png](images/glimmer-dsl-libui-linux-font-button.png)
+![glimmer-dsl-libui-linux-font-button-selection.png](images/glimmer-dsl-libui-linux-font-button-selection.png)
+
+[LibUI](https://github.com/kojix2/LibUI) Original Version:
+
+```ruby
+require 'libui'
+
+UI = LibUI
+
+UI.init
+
+main_window = UI.new_window('hello world', 300, 200, 1)
+
+font_button = UI.new_font_button
+font_descriptor = UI::FFI::FontDescriptor.malloc
+UI.font_button_on_changed(font_button) do
+  UI.font_button_font(font_button, font_descriptor)
+  p family: font_descriptor.Family.to_s,
+    size: font_descriptor.Size,
+    weight: font_descriptor.Weight,
+    italic: font_descriptor.Italic,
+    stretch: font_descriptor.Stretch
+end
+
+UI.window_on_closing(main_window) do
+  puts 'Bye Bye'
+  UI.control_destroy(main_window)
+  UI.quit
+  0
+end
+
+UI.window_set_child(main_window, font_button)
+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('hello world', 300, 200) {
+  font_button { |fb|
+    on_changed do
+      font_descriptor = fb.font
+      p font_descriptor
+    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.9
+0.0.10

data/examples/font_button.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+window('hello world', 300, 200) {
+  font_button { |fb|
+    on_changed do
+      font_descriptor = fb.font
+      p font_descriptor
+    end
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

data/examples/meta_example.rb

@@ -21,6 +21,10 @@ class MetaExample
   end
   
   def launch
+    menu('File') {
+      quit_menu_item
+    }
+    
     window('Meta-Example', 700, 500) { |w|
       margined true
       

data/lib/glimmer/libui/font_button_proxy.rb

@@ -0,0 +1,48 @@
+# 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'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI font button objects
+    #
+    # Follows the Proxy Design Pattern
+    class FontButtonProxy < ControlProxy
+      def font
+        @font_descriptor ||= ::LibUI::FFI::FontDescriptor.malloc
+        ::LibUI.font_button_font(@libui, @font_descriptor)
+        {
+          family: @font_descriptor.Family.to_s,
+          size: @font_descriptor.Size,
+          weight: @font_descriptor.Weight,
+          italic: @font_descriptor.Italic,
+          stretch: @font_descriptor.Stretch
+        }
+      end
+      
+      def destroy
+        ::LibUI.free_font_button_font(@font_descriptor) unless @font_descriptor.nil?
+        super
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Andy Maleh
@@ -165,6 +165,7 @@ files:
 - examples/basic_window.rb
 - examples/basic_window2.rb
 - examples/control_gallery.rb
+- examples/font_button.rb
 - examples/meta_example.rb
 - examples/midi_player.rb
 - examples/simple_notepad.rb
@@ -186,6 +187,7 @@ files:
 - lib/glimmer/libui/date_picker_proxy.rb
 - lib/glimmer/libui/date_time_picker_proxy.rb
 - lib/glimmer/libui/editable_combobox_proxy.rb
+- lib/glimmer/libui/font_button_proxy.rb
 - lib/glimmer/libui/group_proxy.rb
 - lib/glimmer/libui/horizontal_box_proxy.rb
 - lib/glimmer/libui/menu_item_proxy.rb