glimmer-dsl-libui 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7491ce7cea65fb7025868e9fb2db5c4e6187ba269a177879e4276e50fa3d9f
-  data.tar.gz: 9b47cab46d79af36dd06b6914570f30662540b7b8c1e634dc326ed9af32ad041
+  metadata.gz: 974aa189dcfa34a3e96c581592d2acaa4fa1e14edeb784c3b80e47cf21b1f90d
+  data.tar.gz: 6bb99a56fe942706ec3a773cd90d0cfd88554fc03cb27465fb375538a56ac351
 SHA512:
-  metadata.gz: 692870dd49de81f7d2840579f0de3b7bd414bda277db56a4c28597febd012446c6b8b098bf56e5afe8c9b17f68547bb24bceaba45e15c3e4fd3ca041e5c37d2a
-  data.tar.gz: 289ede334bc53171a6a028dca1d03e794d0e81329621f2278365bfdcb2079fd200da21161d4aed6cf8486f382c4e0b04afadf3883ba0e07790878dbfd8fad334
+  metadata.gz: '08fcb654b14c8bf9bdca6e1d3b28477cd8d1d389447d4162dabe7f8f743cd9ee68e033012e01feadc5e9ac92daeca0feb74c794d0323ad4c083dde1f0fc90125'
+  data.tar.gz: e215a320873a70904062254fd63c32296b917c661592983d89bd6fa940413a5e554b6aa42c8e637409d777c3e739c6e80d1fef8072d1c72b4f275fc8985b775e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 0.0.22
+
+- New examples/basic_table_button.rb
+- Support table `button_column`
+- Support table `button_column` `enabled` property
+- Support `on_clicked` listener for `button_column`
+- Support automatic table cell value reading management (table row deletion upon actual `cell_rows` deletion due to implicit data-binding)
+
 ## 0.0.21
 
 - New examples/editable_column_table_image_text.rb

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.21
+# [<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.22
 ## 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)
