glimmer 0.3.5 → 0.4.0

data/lib/glimmer/command_handlers/models/observer.rb

@@ -0,0 +1,115 @@
+require 'set'
+
+module Glimmer
+  # Mixin representing Observer trait from Observer Design Pattern
+  # Allows classes to include without interfering with their
+  # inheritance hierarchy.
+  #
+  # Includes a default implementation that can receive an observer block
+  # Example: Observer.proc {|new_value| puts new_value}
+  # Subclasses may override
+  module Observer
+    # Observer Proc default implementation that takes an observer block to process updates
+    # via call method
+    class Proc
+      include Observer
+
+      def initialize(&observer_block)
+        @observer_block = observer_block
+      end
+
+      # Called by observables once updates occur sending in the new_value if any
+      def call(new_value=nil)
+        @observer_block.call(new_value)
+      end
+    end
+
+    class << self
+      def proc(&observer_block)
+        Proc.new(&observer_block)
+      end
+    end
+
+    def registrations
+      @registrations ||= Set.new
+    end
+
+    def registrations_for(observable, property = nil)
+      registrations.select {|o, p| o == observable && p == property}
+    end
+
+    # mapping of registrations to dependents
+    # {[observable, property] => [[dependent, dependent_observable, dependent_property], ...]}
+    def dependents
+      @dependents ||= Hash.new
+    end
+
+    def dependents_for(registration)
+      dependents[registration] ||= Set.new
+    end
+
+    # 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
+      end
+    end
+    alias observe register
+
+    def unregister(observable, property = nil)
+      observable.remove_observer(*[self, property].compact)
+      registration = [observable, property]
+      dependents_for(registration).each do |dependent|
+        dependent_observer, dependent_observable, dependent_property = dependent
+        dependent_observer.unregister(dependent_observable, dependent_property)
+        remove_dependent(registration => dependent)
+      end
+      registrations.delete(registration)
+    end
+    alias unobserve unregister
+
+    def unregister_dependents_with_observable(registration, dependent_observable)
+      thedependents = dependents_for(registration).select do |d_observer, d_observable, d_property|
+        d_observable == dependent_observable
+      end
+      thedependents.each do |d_observer, d_observable, d_property|
+        d_observer.unregister(d_observable, d_property)
+      end
+    end
+
+    # cleans up all registrations in observables
+    def unregister_all_observables
+      registrations.each do |observable, property|
+        unregister(observable, property)
+      end
+    end
+    alias unobserve_all_observables unregister_all_observables
+
+    # add dependent observer to unregister when unregistering observer
+    def add_dependent(parent_to_dependent_hash)
+      observable, property = registration = parent_to_dependent_hash.keys.first
+      dependent_observer, dependent_observable, dependent_property = dependent = parent_to_dependent_hash.values.first
+      dependents_for(registration) << dependent
+    end
+
+    def remove_dependent(parent_to_dependent_hash)
+      observable, property = registration = parent_to_dependent_hash.keys.first
+      dependent_observer, dependent_observable, dependent_property = dependent = parent_to_dependent_hash.values.first
+      dependents_for(registration).delete(dependent)
+    end
+
+    def call(new_value)
+      raise 'Not implemented!'
+    end
+  end
+end

data/lib/glimmer/command_handlers/models/table_items_binding.rb

@@ -0,0 +1,45 @@
+require_relative 'observable_array'
+require_relative 'observable_model'
+require_relative 'observable'
+require_relative 'observer'
+
+module Glimmer
+  class TableItemsBinding
+    include Glimmer
+    include Observable
+    include Observer
+    include_package 'org.eclipse.swt'
+    include_package 'org.eclipse.swt.widgets'
+
+    def initialize(parent, model_binding, column_properties)
+      @table = parent
+      @model_binding = model_binding
+      @column_properties = column_properties
+      call(@model_binding.evaluate_property)
+      model = model_binding.base_model
+      observe(model, model_binding.property_name_expression)
+      add_contents(@table) {
+        on_widget_disposed { |dispose_event|
+          unregister_all_observables
+        }
+      }
+    end
+    def call(model_collection=nil)
+      if model_collection and model_collection.is_a?(Array)
+        observe(model_collection, @column_properties)
+        @model_collection = model_collection
+      end
+      populate_table(@model_collection, @table, @column_properties)
+    end
+    def populate_table(model_collection, parent, column_properties)
+      parent.widget.removeAll
+      model_collection.each do |model|
+        table_item = TableItem.new(parent.widget, GSWT[:none])
+        for index in 0..(column_properties.size-1)
+          table_item.setText(index, model.send(column_properties[index]).to_s)
+        end
+      end
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/models/tree_items_binding.rb

