glimmer 0.7.8 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3d10cd74668598ac83511994d117f3b99f7332d798d671ddc412dcac3c92fa
-  data.tar.gz: 1daf7b7330d0e73790ec98c5ef3afdf3f991f0f447f5b72ce47bc70901bb8baa
+  metadata.gz: 84d87ba92b94f38539aa2dad56f18f8ec09a358d8ac327008b08ef9be3977e9a
+  data.tar.gz: 74bc0959b428802c4a4e1ef28b3f1365b2f4444a1d0446b6cc85420743a9aa7f
 SHA512:
-  metadata.gz: 81136d0e73a2e26f01bc16b8986f8569910a63509730766d6cb70a533e1fbe38fdce3bfc7e0488d5bbe2a76e10413a46b0765811960698f70a343d45ab3c78a2
-  data.tar.gz: e20bab1be17773690ac997385921e47520e324afe3b4efcf0f0b6ae4dcf00cd6bcaea9b36c048c9c1eec54023af4c853e8c9aaa55138b40fa58f4262cbd09872
+  metadata.gz: b80eeec01d04286de10967801413c72cba05dd06b21f9be75a044cf433827d4598f1bed83576222d71f7455dc868cf4af31ae6db9445a536772f1f6f0f446100
+  data.tar.gz: 0d2ac02fb3c55b4bcf79e150b320b5a0d23749ded30a9324c954b0d79d35543e50c9b786c5a7a258342f72f9144bcffd58b733dd2b4c3bcc66b61e4bfcbf85f8

data/README.md

@@ -1,4 +1,4 @@
-# Glimmer 0.7.8 Beta (Desktop Development Library for Ruby)
+# Glimmer 0.8.0 Beta (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)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/38fbc278022862794414/test_coverage)](https://codeclimate.com/github/AndyObtiva/glimmer/test_coverage)
@@ -75,7 +75,7 @@ NOTE: Glimmer is in beta mode. Please help make better by adopting for small or
 
 ## Table of Contents
 
