glimmer 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc35b055fcf86d7c93b264b409424039c63c0361f0a7b587e9db0f2071e7809e
-  data.tar.gz: 3ab0eec08e13367c717ee74a984fea0ee49bbd309fd2fd3348fb40e70b156b2c
+  metadata.gz: c1cfa3ffb6be614db3b3e6509edf06c483067889a384c0ffbe94cfb27eea3c73
+  data.tar.gz: 4e30d971345d5df61a8ffcd7d736cc71cf2e7992dfe75fba39763ecba1bcbc6d
 SHA512:
-  metadata.gz: '059e99839505e645cc41cd13d0adc2f04680643dd7d45d6b6ecb0e9e2fec7823f330f0962756f745ba9ca564c945fb97480e988d21efd732fb3ec36185c8dc89'
-  data.tar.gz: eb9f191f5aa31e9d716b787bb1b54d0792fb2aaaf080f8f37b7dd17e0ada300192986910b8fe3bcf777a1da7382cf5bd8dd3c6d59bccf63703fbcb95b3fa7bc9
+  metadata.gz: be20760fda63f6b5458fd00ddcdd1f008057a3b376ad11dbaaa9ee488c0ec72cf67d9322b9f6673d23ff8c49679dc636ef98b17db0a8092fdabf41010f400074
+  data.tar.gz: 221280c0420afd17a8f843b2691b445ee2da99240d7b916e4f3af52eec1772458aa846393db9dbc6c44ba8ee1874b53ad517a946ffb05a39653fd669cd771163

data/README.markdown

