glimmer-dsl-tk 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 631bc5fe4586f68987c644c71f33768414c8088601dfbe1cc641d0fc13656729
-  data.tar.gz: abe0f504f6b7fd897af3964e24041331bba475a966c9e75fc22554b86b31cbef
+  metadata.gz: 8b2c3772ea3eeec35d08dfaebbe1db0a25d85b9569e7c88461a0886447c73928
+  data.tar.gz: 6b27a8f3a122a570732d64ca541703cb33fe21009d4e04f1d51cbf3ebdc96df8
 SHA512:
-  metadata.gz: c9d211b7f70cbf38c2ad231343a1d5b73c14767d89468a1e99bf418209c03db079edf5ea116ef78c211f4e35795607ea7a9911acf48bffc3913ed53a0adcbc7a
-  data.tar.gz: b7a66a93ad9d478a215c0c3d6348c9e934ce6dc34b04716d8f2d61a908dd62dd2fa4a4bc42fd4804bd53e0a6c5e4413dc2ea6495b3d2c87417e46d435cb82da9
+  metadata.gz: c470bb4fdc925295f92b6f743126edc5c2fef5480dc7913c66124a4489c6d093f163a70ba4410894043a51f715af2fb09aea5eff85f06031ba012467197b7dc0
+  data.tar.gz: 50ff417aab865e7dbdf0d5208d211cb19a5bd6fc4c1c193a695394e42b6f9715f2e1bbe7ada5985ad123ad3bbc75d879330b535afc7454d00522a27b33137322

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.0.5
+
+- Label text data-binding
+- Entry text data-binding
+- The `grid` geometry manager
+- Hello, Computed! sample
+
 ## 0.0.4
 
 - `list` custom widget (since listbox is not tile themed yet in Tk)

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.4 (Desktop GUI)
+# [<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.5 (Desktop GUI)
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-tk.svg)](http://badge.fury.io/rb/glimmer-dsl-tk)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-dsl-tk.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-dsl-tk)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer-dsl-tk/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer-dsl-tk?branch=master)
@@ -77,7 +77,7 @@ gem install glimmer-dsl-tk
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-tk', '~> 0.0.4'
+gem 'glimmer-dsl-tk', '~> 0.0.5'
 ```
 
 And, then run:
@@ -163,6 +163,26 @@ root {
 }.open
 ```
 
+## The Grid Geometry Manager
+
+The Grid Geometry Manager is supported via the `grid` keyword just as per the [Tk documentation](https://tkdocs.com/tutorial/grid.html), except by nesting under the widget it concerns.
+
+Example:
+
+```ruby
+        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)
+        }
+```
+
+More details can be found in the [Hello, Computed!](#hello-computed) sample below.
+
 ## Bidirectional Data-Binding
 
 Glimmer supports bidirectional data-binding via the `bind` keyword, which takes a model and an attribute.
@@ -180,8 +200,8 @@ This assumes a `Person` model with a `country` attribute representing their curr
   }
 ```
 
-It binds the `values` of the `combobox` to the `country_options` property on the `person` model (data-binding attribute + "_options" by convention).
-That binds the `text` selection of the `combobox` to the `country` property on the `person` model.
+That code sets the `values` of the `combobox` to the `country_options` property on the `person` model (data-binding attribute + "_options" by convention).
+It also binds the `text` selection of the `combobox` to the `country` property on the `person` model.
 
 It automatically handles all the Tk plumbing behind the scenes, such as using `TkVariable` and setting `combobox` `values` from `person.country_options` by convention (attribute_name + "_options").
 
@@ -202,7 +222,7 @@ This assumes a `Person` model with a `country` attribute representing their curr
   }
 ```
 
-It binds the `items` text of the `list` to the `country_options` property on the `person` model (data-binding attribute + "_options" by convention).
+That code binds the `items` text of the `list` to the `country_options` property on the `person` model (data-binding attribute + "_options" by convention).
 It also binds the `selection` text of the `list` to the `country` property on the `person` model.
 
 It automatically handles all the Tk plumbing behind the scenes.
@@ -223,13 +243,49 @@ This assumes a `Person` model with a `provinces` attribute representing their cu
   }
 ```
 
-It binds the `items` text of the `list` to the `provinces_options` property on the `person` model (data-binding attribute + "_options" by convention)
+That code binds the `items` text of the `list` to the `provinces_options` property on the `person` model (data-binding attribute + "_options" by convention)
 That binds the `selection` text of the `list` to the `provinces` property on the `person` model.
 
 It automatically handles all the Tk plumbing behind the scenes.
 
 More details can be found in the [Hello, List Multi Selection!](#hello-list-multi-selection) sample below.
 
+### Label Data-Binding
+
+Example:
+
+This assumes a `Person` model with a `country` attribute.
+
+```ruby
+  label {
+    text bind(person, :country)
+  }
+```
+
+That code binds the `textvariable` value of the `label` to the `country` property on the `person` model.
+
+It automatically handles all the Tk plumbing behind the scenes.
+
+More details can be found in the [Hello, Computed!](#hello-computed) sample below.
+
+### Entry Data-Binding
+
+Example:
+
+This assumes a `Person` model with a `country` attribute.
+
+```ruby
+  entry {
+    text bind(person, :country)
+  }
+```
+
+That code binds the `textvariable` value of the `entry` to the `country` property on the `person` model.
+
+It automatically handles all the Tk plumbing behind the scenes.
+
+More details can be found in the [Hello, Computed!](#hello-computed) sample below.
+
 ## Command Observer
 
 Buttons can set a `command` option to trigger when the user clicks the button. This may be done with the `command` keyword, passing in a block directly (no need for `proc` as per Tk)
@@ -408,9 +464,79 @@ Run (with the [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem ins
 ruby -r glimmer-dsl-tk -e "require '../samples/hello/hello_list_multi_selection.rb'"
 ```
 
+### Hello, Computed!
+
+Glimmer code (from [samples/hello/hello_computed.rb](samples/hello/hello_computed.rb)):
+
+```ruby
+# ... more code precedes
+    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
+# ... more code follows
+```
+
+Run (with the [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed):
+
+```
+ruby -r glimmer-dsl-tk -e "require '../samples/hello/hello_computed.rb'"
+```
+
 Glimmer app:
 
-![glimmer dsl tk screenshot sample hello list multi selection](images/glimmer-dsl-tk-screenshot-sample-hello-list-multi-selection.png)
+![glimmer dsl tk screenshot sample hello computed](images/glimmer-dsl-tk-screenshot-sample-hello-computed.png)
 
 ## Help
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

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

@@ -55,4 +55,6 @@ require 'glimmer/tk/widget_proxy'
 require 'glimmer/tk/notebook_proxy'
 require 'glimmer/tk/frame_proxy'
 require 'glimmer/tk/button_proxy'
+require 'glimmer/tk/label_proxy'
 require 'glimmer/tk/list_proxy'
+require 'glimmer/tk/entry_proxy'

data/lib/glimmer/tk/entry_proxy.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2020 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/tk/widget_proxy'
+
+module Glimmer
+  module Tk    
+    # Proxy for Tk::Tile::TEntry
+    #
+    # Follows the Proxy Design Pattern
+    class EntryProxy < WidgetProxy
+      def validatecommand_block=(proc)
+        tk.validatecommand(proc)
+      end
+      def invalidcommand_block=(proc)
+        tk.invalidcommand(proc)
+      end
+    end
+  end
+end

data/lib/glimmer/tk/label_proxy.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2020 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/tk/widget_proxy'
+
+module Glimmer
+  module Tk    
+    # Proxy for Tk::Tile::TLabel
+    #
+    # Follows the Proxy Design Pattern
+    class LabelProxy < WidgetProxy
+      # TODO specify attribute setters
+#       def tk_widget_has_attribute_setter?(attribute)
+#         if ['anchor', 'justify'].include?(attribute.to_s)
+#           true
+#         else
+#           super
+#         end
+#       end    
+    end
+  end
+end

data/lib/glimmer/tk/widget_proxy.rb

@@ -31,6 +31,12 @@ module Glimmer
         'combobox' => lambda do |tk|
           tk.textvariable = ::TkVariable.new          
         end,
+        'label' => lambda do |tk|
+          tk.textvariable = ::TkVariable.new          
+        end,
+        'entry' => lambda do |tk|
+          tk.textvariable = ::TkVariable.new          
+        end,
       }
       
       class << self
@@ -75,7 +81,7 @@ module Glimmer
       def initialize(underscored_widget_name, parent_proxy, args)
         @parent_proxy = parent_proxy
         @args = args
-        tk_widget_class = self.class.tk_widget_class_for(underscored_widget_name)
+        tk_widget_class = self.class.tk_widget_class_for(underscored_widget_name)        
         @tk = tk_widget_class.new(@parent_proxy.tk, *args)
         # a common widget initializer
         @tk.grid
@@ -97,7 +103,7 @@ 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   
@@ -109,9 +115,22 @@ module Glimmer
         result      
       end
       
+      def tk_widget_has_attribute_getter_setter?(attribute)
+        result = nil
+        begin     
+          # TK Widget currently doesn't support respond_to? properly, so I have to resort to this trick for now   
+          @tk.send(attribute, @tk.send(attribute))
+          result = true
+        rescue => e
+          result = false
+        end
+        result      
+      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) || 
+          tk_widget_has_attribute_setter?(attribute) || 
+          tk_widget_has_attribute_getter_setter?(attribute) || 
           respond_to?(attribute_setter(attribute), args)
       end
 
@@ -119,8 +138,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 +151,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 +170,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 +199,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
       

data/samples/hello/hello_computed.rb

@@ -0,0 +1,75 @@
+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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-13 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -198,12 +198,16 @@ files:
 - lib/glimmer/dsl/tk/root_expression.rb
 - lib/glimmer/dsl/tk/widget_expression.rb
 - lib/glimmer/tk/button_proxy.rb
+- lib/glimmer/tk/entry_proxy.rb
 - lib/glimmer/tk/frame_proxy.rb
+- lib/glimmer/tk/label_proxy.rb
 - lib/glimmer/tk/list_proxy.rb
 - lib/glimmer/tk/notebook_proxy.rb
 - lib/glimmer/tk/root_proxy.rb
 - lib/glimmer/tk/widget_proxy.rb
 - samples/hello/hello_combo.rb
+- samples/hello/hello_computed.rb
+- samples/hello/hello_computed/contact.rb
 - samples/hello/hello_list_multi_selection.rb
 - samples/hello/hello_list_single_selection.rb
 - samples/hello/hello_tab.rb