glimmer-dsl-libui 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06c9ed7f6b104ec0f5a034ee6f74fa2398de9b1d11ffea2e2d1448f07e2c7e43
-  data.tar.gz: 48591881860e3317e2e79a88840fcb0b51d093ba017e0b74dc45e8382ead00b3
+  metadata.gz: c75651f571b0d519f08be54f306fcfdcecddc44e6f475d15051bedcaa0114e76
+  data.tar.gz: 31cf1d94b0273e0a564fa873479ea89aee0c46de4436f7cd2b985e6fce0d715e
 SHA512:
-  metadata.gz: d17b5b51140d69186f2237efffdce6a9e65ec675e568fcb96c911593cb934392ad423da0ea64e75573ef5d657f3690b87a3bca9723e04ca103922b98204e24a1
-  data.tar.gz: 658eb9d2fa4b00a7c4edbb85ef42dbbb3b81f04e4c16e3ccd93715e252a726317bd6fec59081047d6b6698bfb38ab8594413afee6638eccc2373ccb0a8830fcd
+  metadata.gz: 79842463d4788be8d50a6d6b203e50a28ac483d6333fcdf934955ba91e32fd51e4aa3f3b654924657c5e28defe128f36b0d26effb6ed5579fc3049d2f3fdc8cb
+  data.tar.gz: bb2269219236e14c13ad486ac8ae75dc501654eda0ca955bdb2ae6d41772354112f9ed160882472f79bace06adda838338c04d47cf77870e8a8be36cfb610f7a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.9.7
+
+- Scaffold Custom Control Gem via `glimmer scaffold:gem:customcontrol[name,namespace]` (or alias: `glimmer scaffold:gem:cc[name,namespace]`)
+- List Custom Control Gems (expected name format: `glimmer-libui-cc-gemname-namespace`) via `glimmer list:gems:customcontrol[query]` (or alias: `glimmer list:gems:cc[query]`)
+
 ## 0.9.6
 
 - Scaffold Custom Window Gem via `glimmer scaffold:gem:customwindow[name,namespace]` (or alias: `glimmer scaffold:gem:cw[name,namespace]`)

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.6
+# [<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.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)
@@ -354,7 +354,9 @@ Learn more about the differences between various [Glimmer](https://github.com/An
     - [Scaffold Custom Window](#scaffold-custom-window)
     - [Scaffold Custom Control](#scaffold-custom-control)
     - [Scaffold Custom Window Gem](#scaffold-custom-window-gem)
+    - [Scaffold Custom Control Gem](#scaffold-custom-control-gem)
     - [List Custom Window Gems](#list-custom-window-gems)
+    - [List Custom Control Gems](#list-custom-control-gems)
     - [List Glimmer DSLs](#list-glimmer-dsls)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
@@ -426,7 +428,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.9.6'
+gem 'glimmer-dsl-libui', '~> 0.9.7'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -1076,7 +1078,7 @@ window {
 
 ### Scaffold Custom Window Gem
 
-You can scaffold a Ruby gem around a reusable Custom Window by running this command:
+You can scaffold a Ruby gem around a reusable custom window by running this command:
 
 ```
 glimmer scaffold:gem:customwindow[name,namespace]
@@ -1122,7 +1124,7 @@ 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.
+But, typically consumers of the gem would include it in their own project, which makes the gem keyword available in the Glimmer GUI DSL anywhere `Glimmer`. `Glimmer::LibUI::Application`, `Glimmer::LibUI::CustomWindow`, or `Glimmer::LibUI::CustomControl` is mixed.
 
 For example:
 
@@ -1134,6 +1136,70 @@ greeter.show
 ...
 ```
 
+### Scaffold Custom Control Gem
+
+You can scaffold a Ruby gem around a reusable custom control by running this command:
+
+```
+glimmer scaffold:gem:customcontrol[name,namespace]
+```
+
+That will generate a custom control gem project under the naming convention: `glimmer-libui-cc-name-namespace`
+
+The naming convention helps with discoverability of Ruby gems using the command `glimmer list:gems:customcontrol[query]` (or alias: `glimmer list:gems:cc[query]`) where filtering `query` is optional.
+
+The `name` is the custom control 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 control 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 control gem scaffolding command:
+
+```
+glimmer scaffold:gem:cc[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
+```
+
+Typically, consumers of the gem would include it in their own project, which makes the gem keyword available in the Glimmer GUI DSL anywhere `Glimmer`. `Glimmer::LibUI::Application`, `Glimmer::LibUI::CustomWindow`, or `Glimmer::LibUI::CustomControl` is mixed.
+
+For example:
+
+```ruby
+require 'glimmer-libui-cc-model_form-acme'
+
+...
+window {
+  vertical_box {
+    label('Form:')
+    
+    model_form(model: some_model, attributes: some_attributes)
+  }
+}
+...
+```
+
 ### List Custom Window Gems
 
 Custom window gems are scaffolded to follow the naming convention: `glimmer-libui-cw-name-namespace`
@@ -1152,6 +1218,25 @@ glimmer list:gems:cw[query]
 
 The filtering `query` is optional.
 
+
+### List Custom Control Gems
+
+Custom control 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:customcontrol[query]
+```
+
+Or by using the shorter alias:
+
+```
+glimmer list:gems:cc[query]
+```
+
+The filtering `query` is optional.
+
 ### List Glimmer DSLs
 
 Glimmer DSLs can be listed with this command:

data/VERSION

@@ -1 +1 @@
-0.9.6
+0.9.7

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-libui-cw-#{compact_name(custom_window_name)}"
+          gem_name = "glimmer-libui-cw-#{custom_window_name.underscore}"
           gem_summary = "#{human_name(custom_window_name)} - Glimmer Custom Window"
           begin
             custom_window_keyword = dsl_control_name(custom_window_name)
@@ -229,7 +229,7 @@ module Glimmer
             # No Op (keyword is not taken by a built in Ruby method)
           end
           if namespace
-            gem_name += "-#{compact_name(namespace)}"
+            gem_name += "-#{namespace.underscore}"
             gem_summary += " (#{human_name(namespace)})"
           else
             return puts('Namespace is required! Usage: glimmer scaffold:gem:customwindow[name,namespace]') unless `git config --get github.user`.to_s.strip == 'AndyObtiva'
@@ -292,10 +292,10 @@ module Glimmer
         end
     
         def custom_control_gem(custom_control_name, namespace)
-          gem_name = "glimmer-libui-cc-#{compact_name(custom_control_name)}"
+          gem_name = "glimmer-libui-cc-#{custom_control_name.underscore}"
           gem_summary = "#{human_name(custom_control_name)} - Glimmer Custom Control"
           if namespace
-            gem_name += "-#{compact_name(namespace)}"
+            gem_name += "-#{namespace.underscore}"
             gem_summary += " (#{human_name(namespace)})"
           else
             return puts('Namespace is required! Usage: glimmer scaffold:custom_control_gem[custom_control_name,namespace]') unless `git config --get github.user`.to_s.strip == 'AndyObtiva'
@@ -331,10 +331,10 @@ module Glimmer
         end
     
         def custom_shape_gem(custom_shape_name, namespace)
-          gem_name = "glimmer-libui-cs-#{compact_name(custom_shape_name)}"
+          gem_name = "glimmer-libui-cs-#{custom_shape_name.underscore}"
           gem_summary = "#{human_name(custom_shape_name)} - Glimmer Custom Shape"
           if namespace
-            gem_name += "-#{compact_name(namespace)}"
+            gem_name += "-#{namespace.underscore}"
             gem_summary += " (#{human_name(namespace)})"
           else
             return puts('Namespace is required! Usage: glimmer scaffold:custom_shape_gem[custom_shape_name,namespace]') unless `git config --get github.user`.to_s.strip == 'AndyObtiva'
@@ -414,10 +414,6 @@ module Glimmer
           app_name.underscore.titlecase
         end
     
-        def compact_name(gem_name)
-          gem_name.underscore.camelcase.downcase
-        end
-        
         def gemfile(window_type)
           APP_GEMFILE
         end
@@ -645,12 +641,11 @@ require '#{window_type == :app ? current_dir_name : namespace}/model/greeting'
           
           margined true
           
-          vertical_box {
           MULTI_LINE_STRING
           
           if window_type == :gem
             custom_window_file_content += <<-MULTI_LINE_STRING
-            
+          vertical_box {
             button('Preferences...') {
               stretchy false
               
@@ -658,14 +653,21 @@ require '#{window_type == :app ? current_dir_name : namespace}/model/greeting'
                 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
+          else
+            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
+          end
+          
+          custom_window_file_content += <<-MULTI_LINE_STRING
         }
       }
           MULTI_LINE_STRING

data/lib/glimmer/rake_task.rb

@@ -113,7 +113,7 @@ namespace :glimmer do
     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|
 #       require_relative 'rake_task/scaffold'
@@ -123,7 +123,7 @@ namespace :glimmer do
 #     task :cs, [:name, :namespace] => :customshape
 #     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|
@@ -134,17 +134,17 @@ namespace :glimmer do
       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|
-#         require_relative 'rake_task/scaffold'
-#         Glimmer::RakeTask::Scaffold.custom_control_gem(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::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|
+        require_relative 'rake_task/scaffold'
+        Glimmer::RakeTask::Scaffold.custom_control_gem(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 its own Ruby gem project (namespace is required) [alt: scaffold:gem:cs]'
 #       task :customshape, [:name, :namespace] do |t, args|
 #         require_relative 'rake_task/scaffold'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Andy Maleh
@@ -353,8 +353,9 @@ description: Glimmer DSL for LibUI (Fukuoka Award Winning Prerequisite-Free Ruby
   GUI that just works on Mac, Windows, and Linux! Glimmer DSL for LibUI aims to provide
   declarative DSL syntax that visually maps to GUI control hierarchy, convention over
   configuration via smart defaults, automation of low-level details, requiring the
-  least amount of syntax possible to build GUI, bidirectional data-binding, and custom
-  keyword support. If you liked Shoes, You'll love Glimmer!
+  least amount of syntax possible to build GUI, bidirectional data-binding, custom
+  control/window support, and application/gem/window/control scaffolding. If you liked
+  Shoes, You'll love Glimmer!
 email: andy.am@gmail.com
 executables:
 - glimmer