glimmer-dsl-libui 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05618c68efbc037c1da16b8644529316d97a8e8d3ac6dba4df8d74eb64264809'
-  data.tar.gz: e2b56cf6d20fdd6091d3e2701b731ba34f770d63aaaf1c2eb5ba2f88c75fa914
+  metadata.gz: 6e66ca998dc3b30b4a9ef856b9d23f4359d9b24a4f1a1805760b5912c675310f
+  data.tar.gz: 1e464fd9986e1516709e919c3aba9307b90dc0498c1f478050f5cfc54b3ca377
 SHA512:
-  metadata.gz: 7c62fb459566fc5c0dd428696809ae1a451e64beec43aa0fcc4c577ec976797000b7cef484bb6614f7019441de197bac75e5ed6ffeb6b8cae500b6db60e3e964
-  data.tar.gz: 702b6218d118543c7dbdfa825452dd59f469d0f9cd0aa8bbded05d04d44479c2bfb0e89d9cddce710052239c92d9f4efd932eab45f3acbf9ca627ec654786427
+  metadata.gz: ab5d10582f486b129c531aa7472f05e342c5d823d81bec4531dea8996328b916d8eb4e12c49763f28c720e76a9d64feda23b607bca6a748ba0506d4f974e6c1c
+  data.tar.gz: 910c1fd367831c3cb91c3a1a1a37c040ae0cac00cf259a08007625d3bbd8adc39cab8809bc5a8820d700ef925d525372370fc035d1c5c5461b9aae21f759bd4e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.4.4
+
+- Fix issue with data-binding shapes and attributed strings, which broke Snake and Tic Tac Toe examples
+
 ## 0.4.3
 
 - Support `entry` `text` bidirectional 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.4.3
+# [<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.4.4
 ## 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)
