glimmer-dsl-libui 0.11.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: effb65102f9db3aa2977bac55edd4f67f91f1eafdae26403b8c044c714048a03
-  data.tar.gz: 3923d80a19afd62a0220026f33720ee953ad166880e17d60883aed53f9977d86
+  metadata.gz: 664a95631db2e2b9bf943f9843c6954df9dc55ba335e51214d721b376969094c
+  data.tar.gz: 61bc5b8242902e1273296c74dd74b470930a38cf9c34af48e296e14a91dce2e2
 SHA512:
-  metadata.gz: 6e123f42fd61ce49b126e7f51caf738e0c769eca12b177c879007cedaba6ec38974d16ca864e8d8922546f79cfe2dc8946056935684f0bab9d88892e425c5d79
-  data.tar.gz: 8d0d79d7632e30568f747a3db5d9bbdef387e854f55e0cf6559a4d8d242075bc8c1836e00e2554a30eb5eded934bb23c267a764b127cfe768c39e679ff47671e
+  metadata.gz: 7045e3c06a6551286523e8f6564b6b57e86477d4c1693ba8b0852c4e259a69151caa0d945d05187cb9b1d0642274323dc6c5d7dcfe02e8481cc01f227a99e993
+  data.tar.gz: 5927641112ab6807a6f8f941f1e89d1927f85242bdadf79dd1ed9aa8d52f2707cf9607a702ed730a7f76f9594557fadb9f26415b4e87f6ee03b263740f013205

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.11.2
+
+- Fix issue with getting error when nesting property content under custom controls/shapes/windows (fixes `examples/basic_custom_shape.rb`)
+
+## 0.11.1
+
+- Refactor `examples/dynamic_form.rb`
+- Freeze LibUI version at 0.1.2.pre because 0.1.3.pre has issues like preventing the ability to close window with CMD+Q shortcut by default on Mac
+
 ## 0.11.0
 
 - Control `content` data-binding to generate nested controls dynamically based on a model attribute change

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 LibUI 0.11.0
+# [<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 LibUI 0.11.2
 ## Prerequisite-Free Ruby Desktop Development Cross-Platform Native GUI Library  ([Fukuoka Award Winning](http://www.digitalfukuoka.jp/topics/187?locale=ja))
 ### The Quickest Way From Zero To GUI
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
@@ -431,7 +431,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.11.0'
+gem 'glimmer-dsl-libui', '~> 0.11.2'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -636,6 +636,8 @@ Mac | Windows | Linux
 
 Application scaffolding enables automatically generating the directories/files of a new desktop GUI application that follows the MVC architecture and can be packaged as a Ruby gem that includes an executable script for running the app conveniently. It also ensures that software engineers follow the recommended Glimmer DSL for LibUI conventions and best practices. Application Scaffolding greatly improves software engineering productivity when building desktop applications with [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui).
 
