glimmer 0.10.0 → 1.0.0

data/lib/glimmer/data_binding/observable_model.rb

@@ -1,9 +1,29 @@
+# Copyright (c) 2007-2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 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
 
@@ -17,6 +37,17 @@ module Glimmer
           @observable_model.notify_observers(@property_name)
         end
       end
+      
+      PROPERTY_WRITER_FACTORY = lambda do |property_name|
+        property_writer_name = "#{property_name}="
+        lambda 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
 
       def add_observer(observer, property_name)
         return observer if has_observer?(observer, property_name)
@@ -34,7 +65,7 @@ module Glimmer
       end
 
       def has_observer_for_any_property?(observer)
-        property_observer_hash.values.map(&:to_a).sum.include?(observer)
+        property_observer_hash.values.map(&:to_a).reduce(:+).include?(observer)
       end
 
       def property_observer_hash
@@ -47,9 +78,8 @@ module Glimmer
       end
 
       def notify_observers(property_name)
-        property_observer_list(property_name).each {|observer| observer.call(send(property_name))}
+        property_observer_list(property_name).to_a.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}="
@@ -58,27 +88,22 @@ module Glimmer
         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
+          define_singleton_method("__original_#{property_writer_name}", property_writer_method(property_writer_name))
+          define_singleton_method(property_writer_name, &PROPERTY_WRITER_FACTORY.call(property_name))
         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 property_writer_method(property_writer_name)
+        self.class.instance_method(property_writer_name) rescue self.method(property_writer_name)      
+      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
+        property_observer_list(property_name).each { |observer| observer.unregister_dependents_with_observable(observer.registration_for(self, property_name), old_value) }
       end
 
       def ensure_array_object_observer(property_name, object, old_object = nil)
@@ -93,10 +118,8 @@ module Glimmer
       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 ||= {}        
+        @array_object_observers[property_name] = ObservableModel::Notifier.new(self, property_name) unless @array_object_observers.has_key?(property_name)
         @array_object_observers[property_name]
       end
     end

data/lib/glimmer/data_binding/observer.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2007-2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 require 'glimmer/error'
 
 module Glimmer
@@ -59,6 +80,7 @@ module Glimmer
       # registers observer in an observable on a property (optional)
       # observer maintains registration list to unregister later
       def register(observable, property = nil)
+        return if observable.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)
@@ -75,6 +97,7 @@ module Glimmer
       alias observe register
 
       def unregister(observable, property = nil)
+        return unless observable.is_a?(Observable)
         # 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)
@@ -90,16 +113,12 @@ module Glimmer
         thedependents = dependents_for(registration).select do |thedependent|
           thedependent.observable == dependent_observable
         end
-        thedependents.each do |thedependent|
-          thedependent.unregister
-        end
+        thedependents.each(&:unregister)
       end
 
       # cleans up all registrations in observables
       def unregister_all_observables
-        registrations.each do |registration|
-          registration.unregister
-        end
+        registrations.each(&:unregister)
       end
       alias unobserve_all_observables unregister_all_observables
 

data/lib/glimmer/dsl/engine.rb

@@ -1,3 +1,25 @@
+# Copyright (c) 2007-2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'forwardable'
 require 'facets/string/camelcase'
 
 require 'glimmer/dsl/expression_handler'
@@ -12,20 +34,42 @@ module Glimmer
     # 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"
+      STATIC_EXPRESSION_METHOD_FACTORY = lambda do |keyword|
+        lambda do |*args, &block|
+          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
+                raise e if static_expression_dsl.nil? || !Glimmer::DSL::Engine.static_expressions[keyword][static_expression_dsl].is_a?(TopLevelExpression)
+              end
+            end
+            if interpretation
+              interpretation
+            else              
+              raise Glimmer::Error, "Unsupported keyword: #{keyword}" unless static_expression_dsl || retrieved_static_expression
+              Glimmer::DSL::Engine.dsl_stack.push(static_expression_dsl || Glimmer::DSL::Engine.dsl)
+              static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
+              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.info {"#{static_expression.class.name} will handle expression keyword #{keyword}"}
+                Glimmer::DSL::Engine.interpret_expression(static_expression, keyword, *args, &block)
+              end
+            end
+          end              
+        end      
+      end
       
       class << self
