glimmer-dsl-libui 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122c9e87c9613b6ebb29722c0c7d602b0850f369c613374b21df38699e61e669
-  data.tar.gz: fb156f42398d2c8d419de476dfe435fbdfe872545da343daadd035ed2667775c
+  metadata.gz: 755dfde419aa3c77d0ca7229f9962d63b7aa139adbc1d5543e93acbf0c1917db
+  data.tar.gz: f4d753f109947eafeea727804ee871923948a0a262cde11a58dfd2f2fbe893ec
 SHA512:
-  metadata.gz: 0d9587a6a19b25436fb8b810034d4663d2bd6e6dd478ab7397727978b5cec3100016032a0b3b9787ffcdb7245c2df4826829fa3e0d0afd60b69a26f4e45fcdcd
-  data.tar.gz: 8793a26d3383e981db6654b2e5e2705e677436e89eb1f678ec8289d17328d825151cb06ab67eacd19a398092ef77bafc6baa3e729c5152df57cf73189d9ad40e
+  metadata.gz: 96f4f5b7ddbf09a9543cea439ce74b1c5c545e2e6c240533e4d283ffba2bea16778a826601e2350392253d39edd21c8a6cb60d22fa1ee4107084c2cdd9155f70
+  data.tar.gz: 65b9fdb359801bdd1e4c6e9df74f3cc1d49f7012a5fc6b7dfc8cb4f6fbc16732cc6e4119a05d6c0a26eb559d60e3c72b263b3376f0775d4ff1ff5dd3ec52435d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.4.9
+
+- Support unidirectional data-binding on all control properties that support bidirectional data-binding
+- Fix issue in examples/snake.rb with double-turn causing instant death due to snake illogically going back against itself
+
 ## 0.4.8
 
 - Support `checkbox` `checked` bidirectional data-binding (with `<=>` sign)

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.8
+# [<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.9
 ## 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.8'
+gem 'glimmer-dsl-libui', '~> 0.4.9'
 ```
 
 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.
@@ -1398,6 +1398,7 @@ Data-binding supports utilizing the [MVP (Model View Presenter)](https://en.wiki
 - `search_entry`: `text`
 - `slider`: `value`
 - `spinbox`: `value`
+- `table`: `cell_rows` (explicit data-binding using `<=>` and [implicit data-binding](#table-api) by assigning value directly)
 - `time_picker`: `time`
 
 Example of bidirectional data-binding:
@@ -3268,7 +3269,62 @@ Mac | Windows | Linux
 ----|---------|------
 ![glimmer-dsl-libui-mac-basic-table-button.png](images/glimmer-dsl-libui-mac-basic-table-button.png) ![glimmer-dsl-libui-mac-basic-table-button-deleted.png](images/glimmer-dsl-libui-mac-basic-table-button-deleted.png) | ![glimmer-dsl-libui-windows-basic-table-button.png](images/glimmer-dsl-libui-windows-basic-table-button.png) ![glimmer-dsl-libui-windows-basic-table-button-deleted.png](images/glimmer-dsl-libui-windows-basic-table-button-deleted.png) | ![glimmer-dsl-libui-linux-basic-table-button.png](images/glimmer-dsl-libui-linux-basic-table-button.png) ![glimmer-dsl-libui-linux-basic-table-button-deleted.png](images/glimmer-dsl-libui-linux-basic-table-button-deleted.png)
 
-New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version (with explicit [data-binding](#data-binding)):
+
+```ruby
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+class BasicTableButton
+  include Glimmer
+  
+  attr_accessor :data
+  
+  def initialize
+    @data = [
+      %w[cat meow delete],
+      %w[dog woof delete],
+      %w[chicken cock-a-doodle-doo delete],
+      %w[horse neigh delete],
+      %w[cow moo delete]
+    ]
+  end
+  
+  def launch
+    window('Animal sounds', 400, 200) {
+      horizontal_box {
+        table {
+          text_column('Animal')
+          text_column('Description')
+          button_column('Action') {
+            on_clicked do |row|
+              # Option 1: direct data deletion is the simpler solution
+#               @data.delete_at(row) # automatically deletes actual table row due to explicit data-binding
+              
+              # Option 2: cloning only to demonstrate table row deletion upon explicit setting of data attribute (cloning is not recommended beyond demonstrating this point)
+              new_data = @data.clone
+              new_data.delete_at(row)
+              self.data = new_data # automatically loses deleted table row due to explicit data-binding
+            end
+          }
+    
+          cell_rows <=> [self, :data] # explicit data-binding of table cell_rows to self.data
+          
+          on_changed do |row, type, row_data|
+            puts "Row #{row} #{type}: #{row_data}"
+            $stdout.flush
+          end
+        }
+      }
+    }.show
+  end
+end
+
+BasicTableButton.new.launch
+```
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version 2 (with implicit [data-binding](#data-binding)):
 
 ```ruby
 require 'glimmer-dsl-libui'