+Application Scaffolding relies on the [juwelier](https://rubygems.org/gems/juwelier) Ruby gem, which expects having a local Git config (global settings in `~/.gitconfig`) of [`user.name`](https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git#setting-your-git-username-for-every-repository-on-your-computer), [`user.email`](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-email-address-for-every-repository-on-your-computer), and `github.user`.
+
 Scaffold Glimmer DSL for LibUI application with this command:
 
 ```
@@ -1615,7 +1617,7 @@ box1.content {
 }
 ```
 
-You can also use [data-binding](#data-binding) with content blocks to generate content dynamically based on changes in a model attribute. The only difference in syntax in this case would be to wrap the content with an explicit `content(*binding_args) { ... }` block that includes data-binding arguments for a model attribute.
+Content Data-Binding also allows you to use [data-binding](#data-binding) with content blocks to generate content dynamically based on changes in a model attribute. The only difference in syntax in this case would be to wrap the content with an explicit `content(*binding_args) { ... }` block (like `content(model, attribute) { somecontrols }` ) that includes data-binding arguments for a model attribute.
 
 Example:
 
@@ -1624,6 +1626,7 @@ form {
   stretchy false
   
   content(@user, :customizable_attributes) {
+    # this content will be re-rendered whenever @user.customizable_attributes changes
     @user.customizable_attributes.each do |attribute|
       entry {
         label attribute.to_s.split('_').map(&:capitalize).join(' ')
@@ -2107,8 +2110,8 @@ Learn more in the [Paginated Refined Table](/docs/examples/GLIMMER-DSL-LIBUI-ADV
 ### Area API
 
 The `area` control is a canvas-like control for drawing paths that can be used in one of two ways:
-- Declaratively via stable paths: useful for stable paths that will not change often later on. Simply nest `path` and figures like `rectangle` and all drawing logic is generated automatically. Path proxy objects are preserved across redraws assuming there would be relatively few stable paths (mostly for decorative reasons).
-- Semi-declaratively via on_draw listener dynamic paths: useful for more dynamic paths that will definitely change very often. Open an `on_draw` listener block that receives an [`area_draw_params`](#area-draw-params) argument and nest `path` and figures like `rectangle` and all drawing logic is generated automatically. Path proxy objects are destroyed (thrown-away) at the end of drawing, thus having less memory overhead for drawing thousands of dynamic paths.
+- Retained Mode (declaratively via stable shape structures): useful for stable paths that will not change often later on. Simply nest `path` and figures like `rectangle` and all drawing logic is generated automatically. Path proxy objects are preserved across redraws assuming there would be relatively few stable paths (mostly for decorative reasons).
+- Immediate Mode (semi-declaratively via `on_draw` listener dynamic shapes): useful for more dynamic paths that will definitely change very often. Open an `on_draw` listener block that receives an [`area_draw_params`](#area-draw-params) argument and nest `path` and figures like `rectangle` and all drawing logic is generated automatically. Path proxy objects are destroyed (thrown-away) at the end of drawing, thus having less memory overhead for drawing thousands of dynamic paths.
 
 Note that when nesting an `area` directly underneath `window` (without a layout control like `vertical_box`), it is automatically reparented with `vertical_box` in between the `window` and `area` since it would not show up on Linux otherwise.
 
@@ -2164,6 +2167,59 @@ window('Basic Area', 400, 400) {
 
 Check [examples/dynamic_area.rb](/docs/examples/GLIMMER-DSL-LIBUI-ADVANCED-EXAMPLES.md#dynamic-area) for a more detailed semi-declarative example.
 
+In Retained Mode, you can still generate `area` shapes dynamically by relying on Content Data-Binding.
+
+```ruby
+require 'glimmer-dsl-libui'
+
+class LineCollection
+  attr_accessor :line_count
+  
+  def initialize
+    @line_count = 3
+  end
+end
+
+class View
+  include Glimmer::LibUI::Application
+  
+  before_body do
+    @line_collection = LineCollection.new
+  end
+  
+  body {
+    window('Area Shapes - Line', 400, 400) {
+      vertical_box {
+        button('Generate Lines') {
+          stretchy false
+          
+          on_clicked do
+            @line_collection.line_count = rand(3..10)
+          end
+        }
+        area {
+          content(@line_collection, :line_count) { # generated dynamically
+            point_range = (50..350)
+            color_range = (0..255)
+            @line_collection.line_count.times do
+              line(rand(point_range), rand(point_range), rand(point_range), rand(point_range)) {
+                stroke rand(color_range), rand(color_range), rand(color_range), thickness: 3
+              }
+            end
+          }
+        }
+      }
+    }
+  }
+end
+
+View.launch
+```
+
+![area shape content data-binding](/images/glimmer-dsl-libui-mac-area-shape-content-data-binding.png)
+
+![area shape content data-binding regenerated](/images/glimmer-dsl-libui-mac-area-shape-content-data-binding-regenerated.png)
+
 #### Scrolling Area
 
 `scrolling_area(width as Numeric = main_window.width, height as Numeric = main_window.height)` is similar to `area`, but has the following additional methods:

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.11.2

data/examples/dynamic_form.rb

@@ -9,6 +9,15 @@ class User
     # allow customizing all attributes by default
     self.customizable_attributes = ALL_ATTRIBUTES.dup
   end
+  
+  def select_customizable_attribute(attribute, selected)
+    if selected
+      customizable_attributes.push(attribute)
+    else
+      customizable_attributes.delete(attribute)
+    end
+    customizable_attributes.sort_by! {|attribute| User::ALL_ATTRIBUTES.index(attribute)}
+  end
 end
 
 class DynamicForm
@@ -28,14 +37,7 @@ class DynamicForm
             checkbox(attribute.to_s) {
               checked <=> [@user, :customizable_attributes,
                            on_read: -> (attributes) { @user.customizable_attributes.include?(attribute) },
-                           on_write: -> (checked_value) {
-                             if checked_value
-                               @user.customizable_attributes.push(attribute)
-                             else
-                               @user.customizable_attributes.delete(attribute)
-                             end
-                             @user.customizable_attributes.sort_by {|attribute| User::ALL_ATTRIBUTES.index(attribute)}
-                           },
+                           on_write: -> (checked_value) { @user.select_customizable_attribute(attribute, checked_value) }
                           ]
             }
           end

data/lib/glimmer/libui/custom_control.rb

@@ -52,6 +52,16 @@ module Glimmer
           result ||= can_handle_listener?(method_name)
           result ||= @body_root.respond_to?(method_name, *args, &block)
         end
+
+        # Returns content block if used as an attribute reader (no args)
+        # Otherwise, if a block is passed, it adds it as content to this custom control
+        def content(&block)
+          if block_given?
+            Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::CustomControlExpression.new, self.class.keyword, &block)
+          else
+            @content
+          end
+        end
       end
       
       super_module_included do |klass|
@@ -233,16 +243,6 @@ module Glimmer
           !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') and
           !method(method_name)&.source_location&.first&.include?('glimmer/libui/control_proxy.rb')
       end
-
-      # Returns content block if used as an attribute reader (no args)
-      # Otherwise, if a block is passed, it adds it as content to this custom control
-      def content(&block)
-        if block_given?
-          Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::CustomControlExpression.new, self.class.keyword, &block)
-        else
-          @content
-        end
-      end
       
       private
 

data/lib/glimmer/libui/custom_shape.rb

@@ -52,6 +52,16 @@ module Glimmer
           result ||= can_handle_listener?(method_name)
           result ||= @body_root.respond_to?(method_name, *args, &block)
         end
+
+        # Returns content block if used as an attribute reader (no args)
+        # Otherwise, if a block is passed, it adds it as content to this custom shape
+        def content(&block)
+          if block_given?
+            Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::CustomShapeExpression.new, self.class.keyword, &block)
+          else
+            @content
+          end
+        end
       end
 
       super_module_included do |klass|
@@ -230,16 +240,6 @@ module Glimmer
           !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') and
           !method(method_name)&.source_location&.first&.include?('glimmer/libui/shape.rb')
       end
-
-      # Returns content block if used as an attribute reader (no args)
-      # Otherwise, if a block is passed, it adds it as content to this custom shape
-      def content(&block)
-        if block_given?
-          Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::CustomShapeExpression.new, self.class.keyword, &block)
-        else
-          @content
-        end
-      end
       
       private
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -150,14 +150,14 @@ dependencies:
   name: libui
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.1.2.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.1.2.pre
 - !ruby/object:Gem::Dependency
@@ -640,7 +640,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for LibUI (Fukuoka Award Winning Prerequisite-Free Ruby Desktop