@@ -373,7 +373,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.4.3'
+gem 'glimmer-dsl-libui', '~> 0.4.4'
 ```
 
 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.
@@ -877,7 +877,7 @@ Given that it is very new and is not a [libui](https://github.com/andlabs/libui)
 - Including an `image` inside an `area` `on_draw` listener improves performance due to not retaining pixel/line data in memory.
 - Supplying `width` and `height` (2nd and 3rd arguments) greatly improves performance when shrinking image.
 
-Currently, it is recommended to use `image` with very small `width` and `height` values only.
+Currently, it is recommended to use `image` with very small `width` and `height` values only (e.g. 24x24).
 
 Setting a [`transform` `matrix`](#area-transform-matrix) is supported under `image` just like it is under `path` and `text` inside `area`.
 
@@ -1033,6 +1033,8 @@ window('Basic Image', 96, 96) {
 
 One final note is that in Linux, table images grow and shrink with the image size unlike on the Mac where table row heights are constant regardless of image sizes. As such, you may be able to repurpose a table with a single image column and a single row as an image control with more native libui rendering if you are only targeting Linux with your app.
 
+![linux table image](images/glimmer-dsl-libui-linux-basic-table-image.png)
+
 Check out [examples/basic_image.rb](#basic-image) (all versions) for examples of using `image` Glimmer custom control.
 
 #### Colors
@@ -1352,6 +1354,14 @@ See examples of the `observe` keyword at [Color The Circles](#color-the-circles)
 
 [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) supports both bidirectional (two-way) data-binding and unidirectional (one-way) data-binding.
 
+Data-binding enables writing very expressive, terse, and declarative code to synchronize View properties with Model attributes without writing many lines or pages of imperative code doing the same thing, increasing productivity immensely.
+
+Data-binding automatically takes advantage of the [Observer Pattern](#observer-pattern) behind the scenes and is very well suited to declaring View property data sources piecemeal. On the other hand, explicit use of the [Observer Pattern](#observer-pattern) is sometimes more suitable when needing to make multiple View updates upon a single Model attribute change.
+
+Data-binding supports utilizing the [MVP (Model View Presenter)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93presenter) flavor of [MVC](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) by observing both the View and a Presenter for changes and updating the opposite side upon encountering them. This enables writing more decoupled cleaner code that keeps View code and Model code disentangled and highly maintainable. For example, check out the Snake game presenters for [Grid](/examples/snake/presenter/grid.rb) and [Cell](/examples/snake/presenter/cell.rb), which act as proxies for the actual Snake game models [Snake](/examples/snake/model/snake.rb) and [Apple](/examples/snake/model/apple.rb), mediating synchronization of data between them and the [Snake View GUI](/examples/snake.rb).
+
+![MVP](https://www.researchgate.net/profile/Gilles-Perrouin/publication/320249584/figure/fig8/AS:668260987068418@1536337243385/Model-view-presenter-architecture.png)
+
 [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) supports bidirectional (two-way) data-binding of the following controls/properties via the `<=>` operator (indicating data is moving in both directions between View and Model):
 - `entry` `text` property
 - `multiline_entry` `text` property
@@ -1372,11 +1382,11 @@ Another example of bidirectional data-binding with an option:
 
 ```ruby
 entry {
-  text <=> [self, :entry_text, after_write: ->(text) {puts text}]
+  text <=> [self, :entered_text, after_write: ->(text) {puts text}]
 }
 ```
 
-That is data-binding `entry_text` attribute on `self` to `entry` `text` property and printing text after write to the model.
+That is data-binding `entered_text` attribute on `self` to `entry` `text` property and printing text after write to the model.
 
 [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) supports unidirectional (one-way) data-binding of any control/shape/attributed-string property via the `<=` operator (indicating data is moving from the right side, which is the Model, to the left side, which is the GUI View object).
 
@@ -1400,20 +1410,12 @@ window {
 
 That is data-binding the `window` `title` property to the `score` attribute of a `@game`, but converting on read from the Model to a `String`.
 
-The data-binding API:
-- Bidirectional (two-way) data-binding to a Model attribute accessor: `view_property <=> [model, attribute, *read_or_write_options]`
-- Unidirectional (one-way) data-binding to a Model attribute reader: `view_property <= [model, attribute, *read_only_options]`
+To summarize the data-binding API:
+- `view_property <=> [model, attribute, *read_or_write_options]`: Bidirectional (two-way) data-binding to Model attribute accessor
+- `view_property <= [model, attribute, *read_only_options]`: Unidirectional (one-way) data-binding to Model attribute reader
 
 This is also known as the [Glimmer Shine](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#shine) syntax for data-binding, a [Glimmer](https://github.com/AndyObtiva/glimmer)-only unique innovation that takes advantage of [Ruby](https://www.ruby-lang.org/en/)'s highly expressive syntax and malleable DSL support.
 
-Data-binding enables writing very expressive, terse, and declarative code to synchronize View properties with Model attributes without writing many lines or pages of imperative code doing the same thing.
-
-Data-binding automatically takes advantage of the [Observer Pattern](#observer-pattern) behind the scenes and is very well suited to declaring View property data sources piecemeal. On the other hand, explicit use of the [Observer Pattern](#observer-pattern) is sometimes more suitable when needing to make multiple View updates upon a single Model attribute change.
-
-Data-binding supports utilizing the [MVP (Model View Presenter)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93presenter) flavor of [MVC](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) by observing both the View and a Presenter for changes and updating the opposite side upon encountering them. This enables writing more decoupled cleaner code that keeps View code and Model code disentangled and highly maintainable. For example, check out the Snake game presenters for [Grid](/examples/snake/presenter/grid.rb) and [Cell](/examples/snake/presenter/cell.rb), which act as proxies for the actual Snake game models [Snake](/examples/snake/model/snake.rb) and [Apple](/examples/snake/model/apple.rb), mediating synchronization of data between them and the [Snake View GUI](/examples/snake.rb).
-
-![MVP](https://www.researchgate.net/profile/Gilles-Perrouin/publication/320249584/figure/fig8/AS:668260987068418@1536337243385/Model-view-presenter-architecture.png)
-
 Data-binding options include:
 - `before_read {|value| ...}`: performs an operation before reading data from Model to update the View.
 - `on_read {|value| ...}`: converts value read from Model to update the View.
@@ -1421,6 +1423,7 @@ Data-binding options include:
 - `before_write {|value| ...}`: performs an operation before writing data to Model from View.
 - `on_write {|value| ...}`: converts value read from View to update the Model.
 - `after_write {|converted_value| ...}`: performs an operation after writing to Model from View.
+- `computed_by attribute` or `computed_by [attribute1, attribute2, ...]`: indicates model attribute is computed from specified attribute(s), thus updated when they are updated (see in [Login example version 2](/examples/login2.rb))
 
 Note that with both `on_read` and `on_write` converters, you could pass a `Symbol` representing the name of a method on the value object to invoke.
 
@@ -1434,7 +1437,7 @@ entry {
 
 Gotcha: never data-bind a control property to an attribute on the same view object with the same exact name (e.g. binding `entry` `text` property to `self` `text` attribute) as it would conflict with it. Instead, data-bind view property to an attribute with a different name on the view object or with the same name, but on a presenter or model object (e.g. data-bind `entry` `text` to `self` `legal_text` attribute or to `contract` model `text` attribute)
 
-Learn more from data-binding usage in [Basic Entry](#basic-entry), [Form](#form), [Form Table](#form-table), [Login](#login), [Method-Based Custom Keyword](#method-based-custom-keyword), [Snake](#snake) and [Tic Tac Toe](#tic_tac_toe) examples.
+Learn more from data-binding usage in [Login](#login) (4 data-binding versions), [Basic Entry](#basic-entry), [Form](#form), [Form Table](#form-table), [Method-Based Custom Keyword](#method-based-custom-keyword), [Snake](#snake) and [Tic Tac Toe](#tic_tac_toe) examples.
 
 ### API Gotchas
 
@@ -6892,7 +6895,7 @@ end
 Login.new.launch
 ```
 
