glimmer-dsl-tk 0.0.4 → 0.0.8

data/lib/glimmer/tk/list_proxy.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2020 Andy Maleh
-# 
+# Copyright (c) 2020-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -22,7 +22,7 @@
 require 'glimmer/tk/widget_proxy'
 
 module Glimmer
-  module Tk    
+  module Tk
     # Custom list widget implementation
     class ListProxy < WidgetProxy
       def initialize(underscored_widget_name, parent_proxy, args)
@@ -35,16 +35,16 @@ module Glimmer
           ::Tk::Tile::Treeview => {
             'items' => {
               getter: {name: 'items', invoker: lambda { |widget, args| tk.children('').map(&:text) }},
-              setter: {name: 'items=', invoker: lambda { |widget, args| 
+              setter: {name: 'items=', invoker: lambda { |widget, args|
                 @tk.delete @tk.children('')
                 args.first.each do |child|
                   @tk.insert('', 'end', :text => child)
-                end          
+                end
               }},
             },
             'selection' => {
               getter: {name: 'selection', invoker: lambda { |widget, args| @tk.selection.map(&:text) }},
-              setter: {name: 'selection=', invoker: lambda { |widget, args| 
+              setter: {name: 'selection=', invoker: lambda { |widget, args|
                 selection_args = args.first.is_a?(Array) ? args.first : [args.first]
                 selection_items = selection_args.map do |arg|
                   @tk.children('').detect {|item| item.text == arg}

data/lib/glimmer/tk/notebook_proxy.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2020 Andy Maleh
-# 
+# Copyright (c) 2020-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -22,7 +22,7 @@
 require 'glimmer/tk/widget_proxy'
 
 module Glimmer
-  module Tk    
+  module Tk
     # Proxy for Tk::Tile::Notebook
     #
     # Follows the Proxy Design Pattern

data/lib/glimmer/tk/root_proxy.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2020 Andy Maleh
-# 
+# Copyright (c) 2020-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -27,11 +27,14 @@ module Glimmer
     #
     # Follows the Proxy Design Pattern
     class RootProxy < WidgetProxy
-
       def initialize(*args)
         @tk = ::TkRoot.new
       end
 
+      def post_add_content
+        set_attribute('iconphoto', File.expand_path('../../../icons/glimmer.png', __dir__)) if @tk.iconphoto.nil?
+      end
+      
       def open
         start_event_loop
       end
@@ -39,6 +42,17 @@ module Glimmer
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::RootExpression.new, &block)
       end
+      
+      def set_attribute(attribute, *args)
+        if attribute.to_s == 'iconphoto'
+          if args.size == 1 && args.first.is_a?(String)
+            args[0] = ::TkPhotoImage.new(file: args.first)
+          end
+          super
+        else
+          super
+        end
+      end
 
       # Starts Tk mainloop
       def start_event_loop

data/lib/glimmer/tk/widget_proxy.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2020 Andy Maleh
-# 
+# Copyright (c) 2020-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -29,7 +29,13 @@ module Glimmer
 
       DEFAULT_INITIALIZERS = {
         'combobox' => lambda do |tk|
-          tk.textvariable = ::TkVariable.new          
+          tk.textvariable = ::TkVariable.new
+        end,
+        'label' => lambda do |tk|
+          tk.textvariable = ::TkVariable.new
+        end,
+        'entry' => lambda do |tk|
+          tk.textvariable = ::TkVariable.new
         end,
       }
       
@@ -44,17 +50,17 @@ module Glimmer
             Glimmer::Tk.const_get(class_name)
           rescue
             Glimmer::Tk::WidgetProxy
-          end        
+          end
         end
         
         # This supports widgets in and out of basic Tk
         def tk_widget_class_for(underscored_widget_name)
           tk_widget_class_basename = underscored_widget_name.camelcase(:upper)
           potential_tk_widget_class_names = [
-            "::Tk::Tile::#{tk_widget_class_basename}", 
-            "::Tk::#{tk_widget_class_basename}", 
-            "::Tk#{tk_widget_class_basename}", 
-            "::Glimmer::Tk::#{tk_widget_class_basename}Proxy", 
+            "::Tk::Tile::#{tk_widget_class_basename}",
+            "::Tk::#{tk_widget_class_basename}",
+            "::Tk#{tk_widget_class_basename}",
+            "::Glimmer::Tk::#{tk_widget_class_basename}Proxy",
           ]
           tk_widget_class = nil
           potential_tk_widget_class_names.each do |tk_widget_name|
@@ -63,11 +69,11 @@ module Glimmer
               break
             rescue RuntimeError, SyntaxError, NameError => e
               Glimmer::Config.logger.debug e.full_message
-            end            
+            end
           end
           tk_widget_class
         end
-      end      
+      end
       
       # Initializes a new Tk Widget
       #
@@ -79,7 +85,7 @@ module Glimmer
         @tk = tk_widget_class.new(@parent_proxy.tk, *args)
         # a common widget initializer
         @tk.grid
-        DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@tk)        
+        DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@tk)
         @parent_proxy.post_initialize_child(self)
       end
       
@@ -97,21 +103,26 @@ module Glimmer
         !!tk_widget_class_for(underscored_widget_name)
       end
 
-      def tk_widget_has_attribute?(attribute)
+      def tk_widget_has_attribute_setter?(attribute)
         result = nil
-        begin     
-          # TK Widget currently doesn't support respond_to? properly, so I have to resort to this trick for now   
+        begin
+          # TK Widget currently doesn't support respond_to? properly, so I have to resort to this trick for now
           @tk.send(attribute_setter(attribute), @tk.send(attribute))
           result = true
         rescue => e
           result = false
         end
-        result      
+        result
+      end
+      
+      def tk_widget_has_attribute_getter_setter?(attribute)
+        @tk.respond_to?(attribute)
       end
       
       def has_attribute?(attribute, *args)
-        (widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]) || 
-          tk_widget_has_attribute?(attribute) || 
+        (widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]) ||
+          tk_widget_has_attribute_setter?(attribute) ||
+          tk_widget_has_attribute_getter_setter?(attribute) ||
           respond_to?(attribute_setter(attribute), args)
       end
 
@@ -119,8 +130,10 @@ module Glimmer
         widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
         if widget_custom_attribute
           widget_custom_attribute[:setter][:invoker].call(@tk, args)
-        elsif tk_widget_has_attribute?(attribute)
+        elsif tk_widget_has_attribute_setter?(attribute)
           @tk.send(attribute_setter(attribute), *args) unless @tk.send(attribute) == args.first
+        elsif tk_widget_has_attribute_getter_setter?(attribute)
+          @tk.send(attribute, *args) unless @tk.send(attribute) == args.first
         else
           send(attribute_setter(attribute), args)
         end
@@ -130,7 +143,7 @@ module Glimmer
         widget_custom_attribute = widget_custom_attribute_mapping[tk.class] && widget_custom_attribute_mapping[tk.class][attribute.to_s]
         if widget_custom_attribute
           widget_custom_attribute[:getter][:invoker].call(@tk, args)
-        elsif tk_widget_has_attribute?(attribute)
+        elsif tk_widget_has_attribute_getter_setter?(attribute)
           @tk.send(attribute)
         else
           send(attribute)
@@ -149,6 +162,18 @@ module Glimmer
               setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
             },
           },
+          ::Tk::Tile::TLabel => {
+            'text' => {
+              getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
+              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first }},
+            },
+          },
+          ::Tk::Tile::TEntry => {
+            'text' => {
+              getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
+              setter: {name: 'text=', invoker: lambda { |widget, args| @tk.textvariable&.value = args.first unless @text_variable_edit }},
+            },
+          },
         }
       end
       
