glimmer-dsl-libui 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fd65bf048edb4ec2556097bcbbe82b2dd2c1411e6a2c81d592901a40fdcf0f
-  data.tar.gz: 4e48a01e498afdf21fc72a82891106e8198360eeea971f98663e585b6c2ba6d1
+  metadata.gz: 722844f182b70508ed2e98484db762ea72297e7e9634042b2d888ca5b8c65f99
+  data.tar.gz: 88e9f08337452b1d59b90a54f30f489c0acc02154f2b57991de7c5d08c1347fa
 SHA512:
-  metadata.gz: 45492206e1c62e3daf5199a6551029300a8f73a8fdf1cf40b38a3efdaddc49f8b123c18ae61c2b233ed2c19272aa9661c35043b2adccc2cc4f487f004486e8a1
-  data.tar.gz: 0c2b32d5c933da94e99f07926491d1423b29e36b91ad8e2a207472d5235d199a7761f9d768ce7a4eea02287515837aa4c35c0aeb6ed9b1d5c21d387fd796e9c6
+  metadata.gz: cad7f6be9a53386679ff80bfbb0c763428e003dcbf07f812c3d76b4f0dc581239d6e376b2e70bef030bbe1ff64554dae4fc3be55e9618c8dda6bf8a72da51752
+  data.tar.gz: 34a2ef4fa8f372dd69e9de1f768197118a5c30fcc140f178d39285fd75326db7f2f8b76fe9faf8812c3f862d8652d931580124fd252147466f4c5fb3600e8c3f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 0.9.5
+
+- Scaffold Custom Control via `glimmer scaffold:customcontrol[name,namespace]`
+
+## 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

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.3
+# [<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.5
 ## 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)
