glimmer-dsl-libui 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ad3f4e1a2e367a8e95fba05f1b539f2aa865dfab7e2234541933be97dda171
-  data.tar.gz: 44255036ce4a887224c84f861d0654483bada4ff8ed3c2a1c4192083a19cf45b
+  metadata.gz: 916c5f10df3886ef6a5eed0ba6cbade95141812b5f5ab302ba3fb6dc0449a989
+  data.tar.gz: 6558bc6824e050a4f36c8d89d8ee2eded34017e2f931905f7469e045e56ab5e7
 SHA512:
-  metadata.gz: e018c132e8b838ce839adeaae9d812d52ab8be960b87a8d3e5c85cf8045d988b83495640fb4bef7cb778960d2f25b7da8fcf4d659bd8ada7ed8277d26cc9ff9f
-  data.tar.gz: 3fb97e3a7946c9690c0bd48fdbee89d65f99833b11bd9b033c21b099e51f394b98d1aa96c4c51b9e0445c309a5b28f4f272c53174617e20b4e578dc602338c5a
+  metadata.gz: 5395eb43d9bc4a6aee0a18d498334a15475bd17cd976853bfb79c831eb55cdda6d68a9f8f04d62586d6d442004f0c74cef96f4f11e2ac53a08fba100813f989d
+  data.tar.gz: 8d8ed838367b768e7c18d47027f0b8a11d5728bf578339867b60411566dec0ada11294f9691008489f8fedaf971548d0c8bdc927f1b2f53f8f3de0a8e9a90b01

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 0.9.4
+
+- Scaffold Custom Window via `glimmer scaffold:customwindow[name,namespace]`
+
+## 0.9.3
+
+- Application Scaffolding via `glimmer scaffold[app_name]` includes a Model layer
+
 ## 0.9.2
 
 - Add `glimmer` commands `glimmer package:gem`, `glimmer package:gemspec`, and `glimmer package:clean`

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.9.2
+# [<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.9.4
 ## 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)