@@ -166,6 +191,21 @@ module Glimmer
               }
             end,
           },
+          ::Tk::Tile::TEntry => {
+            'text' => lambda do |observer|
+              tk.validate = 'key'
+              tk.validatecommand { |new_tk_variable|
+                @text_variable_edit = new_tk_variable.value != @tk.textvariable.value
+                if @text_variable_edit
+                  observer.call(new_tk_variable.value)
+                  @text_variable_edit = nil
+                  true
+                else
+                  false
+                end
+              }
+            end,
+          },
         }
       end
       
@@ -173,7 +213,7 @@ module Glimmer
         attribute_listener_installers = @tk.class.ancestors.map {|ancestor| widget_attribute_listener_installers[ancestor]}.compact
         widget_listener_installers = attribute_listener_installers.map{|installer| installer[attribute.to_s]}.compact if !attribute_listener_installers.empty?
         widget_listener_installers.to_a.first&.call(observer)
-      end      
+      end
 
       def content(&block)
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Tk::WidgetExpression.new, &block)
@@ -194,7 +234,7 @@ module Glimmer
       end
       
       def respond_to?(method, *args, &block)
-        super || 
+        super ||
           tk.respond_to?(method, *args, &block)
       end
     end

data/lib/glimmer-dsl-tk.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2020 Andy Maleh
-# 
+# Copyright (c) 2020-2021 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
@@ -7,10 +7,10 @@
 # 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

