glimmer 1.0.2 → 1.0.7

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.7

data/glimmer.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer 1.0.2 ruby lib
+# stub: glimmer 1.0.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "1.0.2"
+  s.version = "1.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["AndyMaleh".freeze]
-  s.date = "2020-10-27"
-  s.description = "Glimmer is a Ruby DSL engine with support for the Glimmer DSL for SWT (JRuby Desktop Development GUI Library), the Glimmer DSL for Tk (Ruby Desktop Development GUI Library), the Glimmer DSL for Opal (Web GUI Adapter for Desktop Apps), the Glimmer DSL for XML (& HTML), and the Glimmer DSL for CSS.".freeze
+  s.date = "2021-01-11"
+  s.description = "Glimmer is a Ruby DSL Framework consisting of a DSL Engine and an Observable/Observer/Data-Binding Library. Used in the Glimmer DSL for SWT (JRuby Desktop Development GUI Framework), the Glimmer DSL for Tk (Ruby Desktop Development GUI Library), the Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps), the Glimmer DSL for XML (& HTML), and the Glimmer DSL for CSS.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
   end
 
   if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<array_include_methods>.freeze, [">= 1.0.3", "< 2.0.0"])
+    s.add_runtime_dependency(%q<array_include_methods>.freeze, [">= 1.0.4", "< 2.0.0"])
     s.add_runtime_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
     s.add_development_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
     s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
@@ -61,12 +61,12 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
     s.add_development_dependency(%q<jeweler>.freeze, [">= 2.0.0", "< 3.0.0"])
     s.add_development_dependency(%q<rdoc>.freeze, [">= 6.2.1", "< 7.0.0"])
-    s.add_development_dependency(%q<coveralls>.freeze, ["= 0.8.23"])
+    s.add_development_dependency(%q<coveralls>.freeze, [">= 0"])
     s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
     s.add_development_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
     s.add_development_dependency(%q<rake-tui>.freeze, [">= 0"])
   else
-    s.add_dependency(%q<array_include_methods>.freeze, [">= 1.0.3", "< 2.0.0"])
+    s.add_dependency(%q<array_include_methods>.freeze, [">= 1.0.4", "< 2.0.0"])
     s.add_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
     s.add_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
@@ -74,7 +74,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
     s.add_dependency(%q<jeweler>.freeze, [">= 2.0.0", "< 3.0.0"])
     s.add_dependency(%q<rdoc>.freeze, [">= 6.2.1", "< 7.0.0"])
-    s.add_dependency(%q<coveralls>.freeze, ["= 0.8.23"])
+    s.add_dependency(%q<coveralls>.freeze, [">= 0"])
     s.add_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
     s.add_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
     s.add_dependency(%q<rake-tui>.freeze, [">= 0"])

data/lib/glimmer.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -70,7 +70,7 @@ module Glimmer
       end
       Glimmer.loop_last_data = new_loop_data
       Glimmer::Config.logger.info {"Interpreting keyword: #{method_symbol}"}
-      Glimmer::DSL::Engine.interpret(method_symbol, *args, &block)    
+      Glimmer::DSL::Engine.interpret(method_symbol, *args, &block)
     end
   rescue InvalidKeywordError => e
     Glimmer::Config.logger.error {"Encountered an invalid keyword at this object: #{self}"}

data/lib/glimmer/config.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -46,7 +46,7 @@ module Glimmer
       end
       
       # Returns Glimmer logger (standard Ruby logger)
-      def logger      
+      def logger
         reset_logger! unless defined? @@logger
         @@logger
       end
@@ -56,7 +56,7 @@ module Glimmer
       end
   
       def reset_logger!
-        self.logger = Logger.new(STDOUT).tap do |logger| 
+        self.logger = Logger.new(STDOUT).tap do |logger|
           logger.level = Logger::ERROR
           begin
             logger.level = ENV['GLIMMER_LOGGER_LEVEL'].strip.downcase if ENV['GLIMMER_LOGGER_LEVEL']

data/lib/glimmer/data_binding/model_binding.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -81,9 +81,9 @@ module Glimmer
       end
 
       def apply_converter(converter, value)
