glimmer-dsl-libui 0.12.5 → 0.12.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55d062cea1842f93cdbec55c47e6859c2af81c92be8283e0dd1f4505ce01251e
-  data.tar.gz: 6a973ce01567411a4e83971bfbc0441f58a05c8fdc7e995ca346370eb8112043
+  metadata.gz: d95327be14547ec2bbc41b7d963c00a432a6ae3fbcb5b41c9b900cba967194d8
+  data.tar.gz: 3bf11f49b498aabd0d6c2bc35a8e49be99aeb60066a3095a2ce08c866d2861c2
 SHA512:
-  metadata.gz: f4ac15a26c19bc9ed3a4a4cd2cb3a4507b0a28cc71c2862f38a3acf5ecb9defacad22d8c04d77a1186904ccbca8dfcd5d4ef5231b376aad6f3d1536fa42124f3
-  data.tar.gz: f8ee29ce0b626ff191fddca925fe573a5f098b07ccd9e1387f82f760c2b187da7173aa0006d2577290c3ee579a285edca76aee0749c7eac92a90e84af3468547
+  metadata.gz: 6dca03d07a89a0c700f50509a3f1a56c8321b7b44d38de794f7a4b81d415981c35d463623294b332350517001c2f7c6f841d2d27a18ec79546f884161798799b
+  data.tar.gz: bf843b6399671fdd87f7a6c3f60b17a45506d23477e6273dddb6263540925bc73c9ef3031ef9228e9b1d7ea4c37cf8355c5c22b6c3d3896c0ed05e0d6fbf4623

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.12.7
+
+- Application Scaffolding now generates the main view as `SomeNameApplication` (with `_application` suffix in file name) to indicate clearly it is a `Glimmer::LibUI::Application` class.
+- Application Scaffolding now generates a `presenter` directory for convenience in case presenters are needed.
+
+## 0.12.6
+
+- Shape Content Data-Binding
+
 ## 0.12.5
 
 - Prevent duplication of items in editable_combobox when updating items with an array that contains duplicates

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.12.5
+# [<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.12.7
 ## 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)
@@ -8,6 +8,8 @@
 
 (**[Fukuoka Ruby Award Competition 2022 Special Award Winner](https://andymaleh.blogspot.com/2022/02/glimmer-dsl-for-libui-wins-fukuoka-ruby.html)** [[Award Announcement]](http://www.digitalfukuoka.jp/topics/187?locale=ja))
 
+(**[***RubyConf 2024 Workshop - How To Build Basic Desktop Applications in Ruby***](https://www.youtube.com/watch?v=TTSqRdTVtDY)**)
+
 (**[***RubyConf 2023 Workshop - How To Build Desktop Applications in Ruby***](https://github.com/AndyObtiva/how-to-build-desktop-applications-in-ruby)**)
 
 (**[***RubyConf 2022 Talk - Building Native GUI Apps in Ruby***](https://andymaleh.blogspot.com/2023/02/rubyconf-2022-talk-video-for-building.html)**)
@@ -464,7 +466,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.12.5'
+gem 'glimmer-dsl-libui', '~> 0.12.7'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -790,7 +792,7 @@ hello_world
 When you are in a scaffolded application, you can scaffold a new [custom control](#custom-components) (a control that you can put anything in to represent a view concept in your application) by running this command:
 
 ```
-glimmer scaffold:customcontrol[name,namespace]
+glimmer "scaffold:customcontrol[name,namespace]"
 ```
 
 The `name` represents the [custom control](#custom-components) view class name (it can be underscored, and Glimmer will automatically classify it).
@@ -800,13 +802,13 @@ The `namespace` is optional and represents the module that the [custom control](
 You can also use the shorter `cc` alias for `customcontrol`:
 
 ```
-glimmer scaffold:cc[name,namespace]
+glimmer "scaffold:cc[name,namespace]"
 ```
 
 For example by running this command under a `hello_world` application:
 
 ```
-glimmer scaffold:cc[model_form]
+glimmer "scaffold:cc[model_form]"
 ```
 
 That will generate this class under `app/hello_world/view/model_form`:
@@ -880,7 +882,7 @@ window {
 Here is an example that generates a [custom control](#custom-components) with a namespace:
 
 ```
-glimmer scaffold:cc[model_form,common]
+glimmer "scaffold:cc[model_form,common]"
 ```
 
 That will generate this class under `app/common/view/model_form`:
@@ -980,7 +982,7 @@ A custom window is a specialization of a custom control that has a `window` as i
 When you are in a scaffolded application, you can scaffold a new custom window (a window that you can put anything in to represent a view concept in your application) by running this command:
 
 ```
-glimmer scaffold:customwindow[name,namespace]
+glimmer "scaffold:customwindow[name,namespace]"
 ```
 
 The `name` represents the custom window view class name (it can be underscored, and Glimmer will automatically classify it).
@@ -990,13 +992,13 @@ The `namespace` is optional and represents the module that the custom window vie
 You can also use the shorter `cw` alias for `customwindow`:
 
 ```
-glimmer scaffold:cw[name,namespace]
+glimmer "scaffold:cw[name,namespace]"
 ```
 
 For example by running this command under a `hello_world` application:
 
 ```
-glimmer scaffold:cw[greeting_window]
+glimmer "scaffold:cw[greeting_window]"
 ```
 
 That will generate this class under `app/hello_world/view/greeting_window`:
@@ -1057,7 +1059,7 @@ greeting_window.show
 Here is an example that generates a custom window with a namespace:
 
 ```
-glimmer scaffold:cw[train,station]
+glimmer "scaffold:cw[train,station]"
 ```
 
 That will generate this class under `app/station/view/train`:
@@ -1132,7 +1134,7 @@ hello_world__view__train.show
 When you are in a scaffolded application, you can scaffold a new [custom shape](#custom-components) (a shape that you can put anything in to represent a view concept in your application) by running this command:
 
 ```
-glimmer scaffold:customshape[name,namespace]
+glimmer "scaffold:customshape[name,namespace]"
 ```
 
 The `name` represents the [custom shape](#custom-components) view class name (it can be underscored, and Glimmer will automatically classify it).
@@ -1142,13 +1144,13 @@ The `namespace` is optional and represents the module that the [custom shape](#c
 You can also use the shorter `cs` alias for `customshape`:
 
 ```
-glimmer scaffold:cs[name,namespace]
+glimmer "scaffold:cs[name,namespace]"
 ```
 
 For example by running this command under a `hello_world` application:
 
 ```
-glimmer scaffold:cs[heart]
+glimmer "scaffold:cs[heart]"
 ```
 
 That will generate this class under `app/hello_world/view/heart`:
@@ -1233,7 +1235,7 @@ window {
 Here is an example that generates a [custom shape](#custom-components) with a namespace:
 
 ```
-glimmer scaffold:cs[heart,acme]
+glimmer "scaffold:cs[heart,acme]"
 ```
 
 That will generate this class under `app/acme/view/heart`:
@@ -1330,7 +1332,7 @@ window {
 You can scaffold a Ruby gem around a reusable [custom control](#custom-components) to expose publicly and make available for multiple projects by running this command:
 
 ```
-glimmer scaffold:gem:customcontrol[name,namespace]
+glimmer "scaffold:gem:customcontrol[name,namespace]"
 ```
 
 That will generate a [custom control](#custom-components) gem project under the naming convention: `glimmer-libui-cc-name-namespace`
@@ -1344,7 +1346,7 @@ The `namespace` is needed to avoid clashing with other [custom control](#custom-
 Here is a shorter alias for the [custom control](#custom-components) gem scaffolding command:
 
 ```
-glimmer scaffold:gem:cc[name,namespace]
+glimmer "scaffold:gem:cc[name,namespace]"
 ```
 
 You can package the newly scaffolded project as a Ruby gem by running this command:
@@ -1398,7 +1400,7 @@ A custom window is a specialization of a custom control that has a `window` as i
 You can scaffold a Ruby gem around a reusable custom window to expose publicly and make available for multiple projects by running this command:
 
 ```
-glimmer scaffold:gem:customwindow[name,namespace]
+glimmer "scaffold:gem:customwindow[name,namespace]"
 ```
 
 That will generate a custom window gem project under the naming convention: `glimmer-libui-cw-name-namespace`
@@ -1412,7 +1414,7 @@ The `namespace` is needed to avoid clashing with other custom window gems that o
 Here is a shorter alias for the custom window gem scaffolding command:
 
 ```
-glimmer scaffold:gem:cw[name,namespace]
+glimmer "scaffold:gem:cw[name,namespace]"
 ```
 
 You can package the newly scaffolded project as a Ruby gem by running this command:
@@ -1458,7 +1460,7 @@ greeter.show
 You can scaffold a Ruby gem around a reusable [custom shape](#custom-components) to expose publicly and make available for multiple projects by running this command:
 
 ```
-glimmer scaffold:gem:customshape[name,namespace]
+glimmer "scaffold:gem:customshape[name,namespace]"
 ```
 
 That will generate a [custom shape](#custom-components) gem project under the naming convention: `glimmer-libui-cc-name-namespace`
@@ -1472,7 +1474,7 @@ The `namespace` is needed to avoid clashing with other [custom shape](#custom-co
 Here is a shorter alias for the [custom shape](#custom-components) gem scaffolding command:
 
 ```
-glimmer scaffold:gem:cs[name,namespace]
+glimmer "scaffold:gem:cs[name,namespace]"
 ```
 
 You can package the newly scaffolded project as a Ruby gem by running this command:

data/VERSION

@@ -1 +1 @@
-0.12.5
+0.12.7

data/lib/glimmer/libui/content_bindable.rb

@@ -0,0 +1,19 @@
+module Glimmer
+  module LibUI
+    module ContentBindable
+      # Data-binds the generation of nested content to a model/property (in binding args)
+      # consider providing an option to avoid initial rendering without any changes happening
+      def bind_content(*binding_args, &content_block)
+        # TODO in the future, consider optimizing code by diffing content if that makes sense
+        content_binding_work = proc do |*values|
+          children.dup.each { |child| child.destroy }
+          content(&content_block)
+        end
+        model_binding_observer = Glimmer::DataBinding::ModelBinding.new(*binding_args)
+        content_binding_observer = Glimmer::DataBinding::Observer.proc(&content_binding_work)
+        content_binding_observer.observe(model_binding_observer)
+        content_binding_work.call # TODO inspect if we need to pass args here (from observed attributes) [but it's simpler not to pass anything at first]
+      end
+    end
+  end
+end

data/lib/glimmer/libui/control_proxy.rb

@@ -20,6 +20,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/libui/data_bindable'
+require 'glimmer/libui/content_bindable'
 require 'glimmer/libui/parent'
 
 module Glimmer
@@ -105,6 +106,7 @@ module Glimmer
       end
       
       include DataBindable
+      include ContentBindable
       prepend Parent
       
       KEYWORD_ALIASES = {
@@ -395,20 +397,6 @@ module Glimmer
         Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::ControlExpression.new, @keyword, {post_add_content: @content_added}, &block)
       end
       
-      # Data-binds the generation of nested content to a model/property (in binding args)
-      # consider providing an option to avoid initial rendering without any changes happening
-      def bind_content(*binding_args, &content_block)
-        # TODO in the future, consider optimizing code by diffing content if that makes sense
-        content_binding_work = proc do |*values|
-          children.dup.each { |child| child.destroy }
-          content(&content_block)
-        end
-        model_binding_observer = Glimmer::DataBinding::ModelBinding.new(*binding_args)
-        content_binding_observer = Glimmer::DataBinding::Observer.proc(&content_binding_work)
-        content_binding_observer.observe(model_binding_observer)
-        content_binding_work.call # TODO inspect if we need to pass args here (from observed attributes) [but it's simpler not to pass anything at first]
-      end
-      
       private
       
       def build_control

data/lib/glimmer/libui/shape.rb

@@ -23,6 +23,7 @@ require 'glimmer/libui/parent'
 require 'glimmer/libui/control_proxy/area_proxy'
 require 'glimmer/libui/control_proxy/path_proxy'
 require 'glimmer/libui/data_bindable'
+require 'glimmer/libui/content_bindable'
 require 'glimmer/libui/perfect_shaped'
 
 module Glimmer
@@ -72,6 +73,7 @@ module Glimmer
       include Parent
       include PerfectShaped
       include DataBindable
+      include ContentBindable
       
       KEYWORD_ALIASES = {
         'shape' => 'composite_shape',

data/lib/glimmer/rake_task/scaffold.rb

@@ -153,6 +153,7 @@ module Glimmer
           mkdir 'app'
           write "app/#{file_name(app_name)}.rb", app_main_file(app_name)
           mkdir_p "app/#{file_name(app_name)}/model"
+          mkdir_p "app/#{file_name(app_name)}/presenter"
           mkdir_p "app/#{file_name(app_name)}/view"
           custom_window(class_name(app_name), current_dir_name, window_type, custom_window_class_name: 'Application')
           app_model(current_dir_name)
@@ -195,9 +196,11 @@ module Glimmer
           namespace ||= current_dir_name
           root_dir = File.exist?('app') ? 'app' : 'lib'
           parent_dir = "#{root_dir}/#{file_name(namespace)}/view"
-          return puts("The file '#{parent_dir}/#{file_name(custom_window_name)}.rb' already exists. Please either remove or pick a different name.") if File.exist?("#{parent_dir}/#{file_name(custom_window_name)}.rb")
+          custom_window_file_name_suffix = "_#{file_name(window_options[:custom_window_class_name])}" if window_options[:custom_window_class_name] == 'Application'
+          custom_window_file_name = "#{parent_dir}/#{file_name(custom_window_name)}#{custom_window_file_name_suffix}.rb"
+          return puts("The file '#{custom_window_file_name}' already exists. Please either remove or pick a different name.") if File.exist?(custom_window_file_name)
           mkdir_p parent_dir unless File.exist?(parent_dir)
-          write "#{parent_dir}/#{file_name(custom_window_name)}.rb", custom_window_file(custom_window_name, namespace, window_type, window_options)
+          write custom_window_file_name, custom_window_file(custom_window_name, namespace, window_type, window_options)
         end
     
         def custom_control(custom_control_name, namespace)
@@ -437,7 +440,7 @@ module Glimmer
               LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))
             end
     
-            require '#{file_name(app_name)}/view/#{file_name(app_name)}'
+            require '#{file_name(app_name)}/view/#{file_name(app_name)}_application.rb'
           MULTI_LINE_STRING
         end
     
@@ -457,9 +460,10 @@ module Glimmer
     
         def app_launch_file(app_name)
           <<~MULTI_LINE_STRING
+            # this is only a helper for the bin script to launch the app. Developers must generally not need to edit it.
             require_relative '../#{file_name(app_name)}'
             
-            #{class_name(app_name)}::View::#{class_name(app_name)}.launch
+            #{class_name(app_name)}::View::#{class_name(app_name)}Application.launch
           MULTI_LINE_STRING
         end
         
@@ -545,7 +549,7 @@ require '#{window_type == :app ? current_dir_name : namespace}/model/greeting'
           custom_window_file_content += <<-MULTI_LINE_STRING
 #{namespace_type} #{class_name(namespace)}
   module View
-    class #{class_name(custom_window_name)}
+    class #{class_name(custom_window_name)}#{window_options[:custom_window_class_name] if window_options[:custom_window_class_name] == 'Application'}
       include Glimmer::LibUI::#{window_options[:custom_window_class_name]}
     
           MULTI_LINE_STRING

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.12.7
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -526,6 +526,7 @@ files:
 - lib/glimmer/launcher.rb
 - lib/glimmer/libui.rb
 - lib/glimmer/libui/attributed_string.rb
+- lib/glimmer/libui/content_bindable.rb
 - lib/glimmer/libui/control_proxy.rb
 - lib/glimmer/libui/control_proxy/area_proxy.rb
 - lib/glimmer/libui/control_proxy/area_proxy/scrolling_area_proxy.rb