-- [Glimmer 0.7.8 Beta (Desktop Development Library for Ruby)](#glimmer-078-beta-desktop-development-library-for-ruby)
+- [Glimmer 0.8.0 Beta (Ruby Desktop Development GUI Library)](#glimmer-080-beta-desktop-development-library-for-ruby)
   - [Examples](#examples)
     - [Hello, World!](#hello-world)
     - [Tic Tac Toe](#tic-tac-toe)
@@ -174,7 +174,7 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.7.8
+jgem install glimmer -v 0.8.0
 ```
 
 `jgem` is JRuby's version of `gem` command. 
@@ -185,7 +185,7 @@ Otherwise, you may also run `jruby -S gem install ...`
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.7.8'
+gem 'glimmer', '~> 0.8.0'
 ```
 
 And, then run:
@@ -247,7 +247,7 @@ automatically preloading the glimmer Ruby gem and SWT jar dependency.
 Optionally, extra Glimmer options, JRuby options and environment variables may be passed in.
 
 Glimmer options:
-- "--quiet"           : Does not announce file path of Glimmer application being launched nor enable logging
+- "--quiet"           : Does not announce file path of Glimmer application being launched
 - "--debug"           : Displays extra debugging information, passes "--debug" to JRuby, and enables debug logging
 - "--log-level=VALUE" : Sets Glimmer's Ruby logger level ("ERROR" / "WARN" / "INFO" / "DEBUG"; default is none)
 
@@ -632,7 +632,7 @@ Shell widget proxy has extra methods specific to SWT Shell:
 
 Dialog is a variation on Shell. It is basically a shell that is modal (blocks what's behind it) and belongs to another shell. It only has a close button.
 
-Glimmer facilitates building dialogs by using the `dialog` keyword, which automatically adds the SWT::DIALOG_TRIM and SWT::APPLICATION_MODAL [widget styles](#widget-styles) needed for a dialog.
+Glimmer facilitates building dialogs by using the `dialog` keyword, which automatically adds the SWT.DIALOG_TRIM and SWT.APPLICATION_MODAL [widget styles](#widget-styles) needed for a dialog.
 
 #### Menus
 
@@ -1324,7 +1324,7 @@ Glimmer supports observing widgets with two main types of events:
 
 Additionally, there are two more types of events:
 - SWT `display` supports global listeners called filters that run on any widget. They are hooked via `on_event_{swt-event-constant}`
-- the `shell` widget supports Mac application menu item observers (`on_about` and `on_preferences`), which you can read about under [Miscellaneous](#miscellaneous).
+- SWT `display` supports Mac application menu item observers (`on_about` and `on_preferences`), which you can read about under [Miscellaneous](#miscellaneous).
 
 Number 1 is more commonly used in SWT applications, so make it your starting point. Number 2 covers events not found in number 1, so look into it if you don't find an SWT listener you need in number 1.
 
@@ -1559,8 +1559,8 @@ Custom Widgets have the following attributes available to call from inside the `
 - `#swt_widget`: actual SWT widget for `body_root`
 
 Additionally, custom widgets can call the following class methods:
-- `.options`: declares a list of options by taking an option name array (symbols/strings). This generates option attribute accessors (e.g. `options :orientation, :bg_color` generates `#orientation`, `#orientation=(v)`, `#bg_color`, and `#bg_color=(v)` attribute accessors)
-- `.option`: declares a single option taking option name and default value as arguments (also generates attribute accessors just like `.options`)
+- `::options(*option_names)`: declares a list of options by taking an option name array (symbols/strings). This generates option attribute accessors (e.g. `options :orientation, :bg_color` generates `#orientation`, `#orientation=(v)`, `#bg_color`, and `#bg_color=(v)` attribute accessors)
+- `::option(option_name, default: nil)`: declares a single option taking option name and default value as arguments (also generates attribute accessors just like `::options`)
 
 #### Content/Options Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
 
@@ -1570,7 +1570,7 @@ class Sandwich
   include Glimmer::UI::CustomWidget
 
   options :orientation, :bg_color
-  option :fg_color, :black
+  option :fg_color, default: :black
 
   body {
     composite(swt_style) { # gets custom widget style
@@ -1705,52 +1705,61 @@ shell { |app_shell|
 
 #### Application Menu Items (About/Preferences)
 
-Mac applications always have About and Preferences menu items. Glimmer provides widget observer hooks for them on the `shell` widget:
+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
-shell { |shell_proxy|
-  text 'Application Menu Items'
-  fill_layout {
-    margin_width 15
-    margin_height 15
-  }
-  label {
-    text 'Application Menu Items'
-    font height: 30
-  }
-  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 = shell(:dialog_trim, :application_modal) {
-      text 'Preferences'
-      row_layout {
-        type :vertical
-        margin_left 15
-        margin_top 15
-        margin_right 15
-        margin_bottom 15
+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
       }
-      label {
-        text 'Check one of these options:'
+      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
       }
-      button(:radio) {
-        text 'Option 1'
+    }
+    @shell_proxy = shell {
+      text 'Application Menu Items'
+      fill_layout {
+        margin_width 15
+        margin_height 15
       }
-      button(:radio) {
-        text 'Option 2'
+      label {
+        text 'Application Menu Items'
+        font height: 30
       }
     }
-    preferences_dialog.open
-  }
-}.open
+    @shell_proxy.open
+  end
+end
+
+Example.new
 ```
 
 #### App Name and Version

data/VERSION

@@ -1 +1 @@
-0.7.8
+0.8.0

data/lib/glimmer/launcher.rb

@@ -27,7 +27,7 @@ module Glimmer
       Optionally, extra Glimmer options, JRuby options and environment variables may be passed in.
     
       Glimmer options:
-      - "--quiet"           : Does not announce file path of Glimmer application being launched nor enable logging
+      - "--quiet"           : Does not announce file path of Glimmer application being launched
       - "--debug"           : Displays extra debugging information, passes "--debug" to JRuby, and enables debug logging
       - "--log-level=VALUE" : Sets Glimmer's Ruby logger level ("ERROR" / "WARN" / "INFO" / "DEBUG"; default is none)
     

data/lib/glimmer/scaffold.rb

@@ -424,9 +424,9 @@ class Scaffold
     ## Add options like the following to configure CustomShell by outside consumers
     #
     # options :title, :background_color
-    # option :width, 320
-    # option :height, 240
-    option :greeting, 'Hello, World!'
+    # option :width, default: 320
+    # option :height, default: 240
+    option :greeting, default: 'Hello, World!'
 
     ## Use before_body block to pre-initialize variables to use in body
     #
@@ -438,6 +438,14 @@ class Scaffold
     before_body {
       Display.setAppName('#{shell_type == :gem ? human_name(custom_shell_name) : human_name(namespace)}')
       Display.setAppVersion(VERSION)
+      @display = display {
+        on_about {
+          display_about_dialog
+        }
+        on_preferences {
+          display_preferences_dialog
+        }
+      }
     }
         MULTI_LINE_STRING
       else
@@ -465,20 +473,6 @@ class Scaffold
         minimum_size 320, 240
         text "#{human_name(namespace)} - #{human_name(custom_shell_name)}"
         grid_layout
-      MULTI_LINE_STRING
-      
-      if %i[gem app].include?(shell_type)
-        custom_shell_file_content += <<-MULTI_LINE_STRING      
-        on_about {
-          display_about_dialog
-        }
-        on_preferences {
-          display_preferences_dialog
-        }
-        MULTI_LINE_STRING
-      end
-      
-      custom_shell_file_content += <<-MULTI_LINE_STRING
         label(:center) {
           text bind(self, :greeting)
           font height: 40
@@ -552,7 +546,7 @@ end
             ## Add options like the following to configure CustomWidget by outside consumers
             #
             # options :custom_text, :background_color
-            # option :foreground_color, :red
+            # option :foreground_color, default: :red
         
             ## Use before_body block to pre-initialize variables to use in body
             #

data/lib/glimmer/swt/display_proxy.rb

@@ -16,6 +16,8 @@ module Glimmer
     class DisplayProxy
       include_package 'org.eclipse.swt.widgets'
 
+      OBSERVED_MENU_ITEMS = ['about', 'preferences']
+
       class << self
         # Returns singleton instance
         def instance(*args)
@@ -52,6 +54,9 @@ module Glimmer
         if observation_request.start_with?('on_event_')
           constant_name = observation_request.sub(/^on_event_/, '')
           SWTProxy.has_constant?(constant_name)
+        elsif observation_request.start_with?('on_')
+          event_name = observation_request.sub(/^on_/, '')
+          OBSERVED_MENU_ITEMS.include?(event_name)
         else
           false
         end
@@ -61,6 +66,15 @@ module Glimmer
         if observation_request.start_with?('on_event_')
           constant_name = observation_request.sub(/^on_event_/, '')
           add_swt_event_listener(constant_name, &block)
+        elsif observation_request.start_with?('on_')
+          event_name = observation_request.sub(/^on_/, '')
+          if OBSERVED_MENU_ITEMS.include?(event_name)
+            if OS.mac?
+              system_menu = swt_display.getSystemMenu
+              menu_item = system_menu.getItems.find {|menu_item| menu_item.getID == SWTProxy["ID_#{event_name.upcase}"]}
+              menu_item.addListener(SWTProxy[:Selection], &block)
+            end
+          end
         end
       end
 

data/lib/glimmer/swt/menu_proxy.rb

@@ -79,6 +79,23 @@ module Glimmer
           super(attribute_name)
         end
       end
+      
+      def can_handle_observation_request?(observation_request, super_only: false)
+        super_result = super(observation_request)
+        if observation_request.start_with?('on_') && !super_result && !super_only
+          return menu_item_proxy.can_handle_observation_request?(observation_request)
+        else
+          super_result
+        end
+      end
+      
+      def handle_observation_request(observation_request, &block)
+        if can_handle_observation_request?(observation_request, super_only: true)
+          super
+        else
+          menu_item_proxy.handle_observation_request(observation_request, &block)
+        end
+      end      
     end
   end
 end

data/lib/glimmer/swt/shell_proxy.rb

@@ -14,7 +14,6 @@ module Glimmer
 
       WIDTH_MIN = 130
       HEIGHT_MIN = 0
-      OBSERVED_MENU_ITEMS = ['about', 'preferences']
 
       attr_reader :opened_before
       alias opened_before? opened_before
@@ -128,30 +127,6 @@ module Glimmer
         end
       end
 
-      def can_handle_observation_request?(observation_request)
-        result = false
-        if observation_request.start_with?('on_')
-          event_name = observation_request.sub(/^on_/, '')
-          result = OBSERVED_MENU_ITEMS.include?(event_name)
-        end
-        result || super
-      end
-
-      def handle_observation_request(observation_request, &block)
-        if observation_request.start_with?('on_')
-          event_name = observation_request.sub(/^on_/, '')
-          if OBSERVED_MENU_ITEMS.include?(event_name)
-            if OS.mac?
-              system_menu = DisplayProxy.instance.swt_display.getSystemMenu
-              menu_item = system_menu.getItems.find {|menu_item| menu_item.getID == SWTProxy["ID_#{event_name.upcase}"]}
-              menu_item.addListener(SWTProxy[:Selection], &block)
-            end
-          else
-            super
-          end
-        end
-      end
-
       def add_observer(observer, property_name)
         case property_name.to_s
         when 'visible?' #TODO see if you must handle non-? version and/or move elsewhere

data/lib/glimmer/ui/custom_widget.rb

@@ -70,7 +70,7 @@ module Glimmer
           @custom_widget_namespaces = Set[Object, Glimmer::UI]
         end
 
-        # Allows defining convenience option readers for an array of option names
+        # Allows defining convenience option accessors for an array of option names
         # Example: `options :color1, :color2` defines `#color1` and `#color2`
         # where they return the instance values `options[:color1]` and `options[:color2]`
         # respectively.
@@ -87,9 +87,9 @@ module Glimmer
           end
         end
 
-        def option(new_option, new_option_default = nil)
+        def option(new_option, default: nil)
           new_option = new_option.to_s.to_sym
-          new_options = {new_option => new_option_default}
+          new_options = {new_option => default}
           @options = options.merge(new_options)
           def_option_attr_accessors(new_options)
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.8.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-description: Desktop Development Library for Ruby
+description: Ruby Desktop Development GUI Library
 email: andy.am@gmail.com
 executables:
 - glimmer
@@ -299,5 +299,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
-summary: Desktop Development Library for Ruby
+summary: Ruby Desktop Development GUI Library
 test_files: []