glimmer-dsl-libui 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e8beebaf4e3c91450a4ae20b619b63a6303e67c82ae6a678f5f509f69a4310c
-  data.tar.gz: c2a4f231d85faf7a70fbc96572458b53007b1cd3865f2fe330fca379fd379c74
+  metadata.gz: c3ad3f4e1a2e367a8e95fba05f1b539f2aa865dfab7e2234541933be97dda171
+  data.tar.gz: 44255036ce4a887224c84f861d0654483bada4ff8ed3c2a1c4192083a19cf45b
 SHA512:
-  metadata.gz: ec4010baf04afde8b8c2312c081af0ae748748869ee19dbdf1bb5ea92d627abbd5d89d87db8a135ba158b56fc4bb28291f2e572e728aaad728c3ca43dcfe5ed2
-  data.tar.gz: b4e2c8f38655b60b35a12fd55a634ef706c838a28d622677f86159c931b2ef548f744cf804b26b11d0a696b8fa2a6e4d44fa5118582af44814dee8b3db15a435
+  metadata.gz: e018c132e8b838ce839adeaae9d812d52ab8be960b87a8d3e5c85cf8045d988b83495640fb4bef7cb778960d2f25b7da8fcf4d659bd8ada7ed8277d26cc9ff9f
+  data.tar.gz: 3fb97e3a7946c9690c0bd48fdbee89d65f99833b11bd9b033c21b099e51f394b98d1aa96c4c51b9e0445c309a5b28f4f272c53174617e20b4e578dc602338c5a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 0.9.2
+
+- Add `glimmer` commands `glimmer package:gem`, `glimmer package:gemspec`, and `glimmer package:clean`
+
+## 0.9.1
+
+- Scaffold an application via Glimmer Command: `glimmer scaffold[app_name]`
+- Hide unsupported Scaffolding tasks in Glimmer Command
+- Add missing Glimmer Command gem dependencies: `rake`, `rake-tui`, `text-table`, `puts_debuggerer`
+
 ## 0.9.0
 
 - Support `glimmer` command to more conveniently run applications (`glimmer app_path`) and examples (`glimmer examples`)

data/README.md