@@ -0,0 +1,49 @@
+require_relative 'observable_array'
+require_relative 'observable_model'
+require_relative 'observable'
+require_relative 'observer'
+
+module Glimmer
+  class TreeItemsBinding
+    include Glimmer
+    include Observable
+    include Observer
+    include_package 'org.eclipse.swt'
+    include_package 'org.eclipse.swt.widgets'
+
+    def initialize(parent, model_binding, tree_properties)
+      @tree = parent
+      @model_binding = model_binding
+      @tree_properties = [tree_properties].flatten.first.to_h
+      call(@model_binding.evaluate_property)
+      model = model_binding.base_model
+      observe(model, model_binding.property_name_expression)
+      add_contents(@tree) {
+        on_widget_disposed { |dispose_event|
+          unregister_all_observables
+        }
+      }
+    end
+    def call(model_tree_root_node=nil)
+      if model_tree_root_node and model_tree_root_node.respond_to?(@tree_properties[:children])
+        observe(model_tree_root_node, @tree_properties[:text])
+        observe(model_tree_root_node, @tree_properties[:children])
+        @model_tree_root_node = model_tree_root_node
+      end
+      populate_tree(@model_tree_root_node, @tree, @tree_properties)
+    end
+    def populate_tree(model_tree_root_node, parent, tree_properties)
+      parent.widget.removeAll
+      populate_tree_node(model_tree_root_node, parent.widget, tree_properties)
+    end
+    def populate_tree_node(model_tree_node, parent, tree_properties)
+      table_item = TreeItem.new(parent, GSWT[: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|
+        observe(child, @tree_properties[:text])
+        populate_tree_node(child, table_item, tree_properties)
+      end
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/models/widget_binding.rb

@@ -0,0 +1,29 @@
+require_relative 'observable'
+require_relative 'observer'
+
+module Glimmer
+  class WidgetBinding
+    include Glimmer
+    include Observable
+    include Observer
+
+    attr_reader :widget, :property
+    def initialize(model, property, translator = nil)
+      @widget = model
+      @property = property
+      @translator = translator || proc {|value| value}
+      add_contents(@widget) {
+        on_widget_disposed { |dispose_event|
+          unregister_all_observables
+        }
+      }
+    end
+    def call(value)
+      converted_value = translated_value = @translator.call(value)
+      @widget.set_attribute(@property, converted_value) unless evaluate_property == converted_value
+    end
+    def evaluate_property
+      @widget.widget.send(@property)
+    end
+  end
+end

data/lib/glimmer/command_handlers/shell_command_handler.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_shell"
+
+module Glimmer
+  class ShellCommandHandler
+    include CommandHandler
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      command_symbol.to_s == "shell"
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      GShell.send(:new, *args)
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/tab_item_command_handler.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_shell"
+require File.dirname(__FILE__) + "/models/g_tab_item_composite"
+
+module Glimmer
+  class TabItemCommandHandler
+    include CommandHandler
+    include Glimmer
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      parent.is_a?(GWidget) and
+      command_symbol.to_s == "tab_item"
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      tab_item = GWidget.new(command_symbol.to_s, parent.widget, args)
+      GTabItemComposite.new(tab_item, parent.widget, args)
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/table_column_properties_data_binding_command_handler.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+
+module Glimmer
+  # Responsible for providing a readable keyword (command symbol) to capture
+  # and return column properties for use in TreeItemsDataBindingCommandHandler
+  class TableColumnPropertiesDataBindingCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt'
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      parent.is_a?(GWidget) and
+      parent.widget.is_a?(Table) and
+      command_symbol.to_s == "column_properties" and
+      block == nil
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      args
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/table_items_data_binding_command_handler.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+require File.dirname(__FILE__) + "/models/table_items_binding"
+
+module Glimmer
+  #Depends on BindCommandHandler and TableColumnPropertiesDataBindingCommandHandler
+  class TableItemsDataBindingCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      parent.is_a?(GWidget) and
+      parent.widget.is_a?(Table) and
+      command_symbol.to_s == "items" and
+      args.size == 2 and
+      args[0].is_a?(ModelBinding) and
+      args[0].evaluate_property.is_a?(Array) and
+      args[1].is_a?(Array) and
+      block == nil
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      model_binding = args[0]
+      column_properties = args[1]
+      TableItemsBinding.new(parent, model_binding, column_properties)
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/tree_items_data_binding_command_handler.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+require File.dirname(__FILE__) + "/models/tree_items_binding"
+
+module Glimmer
+  class TreeItemsDataBindingCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      (parent.is_a?(GWidget)) and
+      (parent.widget.is_a?(Tree)) and
+      (command_symbol.to_s == "items") and
+      (args.size == 2) and
+      (args[0].is_a?(ModelBinding)) and
+      (!args[0].evaluate_property.is_a?(Array)) and
+      (args[1].is_a?(Array) && !args[1].empty? && args[1].first.is_a?(Hash)) and
+      (block == nil)
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      model_binding = args[0]
+      tree_properties = args[1]
+      TreeItemsBinding.new(parent, model_binding, tree_properties)
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/tree_properties_data_binding_command_handler.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+
+module Glimmer
+  # Responsible for providing a readable keyword (command symbol) to capture
+  # and return tree properties for use in TreeItemsDataBindingCommandHandler
+  class TreePropertiesDataBindingCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt'
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      parent.is_a?(GWidget) and
+      parent.widget.is_a?(Tree) and
+      command_symbol.to_s == "tree_properties" and
+      block == nil
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      args
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/widget_command_handler.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+
+module Glimmer
+  class WidgetCommandHandler
+    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 != "shell" and
+      GWidget.widget_exists?(command_symbol.to_s)
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      Glimmer.logger.debug "widget styles are: " + args.inspect
+      GWidget.new(command_symbol.to_s, parent.widget, args)
+    end
+
+  end
+end

data/lib/glimmer/command_handlers/widget_listener_command_handler.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + "/../command_handler"
+require File.dirname(__FILE__) + "/models/g_widget"
+
+module Glimmer
+  class WidgetListenerCommandHandler
+    include CommandHandler
+
+    include_package 'org.eclipse.swt.widgets'
+
+    def can_handle?(parent, command_symbol, *args, &block)
+      Glimmer.logger.debug "parent is a widget: " + (parent.is_a?(GWidget)).to_s
+      return unless parent.is_a?(GWidget)
+      Glimmer.logger.debug "on listener?: " + (command_symbol.to_s[0,3] == "on_").to_s
+      return unless command_symbol.to_s[0,3] == "on_"
+      Glimmer.logger.debug "command symbol is longer than 3: " + (command_symbol.to_s.length > 3).to_s
+      return unless command_symbol.to_s.length > 3
+      Glimmer.logger.debug "args are 0?: " + (args.size == 0).to_s
+      return unless args.size == 0
+      Glimmer.logger.debug "can add listener? " + (parent.can_add_listener?(command_symbol.to_s[3, command_symbol.to_s.length])).to_s
+      parent.can_add_listener?(command_symbol.to_s[3, command_symbol.to_s.length])
+    end
+
+    def do_handle(parent, command_symbol, *args, &block)
+      parent.add_listener(command_symbol.to_s[3, command_symbol.to_s.length], &block)
+      ListenerParent.new #TODO refactor and move to models
+    end
+
+    #TODO refactor and move to separate file
+    class ListenerParent
+      include Parent
+
+      def process_block(block)
+        #NOOP
+      end
+
+    end
+
+  end
+end