glimmer-dsl-tk 0.0.57 → 0.0.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0e1ed1843f904d42892c7fe2546383717da65d7cfd0690b1b66101a5b68576
-  data.tar.gz: af96af00f8b06606ac584ab14d5d8d360977a58ec354053a0826edc470c0d57f
+  metadata.gz: 9c0553115fdb0b7a912c59f6feda8b475e76c546fc2db32984037e7bbc8db204
+  data.tar.gz: 450c7795ef8adafe88db9fbfdf78691933f79b06f1f4b1e899f5ddacac3da567
 SHA512:
-  metadata.gz: '01787afce29bc0b1d4656b8ab646f0eb4501a8b8feb23979ad99970f6e5d6bb75d5945bb0b9a9a91cdb34f36d6bdf9226ec3e3aa60368206cd98b40daa2cd0a1'
-  data.tar.gz: 677f8d13ab20b7857c613167d1d21eed0dec3f1b19a8b29ba4b4cec49545186446c2c9bacbaf9e0741c16ceb2d20e60136c482dc6e78783d8b1d435ed4239be8
+  metadata.gz: 256d0e2d25fd50791b979cf92ba9dad8dedf77941e6e6394f1474f41f20a035bb601f6cc2af3b2bab8ed0b3acf11825d041a3d65d5d8941da85e6fc563c7c23b
+  data.tar.gz: b122dd08e9a6b2ec400ecf49c15d0be69fcc3c4e4fbe4de9c427dc0b1a085cae6ab8c95deca79272f28ecb21479477a6792ae434544c64013ebfe8cc4b8b49de

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 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') {}`)
+- Use `on_textvariable` in `samples/hello/hello_entry.rb`
+- Improve validation text in `samples/hello/hello_entry.rb` to say "... not a valid phone!"
+
 ## 0.0.57
 
 - Hello, Theme! sample

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.57
+# [<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.60
 ## 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.57'
+gem 'glimmer-dsl-tk', '0.0.60'
 ```
 
 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'`) or Hex color (e.g. `'#ffd807'`)
+- `background`: [Built-in Color](https://tcl.tk/man/tcl8.6/TkCmd/colors.htm) (e.g. `'AliceBlue'`) or Hex color (e.g. `'#ffd807'`)
 
 #### 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.57
+0.0.60

data/lib/glimmer/dsl/tk/dsl.rb

@@ -37,6 +37,7 @@ module Glimmer
         Tk,
         %w[
           list_selection_data_binding
+          variable_listener
           data_binding
           attribute
           shine_data_binding

data/lib/glimmer/dsl/tk/variable_listener_expression.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2020-2022 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/dsl/expression'
+require 'glimmer/tk/widget_proxy'
+
+module Glimmer
+  module DSL
+    module Tk
+      class VariableListenerExpression < Expression
+        def can_interpret?(parent, keyword, *args, &block)
+          parent.is_a?(Glimmer::Tk::WidgetProxy) && keyword.match(/^on_.*/) && textual?(args.first)
+        end
+  
+        def interpret(parent, keyword, *args, &block)
+          variable_name = keyword.sub(/^on_/, '')
+          operation = args.first.to_s
+          parent.tk.send(variable_name).trace(operation, &block)
+        end
+      end
+    end
+  end
+end

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

@@ -192,6 +192,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 +309,30 @@ 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}"]
+          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 +559,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

@@ -36,12 +36,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]
       }
@@ -60,11 +61,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)
@@ -72,7 +76,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.value} is not valid!"
+          @validated_entry_label.text = "#{validate_args.value} is not a valid phone!"
           @validated_entry_label.foreground = 'red'
         end
 
@@ -82,6 +86,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 {

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.57
+  version: 0.0.60
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-06-24 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
@@ -205,6 +205,7 @@ files:
 - lib/glimmer/dsl/tk/on_expression.rb
 - lib/glimmer/dsl/tk/root_expression.rb
 - lib/glimmer/dsl/tk/shine_data_binding_expression.rb
+- lib/glimmer/dsl/tk/variable_listener_expression.rb
 - lib/glimmer/dsl/tk/widget_expression.rb
 - lib/glimmer/tk/checkbutton_proxy.rb
 - lib/glimmer/tk/combobox_proxy.rb