glimmer-dsl-libui 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aedcfa3ba9a8d44ce0df9ee4f684535d3492c858ca0171f4181a80ed4772899
-  data.tar.gz: 21f8b0577f27116216821c2bcbe3fd458261a5f8c957c5c0a2aa4683d370310d
+  metadata.gz: 5f7eb8d1c417de9910ff49f86592694558a3333f4840971f65be1232adf7408b
+  data.tar.gz: 9cdf9733b7026aae945ec183ba4551ee2bbe120454c0a094c02a99bd5338069a
 SHA512:
-  metadata.gz: fc1404d69d320e772a50506bfde13942cc7f981fb932c1c0999340c1c048ce64935eeac799d6af3b258a1a18ccb3472b9915814da72a96f5fb4d5f0b9af13fb6
-  data.tar.gz: eac5a371a0d685fab5cd397a43f7b25c333d855b5972c898dd0794c4001f61c08440d5da4f80911017155f0c051cea79391eefa5e603e13fb5292db12f4d2689
+  metadata.gz: 5a6c290b75e8301cadd8c837be2612dd4e653192577ea0c8f2493d4fa4a0b7198f2f8008c99d7adeef42320e5b4d86be339b37fe9ca588ee4cc9e22ad36c0a48
+  data.tar.gz: b51a3e1e878b9adde67cc6670f682df5d7ab09a6678b8b16655fbcb0d5e3770b5119f867ea58c4b025a78e043ed56cd0309f86eccdec0b90d31c19b375a0007b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 0.7.4
+
+- `table` `sortable` property (default: `true`) to enable automatic table sorting support when `cell_rows` is an `Array` (does not sort if `cell_rows` is a lazy enumerable)
+- Fix issue with not auto-checking checkboxes for zero-or-many table selection in `examples/basic_table_selection2.rb`
+- Rename `examples/basic_table_selection.rb` to `examples/basic_table_selection3.rb` and add new `examples/basic_table_selection.rb` with automated `table` selection via `sortable` property (default: `true`)
+- Disable automatic sorting by default in `refined_table` (set its `table` `sortable` property to `false`) since it does not sort over the entire collection, yet the visible collection only
+- Disable `sortable` sorting for `table` `button_column` since it does not make sense for it
+
+## 0.7.3
+
+- `table` `selection` data-binding support
+- `table` column `sort_indicator` data-binding support
+- New `examples/basic_table_selection2.rb` that uses `selection`, `selection_mode`, `header_visible`, and `sort_indicator` data-binding support
+
 ## 0.7.2
 
 - `table` `on_selection_changed` listener arguments now provide extra arguments of `selection`, `added_selection`, `removed_selection` after first argument (`table`)

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.7.2
+# [<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.7.4
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 ### The Quickest Way From Zero To GUI
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
@@ -544,7 +544,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.7.2'
+gem 'glimmer-dsl-libui', '~> 0.7.4'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -824,7 +824,7 @@ There are additional useful `Glimmer::LibUI` operations that are not found in `L
 
 The `table` control must first declare its columns via one of these column keywords (mentioned in [Supported Keywords](#supported-keywords)):
   - `background_color_column`: expects color cell values
-  - `button_column`: expects `String` cell values
+  - `button_column`: expects `String` cell values and a nested `on_clicked` listener that gets triggerd when a button is clicked
   - `checkbox_column`: expects Boolean cell values
   - `checkbox_text_column`: expects dual-element `Array` of Boolean and `String` cell values
   - `checkbox_text_color_column`: expects triple-element `Array` of Boolean, `String`, and color cell values
@@ -842,6 +842,22 @@ Note that the `cell_rows` property declaration results in "implicit data-binding
 - 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
 
+More details about table data-binding can be found in [examples/basic_table.rb](https://github.com/AndyObtiva/glimmer-dsl-libui/blob/master/docs/examples/GLIMMER-DSL-LIBUI-BASIC-EXAMPLES.md#basic-table) or other `table` [basic examples](https://github.com/AndyObtiva/glimmer-dsl-libui/blob/master/docs/examples/GLIMMER-DSL-LIBUI-BASIC-EXAMPLES.md) and [advanced examples](https://github.com/AndyObtiva/glimmer-dsl-libui/blob/master/docs/examples/GLIMMER-DSL-LIBUI-ADVANCED-EXAMPLES.md).
+
+The `table` control supports table selection and table sorting automatically as smart defaults, which can also be configured if needed as per the options below.
+
+There are other properties that `table` supports:
+- `selection_mode` (`Symbol`) [default: `:zero_or_one`]: sets selection mode to `:one`, `:zero_or_one`, `:zero_or_many`, or `:none`
+- `selection` (`Integer` or `Array` of `Integer`s): a single `Integer` row index for `:one` and `:zero_or_one` selection modes, or an `Array` of `Integer` row indexes if selection mode is `:zero_or_many`
+- `header_visible` (Boolean): shows or hides column headers
+- `sortable` (Boolean) [default: `true`]: enables automatic table sorting support
+
+To handle `table` sorting manually, the following can be set inside a table column:
+- `sort_indicator` (`Symbol`): sets sort indicator to ascending or descending with the value being `:ascending`, `:descending`, `:asc`, `:desc`, `:a`, or `:d`
+- `on_clicked` (`Proc`): this listener is triggered when a table column is clicked
+
+More details about table selection and table sorting can be found in [examples/basic_table_selection.rb](https://github.com/AndyObtiva/glimmer-dsl-libui/blob/master/docs/examples/GLIMMER-DSL-LIBUI-BASIC-EXAMPLES.md#basic-table-selection).
+
 ([explicit data-binding](#data-binding) supports everything available with implicit data-binding too)
 
 Example (you may copy/paste in [`girb`](#girb-glimmer-irb)):
@@ -1976,7 +1992,8 @@ 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 by using `<=>` and [implicit data-binding](#table-api) by assigning value directly)
+- `table`: `cell_rows`, `selection`
+- `table` columns (e.g. `text_column`): `sort_indicator`
 - `time_picker`: `time`
 
 Example of bidirectional data-binding:

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.4

data/docs/examples/GLIMMER-DSL-LIBUI-BASIC-EXAMPLES.md

@@ -1506,8 +1506,6 @@ Mac | Windows | Linux
 
 ## Basic Table Selection
 
-[examples/basic_table_selection.rb](/examples/basic_table_selection.rb)
-
 Run with this command from the root of the project if you cloned the project:
 
 ```
@@ -1526,6 +1524,14 @@ ruby -r glimmer-dsl-libui -e "require 'examples/basic_table_selection'"
 ![glimmer-dsl-libui-mac-basic-table-selection-none.png](/images/glimmer-dsl-libui-mac-basic-table-selection-none.png)
 ![glimmer-dsl-libui-mac-basic-table-selection-header-not-visible.png](/images/glimmer-dsl-libui-mac-basic-table-selection-header-not-visible.png)
 
+Version 1 (without data-binding):
+
+[examples/basic_table_selection.rb](/examples/basic_table_selection.rb)
+
+Version 2 (with data-binding):
+
+[examples/basic_table_selection2.rb](/examples/basic_table_selection2.rb)
+
 ## Basic Area
 
 [examples/basic_area.rb](/examples/basic_area.rb)

data/examples/basic_table_selection.rb

@@ -1,6 +1,45 @@
 require 'glimmer-dsl-libui'
 
 class BasicTableSelection
+  TableColumnPresenter = Struct.new(:name,
+                                    :column,
+                                    :table_presenter,
+                                    keyword_init: true)
+                                  
+  TablePresenter = Struct.new(:data,
+                              :column_names,
+                              :selection_mode,
+                              :selection,
+                              :header_visible,
+                              :sortable,
+                              keyword_init: true) do
+    def selection_items
+      data.size.times.map { |row| "Row #{row} Selection" }
+    end
+    
+    def toggle_header_visible
+      self.header_visible = !(header_visible.nil? || header_visible)
+    end
+    
+    def toggle_sortable
+      self.sortable = !(sortable.nil? || sortable)
+    end
+    
+    def column_presenters
+      @column_presenters ||= column_names.each_with_index.map do |column_name, column|
+        TableColumnPresenter.new(name: column_name, column: column, table_presenter: self)
+      end
+    end
+    
+    def selected_row
+      selection && data[selection]
+    end
+    
+    def selected_rows
+      selection && selection.is_a?(Array) && selection.map { |row| data[row] }
+    end
+  end
+  
   include Glimmer::LibUI::Application
   
   before_body do
@@ -11,10 +50,38 @@ class BasicTableSelection
       %w[horse neigh],
       %w[cow moo]
     ]
-    @one_table_data = data.dup
-    @zero_or_one_table_data = data.dup
-    @zero_or_many_table_data = data.dup
-    @none_table_data = data.dup
+    @one_table_presenter = TablePresenter.new(
+      data: data.dup,
+      column_names: ['Name', 'Description'],
+      selection_mode: :one, # other values are :zero_or_many , :zero_or_one, :none (default is :zero_or_one if not specified)
+      selection: 2, # initial selection row index (could be nil too or just left off, defaulting to 0)
+      header_visible: nil, # defaults to true
+      sortable: nil, # defaults to true
+    )
+    @zero_or_one_table_presenter = TablePresenter.new(
+      data: data.dup,
+      column_names: ['Name', 'Description'],
+      selection_mode: :zero_or_one, # other values are :zero_or_many , :one, :none (default is :zero_or_one if not specified)
+      selection: nil, # initial selection row index (could be an integer too or just left off, defaulting to nil)
+      header_visible: nil, # defaults to true
+      sortable: nil, # defaults to true
+    )
+    @zero_or_many_table_presenter = TablePresenter.new(
+      data: data.dup,
+      column_names: ['Name', 'Description'],
+      selection_mode: :zero_or_many, # other values are :zero_or_many , :one, :none (default is :zero_or_one if not specified)
+      selection: [0, 2, 4], # initial selection row index (could be an integer too or just left off, defaulting to nil)
+      header_visible: nil, # defaults to true
+      sortable: nil, # defaults to true
+    )
+    @none_table_presenter = TablePresenter.new(
+      data: data.dup,
+      column_names: ['Name', 'Description'],
+      selection_mode: :none, # other values are :zero_or_many , :zero_or_one, :one (default is :zero_or_one if not specified)
+      selection: nil, # defaults to nil
+      header_visible: nil, # defaults to true
+      sortable: nil, # defaults to true
+    )
   end
   
   body {
@@ -26,42 +93,37 @@ class BasicTableSelection
               stretchy false
               
               @one_table_selection_radio_buttons = radio_buttons {
-                items @one_table_data.size.times.map { |row| "Row #{row} Selection" }
-                
-                on_selected do |rb|
-                  @one_table.selection = [rb.selected]
-                end
+                items @one_table_presenter.selection_items
+                selected <=> [@one_table_presenter, :selection]
               }
             }
-            
-            button('Toggle Table Header Visibility') {
+
+            horizontal_box {
               stretchy false
               
-              on_clicked do
-                @one_table.header_visible = !@one_table.header_visible
-              end
-            }
-            
-            @one_table = table {
-              text_column('Animal') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_one_table_column(tc, column)
+              button('Toggle Table Header Visibility') {
+                on_clicked do
+                  @one_table_presenter.toggle_header_visible
                 end
               }
-              text_column('Description') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_one_table_column(tc, column)
+              
+              button('Toggle Table Sortability') {
+                on_clicked do
+                  @one_table_presenter.toggle_sortable # toggles sortable attribute to false or true
                 end
               }
+            }
+            
+            @one_table = table {
+              @one_table_presenter.column_presenters.each do |column_presenter|
+                text_column(column_presenter.name)
+              end
         
-              cell_rows @one_table_data
-              selection_mode :one # other values are :zero_or_many , :zero_or_one, :none (default is :zero_or_one if not specified)
-              selection 2 # initial selection row index (could be nil too or just left off, defaulting to 0)
-              # header_visible true # default
+              cell_rows @one_table_presenter.data
+              selection_mode <= [@one_table_presenter, :selection_mode]
+              selection <=> [@one_table_presenter, :selection]
+              header_visible <= [@one_table_presenter, :header_visible]
+              sortable <= [@one_table_presenter, :sortable]
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -77,54 +139,48 @@ class BasicTableSelection
                 puts "Selection Changed: #{selection.inspect}"
                 puts "Added Selection: #{added_selection.inspect}"
                 puts "Removed Selection: #{removed_selection.inspect}"
-                @one_table_selection_radio_buttons.selected = selection
               end
             }
           }
         }
