glimmer-dsl-tk 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49a3f4e1f560a01173a20fa1a13fc62f107445c63cad77f353b3b7a9765433c3
-  data.tar.gz: 70decda6f2e3a73a24916b2e9d0685ff386fc4fe29b89fff3b4188fab830f21b
+  metadata.gz: f1af2971637c33b4dcebacf0de9239fa24402b92325157df38453a1ba535d99c
+  data.tar.gz: f327b2f968225d46be3768dc109aba6799ad4b00cd4c77b2584ed3729de57a7d
 SHA512:
-  metadata.gz: 7f9b8ee1544898bcb7031eacaf4ebb532ab113ac5852b6606bf247a05e27937b5d22c87833b5947527e6b525d83e2eb5714a42f1cf8f754bf7513d59eaf19ff4
-  data.tar.gz: 479e321c66646a97bd5fee7e6844e4b7a862ec88b2ba25697a9f8e1ac231717297258576b4b88facab135094bff30b2a507bd6b1a624fb0288f163ca5dff54c9
+  metadata.gz: a94b3eff61254b4b134cd19011c51ea1ec1ca952f6f2a753897840a0586cd39ca41483f4701a6746d8768b186a28790f6a010dfa6ba8f27d38d1698058ee11b4
+  data.tar.gz: d0fba3f64cb7b54f94ae6c00d7d6dbe4c1fe400cbc66c15c55b3648cfa3d05b0cb2eba123e6a4a9b1e79c78e9f0c9376282a2f9829d8f95013aa9804bcc05609

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.0.22
+
+- Hello, Checkbutton!
+- Support checkbutton data-binding
+
 ## 0.0.21
 
 - Support event bindings via `on(event) {}` syntax nestable under any widget

data/README.md