-New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version (with [data-binding](#data-binding)):
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version 3 (with [data-binding](#data-binding)):
 
 ```ruby
 require 'glimmer-dsl-libui'
@@ -6962,7 +6965,7 @@ end
 Login.new.launch
 ```
 
-New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version (with [data-binding](#data-binding)):
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version 4 (with [data-binding](#data-binding)):
 
 ```ruby
 require 'glimmer-dsl-libui'

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/lib/glimmer/libui/attributed_string.rb

@@ -23,10 +23,13 @@ require 'glimmer/libui/control_proxy'
 require 'glimmer/libui/control_proxy/area_proxy'
 require 'glimmer/libui/parent'
 require 'glimmer/libui/control_proxy/transformable'
+require 'glimmer/libui/data_bindable'
 
 module Glimmer
   module LibUI
     class AttributedString
+      include DataBindable
+      
       attr_reader :keyword, :parent_proxy, :args
       attr_accessor :block
     

data/lib/glimmer/libui/control_proxy.rb

@@ -19,6 +19,8 @@
 # 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/data_bindable'
+
 module Glimmer
   module LibUI
     # Proxy for LibUI control objects
@@ -101,6 +103,8 @@ module Glimmer
         end
       end
       
+      include DataBindable
+      
       KEYWORD_ALIASES = {
         'msg_box'       => 'message_box',
         'msg_box_error' => 'message_box_error',
@@ -332,18 +336,6 @@ module Glimmer
       alias set_visible visible
       alias visible= visible
       
-      # Data-binds model to update view.
-      # Subclasses can override to do inverse data-binding by observing view control for property changes and updating model binding accordingly
-      def data_bind(property, model_binding)
-        model_attribute_observer = Glimmer::DataBinding::Observer.proc do
-          new_value = model_binding.evaluate_property
-          send("#{property}=", new_value) unless send(property) == new_value
-        end
-        model_attribute_observer.observe(model_binding)
-        model_attribute_observer.call # initial update
-        model_attribute_observer
-      end
-      
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::ControlExpression.new, @keyword, &block)
       end

data/lib/glimmer/libui/data_bindable.rb

@@ -0,0 +1,39 @@
+# 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
+    # Parent controls and shapes who have children and add child post_initialize_child
+    module DataBindable
+      # Data-binds model to update view.
+      # Subclasses can override to do inverse data-binding by observing view control for property changes and updating model binding accordingly
+      def data_bind(property, model_binding)
+        model_attribute_observer = Glimmer::DataBinding::Observer.proc do
+          new_value = model_binding.evaluate_property
+          send("#{property}=", new_value) unless send(property) == new_value
+        end
+        model_attribute_observer.observe(model_binding)
+        model_attribute_observer.call # initial update
+        model_attribute_observer
+      end
+    end
+  end
+end

data/lib/glimmer/libui/shape.rb

@@ -22,6 +22,7 @@
 require 'glimmer/libui/parent'
 require 'glimmer/libui/control_proxy/area_proxy'
 require 'glimmer/libui/control_proxy/path_proxy'
+require 'glimmer/libui/data_bindable'
 
 module Glimmer
   module LibUI
@@ -64,6 +65,7 @@ module Glimmer
       end
       
       include Parent
+      include DataBindable
       
       attr_reader :parent, :args, :keyword, :block
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-27 00:00:00.000000000 Z
+date: 2021-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -372,6 +372,7 @@ files:
 - lib/glimmer/libui/control_proxy/transformable.rb
 - lib/glimmer/libui/control_proxy/triple_column.rb
 - lib/glimmer/libui/control_proxy/window_proxy.rb
+- lib/glimmer/libui/data_bindable.rb
 - lib/glimmer/libui/image_path_renderer.rb
 - lib/glimmer/libui/parent.rb
 - lib/glimmer/libui/shape.rb