glimmer 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 425d16ab524a7ca569aad23a16f90be2d191e30f9718ccc29829eadc4d479b73
-  data.tar.gz: 5b23ea4769c1921379f6a3314a9e5496e1b339dd3ea43b12bfef58678cf17be2
+  metadata.gz: '039508d9d31dec60207c13aa5ab20abe07af71d5e1d06fa2e26694151e06a124'
+  data.tar.gz: 402f7855f32fa23a157d044dd5f080b7ab4a9c16c353ed209a14d46565ab2c9b
 SHA512:
-  metadata.gz: 5415bc5431a2ea2b4368c58bb97212cf6aea9f2711df08bd7757a5ee9c6eb84931616c082b023039d59dcea8140408e870973bf0043d07607667fa9e12381de6
-  data.tar.gz: 71678e659abb1776861c6f054520be42631b72e8013f0d5c3bbf399dedf09b9a2e0681155dda4ef327a73d7298a7c4628dd98076cb286ee0a8b2054dcf055c9d
+  metadata.gz: 07ae480ae5c8807d663bead2005fd303f53238c3b8684e70b8e87c30341c119faf2a3420e25fa75037cd44019fc8ed7f09f7d0bb58bbe395e8fa353b29a5bbbf
+  data.tar.gz: cf4866df36d0fcd4dd75192e246edbf77bde8c63bd741adb5fc5969202415e22430b15091bac5b53a4dd9778f0f15679666d52f2cee2648b49836d1ac8ad4ee0

data/README.markdown

