glimmer-dsl-libui 0.0.27 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1014e0c2243936dc61a783c96c3f5760faf93692f8d60535667b29f5a0378cf9
-  data.tar.gz: 4176b09e4f89d5cdf2d182f1dceb9ae67aab71b3b28696d1a77e191708b931d8
+  metadata.gz: 54faaec785d114536e8b747aa55f7d7bd043339e99f041722d60d70623a9b648
+  data.tar.gz: 9391f99834f34e2b878b2dbf41b7a8ff3f1ab58daf003acdf33a4f93a2e0777c
 SHA512:
-  metadata.gz: 7080a17729c2059e0b7459a6087466d38a7fda9aa91be1964109418ec2bb8c55187d45fa75f6b2c83fa9c30d886c8efb84ca1c1714cf73e5e02b6a6a51741559
-  data.tar.gz: 9f21040ea200f827efcb235541fe28565361819aae0005653778d480b80b6e9d43e6ec7008e5512199abeb2e5832f2776beacda806cf260b73795bf5bfa7e9e5
+  metadata.gz: 8f2d65ebb19e77c5fab1e037c751af43635a03b07671c8e03ac507bf4e01c04e37c083ffe91a4b18796505801e0d77d84770d0aa13951785422db6ae3c11830f
+  data.tar.gz: 34965b3e01a55733b767dccb4356b4902627a55fd6843295c76fc473a4b049456c7ee59df12bfc9f61541668b763a394d1fb43955f057f6cc8f6a4f72a2ae6b3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.28
+
+- Support automatic table row change when updating a row in `cell_rows` (e.g. `data[3] = ['new', 'row', 'cell', 'values']`)
+- Support `editable` property for `checkbox_column` (checkbox editing only works in Windows due to a [libui](https://github.com/andlabs/libui) limitation)
+- Support `editable`, `editable_checkbox`, and `editable_text` properties for `checkbox_text_column` (checkbox editing only works in Windows due to a [libui](https://github.com/andlabs/libui) limitation)
+- Fix examples/basic_table_checkbox_text.rb by removing `editable` property
+
 ## 0.0.27
 
 - New examples/form_table.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.27
+# [<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.28
 ## 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.27](#-glimmer-dsl-for-libui-0027)
+- [Glimmer DSL for LibUI 0.0.28](#-glimmer-dsl-for-libui-0028)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [Usage](#usage)
   - [API](#api)
@@ -52,6 +52,7 @@ Other [Glimmer](https://rubygems.org/gems/glimmer) DSL gems you might be interes
     - [Common Control Operations](#common-control-operations)
     - [Extra Dialogs](#extra-dialogs)
     - [Extra Operations](#extra-operations)
+    - [Table API](#table-api)
     - [Smart Defaults and Conventions](#smart-defaults-and-conventions)
     - [API Gotchas](#api-gotchas)
     - [Original API](#original-api)
@@ -166,7 +167,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.0.27'
+gem 'glimmer-dsl-libui', '~> 0.0.28'
 ```
 
 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.
@@ -225,8 +226,8 @@ Control(Args) | Properties | Listeners
 `button(text as String)` | `text` (`String`) | `on_clicked`
 `button_column(name as String)` | `enabled` (Boolean) | None
 `checkbox(text as String)` | `checked` (Boolean), `text` (`String`) | `on_toggled`
-`checkbox_column(name as String)` | None | None
-`checkbox_text_column(name as String)` | `editable` (Boolean) | None
+`checkbox_column(name as String)` | `editable` (Boolean) [Windows-only due to a current libui limitation] | None
+`checkbox_text_column(name as String)` | `editable` (Boolean) [Windows-only due to a current libui limitation], `editable_checkbox` (Boolean) [Windows-only due to a current libui limitation], `editable_text` (Boolean) | None
 `combobox` | `items` (`Array` of `String`), `selected` (`Integer`) | `on_selected`
 `color_button` | `color` (Array of `red` as `Float`, `green` as `Float`, `blue` as `Float`, `alpha` as `Float`), `red` as `Float`, `green` as `Float`, `blue` as `Float`, `alpha` as `Float` | `on_changed`
 `date_picker` | `time` (`Hash` of keys: `sec` as `Integer`, `min` as `Integer`, `hour` as `Integer`, `mday` as `Integer`, `mon` as `Integer`, `year` as `Integer`, `wday` as `Integer`, `yday` as `Integer`, `dst` as Boolean) | `on_changed`
@@ -302,6 +303,24 @@ Control(Args) | Properties | Listeners
 - `ControlProxy::main_window_proxy`: returns the first window proxy instantiated in the application
 - `ControlProxy#window_proxy`: returns the window proxy parent for a control
 
+### Table API
+
+The `table` control must first declare its columns via one of these column keywords (mentioned in [Supported Controls](#supported-controls)):
+  - `button_column`: expects `String` cell values
+  - `checkbox_column`: expects Boolean cell values
+  - `checkbox_text_column`: expects dual-element `Array` of Boolean and `String` cell values
+  - `image_column`: expects `image` cell values (produced by `image` and `image_part` keywords as per [Supported Controls](#supported-controls))
+  - `image_text_column`: expects dual-element `Array` of `image` and `String` cell values
+  - `text_column`: expects `String` cell values
+  - `progress_bar_column`: expects `Integer` cell values
+  
+Afterwards, it must declare its `cell_rows` array (`Array` of `Array`s of column cell values) and whether it is `editable` (Boolean) for all its columns.
+
+Note that the `cell_rows` property declaration results in "implicit data-binding" between the `table` control and `Array` of `Arrays` (a new innovation) to provide convenience automatic support for:
+- Deleting cell rows: Calling `Array#delete`, `Array#delete_at`, `Array#delete_if`, or any filtering/deletion `Array` method automatically deletes rows in actual `table` control
+- Inserting cell rows: Calling `Array#<<`, `Array#push`, `Array#prepend`, or any insertion/addition `Array` method automatically inserts rows in actual `table` control
+- Changing cell rows: Calling `Array#[]=`, `Array#map!`, or any update `Array` method automatically updates rows in actual `table` control
+
 ### Smart Defaults and Conventions
 
 - `horizontal_box`, `vertical_box`, `grid`, and `form` controls have `padded` as `true` upon instantiation to ensure more user-friendly GUI by default
@@ -327,13 +346,14 @@ Control(Args) | Properties | Listeners
 - Smart defaults for `grid` child attributes are `left` (`0`), `top` (`0`), `xspan` (`1`), `yspan` (`1`), `hexpand` (`false`), `halign` (`0`), `vexpand` (`false`), and `valign` (`0`)
 - The `table` control automatically constructs required `TableModelHandler`, `TableModel`, and `TableParams`, calculating all their arguments from `cell_rows` and `editable` properties (e.g. `NumRows`) as well as nested columns (e.g. `text_column`)
 - Table model instances are automatically freed from memory after `window` is destroyed.
-- Table `cell_rows` data has implicit data-binding to table cell values for deletion and insertion (done by diffing `cell_rows` value before and after change and auto-informing `table` of deletions [`::LibUI.table_model_row_deleted`] and insertions [`::LibUI.table_model_row_deleted`]). When deleting data rows from `cell_rows` array, then actual rows from the `table` are automatically deleted. When inserting data rows into `cell_rows` array, then actual `table` rows are automatically inserted.
+- Table `cell_rows` data has implicit data-binding to table cell values for deletion, insertion, and change (done by diffing `cell_rows` value before and after change and auto-informing `table` of deletions [`LibUI.table_model_row_deleted`], insertions [`LibUI.table_model_row_deleted`], and changes [`LibUI.table_model_row_changed`]). When deleting data rows from `cell_rows` array, then actual rows from the `table` are automatically deleted. When inserting data rows into `cell_rows` array, then actual `table` rows are automatically inserted. When updating data rows in `cell_rows` array, then actual `table` rows are automatically updated.
 - `image` instances are automatically freed from memory after `window` is destroyed.
 - `image` `width` and `height` can be left off if it has one `image_part` only as they default to the same `width` and `height` of the `image_part`
 
 ### API Gotchas
 
-There is no proper way to destroy `grid` children due to [libui](https://github.com/andlabs/libui) not offering any API for deleting them from `grid` (no `grid_delete` similar to `box_delete` for `horizontal_box` and `vertical_box`)
+- There is no proper way to destroy `grid` children due to [libui](https://github.com/andlabs/libui) not offering any API for deleting them from `grid` (no `grid_delete` similar to `box_delete` for `horizontal_box` and `vertical_box`).
+- `table` `checkbox_column` and `checkbox_text_column` checkbox editing currently only works in Windows due to a current limitation in [libui](https://github.com/andlabs/libui).
 
 ### Original API
 

data/VERSION

@@ -1 +1 @@
-0.0.27
+0.0.28

data/examples/basic_table_checkbox_text.rb

@@ -17,9 +17,7 @@ window('Animal sounds', 400, 200) {
     table {
       text_column('Animal')
       text_column('Sound')
-      checkbox_text_column('Description') {
-        editable true
-      }
+      checkbox_text_column('Description')
 
       cell_rows data
     }

data/lib/glimmer/libui/checkbox_column_proxy.rb

@@ -30,12 +30,12 @@ module Glimmer
     # Follows the Proxy Design Pattern
     class CheckboxColumnProxy < ControlProxy
       include Column
-#       include EditableColumn # TODO enable this once checkbox column becomes editable on macosx in C libui (currently has a bug)
+      include EditableColumn
       
       private
       
       def build_control
-        @parent_proxy.append_checkbox_column(name, column_index, -1)
+        @parent_proxy.append_checkbox_column(name, column_index, editable_value)
       end
     end
   end

data/lib/glimmer/libui/checkbox_text_column_proxy.rb

@@ -32,12 +32,44 @@ module Glimmer
     class CheckboxTextColumnProxy < ControlProxy
       include Column
       include DualColumn
-      include EditableColumn # TODO split into editable_checkbox and editable_text properties in the future given that checkbox and text can be edited separately
+      include EditableColumn
       
+      def editable_checkbox(value = nil)
+        if value.nil?
+          @editable_checkbox = false if @editable_checkbox.nil?
+          @editable_checkbox
+        else
+          @editable_checkbox = !!value
+        end
+      end
+      alias editable_checkbox= editable_checkbox
+      alias set_editable_checkbox editable_checkbox
+      alias editable_checkbox? editable_checkbox
+
+      def editable_text(value = nil)
+        if value.nil?
+          @editable_text = false if @editable_text.nil?
+          @editable_text
+        else
+          @editable_text = !!value
+        end
+      end
+      alias editable_text= editable_text
+      alias set_editable_text editable_text
+      alias editable_text? editable_text
+
       private
       
       def build_control
-        @parent_proxy.append_checkbox_text_column(name, column_index, -1, second_column_index, editable_value)
+        @parent_proxy.append_checkbox_text_column(name, column_index, editable_checkbox_value, second_column_index, editable_text_value)
+      end
+      
+      def editable_checkbox_value
+        (@parent_proxy.editable? || editable? || editable_checkbox?) ? -2 : -1
+      end
+      
+      def editable_text_value
+        (@parent_proxy.editable? || editable? || editable_text?) ? -2 : -1
       end
     end
   end

data/lib/glimmer/libui/table_proxy.rb

@@ -71,12 +71,16 @@ module Glimmer
             @last_cell_rows = @cell_rows.clone
             Glimmer::DataBinding::Observer.proc do
               if @cell_rows.size < @last_cell_rows.size && @last_cell_rows.include_all?(*@cell_rows)
-                @last_cell_rows.array_diff_indexes(@cell_rows).reverse.each do |index|
-                  ::LibUI.table_model_row_deleted(model, index)
+                @last_cell_rows.array_diff_indexes(@cell_rows).reverse.each do |row|
+                  ::LibUI.table_model_row_deleted(model, row)
                 end
               elsif @cell_rows.size > @last_cell_rows.size && @cell_rows.include_all?(*@last_cell_rows)
-                @cell_rows.array_diff_indexes(@last_cell_rows).each do |index|
-                  ::LibUI.table_model_row_inserted(model, index)
+                @cell_rows.array_diff_indexes(@last_cell_rows).each do |row|
+                  ::LibUI.table_model_row_inserted(model, row)
+                end
+              else
+                @cell_rows.each_with_index do |new_row_data, row|
+                  ::LibUI.table_model_row_changed(model, row) if new_row_data != @last_cell_rows[row]
                 end
               end
               @last_cell_rows = @cell_rows.clone

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - Andy Maleh