@@ -83,16 +83,18 @@ Other [Glimmer](https://github.com/AndyObtiva/glimmer) DSL gems:
       - [Icon Photo](#icon-photo)
   - [The Grid Geometry Manager](#the-grid-geometry-manager)
   - [Bidirectional Data-Binding](#bidirectional-data-binding)
-    - [General Property Data-Binding](#general-property-data-binding)
+    - [Label Data-Binding](#label-data-binding)
     - [Combobox Data-Binding](#combobox-data-binding)
     - [List Single Selection Data-Binding](#list-single-selection-data-binding)
     - [List Multi Selection Data-Binding](#list-multi-selection-data-binding)
     - [Entry Data-Binding](#entry-data-binding)
-  - [Command Observer](#command-observer)
+    - [Checkbox Data-Binding](#checkbox-data-binding)
+  - [Command Callback](#command-callback)
   - [Gotchas](#gotchas)
   - [Samples](#samples)
     - [Hello, World!](#hello-world)
     - [Hello, Button!](#hello-button)
+    - [Hello, Checkbutton!](#hello-checkbutton)
     - [Hello, Frame!](#hello-frame)
     - [Hello, Root!](#hello-root)
     - [Hello, Notebook!](#hello-notebook)
@@ -248,6 +250,7 @@ root {
 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'`), `default` (`'active', 'normal'`) | `command {}`
 `combobox` | `state`, `text` | `'ComboboxSelected'`
 `entry` | `width`, `text` | None
 `frame(text: nil)` | `width`, `height`, `borderwidth`, `relief` (`'flat' (default), 'raised', 'sunken', 'solid', 'ridge', 'groove'`) | None
@@ -371,7 +374,7 @@ More details can be found in the [Hello, Computed!](#hello-computed) sample belo
 
 Glimmer supports Shine syntax bidirectional data-binding via the `<=>` operator (read-write) and unidirectional data-binding via the `<=` operator (read-only), which takes a model and an attribute (the `bind` keyword may also be used as the old-style of data-binding).
 
-### General Property Data-Binding
+### Label Data-Binding
 
 Example:
 
@@ -379,11 +382,11 @@ This assumes a `Person` model with a `country` attribute.
 
 ```ruby
   label {
-    text <=> [person, :country]
+    text <= [person, :country]
   }
 ```
 
-That code binds the `textvariable` value of the `label` to the `country` property on the `person` model.
+That code binds the `textvariable` value of the `label` unidirectionally (read-only) to the `country` property on the `person` model.
 
 It automatically handles all the Tk plumbing behind the scenes.
 
@@ -424,8 +427,8 @@ This assumes a `Person` model with a `country` attribute representing their curr
   }
 ```
 
-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.
+That code binds the `items` text of the `list` to the `country_options` attribute on the `person` model (data-binding attribute + "_options" by convention).
+It also binds the `selection` text of the `list` to the `country` attribute on the `person` model.
 
 It automatically handles all the Tk plumbing behind the scenes.
 
@@ -445,8 +448,8 @@ This assumes a `Person` model with a `provinces` attribute representing their cu
   }
 ```
 
-That code binds the `items` text of the `list` to the `provinces_options` property on the `person` model (data-binding attribute + "_options" by convention).
-It also binds the `selection` text of the `list` to the `provinces` property on the `person` model.
+That code binds the `items` text of the `list` to the `provinces_options` attribute on the `person` model (data-binding attribute + "_options" by convention).
+It also binds the `selection` text of the `list` to the `provinces` attribute on the `person` model.
 
 It automatically handles all the Tk plumbing behind the scenes.
 
@@ -464,30 +467,47 @@ This assumes a `Person` model with a `country` attribute.
   }
 ```
 
-That code binds the `textvariable` value of the `entry` to the `country` property on the `person` model.
+That code binds the `textvariable` value of the `entry` to the `country` attribute 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
+### Checkbox Data-Binding
+
+Example:
+
+This assumes a `Person` model with a boolean `adult` attribute.
+
+```ruby
+  checkbutton {
+    variable <=> [person, :adult]
+  }
+```
+
+That code binds the `variable` value of the `checkbutton` to the boolean `adult` attribute on the `person` model.
 
-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)
+It automatically handles all the Tk plumbing behind the scenes.
+
+More details can be found in the [Hello, Checkbutton!](#hello-checkbutton) sample below.
+
+## Command Callback
+
+`button` and `checkbutton` can set a `command` block to trigger when the user clicks the button/checkbutton. This may be done with the `command` keyword, passing in a block directly.
 
 Example:
 
 ```ruby
   button {
     text "Reset Selection"
+    
     command {
       person.reset_country
     }
   }
 ```
 
-This resets the person country.
-
-More details can be found in the [Hello, Combobox!](#hello-combobox) sample below.
+More details can be found in the [Hello, Button!](#hello-button) sample below.
 
 ## Gotchas
 
@@ -628,6 +648,97 @@ Glimmer app:
 
 ![glimmer dsl tk screenshot sample hello button](images/glimmer-dsl-tk-screenshot-sample-hello-button.png)
 
+### Hello, Checkbutton!
+
+Glimmer code (from [samples/hello/hello_checkbutton.rb](samples/hello/hello_checkbutton.rb)):
+
+```ruby
+require 'glimmer-dsl-tk'
+
+class HelloCheckbutton
+  class Person
+    attr_accessor :skiing, :snowboarding, :snowmobiling, :snowshoeing
+    
+    def initialize
+      reset_activities!
+    end
+    
+    def reset_activities!
+      self.skiing = false
+      self.snowboarding = true
+      self.snowmobiling = false
+      self.snowshoeing = false
+    end
+  end
+  
+  include Glimmer
+  
+  def initialize
+    @person = Person.new
+  end
+  
+  def launch
+    root {
+      title 'Hello, Checkbutton!'
+      background '#ececec' if OS.mac?
+      
+      label {
+        text 'Check all snow activities you are interested in:'
+        font 'caption'
+      }
+      
+      frame {
+        checkbutton {
+          text 'Skiing'
+          variable <=> [@person, :skiing]
+        }
+        
+        checkbutton {
+          text 'Snowboarding'
+          variable <=> [@person, :snowboarding]
+        }
+        
+        checkbutton {
+          text 'Snowmobiling'
+          variable <=> [@person, :snowmobiling]
+        }
+        
+        checkbutton {
+          text 'Snowshoeing'
+          variable <=> [@person, :snowshoeing]
+        }
+      }
+      
+      button {
+        text 'Reset Activities'
+        
+        command do
+          @person.reset_activities!
+        end
+      }
+    }.open
+  end
+end
+
+HelloCheckbutton.new.launch
+```
+
+Run with [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed:
+
+```
+ruby -r glimmer-dsl-tk -e "require 'samples/hello/hello_checkbutton'"
+```
+
+Alternatively, run from cloned project without [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed:
+
+```
+ruby -r ./lib/glimmer-dsl-tk.rb ./samples/hello/hello_checkbutton.rb
+```
+
+Glimmer app:
+
+![glimmer dsl tk screenshot sample hello checkbutton](images/glimmer-dsl-tk-screenshot-sample-hello-checkbutton.png)
+
 ### Hello, Frame!
 
 Glimmer code (from [samples/hello/hello_frame.rb](samples/hello/hello_frame.rb)):

data/VERSION

@@ -1 +1 @@
-0.0.21
+0.0.22

data/lib/glimmer/tk/button_proxy.rb

@@ -27,9 +27,20 @@ module Glimmer
     #
     # Follows the Proxy Design Pattern
     class ButtonProxy < WidgetProxy
+      # TODO extract to a module
+      
       def command_block=(proc)
         tk.command(proc)
       end
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name.to_s.downcase
+        when 'command'
+          command(listener)
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/glimmer/tk/checkbutton_proxy.rb

@@ -0,0 +1,44 @@
+# 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/tk/widget_proxy'
+
+module Glimmer
+  module Tk
+    # Proxy for Tk::Tile::Checkbutton
+    #
+    # Follows the Proxy Design Pattern
+    class ChecktbuttonProxy < WidgetProxy
+      def command_block=(proc)
+        tk.command(proc)
+      end
+      
+      def handle_listener(listener_name, &listener)
+        case listener_name.to_s.downcase
+        when 'command'
+          command(listener)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/tk/root_proxy.rb

@@ -127,7 +127,7 @@ module Glimmer
       end
       
       def handle_listener(listener_name, &listener)
-        case listener_name.to_s
+        case listener_name.to_s.upcase
         when 'WM_DELETE_WINDOW', 'DELETE_WINDOW'
           listener_name = 'WM_DELETE_WINDOW'
           @tk.protocol(listener_name, &listener)

data/lib/glimmer/tk/widget_proxy.rb

@@ -64,6 +64,9 @@ module Glimmer
       attr_reader :parent_proxy, :tk, :args, :keyword
 
       DEFAULT_INITIALIZERS = {
+        'checkbutton' => lambda do |tk|
+          tk.variable = ::TkVariable.new
+        end,
         'combobox' => lambda do |tk|
           tk.textvariable = ::TkVariable.new
         end,
@@ -212,6 +215,16 @@ module Glimmer
               setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
             },
           },
+          ::Tk::Tile::TCheckbutton => {
+            'image' => {
+              getter: {name: 'image', invoker: lambda { |widget, args| @tk.image }},
+              setter: {name: 'image=', invoker: lambda { |widget, args| @tk.image = image_argument(args) }},
+            },
+            'variable' => {
+              getter: {name: 'variable', invoker: lambda { |widget, args| @tk.variable&.value.to_i == 1 }},
+              setter: {name: 'variable=', invoker: lambda { |widget, args| @tk.variable&.value = args.first.is_a?(Integer) ? args.first : (args.first ? 1 : 0) }},
+            },
+          },
           ::Tk::Tile::TCombobox => {
             'text' => {
               getter: {name: 'text', invoker: lambda { |widget, args| @tk.textvariable&.value }},
@@ -239,6 +252,13 @@ module Glimmer
       
       def widget_attribute_listener_installers
         @tk_widget_attribute_listener_installers ||= {
+          ::Tk::Tile::TCheckbutton => {
+            'variable' => lambda do |observer|
+              @tk.command {
+                observer.call(@tk.variable.value.to_i == 1)
+              }
+            end,
+          },
           ::Tk::Tile::TCombobox => {
             'text' => lambda do |observer|
               if observer.is_a?(Glimmer::DataBinding::ModelBinding)

data/lib/glimmer-dsl-tk.rb

@@ -27,6 +27,7 @@ require 'glimmer'
 require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 # require 'super_module'
 require 'tk'
+require 'os'
 
 # Internal requires
 # require 'ext/glimmer/config'

data/samples/hello/hello_checkbutton.rb

@@ -0,0 +1,89 @@
+# 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'
+
+class HelloCheckbutton
+  class Person
+    attr_accessor :skiing, :snowboarding, :snowmobiling, :snowshoeing
+    
+    def initialize
+      reset_activities!
+    end
+    
+    def reset_activities!
+      self.skiing = false
+      self.snowboarding = true
+      self.snowmobiling = false
+      self.snowshoeing = false
+    end
+  end
+  
+  include Glimmer
+  
+  def initialize
+    @person = Person.new
+  end
+  
+  def launch
+    root {
+      title 'Hello, Checkbutton!'
+      background '#ececec' if OS.mac?
+      
+      label {
+        text 'Check all snow activities you are interested in:'
+        font 'caption'
+      }
+      
+      frame {
+        checkbutton {
+          text 'Skiing'
+          variable <=> [@person, :skiing]
+        }
+        
+        checkbutton {
+          text 'Snowboarding'
+          variable <=> [@person, :snowboarding]
+        }
+        
+        checkbutton {
+          text 'Snowmobiling'
+          variable <=> [@person, :snowmobiling]
+        }
+        
+        checkbutton {
+          text 'Snowshoeing'
+          variable <=> [@person, :snowshoeing]
+        }
+      }
+      
+      button {
+        text 'Reset Activities'
+        
+        command do
+          @person.reset_activities!
+        end
+      }
+    }.open
+  end
+end
+
+HelloCheckbutton.new.launch

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-tk
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -38,6 +38,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: tk
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +223,7 @@ files:
 - lib/glimmer/dsl/tk/shine_data_binding_expression.rb
 - lib/glimmer/dsl/tk/widget_expression.rb
 - lib/glimmer/tk/button_proxy.rb
+- lib/glimmer/tk/checkbutton_proxy.rb
 - lib/glimmer/tk/entry_proxy.rb
 - lib/glimmer/tk/frame_proxy.rb
 - lib/glimmer/tk/label_proxy.rb
@@ -212,6 +233,7 @@ files:
 - lib/glimmer/tk/treeview_proxy.rb
 - lib/glimmer/tk/widget_proxy.rb
 - samples/hello/hello_button.rb
+- samples/hello/hello_checkbutton.rb
 - samples/hello/hello_combobox.rb
 - samples/hello/hello_computed.rb
 - samples/hello/hello_computed/contact.rb
@@ -252,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for Tk