@@ -6449,7 +6505,7 @@ require 'glimmer-dsl-libui'
 class FormTable
   include Glimmer
   
-  attr_accessor :name, :email, :phone, :city, :state, :filter_value
+  attr_accessor :data, :name, :email, :phone, :city, :state, :filter_value
   
   def initialize
     @data = [
@@ -6520,10 +6576,10 @@ class FormTable
             after_write: ->(filter_value) { # execute after write to self.filter_value
               @unfiltered_data ||= @data.dup
               # Unfilter first to remove any previous filters
-              @data.replace(@unfiltered_data) # affects table indirectly through implicit data-binding
+              self.data = @unfiltered_data # affects table indirectly through explicit data-binding
               # Now, apply filter if entered
               unless filter_value.empty?
-                @data.filter! do |row_data| # affects table indirectly through implicit data-binding
+                self.data = @data.filter do |row_data| # affects table indirectly through explicit data-binding
                   row_data.any? do |cell|
                     cell.to_s.downcase.include?(filter_value.downcase)
                   end
@@ -6540,7 +6596,7 @@ class FormTable
           text_column('City')
           text_column('State')
     
-          cell_rows @data # implicit data-binding
+          cell_rows <=> [self, :data] # explicit data-binding
           
           on_changed do |row, type, row_data|
             puts "Row #{row} #{type}: #{row_data}"
@@ -8195,6 +8251,7 @@ class Snake
     @game = Model::Game.new
     @grid = Presenter::Grid.new(@game)
     @game.start
+    @keypress_queue = []
     create_gui
     register_observers
   end
@@ -8214,14 +8271,30 @@ class Snake
     end
     
     Glimmer::LibUI.timer(SNAKE_MOVE_DELAY) do
-      @game.snake.move unless @game.over?
+      unless @game.over?
+        process_queued_keypress
+        @game.snake.move
+      end
+    end
+  end
+  
+  def process_queued_keypress
+    # key press queue ensures one turn per snake move to avoid a double-turn resulting in instant death (due to snake illogically going back against itself)
+    key = @keypress_queue.shift
+    case [@game.snake.head.orientation, key]
+    in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
+      @game.snake.turn_right
+    in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
+      @game.snake.turn_left
+    else
+      # No Op
     end
   end
   
   def create_gui
     @main_window = window {
       # data-bind window title to game score, converting it to a title string on read from the model
-      title <= [@game, :score, on_read: -> (score) {"Glimmer Snake (Score: #{@game.score})"}]
+      title <= [@game, :score, on_read: -> (score) {"Snake (Score: #{@game.score})"}]
       content_size @game.width * CELL_SIZE, @game.height * CELL_SIZE
       resizable false
       
@@ -8239,15 +8312,7 @@ class Snake
                 }
                 
                 on_key_up do |area_key_event|
-                  orientation_and_key = [@game.snake.head.orientation, area_key_event[:ext_key]]
-                  case orientation_and_key
-                  in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
-                    @game.snake.turn_right
-                  in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
-                    @game.snake.turn_left
-                  else
-                    # No Op
-                  end
+                  @keypress_queue << area_key_event[:ext_key]
                 end
               }
             end
@@ -9115,7 +9180,7 @@ These features have been planned or suggested. You might see them in a future ve
     is fine, but please isolate to its own commit so I can cherry-pick
     around it.
 
-Note that the latest development sometimes takes place in [development](https://github.com/AndyObtiva/glimmer-dsl-libui/tree/development) branch (which is deleted once merged back to [master](https://github.com/AndyObtiva/glimmer-dsl-libui)).
+Note that the latest development sometimes takes place in the [development](https://github.com/AndyObtiva/glimmer-dsl-libui/tree/development) branch (usually deleted once merged back to [master](https://github.com/AndyObtiva/glimmer-dsl-libui)).
 
 ## Contributors
 

data/VERSION

@@ -1 +1 @@
-0.4.8
+0.4.9

data/examples/snake.rb

@@ -12,6 +12,7 @@ class Snake
     @game = Model::Game.new
     @grid = Presenter::Grid.new(@game)
     @game.start
+    @keypress_queue = []
     create_gui
     register_observers
   end
@@ -31,7 +32,23 @@ class Snake
     end
     
     Glimmer::LibUI.timer(SNAKE_MOVE_DELAY) do
-      @game.snake.move unless @game.over?
+      unless @game.over?
+        process_queued_keypress
+        @game.snake.move
+      end
+    end
+  end
+  
+  def process_queued_keypress
+    # key press queue ensures one turn per snake move to avoid a double-turn resulting in instant death (due to snake illogically going back against itself)
+    key = @keypress_queue.shift
+    case [@game.snake.head.orientation, key]
+    in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
+      @game.snake.turn_right
+    in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
+      @game.snake.turn_left
+    else
+      # No Op
     end
   end
   
@@ -56,15 +73,7 @@ class Snake
                 }
                 
                 on_key_up do |area_key_event|
-                  orientation_and_key = [@game.snake.head.orientation, area_key_event[:ext_key]]
-                  case orientation_and_key
-                  in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
-                    @game.snake.turn_right
-                  in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
-                    @game.snake.turn_left
-                  else
-                    # No Op
-                  end
+                  @keypress_queue << area_key_event[:ext_key]
                 end
               }
             end

data/lib/glimmer/libui/control_proxy/checkbox_proxy.rb

@@ -30,8 +30,7 @@ module Glimmer
       class CheckboxProxy < ControlProxy
         DEFAULT_TEXT = ''
       
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_toggled') { model_binding.call(checked) } if property == 'checked'
         end
         

data/lib/glimmer/libui/control_proxy/color_button_proxy.rb

@@ -114,8 +114,7 @@ module Glimmer
           super
         end
         
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(color) } if property == 'color'
         end
       end

