glimmer 0.4.9 → 0.5.0

data/lib/glimmer.rb

@@ -3,80 +3,71 @@
 # comes with built-in data-binding support to greatly facilitate synchronizing
 # UI with domain models.
 
-require "rubygems"
-require "facets"
-require "super_module"
-require "logger"
-require "java"
-require "nested_inherited_jruby_include_package"
-require_relative "glimmer/parent"
-require_relative "glimmer/swt_packages" #TODO move into SWT namespace
-require_relative "glimmer/swt/custom_widget"
-require_relative 'glimmer/swt/video' # TODO offload to a custom widget directory
-require_relative "glimmer/ext/module"
+require 'facets'
+require 'super_module'
+require 'logger'
+require 'java'
+require 'set'
+require 'nested_inherited_jruby_include_package'
 
+# Glimmer provides a JRuby Desktop UI DSL + Data-Binding functionality
+#
+# A desktop UI application class must include Glimmer to gain access to Glimmer DSL
+#
+# Glimmer DSL static keywords (e.g. rgb, bind, etc..) are available as inherited methods
+# Glimmer DSL dynamic keywords (e.g. label, combo, etc...) are available via method_missing
 module Glimmer
+  #TODO make it configurable to include or not include perhaps reverting to using included
   REGEX_METHODS_EXCLUDED = /^(to_|\[)/
-   #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}
-
-  def self.logger
-    @@logger
-  end
 
-  # TODO calling original method_missing after aliasing for cases where method_missing is not needed, like known excluded symbols
+  class << self
+    def included(klass)
+      if import_swt_packages
+        klass.include(SWT::Packages)
+      end
+    end
 
-  alias method_missing_without_glimmer method_missing
-  def self.method_missing(method_symbol, *args, &block)
-    if method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
-      return method_missing_without_glimmer(method_symbol, *args, &block)
+    # Tells Glimmer to import SWT packages into including class (default: true)
+    def import_swt_packages=(value)
+      @@import_swt_packages = !!value
     end
-    Glimmer.logger.debug "method: " + method_symbol.to_s + " and args: " + args.to_s
-    command_handler_chain = CommandHandlerChainFactory.chain
-    return_value = command_handler_chain.handle(@@parent_stack.last, method_symbol, *args, &block)
-    add_contents(return_value, &block)
-    return return_value
-  # rescue => e
-    # Glimmer.logger.error e.message
-    # method_missing_without_glimmer(method_symbol, *args, &block)
-  end
 
-  # TODO come up with a better public name for this and put on gwidgets directly
-  def self.add_contents(parent, &block)
-    @@parent_stack.push(parent) if parent.is_a?(Parent)
-    @@parent_stack.last.process_block(block) if block and @@parent_stack.last
-    @@parent_stack.pop if parent.is_a?(Parent)
-  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
 
-  def self.dsl(dsl)
-    @@parent_stack = []
-    CommandHandlerChainFactory.select_dsl(dsl)
+    # Returns Glimmer logger (standard Ruby logger)
+    def logger
+      unless defined? @@logger
+        @@logger = Logger.new(STDOUT).tap {|logger| logger.level = Logger::WARN}
+      end
+      @@logger
+    end
   end
 
-  #added for convenience
-
   def method_missing(method_symbol, *args, &block)
-    Glimmer.method_missing(method_symbol, *args, &block)
-  end
-
-  def add_contents(parent, &block)
-    Glimmer.add_contents(parent, &block)
-  end
-
-  def dsl(dsl)
-    Glimmer.dsl(dsl)
+    # This if statement speeds up Glimmer in girb or whenever directly including on main object
+    if method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
+      raise InvalidKeywordError, "Glimmer excluded keyword: #{method_symbol}"
+    end
+    Glimmer.logger.debug "keyword: " + method_symbol.to_s + " and args: " + args.to_s
+    Glimmer::DSL::Engine.interpret(method_symbol, *args, &block)
+  rescue InvalidKeywordError => e
+    if !method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
+      Glimmer.logger.error e.message
+    end
+    Glimmer.logger.debug "#{e.message}\n#{e.backtrace.join("\n")}"
+    super(method_symbol, *args, &block)
   end
 end
 
-# Command handlers may rely on Glimmer, so this is put here to avoid an infinite loop.
-require File.dirname(__FILE__) + "/glimmer/xml_command_handlers" #TODO move into namespace
-require File.dirname(__FILE__) + "/glimmer/command_handlers" #TODO move into namespace
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+require 'glimmer/swt/packages'
+require 'glimmer/dsl'
+require 'glimmer/error'
+require 'glimmer/invalid_keyword_error'

data/lib/glimmer/data_binding/list_selection_binding.rb

@@ -0,0 +1,52 @@
+require 'glimmer'
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
+
+module Glimmer
+  module DataBinding
+    # SWT List widget selection binding
+    class ListSelectionBinding
+      include Glimmer
+      include Observable
+      include Observer
+
+      attr_reader :widget_proxy
+
+      PROPERTY_TYPE_UPDATERS = {
+        :string => lambda { |widget_proxy, value| widget_proxy.swt_widget.select(widget_proxy.swt_widget.index_of(value.to_s)) },
+        :array => lambda { |widget_proxy, value| widget_proxy.swt_widget.selection=(value || []).to_java(:string) }
+      }
+
+      PROPERTY_EVALUATORS = {
+        :string => lambda do |selection_array|
+          return nil if selection_array.empty?
+          selection_array[0]
+        end,
+        :array => lambda do |selection_array|
+          selection_array
+        end
+      }
+
+      # Initialize with list widget and property_type
+      # property_type :string represents default list single selection
+      # property_type :array represents list multi selection
+      def initialize(widget_proxy, property_type)
+        property_type = :string if property_type.nil? or property_type == :undefined
+        @widget_proxy = widget_proxy
+        @property_type = property_type
+        @widget_proxy.on_widget_disposed do |dispose_event|
+          unregister_all_observables
+        end
+      end
+
+      def call(value)
+        PROPERTY_TYPE_UPDATERS[@property_type].call(@widget_proxy, value) unless evaluate_property == value
+      end
+
+      def evaluate_property
+        selection_array = @widget_proxy.swt_widget.send('selection').to_a
+        PROPERTY_EVALUATORS[@property_type].call(selection_array)
+      end
+    end
+  end
+end

data/lib/glimmer/{swt → data_binding}/model_binding.rb

@@ -1,18 +1,20 @@
-require_relative 'observable'
-require_relative 'observer'
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
 
 module Glimmer
-  module SWT
+  module DataBinding
     class ModelBinding
       include Observable
       include Observer
 
       attr_reader :property_type, :binding_options
-      @@property_type_converters = {
+
+      PROPERTY_TYPE_CONVERTERS = {
         :undefined => lambda { |value| value },
         :fixnum => lambda { |value| value.to_i },
         :array => lambda { |value| value.to_a }
       }
+
       def initialize(base_model, property_name_expression, property_type = :undefined, binding_options = nil)
         property_type = :undefined if property_type.nil?
         @base_model = base_model
@@ -25,9 +27,11 @@ module Glimmer
           end
         end
       end
+
       def model
         nested_property? ? nested_model : base_model
       end
+
       # e.g. person.address.state returns [person, person.address]
       def nested_models
         @nested_models = [base_model]
@@ -42,15 +46,19 @@ module Glimmer
         end
         @nested_models
       end
+
       def nested_model
         nested_models.last
       end
+
       def base_model
         @base_model
       end
+
       def property_name
         nested_property? ? nested_property_name : property_name_expression
       end
+
       # All nested property names
       # e.g. property name expression "address.state" gives ['address', 'state']
       # If there are any indexed property names, this returns indexes as properties.
@@ -58,31 +66,39 @@ module Glimmer
       def nested_property_names
         @nested_property_names ||= property_name_expression.split(".").map {|pne| pne.match(/([^\[]+)(\[[^\]]+\])?/).to_a.drop(1)}.flatten.compact
       end
+
       # Final nested property name
       # e.g. property name expression "address.state" gives :state
       def nested_property_name
         nested_property_names.last
       end
+
       # Model representing nested property names
       # e.g. property name expression "address.state" gives [:address]
       def model_property_names
         nested_property_names[0...-1]
       end
+
       def nested_property?
         property_name_expression.match(/[.\[]/)
       end
+
       def property_name_expression
         @property_name_expression
       end
+
       def computed?
         !computed_by.empty?
       end
+
       def computed_by
         [@binding_options[:computed_by]].flatten.compact
       end
+
       def computed_binding_options
         @binding_options.reject {|k,v| k == :computed_by}
       end
+
       def nested_property_observers_for(observer)
         @nested_property_observers_collection ||= {}
         unless @nested_property_observers_collection.has_key?(observer)
@@ -98,6 +114,7 @@ module Glimmer
         end
         @nested_property_observers_collection[observer]
       end
+
       def add_observer(observer)
         if computed?
           add_computed_observers(observer)
@@ -109,6 +126,7 @@ module Glimmer
           observer.add_dependent(my_registration => observer_registration)
         end
       end
+
       def remove_observer(observer)
         if computed?
           @computed_model_bindings.each do |computed_model_binding|
@@ -121,6 +139,7 @@ module Glimmer
           observer.unobserve(model, property_name)
         end
       end
+
       def computed_observer_for(observer)
         @computed_observer_collection ||= {}
         unless @computed_observer_collection.has_key?(observer)
@@ -130,6 +149,7 @@ module Glimmer
         end
         @computed_observer_collection[observer]
       end
+
       def add_computed_observers(observer)
         @computed_model_bindings.each do |computed_model_binding|
           observer_registration = computed_observer_for(observer).observe(computed_model_binding)
@@ -137,6 +157,7 @@ module Glimmer
           observer.add_dependent(my_registration => observer_registration)
         end
       end
+
       def add_nested_observers(observer)
         nested_property_observers = nested_property_observers_for(observer)
         nested_models.zip(nested_property_names).each_with_index do |zip, i|
@@ -159,23 +180,29 @@ module Glimmer
           end
         end
       end
+
       def call(value)
         return if model.nil?
-        converted_value = @@property_type_converters[@property_type].call(value)
+        converted_value = PROPERTY_TYPE_CONVERTERS[@property_type].call(value)
         invoke_property_writer(model, "#{property_name}=", converted_value) unless evaluate_property == converted_value
       end
+
       def evaluate_property
         invoke_property_reader(model, property_name) unless model.nil?
       end
+
       def evaluate_options_property
         model.send(options_property_name) unless model.nil?
       end
+
       def options_property_name
         self.property_name + "_options"
       end
+
       def property_indexed?(property_expression)
         property_expression.start_with?('[')
       end
+
       def invoke_property_reader(object, property_expression)
         if property_indexed?(property_expression)
           property_method = '[]'
@@ -186,6 +213,7 @@ module Glimmer
           object.send(property_expression)
         end
       end
+
       def invoke_property_writer(object, property_expression, value)
         if property_indexed?(property_expression)
           property_method = '[]='

data/lib/glimmer/{swt → data_binding}/observable.rb

@@ -1,12 +1,15 @@
+require 'glimmer/error'
+
 module Glimmer
-  module SWT
+  module DataBinding
     module Observable
+      # TODO rename methods to observe/unobserve
       def add_observer(observer, property_or_properties=nil)
-        raise 'Not implemented!'
+        raise Error, 'Not implemented!'
       end
 
       def remove_observer(observer, property_or_properties=nil)
-        raise 'Not implemented!'
+        raise Error, 'Not implemented!'
       end
     end
   end

data/lib/glimmer/{swt → data_binding}/observable_array.rb

@@ -3,7 +3,7 @@ require 'set'
 require_relative 'observable'
 
 module Glimmer
-  module SWT
+  module DataBinding
     # TODO prefix utility methods with double-underscore
     module ObservableArray
       include Observable
@@ -42,6 +42,8 @@ module Glimmer
       end
 
       def self.extend_object(array)
+        # TODO consider alias_method, and define_method instead
+
         array.instance_eval("alias __original_add <<")
         array.instance_eval <<-end_eval, __FILE__, __LINE__
         def <<(value)

data/lib/glimmer/{swt → data_binding}/observable_model.rb

@@ -1,10 +1,10 @@
-require 'set'
+require 'glimmer'
 
 require_relative 'observable'
 require_relative 'observer'
 
 module Glimmer
-  module SWT
+  module DataBinding
     # TODO prefix utility methods with double-underscore
     module ObservableModel
       include Observable
@@ -62,6 +62,7 @@ module Glimmer
         begin
           method("__original_#{property_writer_name}")
         rescue
+          # TODO consider alias_method or define_method instead
           instance_eval "alias __original_#{property_writer_name} #{property_writer_name}"
           instance_eval <<-end_eval, __FILE__, __LINE__
           def #{property_writer_name}(value)

data/lib/glimmer/data_binding/observable_widget.rb

@@ -0,0 +1,17 @@
+module Glimmer
+  module DataBinding
+    module ObservableWidget
+      # TODO see if it is worth it to eliminate duplication of method_missing
+      # from WidgetProxy using a module
+
+      def method_missing(method, *args, &block)
+        method_name = method.to_s
+        if can_handle_observation_request?(method_name)
+          handle_observation_request(method_name, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/{swt → data_binding}/observer.rb

@@ -1,7 +1,7 @@
-require 'set'
+require 'glimmer/error'
 
 module Glimmer
-  module SWT
+  module DataBinding
     # Mixin representing Observer trait from Observer Design Pattern
     # Allows classes to include without interfering with their
     # inheritance hierarchy.
@@ -117,7 +117,7 @@ module Glimmer
       end
 
       def call(new_value)
-        raise 'Not implemented!'
+        raise Error, 'Not implemented!'
       end
     end
   end