-        def dsl=(dsl_name)
-          dsl_name = dsl_name&.to_sym
-          if dsl_name
-            dsl_stack.push(dsl_name)
-          else
-            dsl_stack.clear
-          end
-        end
+        extend Forwardable
         
-        def dsl
-          dsl_stack.last
-        end
+        def_delegator :dsl_stack, :last, :dsl
 
         def dsls
           static_expressions.values.map(&:keys).flatten.uniq
@@ -74,14 +118,10 @@ module Glimmer
         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
+        attr_writer :dynamic_expression_chains_of_responsibility
 
         # Sets static expressions. Useful for internal testing
-        def static_expressions=(expressions)
-          @static_expressions = expressions
-        end
+        attr_writer :static_expressions
 
         # Sets an ordered array of DSL expressions to support
         #
@@ -96,7 +136,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.info {"Adding dynamic expression: #{expression.class.name}"}
             expression_handler = ExpressionHandler.new(expression)
             expression_handler.next = last_expresion_handler if last_expresion_handler
             expression_handler
@@ -104,43 +144,12 @@ module Glimmer
         end
 
         def add_static_expression(static_expression)
-          Glimmer::Config.logger.debug {"Adding static expression: #{static_expression.class.name}"}
+          Glimmer::Config.logger.info {"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|
-            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
-                  raise e if static_expression_dsl.nil? || !Glimmer::DSL::Engine.static_expressions[keyword][static_expression_dsl].is_a?(TopLevelExpression)
-                end
-              end
-              if interpretation
-                interpretation
-              else              
-                raise Glimmer::Error, "Unsupported keyword: #{keyword}" unless static_expression_dsl || retrieved_static_expression
-                Glimmer::DSL::Engine.dsl_stack.push(static_expression_dsl || Glimmer::DSL::Engine.dsl)
-                static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
-                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}"}
-                  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
-            end              
-          end
+          Glimmer.send(:define_method, keyword, &STATIC_EXPRESSION_METHOD_FACTORY.call(keyword))
         end
 
         def expression_class(dsl_namespace, expression_name)
@@ -152,16 +161,17 @@ module Glimmer
         end
 
         # 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 MESSAGE_NO_DSLS
-            return
-          end
+        def interpret(keyword, *args, &block)          
+          return puts(MESSAGE_NO_DSLS) if no_dsls?
           keyword = keyword.to_s
           dynamic_expression_dsl = (dynamic_expression_chains_of_responsibility.keys - disabled_dsls).first if dsl.nil?
           dsl_stack.push(dynamic_expression_dsl || dsl)
           expression = dynamic_expression_chains_of_responsibility[dsl].handle(parent, keyword, *args, &block)
-          expression.interpret(parent, keyword, *args, &block).tap do |ui_object|            
+          interpret_expression(expression, keyword, *args, &block)
+        end
+        
+        def interpret_expression(expression, keyword, *args, &block)
+          expression.interpret(parent, keyword, *args, &block).tap do |ui_object|
             add_content(ui_object, expression, &block)
             dsl_stack.pop
           end
@@ -189,9 +199,7 @@ module Glimmer
         #
         # Parents are maintained in a stack while evaluating Glimmer DSL
         # to ensure properly ordered interpretation of DSL syntax
-        def parent
-          parent_stack.last
-        end
+        def_delegator :parent_stack, :last, :parent
 
         def parent_stack
           parent_stacks[dsl] ||= []

data/lib/glimmer/dsl/expression.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2007-2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 require 'glimmer/error'
 
 module Glimmer

data/lib/glimmer/dsl/expression_handler.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2007-2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 require 'glimmer/invalid_keyword_error'
 
 module Glimmer
@@ -23,9 +44,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.info {"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.info {"#{@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 +55,6 @@ 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}
           raise InvalidKeywordError, message
         end
       end

data/lib/glimmer/dsl/parent_expression.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2007-2020 Andy Maleh
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 require 'glimmer/error'
 
 module Glimmer