glimmer-dsl-swing 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d91f9d5241c9f9414d4f4c343568a71f19657560b72713a4fbfe4711af0e120f
-  data.tar.gz: 25079ddbf4e8b83a899b4857e88aa9dacfbde3f67147c7708047113654e42df7
+  metadata.gz: e0ffbe12ad885326f61aa37073604e1df424e538d33bd6a05653598c017c4c78
+  data.tar.gz: cbef6588edb062f6079fd55b1af4f4de8dd691fbe3c4a350176c3d179c2e4e5e
 SHA512:
-  metadata.gz: 23641076d917e3223517cfabfd82c72973360b4bff14032567e67e6352b4dd40e6e628d920833786401a8b0d65b3959d6303e6721cd2fd95254ff365e8bc64ee
-  data.tar.gz: f1b4f292413767713e88bf115e0b16cb4df5644f72cfb79c80f5043dbc4bfe639e6e3fb5ec79ec515b3e526e094c4be9aed3a48ed2a3ba7d402978517643770c
+  metadata.gz: 87b6a0d7b707ad99af3ca49a769edd5376a75d961190c87a4677cf9d5d8ba11b2b47cfd19f19b1391e381a13158783d88d7507711c2cb8bbc5d11c4ec03512fb
+  data.tar.gz: 7daff7909124ea6303d905821868116c91c15db4e2a467f47c2f6e9d729877316d9bbee340a3930c401a57184e38235f4b8af49356dd6820325e98fb25cf499c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.0.3
+
+- Support `observe` keyword for observing model attributes to update the View
+- Support adding `include Glimmer` inside a class
+- Hello, Button! sample version 2 (decoupled view using `observe` keyword)
+
 ## 0.0.2
 
 - General Java 2D shape support by nesting under any component

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 Swing 0.0.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 Swing 0.0.3
 ## JRuby Swing Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-swing.svg)](http://badge.fury.io/rb/glimmer-dsl-swing)
 [![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)
@@ -14,8 +14,8 @@ There has been a great divide between two big GUI toolkits in Java in the past:
 That said, from a balanced software engineering point of view, there are sometimes non-functional requirements that might target [Swing](https://docs.oracle.com/javase/tutorial/uiswing/) as an appropriate GUI toolkit solution. Like in the case of extending legacy [Swing](https://docs.oracle.com/javase/tutorial/uiswing/) applications or developing rare applications that require fully custom looking graphical user interfaces (typically not recommended), such as traffic control planning or diagramming applications. In the latter case, it would not matter whether to use [SWT](https://www.eclipse.org/swt/) or [Swing](https://docs.oracle.com/javase/tutorial/uiswing/) as they both provide support for building non-native components (in addition to native widgets in the case of [SWT](https://www.eclipse.org/swt/)).
 
 [Glimmer DSL for Swing](https://rubygems.org/gems/glimmer-dsl-swing) aims to supercharge productivity and maintainability in developing [Swing](https://docs.oracle.com/javase/tutorial/uiswing/) applications by providing a DSL similar to [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) having:
-- Declarative DSL syntax that visually maps to the GUI component hierarchy
-- Convention over configuration via smart defaults and automation of low-level details
+- [Declarative DSL syntax](#glimmer-gui-dsl) that visually maps to the GUI component hierarchy
+- Convention over configuration via [smart defaults and automation of low-level details](#smart-defaults-and-conventions)
 - Requiring the least amount of syntax possible to build GUI
 - Custom Keyword support
 - Bidirectional Data-Binding to declaratively wire and automatically synchronize GUI with Business Models
@@ -57,14 +57,14 @@ Note: On the Mac, if you have [Glimmer DSL for SWT](https://github.com/AndyObtiv
 
 Run this command to install directly:
 ```
-gem install glimmer-dsl-swing
+gem install glimmer-dsl-swing -v0.0.3
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-swing', '~> 0.0.2'
+gem 'glimmer-dsl-swing', '0.0.3'
 ```
 
 And, then run:
@@ -86,6 +86,24 @@ jframe('Hello, World!') {
 }.show
 ```
 
+For actual application development outside of simple demos, mixin the `Glimmer` module into a custom application class instead:
+
+```ruby
+require 'glimmer-dsl-swing'
+
+class SomeApplication
+  include Glimmer
+
+  def launch
+    jframe('Hello, World!') {
+      jlabel('Hello, World!')
+    }.show
+  end
+end
+
+SomeApplication.new.launch
+```
+
 ## Glimmer GUI DSL
 
 The Glimmer GUI DSL enables development of desktop graphical user interfaces in a manner similar to HTML, but in one language, Ruby, thus avoiding the multi-language separation dissonance encountered on the web, especially given that Ruby looping/conditional constructs do not need scriptlets to be added around View code. This makes desktop development extremely productive.
@@ -165,6 +183,60 @@ frame1 = jframe('Hello, World!') {
 frame1.show
 ```
 
+Despite `#show` being deprecated in the Java API, it is recommended to use `#show` instead of `visible=` in the Glimmer GUI DSL because it has less awkward syntax (it calls `visible=` behind the scenes to avoid the deprecated API). `#show` also invokes `pack` automatically on first run, and ensures utilizing `SwingUtilities.invokeLater` behind the scenes.
+
+6 - Observe Model Attributes
+
+In Smalltalk-MVC ([Model View Controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) Architectural Pattern), the View is an active View that observes the Model for changes and updates itself.
+
+![MVC](https://camo.githubusercontent.com/0651c35cc70c5ba422876936733b07667368835bbd3cdbf5e706151410bdea04/68747470733a2f2f7777772e7265736561726368676174652e6e65742f70726f66696c652f44616e6e792d5765796e732f7075626c69636174696f6e2f3236393330333631312f6669677572652f666967322f41533a38353831333330353634363238363640313538313630363237323830302f536d616c6c74616c6b38302d4d56432d7061747465726e2d566965772d616e642d436f6e74726f6c6c65722d776f726b2d61732d612d706169722d616c6c6f77696e672d7468652d757365722d746f2d696e7465726163742e70706d)
+
+This can be achieved with the Glimmer GUI DSL using the `observe` keyword, which takes a model (any object, including `self`) and attribute Symbol or String expression (e.g. `:count` or `'address.street'`).
+
+The model is automatically enhanced as an `Glimmer::DataBinding::ObservableModel` / `Glimmer::DataBinding::ObservableHash` / `Glimmer::DataBinding::ObservableArray` depending on its type to support notifying observers of attribute changes (when performed using the attribute writer, which automatically calls added method `notify_observers(attribute)`)
+
+Note that it is usually recommended to observe external model objects (not `self`), but `self` is OK in very simple cases or presentation-related attributes only.
+
+Example:
+
+```ruby
+require 'glimmer-dsl-swing'
+
+class Counter
+  attr_accessor :count
+
+  def initialize
+    self.count = 0
+  end
+end
+
+class HelloButton
+  include Glimmer
+  
+  def initialize
+    @counter = Counter.new
+
+    observe(@counter, :count) do |new_count|
+      @button.text = "Click To Increment: #{new_count}"
+    end
+  end
+  
+  def launch
+    jframe('Hello, Button!') {
+      @button = jbutton('Click To Increment: 0') {
+        on_action_performed do
+          @counter.count += 1
+        end
+      }
+    }.show
+  end
+end
+
+HelloButton.new.launch
+```
+
+![screenshots/glimmer-dsl-swing-mac-hello-button.png](screenshots/glimmer-dsl-swing-mac-hello-button.png)
+
 ### Shape DSL
 
 [Glimmer DSL for Swing](https://rubygems.org/gems/glimmer-dsl-swing) might be the only Ruby Swing DSL out there that supports an additional Shape DSL.
@@ -175,6 +247,8 @@ Simply utilize underscored shape names from the `java.awt.geom` [package classes
 
 For example, `Arc2D` becomes simply `arc`.
 
+Glimmer utilizes the `Double` variation of shape classes.
+
 Additionally, you can set `draw_color` or `fill_color` property as an rgb/rgba hash (e.g. `r: 255, g: 0, b: 0`)
 
 Example:
@@ -233,6 +307,11 @@ jframe('Hello, Shapes!') {
 
 ![screenshots/glimmer-dsl-swing-mac-hello-shapes.png](screenshots/glimmer-dsl-swing-mac-hello-shapes.png)
 
+## Smart Defaults and Conventions
+
+- `jframe` automatically invokes `pack` on first run of `show`, and ensures utilizing `SwingUtilities.invokeLater` behind the scenes.
+- When nesting a shape under a [swing](https://docs.oracle.com/javase/8/docs/api/javax/swing/package-summary.html)/[awt](https://docs.oracle.com/javase/8/docs/api/java/awt/package-summary.html) component, it is automatically added to shapes to paint on top of component (after painting component itself).
+
 ## Girb (Glimmer IRB)
 
 You can run the `girb` command (`bin/girb` if you cloned the project locally):
@@ -241,7 +320,7 @@ You can run the `girb` command (`bin/girb` if you cloned the project locally):
 girb
 ```
 
-This gives you `irb` with the `glimmer-dsl-gtk` gem loaded and the `Glimmer` module mixed into the main object for easy experimentation with GUI.
+This gives you `irb` with the `glimmer-dsl-swing` gem loaded and the `Glimmer` module mixed into the main object for easy experimentation with GUI.
 
 ## Samples
 
@@ -263,6 +342,8 @@ jruby -r ./lib/glimmer-dsl-swing samples/hello/hello_world.rb
 
 ![screenshots/glimmer-dsl-swing-mac-hello-world.png](screenshots/glimmer-dsl-swing-mac-hello-world.png)
 
+[samples/hello/hello_world.rb](samples/hello/hello_world.rb):
+
 ```ruby
 require 'glimmer-dsl-swing'
 
@@ -289,6 +370,8 @@ jruby -r ./lib/glimmer-dsl-swing samples/hello/hello_button.rb
 
 ![screenshots/glimmer-dsl-swing-mac-hello-button.png](screenshots/glimmer-dsl-swing-mac-hello-button.png)
 
+Version 1 (without model) - [samples/hello/hello_button.rb](samples/hello/hello_button.rb):
+
 ```ruby
 require 'glimmer-dsl-swing'
 
@@ -305,6 +388,44 @@ jframe('Hello, Button!') {
 }.show
 ```
 
+Version 2 (with model) - [samples/hello/hello_button2.rb](samples/hello/hello_button2.rb):
+
+```ruby
+require 'glimmer-dsl-swing'
+
+class Counter
+  attr_accessor :count
+
+  def initialize
+    self.count = 0
+  end
+end
+
+class HelloButton
+  include Glimmer
+  
+  def initialize
+    @counter = Counter.new
+
+    observe(@counter, :count) do |new_count|
+      @button.text = "Click To Increment: #{new_count}"
+    end
+  end
+  
+  def launch
+    jframe('Hello, Button!') {
+      @button = jbutton('Click To Increment: 0') {
+        on_action_performed do
+          @counter.count += 1
+        end
+      }
+    }.show
+  end
+end
+
+HelloButton.new.launch
+```
+
 #### Hello, Shapes!
 
 Run with gem installed:
@@ -321,6 +442,8 @@ jruby -r ./lib/glimmer-dsl-swing samples/hello/hello_shapes.rb
 
 ![screenshots/glimmer-dsl-swing-mac-hello-shapes.png](screenshots/glimmer-dsl-swing-mac-hello-shapes.png)
 
+[samples/hello/hello_shapes.rb](samples/hello/hello_shapes.rb):
+
 ```ruby
 require 'glimmer-dsl-swing'
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/glimmer/dsl/swing/observe_expression.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2021 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 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/top_level_expression'
+require 'glimmer/dsl/observe_expression'
+
+module Glimmer
+  module DSL
+    module Swing
+      class ObserveExpression < StaticExpression
+        include TopLevelExpression
+        include Glimmer::DSL::ObserveExpression
+      end
+    end
+  end
+end

data/lib/glimmer/swing/component_proxy.rb

@@ -31,6 +31,8 @@ module Glimmer
       include Packages
 
       class << self
+        include Packages
+        
         def exist?(keyword)
           !!component_class(keyword)
         end

data/lib/glimmer-dsl-swing.rb

@@ -24,11 +24,11 @@ $LOAD_PATH.unshift(File.expand_path('.', __dir__))
 # External requires
 # require 'logging'
 require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
+require 'nested_inherited_jruby_include_package'
 # require 'super_module'
 require 'java'
 require 'concurrent-ruby' # ensures glimmer relies on Concurrent data-structure classes (e.g. Concurrent::Array)
 require 'glimmer'
-require 'nested_inherited_jruby_include_package'
 require 'os'
 require 'array_include_methods'
 require 'facets/string/underscore'

data/samples/hello/hello_button2.rb

@@ -0,0 +1,33 @@
+require 'glimmer-dsl-swing'
+
+class Counter
+  attr_accessor :count
+
+  def initialize
+    self.count = 0
+  end
+end
+
+class HelloButton
+  include Glimmer
+  
+  def initialize
+    @counter = Counter.new
+
+    observe(@counter, :count) do |new_count|
+      @button.text = "Click To Increment: #{new_count}"
+    end
+  end
+  
+  def launch
+    jframe('Hello, Button!') {
+      @button = jbutton('Click To Increment: 0') {
+        on_action_performed do
+          @counter.count += 1
+        end
+      }
+    }.show
+  end
+end
+
+HelloButton.new.launch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-swing
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andy Maleh
@@ -217,6 +217,7 @@ files:
 - lib/glimmer/dsl/swing/component_expression.rb
 - lib/glimmer/dsl/swing/dsl.rb
 - lib/glimmer/dsl/swing/listener_expression.rb
+- lib/glimmer/dsl/swing/observe_expression.rb
 - lib/glimmer/dsl/swing/property_expression.rb
 - lib/glimmer/dsl/swing/shape_expression.rb
 - lib/glimmer/swing.rb
@@ -228,6 +229,7 @@ files:
 - lib/glimmer/swing/packages.rb
 - lib/glimmer/swing/shape_proxy.rb
 - samples/hello/hello_button.rb
+- samples/hello/hello_button2.rb
 - samples/hello/hello_shapes.rb
 - samples/hello/hello_world.rb
 homepage: http://github.com/AndyObtiva/glimmer-dsl-swing