@@ -42,7 +42,7 @@ shell {
     (1..3).each { |row|
       (1..3).each { |column|
         button {
-          layout_data GridData.new(RSwt[:fill], RSwt[:fill], true, true)
+          layout_data GridData.new(GSWT[:fill], GSWT[:fill], true, true)
           text        bind(@tic_tac_toe_board.box(row, column), :sign)
           enabled     bind(@tic_tac_toe_board.box(row, column), :empty)
           on_widget_selected {
@@ -102,14 +102,14 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.3.5
+jgem install glimmer -v 0.4.0
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.3.5'
+gem 'glimmer', '~> 0.4.0'
 ```
 
 And, then run:
@@ -198,13 +198,13 @@ Glimmer ships with SWT style **smart defaults** so you wouldn't have to set them
 
 You may check out all available `SWT` styles here:
 
-https://help.eclipse.org/2019-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
 
 **Final Note** (advanced case outside of standard Glimmer DSL):
 
 When building a widget-related SWT object manually (e.g. `GridData.new(...)`), you are expected to use `SWT::CONSTANT` directly or BIT-OR a few SWT constants together like `SWT::BORDER | SWT::V_SCROLL`.
 
-Glimmer facilitates that with `RSwt` class by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR. For example: `RSwt[:border, :v_scroll]`
+Glimmer facilitates that with `GSWT` class by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR. For example: `GSWT[:border, :v_scroll]`
 
 ### Widget Properties
 
@@ -257,9 +257,9 @@ label {
 }
 ```
 
-You may check out all available standard colors in `SWT` over here:
+You may check out all available standard colors in `SWT` over here (having `COLOR_` prefix):
 
-https://help.eclipse.org/2019-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
 
 ### Fonts
 
@@ -314,36 +314,69 @@ You may learn more about Glimmer's syntax by reading the Eclipse Zone Tutorial m
 
 Glimmer comes with `Observer` module, which is used internally for data-binding, but can also be used externally for custom use of the Observer Pattern.
 
-In summary, the class that needs to observe an object, must include Observer and implement `#update(changed_value)` method. The class to be observed doesn't need to do anything. It will automatically be enhanced by Glimmer for observation.
+In summary, the class that needs to observe an object, must include Observer and implement `#call(new_value)` method. The class to be observed doesn't need to do anything. It will automatically be enhanced by Glimmer for observation.
 
-Observers can be a good mechanism for displaying dialog messages with Glimmer (using SWT's `MessageBox`).
-
-Look at `samples/tictactoe/tic_tac_toe.rb` for an `Observer` dialog message example.
+To register observer, one has to call the `#observe` method and pass in the observable and the property(ies) to observe.
 
 ```ruby
-observe(@tic_tac_toe_board, "game_status")
+class TicTacToe
+  include Glimmer
+  include Observer
+
+  def initialize
+    # ...
+    observe(@tic_tac_toe_board, "game_status")
+  end
+
+  def call(game_status)
+    display_win_message if game_status == TicTacToeBoard::WIN
+    display_draw_message if game_status == TicTacToeBoard::DRAW
+  end
+  # ...
+end
 ```
 
+Alternatively, one can use a default Observer::Proc implementation via Observer#proc method:
 ```ruby
-def update(game_status)
-  display_win_message if game_status == TicTacToeBoard::WIN
-  display_draw_message if game_status == TicTacToeBoard::DRAW
-end
+observer = Observer.proc { |new_value| puts new_value }
+observer.observe(@tic_tac_toe_board, "game_status")
+```
 
-def display_win_message
-  display_game_over_message("Player #{@tic_tac_toe_board.winning_sign} has won!")
-end
+Observers can be a good mechanism for displaying dialog messages with Glimmer (using SWT's `MessageBox`).
 
-def display_draw_message
-  display_game_over_message("Draw!")
-end
+Look at `samples/tictactoe/tic_tac_toe.rb` for an `Observer` dialog message example (sample below).
 
-def display_game_over_message(message)
-  message_box = MessageBox.new(@shell.widget)
-  message_box.setText("Game Over")
-  message_box.setMessage(message)
-  message_box.open
-  @tic_tac_toe_board.reset
+```ruby
+class TicTacToe
+  include Glimmer
+  include Observer
+
+  def initialize
+    # ...
+    observe(@tic_tac_toe_board, "game_status")
+  end
+
+  def call(game_status)
+    display_win_message if game_status == TicTacToeBoard::WIN
+    display_draw_message if game_status == TicTacToeBoard::DRAW
+  end
+
+  def display_win_message
+    display_game_over_message("Player #{@tic_tac_toe_board.winning_sign} has won!")
+  end
+
+  def display_draw_message
+    display_game_over_message("Draw!")
+  end
+
+  def display_game_over_message(message)
+    message_box = MessageBox.new(@shell.widget)
+    message_box.setText("Game Over")
+    message_box.setMessage(message)
+    message_box.open
+    @tic_tac_toe_board.reset
+  end
+  # ...
 end
 ```
 
@@ -361,6 +394,10 @@ glimmer samples/hello_world.rb
 
 https://www.eclipse.org/swt/docs.php
 
+Here is the SWT API:
+
+https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/index.html
+
 Here is a list of SWT widgets:
 
 https://help.eclipse.org/2019-12/topic/org.eclipse.platform.doc.isv/guide/swt_widgets_controls.htm?cp=2_0_7_0_0
@@ -373,7 +410,7 @@ https://wiki.eclipse.org/SWT_Widget_Style_Bits
 
 Glimmer automatically imports all SWT Java packages upon adding `include Glimmer` to a class or module.
 
-Still, if you'd like to import manually elsewhere, you may add the following lines to your code:
+Still, if you'd like to import manually elsewhere, you may add the following lines to your code import a SWT Java package using `include_package`:
 
 ```ruby
 include_package 'org.eclipse.swt'
@@ -382,9 +419,15 @@ include_package 'org.eclipse.swt.layout'
 include_package 'org.eclipse.swt.graphics'
 ```
 
-This allows you to call Java SWT classes from Ruby without indicating the package explicitly.
+Or only import a specific SWT Java class using `java_import`:
+
+```ruby
+java_import 'org.eclipse.swt.SWT'
+```
+
+This allows you to call SWT Java classes from Ruby without mentioning package namespaces.
 
-For example, `org.eclipse.swt.graphics.Color` becomes `Color`
+For example, after imports, `org.eclipse.swt.graphics.Color` can be referred to by just `Color`
 
 ## Girb (Glimmer irb)
 
@@ -458,9 +501,28 @@ a new component and extend the DSL with it
 - Avoid disposing display when disposing a shell to allow recycling
 - Provide a display builder method to use independently of shell
 - Supported a single computed data binding as a string (not array)
-- Disallow use of SWT::CONSTANTs with ORing since it's not intuitive at all
 - Support data binding translator option via a block
 - Center windows upon launching
+- Add TruffleRuby support
+- Make Shell automatically use last instantiated Display if not disposed
+- Allow ability to instantiate Display independently of Shell
+
+## Release Notes
+
+[RELEASE.md](https://github.com/AndyObtiva/glimmer/blob/master/RELEASE.md)
+
+## Contributing
+
+- Clone repo
+- Setup pre-requisites (installing JRuby via RVM on the Mac)
+- cd into project again to activiate RVM glimmer gemset
+- gem install bundler
+- bundle
+- rake # runs specs (ensure they finish successfully)
+- rake install # builds/installs glimmer gem to be able to run samples via (glimmer samples/**)
+
+To run a specific spec, run:
+`rake SPEC=spec_file_path`
 
 ## Contributors
 

data/lib/glimmer.rb

@@ -7,10 +7,8 @@ require "rubygems"
 require "facets"
 require "logger"
 require "java"
-require_relative "string"
-require_relative "symbol"
-require_relative "parent"
-require_relative "swt_packages"
+require_relative "glimmer/parent"
+require_relative "glimmer/swt_packages"
 
 module Glimmer
    #TODO make it configurable to include or not include
@@ -63,5 +61,5 @@ module Glimmer
 end
 
 # Command handlers may rely on Glimmer, so this is put here to avoid an infinite loop.
-require File.dirname(__FILE__) + "/xml_command_handlers"
-require File.dirname(__FILE__) + "/command_handlers"
+require File.dirname(__FILE__) + "/glimmer/xml_command_handlers"
+require File.dirname(__FILE__) + "/glimmer/command_handlers"

data/lib/glimmer/command_handler.rb

@@ -0,0 +1,10 @@
+module Glimmer
+  module CommandHandler
+    def can_handle?(parent, command_symbol, *args, &block)
+      raise "must be implemented by a class"
+    end
+    def do_handle(parent, command_symbol, *args, &block)
+      raise "must be implemented by a class"
+    end
+  end
+end

data/lib/glimmer/command_handler_chain_factory.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + "/command_handler_chain_link"
+
+module Glimmer
+  class CommandHandlerChainFactory
+    @@dsls = {}
+
+    def self.def_dsl(dsl, *command_handler_array)
+      @@last_chain_link = nil
+      @@chain = nil
+      command_handler_array.each do |command_handler|
+        Glimmer.logger.debug "Loading #{command_handler.class.to_s}..."
+        chain_link = CommandHandlerChainLink.new(command_handler)
+        @@last_chain_link.chain_to(chain_link) if @@last_chain_link
+        @@last_chain_link = chain_link
+        @@chain = chain_link unless @@chain
+      end
+      @@dsls[dsl] = {
+        :last_chain_link => @@last_chain_link,
+        :chain => @@chain
+      }
+    end
+
+    def self.select_dsl(dsl)
+      @@last_chain_link = @@dsls[dsl][:last_chain_link]
+      @@chain = @@dsls[dsl][:chain]
+    end
+
+    def self.chain
+      @@chain
+    end
+  end
+end

data/lib/glimmer/command_handler_chain_link.rb

@@ -0,0 +1,21 @@
+module Glimmer
+  class CommandHandlerChainLink
+    def initialize(command_handler)
+      @command_handler = command_handler
+    end
+    def chain_to(next_chain_link)
+      @next_chain_link = next_chain_link
+    end
+    def handle(parent, command_symbol, *args, &block)
+      if (@command_handler.can_handle?(parent, command_symbol, *args, &block))
+        Glimmer.logger.debug "#{@command_handler.class.to_s} will handle command: #{command_symbol} with arguments #{args}"
+        return @command_handler.do_handle(parent, command_symbol, *args, &block)
+      elsif @next_chain_link
+        return @next_chain_link.handle(parent, command_symbol, *args, &block)
+      else
+        Glimmer.logger.debug "Command: #{command_symbol} cannot be handled!"
+        return nil
+      end
+    end
+  end
+end

data/lib/{command_handlers.rb → glimmer/command_handlers.rb}

@@ -1,5 +1,6 @@
 require_relative "command_handler_chain_factory"
 require_relative "command_handlers/color_command_handler"
+require_relative "command_handlers/display_command_handler"
 require_relative "command_handlers/shell_command_handler"
 require_relative "command_handlers/widget_listener_command_handler"
 require_relative "command_handlers/bind_command_handler"
@@ -14,20 +15,23 @@ require_relative "command_handlers/data_binding_command_handler"
 require_relative "command_handlers/widget_method_command_handler"
 require_relative "command_handlers/widget_command_handler"
 
-# edit to add more command handlers and extend Glimmer
-CommandHandlerChainFactory.def_dsl(:swt,
-  ShellCommandHandler.new,
-  WidgetListenerCommandHandler.new,
-  BindCommandHandler.new,
-  TabItemCommandHandler.new,
-  ComboSelectionDataBindingCommandHandler.new,
-  ListSelectionDataBindingCommandHandler.new,
-  TreeItemsDataBindingCommandHandler.new,
-  TreePropertiesDataBindingCommandHandler.new,
-  TableItemsDataBindingCommandHandler.new,
-  TableColumnPropertiesDataBindingCommandHandler.new,
-  DataBindingCommandHandler.new,
-  ColorCommandHandler.new,
-  WidgetMethodCommandHandler.new,
-  WidgetCommandHandler.new
-)
+module Glimmer
+  # edit to add more command handlers and extend Glimmer
+  CommandHandlerChainFactory.def_dsl(:swt,
+    DisplayCommandHandler.new,
+    ShellCommandHandler.new,
+    WidgetListenerCommandHandler.new,
+    BindCommandHandler.new,
+    TabItemCommandHandler.new,
+    ComboSelectionDataBindingCommandHandler.new,
+    ListSelectionDataBindingCommandHandler.new,
+    TreeItemsDataBindingCommandHandler.new,
+    TreePropertiesDataBindingCommandHandler.new,
+    TableItemsDataBindingCommandHandler.new,
+    TableColumnPropertiesDataBindingCommandHandler.new,
+    DataBindingCommandHandler.new,
+    ColorCommandHandler.new,
+    WidgetMethodCommandHandler.new,
+    WidgetCommandHandler.new
+  )
+end

data/lib/glimmer/command_handlers/bind_command_handler.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+require File.dirname(__FILE__) + "/models/model_binding"
+
+module Glimmer
+  # Responsible for setting up the return value of the bind keyword (command symbol)
+  # as a ModelBinding. It is then used by another command handler like
+  # DataBindingCommandHandler for text and selection properties on Text and Spinner
+  # or TableItemsDataBindingCommandHandler for items in a Table
+  class BindCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      (
+        parent.is_a?(GWidget) and
+        command_symbol.to_s == "bind" and
+        (
+          (
+            (args.size == 2) and
+            (
+              args[1].is_a?(Symbol) or
+              args[1].is_a?(String)
+            )
+            ) or
+            (
+              (args.size == 3) and
+              (args[1].is_a?(Symbol) or args[1].is_a?(String)) and
+              (args[2].is_a?(Symbol) or args[2].is_a?(String) or args[2].is_a?(Hash))
+              ) or
+              (
+                (args.size == 4) and
+                (args[1].is_a?(Symbol) or args[1].is_a?(String)) and
+                (args[2].is_a?(Symbol) or args[2].is_a?(String)) and
+                (args[3].is_a?(Hash))
+              )
+              ) and
+              block == nil
+            )
+          end
+
+          def do_handle(parent, command_symbol, *args, &block)
+            property_type = args[2] if (args.size == 3) && !args[2].is_a?(Hash)
+            binding_options = args[2] if args[2].is_a?(Hash)
+            binding_options = args[3] if args[3].is_a?(Hash)
+            ModelBinding.new(args[0], args[1].to_s, property_type, binding_options)
+          end
+
+        end
+end

data/lib/glimmer/command_handlers/color_command_handler.rb

@@ -0,0 +1,26 @@
+require_relative '../command_handler'
+require_relative 'models/g_color'
+
+module Glimmer
+  class ColorCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      ['rgba', 'rgb'].include?(command_symbol.to_s) and
+      (3..5).include?(args.count)
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      if args.first.is_a?(Display) || args.first.nil?
+        display = args.delete_at(0)
+      elsif parent.is_a?(GWidget)
+        display = parent.widget.display
+      else
+        display = nil
+      end
+      GColor.new(display, *args)
+    end
+  end
+end

data/lib/glimmer/command_handlers/combo_selection_data_binding_command_handler.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+
+module Glimmer
+  class ComboSelectionDataBindingCommandHandler
+    include CommandHandler
+    include Glimmer
+
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      parent.is_a?(GWidget) and
+      parent.widget.is_a?(Combo) and
+      command_symbol.to_s == "selection" and
+      args.size == 1 and
+      args[0].is_a?(ModelBinding) and
+      args[0].evaluate_options_property.is_a?(Array) and
+      block == nil
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      model_binding = args[0]
+      widget_binding = WidgetBinding.new(parent, "items")
+      widget_binding.call(model_binding.evaluate_options_property)
+      model = model_binding.base_model
+      widget_binding.observe(model, model_binding.options_property_name)
+
+      widget_binding = WidgetBinding.new(parent, "text")
+      widget_binding.call(model_binding.evaluate_property)
+      widget_binding.observe(model, model_binding.property_name_expression)
+
+      add_contents(parent) {
+        on_widget_selected {
+          model_binding.call(widget_binding.evaluate_property)
+        }
+      }
+    end
+
+  end
+end