glimmer 0.9.2 → 0.10.1

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.10.1

data/lib/glimmer.rb

@@ -5,6 +5,10 @@
 require 'logger'
 require 'set'
 
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+require 'glimmer/config'
+
 # Glimmer provides a JRuby Desktop UI DSL + Data-Binding functionality
 #
 # A desktop UI application class must include Glimmer to gain access to Glimmer DSL
@@ -13,27 +17,50 @@ require 'set'
 # 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 add loop detection support to avoid infinite loops (perhaps breaks after 3 repetitions and provides an option to allow it if intentional)
+  class << self
+    attr_accessor :loop_last_data
+    
+    def loop_reset!(including_loop_last_data = false)
+      @loop_last_data = nil if including_loop_last_data
+      @loop = 1
+    end
+    
+    def loop
+      @loop ||= loop_reset!
+    end
+    
+    def loop_increment!
+      @loop = loop + 1
+    end
+  end
 
   def method_missing(method_symbol, *args, &block)
-    # 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}"
+    new_loop_data = [method_symbol, args, block]
+    if new_loop_data == Glimmer.loop_last_data
+      Glimmer.loop_increment!
+      raise "Glimmer looped #{Config.loop_max_count} times with keyword '#{new_loop_data[0]}'! Check code for errors." if Glimmer.loop == Config.loop_max_count
+    else
+      Glimmer.loop_reset!
     end
-    Glimmer::Config.logger&.debug "Interpreting keyword: #{method_symbol}"
+    Glimmer.loop_last_data = new_loop_data
+    # This if statement speeds up Glimmer in girb or whenever directly including on main object
+    is_excluded = Config.excluded_keyword_checkers.reduce(false) {|result, checker| result || instance_exec(method_symbol, *args, &checker) }
+    raise ExcludedKeywordError, "Glimmer excluded keyword: #{method_symbol}" if is_excluded
+    Glimmer::Config.logger.info {"Interpreting keyword: #{method_symbol}"}
     Glimmer::DSL::Engine.interpret(method_symbol, *args, &block)
+  rescue ExcludedKeywordError => e
+    # TODO add a feature to show excluded keywords optionally for debugging purposes
+    super(method_symbol, *args, &block)
   rescue InvalidKeywordError => e
-    if !method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
-      Glimmer::Config.logger&.error e.message
-    end
-    Glimmer::Config.logger&.debug "#{e.message}\n#{e.backtrace.join("\n")}"
+    Glimmer::Config.logger.error {"Encountered an invalid keyword at this object: #{self}"}
+    Glimmer::Config.logger.error {e.full_message}
     super(method_symbol, *args, &block)
   end
 end
 
-$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
-
-require 'glimmer/config'
 require 'glimmer/error'
+require 'glimmer/excluded_keyword_error'
 require 'glimmer/invalid_keyword_error'
 require 'glimmer/dsl/engine'

data/lib/glimmer/config.rb

@@ -1,22 +1,48 @@
 module Glimmer
   module Config
     class << self
+      LOOP_MAX_COUNT_DEFAULT = 100
+      REGEX_METHODS_EXCLUDED = /^(to_|\[)/
+      
+      attr_writer :loop_max_count
+      
+      def excluded_keyword_checkers
+        @excluded_keyword_checkers ||= reset_excluded_keyword_checkers!
+      end
+      
+      def excluded_keyword_checkers=(checkers)
+        @excluded_keyword_checkers = checkers
+      end
+      
+      def reset_excluded_keyword_checkers!
+        @excluded_keyword_checkers = [
+          lambda { |method_symbol, *args| method_symbol.to_s.match(REGEX_METHODS_EXCLUDED) }
+        ]
+      end
+      
+      def loop_max_count
+        @loop_max_count ||= LOOP_MAX_COUNT_DEFAULT
+      end
+      
       # Returns Glimmer logger (standard Ruby logger)
       def logger
-        # unless defined? @@logger
-        #   @@logger = Logger.new(STDOUT).tap {|logger| logger.level = Logger::WARN}
-        # end
-        @@logger if defined? @@logger
+        reset_logger! unless defined? @@logger
+        @@logger
+      end
+      
+      def logger=(custom_logger)
+        @@logger = custom_logger
       end
   
-      def enable_logging
-        @@logger = Logger.new(STDOUT).tap {|logger| logger.level = Logger::WARN}
+      def reset_logger!
+        self.logger = Logger.new(STDOUT).tap do |logger| 
+          logger.level = Logger::ERROR
+        end
       end
     end
   end
 end
 
 if ENV['GLIMMER_LOGGER_LEVEL']
-  Glimmer::Config.enable_logging
   Glimmer::Config.logger.level = ENV['GLIMMER_LOGGER_LEVEL'].downcase
 end

data/lib/glimmer/data_binding/observable_array.rb

@@ -38,7 +38,7 @@ module Glimmer
       end
 
       def notify_observers
-        property_observer_list.each {|observer| observer.call}
+        property_observer_list.to_a.each(&:call)
       end
       
       def <<(element)

data/lib/glimmer/data_binding/observable_model.rb

@@ -47,7 +47,9 @@ 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 do |observer|
+          observer.call(send(property_name))
+        end
       end
       #TODO upon updating values, make sure dependent observers are cleared (not added as dependents here)
 
@@ -56,9 +58,9 @@ module Glimmer
         method(property_writer_name)
         ensure_array_object_observer(property_name, send(property_name))
         begin
-          method("__original_#{property_writer_name}")
+          singleton_method("__original_#{property_writer_name}")
         rescue
-          old_method = self.class.instance_method(property_writer_name)
+          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)
@@ -69,8 +71,8 @@ module Glimmer
           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")}"
+        #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)

data/lib/glimmer/data_binding/observer.rb

@@ -75,6 +75,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 +91,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

@@ -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.info {"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.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|
-            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.info {"#{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.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 +34,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/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.2
+  version: 0.10.1
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-07-27 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: []
@@ -157,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: