glimmer-dsl-tk 0.0.58 → 0.0.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf96d61575c30434197c7edfe2bfb6e6fd9fb84c70c18c0e924d688418351315
-  data.tar.gz: eaa003fd150d7fac2e85196e477714ea7df87d7a4651e44c0a909b8c566085c3
+  metadata.gz: 65202d323a2567e112890475495d310877f839c0a064f8f4e17e2564df47b422
+  data.tar.gz: 93515ff8e8ef6ff1e8b3eae4d3f809522110fb9e0e83e4523eaede034cd605d0
 SHA512:
-  metadata.gz: 9451fadd605400721e4fd02a601e2720a2e4a41daa28aa0fa69b32f43ae1334de5ecde54ed2cd7d0f13bebdcdfe666daa4391c585fbea24302556eec8389f8af
-  data.tar.gz: c9e1ad3acd64c17b7642500ed7764c8f3be955de5a5a34d9cd482ac65a23aaba613396d6b14cfaddcd1537d63df6c3e810e723cd48c46bbcb318b00e4b5bc1ed
+  metadata.gz: a5206b004b6b49c5b29444410b86d978cb787314e25c32f069e2e973b456f164a20c04a295a2cac4bd90d0e5627df5477605daf8cc9439bf883caea4e79485b3
+  data.tar.gz: 9addeadf0b91a2c51a0ac137b550d700a2a621d52ca997d8618ff6d83281be2c030eebe34ca0cf4bd0c122b3fa4b26c9ac8ecf4b1e2b3f46ba7bafad562f1052

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 0.0.61
+
+- Fix issue with Hello, Entry! breaking after the latest release due to mistakenly converting color `'red'` to `'#red'` by thinking it is hex
+
+## 0.0.60
+
+- Update Hello, Built-in Dialog! with more options for customizing dialogs
+- Support setting colors as rgb colors via `r, g, b` (e.g. `foreground 210, 48, 110`)
+- Accept hex color strings not starting with `#` (e.g. `background 'f828d7'`)
+
+## 0.0.59
+
+- Auto-Default to `validate 'key'` on an `entry` when defining `validatecommand {}`, `on('validate') {}`, `invalidcommand {}`, `on('invalid') {}`
+
 ## 0.0.58
 
 - Support `@tk.textvariable.trace('write')` kind of variable tracing via `on_var(trace_operation) {}` listeners (e.g. `on_textvariable('write') {}`)

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 Tk 0.0.58
+# [<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 Tk 0.0.61
 ## Ruby Tk Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-tk.svg)](http://badge.fury.io/rb/glimmer-dsl-tk)
 [![Ruby](https://github.com/AndyObtiva/glimmer-dsl-tk/actions/workflows/ruby.yml/badge.svg)](https://github.com/AndyObtiva/glimmer-dsl-tk/actions/workflows/ruby.yml)
@@ -195,7 +195,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '0.0.58'
+gem 'glimmer-dsl-tk', '0.0.61'
 ```
 
 And, then run:
@@ -309,14 +309,14 @@ keyword(args) | attributes | event bindings & callbacks
 ------------- | ---------- | ---------
 `button` | `text`, `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `default` (`'active', 'normal'`) | `command {}`
 `checkbutton` | `text`, `variable` (Boolean), `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `onvalue` (default: `1`), `offvalue` (default: `0`) | `command {}`
-`choose_color(options = nil)` | None | None
-`choose_directory(options = nil)` | None | None
-`choose_font(options = nil) {|font| ... }` | None | None
+`choose_color(parent: nil, initialcolor: 'white', title: 'Colors')` | None | None
+`choose_directory(parent: nil)` | None | None
+`choose_font(family: nil, size: nil, weight: nil) {|font| ... }` | None | None
 `combobox` | `state`, `text` | `'ComboboxSelected'`
 `entry` | `width`, `text`, `validate`, `show` (`'none', 'focus', 'focusin', 'focusout', 'key', or 'all'`) | `'validate'`, `'invalid'`, `'change'` (alias: `'changed'`), `validatecommand {}`, `invalidcommand {}`
-`get_multiple_open_file(options = nil)` | None | None
-`get_open_file(options = nil)` | None | None
-`get_save_file(options = nil)` | None | None
+`get_multiple_open_file(parent: nil, title: '')` | None | None
+`get_open_file(parent: nil, title: '')` | None | None
+`get_save_file(parent: nil, title: '')` | None | None
 `spinbox` | `text`, `from`, `to`, `increment`, `format`, [more attributes](https://tcl.tk/man/tcl8.6/TkCmd/text.htm#M116) | `command {}`, `'increment'`, `'decrement'`
 `frame(text: nil)` | `width`, `height`, `borderwidth`, `relief` (`'flat' (default), 'raised', 'sunken', 'solid', 'ridge', 'groove'`) | None
 `label` | `text`, `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `font` (`'default', 'text', 'fixed', 'menu', 'heading', 'caption', 'small_caption', 'icon', 'tooltip'`), `relief` (`'flat' (default), 'raised', 'sunken', 'solid', 'ridge', 'groove'`), `justify` (`'left', 'center', 'right'`), `foreground`, `background` | None
@@ -343,6 +343,8 @@ Options for `get_open_file` and `get_multiple_open_file` include:
 #### Common Attributes
 
 - `grid`: `Hash` of `:row`, `:column`, `:padx`, `:pady`, `:sticky` (`'e', 'w', 'n', 's'` or any combination of direction letters)
+- `foreground`: [Built-in Color](https://tcl.tk/man/tcl8.6/TkCmd/colors.htm) (e.g. `'AliceBlue'`), Hex color (e.g. `'#ffd807'`), or RGB color array (e.g. `foreground 255, 128, 75`)
+- `background`: [Built-in Color](https://tcl.tk/man/tcl8.6/TkCmd/colors.htm) (e.g. `'AliceBlue'`), Hex color (e.g. `'#ffd807'`), or RGB color array (e.g. `foreground 255, 128, 75`)
 
 #### Common Event Bindings
 
@@ -2181,12 +2183,13 @@ class HelloEntry
   def launch
     root {
       title 'Hello, Entry!'
-      
+      minsize 230, 0
+         
       label {
         grid sticky: 'ew'
         text 'default entry'
       }
-      entry {
+      entry { |the_entry|
         grid sticky: 'ew'
         text <=> [self, :default]
       }
@@ -2205,11 +2208,14 @@ class HelloEntry
         grid sticky: 'ew'
         text 'entry with event handlers'
       }
-      entry {
+      entry { |the_entry|
         grid sticky: 'ew'
         text <=> [self, :telephone]
-        validate 'key'
 
+        # validate 'key' # default when on('validate') or on('invalid') is specified
+        ## Validation happens on key change by default when validation listeners are specified
+        ## (other accepted values: 'none', 'focus', 'focusin', 'focusout', 'key', or 'all')
+        
         ## this event kicks in just after the user typed and before modifying the text variable
         on('validate') do |new_text_variable|
           telephone?(new_text_variable.value)
@@ -2217,7 +2223,7 @@ class HelloEntry
 
         ## this event kicks in just after the text variable is validated and before it is modified
         on('invalid') do |validate_args|
-          @validated_entry_label.text = "#{validate_args.string} is not valid!"
+          @validated_entry_label.text = "#{validate_args.value} is not a valid phone!"
           @validated_entry_label.foreground = 'red'
         end
 
@@ -2227,6 +2233,13 @@ class HelloEntry
           @validated_entry_label.text = 'entry with event handlers'
           @validated_entry_label.foreground = nil
         end
+        
+        ## this is similar to on('change') (which is Glimmer-specific), but more low level at the Tk level
+        ## it is the equivalent of calling: the_entry.tk.textvariable.trace('write') { puts "..." }
+        ## More at: https://tkdocs.com/tutorial/widgets.html#entry and https://tcl.tk/man/tcl8.6/TclCmd/trace.htm#M14
+        on_textvariable('write') do
+          puts "\"#{the_entry.text}\" has been written to entry!"
+        end
       }
 
       label {
@@ -4274,9 +4287,9 @@ https://github.com/ancorgs/y3network-ruby-ui
 
 This is a Graphical User Interface for the famous [cryptopunks Ruby gem](https://github.com/cryptopunksnotdead/cryptopunks/tree/master/cryptopunks).
 
-https://github.com/cryptopunksnotdead/cryptopunks-gui
+https://github.com/cryptopunksnotdead/cryptopunks/tree/master/cryptopunks-gui
 
-![CryptoPunks GUI Screenshot](https://raw.githubusercontent.com/cryptopunksnotdead/cryptopunks-gui/master/screenshots/cryptopunks-gui-screenshot.png)
+![CryptoPunks GUI Screenshot](https://raw.githubusercontent.com/cryptopunksnotdead/cryptopunks/master/cryptopunks-gui/screenshots/cryptopunks-gui-screenshot.png)
 
 ### Circule
 

data/VERSION

@@ -1 +1 @@
-0.0.58
+0.0.61

data/lib/glimmer/tk/entry_proxy.rb

@@ -31,13 +31,24 @@ module Glimmer
       include TextVariableOwner
     
       def validatecommand_block=(proc)
+        self.validate = 'key' unless validate
         tk.validatecommand(proc)
       end
       
       def invalidcommand_block=(proc)
+        self.validate = 'key' unless validate
         tk.invalidcommand(proc)
       end
       
+      def validate
+        @validate
+      end
+      
+      def validate=(value)
+        @validate = value
+        @tk.validate(value)
+      end
+      
       def handle_listener(listener_name, &listener)
         case listener_name.to_s.downcase
         when 'change', 'changed', 'modified'

data/lib/glimmer/tk/widget_proxy.rb

@@ -73,6 +73,7 @@ module Glimmer
       prepend DraggableAndDroppable
       
       FONTS_PREDEFINED = %w[default text fixed menu heading caption small_caption icon tooltip]
+      HEXADECIMAL_CHARACTERS = %w[0 1 2 3 4 5 6 7 8 9 a b c d e f]
       
       attr_reader :parent_proxy, :tk, :args, :keyword, :children, :bind_ids, :destroyed
       alias destroyed? destroyed
@@ -192,6 +193,7 @@ module Glimmer
 
       def set_attribute(attribute, *args)
         begin
+          args = normalize_attribute_arguments(attribute, args)
           widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
           if respond_to?(attribute_setter(attribute), super_only: true)
             send(attribute_setter(attribute), *args)
@@ -308,6 +310,34 @@ module Glimmer
         @tk.style = style
       end
       
+      def normalize_attribute_arguments(attribute, args)
+        attribute_argument_normalizers[attribute]&.call(args) || args
+      end
+      
+      def attribute_argument_normalizers
+        color_normalizer = lambda do |args|
+          if args.size > 1 || args.first.is_a?(Numeric)
+            rgb = args
+            rgb = rgb.map(&:to_s).map(&:to_i)
+            rgb = 3.times.map { |n| rgb[n] || 0}
+            hex = rgb.map { |color| color.to_s(16).ljust(2, '0') }.join
+            ["##{hex}"]
+          elsif args.size == 1 &&
+                args.first.is_a?(String) &&
+                !args.first.start_with?('#') &&
+                (args.first.size == 3 || args.first.size == 6)  &&
+                (args.first.chars.all? {|char| HEXADECIMAL_CHARACTERS.include?(char.downcase)})
+            ["##{args.first}"]
+          else
+            args
+          end
+        end
+        @attribute_argument_normalizers ||= {
+          'background' => color_normalizer,
+          'foreground' => color_normalizer,
+        }
+      end
+      
       def widget_custom_attribute_mapping
         # TODO consider extracting to modules/subclasses
         @widget_custom_attribute_mapping ||= {
@@ -534,10 +564,12 @@ module Glimmer
 
       def method_missing(method, *args, &block)
         method = method.to_s
+        attribute_name = method.sub(/=$/, '')
+        args = normalize_attribute_arguments(attribute_name, args)
         if args.empty? && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method]) || has_state?(method) || has_attributes_attribute?(method))
           get_attribute(method)
         elsif method.end_with?('=') && block.nil? && ((widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][method.sub(/=$/, '')]) || has_state?(method) || has_attributes_attribute?(method))
-          set_attribute(method.sub(/=$/, ''), *args)
+          set_attribute(attribute_name, *args)
         else
           tk.send(method, *args, &block)
         end

data/samples/hello/hello_built_in_dialog.rb

@@ -31,21 +31,47 @@ root { |w|
   y 150
   
   frame {
-    %w[get_open_file get_multiple_open_file get_save_file choose_directory choose_color].each do |dialog|
+    %w[get_open_file get_multiple_open_file get_save_file choose_directory].each do |dialog|
+      dialog_name = dialog.split('_').map(&:capitalize).join(' ')
       button {
-        text dialog.split('_').map(&:capitalize).join(' ')
+        text dialog_name
         
         on('command') do
-          result = send(dialog, parent: w)
+          # parent is optional.
+          # It is recommended to set parent to display dialog on top of.
+          #
+          # title is optional (defaults to blank).
+          # It is not supported by choose_directory (its title is always blank).
+          result = send(dialog, parent: w, title: dialog_name)
+          # Uniformly handle both a singular result (e.g. from get_open_file)
+          # and an array of results (e.g. from get_multiple_open_file)
           @result_label.text = [result].flatten.join("\n")
         end
       }
     end
     
+    button {
+      text 'Choose Color'
+      
+      on('command') do
+        # parent is optional.
+        # It is recommended to set parent to display dialog on top of.
+        #
+        # title is optional (defaults to 'Colors').
+        #
+        # initialcolor is optional (defaults to 'white').
+        # It can be a built-in color (e.g. 'AliceBlue') or hex (e.g. '#FFFF00')
+        # Full list of built-in colors is at: https://tcl.tk/man/tcl8.6/TkCmd/colors.htm
+        chosen_color = choose_color(parent: w, title: 'Choose Color', initialcolor: '#FFFF00')
+        @result_label.text = chosen_color
+      end
+    }
+    
     button {
       text 'Choose Font'
       
       on('command') do
+        # Initial family, size, and weight are optional.
         choose_font(family: 'Courier New', size: '30', weight: 'bold') do |chosen_font|
           @result_label.text = chosen_font
         end

data/samples/hello/hello_entry.rb

@@ -64,8 +64,11 @@ class HelloEntry
       entry { |the_entry|
         grid sticky: 'ew'
         text <=> [self, :telephone]
-        validate 'key'
 
+        # validate 'key' # default when on('validate') or on('invalid') is specified
+        ## Validation happens on key change by default when validation listeners are specified
+        ## (other accepted values: 'none', 'focus', 'focusin', 'focusout', 'key', or 'all')
+        
         ## this event kicks in just after the user typed and before modifying the text variable
         on('validate') do |new_text_variable|
           telephone?(new_text_variable.value)

data/samples/hello/hello_label.rb

@@ -80,8 +80,13 @@ class HelloLabel
             anchor 'center'
             justify 'center' # other options are: 'left' and 'right'
             font 'caption' # other options are: 'default', 'text', 'fixed', 'menu', 'heading', 'small_caption', 'icon', 'tooltip'
-            foreground 'blue'
             relief 'sunken' # other options are: 'flat' (default), 'raised', 'solid', 'ridge', 'groove'
+            foreground 38, 20, 138 # RGB (Red Green Blue) color
+            
+            # Other supported color arguments:
+            # foreground 'blue' # built-in color alternative from https://tcl.tk/man/tcl8.6/TkCmd/colors.htm
+            # foreground '#ff0000' # hex color
+            # foreground 'ff0000' # hex color missing the # prefix
           }
         }
         

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.58
+  version: 0.0.61
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-07 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -170,8 +170,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
-description: Glimmer DSL for Tk (MRI Ruby Desktop Development GUI Library) - Ruby
-  DSL for Tcl/Tk with bidirectional/unidirectional data-binding support.
+description: Glimmer DSL for Tk (Ruby Tk Desktop Development GUI Library) - Ruby DSL
+  for Tcl/Tk with bidirectional/unidirectional data-binding support.
 email: andy.am@gmail.com
 executables:
 - girb