glimmer-dsl-libui 0.5.16 → 0.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99ed9eb0a65da64d13717cf3f967ceadc36c4a0eed74fcbb385bd5d19c812db2
-  data.tar.gz: f24060ff8ef38a93c1f3174d3e01102d61d2c0c8d8466b1e0d32fedc8972c9ea
+  metadata.gz: b837f495b6ee88ac59beb20c32f1bd3c3fe3b777a4b195d64c2958afb46cf039
+  data.tar.gz: 515861c59a0136a1425f7eb24a9613686595bb2e09657ec096a2a6ec3552b9cc
 SHA512:
-  metadata.gz: def5540396a5cffc5f1271d3bb2664d008cf26db2f88207dc75bc23fa9915a2badfa45db8778e59644c99cbb0753147361556de25d118acd51e2dc211abd4bc8
-  data.tar.gz: 30ac47a92b4439aca5f3bc244514b400f810d8a9c855f64acf924544b448647d0d573d5218bc2e515ceb7bb469978b1e3e754d74d3ff86aea0b7d7247ee0e433
+  metadata.gz: 5e84bd0c82fdc0c8aa5876a628e1f0ecf327e08a692ff531764f1a2f9311f24ec89998a9a4959ba65f93a0aad8e645c24bb3a14348d96282e64be2ccdeaea983
+  data.tar.gz: 3870d2d46189f0b81c6490d169f7fef63e782d408a7d20038b43fd1ebbf90ebac34b615c4b96514f1cf1294dae6f4b56933fe0c55430c5e9b1fd542654025c4d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 0.5.17
+
+- Ensure disabling pagination buttons in `refined_table` if page is at beginning or end
+- Add a "of #{page_count} pages" label after the text control in `refined_table` pagination area
+- Page count ("of #{page_count} pages" label) can be shown by setting `visible_page_count: true` in `refined_table` options
+- Correct initial `page` option passed to `refined_table` if out of range
+- If `refined_table` `model_array` has no more than a single page of data, then hide pagination buttons
+
 ## 0.5.16
 
 - `refined_table` custom control that renders a `table` with filtering and pagination, thus being able to handle a large data set (e.g. 50,000)

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.5.16
+# [<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.5.17
 ## 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)
@@ -584,7 +584,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.5.16'
+gem 'glimmer-dsl-libui', '~> 0.5.17'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -766,7 +766,7 @@ Keyword(Args) | Properties | Listeners
 `quit_menu_item` | None | `on_clicked`
 `radio_buttons` | `selected` (`Integer`) | `on_selected`
 `rectangle(x as Numeric, y as Numeric, width as Numeric, height as Numeric)` |  `x` (`Numeric`), `y` (`Numeric`), `width` (`Numeric`), `height` (`Numeric`) | None
-`refined_table` | (EARLY ALPHA UNSTABLE API / CHECK SOURCE CODE FOR DETAILS) | (EARLY ALPHA UNSTABLE API / CHECK SOURCE CODE FOR DETAILS)
+`refined_table` | `model_array` (`Array`), `table_columns` (`Hash`), `table_editable` (Boolean), `per_page` (`Integer`), `page` (`Integer`), `visible_page_count` (Boolean) | (EARLY ALPHA UNSTABLE API / CHECK SOURCE CODE FOR DETAILS)
 `scrolling_area(width = main_window.width, height = main_window.height)` | `auto_draw_enabled` (Boolean), `size` (`Array` of `width` (`Numeric`) and `height` (`Numeric`)), `width` (`Numeric`), `height` (`Numeric`) | `on_draw(area_draw_params)`, `on_mouse_event(area_mouse_event)`, `on_mouse_down(area_mouse_event)`, `on_mouse_up(area_mouse_event)`, `on_mouse_drag_started(area_mouse_event)`, `on_mouse_dragged(area_mouse_event)`, `on_mouse_dropped(area_mouse_event)`, `on_mouse_entered`, `on_mouse_exited`, `on_key_event(area_key_event)`, `on_key_down(area_key_event)`, `on_key_up(area_key_event)`
 `search_entry` | `read_only` (Boolean), `text` (`String`) | `on_changed`
 `separator_menu_item` | None | None
@@ -998,11 +998,22 @@ Learn more by checking out [examples](#examples).
 
 [EARLY ALPHA FEATURE]
 
-`refined_table` is a custom control provided exclusively by Glimmer DSL for LibUI that includes filtering and pagination support out of the box and can handle very large amounts of data (e.g. 50,000 rows).
+`refined_table` is a custom control provided exclusively by [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui)
+that includes filtering and pagination support out of the box and can handle very large amounts of data (e.g. 50,000 rows).
 
 It is currently an early alpha feature, so please test-drive and report issues if you encounter any.
+And, please keep in mind that the API might undergo big changes.
 
-Also, the API might undergo big changes, so please keep that in mind.
+Options (passed as kwargs hash):
+
+- `model_array` (`Array`): array of models for which attributes map to table columns
+- `table_columns` (`Hash`): this maps column types to symbols (e.g. `text_column` becomes `:text`) with hash options per column
+- `table_editable` (Boolean) [default: `false`]: this indicates if all table columns are editable or not.
+- `per_page` (`Integer`)
+- `page` (`Integer`)
+- `visible_page_count` (Boolean) [default: `false`]: shows "of PAGE_COUNT pages" after page `entry` field
+
+If the initial `model_array` has no more than a single page of data, then pagination buttons are hidden (but, the filter field remains).
 
 Example code:
 
@@ -1016,9 +1027,10 @@ refined_table(
     'City'  => :text,
     'State' => :text,
   },
-  table_editable: true,
+  table_editable: true, # default value is false
   per_page: 20, # row count per page
-  page: 5, # initial page
+  # page: 1, # initial page is 1
+  # visible_page_count: true, # page count can be shown if preferred
 )
 ```
 
@@ -8046,148 +8058,21 @@ class PaginatedRefinedTable
   include Glimmer::LibUI::Application
   
   NAMES_FIRST = %w[
-    Liam
-    Noah
-    William
-    James
-    Oliver
-    Benjamin
-    Elijah
-    Lucas
-    Mason
-    Logan
-    Alexander
-    Ethan
-    Jacob
-    Michael
-    Daniel
-    Henry
-    Jackson
-    Sebastian
-    Aiden
-    Matthew
-    Samuel
-    David
-    Joseph
-    Carter
-    Owen
-    Wyatt
-    John
-    Jack
-    Luke
-    Jayden
-    Dylan
-    Grayson
-    Levi
-    Isaac
-    Gabriel
-    Julian
-    Mateo
-    Anthony
-    Jaxon
-    Lincoln
-    Joshua
-    Christopher
-    Andrew
-    Theodore
-    Caleb
-    Ryan
-    Asher
-    Nathan
-    Thomas
-    Leo
-    Isaiah
-    Charles
-    Josiah
-    Hudson
-    Christian
-    Hunter
-    Connor
-    Eli
-    Ezra
-    Aaron
-    Landon
-    Adrian
-    Jonathan
-    Nolan
-    Jeremiah
-    Easton
-    Elias
-    Colton
-    Cameron
-    Carson
-    Robert
-    Angel
-    Maverick
-    Nicholas
-    Dominic
-    Jaxson
-    Greyson
-    Adam
-    Ian
-    Austin
-    Santiago
-    Jordan
-    Cooper
-    Brayden
-    Roman
-    Evan
-    Ezekiel
-    Xaviar
-    Jose
-    Jace
-    Jameson
-    Leonardo
-    Axel
-    Everett
-    Kayden
-    Miles
-    Sawyer
-    Jason
-    Emma
-    Olivia
-    Bartholomew
-    Corey
-    Danielle
-    Eva
-    Felicity
+    Liam Noah William James Oliver Benjamin Elijah Lucas Mason Logan Alexander Ethan Jacob Michael Daniel Henry Jackson Sebastian
+    Aiden Matthew Samuel David Joseph Carter Owen Wyatt John Jack Luke Jayden Dylan Grayson Levi Isaac Gabriel Julian Mateo
+    Anthony Jaxon Lincoln Joshua Christopher Andrew Theodore Caleb Ryan Asher Nathan Thomas Leo Isaiah Charles Josiah Hudson
+    Christian Hunter Connor Eli Ezra Aaron Landon Adrian Jonathan Nolan Jeremiah Easton Elias Colton Cameron Carson Robert Angel
+    Maverick Nicholas Dominic Jaxson Greyson Adam Ian Austin Santiago Jordan Cooper Brayden Roman Evan Ezekiel Xaviar Jose Jace
+    Jameson Leonardo Axel Everett Kayden Miles Sawyer Jason Emma Olivia Bartholomew Corey Danielle Eva Felicity
   ]
   
   NAMES_LAST = %w[
-    Smith
-    Johnson
-    Williams
-    Brown
-    Jones
-    Miller
-    Davis
-    Wilson
-    Anderson
-    Taylor
-    George
-    Harrington
-    Iverson
-    Jackson
-    Korby
-    Levinson
+    Smith Johnson Williams Brown Jones Miller Davis Wilson Anderson Taylor George Harrington Iverson Jackson Korby Levinson
   ]
   
   CITIES = [
-    'Bellesville',
-    'Lombardia',
-    'Steepleton',
-    'Deerenstein',
-    'Schwartz',
-    'Hollandia',
-    'Saint Pete',
-    'Grandville',
-    'London',
-    'Berlin',
-    'Elktown',
-    'Paris',
-    'Garrison',
-    'Muncy',
-    'St Louis',
+    'Bellesville', 'Lombardia', 'Steepleton', 'Deerenstein', 'Schwartz', 'Hollandia', 'Saint Pete', 'Grandville', 'London',
+    'Berlin', 'Elktown', 'Paris', 'Garrison', 'Muncy', 'St Louis',
   ]
   
   STATES = [ 'AK', 'AL', 'AR', 'AZ', 'CA', 'CO', 'CT', 'DC', 'DE', 'FL', 'GA',
@@ -8265,7 +8150,7 @@ class PaginatedRefinedTable
         refined_table(
           model_array: contacts,
           table_columns: {
-            'Name'  => :text,
+            'Name'  => {text: {editable: false}},
             'Email' => :text,
             'Phone' => :text,
             'City'  => :text,
@@ -8273,6 +8158,8 @@ class PaginatedRefinedTable
           },
           table_editable: true,
           per_page: 20,
+          # page: 1, # initial page is 1
+          # visible_page_count: true, # page count can be shown if preferred
         )
       }
     }

data/VERSION

@@ -1 +1 @@
-0.5.16
+0.5.17

data/examples/paginated_refined_table.rb

@@ -6,148 +6,21 @@ class PaginatedRefinedTable
   include Glimmer::LibUI::Application
   
   NAMES_FIRST = %w[
-    Liam
-    Noah
-    William
-    James
-    Oliver
-    Benjamin
-    Elijah
-    Lucas
-    Mason
-    Logan
-    Alexander
-    Ethan
-    Jacob
-    Michael
-    Daniel
-    Henry
-    Jackson
-    Sebastian
-    Aiden
-    Matthew
-    Samuel
-    David
-    Joseph
-    Carter
-    Owen
-    Wyatt
-    John
-    Jack
-    Luke
-    Jayden
-    Dylan
-    Grayson
-    Levi
-    Isaac
-    Gabriel
-    Julian
-    Mateo
-    Anthony
-    Jaxon
-    Lincoln
-    Joshua
-    Christopher
-    Andrew
-    Theodore
-    Caleb
-    Ryan
-    Asher
-    Nathan
-    Thomas
-    Leo
-    Isaiah
-    Charles
-    Josiah
-    Hudson
-    Christian
-    Hunter
-    Connor
-    Eli
-    Ezra
-    Aaron
-    Landon
-    Adrian
-    Jonathan
-    Nolan
-    Jeremiah
-    Easton
-    Elias
-    Colton
-    Cameron
-    Carson
-    Robert
-    Angel
-    Maverick
-    Nicholas
-    Dominic
-    Jaxson
-    Greyson
-    Adam
-    Ian
-    Austin
-    Santiago
-    Jordan
-    Cooper
-    Brayden
-    Roman
-    Evan
-    Ezekiel
-    Xaviar
-    Jose
-    Jace
-    Jameson
-    Leonardo
-    Axel
-    Everett
-    Kayden
-    Miles
-    Sawyer
-    Jason
-    Emma
-    Olivia
-    Bartholomew
-    Corey
-    Danielle
-    Eva
-    Felicity
+    Liam Noah William James Oliver Benjamin Elijah Lucas Mason Logan Alexander Ethan Jacob Michael Daniel Henry Jackson Sebastian
+    Aiden Matthew Samuel David Joseph Carter Owen Wyatt John Jack Luke Jayden Dylan Grayson Levi Isaac Gabriel Julian Mateo
+    Anthony Jaxon Lincoln Joshua Christopher Andrew Theodore Caleb Ryan Asher Nathan Thomas Leo Isaiah Charles Josiah Hudson
+    Christian Hunter Connor Eli Ezra Aaron Landon Adrian Jonathan Nolan Jeremiah Easton Elias Colton Cameron Carson Robert Angel
+    Maverick Nicholas Dominic Jaxson Greyson Adam Ian Austin Santiago Jordan Cooper Brayden Roman Evan Ezekiel Xaviar Jose Jace
+    Jameson Leonardo Axel Everett Kayden Miles Sawyer Jason Emma Olivia Bartholomew Corey Danielle Eva Felicity
   ]
   
   NAMES_LAST = %w[
-    Smith
-    Johnson
-    Williams
-    Brown
-    Jones
-    Miller
-    Davis
-    Wilson
-    Anderson
-    Taylor
-    George
-    Harrington
-    Iverson
-    Jackson
-    Korby
-    Levinson
+    Smith Johnson Williams Brown Jones Miller Davis Wilson Anderson Taylor George Harrington Iverson Jackson Korby Levinson
   ]
   
   CITIES = [
-    'Bellesville',
-    'Lombardia',
-    'Steepleton',
-    'Deerenstein',
-    'Schwartz',
-    'Hollandia',
-    'Saint Pete',
-    'Grandville',
-    'London',
-    'Berlin',
-    'Elktown',
-    'Paris',
-    'Garrison',
-    'Muncy',
-    'St Louis',
+    'Bellesville', 'Lombardia', 'Steepleton', 'Deerenstein', 'Schwartz', 'Hollandia', 'Saint Pete', 'Grandville', 'London',
+    'Berlin', 'Elktown', 'Paris', 'Garrison', 'Muncy', 'St Louis',
   ]
   
   STATES = [ 'AK', 'AL', 'AR', 'AZ', 'CA', 'CO', 'CT', 'DC', 'DE', 'FL', 'GA',
@@ -233,6 +106,8 @@ class PaginatedRefinedTable
           },
           table_editable: true,
           per_page: 20,
+          # page: 1, # initial page is 1
+          # visible_page_count: true, # page count can be hidden if preferred
         )
       }
     }

data/lib/glimmer/libui/custom_control/refined_table.rb

@@ -6,6 +6,7 @@ class RefinedTable
   option :table_editable, default: false
   option :per_page, default: 10
   option :page, default: 1
+  option :visible_page_count, default: false
   
   attr_accessor :filtered_model_array, :filter_query, :filter_query_page_stack, :paginated_model_array
   
@@ -14,6 +15,7 @@ class RefinedTable
     @filter_query_page_stack = {}
     @filtered_model_array = model_array.dup
     @filtered_model_array_stack = {@filter_query => @filtered_model_array}
+    self.page = correct_page(page)
     paginate_model_array
   end
   
@@ -21,7 +23,7 @@ class RefinedTable
     vertical_box {
       table_filter
 
-      table_paginator
+      table_paginator if page_count > 1
       
       @table = table {
         table_columns.each do |column_name, column_details|
@@ -74,8 +76,10 @@ class RefinedTable
   def table_paginator
     horizontal_box {
       stretchy false
-
+      
       button('<<') {
+        enabled <= [self, :page, on_read: ->(val) {val > 1}]
+        
         on_clicked do
           unless self.page == 0
             self.page = 1
@@ -83,7 +87,10 @@ class RefinedTable
           end
         end
       }
+      
       button('<') {
+        enabled <= [self, :page, on_read: ->(val) {val > 1}]
+        
         on_clicked do
           unless self.page == 0
             self.page = [page - 1, 1].max
@@ -91,6 +98,7 @@ class RefinedTable
           end
         end
       }
+      
       entry {
         text <=> [self, :page,
                   on_read: :to_s,
@@ -98,7 +106,16 @@ class RefinedTable
                   after_write: ->(val) { paginate_model_array },
                  ]
       }
+      
+      if visible_page_count
+        label {
+          text <= [self, :paginated_model_array, on_read: ->(val) {"of #{page_count} pages"}]
+        }
+      end
+      
       button('>') {
+        enabled <= [self, :page, on_read: ->(val) {val < page_count}]
+        
         on_clicked do
           unless self.page == 0
             self.page = [page + 1, page_count].min
@@ -106,7 +123,10 @@ class RefinedTable
           end
         end
       }
+      
       button('>>') {
+        enabled <= [self, :page, on_read: ->(val) {val < page_count}]
+        
         on_clicked do
           unless self.page == 0
             self.page = page_count

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.5.16
+  version: 0.5.17
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-31 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer