glimmer-dsl-tk 0.0.59 → 0.0.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26c20e8d681d57d11f540136ad94fd26a4f7ab51a5663eba95599dd5fa1589fe
-  data.tar.gz: 6f70dd20a48487e0c73135790b24e38f8080fa376cda20f1da2c8db83cb78d4c
+  metadata.gz: b6a4152765e0997cd3d29beec05f16be105a09ae868e49335fb09e81d552e576
+  data.tar.gz: 31c3f1d4ee33b5ab9dec7ccd76d11a6c50cde145cf3a5517401859b0ae16a45a
 SHA512:
-  metadata.gz: 97fc2a77f286aec0cef3f0733aa1642415a0cf5ae420ea7713344b4b9f0de676d96fbb40b6cdba8d5a3338f8340a6b94ef3e6497043b86cd154258d66e320616
-  data.tar.gz: d48746949f04d68643d6493cab85c04bc7951da0fcbced1c7f13ab9a968d3bab6e452b8c804b2b012ab6b662c8092e87c0bea4386a214b2ccd494a94e46b6299
+  metadata.gz: 7f4820bb0d35553b16fc9b37bfca7d2abdc463cbd2e958f462b5be5c53e79e7ae3abc918fa2bbc6775d642432b127fa3d26ff72d96195287fecd287e13a50a23
+  data.tar.gz: 6f5b093cd7f834e6d8126142d5f63e66dde7c164b463eee577cd8b177d27784335d3f2df88555ce103c68a29eaed72ab1ec1e608018e8b76655c9704e77c0826

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 0.0.62
+
+- `icon_photo` as alias for `iconphoto` attribute on `root` and `toplevel`
+- `initial_color` as alias for `initialcolor` attribute on `choose_color` built-in dialog
+
+## 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') {}`

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.59
+# [<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.62
 ## 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.59'
+gem 'glimmer-dsl-tk', '0.0.62'
 ```
 
 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, initial_color: '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
@@ -328,11 +328,11 @@ keyword(args) | attributes | event bindings & callbacks
 `menu_item(style = :command, label: , underline: )` (style also can be `:radiobutton`, `:checkbutton`, `:separator`, `:about`, `:preferences`, `:quit`, `:help`) | `state`, `accelerator`, `selection` & `variable` (if `:radiobutton` or `:checkbutton`), `image`, `compound` | `command`
 `notebook` | None | None
 `radiobutton` | `text`, `variable` (Boolean), `image` (optional keyword args: `subsample`, `zoom`, `from`, `to`, `shrink`, `compositingrule`), `compound` (`'center', 'top', 'bottom', 'left', 'right'`), `value` (default: `text`) | `command {}`
-`root` | `title`, `iconphoto`, `background`, `alpha`, `escapable`, `fullscreen?`, `topmost?`, `transparent?`, `stackorder`, `winfo_screendepth`, `winfo_screenvisual`, `winfo_screenwidth`, `winfo_screenheight`, `winfo_pixels('li')`, `winfo_screen`, `wm_maxsize`, `state` (`'normal', 'iconic', 'withdrawn', 'icon', 'zoomed'`) | `'DELETE_WINDOW'`, `'OPEN_WINDOW'`
+`root` | `title`, `icon_photo`, `background`, `alpha`, `escapable`, `fullscreen?`, `topmost?`, `transparent?`, `stackorder`, `winfo_screendepth`, `winfo_screenvisual`, `winfo_screenwidth`, `winfo_screenheight`, `winfo_pixels('li')`, `winfo_screen`, `wm_maxsize`, `state` (`'normal', 'iconic', 'withdrawn', 'icon', 'zoomed'`) | `'DELETE_WINDOW'`, `'OPEN_WINDOW'`
 `scrollbar` | `orient` | `command`
 `scrollbar_frame` | `xscrollbar` (Boolean or scrollbar widget proxy), `yscrollbar` (Boolean or scrollbar widget proxy) | None
 `separator` | `orient` (`'horizontal' (default) or 'vertical'`) | None
-`toplevel` | `title`, `iconphoto`, `background`, `alpha`, `escapable`, `fullscreen?`, `topmost?`, `transparent?`, `stackorder`, `winfo_screendepth`, `winfo_screenvisual`, `winfo_screenwidth`, `winfo_screenheight`, `winfo_pixels('li')`, `winfo_screen`, `wm_maxsize`, `state` (`'normal', 'iconic', 'withdrawn', 'icon', 'zoomed'`) | `'DELETE_WINDOW'`
+`toplevel` | `title`, `icon_photo`, `background`, `alpha`, `escapable`, `fullscreen?`, `topmost?`, `transparent?`, `stackorder`, `winfo_screendepth`, `winfo_screenvisual`, `winfo_screenwidth`, `winfo_screenheight`, `winfo_pixels('li')`, `winfo_screen`, `wm_maxsize`, `state` (`'normal', 'iconic', 'withdrawn', 'icon', 'zoomed'`) | `'DELETE_WINDOW'`
 `text` | `value`, [many more attributes](https://tcl.tk/man/tcl8.6/TkCmd/text.htm#M116) | `'modified'`, `'selection'`, `'insert_mark_moved'` (alias: `'insert_mark_move', 'InsertMarkMove', 'InsertMarkMoved'`)
 `x_scrollbar` | `orient` (`'horizontal'`) | `command`
 `y_scrollbar` | `orient` (`'vertical'`) | `command`
@@ -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
 
@@ -553,7 +555,7 @@ When nesting `frame` under `notebook`, you can pass a `:text` keyword argument t
 
 #### Icon Photo
 
-The `iconphoto` attribute on `root` is set to the Glimmer icon by default if no icon photo is supplied.
+The `icon_photo` attribute (alias for `iconphoto`) on `root` is set to the Glimmer icon by default if no icon photo is supplied.
 
 Otherwise, [Glimmer DSL for Tk](https://rubygems.org/gems/glimmer-dsl-tk) is smart enough to accept an image path directly (no need to wrap with `TkPhotoImage`)
 
@@ -562,7 +564,7 @@ Example with direct image path (you may copy/paste in [`girb`](#girb-glimmer-irb
 ```ruby
 root {
   title 'Title'
-  iconphoto 'icons/glimmer.png'
+  icon_photo 'icons/glimmer.png'
 }.open
 ```
 
@@ -571,7 +573,7 @@ Example with `TkPhotoImage` object (you may copy/paste in [`girb`](#girb-glimmer
 ```ruby
 root {
   title 'Title'
-  iconphoto TkPhotoImage.new(file: 'icons/glimmer.png')
+  icon_photo TkPhotoImage.new(file: 'icons/glimmer.png')
 }.open
 ```
 
@@ -1533,7 +1535,7 @@ include Glimmer
 
 root { |r|
   title 'Hello, Root!'
-  iconphoto File.expand_path('../../icons/glimmer.png', __dir__)
+  icon_photo File.expand_path('../../icons/glimmer.png', __dir__)
   width 400
   height 200
   x -150

data/VERSION

@@ -1 +1 @@
-0.0.59
+0.0.62

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

@@ -38,6 +38,7 @@ module Glimmer
         def interpret(parent, keyword, *args, &block)
           if args.first.is_a?(Hash)
             options = args.first.symbolize_keys
+            options[:initialcolor] = options.delete(:initial_color) if options.keys.include?(:initial_color)
             options[:filetypes] = options.delete(:file_types) if options.keys.include?(:file_types)
             options[:filetypes] = options[:filetypes].map { |key, value| "{#{key}} {#{value}}" } if options[:filetypes].is_a?(Hash)
             options[:parent] = options[:parent].tk if options[:parent].is_a?(Glimmer::Tk::RootProxy)

data/lib/glimmer/tk/toplevel_proxy.rb

@@ -48,14 +48,14 @@ module Glimmer
       end
       
       def has_attribute?(attribute, *args)
-        %w[width height x y].include?(attribute.to_s) || super
+        %w[width height x y icon_photo].include?(attribute.to_s) || super
       end
       
       def set_attribute(attribute, *args)
         case attribute.to_s
-        when 'iconphoto'
+        when 'iconphoto', 'icon_photo'
           args[0..-1] = [image_argument(args)]
-          super
+          super('iconphoto', *args)
         when 'resizable'
           if args.size == 1 && !args.first.is_a?(Array)
             self.resizable = [args.first]*2
@@ -67,6 +67,19 @@ module Glimmer
         end
       end
       
+      def get_attribute(attribute)
+        case attribute.to_s
+        when 'icon_photo'
+          super('iconphoto')
+        else
+          super
+        end
+      end
+      
+      def icon_photo
+        iconphoto
+      end
+      
       def width
         geometry.split(REGEX_GEOMETRY)[0].to_i
       end

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 ||= {
@@ -380,6 +410,10 @@ module Glimmer
               getter: {name: 'text', invoker: lambda { |widget, args| @tk.title }},
               setter: {name: 'text=', invoker: lambda { |widget, args| @tk.title = args.first }},
             },
+            'icon_photo' => {
+              getter: {name: 'icon_photo', invoker: lambda { |widget, args| @tk.iconphoto }},
+              setter: {name: 'icon_photo=', invoker: lambda { |widget, args| @tk.iconphoto = image_argument(args) }},
+            },
           },
         }
       end
@@ -534,10 +568,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', initial_color: '#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_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
           }
         }
         

data/samples/hello/hello_root.rb

@@ -25,7 +25,7 @@ include Glimmer
 
 root { |r|
   title 'Hello, Root!'
-  iconphoto File.expand_path('../../icons/glimmer.png', __dir__)
+  icon_photo File.expand_path('../../icons/glimmer.png', __dir__)
   width 400
   height 200
   x -150

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.59
+  version: 0.0.62
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-07-30 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