@@ -1,5 +1,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 ([Fukuoka Award Winning](http://www.digitalfukuoka.jp/topics/187?locale=ja))
-## Prerequisite-Free Ruby Desktop Development Cross-Platform Native GUI Library
+# [<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
+## 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)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -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
-- [Far Future Plan] Scaffolding for new custom controls, apps, and gems
+- [Scaffolding](scaffold-application) for new custom controls, apps, and gems
 - [Far Future Plan] Native-Executable packaging on Mac, Windows, and Linux.
 
 Hello, World!
@@ -347,6 +347,10 @@ Learn more about the differences between various [Glimmer](https://github.com/An
     - [Experimentation Usage](#experimentation-usage)
     - [Prototyping Usage](#prototyping-usage)
     - [Serious Usage](#serious-usage)
+  - [Glimmer Command](#glimmer-command)
+    - [Run Application](#run-application)
+    - [Run Examples](#run-examples)
+    - [Scaffold Application](#scaffold-application)
   - [Girb (Glimmer IRB)](#girb-glimmer-irb)
   - [Glimmer GUI DSL Concepts](#glimmer-gui-dsl-concepts)
   - [API](#api)
@@ -417,7 +421,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.9.0'
+gem 'glimmer-dsl-libui', '~> 0.9.2'
 ```
 
 Test that installation worked by running the [Glimmer Meta-Example](#examples):
@@ -525,9 +529,7 @@ If you are new to [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-
 
 ## Glimmer Command
 
-The `glimmer` command allows you to conveniently:
-- Run Glimmer DSL for LibUI applications (via `glimmer [app_path]`)
-- Run Glimmer DSL for LibUI included examples (via `glimmer examples`, which brings up the [Glimmer Meta-Example](https://github.com/AndyObtiva/glimmer-dsl-libui/blob/master/examples/meta_example.rb))
+The `glimmer` command allows you to conveniently run applications (`glimmer app_path`), run examples (`glimmer examples`), and scaffold applications (`glimmer "scaffold[app_name]"`).
 
 You can bring up usage instructions by running the `glimmer` command without arguments:
 
@@ -581,6 +583,144 @@ On Windows and ARM64 machines, it simply lists the available Glimmer tasks at th
 
 Note: If you encounter an issue running the `glimmer` command, run `bundle exec glimmer` instead.
 
+### Run Application
+
+Run Glimmer DSL for LibUI applications via this command:
+
+```
+glimmer app_path
+```
+
+For example, from a cloned glimmer-dsl-libui repository:
+
+```
+glimmer examples/basic_window.rb
+```
+
+Mac | Windows | Linux
+----|---------|------
+![glimmer-dsl-libui-mac-basic-window.png](/images/glimmer-dsl-libui-mac-basic-window.png) | ![glimmer-dsl-libui-windows-basic-window.png](/images/glimmer-dsl-libui-windows-basic-window.png) | ![glimmer-dsl-libui-linux-basic-window.png](/images/glimmer-dsl-libui-linux-basic-window.png)
+
+### Run Examples
+
+Run Glimmer DSL for LibUI included examples via this command:
+
+```
+glimmer examples
+```
+
+That brings up the [Glimmer Meta-Example](https://github.com/AndyObtiva/glimmer-dsl-libui/blob/master/examples/meta_example.rb))
+
+Mac | Windows | Linux
+----|---------|------
+![glimmer-dsl-libui-mac-meta-example.png](images/glimmer-dsl-libui-mac-meta-example.png) | ![glimmer-dsl-libui-windows-meta-example.png](images/glimmer-dsl-libui-windows-meta-example.png) | ![glimmer-dsl-libui-linux-meta-example.png](images/glimmer-dsl-libui-linux-meta-example.png)
+
+### Scaffold Application
+
+Application scaffolding enables automatically generating the directories/files of a new desktop GUI application that follows the MVC architecture and can be packaged as a Ruby gem that includes a binary script for running the app conveniently.
+
+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.
+
+For example, if we run:
+
+```
+glimmer "scaffold[hello_world]"
+```
+
+The following files are generated and reported by the `glimmer` command:
+
+```
+Created hello_world/.gitignore
+Created hello_world/.ruby-version
+Created hello_world/.ruby-gemset
+Created hello_world/VERSION
+Created hello_world/LICENSE.txt
+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/icons/windows/Hello World.ico
+Created hello_world/icons/macosx/Hello World.icns
+Created hello_world/icons/linux/Hello World.png
+Created hello_world/app/hello_world/launch.rb
+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`)
+
+Once you step into the application directory, you can run it in one of multiple ways:
+
+```
+bin/app_name
+```
+
+For example:
+
+```
+bin/hello_world
+```
+
+Or using the Glimmer generic command for running applications, which will automatically detect the application running script:
+
+```
+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.
+
+You can package the newly scaffolded app 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
+```
+
+Once you install the gem (e.g. `gem install hello_world`), you can simply run the app with its binary script:
+
+```
+app_name
+```
+
+For example:
+
+```
+hello_world
+```
+
+![glimmer-dsl-libui-mac-scaffold-app-initial-screen.png](images/glimmer-dsl-libui-mac-scaffold-app-initial-screen.png)
+
 ## 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/RUBY_VERSION

@@ -0,0 +1 @@
+3.2.2

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.2

data/lib/glimmer/rake_task/package.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2021-2023 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'os'
+
+module Glimmer
+  module RakeTask
+    module Package
+      class << self
+        def clean
+          require 'fileutils'
+          FileUtils.rm_rf('pkg')
+        end
+        
+        def gemspec
+          system 'rake gemspec:generate'
+        end
+        
+        def gem
+          system 'rake build'
+        end
+      end
+    end
+  end
+end