-              
+        
         tab_item('Zero-Or-One') {
           vertical_box {
             vertical_box {
               stretchy false
               
               @zero_or_one_table_selection_radio_buttons = radio_buttons {
-                items @zero_or_one_table_data.size.times.map { |row| "Row #{row} Selection" }
-                
-                on_selected do |rb|
-                  @zero_or_one_table.selection = [rb.selected]
-                end
+                items @zero_or_one_table_presenter.selection_items
+                selected <=> [@zero_or_one_table_presenter, :selection]
               }
             }
             
-            button('Toggle Table Header Visibility') {
+            horizontal_box {
               stretchy false
               
-              on_clicked do
-                @zero_or_one_table.header_visible = !@zero_or_one_table.header_visible
-              end
-            }
-            
-            @zero_or_one_table = table {
-              text_column('Animal') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_zero_or_one_table_column(tc, column)
+              button('Toggle Table Header Visibility') {
+                on_clicked do
+                  @zero_or_one_table_presenter.toggle_header_visible
                 end
               }
-              text_column('Description') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_zero_or_one_table_column(tc, column)
+              
+              button('Toggle Table Sortability') {
+                on_clicked do
+                  @zero_or_one_table_presenter.toggle_sortable # toggles sortable attribute to false or true
                 end
               }
+            }
+            
+            @zero_or_one_table = table {
+              @zero_or_one_table_presenter.column_presenters.each do |column_presenter|
+                text_column(column_presenter.name)
+              end
         
-              cell_rows @zero_or_one_table_data
-              selection_mode :zero_or_one # other values are :zero_or_many , :one, :none (default is :zero_or_one if not specified)
-              # selection 0 # initial selection row index (could be nil too or just left off)
-              # header_visible true # default
+              cell_rows @zero_or_one_table_presenter.data
+              selection_mode <= [@zero_or_one_table_presenter, :selection_mode]
+              selection <=> [@zero_or_one_table_presenter, :selection]
+              header_visible <= [@zero_or_one_table_presenter, :header_visible]
+              sortable <= [@zero_or_one_table_presenter, :sortable]
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -140,7 +196,6 @@ class BasicTableSelection
                 puts "Selection Changed: #{selection.inspect}"
                 puts "Added Selection: #{added_selection.inspect}"
                 puts "Removed Selection: #{removed_selection.inspect}"
-                @zero_or_one_table_selection_radio_buttons.selected = selection
               end
             }
           }
@@ -151,49 +206,46 @@ class BasicTableSelection
             vertical_box {
               stretchy false
               
-              @zero_or_many_table_selection_checkboxes = @zero_or_many_table_data.size.times.map do |row|
+              @zero_or_many_table_selection_checkboxes = @zero_or_many_table_presenter.data.size.times.map do |row|
                 checkbox("Row #{row} Selection") {
-                  on_toggled do |c|
-                    table_selection = @zero_or_many_table.selection.to_a
-                    if c.checked?
-                      table_selection << row unless table_selection.include?(row)
-                    else
-                      table_selection.delete(row) if table_selection.include?(row)
-                    end
-                    @zero_or_many_table.selection = table_selection
-                  end
+                  checked <=> [@zero_or_many_table_presenter, :selection,
+                                on_read: ->(selection_rows) {selection_rows.to_a.include?(row)},
+                                on_write: ->(checked_value) {
+                                  checked_value ?
+                                    (@zero_or_many_table_presenter.selection.to_a + [row]).uniq :
+                                    @zero_or_many_table_presenter.selection.to_a.reject {|v| v == row }
+                                },
+                              ]
                 }
               end
             }
             
-            button('Toggle Table Header Visibility') {
+            horizontal_box {
               stretchy false
               
-              on_clicked do
-                @zero_or_many_table.header_visible = !@zero_or_many_table.header_visible
-              end
-            }
-            
-            @zero_or_many_table = table {
-              text_column('Animal') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_zero_or_many_table_column(tc, column)
+              button('Toggle Table Header Visibility') {
+                on_clicked do
+                  @zero_or_many_table_presenter.toggle_header_visible
                 end
               }
-              text_column('Description') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_zero_or_many_table_column(tc, column)
+              
+              button('Toggle Table Sortability') {
+                on_clicked do
+                  @zero_or_many_table_presenter.toggle_sortable # toggles sortable attribute to false or true
                 end
               }
+            }
+            
+            @zero_or_many_table = table {
+              @zero_or_many_table_presenter.column_presenters.each do |column_presenter|
+                text_column(column_presenter.name)
+              end
         
-              cell_rows @zero_or_many_table_data
-              selection_mode :zero_or_many # other values are :none , :zero_or_one , and :one (default is :zero_or_one if not specified)
-              selection 0, 2, 4 # initial selection row indexes (could be empty array too or just left off)
-              # header_visible true # default
+              cell_rows @zero_or_many_table_presenter.data
+              selection_mode <= [@zero_or_many_table_presenter, :selection_mode]
+              selection <=> [@zero_or_many_table_presenter, :selection]
+              header_visible <= [@zero_or_many_table_presenter, :header_visible]
+              sortable <= [@zero_or_many_table_presenter, :sortable]
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -209,46 +261,39 @@ class BasicTableSelection
                 puts "Selection Changed: #{selection.inspect}"
                 puts "Added Selection: #{added_selection.inspect}"
                 puts "Removed Selection: #{removed_selection.inspect}"
-                removed_selection&.each do |selected_row|
-                  @zero_or_many_table_selection_checkboxes[selected_row].checked = false
-                end
-                added_selection&.each do |selected_row|
-                  @zero_or_many_table_selection_checkboxes[selected_row].checked = true
-                end
               end
             }
           }
         }
-                
+        
         tab_item('None') {
           vertical_box {
-            button('Toggle Table Header Visibility') {
+            horizontal_box {
               stretchy false
               
-              on_clicked do
-                @none_table.header_visible = !@none_table.header_visible
-              end
-            }
-            
-            @none_table = table {
-              text_column('Animal') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_none_table_column(tc, column)
+              button('Toggle Table Header Visibility') {
+                on_clicked do
+                  @none_table_presenter.toggle_header_visible
                 end
               }
-              text_column('Description') {
-                # sort_indicator :descending # (optional) can be :ascending, :descending, or nil (default)
-                
-                on_clicked do |tc, column|
-                  sort_none_table_column(tc, column)
+              
+              button('Toggle Table Sortability') {
+                on_clicked do
+                  @none_table_presenter.toggle_sortable # toggles sortable attribute to false or true
                 end
               }
+            }
+            
+            @none_table = table {
+              @none_table_presenter.column_presenters.each do |column_presenter|
+                text_column(column_presenter.name)
+              end
         
-              cell_rows @none_table_data
-              selection_mode :none # other values are :zero_or_many , :zero_or_one, :one (default is :zero_or_one if not specified)
-              # header_visible true # default
+              cell_rows @none_table_presenter.data
+              selection_mode <= [@none_table_presenter, :selection_mode]
+              selection <=> [@none_table_presenter, :selection]
+              header_visible <= [@none_table_presenter, :header_visible]
+              sortable <= [@none_table_presenter, :sortable]
         
               on_row_clicked do |t, row|
                 puts "Row Clicked: #{row}"
@@ -264,40 +309,6 @@ class BasicTableSelection
       }
     }
   }
-  
-  def sort_one_table_column(tc, column)
-    puts "Clicked column #{column}: #{tc.name}"
-    selected_row = @one_table.selection && @one_table_data[@one_table.selection]
-    tc.toggle_sort_indicator
-    @one_table_data.sort_by! { |row_data| row_data[column] }
-    @one_table_data.reverse! if tc.sort_indicator == :descending
-    @one_table.selection = @one_table_data.index(selected_row)
-  end
-  
-  def sort_zero_or_one_table_column(tc, column)
-    puts "Clicked column #{column}: #{tc.name}"
-    selected_row = @zero_or_one_table.selection && @zero_or_one_table_data[@zero_or_one_table.selection]
-    tc.toggle_sort_indicator
-    @zero_or_one_table_data.sort_by! { |row_data| row_data[column] }
-    @zero_or_one_table_data.reverse! if tc.sort_indicator == :descending
-    @zero_or_one_table.selection = @zero_or_one_table_data.index(selected_row)
-  end
-  
-  def sort_zero_or_many_table_column(tc, column)
-    puts "Clicked column #{column}: #{tc.name}"
-    selected_rows = @zero_or_many_table.selection&.map { |row| @zero_or_many_table_data[row] }
-    tc.toggle_sort_indicator
-    @zero_or_many_table_data.sort_by! { |row_data| row_data[column] }
-    @zero_or_many_table_data.reverse! if tc.sort_indicator == :descending
-    @zero_or_many_table.selection = selected_rows&.map {|row_data| @zero_or_many_table_data.index(row_data) }
-  end
-  
-  def sort_none_table_column(tc, column)
-    puts "Clicked column #{column}: #{tc.name}"
-    tc.toggle_sort_indicator
-    @none_table_data.sort_by! { |row_data| row_data[column] }
-    @none_table_data.reverse! if tc.sort_indicator == :descending
-  end
 end
 
 BasicTableSelection.launch