@@ -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.21](#-glimmer-dsl-for-libui-0021)
+- [Glimmer DSL for LibUI 0.0.22](#-glimmer-dsl-for-libui-0022)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -74,6 +74,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Editable Column Table](#editable-column-table)
     - [Basic Table Image](#basic-table-image)
     - [Basic Table Image Text](#basic-table-image-text)
+    - [Basic Table Button](#basic-table-button)
   - [Contributing to glimmer-dsl-libui](#contributing-to-glimmer-dsl-libui)
   - [Help](#help)
     - [Issues](#issues)
@@ -161,7 +162,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.21'
+gem 'glimmer-dsl-libui', '~> 0.0.22'
 ```
 
 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.
@@ -2245,6 +2246,64 @@ window('The Red Turtle', 900, 350) {
 }.show
 ```
 
+### Basic Table Button
+
+[examples/basic_table_button.rb](examples/basic_table_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_table_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_table_button'"
+```
+
+Mac
+
+![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)
+
+Linux
+
+![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:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow delete],
+  %w[dog woof delete],
+  %w[chicken cock-a-doodle-doo delete],
+  %w[hourse neigh delete],
+  %w[cow moo delete]
+]
+
+window('Animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+      button_column('Action') {
+        on_clicked do |row|
+          data.delete_at(row) # automatically deletes actual table row due to implicit data-binding
+        end
+      }
+
+      cell_rows data # implicit data-binding
+    }
+  }
+}.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.21
+0.0.22

data/examples/basic_table_button.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
+data = [
+  %w[cat meow delete],
+  %w[dog woof delete],
+  %w[chicken cock-a-doodle-doo delete],
+  %w[hourse neigh delete],
+  %w[cow moo delete]
+]
+
+window('Animal sounds', 300, 200) {
+  horizontal_box {
+    table {
+      text_column('Animal')
+      text_column('Description')
+      button_column('Action') {
+        on_clicked do |row|
+          data.delete_at(row) # automatically deletes actual table row due to implicit data-binding
+        end
+      }
+
+      cell_rows data # implicit data-binding
+    }
+  }
+  
+  on_closing do
+    puts 'Bye Bye'
+  end
+}.show

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

@@ -35,10 +35,6 @@ module Glimmer
     module Libui
       Engine.add_dynamic_expressions(
         Libui,
-#           list_selection_data_binding
-#           data_binding
-#           block_attribute
-#           attribute
         %w[
           listener
           property

data/lib/glimmer/libui/button_column_proxy.rb

@@ -0,0 +1,67 @@
+# 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/column'
+require 'glimmer/libui/enableable_column'
+
+module Glimmer
+  module LibUI
+    # Proxy for LibUI button column objects
+    #
+    # Follows the Proxy Design Pattern
+    class ButtonColumnProxy < ControlProxy
+      include Column
+      include EnableableColumn
+      
+      def on_clicked(&block)
+        # TODO consider generalizing into custom listeners and moving to ControlProxy
+        @on_clicked_procs ||= []
+        @on_clicked_procs << block
+      end
+      
+      def can_handle_listener?(listener_name)
+        listener_name == 'on_clicked' || super
+      end
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name
+        when 'on_clicked'
+          on_clicked(&listener)
+        else
+          super
+        end
+      end
+      
+      def notify_listeners(listener_name, *args)
+        @on_clicked_procs&.each do |on_clicked_proc|
+          on_clicked_proc.call(*args)
+        end
+      end
+          
+      private
+      
+      def build_control
+        @parent_proxy.append_button_column(name, column_index, enabled_value)
+      end
+    end
+  end
+end

data/lib/glimmer/libui/column.rb

@@ -19,8 +19,6 @@
 # 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
     # Common logic for all column proxy objects

data/lib/glimmer/libui/dual_column.rb

@@ -19,8 +19,6 @@
 # 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
     # A dual column is one that represents two values (e.g. image and text or checkbox and text)

data/lib/glimmer/libui/editable_column.rb

@@ -19,13 +19,12 @@
 # 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
     module EditableColumn
       def editable(value = nil)
         if value.nil?
+          @editable = false if @editable.nil?
           @editable
         else
           @editable = !!value

data/lib/glimmer/libui/enableable_column.rb

@@ -0,0 +1,44 @@
+# 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 EnableableColumn
+      def enabled(value = nil)
+        if value.nil?
+          @enabled = true if @enabled.nil?
+          @enabled
+        else
+          @enabled = !!value
+        end
+      end
+      alias enabled= enabled
+      alias set_enabled enabled
+      alias enabled? enabled
+
+      private
+      
+      def enabled_value
+        enabled? ? -2 : -1
+      end
+    end
+  end
+end

data/lib/glimmer/libui/image_text_column_proxy.rb

@@ -21,6 +21,8 @@
 
 require 'glimmer/libui/control_proxy'
 require 'glimmer/libui/column'
+require 'glimmer/libui/dual_column'
+require 'glimmer/libui/editable_column'
 
 module Glimmer
   module LibUI

data/lib/glimmer/libui/table_proxy.rb

@@ -20,6 +20,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/libui/control_proxy'
+require 'glimmer/data_binding/observer'
+
+using ArrayIncludeMethods
 
 module Glimmer
   module LibUI
@@ -63,18 +66,19 @@ module Glimmer
         if rows.nil?
           @cell_rows
         else
-          rows = rows.map do |row|
-            row.map do |cell|
-              if cell.respond_to?(:libui)
-                cell.libui
-              elsif cell.is_a?(Array)
-                cell.map { |inner_cell| inner_cell.respond_to?(:libui) ? inner_cell.libui : inner_cell }
-              else
-                cell
+          @cell_rows = rows
+          @cell_rows.tap do
+            @last_cell_rows = @cell_rows.clone
+            Glimmer::DataBinding::Observer.proc do
+              if (@cell_rows.size == @last_cell_rows.size - 1) && @last_cell_rows & @cell_rows == @cell_rows
+                _, row = @last_cell_rows.each_with_index.find do |row_data, row|
+                  !@cell_rows.include?(row_data)
+                end
+                ::LibUI.table_model_row_deleted(model, row)
               end
-            end
+              @last_cell_rows = @cell_rows.clone
+            end.observe(self, :cell_rows)
           end
-          @cell_rows = rows
         end
       end
       alias cell_rows= cell_rows
@@ -104,7 +108,7 @@ module Glimmer
         @model_handler.NumColumns   = rbcallback(4) { @columns.map {|c| c.is_a?(DualColumn) ? 2 : 1}.sum }
         @model_handler.ColumnType   = rbcallback(4, [1, 1, 4]) do |_, _, column|
           case @columns[column]
-          when TextColumnProxy, NilClass
+          when TextColumnProxy, ButtonColumnProxy, NilClass
             0
           when ImageColumnProxy, ImageTextColumnProxy
             1
@@ -114,18 +118,16 @@ module Glimmer
 #             2
 #           when ProgressBarColumnProxy
 #             2
-#           when ButtonColumnProxy
-#             0
           end
         end
         @model_handler.NumRows      = rbcallback(4) { cell_rows.count }
         @model_handler.CellValue    = rbcallback(1, [1, 1, 4, 4]) do |_, _, row, column|
           the_cell_rows = expanded_cell_rows
           case @columns[column]
-          when TextColumnProxy, NilClass
+          when TextColumnProxy, ButtonColumnProxy, NilClass
             ::LibUI.new_table_value_string((expanded_cell_rows[row] && expanded_cell_rows[row][column]).to_s)
           when ImageColumnProxy, ImageTextColumnProxy
-            ::LibUI.new_table_value_image((expanded_cell_rows[row] && expanded_cell_rows[row][column]))
+            ::LibUI.new_table_value_image((expanded_cell_rows[row] && (expanded_cell_rows[row][column].respond_to?(:libui) ? expanded_cell_rows[row][column].libui : expanded_cell_rows[row][column])))
           end
         end
         @model_handler.SetCellValue = rbcallback(0, [1, 1, 4, 4, 1]) do |_, _, row, column, val|
@@ -135,9 +137,10 @@ module Glimmer
             @cell_rows[row] ||= []
             @cell_rows[row][column] = ::LibUI.table_value_string(val).to_s
           when NilClass
-            # TODO ensure this works for editable table
             column = @columns[column - 1].index
             @cell_rows[row][column][1] = ::LibUI.table_value_string(val).to_s
+          when ButtonColumnProxy
+            @columns[column].notify_listeners(:on_clicked, row)
           end
         end
         

data/lib/glimmer/libui/text_column_proxy.rb

@@ -21,6 +21,7 @@
 
 require 'glimmer/libui/control_proxy'
 require 'glimmer/libui/column'
+require 'glimmer/libui/editable_column'
 
 module Glimmer
   module LibUI

data/lib/glimmer/libui/window_proxy.rb

@@ -61,20 +61,29 @@ module Glimmer
         end
       end
       
+      def can_handle_listener?(listener_name)
+        listener_name == 'on_destroy' || super
+      end
+      
       def handle_listener(listener_name, &listener)
-        if listener_name == 'on_closing'
-          default_behavior_listener = Proc.new do
-            return_value = listener.call(self)
-            if return_value.is_a?(Numeric)
-              return_value
-            else
-              destroy
-              ::LibUI.quit
-              0
+        case listener_name
+        when 'on_destroy'
+          on_destroy(&listener)
+        else
+          if listener_name == 'on_closing'
+            default_behavior_listener = Proc.new do
+              return_value = listener.call(self)
+              if return_value.is_a?(Numeric)
+                return_value
+              else
+                destroy
+                ::LibUI.quit
+                0
+              end
             end
           end
+          super(listener_name, &default_behavior_listener)
         end
-        super(listener_name, &default_behavior_listener)
       end
     
       private

data/lib/glimmer-dsl-libui.rb

@@ -27,6 +27,7 @@ require 'glimmer'
 # require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 # require 'super_module'
 require 'os'
+require 'array_include_methods'
 require 'libui'
 
 # Internal requires

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Andy Maleh
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +197,7 @@ files:
 - examples/basic_button.rb
 - examples/basic_entry.rb
 - examples/basic_table.rb
+- examples/basic_table_button.rb
 - examples/basic_table_image.rb
 - examples/basic_table_image_text.rb
 - examples/basic_window.rb
@@ -224,6 +225,7 @@ files:
 - lib/glimmer/dsl/libui/tab_item_expression.rb
 - lib/glimmer/libui/about_menu_item_proxy.rb
 - lib/glimmer/libui/box.rb
+- lib/glimmer/libui/button_column_proxy.rb
 - lib/glimmer/libui/button_proxy.rb
 - lib/glimmer/libui/check_menu_item_proxy.rb
 - lib/glimmer/libui/checkbox_proxy.rb
@@ -236,6 +238,7 @@ files:
 - lib/glimmer/libui/dual_column.rb
 - lib/glimmer/libui/editable_column.rb
 - lib/glimmer/libui/editable_combobox_proxy.rb
+- lib/glimmer/libui/enableable_column.rb
 - lib/glimmer/libui/font_button_proxy.rb
 - lib/glimmer/libui/form_proxy.rb
 - lib/glimmer/libui/grid_proxy.rb