@@ -5,9 +5,11 @@ Glimmer is a cross-platform Ruby desktop development library. Glimmer's main inn
 
 You may learn more by reading this article: [Eclipse Zone Tutorial](http://eclipse.dzone.com/articles/an-introduction-glimmer)
 
-## Example
+## Examples
 
-Code (`hello_world.rb`):
+### Hello World
+
+Glimmer code (from `samples/hello_world.rb`):
 ```ruby
 include Glimmer
 
@@ -21,13 +23,47 @@ shell {
 
 Run:
 ```
-glimmer hello_world.rb
+glimmer samples/hello_world.rb
 ```
 
 Glimmer app:
 
-![Glimmer](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-world.png)
+![Hello World](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-hello-world.png)
+
+### Tic Tac Toe
 
+Glimmer code (from `samples/tictactoe/tic_tac_toe.rb`):
+
+```ruby
+shell {
+  text "Tic-Tac-Toe"
+  composite {
+    layout GridLayout.new(3,true)
+    (1..3).each { |row|
+      (1..3).each { |column|
+        button {
+          layout_data GridData.new(:fill.swt_constant, :fill.swt_constant, 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 {
+            @tic_tac_toe_board.mark_box(row, column)
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+Run:
+
+```
+glimmer samples/tictactoe/tic_tac_toe.rb
+```
+
+Glimmer app:
+
+![Tic Tac Toe](https://github.com/AndyObtiva/glimmer/raw/master/images/glimmer-tic-tac-toe.png)
 
 ## Resources
 
@@ -66,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.1
+jgem install glimmer -v 0.3.2
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.3.1'
+gem 'glimmer', '~> 0.3.2'
 ```
 
 And, then run:
@@ -148,6 +184,43 @@ The fifth example demonstrates nested indexed computed value data binding whereb
 
 You may learn more about Glimmer's syntax by reading the Eclipse Zone Tutorial mentioned in resources and opening up the samples under the `samples` folder.
 
+### Observer/Observable
+
+Glimmer comes with the two classes `Observer`/`Observable`, which are 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.
+
+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.
+
+```ruby
+observe(@tic_tac_toe_board, "game_status")
+```
+
+```ruby
+def update(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
+```
+
 ## Samples
 
 Check the "samples" folder for examples on how to write Glimmer applications. To run them, make sure to install the `glimmer` gem first and then use the `glimmer` command.
@@ -232,6 +305,9 @@ These features have been suggested. You might see them in a future version of Gl
 a new component and extend the DSL with it
 - **Nested indexed property data binding**: a complementary feature to nested property data binding that binds to a collection element by index (e.g. `bind(user, 'addresses[1].street')`)
 - **bind_collection**: an iterator that enables spawning widgets based on a variable collection (e.g. `bind_collection('user.addresses') { |address| address_widget {...} }` spawns 3 `AddressWidget`s if `user.addresses` is set with 3 addresses; and replaces with 2 `AddressWidget`s if `user.addresses` is reset with 2 addresses only). Needs further thought on naming and functionality.
+- Automatic relayout of "glimmer components" when disposing one or as an option
+- Consider using Ruby Refinements for Glimmer
+
 
 ## Contributors
 

data/lib/command_handlers/combo_selection_data_binding_command_handler.rb

@@ -22,7 +22,6 @@ class ComboSelectionDataBindingCommandHandler
     widget_binding = WidgetBinding.new(parent, "items")
     widget_binding.update(model_binding.evaluate_options_property)
     model = model_binding.base_model
-    model.extend(ObservableModel) unless model.is_a?(ObservableModel)
     widget_binding.observe(model, model_binding.options_property_name)
 
     widget_binding = WidgetBinding.new(parent, "text")

data/lib/command_handlers/list_selection_data_binding_command_handler.rb

@@ -23,7 +23,6 @@ class ListSelectionDataBindingCommandHandler
     widget_binding = WidgetBinding.new(parent, "items")
     widget_binding.update(model_binding.evaluate_options_property)
     model = model_binding.base_model
-    model.extend(ObservableModel) unless model.is_a?(ObservableModel)
     #TODO make this options observer dependent and all similar observers in widget specific data binding handlers
     widget_binding.observe(model, model_binding.options_property_name)
 

data/lib/command_handlers/models/list_selection_binding.rb

@@ -1,8 +1,10 @@
-require File.dirname(__FILE__) + "/observer"
+require_relative 'observable'
+require_relative 'observer'
 
 # SWT List widget selection binding
 class ListSelectionBinding
   include Glimmer
+  include Observable
   include Observer
 
   attr_reader :widget

data/lib/command_handlers/models/model_binding.rb

@@ -1,7 +1,9 @@
+require_relative 'observable'
 require_relative 'observer'
 require_relative 'block_observer'
 
 class ModelBinding
+  include Observable
   include Observer
 
   attr_reader :property_type, :binding_options
@@ -110,7 +112,6 @@ class ModelBinding
     elsif nested_property?
       add_nested_observers(observer)
     else
-      model.extend(ObservableModel) unless model.is_a?(ObservableModel)
       observer.observe(model, property_name)
       observer.add_dependent([self, nil] => [observer, model, property_name])
     end
@@ -124,7 +125,6 @@ class ModelBinding
     elsif nested_property?
       nested_property_observers_for(observer).clear
     else
-      model.extend(ObservableModel) unless model.is_a?(ObservableModel)
       observer.unobserve(model, property_name)
     end
   end
@@ -155,12 +155,11 @@ class ModelBinding
       parent_property_name = nil if parent_property_name.to_s.start_with?('[')
       unless model.nil?
         if property_indexed?(property_name)
-          model.extend(ObservableArray) unless model.is_a?(ObservableArray)
-          nested_property_observer.observe(model) unless model.has_observer?(nested_property_observer)
+          # TODO figure out a way to deal with this more uniformly
+          nested_property_observer.observe(model)
           parent_observer.add_dependent([parent_model, parent_property_name] => [nested_property_observer, model, nil])
         else
-          model.extend(ObservableModel) unless model.is_a?(ObservableModel)
-          nested_property_observer.observe(model, property_name) unless model.has_observer?(nested_property_observer, property_name)
+          nested_property_observer.observe(model, property_name)
           parent_observer.add_dependent([parent_model, parent_property_name] => [nested_property_observer, model, property_name])
         end
       end

data/lib/command_handlers/models/observable_array.rb

@@ -7,10 +7,10 @@ module ObservableArray
   include Observable
 
   def add_observer(observer, element_properties=nil)
+    return observer if has_observer?(observer) && element_properties.nil?
     property_observer_list << observer
     [element_properties].flatten.compact.each do |property|
       each do |element|
-        element.extend(ObservableModel) unless element.is_a?(ObservableModel)
         observer.observe(element, property)
       end
     end
@@ -21,7 +21,6 @@ module ObservableArray
     property_observer_list.delete(observer)
     [element_properties].flatten.compact.each do |property|
       each do |element|
-        element.extend(ObservableModel) unless element.is_a?(ObservableModel)
         observer.unobserve(element, property)
       end
     end

data/lib/command_handlers/models/observable_model.rb

@@ -54,6 +54,7 @@ module ObservableModel
 
   def add_property_writer_observers(property_name)
     property_writer_name = "#{property_name}="
+    method(property_writer_name)
     ensure_array_object_observer(property_name, send(property_name))
     begin
       method("__original_#{property_writer_name}")
@@ -69,6 +70,9 @@ module ObservableModel
         end
       end_eval
     end
+  rescue => e
+    # ignore writing if no property writer exists
+    Glimmer.logger.debug "No need to observe property writer: #{property_writer_name}\n#{e.message}\n#{e.backtrace.join("\n")}"
   end
 
   def unregister_dependent_observers(property_name, old_value)
@@ -81,7 +85,6 @@ module ObservableModel
 
   def ensure_array_object_observer(property_name, object, old_object = nil)
     return unless object.is_a?(Array)
-    object.extend(ObservableArray) unless object.is_a?(ObservableArray)
     array_object_observer = array_object_observer_for(property_name)
     array_object_observer.observe(object)
     property_observer_list(property_name).each do |observer|

data/lib/command_handlers/models/observer.rb

@@ -25,6 +25,14 @@ module Observer
   # registers observer in an observable on a property (optional)
   # observer maintains registration list to unregister later
   def register(observable, property = nil)
+    unless observable.is_a?(Observable)
+      # TODO refactor code to be more smart/polymorphic/automated and honor open/closed principle
+      if observable.is_a?(Array)
+        observable.extend(ObservableArray)
+      else
+        observable.extend(ObservableModel)
+      end
+    end
     observable.add_observer(*[self, property].compact)
     [observable, property].tap do |registration|
       self.registrations << registration

data/lib/command_handlers/models/r_widget.rb

@@ -1,9 +1,10 @@
-require File.dirname(__FILE__) + "/r_widget_listener"
-require File.dirname(__FILE__) + "/r_runnable"
+require_relative "r_widget_listener"
+require_relative "r_runnable"
 
 class RWidget
-  require File.dirname(__FILE__) + "/r_widget_packages"
-
+  include_package 'org.eclipse.swt'
+  include_package 'org.eclipse.swt.widgets'
+  include_package 'org.eclipse.swt.layout'
   include Parent
 
   attr_reader :widget

data/lib/command_handlers/models/table_items_binding.rb

@@ -1,9 +1,11 @@
-require File.dirname(__FILE__) + "/observable_array"
-require File.dirname(__FILE__) + "/observable_model"
-require File.dirname(__FILE__) + "/observer"
+require_relative 'observable_array'
+require_relative 'observable_model'
+require_relative 'observable'
+require_relative 'observer'
 
 class TableItemsBinding
   include Glimmer
+  include Observable
   include Observer
   include_package 'org.eclipse.swt'
   include_package 'org.eclipse.swt.widgets'
@@ -14,7 +16,6 @@ class TableItemsBinding
     @column_properties = column_properties
     update(@model_binding.evaluate_property)
     model = model_binding.base_model
-    model.extend(ObservableModel) unless model.is_a?(ObservableModel)
     observe(model, model_binding.property_name_expression)
     add_contents(@table) {
       on_widget_disposed { |dispose_event|
@@ -24,7 +25,6 @@ class TableItemsBinding
   end
   def update(model_collection=nil)
     if model_collection and model_collection.is_a?(Array)
-      model_collection.extend(ObservableArray) unless model_collection.is_a?(ObservableArray)
       observe(model_collection, @column_properties)
       @model_collection = model_collection
     end

data/lib/command_handlers/models/tree_items_binding.rb

@@ -1,9 +1,11 @@
-require File.dirname(__FILE__) + "/observable_array"
-require File.dirname(__FILE__) + "/observable_model"
-require File.dirname(__FILE__) + "/observer"
+require_relative 'observable_array'
+require_relative 'observable_model'
+require_relative 'observable'
+require_relative 'observer'
 
 class TreeItemsBinding
   include Glimmer
+  include Observable
   include Observer
   include_package 'org.eclipse.swt'
   include_package 'org.eclipse.swt.widgets'
@@ -14,7 +16,6 @@ class TreeItemsBinding
     @tree_properties = [tree_properties].flatten.first.to_h
     update(@model_binding.evaluate_property)
     model = model_binding.base_model
-    model.extend(ObservableModel) unless model.is_a?(ObservableModel)
     observe(model, model_binding.property_name_expression)
     add_contents(@tree) {
       on_widget_disposed { |dispose_event|
@@ -24,7 +25,6 @@ class TreeItemsBinding
   end
   def update(model_tree_root_node=nil)
     if model_tree_root_node and model_tree_root_node.respond_to?(@tree_properties[:children])
-      model_tree_root_node.extend(ObservableModel) unless model_tree_root_node.is_a?(ObservableModel)
       observe(model_tree_root_node, @tree_properties[:text])
       observe(model_tree_root_node, @tree_properties[:children])
       @model_tree_root_node = model_tree_root_node
@@ -39,7 +39,6 @@ class TreeItemsBinding
     table_item = TreeItem.new(parent, SWT::NONE)
     table_item.setText((model_tree_node && model_tree_node.send(tree_properties[:text])).to_s)
       [model_tree_node && model_tree_node.send(tree_properties[:children])].flatten.to_a.compact.each do |child|
-      child.extend(ObservableModel) unless child.is_a?(ObservableModel)
       observe(child, @tree_properties[:text])
       populate_tree_node(child, table_item, tree_properties)
     end

data/lib/command_handlers/models/widget_binding.rb

@@ -1,7 +1,9 @@
-require File.dirname(__FILE__) + "/observer"
+require_relative 'observable'
+require_relative 'observer'
 
 class WidgetBinding
   include Glimmer
+  include Observable
   include Observer
 
   attr_reader :widget, :property

data/lib/glimmer.rb

@@ -7,13 +7,20 @@ require "rubygems"
 require "facets"
 require "logger"
 require "java"
-require File.dirname(__FILE__) + "/string"
-require File.dirname(__FILE__) + "/symbol"
-require File.dirname(__FILE__) + "/parent"
+require_relative "string"
+require_relative "symbol"
+require_relative "parent"
+require_relative "swt_packages"
 
 module Glimmer
-
-  include_package 'org.eclipse.swt'
+   #TODO make it configurable to include or not include
+  include SwtPackages
+  def self.included(klass)
+    klass.include SwtPackages
+  end
+  def self.extended(klass)
+    klass.include SwtPackages
+  end
 
   @@parent_stack = []
   @@logger = Logger.new(STDOUT).tap {|logger| logger.level = Logger::WARN}

data/lib/swt_packages.rb

@@ -0,0 +1,11 @@
+# edit to add more packages and support custom widgets
+module SwtPackages
+  def self.included(klass)
+    klass.class_eval do
+      include_package 'org.eclipse.swt'
+      include_package 'org.eclipse.swt.widgets'
+      include_package 'org.eclipse.swt.layout'
+      include_package 'org.eclipse.swt.graphics'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - AndyMaleh
@@ -171,7 +171,6 @@ files:
 - lib/command_handlers/models/r_tab_item_composite.rb
 - lib/command_handlers/models/r_widget.rb
 - lib/command_handlers/models/r_widget_listener.rb
-- lib/command_handlers/models/r_widget_packages.rb
 - lib/command_handlers/models/table_items_binding.rb
 - lib/command_handlers/models/tree_items_binding.rb
 - lib/command_handlers/models/widget_binding.rb
@@ -189,6 +188,7 @@ files:
 - lib/parent.rb
 - lib/shine.rb
 - lib/string.rb
+- lib/swt_packages.rb
 - lib/symbol.rb
 - lib/xml_command_handlers.rb
 - lib/xml_command_handlers/html_command_handler.rb

data/lib/command_handlers/models/r_widget_packages.rb

@@ -1,6 +0,0 @@
-# edit to add more packages and support custom widgets
-class RWidget
-  include_package 'org.eclipse.swt'
-  include_package 'org.eclipse.swt.layout'
-  include_package 'org.eclipse.swt.widgets'
-end