@@ -351,6 +351,7 @@ Learn more about the differences between various [Glimmer](https://github.com/An
     - [Run Application](#run-application)
     - [Run Examples](#run-examples)
     - [Scaffold Application](#scaffold-application)
+    - [Scaffold Custom Window](#scaffold-custom-window)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [API](#api)
@@ -421,7 +422,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.9.2'
+gem 'glimmer-dsl-libui', '~> 0.9.4'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -625,7 +626,7 @@ Scaffold Glimmer DSL for LibUI application with this command:
 glimmer "scaffold[app_name]"
 ```
 
-That will generate the general MVC structure of a new Glimmer DSL for LibUI application.
+That will automatically generate the general MVC structure of a new Glimmer DSL for LibUI application and launch the application when done.
 
 For example, if we run:
 
@@ -645,6 +646,7 @@ Created hello_world/Gemfile
 Created hello_world/Rakefile
 Created hello_world/app/hello_world.rb
 Created hello_world/app/hello_world/view/hello_world.rb
+Created hello_world/app/hello_world/model/greeting.rb
 Created hello_world/icons/windows/Hello World.ico
 Created hello_world/icons/macosx/Hello World.icns
 Created hello_world/icons/linux/Hello World.png
@@ -655,8 +657,19 @@ Created hello_world/bin/hello_world
 They include a basic Hello, World! application with menus and about/preferences dialogs.
 
 Views live under `app/app_name/view` (e.g. `app/hello_world/view`)
+
 Models live under `app/app_name/model` (e.g. `app/hello_world/model`)
 
+The application runs automatically once scaffolding is done.
+
+![glimmer-dsl-libui-mac-scaffold-app-initial-screen.png](images/glimmer-dsl-libui-mac-scaffold-app-initial-screen.png)
+
+![glimmer-dsl-libui-mac-scaffold-app-preferences.png](images/glimmer-dsl-libui-mac-scaffold-app-preferences.png)
+
+![glimmer-dsl-libui-mac-scaffold-app-changed-greeting.png](images/glimmer-dsl-libui-mac-scaffold-app-changed-greeting.png)
+
+![glimmer-dsl-libui-mac-scaffold-app-about.png](images/glimmer-dsl-libui-mac-scaffold-app-about.png)
+
 Once you step into the application directory, you can run it in one of multiple ways:
 
 ```
@@ -677,11 +690,7 @@ glimmer run
 
 ![glimmer-dsl-libui-mac-scaffold-app-initial-screen.png](images/glimmer-dsl-libui-mac-scaffold-app-initial-screen.png)
 
-![glimmer-dsl-libui-mac-scaffold-app-preferences.png](images/glimmer-dsl-libui-mac-scaffold-app-preferences.png)
-
-![glimmer-dsl-libui-mac-scaffold-app-changed-greeting.png](images/glimmer-dsl-libui-mac-scaffold-app-changed-greeting.png)
-
-The application comes with `juwelier` for auto-generating an application gem from its `Rakefile` gem configuration.
+The application comes with the [juwelier](https://rubygems.org/gems/juwelier) gem for auto-generating an application gem from the app `Rakefile` and `Gemfile` configuration (no need to manually declare gems in a gemspec... just use `Gemfile` normally and [juwelier](https://rubygems.org/gems/juwelier) takes care of the rest by generating an app gemspec automatically from `Gemfile`).
 
 You can package the newly scaffolded app as a Ruby gem by running this command:
 
@@ -721,6 +730,158 @@ hello_world
 
 ![glimmer-dsl-libui-mac-scaffold-app-initial-screen.png](images/glimmer-dsl-libui-mac-scaffold-app-initial-screen.png)
 
+### Scaffold Custom Window
+
+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]
+```
+
+The name represents the custom window view class name (it can be underscored, and Glimmer will automatically classify it).
+
+The namespace is optional and represents the module that the custom window view class will live under. If left off, the main application class namespace is used (e.g. the top-level `HelloWorld` class namespace for a `hello_world` application).
+
+You can also use the shorter `cw` alias for `customwindow`:
+
+```
+glimmer scaffold:cw[name,namespace]
+```
+
+For example by running this command under a `hello_world` application:
+
+```
+glimmer scaffold:cw[greeting_window]
+```
+
+That will generate this class under `app/hello_world/view/greeting_window`:
+
+```ruby
+class HelloWorld
+  module View
+    class GreetingWindow
+      include Glimmer::LibUI::CustomWindow
+    
+          
+      ## Add options like the following to configure CustomWindow by outside consumers
+      #
+      # options :title, :background_color
+      # option :width, default: 320
+      # option :height, default: 240
+  
+      ## Use before_body block to pre-initialize variables to use in body and
+      #  to setup application menu
+      #
+      # before_body do
+      #
+      # end
+  
+      ## Use after_body block to setup observers for controls in body
+      #
+      # after_body do
+      #
+      # end
+  
+      ## Add control content inside custom window body
+      ## Top-most control must be a window or another custom window
+      #
+      body {
+        window {
+          # Replace example content below with custom window content
+          content_size 240, 240
+          title 'Hello World'
+          
+          margined true
+          
+          label {
+            text 'Hello World'
+          }
+        }
+      }
+    end
+  end
+end
+```
+
+When the generated file is required in another view, the custom window keyword `greeting_window` become available and reusable, like by calling:
+
+```ruby
+greeting_window.show
+```
+
+Here is an example that generates a custom window with a namespace:
+
+```
+glimmer scaffold:cw[train,station]
+```
+
+That will generate this class under `app/station/view/train`:
+
+```ruby
+module Station
+  module View
+    class Train
+      include Glimmer::LibUI::CustomWindow
+    
+          
+      ## Add options like the following to configure CustomWindow by outside consumers
+      #
+      # options :title, :background_color
+      # option :width, default: 320
+      # option :height, default: 240
+  
+      ## Use before_body block to pre-initialize variables to use in body and
+      #  to setup application menu
+      #
+      # before_body do
+      #
+      # end
+  
+      ## Use after_body block to setup observers for controls in body
+      #
+      # after_body do
+      #
+      # end
+  
+      ## Add control content inside custom window body
+      ## Top-most control must be a window or another custom window
+      #
+      body {
+        window {
+          # Replace example content below with custom window content
+          content_size 240, 240
+          title 'Station'
+          
+          margined true
+          
+          label {
+            text 'Station'
+          }
+        }
+      }
+    end
+  end
+end
+```
+
+When that file is required, the `train` keyword becomes available:
+
+```ruby
+train.show
+```
+
+If for whatever reason, you end up with 2 custom window views having the same name with different namespaces, then you can invoke the specific custom window you want by including the Ruby namespace in underscored format separated by double-underscores:
+
+```ruby
+station__view__train.show
+```
+
+Or another `train` custom window view:
+
+```ruby
+hello_world__view__train.show
+```
+
 ## Girb (Glimmer IRB)
 
 You can run the `girb` command (`bin/girb` if you cloned the project locally) to do some quick and dirty experimentation and learning:

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.4

data/lib/glimmer/rake_task/scaffold.rb

@@ -155,6 +155,7 @@ module Glimmer
           mkdir_p "app/#{file_name(app_name)}/model"
           mkdir_p "app/#{file_name(app_name)}/view"
           custom_window(class_name(app_name), current_dir_name, window_type, custom_window_class_name: 'Application')
+          application_model(current_dir_name)
             
           mkdir_p 'icons/windows'
           icon_file = "icons/windows/#{human_name(app_name)}.ico"
@@ -366,6 +367,16 @@ module Glimmer
           puts 'Run `rake build` to build gem.'
           puts 'Run `rake release` to release into rubygems.org once ready.'
         end
+        
+        def application_model(current_dir_name)
+          model_name = 'Greeting'
+          namespace ||= current_dir_name
+          root_dir = File.exist?('app') ? 'app' : 'lib'
+          parent_dir = "#{root_dir}/#{file_name(namespace)}/model"
+          return puts("The file '#{parent_dir}/#{file_name(model_name)}.rb' already exists. Please either remove or pick a different name.") if File.exist?("#{parent_dir}/#{file_name(model_name)}.rb")
+          mkdir_p parent_dir unless File.exist?(parent_dir)
+          write "#{parent_dir}/#{file_name(model_name)}.rb", model_file(model_name, namespace)
+        end
     
         private
         
@@ -527,7 +538,16 @@ module Glimmer
           window_options[:custom_window_class_name] ||= 'CustomWindow'
           namespace_type = class_name(namespace) == class_name(current_dir_name) ? 'class' : 'module'
     
-          custom_window_file_content = <<-MULTI_LINE_STRING
+          custom_window_file_content = ''
+          
+          if %i[gem app].include?(window_type)
+            custom_window_file_content += <<-MULTI_LINE_STRING
+require '#{current_dir_name}/model/greeting'
+
+            MULTI_LINE_STRING
+          end
+    
+          custom_window_file_content += <<-MULTI_LINE_STRING
 #{namespace_type} #{class_name(namespace)}
   module View
     class #{class_name(custom_window_name)}
@@ -543,15 +563,6 @@ module Glimmer
             MULTI_LINE_STRING
           end
           
-          if %i[gem app].include?(window_type)
-            custom_window_file_content += <<-MULTI_LINE_STRING
-      GREETINGS = [
-        'Hello, World!',
-        'Howdy, Partner!'
-      ]
-            MULTI_LINE_STRING
-          end
-          
           custom_window_file_content += <<-MULTI_LINE_STRING
           
       ## Add options like the following to configure CustomWindow by outside consumers
@@ -561,14 +572,6 @@ module Glimmer
       # option :height, default: 240
           MULTI_LINE_STRING
       
-          if %i[gem app].include?(window_type)
-            custom_window_file_content += <<-MULTI_LINE_STRING
-      
-      # GREETING Array selected index
-      option :greeting_index, default: 0
-            MULTI_LINE_STRING
-          end
-      
           custom_window_file_content += <<-MULTI_LINE_STRING
   
       ## Use before_body block to pre-initialize variables to use in body and
@@ -579,6 +582,8 @@ module Glimmer
           if %i[gem app].include?(window_type)
             custom_window_file_content += <<-MULTI_LINE_STRING
       before_body do
+        @greeting = Model::Greeting.new
+        
         menu('File') {
           menu_item('Preferences...') {
             on_clicked do
@@ -634,7 +639,7 @@ module Glimmer
           margined true
           
           label {
-            text <= [self, :greeting_index, on_read: -> { greeting }]
+            #{%i[gem app].include?(window_type) ? "text <= [@greeting, :text]" : "text '#{human_name(custom_window_name)}'"}
           }
         }
       }
@@ -643,10 +648,6 @@ module Glimmer
           if %i[gem app].include?(window_type)
             custom_window_file_content += <<-MULTI_LINE_STRING
   
-      def greeting
-        GREETINGS[greeting_index]
-      end
-  
       def display_about_dialog
         message = "#{human_name(namespace)}#{" - #{human_name(custom_window_name)}" if window_type == :gem} \#{VERSION}\\n\\n\#{LICENSE}"
         msg_box('About', message)
@@ -674,8 +675,8 @@ module Glimmer
             radio_buttons {
               stretchy false
               
-              items GREETINGS
-              selected <=> [self, :greeting_index]
+              items Model::Greeting::GREETINGS
+              selected <=> [@greeting, :text_index]
             }
           }
         }.show
@@ -790,6 +791,37 @@ end
           MULTI_LINE_STRING
         end
         
+        def model_file(model_name, namespace)
+          namespace_type = class_name(namespace) == class_name(current_dir_name) ? 'class' : 'module'
+    
+          <<-MULTI_LINE_STRING
+#{namespace_type} #{class_name(namespace)}
+  module Model
+    class #{class_name(model_name)}
+      GREETINGS = [
+        'Hello, World!',
+        'Howdy, Partner!'
+      ]
+      
+      attr_accessor :text
+      
+      def initialize
+        @text = GREETINGS.first
+      end
+      
+      def text_index=(new_text_index)
+        self.text = GREETINGS[new_text_index]
+      end
+      
+      def text_index
+        GREETINGS.index(text)
+      end
+    end
+  end
+end
+          MULTI_LINE_STRING
+        end
+        
       end
       
     end

data/lib/glimmer/rake_task.rb

@@ -93,16 +93,16 @@ namespace :glimmer do
     Glimmer::RakeTask::Scaffold.app(args[:app_name])
   end
 
-#   namespace :scaffold do
-#     desc 'Scaffold Glimmer::UI::CustomWindow subclass (full window view) under app/views (namespace is optional) [alt: scaffold:cw]'
-#     task :customwindow, [:name, :namespace] do |t, args|
-#       require_relative 'rake_task/scaffold'
-#       Glimmer::RakeTask::Scaffold.custom_window(args[:name], args[:namespace])
-#     end
-#
-#     task :cw, [:name, :namespace] => :customwindow
-#     task :custom_window, [:name, :namespace] => :customwindow
-#     task :"custom-window", [:name, :namespace] => :customwindow
+  namespace :scaffold do
+    desc 'Scaffold Glimmer::UI::CustomWindow subclass (full window view) under app/views (namespace is optional) [alt: scaffold:cw]'
+    task :customwindow, [:name, :namespace] do |t, args|
+      require_relative 'rake_task/scaffold'
+      Glimmer::RakeTask::Scaffold.custom_window(args[:name], args[:namespace])
+    end
+
+    task :cw, [:name, :namespace] => :customwindow
+    task :custom_window, [:name, :namespace] => :customwindow
+    task :"custom-window", [:name, :namespace] => :customwindow
 #
 #     desc 'Scaffold Glimmer::UI::CustomControl subclass (part of a view) under app/views (namespace is optional) [alt: scaffold:cc]'
 #     task :customcontrol, [:name, :namespace] do |t, args|
@@ -159,7 +159,7 @@ namespace :glimmer do
 #     task :custom_window_gem, [:name, :namespace] => 'gem:customwindow'
 #     task :custom_control_gem, [:name, :namespace] => 'gem:customcontrol'
 #     task :custom_shape_gem, [:name, :namespace] => 'gem:customshape'
-#   end
+  end
   
   namespace :list do
     task :list_require do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-20 00:00:00.000000000 Z
+date: 2023-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer