glimmer 0.9.1 → 0.10.0

data/lib/glimmer/data_binding/observable_model.rb

@@ -0,0 +1,104 @@
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
+
+module Glimmer
+  module DataBinding
+    # TODO prefix utility methods with double-underscore
+    module ObservableModel
+      include Observable
+
+      class Notifier
+        include Observer
+        def initialize(observable_model, property_name)
+          @observable_model = observable_model
+          @property_name = property_name
+        end
+        def call(new_value=nil)
+          @observable_model.notify_observers(@property_name)
+        end
+      end
+
+      def add_observer(observer, property_name)
+        return observer if has_observer?(observer, property_name)
+        property_observer_list(property_name) << observer
+        add_property_writer_observers(property_name)
+        observer
+      end
+
+      def remove_observer(observer, property_name)
+        property_observer_list(property_name).delete(observer)
+      end
+
+      def has_observer?(observer, property_name)
+        property_observer_list(property_name).include?(observer)
+      end
+
+      def has_observer_for_any_property?(observer)
+        property_observer_hash.values.map(&:to_a).sum.include?(observer)
+      end
+
+      def property_observer_hash
+        @property_observers ||= Hash.new
+      end
+
+      def property_observer_list(property_name)
+        property_observer_hash[property_name.to_sym] = Set.new unless property_observer_hash[property_name.to_sym]
+        property_observer_hash[property_name.to_sym]
+      end
+
+      def notify_observers(property_name)
+        property_observer_list(property_name).each {|observer| observer.call(send(property_name))}
+      end
+      #TODO upon updating values, make sure dependent observers are cleared (not added as dependents here)
+
+      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
+          singleton_method("__original_#{property_writer_name}")
+        rescue
+          old_method = self.class.instance_method(property_writer_name) rescue self.method(property_writer_name)
+          define_singleton_method("__original_#{property_writer_name}", old_method)
+          define_singleton_method(property_writer_name) do |value|
+            old_value = self.send(property_name)
+            unregister_dependent_observers(property_name, old_value)
+            self.send("__original_#{property_writer_name}", value)
+            notify_observers(property_name)
+            ensure_array_object_observer(property_name, value, old_value)
+          end
+        end
+      rescue => e
+        #ignore writing if no property writer exists
+        Glimmer::Config.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)
+        # TODO look into optimizing this
+        return unless old_value.is_a?(ObservableModel) || old_value.is_a?(ObservableArray)
+        property_observer_list(property_name).each do |observer|
+          observer.unregister_dependents_with_observable(observer.registration_for(self, property_name), old_value)
+        end
+      end
+
+      def ensure_array_object_observer(property_name, object, old_object = nil)
+        return unless object.is_a?(Array)
+        array_object_observer = array_object_observer_for(property_name)
+        array_observer_registration = array_object_observer.observe(object)
+        property_observer_list(property_name).each do |observer|
+          my_registration = observer.registration_for(self, property_name) # TODO eliminate repetition
+          observer.add_dependent(my_registration => array_observer_registration)
+        end
+        array_object_observer_for(property_name).unregister(old_object) if old_object.is_a?(ObservableArray)
+      end
+
+      def array_object_observer_for(property_name)
+        @array_object_observers ||= {}
+        unless @array_object_observers.has_key?(property_name)
+          @array_object_observers[property_name] = ObservableModel::Notifier.new(self, property_name)
+        end
+        @array_object_observers[property_name]
+      end
+    end
+  end
+end

data/lib/glimmer/data_binding/observer.rb

@@ -0,0 +1,127 @@
+require 'glimmer/error'
+
+module Glimmer
+  module DataBinding
+    # 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 Registration < Struct.new(:observer, :observable, :property, keyword_init: true)
+        def unregister
+          observer.unobserve(observable, property)
+        end
+        alias unobserve unregister
+      end
+
+      class << self
+        def proc(&observer_block)
+          Proc.new(&observer_block)
+        end
+      end
+
+      def registrations
+        @registrations ||= Set.new
+      end
+
+      def registration_for(observable, property = nil)
+        Registration.new(observer: self, observable: observable, property: 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)
+        registration_for(observable, property).tap do |registration|
+          self.registrations << registration
+        end
+      end
+      alias observe register
+
+      def unregister(observable, property = nil)
+        # TODO optimize performance in the future via indexing and/or making a registration official object/class
+        observable.remove_observer(*[self, property].compact)
+        registration = registration_for(observable, property)
+        dependents_for(registration).each do |dependent|
+          dependent.unregister
+          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 |thedependent|
+          thedependent.observable == dependent_observable
+        end
+        thedependents.each do |thedependent|
+          thedependent.unregister
+        end
+      end
+
+      # cleans up all registrations in observables
+      def unregister_all_observables
+        registrations.each do |registration|
+          registration.unregister
+        end
+      end
+      alias unobserve_all_observables unregister_all_observables
+
+      # add dependent observer to unregister when unregistering observer
+      def add_dependent(parent_to_dependent_hash)
+        registration = parent_to_dependent_hash.keys.first
+        dependent = parent_to_dependent_hash.values.first
+        dependents_for(registration) << dependent
+      end
+
+      def remove_dependent(parent_to_dependent_hash)
+        registration = parent_to_dependent_hash.keys.first
+        dependent = parent_to_dependent_hash.values.first
+        dependents_for(registration).delete(dependent)
+      end
+
+      def call(new_value)
+        raise Error, 'Not implemented!'
+      end
+    end
+  end
+end
+
+require 'glimmer/data_binding/observable_model'
+require 'glimmer/data_binding/observable_array'