@@ -28,7 +28,7 @@ The main trade-off in using [Glimmer DSL for LibUI](https://rubygems.org/gems/gl
 - Requiring the [least amount of syntax](#glimmer-gui-dsl-concepts) possible to build GUI
 - [Custom Control](#custom-keywords) support
 - [Bidirectional/Unidirectional Data-Binding](#data-binding) to declaratively wire and automatically synchronize GUI Views with Models
-- [Scaffolding](scaffold-application) for new custom controls, apps, and gems
+- [Scaffolding](#scaffold-application) for new custom windows/controls, apps, and gems
 - [Far Future Plan] Native-Executable packaging on Mac, Windows, and Linux.
 
 Hello, World!
@@ -351,6 +351,8 @@ 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)
+    - [Scaffold Custom Control](#scaffold-custom-control)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [API](#api)
@@ -421,7 +423,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.9.3'
+gem 'glimmer-dsl-libui', '~> 0.9.5'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -625,7 +627,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:
 
@@ -659,6 +661,16 @@ 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:
 
 ```
@@ -679,12 +691,6 @@ 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)
-
-![glimmer-dsl-libui-mac-scaffold-app-about.png](images/glimmer-dsl-libui-mac-scaffold-app-about.png)
-
 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:
@@ -725,6 +731,346 @@ 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 (e.g. `require 'hello_world/view/greeting_window'`), 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 in another view (e.g. `require 'station/view/train'`), 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
+```
+
+### Scaffold Custom Control
+
+When you are in a scaffolded application, you can scaffold a new custom control (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]
+```
+
+The name represents the custom control view class name (it can be underscored, and Glimmer will automatically classify it).
+
+The namespace is optional and represents the module that the custom control 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 `cc` alias for `customcontrol`:
+
+```
+glimmer scaffold:cc[name,namespace]
+```
+
+For example by running this command under a `hello_world` application:
+
+```
+glimmer scaffold:cw[model_form]
+```
+
+That will generate this class under `app/hello_world/view/model_form`:
+
+```ruby
+class HelloWorld
+  module View
+    class ModelForm
+      include Glimmer::LibUI::CustomControl
+  
+      ## Add options like the following to configure CustomControl by outside consumers
+      #
+      # options :custom_text, :background_color
+      # option :foreground_color, default: :red
+      
+      # Replace example options with your own options
+      option :model
+      option :attributes
+  
+      ## Use before_body block to pre-initialize variables to use in body
+      #
+      #
+      before_body do
+        # Replace example code with your own before_body code
+        default_model_attributes = [:first_name, :last_name, :email]
+        default_model_class = Struct.new(*default_model_attributes)
+        self.model ||= default_model_class.new
+        self.attributes ||= default_model_attributes
+      end
+  
+      ## Use after_body block to setup observers for controls in body
+      #
+      # after_body do
+      #
+      # end
+  
+      ## Add control content under custom control body
+      ##
+      ## If you want to add a window as the top-most control,
+      ## consider creating a custom window instead
+      ## (Glimmer::LibUI::CustomWindow offers window convenience methods, like show and hide)
+      #
+      body {
+        # Replace example content (model_form custom control) with your own custom control content.
+        form {
+          attributes.each do |attribute|
+            entry { |e|
+              label attribute.to_s.underscore.split('_').map(&:capitalize).join(' ')
+              text <=> [model, attribute]
+            }
+          end
+        }
+      }
+  
+    end
+  end
+end
+```
+
+When the generated file is required in another view (e.g. `require 'hello_world/view/model_form'`), the custom control keyword `model_form` become available and reusable, like by calling:
+
+```ruby
+window {
+  vertical_box {
+    label('Form:')
+    model_form(model: some_model, attributes: array_of_attributes)
+  }
+}
+```
+
+Here is an example that generates a custom control with a namespace:
+
+```
+glimmer scaffold:cw[model_form,common]
+```
+
+That will generate this class under `app/common/view/model_form`:
+
+```ruby
+module Common
+  module View
+    class ModelForm
+      include Glimmer::LibUI::CustomControl
+  
+      ## Add options like the following to configure CustomControl by outside consumers
+      #
+      # options :custom_text, :background_color
+      # option :foreground_color, default: :red
+      
+      # Replace example options with your own options
+      option :model
+      option :attributes
+  
+      ## Use before_body block to pre-initialize variables to use in body
+      #
+      #
+      before_body do
+        # Replace example code with your own before_body code
+        default_model_attributes = [:first_name, :last_name, :email]
+        default_model_class = Struct.new(*default_model_attributes)
+        self.model ||= default_model_class.new
+        self.attributes ||= default_model_attributes
+      end
+  
+      ## Use after_body block to setup observers for controls in body
+      #
+      # after_body do
+      #
+      # end
+  
+      ## Add control content under custom control body
+      ##
+      ## If you want to add a window as the top-most control,
+      ## consider creating a custom window instead
+      ## (Glimmer::LibUI::CustomWindow offers window convenience methods, like show and hide)
+      #
+      body {
+        # Replace example content (model_form custom control) with your own custom control content.
+        form {
+          attributes.each do |attribute|
+            entry { |e|
+              label attribute.to_s.underscore.split('_').map(&:capitalize).join(' ')
+              text <=> [model, attribute]
+            }
+          end
+        }
+      }
+  
+    end
+  end
+end
+```
+
+When that file is required in another view (e.g. `require 'common/view/model_form'`), the `model_form` keyword becomes available:
+
+```ruby
+window {
+  vertical_box {
+    label('Form:')
+    model_form(model: some_model, attributes: array_of_attributes)
+  }
+}
+```
+
+If for whatever reason, you end up with 2 custom control views having the same name with different namespaces, then you can invoke the specific custom control you want by including the Ruby namespace in underscored format separated by double-underscores:
+
+```ruby
+window {
+  vertical_box {
+    label('Form:')
+    common__view__model_form(model: some_model, attributes: array_of_attributes)
+  }
+}
+```
+
+Or another `model_form` custom control view:
+
+```ruby
+window {
+  vertical_box {
+    label('Form:')
+    hello_world__view__model_form(model: some_model, attributes: array_of_attributes)
+  }
+}
+```
+
 ## 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.3
+0.9.5

data/lib/glimmer/rake_task/scaffold.rb

@@ -155,7 +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)
+          app_model(current_dir_name)
             
           mkdir_p 'icons/windows'
           icon_file = "icons/windows/#{human_name(app_name)}.ico"
@@ -368,7 +368,7 @@ module Glimmer
           puts 'Run `rake release` to release into rubygems.org once ready.'
         end
         
-        def application_model(current_dir_name)
+        def app_model(current_dir_name)
           model_name = 'Greeting'
           namespace ||= current_dir_name
           root_dir = File.exist?('app') ? 'app' : 'lib'
@@ -639,7 +639,7 @@ require '#{current_dir_name}/model/greeting'
           margined true
           
           label {
-            text <= [@greeting, :text]
+            #{%i[gem app].include?(window_type) ? "text <= [@greeting, :text]" : "text '#{human_name(custom_window_name)}'"}
           }
         }
       }
@@ -704,13 +704,21 @@ end
       #
       # options :custom_text, :background_color
       # option :foreground_color, default: :red
+      
+      # Replace example options with your own options
+      option :model
+      option :attributes
   
       ## Use before_body block to pre-initialize variables to use in body
       #
       #
-      # before_body do
-      #
-      # end
+      before_body do
+        # Replace example code with your own before_body code
+        default_model_attributes = [:first_name, :last_name, :email]
+        default_model_class = Struct.new(*default_model_attributes)
+        self.model ||= default_model_class.new
+        self.attributes ||= default_model_attributes
+      end
   
       ## Use after_body block to setup observers for controls in body
       #
@@ -725,9 +733,14 @@ end
       ## (Glimmer::LibUI::CustomWindow offers window convenience methods, like show and hide)
       #
       body {
-        # Replace example content below with custom control content
-        label {
-          background :red
+        # Replace example content (model_form custom control) with your own custom control content.
+        form {
+          attributes.each do |attribute|
+            entry { |e|
+              label attribute.to_s.underscore.split('_').map(&:capitalize).join(' ')
+              text <=> [model, attribute]
+            }
+          end
         }
       }
   

data/lib/glimmer/rake_task.rb

@@ -93,26 +93,26 @@ 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
-#
-#     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|
-#       require_relative 'rake_task/scaffold'
-#       Glimmer::RakeTask::Scaffold.custom_control(args[:name], args[:namespace])
-#     end
-#
-#     task :cc, [:name, :namespace] => :customcontrol
-#     task :custom_control, [:name, :namespace] => :customcontrol
-#     task :"custom-control", [:name, :namespace] => :customcontrol
+  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|
+      require_relative 'rake_task/scaffold'
+      Glimmer::RakeTask::Scaffold.custom_control(args[:name], args[:namespace])
+    end
+
+    task :cc, [:name, :namespace] => :customcontrol
+    task :custom_control, [:name, :namespace] => :customcontrol
+    task :"custom-control", [:name, :namespace] => :customcontrol
 #
 #     desc 'Scaffold Glimmer::UI::CustomShape subclass (part of a view) under app/views (namespace is optional) [alt: scaffold:cs]'
 #     task :customshape, [: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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Andy Maleh