data/lib/glimmer/libui/control_proxy/combobox_proxy.rb

@@ -64,8 +64,7 @@ module Glimmer
         alias set_selected_item selected_item
         alias selected_item= selected_item
         
-        def data_bind(property, model_binding)
-          super # model to view data-binding
+        def data_bind_write(property, model_binding)
           case property
           when 'selected'
             handle_listener('on_selected') { model_binding.call(selected) }

data/lib/glimmer/libui/control_proxy/date_time_picker_proxy.rb

@@ -65,8 +65,7 @@ module Glimmer
           super
         end
         
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(time) } if property == 'time'
         end
       end

data/lib/glimmer/libui/control_proxy/editable_combobox_proxy.rb

@@ -40,8 +40,7 @@ module Glimmer
         alias set_items items
         alias items= items
         
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(text) } if property == 'text'
         end
       end

data/lib/glimmer/libui/control_proxy/entry_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class EntryProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(text) } if property == 'text'
         end
         

data/lib/glimmer/libui/control_proxy/font_button_proxy.rb

@@ -65,7 +65,11 @@ module Glimmer
           super
         end
         
-        def data_bind(property, model_binding)
+        def data_bind_read(property, model_binding)
+          # No Op
+        end
+        
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(font) } if property == 'font'
         end
       end

data/lib/glimmer/libui/control_proxy/menu_item_proxy/check_menu_item_proxy.rb

@@ -29,8 +29,7 @@ module Glimmer
         #
         # Follows the Proxy Design Pattern
         class CheckMenuItemProxy < MenuItemProxy
-          def data_bind(property, model_binding)
-            super
+          def data_bind_write(property, model_binding)
             handle_listener('on_clicked') { model_binding.call(checked) } if property == 'checked'
           end
         

data/lib/glimmer/libui/control_proxy/menu_item_proxy/radio_menu_item_proxy.rb

@@ -65,8 +65,7 @@ module Glimmer
             end
           end
         
-          def data_bind(property, model_binding)
-            super
+          def data_bind_write(property, model_binding)
             handle_listener('on_clicked') { model_binding.call(checked) } if property == 'checked'
           end
         

data/lib/glimmer/libui/control_proxy/multiline_entry_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class MultilineEntryProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(text) } if property == 'text'
         end
         

data/lib/glimmer/libui/control_proxy/radio_buttons_proxy.rb

@@ -50,8 +50,7 @@ module Glimmer
         alias set_selected_item selected_item
         alias selected_item= selected_item
         
-        def data_bind(property, model_binding)
-          super # model to view data-binding
+        def data_bind_write(property, model_binding)
           case property
           when 'selected'
             handle_listener('on_selected') { model_binding.call(selected) }

data/lib/glimmer/libui/control_proxy/slider_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class SliderProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(value) } if property == 'value'
         end
       end

data/lib/glimmer/libui/control_proxy/spinbox_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class SpinboxProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(value) } if property == 'value'
         end
       end

data/lib/glimmer/libui/data_bindable.rb

@@ -23,9 +23,25 @@ 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
+      # Sets up read/write (bidirectional) data-binding
+      #
+      # classes are expected to implement `data_bind_write(property, model_binding)` to setup write data-binding
+      # by observing view property for changes and writing to model attribute via model binding accordingly
+      #
+      # classes can override data_bind_read to disable read data-binding in rare scenarios that might need it
+      #
+      # returns model attribute reading observer by default
       def data_bind(property, model_binding)
+        data_bind_read(property, model_binding).tap do
+          data_bind_write(property, model_binding) unless model_binding.binding_options[:read_only]
+        end
+      end
+      
+      # Sets up read data-binding (reading from model to update view)
+      #
+      # Default implementation observes model attribute for changes via model binding
+      # and updates view property accordingly
+      def data_bind_read(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
@@ -34,6 +50,15 @@ module Glimmer
         model_attribute_observer.call # initial update
         model_attribute_observer
       end
+      
+      # Sets up write data-binding (writing to model from view)
+      #
+      # Has no implementation by default. Classes are expected
+      # to implement this method by observing view property
+      # for changes and writing them to model accordingly via model binding
+      def data_bind_write(property, model_binding)
+        # No Op by default
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer