glimmer 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbe97823fd25586221485191db661a4cb6fe71d8d9be9e89b60d617d5f496540
-  data.tar.gz: d81b11d52ce3f0fe1fdb46d9f1a6c286ccd95c3021118f71b4f72d7724cd0f41
+  metadata.gz: c109cca015308e3a388d79b30ece439200ebf53d300cb2305be5c7a3845790eb
+  data.tar.gz: ad27543079db9eabface83fdf67342dabe37b1b01ba64e03c545bb1bea08158b
 SHA512:
-  metadata.gz: 930a0914fc83db952df2eba9321779ee34a3d2819a0dabb05a31615b97b1eb57ff222321bd9db9fa4d6950e0f4e68f6455a66223ac1a1126a1c72be75a8a8b46
-  data.tar.gz: 5ab308d9b3403a9876d8f40f8a51d277cf0c88527f257977f87a21fc530a95a0d3e92d64a6b4025a56b2ed857f3d6b1c4d0d3df10bed7999c25cf90e589d6934
+  metadata.gz: ccdd49212a55e8ee6a91ae603314e926dfc8944c2b972e2fbf3e387b01020c6b9cdd5eeb28155f5b305f5f517e488414c01fc1f5cdec46372a34c41e467dff15
+  data.tar.gz: c19d423a2cf484f6749072e38e1f0608395420e2a44960672a5c9620867431ebae6d12e2015f8bf398bc6d565e0a8e661f86225880d42a7fd699146c9c65c342

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Andy Maleh
+Copyright (c) 2011-2020 Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,6 @@
-# Glimmer 0.8.2 Beta (Ruby Desktop Development GUI Library)
+# Glimmer - Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer.svg)](http://badge.fury.io/rb/glimmer)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer)
-[![Maintainability](https://api.codeclimate.com/v1/badges/38fbc278022862794414/maintainability)](https://codeclimate.com/github/AndyObtiva/glimmer/maintainability)
 
 Glimmer is a native-GUI cross-platform desktop development library written in Ruby. Glimmer's main innovation is a JRuby DSL that enables productive and efficient authoring of desktop application user-interfaces while relying on the robust Eclipse SWT library. Glimmer additionally innovates by having built-in data-binding support to greatly facilitate synchronizing the GUI with domain models. As a result, that achieves true decoupling of object oriented components, enabling developers to solve business problems without worrying about GUI concerns, or alternatively drive development GUI-first, and then write clean business models test-first afterwards.
 
@@ -72,9 +71,11 @@ Glimmer app:
 
 NOTE: Glimmer is in beta mode. Please help make better by [contributing](#contributing), adopting for small or low risk projects, and providing feedback.
 
+Ruby is a dynamically-typed object-oriented language, which provides great productivity gains due to its powerful expressive syntax and dynamic nature. While it is proven by the Ruby on Rails framework for web development, it currently lacks a robust platform-independent framework for building desktop applications. Given that Java libraries can now be utilized in Ruby code through JRuby, Eclipse technologies, such as SWT, JFace, and RCP can help fill the gap of desktop application development with Ruby.
+
 ## Table of contents
 
-- [Glimmer 0.8.2 Beta (Ruby Desktop Development GUI Library)](#glimmer-082-beta-ruby-desktop-development-gui-library)
+- [Glimmer - Ruby Desktop Development GUI Library](#glimmer-ruby-desktop-development-gui-library)
   - [Examples](#examples)
     - [Hello, World!](#hello-world)
     - [Tic Tac Toe](#tic-tac-toe)
@@ -125,9 +126,9 @@ NOTE: Glimmer is in beta mode. Please help make better by [contributing](#contri
       - [Gotcha](#gotcha)
     - [Custom Shells](#custom-shells)
     - [Miscellaneous](#miscellaneous)
+      - [Multi-DSL Support](#multi-dsl-support)
       - [Application Menu Items (About/Preferences)](#application-menu-items-aboutpreferences)
       - [App Name and Version](#app-name-and-version)
-      - [Multi-DSL Support](#multi-dsl-support)
       - [Video Widget](#video-widget)
       - [Browser Widget](#browser-widget)
   - [Glimmer Style Guide](#glimmer-style-guide)
@@ -204,7 +205,7 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.8.2
+jgem install glimmer-dsl-swt -v 0.1.0
 ```
 
 `jgem` is JRuby's version of `gem` command. 
@@ -215,7 +216,7 @@ Otherwise, you may also run `jruby -S gem install ...`
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.8.2'
+gem 'glimmer-dsl-swt', '~> 0.1.0'
 ```
 
 And, then run:
@@ -223,6 +224,8 @@ And, then run:
 jruby -S bundle install
 ```
 
+You may learn more about other Glimmer related gems at [Multi-DSL Support](#multi-dsl-support)
+
 ## Glimmer Command
 
 ### Basic Usage
@@ -424,7 +427,7 @@ With Glimmer installed, you may want to run `girb` instead of standard `irb` to
 girb
 ```
 
-If you cloned this project locally, you may run `bin/girb` instead.
+If you cloned [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) project locally, you may run `bin/girb` instead.
 
 ```
 bin/girb
@@ -432,6 +435,8 @@ bin/girb
 
 Watch out for hands-on examples in this README indicated by "you may copy/paste in [`girb`](#girb-glimmer-irb-command)"
 
+Keep in mind that all samples live under [https://github.com/AndyObtiva/glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt)
+
 ## Glimmer DSL Syntax
 
 Glimmer DSL syntax consists of static keywords and dynamic keywords to build and bind user-interface objects.
@@ -1794,92 +1799,19 @@ shell { |app_shell|
 
 ### Miscellaneous
 
-#### Application Menu Items (About/Preferences)
-
-Mac applications always have About and Preferences menu items. Glimmer provides widget observer hooks for them on the `display`:
-- `on_about`: executes code when user selects App Name -> About
-- `on_preferences`: executes code when user selects App Name -> Preferences or hits 'CMD+,' on the Mac
-
-Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
-
-```ruby
-class Example
-  def initialize
-    display {
-      on_about {
-        message_box = MessageBox.new(@shell_proxy.swt_widget)
-        message_box.setText("About")
-        message_box.setMessage("About Application")
-        message_box.open
-      }
-      on_preferences {
-        preferences_dialog = dialog {
-          text 'Preferences'
-          row_layout {
-            type :vertical
-            margin_left 15
-            margin_top 15
-            margin_right 15
-            margin_bottom 15
-          }
-          label {
-            text 'Check one of these options:'
-          }
-          button(:radio) {
-            text 'Option 1'
-          }
-          button(:radio) {
-            text 'Option 2'
-          }
-        }
-        preferences_dialog.open
-      }
-    }
-    @shell_proxy = shell {
-      text 'Application Menu Items'
-      fill_layout {
-        margin_width 15
-        margin_height 15
-      }
-      label {
-        text 'Application Menu Items'
-        font height: 30
-      }
-    }
-    @shell_proxy.open
-  end
-end
-
-Example.new
-```
-
-#### App Name and Version
-
-Application name (shows up on the Mac in top menu bar) and version may be specified upon [packaging](#packaging--distribution) by specifying "-Bmac.CFBundleName" and "-Bmac.CFBundleVersion" options.
-
-Still, if you would like proper application name to show up on the Mac top menu bar during development, you may do so by invoking the SWT Display.setAppName method before any Display object has been instantiated (i.e. before any Glimmer widget like shell has been declared).
-
-Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
-
-```ruby
-Display.setAppName('Glimmer Demo')
-
-shell(:no_resize) {
-  text "Glimmer"
-  label {
-    text "Hello, World!"
-  }
-}.open
-```
+#### Multi-DSL Support
 
-Also, you may invoke `Display.setAppVersion('1.0.0')` if needed for OS app version identification reasons during development, replacing `'1.0.0'` with your application version.
+Glimmer is a DSL engine that supports multiple DSLs (Domain Specific Languages):
+- [SWT](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (Desktop GUI)
+- [Opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Web GUI Adapter for Desktop Apps)
+- [XML](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML) - Useful with [SWT Browser Widget](#browser-widget)
+- [CSS](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS (Cascading Style Sheets) - Useful with [SWT Browser Widget](#browser-widget)
 
-#### Multi-DSL Support
+Glimmer automatically recognizes top-level keywords in each DSL and activates DSL accordingly. Glimmer allows mixing DSLs, which comes in handy when doing things like using the SWT Browser widget with XML and CSS. Once done processing a nested DSL top-level keyword, Glimmer switches back to the prior DSL automatically.
 
-Glimmer supports two other DSLs in addition to the SWT DSL; that is Glimmer XML DSL and Glimmer CSS DSL. It also allows mixing DSLs, which comes in handy when doing things like using the `browser` widget. Glimmer automatically recognizes top-level keywords in each DSL
-and switches DSLs accordingly. Once done processing a top-level keyword, it switches back to the prior DSL automatically.
+##### SWT
 
-For example, the SWT DSL has the following top-level keywords:
+The SWT DSL was already covered in detail. However, for the sake of mixing DSLs, you need to know that the SWT DSL has the following top-level keywords:
 - `shell`
 - `display`
 - `color`
@@ -1887,7 +1819,13 @@ For example, the SWT DSL has the following top-level keywords:
 - `async_exec`
 - `sync_exec`
 
-##### XML DSL
+##### Opal
+
+Full instructions are found in the [Opal](https://github.com/AndyObtiva/glimmer-dsl-opal) DSL page.
+
+The [Opal](https://github.com/AndyObtiva/glimmer-dsl-opal) DSL is simply a web GUI adapter for desktop apps written in Glimmer. As such, it supports all the DSL keywords of the SWT DSL and shares the same top-level keywords.
+
+##### XML
 
 Simply start with `html` keyword and add HTML inside its block using Glimmer DSL syntax.
 Once done, you may call `to_s`, `to_xml`, or `to_html` to get the formatted HTML output.
@@ -1965,8 +1903,7 @@ Output:
 <DOCUMENT><document:body document:id="main"></document:body></DOCUMENT>
 ```
 
-
-##### CSS DSL
+##### CSS
 
 Simply start with `css` keyword and add stylesheet rule sets inside its block using Glimmer DSL syntax.
 Once done, you may call `to_s` or `to_css` to get the formatted CSS output.
@@ -2002,6 +1939,86 @@ Glimmer provides a number of methods on Glimmer::DSL::Engine to configure DSL su
 - `Glimmer::DSL::Engine.enable_dsl(dsl_name)`: Re-enables disabled DSL
 - `Glimmer::DSL::Engine.enabled_dsls=(dsl_names)`: Disables all DSLs except the ones specified.
 
+#### Application Menu Items (About/Preferences)
+
+Mac applications always have About and Preferences menu items. Glimmer provides widget observer hooks for them on the `display`:
+- `on_about`: executes code when user selects App Name -> About
+- `on_preferences`: executes code when user selects App Name -> Preferences or hits 'CMD+,' on the Mac
+
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+
+```ruby
+class Example
+  def initialize
+    display {
+      on_about {
+        message_box = MessageBox.new(@shell_proxy.swt_widget)
+        message_box.setText("About")
+        message_box.setMessage("About Application")
+        message_box.open
+      }
+      on_preferences {
+        preferences_dialog = dialog {
+          text 'Preferences'
+          row_layout {
+            type :vertical
+            margin_left 15
+            margin_top 15
+            margin_right 15
+            margin_bottom 15
+          }
+          label {
+            text 'Check one of these options:'
+          }
+          button(:radio) {
+            text 'Option 1'
+          }
+          button(:radio) {
+            text 'Option 2'
+          }
+        }
+        preferences_dialog.open
+      }
+    }
+    @shell_proxy = shell {
+      text 'Application Menu Items'
+      fill_layout {
+        margin_width 15
+        margin_height 15
+      }
+      label {
+        text 'Application Menu Items'
+        font height: 30
+      }
+    }
+    @shell_proxy.open
+  end
+end
+
+Example.new
+```
+
+#### App Name and Version
+
+Application name (shows up on the Mac in top menu bar) and version may be specified upon [packaging](#packaging--distribution) by specifying "-Bmac.CFBundleName" and "-Bmac.CFBundleVersion" options.
+
+Still, if you would like proper application name to show up on the Mac top menu bar during development, you may do so by invoking the SWT Display.setAppName method before any Display object has been instantiated (i.e. before any Glimmer widget like shell has been declared).
+
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+
+```ruby
+Display.setAppName('Glimmer Demo')
+
+shell(:no_resize) {
+  text "Glimmer"
+  label {
+    text "Hello, World!"
+  }
+}.open
+```
+
+Also, you may invoke `Display.setAppVersion('1.0.0')` if needed for OS app version identification reasons during development, replacing `'1.0.0'` with your application version.
+
 #### Video Widget
 
 ![Video Widget](images/glimmer-video-widget.png)
@@ -2025,7 +2042,7 @@ shell {
 }.open
 ```
 
-Example rendering HTML with JavaScript on document ready (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+Example rendering HTML with JavaScript on document ready (you may copy/paste in [`girb`](#girb-glimmer-irb-command) provided you install and require [glimmer-dsl-xml gem](https://github.com/AndyObtiva/glimmer-dsl-xml)):
 
 ```ruby
 shell {
@@ -2046,7 +2063,7 @@ shell {
 }.open
 ```
 
-This relies on Glimmer's [Multi-DSL Support](https://github.com/AndyObtiva/glimmer/tree/development#multi-dsl-support) for building the HTML text using Glimmer XML DSL.
+This relies on Glimmer's [Multi-DSL Support](#multi-dsl-support) for building the HTML text using [Glimmer XML DSL](https://github.com/AndyObtiva/glimmer-dsl-xml).
 
 ## Glimmer Style Guide
 
@@ -2374,6 +2391,10 @@ By the way, keep in mind that during normal operation, it does also indicate a f
 Exec failed with code 2 command [[/usr/bin/SetFile, -c, icnC, /var/folders/4_/g1sw__tx6mjdgyh3mky7vydc0000gp/T/fxbundler4076750801763032201/images/MathBowling/.VolumeIcon.icns] in unspecified directory
 ```
 
+## Limitations
+
+- Glimmer apps have a long startup up time and can take anywhere between 12 and 30 seconds to start depending on the app and the machine. Once started, Glimmer apps run very fast and perform very responsively since Ruby is more than fast and capable for handling desktop GUIs. In any case, one idea to address this limitation is to include a background service (daemon) that can launch Glimmer apps instantly or near instantly by keeping a JRuby runtime started and ready at all times.
+
 ## Resources
 
 * [Code Master Blog](http://andymaleh.blogspot.com/search/label/Glimmer)
@@ -2401,7 +2422,7 @@ If you need live help, try the [#glimmer](http://widget.mibbit.com/?settings=751
 
 These features have been suggested. You might see them in a future version of Glimmer. You are welcome to contribute more feature suggestions.
 
-[TODO.md](TODO.md)
+[TODO.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/TODO.md)
 
 ## Change Log
 

data/VERSION

@@ -1 +1 @@
-0.8.2
+0.9.0

data/lib/glimmer.rb

@@ -2,14 +2,8 @@
 # interfaces using the robust platform-independent Eclipse SWT library. Glimmer
 # comes with built-in data-binding support to greatly facilitate synchronizing
 # UI with domain models.
-require 'facets'
-require 'super_module'
 require 'logger'
-require 'java'
 require 'set'
-require 'nested_inherited_jruby_include_package'
-require 'fileutils'
-require 'os'
 
 # Glimmer provides a JRuby Desktop UI DSL + Data-Binding functionality
 #
@@ -21,16 +15,6 @@ module Glimmer
   #TODO make it configurable to include or not include perhaps reverting to using included
   REGEX_METHODS_EXCLUDED = /^(to_|\[)/
 
-  class << self
-    def included(klass)
-      if Config.import_swt_packages
-        klass.include(SWT::Packages)
-        klass.extend(SWT::Packages)
-        klass.extend(Glimmer)
-      end
-    end
-  end
-
   def method_missing(method_symbol, *args, &block)
     # This if statement speeds up Glimmer in girb or whenever directly including on main object
     if method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
@@ -50,9 +34,5 @@ end
 $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 require 'glimmer/config'
-require 'glimmer/swt/packages'
-require 'glimmer/dsl/swt/dsl'
-require 'glimmer/dsl/xml/dsl'
-require 'glimmer/dsl/css/dsl'
 require 'glimmer/error'
 require 'glimmer/invalid_keyword_error'

data/lib/glimmer/config.rb

@@ -1,19 +1,6 @@
 module Glimmer
   module Config
     class << self
-      # Tells Glimmer to import SWT packages into including class (default: true)
-      def import_swt_packages=(value)
-        @@import_swt_packages = !!value
-      end
-  
-      # Returns whether Glimmer will import SWT packages into including class
-      def import_swt_packages
-        unless defined? @@import_swt_packages
-          @@import_swt_packages = true
-        end
-        @@import_swt_packages
-      end
-  
       # Returns Glimmer logger (standard Ruby logger)
       def logger
         # unless defined? @@logger

data/lib/glimmer/dsl/engine.rb

@@ -1,4 +1,5 @@
-require 'glimmer'
+require 'facets/string/camelcase'
+
 require 'glimmer/dsl/expression_handler'
 
 module Glimmer
@@ -73,8 +74,9 @@ module Glimmer
         #
         # They are used in order following the Chain of Responsibility Design
         # Pattern when interpretting a DSL expression
-        def add_dynamic_expressions(dsl_namespace, expression_names)
-          dsl = dsl_namespace.name.split("::").last.downcase.to_sym
+        def add_dynamic_expressions(dsl_namespace, *expression_names)
+          expression_names = expression_names.flatten
+          dsl = dsl_namespace.name.split("::").last.downcase.to_sym          
           dynamic_expression_chains_of_responsibility[dsl] = expression_names.reverse.map do |expression_name|
             expression_class(dsl_namespace, expression_name).new
           end.reduce(nil) do |last_expresion_handler, expression|
@@ -82,7 +84,7 @@ module Glimmer
             expression_handler = ExpressionHandler.new(expression)
             expression_handler.next = last_expresion_handler if last_expresion_handler
             expression_handler
-          end
+          end                   
         end
 
         def add_static_expression(static_expression)
@@ -91,31 +93,36 @@ module Glimmer
           static_expression_dsl = static_expression.class.dsl
           static_expressions[keyword] ||= {}
           static_expressions[keyword][static_expression_dsl] = static_expression
-          Glimmer.define_method(keyword) do |*args, &block|
+          Glimmer.send(:define_method, keyword) do |*args, &block|
             begin
               retrieved_static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]            
               static_expression_dsl = (Glimmer::DSL::Engine.static_expressions[keyword].keys - Glimmer::DSL::Engine.disabled_dsls).first if retrieved_static_expression.nil?
+              interpretation = nil
               if retrieved_static_expression.nil? && Glimmer::DSL::Engine.dsl && (static_expression_dsl.nil? || !Glimmer::DSL::Engine.static_expressions[keyword][static_expression_dsl].is_a?(TopLevelExpression))
                 begin
-                  return Glimmer::DSL::Engine.interpret(keyword, *args, &block)
+                  interpretation = Glimmer::DSL::Engine.interpret(keyword, *args, &block)
                 rescue => e
                   Glimmer::DSL::Engine.reset
                   raise e if static_expression_dsl.nil? || !Glimmer::DSL::Engine.static_expressions[keyword][static_expression_dsl].is_a?(TopLevelExpression)
                 end
               end
-              raise Glimmer::Error, "Unsupported keyword: #{keyword}" unless static_expression_dsl || retrieved_static_expression
-              Glimmer::DSL::Engine.dsl_stack.push(static_expression_dsl || Glimmer::DSL::Engine.dsl)
-              static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
-              if !static_expression.can_interpret?(Glimmer::DSL::Engine.parent, keyword, *args, &block)
-                raise Error, "Invalid use of Glimmer keyword #{keyword} with args #{args} under parent #{Glimmer::DSL::Engine.parent}"
-              else
-                Glimmer::Config.logger&.debug "#{static_expression.class.name} will handle expression keyword #{keyword}"
-                return static_expression.interpret(Glimmer::DSL::Engine.parent, keyword, *args, &block).tap do |ui_object|
-                  Glimmer::DSL::Engine.add_content(ui_object, static_expression, &block) unless block.nil?
-                  Glimmer::DSL::Engine.dsl_stack.pop
+              if interpretation
+                interpretation
+              else              
+                raise Glimmer::Error, "Unsupported keyword: #{keyword}" unless static_expression_dsl || retrieved_static_expression
+                Glimmer::DSL::Engine.dsl_stack.push(static_expression_dsl || Glimmer::DSL::Engine.dsl)
+                static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
+                if !static_expression.can_interpret?(Glimmer::DSL::Engine.parent, keyword, *args, &block)
+                  raise Error, "Invalid use of Glimmer keyword #{keyword} with args #{args} under parent #{Glimmer::DSL::Engine.parent}"
+                else
+                  Glimmer::Config.logger&.debug "#{static_expression.class.name} will handle expression keyword #{keyword}"
+                  static_expression.interpret(Glimmer::DSL::Engine.parent, keyword, *args, &block).tap do |ui_object|
+                    Glimmer::DSL::Engine.add_content(ui_object, static_expression, &block) unless block.nil?
+                    Glimmer::DSL::Engine.dsl_stack.pop
+                  end
                 end
               end
-            rescue => e
+            rescue StandardError => e
 #               Glimmer::DSL::Engine.dsl_stack.pop
                 Glimmer::DSL::Engine.reset
               raise e
@@ -141,7 +148,7 @@ module Glimmer
             add_content(ui_object, expression, &block)
             dsl_stack.pop
           end
-        rescue => e
+        rescue StandardError => e
 #           dsl_stack.pop
           reset
           raise e