-        return value if converter.nil?          
-        return value.send(converter) if (converter.is_a?(String) || converter.is_a?(Symbol)) && value.respond_to?(converter)          
-        return converter.call(value) if converter.respond_to?(:call, value)          
+        return value if converter.nil?
+        return value.send(converter) if (converter.is_a?(String) || converter.is_a?(Symbol)) && value.respond_to?(converter)
+        return converter.call(value) if converter.respond_to?(:call, value)
         raise Glimmer::Error, "Unsupported bind converter: #{converter.inspect}"
       end
 
@@ -209,11 +209,11 @@ module Glimmer
       def call(value)
         return if model.nil?
         converted_value = value
-        invoke_property_writer(model, "#{property_name}=", converted_value) unless evaluate_property == converted_value
+        invoke_property_writer(model, "#{property_name}=", converted_value) unless converted_value == evaluate_property
       end
 
       def evaluate_property
-        value = nil        
+        value = nil
         value = invoke_property_reader(model, property_name) unless model.nil?
         convert_on_read(value)
       end
@@ -242,7 +242,7 @@ module Glimmer
       end
 
       def invoke_property_writer(object, property_expression, value)
-        return if @binding_options[:read_only]
+        raise "Cannot invoke `#{property_expression}` because ModelBinding#binding_options[:read_only]=true" if @binding_options[:read_only]
         value = convert_on_write(value)
         if property_indexed?(property_expression)
           property_method = '[]='

data/lib/glimmer/data_binding/observable.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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

data/lib/glimmer/data_binding/observable_array.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -48,7 +48,7 @@ module Glimmer
       def add_element_observer(element, observer)
         element_properties_for(observer).each do |property|
           observer.observe(element, property)
-        end      
+        end
       end
 
       def remove_observer(observer, *element_properties)
@@ -62,20 +62,20 @@ module Glimmer
           property_observer_list.delete(observer)
           observer_element_properties.delete(observer)
           each { |element| remove_element_observer(element, observer) }
-        end        
+        end
         observer
       end
 
       def remove_element_observers(element)
         property_observer_list.each do |observer|
           remove_element_observer(element, observer)
-        end      
+        end
       end
 
       def remove_element_observer(element, observer)
         element_properties_for(observer).each do |property|
           observer.unobserve(element, property)
-        end      
+        end
       end
 
       def has_observer?(observer)
@@ -104,7 +104,7 @@ module Glimmer
       
       def <<(element)
         super(element).tap do
-          add_element_observers(element)        
+          add_element_observers(element)
           notify_observers
         end
       end
@@ -115,7 +115,7 @@ module Glimmer
         old_value = self[index]
         unregister_dependent_observers(old_value)
         remove_element_observers(old_value)
-        add_element_observers(value)    
+        add_element_observers(value)
         super(index, value).tap do
           notify_observers
         end
@@ -151,7 +151,7 @@ module Glimmer
         if block_given?
           old_array = Array.new(self)
           super(&block).tap do |new_array|
-            (old_array - new_array).each do |element| 
+            (old_array - new_array).each do |element|
               unregister_dependent_observers(element)
               remove_element_observers(element)
             end
@@ -264,7 +264,7 @@ module Glimmer
 
       def unshift(element)
         super(element).tap do
-          add_element_observers(element)        
+          add_element_observers(element)
           notify_observers
         end
       end

data/lib/glimmer/data_binding/observable_model.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -43,7 +43,7 @@ module Glimmer
         lambda do |value|
           old_value = self.send(property_name)
           unregister_dependent_observers(property_name, old_value)
-          self.send("__original_#{property_writer_name}", value)
+          self.send("__original__#{property_writer_name}", value)
           notify_observers(property_name)
           ensure_array_object_observer(property_name, value, old_value)
         end
@@ -57,7 +57,26 @@ module Glimmer
       end
 
       def remove_observer(observer, property_name)
-        property_observer_list(property_name).delete(observer)
+        if has_observer?(observer, property_name)
+          property_observer_list(property_name).delete(observer)
+          observer.unobserve(self, property_name)
+        end
+      end
+
+      def remove_observers(property_name)
+        property_observer_hash[property_name.to_sym].each do |observer|
+          remove_observer(observer, property_name)
+        end
+        property_observer_hash.delete(property_name.to_sym)
+      end
+
+      def remove_all_observers
+        all_observers = property_observer_hash.clone
+        property_observer_hash.keys.each do |property_name|
+          remove_observers(property_name)
+        end
+        property_observer_hash.clear
+        all_observers
       end
 
       def has_observer?(observer, property_name)
@@ -86,9 +105,9 @@ module Glimmer
         method(property_writer_name)
         ensure_array_object_observer(property_name, send(property_name))
         begin
-          singleton_method("__original_#{property_writer_name}")
+          method("__original__#{property_writer_name}")
         rescue
-          define_singleton_method("__original_#{property_writer_name}", property_writer_method(property_writer_name))
+          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
@@ -97,7 +116,7 @@ module Glimmer
       end
       
       def property_writer_method(property_writer_name)
-        self.class.instance_method(property_writer_name) rescue self.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)
@@ -107,7 +126,7 @@ module Glimmer
       end
 
       def ensure_array_object_observer(property_name, object, old_object = nil)
-        return unless object.is_a?(Array)
+        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|
@@ -118,7 +137,7 @@ module Glimmer
       end
 
       def array_object_observer_for(property_name)
-        @array_object_observers ||= {}        
+        @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

data/lib/glimmer/data_binding/observer.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -51,6 +51,7 @@ module Glimmer
           observer.unobserve(observable, property)
         end
         alias unobserve unregister
+        alias deregister unregister
       end
 
       class << self
@@ -99,13 +100,14 @@ module Glimmer
       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)
         dependents_for(registration).each do |dependent|
           dependent.unregister
           remove_dependent(registration => dependent)
         end
-        registrations.delete(registration)
+        registrations.delete(registration).tap do |registration|
+          observable.remove_observer(*[self, property].compact)
+        end
       end
       alias unobserve unregister
 

data/lib/glimmer/dsl/engine.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2007-2020 Andy Maleh
-# 
+# Copyright (c) 2007-2021 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
@@ -7,10 +7,10 @@
 # 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
@@ -51,7 +51,7 @@ module Glimmer
             end
             if interpretation
               interpretation
-            else              
+            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]
@@ -62,8 +62,8 @@ module Glimmer
                 Glimmer::DSL::Engine.interpret_expression(static_expression, keyword, *args, &block)
               end
             end
-          end              
-        end      
+          end
+        end
       end
       
       class << self
@@ -115,7 +115,7 @@ module Glimmer
         # Static expressions indexed by keyword and dsl
         def static_expressions
           @static_expressions ||= {}
-        end        
+        end
 
         # Sets dynamic expression chains of responsibility. Useful for internal testing
         attr_writer :dynamic_expression_chains_of_responsibility
@@ -132,7 +132,7 @@ module Glimmer
         # Pattern when interpretting a DSL expression
         def add_dynamic_expressions(dsl_namespace, *expression_names)
           expression_names = expression_names.flatten
-          dsl = dsl_namespace.name.split("::").last.downcase.to_sym          
+          dsl = dsl_namespace.name.split("::").last.downcase.to_sym
           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|
@@ -140,7 +140,7 @@ module Glimmer
             expression_handler = ExpressionHandler.new(expression)
             expression_handler.next = last_expresion_handler if last_expresion_handler
             expression_handler
-          end                   
+          end
         end
 
         def add_static_expression(static_expression)
@@ -161,10 +161,11 @@ module Glimmer
         end
 
         # Interprets Glimmer dynamic DSL expression consisting of keyword, args, and block (e.g. shell(:no_resize) { ... })
-        def interpret(keyword, *args, &block)          
+        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?
+          # TODO consider pushing this code into interpret_expresion to provide hooks that work around it regardless of static vs dynamic
           dsl_stack.push(dynamic_expression_dsl || dsl)
           expression = dynamic_expression_chains_of_responsibility[dsl].handle(parent, keyword, *args, &block)
           interpret_expression(expression, keyword, *args, &block)
@@ -185,7 +186,7 @@ module Glimmer
         def add_content(parent, expression, &block)
           if block_given? && expression.is_a?(ParentExpression)
             dsl_stack.push(expression.class.dsl)
-            parent_stack.push(parent) 
+            parent_stack.push(parent)
             begin
               expression.add_content(parent, &block)
             ensure