data/samples/hello/hello_combo.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2020 Andy Maleh
-# 
+# Copyright (c) 2020-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -21,10 +21,10 @@
 
 require 'glimmer-dsl-tk'
 
-class Person 
+class Person
   attr_accessor :country, :country_options
 
-  def initialize   
+  def initialize
     self.country_options=["", "Canada", "US", "Mexico"]
     self.country = "Canada"
   end
@@ -43,12 +43,12 @@ class HelloCombo
     root {
       title 'Hello, Combo!'
       
-      combobox { |proxy|
-        state 'readonly'       
+      combobox {
+        state 'readonly'
         text bind(person, :country)
       }
       
-      button { |proxy|
+      button {
         text "Reset Selection"
         command {
           person.reset_country

data/samples/hello/hello_computed/contact.rb

@@ -0,0 +1,21 @@
+class HelloComputed
+  class Contact
+    attr_accessor :first_name, :last_name, :year_of_birth
+  
+    def initialize(attribute_map)
+      @first_name = attribute_map[:first_name]
+      @last_name = attribute_map[:last_name]
+      @year_of_birth = attribute_map[:year_of_birth]
+    end
+  
+    def name
+      "#{last_name}, #{first_name}"
+    end
+    
+    def age
+      Time.now.year - year_of_birth.to_i
+    rescue
+      0
+    end
+  end
+end

data/samples/hello/hello_computed.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2020-2021 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-tk'
+
+require_relative 'hello_computed/contact'
+
+class HelloComputed
+  include Glimmer
+
+  def initialize
+    @contact = Contact.new(
+      first_name: 'Barry',
+      last_name: 'McKibbin',
+      year_of_birth: 1985
+    )
+  end
+
+  def launch
+    root {
+      title 'Hello, Computed!'
+      
+      frame {
+        grid column: 0, row: 0, padx: 5, pady: 5
+        
+        label {
+          grid column: 0, row: 0, sticky: 'w'
+          text 'First Name: '
+        }
+        entry {
+          grid column: 1, row: 0
+          width 15
+          text bind(@contact, :first_name)
+        }
+        
+        label {
+          grid column: 0, row: 1, sticky: 'w'
+          text 'Last Name: '
+        }
+        entry {
+          grid column: 1, row: 1
+          width 15
+          text bind(@contact, :last_name)
+        }
+        
+        label {
+          grid column: 0, row: 2, sticky: 'w'
+          text 'Year of Birth: '
+        }
+        entry {
+          grid column: 1, row: 2
+          width 15
+          text bind(@contact, :year_of_birth)
+        }
+        
+        label {
+          grid column: 0, row: 3, sticky: 'w'
+          text 'Name: '
+        }
+        label {
+          grid column: 1, row: 3, sticky: 'w'
+          text bind(@contact, :name, computed_by: [:first_name, :last_name])
+        }
+        
+        label {
+          grid column: 0, row: 4, sticky: 'w'
+          text 'Age: '
+        }
+        label {
+          grid column: 1, row: 4, sticky: 'w'
+          text bind(@contact, :age, on_write: :to_i, computed_by: [:year_of_birth])
+        }
+      }
+    }.open
+  end
+end
+
+HelloComputed.new.launch