data/lib/glimmer/dsl/engine.rb

@@ -11,6 +11,8 @@ module Glimmer
     # When DSL engine interprets an expression, it attempts to handle
     # with ordered expression array specified via `.expressions=` method.
     class Engine
+      MESSAGE_NO_DSLS = "Glimmer has no DSLs configured. Add glimmer-dsl-swt gem or visit https://github.com/AndyObtiva/glimmer#multi-dsl-support for more details.\n"
+      
       class << self
         def dsl=(dsl_name)
           dsl_name = dsl_name&.to_sym
@@ -69,6 +71,16 @@ module Glimmer
         # Static expressions indexed by keyword and dsl
         def static_expressions
           @static_expressions ||= {}
+        end        
+
+        # Sets dynamic expression chains of responsibility. Useful for internal testing
+        def dynamic_expression_chains_of_responsibility=(chains)
+          @dynamic_expression_chains_of_responsibility = chains
+        end
+
+        # Sets static expressions. Useful for internal testing
+        def static_expressions=(expressions)
+          @static_expressions = expressions
         end
 
         # Sets an ordered array of DSL expressions to support
@@ -84,7 +96,7 @@ module Glimmer
           dynamic_expression_chains_of_responsibility[dsl] = expression_names.reverse.map do |expression_name|
             expression_class(dsl_namespace, expression_name).new
           end.reduce(nil) do |last_expresion_handler, expression|
-            Glimmer::Config.logger&.debug "Adding dynamic expression: #{expression.class.name}"
+            Glimmer::Config.logger.debug {"Adding dynamic expression: #{expression.class.name}"}
             expression_handler = ExpressionHandler.new(expression)
             expression_handler.next = last_expresion_handler if last_expresion_handler
             expression_handler
@@ -92,21 +104,22 @@ module Glimmer
         end
 
         def add_static_expression(static_expression)
-          Glimmer::Config.logger&.debug "Adding static expression: #{static_expression.class.name}"
+          Glimmer::Config.logger.debug {"Adding static expression: #{static_expression.class.name}"}
           keyword = static_expression.class.keyword
           static_expression_dsl = static_expression.class.dsl
           static_expressions[keyword] ||= {}
           static_expressions[keyword][static_expression_dsl] = static_expression
           Glimmer.send(:define_method, keyword) do |*args, &block|
-            begin
-              retrieved_static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]            
+            if Glimmer::DSL::Engine.no_dsls?
+              puts Glimmer::DSL::Engine::MESSAGE_NO_DSLS
+            else
+              retrieved_static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
               static_expression_dsl = (Glimmer::DSL::Engine.static_expressions[keyword].keys - Glimmer::DSL::Engine.disabled_dsls).first if retrieved_static_expression.nil?
               interpretation = nil
               if retrieved_static_expression.nil? && Glimmer::DSL::Engine.dsl && (static_expression_dsl.nil? || !Glimmer::DSL::Engine.static_expressions[keyword][static_expression_dsl].is_a?(TopLevelExpression))
                 begin
                   interpretation = Glimmer::DSL::Engine.interpret(keyword, *args, &block)
                 rescue => e
-                  Glimmer::DSL::Engine.reset
                   raise e if static_expression_dsl.nil? || !Glimmer::DSL::Engine.static_expressions[keyword][static_expression_dsl].is_a?(TopLevelExpression)
                 end
               end
@@ -119,18 +132,14 @@ module Glimmer
                 if !static_expression.can_interpret?(Glimmer::DSL::Engine.parent, keyword, *args, &block)
                   raise Error, "Invalid use of Glimmer keyword #{keyword} with args #{args} under parent #{Glimmer::DSL::Engine.parent}"
                 else
-                  Glimmer::Config.logger&.debug "#{static_expression.class.name} will handle expression keyword #{keyword}"
+                  Glimmer::Config.logger.debug {"#{static_expression.class.name} will handle expression keyword #{keyword}"}
                   static_expression.interpret(Glimmer::DSL::Engine.parent, keyword, *args, &block).tap do |ui_object|
                     Glimmer::DSL::Engine.add_content(ui_object, static_expression, &block) unless block.nil?
                     Glimmer::DSL::Engine.dsl_stack.pop
                   end
                 end
               end
-            rescue StandardError => e
-#               Glimmer::DSL::Engine.dsl_stack.pop
-                Glimmer::DSL::Engine.reset
-              raise e
-            end
+            end              
           end
         end
 
@@ -145,7 +154,7 @@ module Glimmer
         # Interprets Glimmer dynamic DSL expression consisting of keyword, args, and block (e.g. shell(:no_resize) { ... })
         def interpret(keyword, *args, &block)
           if no_dsls?
-            puts "Glimmer has no DSLs configured. Add glimmer-dsl-swt gem or visit https://github.com/AndyObtiva/glimmer#multi-dsl-support for more details.\n"
+            puts MESSAGE_NO_DSLS
             return
           end
           keyword = keyword.to_s
@@ -156,10 +165,6 @@ module Glimmer
             add_content(ui_object, expression, &block)
             dsl_stack.pop
           end
-        rescue StandardError => e
-#           dsl_stack.pop
-          reset
-          raise e
         end
 
         # Adds content block to parent UI object
@@ -171,9 +176,12 @@ module Glimmer
           if block_given? && expression.is_a?(ParentExpression)
             dsl_stack.push(expression.class.dsl)
             parent_stack.push(parent) 
-            expression.add_content(parent, &block)
-            parent_stack.pop
-            dsl_stack.pop
+            begin
+              expression.add_content(parent, &block)
+            ensure
+              parent_stack.pop
+              dsl_stack.pop
+            end
           end
         end
 

data/lib/glimmer/dsl/expression_handler.rb

@@ -23,9 +23,9 @@ module Glimmer
       # Otherwise, it forwards to the next handler configured via `#next=` method
       # If there is no handler next, then it raises an error
       def handle(parent, keyword, *args, &block)
-        Glimmer::Config.logger&.debug "Attempting to handle #{keyword} with #{@expression.class.name.split(":").last}"
+        Glimmer::Config.logger.debug {"Attempting to handle #{keyword} with #{@expression.class.name.split(":").last}"}
         if @expression.can_interpret?(parent, keyword, *args, &block)
-          Glimmer::Config.logger&.debug "#{@expression.class.name} will handle expression keyword #{keyword}"
+          Glimmer::Config.logger.debug {"#{@expression.class.name} will handle expression keyword #{keyword}"}
           return @expression
         elsif @next_expression_handler
           return @next_expression_handler.handle(parent, keyword, *args, &block)
@@ -34,7 +34,7 @@ module Glimmer
           message = "Glimmer keyword #{keyword} with args #{args} cannot be handled"
           message += " inside parent #{parent}" if parent
           message += "! Check the validity of the code."
-          # Glimmer::Config.logger&.error message
+          # Glimmer::Config.logger.error {message}
           raise InvalidKeywordError, message
         end
       end

data/lib/glimmer/excluded_keyword_error.rb

@@ -0,0 +1,5 @@
+module Glimmer
+  # Represents Glimmer errors that occur due to excluded keywords passing through method_missing
+  class ExcludedKeywordError < RuntimeError
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-14 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,48 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  name: coveralls
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  name: simplecov
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  name: simplecov-lcov
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Ruby Desktop Development GUI Library (JRuby on SWT)
 email: andy.am@gmail.com
 executables: []
@@ -145,6 +187,11 @@ files:
 - VERSION
 - lib/glimmer.rb
 - lib/glimmer/config.rb
+- lib/glimmer/data_binding/model_binding.rb
+- lib/glimmer/data_binding/observable.rb
+- lib/glimmer/data_binding/observable_array.rb
+- lib/glimmer/data_binding/observable_model.rb
+- lib/glimmer/data_binding/observer.rb
 - lib/glimmer/dsl/engine.rb
 - lib/glimmer/dsl/expression.rb
 - lib/glimmer/dsl/expression_handler.rb
@@ -152,6 +199,7 @@ files:
 - lib/glimmer/dsl/static_expression.rb
 - lib/glimmer/dsl/top_level_expression.rb
 - lib/glimmer/error.rb
+- lib/glimmer/excluded_keyword_error.rb
 - lib/glimmer/invalid_keyword_error.rb
 homepage: http://github.com/AndyObtiva/glimmer
 licenses: