glimmer-dsl-libui 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 722844f182b70508ed2e98484db762ea72297e7e9634042b2d888ca5b8c65f99
-  data.tar.gz: 88e9f08337452b1d59b90a54f30f489c0acc02154f2b57991de7c5d08c1347fa
+  metadata.gz: 06c9ed7f6b104ec0f5a034ee6f74fa2398de9b1d11ffea2e2d1448f07e2c7e43
+  data.tar.gz: 48591881860e3317e2e79a88840fcb0b51d093ba017e0b74dc45e8382ead00b3
 SHA512:
-  metadata.gz: cad7f6be9a53386679ff80bfbb0c763428e003dcbf07f812c3d76b4f0dc581239d6e376b2e70bef030bbe1ff64554dae4fc3be55e9618c8dda6bf8a72da51752
-  data.tar.gz: 34a2ef4fa8f372dd69e9de1f768197118a5c30fcc140f178d39285fd75326db7f2f8b76fe9faf8812c3f862d8652d931580124fd252147466f4c5fb3600e8c3f
+  metadata.gz: d17b5b51140d69186f2237efffdce6a9e65ec675e568fcb96c911593cb934392ad423da0ea64e75573ef5d657f3690b87a3bca9723e04ca103922b98204e24a1
+  data.tar.gz: 658eb9d2fa4b00a7c4edbb85ef42dbbb3b81f04e4c16e3ccd93715e252a726317bd6fec59081047d6b6698bfb38ab8594413afee6638eccc2373ccb0a8830fcd

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # Change Log
 
+## 0.9.6
+
+- Scaffold Custom Window Gem via `glimmer scaffold:gem:customwindow[name,namespace]` (or alias: `glimmer scaffold:gem:cw[name,namespace]`)
+- List Custom Window Gems (expected name format: `glimmer-libui-cw-gemname-namespace`) via `glimmer list:gems:customwindow[query]` (or alias: `glimmer list:gems:cw[query]`)
+- List Glimmer DSLs via `glimmer list:gems:dsl[query]`
+
 ## 0.9.5
 
-- Scaffold Custom Control via `glimmer scaffold:customcontrol[name,namespace]`
+- Scaffold Custom Control via `glimmer scaffold:customcontrol[name,namespace]` (or alias: `glimmer scaffold:cc[name,namespace]`)
 
 ## 0.9.4
 
-- Scaffold Custom Window via `glimmer scaffold:customwindow[name,namespace]`
+- Scaffold Custom Window via `glimmer scaffold:customwindow[name,namespace]` (or alias: `glimmer scaffold:cw[name,namespace]`)
 
 ## 0.9.3
 

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.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.9.6
 ## 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)
@@ -353,6 +353,9 @@ Learn more about the differences between various [Glimmer](https://github.com/An
     - [Scaffold Application](#scaffold-application)
     - [Scaffold Custom Window](#scaffold-custom-window)
     - [Scaffold Custom Control](#scaffold-custom-control)
+    - [Scaffold Custom Window Gem](#scaffold-custom-window-gem)
+    - [List Custom Window Gems](#list-custom-window-gems)
+    - [List Glimmer DSLs](#list-glimmer-dsls)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [API](#api)
@@ -423,7 +426,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.9.5'
+gem 'glimmer-dsl-libui', '~> 0.9.6'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -739,9 +742,9 @@ When you are in a scaffolded application, you can scaffold a new custom window (
 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 `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).
+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`:
 
@@ -891,9 +894,9 @@ When you are in a scaffolded application, you can scaffold a new custom control
 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 `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).
+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`:
 
@@ -1071,6 +1074,94 @@ window {
 }
 ```
 
+### Scaffold Custom Window Gem
+
+You can scaffold a Ruby gem around a reusable Custom Window by running this command:
+
+```
+glimmer scaffold:gem:customwindow[name,namespace]
+```
+
+That will generate a custom window gem project under the naming convention: `glimmer-libui-cw-name-namespace`
+
+The naming convention helps with discoverability of Ruby gems using the command `glimmer list:gems:customwindow[query]` (or alias: `glimmer list:gems:cw[query]`) where filtering `query` is optional.
+
+The `name` is the custom window class name, which must not contain dashes by convention (multiple words can be concatenated or can use underscores between them).
+
+The `namespace` is needed to avoid clashing with other custom window gems that other software engineers might have thought of. It is recommended not to include dashes between words in it by convention yet concatenated words or underscores between them.
+
+Here is a shorter alias for the custom window gem scaffolding command:
+
+```
+glimmer scaffold:gem:cw[name,namespace]
+```
+
+You can package the newly scaffolded project as a Ruby gem by running this command:
+
+```
+glimmer package:gem
+```
+
+Or by using the raw rake command:
+
+```
+rake build
+```
+
+You can generate the application gemspec explicitly if needed with this command (though it is not needed to build the gem):
+
+```
+glimmer package:gemspec
+```
+
+Or by using the raw rake command:
+
+```
+rake gemspec:generate
+```
+
+The project optionally allows you to run the custom window as its own separate app with a binary script (`bin/gem_name`) to see it, which helps with prototyping it.
+
+But, typically consumers of the gem would include it in their own project, which makes the gem keyword available in the Glimmer GUI DSL where `Glimmer`. `Glimmer::LibUI::Application`, `Glimmer::LibUI::CustomWindow`, or `Glimmer::LibUI::CustomControl` is mixed.
+
+For example:
+
+```ruby
+require 'glimmer-libui-cw-greeter-acme'
+
+...
+greeter.show
+...
+```
+
+### List Custom Window Gems
+
+Custom window gems are scaffolded to follow the naming convention: `glimmer-libui-cw-name-namespace`
+
+The naming convention helps with discoverability of Ruby gems using the command:
+
+```
+glimmer list:gems:customwindow[query]
+```
+
+Or by using the shorter alias:
+
+```
+glimmer list:gems:cw[query]
+```
+
+The filtering `query` is optional.
+
+### List Glimmer DSLs
+
+Glimmer DSLs can be listed with this command:
+
+```
+glimmer list:gems:dsl[query]
+```
+
+The filtering `query` is optional.
+
 ## 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.5
+0.9.6

data/lib/glimmer/rake_task/list.rb

@@ -30,25 +30,25 @@ module Glimmer
         REGEX_GEM_LINE = /^([^\(]+) \(([^\)]+)\)$/
         
         def custom_control_gems(query=nil)
-          list_gems('glimmer-cw-', query) do |result|
+          list_gems('glimmer-libui-cc-', query) do |result|
             puts
-            puts "  Glimmer Custom Control Gems#{" matching [#{query}]" if query} at rubygems.org:"
+            puts "  Glimmer DSL for LibUI Custom Control Gems#{" matching [#{query}]" if query} at rubygems.org:"
             puts result
           end
         end
 
         def custom_window_gems(query=nil)
-          list_gems('glimmer-cs-', query) do |result|
+          list_gems('glimmer-libui-cw-', query) do |result|
             puts
-            puts "  Glimmer Custom Window Gems#{" matching [#{query}]" if query} at rubygems.org:"
+            puts "  Glimmer DSL for LibUI Custom Window Gems#{" matching [#{query}]" if query} at rubygems.org:"
             puts result
           end
         end
 
         def custom_shape_gems(query=nil)
-          list_gems('glimmer-cp-', query) do |result|
+          list_gems('glimmer-libui-cs-', query) do |result|
             puts
-            puts "  Glimmer Custom Shape Gems#{" matching [#{query}]" if query} at rubygems.org:"
+            puts "  Glimmer DSL for LibUI Custom Shape Gems#{" matching [#{query}]" if query} at rubygems.org:"
             puts result
           end
         end

data/lib/glimmer/rake_task/scaffold.rb

@@ -219,7 +219,7 @@ module Glimmer
         end
     
         def custom_window_gem(custom_window_name, namespace)
-          gem_name = "glimmer-cs-#{compact_name(custom_window_name)}"
+          gem_name = "glimmer-libui-cw-#{compact_name(custom_window_name)}"
           gem_summary = "#{human_name(custom_window_name)} - Glimmer Custom Window"
           begin
             custom_window_keyword = dsl_control_name(custom_window_name)
@@ -249,6 +249,7 @@ module Glimmer
           write 'Rakefile', gem_rakefile(custom_window_name, namespace, gem_name)
           append "lib/#{gem_name}.rb", gem_main_file(custom_window_name, namespace)
           custom_window(custom_window_name, namespace, :gem)
+          app_model(current_dir_name, namespace)
           
           mkdir_p "lib/#{gem_name}"
           write "lib/#{gem_name}/launch.rb", gem_launch_file(gem_name, custom_window_name, namespace)
@@ -291,7 +292,7 @@ module Glimmer
         end
     
         def custom_control_gem(custom_control_name, namespace)
-          gem_name = "glimmer-cw-#{compact_name(custom_control_name)}"
+          gem_name = "glimmer-libui-cc-#{compact_name(custom_control_name)}"
           gem_summary = "#{human_name(custom_control_name)} - Glimmer Custom Control"
           if namespace
             gem_name += "-#{compact_name(namespace)}"
@@ -330,7 +331,7 @@ module Glimmer
         end
     
         def custom_shape_gem(custom_shape_name, namespace)
-          gem_name = "glimmer-cp-#{compact_name(custom_shape_name)}"
+          gem_name = "glimmer-libui-cs-#{compact_name(custom_shape_name)}"
           gem_summary = "#{human_name(custom_shape_name)} - Glimmer Custom Shape"
           if namespace
             gem_name += "-#{compact_name(namespace)}"
@@ -368,7 +369,7 @@ module Glimmer
           puts 'Run `rake release` to release into rubygems.org once ready.'
         end
         
-        def app_model(current_dir_name)
+        def app_model(current_dir_name, namespace = nil)
           model_name = 'Greeting'
           namespace ||= current_dir_name
           root_dir = File.exist?('app') ? 'app' : 'lib'
@@ -542,7 +543,7 @@ module Glimmer
           
           if %i[gem app].include?(window_type)
             custom_window_file_content += <<-MULTI_LINE_STRING
-require '#{current_dir_name}/model/greeting'
+require '#{window_type == :app ? current_dir_name : namespace}/model/greeting'
 
             MULTI_LINE_STRING
           end
@@ -579,7 +580,7 @@ require '#{current_dir_name}/model/greeting'
       #
           MULTI_LINE_STRING
           
-          if %i[gem app].include?(window_type)
+          if window_type == :app
             custom_window_file_content += <<-MULTI_LINE_STRING
       before_body do
         @greeting = Model::Greeting.new
@@ -609,6 +610,12 @@ require '#{current_dir_name}/model/greeting'
             end
           }
         }
+      end
+            MULTI_LINE_STRING
+          elsif window_type == :gem
+            custom_window_file_content += <<-MULTI_LINE_STRING
+      before_body do
+        @greeting = Model::Greeting.new
       end
             MULTI_LINE_STRING
           else
@@ -638,12 +645,30 @@ require '#{current_dir_name}/model/greeting'
           
           margined true
           
-          label {
-            #{%i[gem app].include?(window_type) ? "text <= [@greeting, :text]" : "text '#{human_name(custom_window_name)}'"}
+          vertical_box {
+          MULTI_LINE_STRING
+          
+          if window_type == :gem
+            custom_window_file_content += <<-MULTI_LINE_STRING
+            
+            button('Preferences...') {
+              stretchy false
+              
+              on_clicked do
+                display_preferences_dialog
+              end
+            }
+            MULTI_LINE_STRING
+          end
+          
+          custom_window_file_content += <<-MULTI_LINE_STRING
+            label {
+              #{%i[gem app].include?(window_type) ? "text <= [@greeting, :text]" : "text '#{human_name(custom_window_name)}'"}
+            }
           }
         }
       }
-            MULTI_LINE_STRING
+          MULTI_LINE_STRING
           
           if %i[gem app].include?(window_type)
             custom_window_file_content += <<-MULTI_LINE_STRING

data/lib/glimmer/rake_task.rb

@@ -124,16 +124,16 @@ namespace :glimmer do
 #     task :custom_shape, [:name, :namespace] => :customshape
 #     task :"custom-shape", [:name, :namespace] => :customshape
 #
-#     namespace :gem do
-#       desc 'Scaffold Glimmer::UI::CustomWindow subclass (full window view) under its own Ruby gem + app project (namespace is required) [alt: scaffold:gem:cw]'
-#       task :customwindow, [:name, :namespace] do |t, args|
-#         require_relative 'rake_task/scaffold'
-#         Glimmer::RakeTask::Scaffold.custom_window_gem(args[:name], args[:namespace])
-#       end
-#
-#       task :cw, [:name, :namespace] => :customwindow
-#       task :custom_window, [:name, :namespace] => :customwindow
-#       task :"custom-window", [:name, :namespace] => :customwindow
+    namespace :gem do
+      desc 'Scaffold Glimmer::UI::CustomWindow subclass (full window view) under its own Ruby gem + app project (namespace is required) [alt: scaffold:gem:cw]'
+      task :customwindow, [:name, :namespace] do |t, args|
+        require_relative 'rake_task/scaffold'
+        Glimmer::RakeTask::Scaffold.custom_window_gem(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 its own Ruby gem project (namespace is required) [alt: scaffold:gem:cc]'
 #       task :customcontrol, [:name, :namespace] do |t, args|
@@ -154,11 +154,7 @@ namespace :glimmer do
 #       task :cs, [:name, :namespace] => :customshape
 #       task :custom_shape, [:name, :namespace] => :customshape
 #       task :"custom-shape", [:name, :namespace] => :customshape
-#     end
-#
-#     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
@@ -198,13 +194,6 @@ namespace :glimmer do
       task :dsl, [:query] => :list_require do |t, args|
         Glimmer::RakeTask::List.dsl_gems(args[:query])
       end
-    
     end
-    
-    # legacy support
-    
-    task :custom_window_gems, [:name, :namespace] => 'gems:customwindow'
-    task :custom_control_gems, [:name, :namespace] => 'gems:customcontrol'
-    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Andy Maleh