glimmer 1.0.7 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.7
+1.1.0

data/glimmer.gemspec

@@ -1,17 +1,17 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer 1.0.7 ruby lib
+# stub: glimmer 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "1.0.7"
+  s.version = "1.1.0"
 
   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 = "2021-01-11"
+  s.date = "2021-02-08"
   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 = [
@@ -41,33 +41,50 @@ Gem::Specification.new do |s|
     "lib/glimmer/dsl/static_expression.rb",
     "lib/glimmer/dsl/top_level_expression.rb",
     "lib/glimmer/error.rb",
+    "lib/glimmer/ext/module.rb",
     "lib/glimmer/invalid_keyword_error.rb"
   ]
   s.homepage = "http://github.com/AndyObtiva/glimmer".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.1.4".freeze
+  s.rubygems_version = "3.0.6".freeze
   s.summary = "Glimmer Ruby DSL Engine".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
-  end
 
-  if s.respond_to? :add_runtime_dependency then
-    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"])
-    s.add_development_dependency(%q<puts_debuggerer>.freeze, ["~> 0.10.0"])
-    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"])
-    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"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      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_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 1.1.7", "< 2.0.0"])
+      s.add_development_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+      s.add_development_dependency(%q<puts_debuggerer>.freeze, ["~> 0.10.0"])
+      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"])
+      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.4", "< 2.0.0"])
+      s.add_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
+      s.add_dependency(%q<concurrent-ruby>.freeze, [">= 1.1.7", "< 2.0.0"])
+      s.add_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+      s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.10.0"])
+      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"])
+      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"])
+    end
   else
     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<concurrent-ruby>.freeze, [">= 1.1.7", "< 2.0.0"])
     s.add_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
     s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.10.0"])

data/lib/glimmer.rb

@@ -22,10 +22,20 @@
 require 'logger'
 require 'set'
 require 'array_include_methods'
+if RUBY_ENGINE == 'opal'
+  module Concurrent
+    Array = ::Array
+    Hash = ::Hash
+    Set = ::Set
+  end
+else
+  require 'concurrent-ruby'
+end
 
 $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 require 'glimmer/config'
+require 'glimmer/ext/module'
 
 # Glimmer provides a JRuby Desktop UI DSL + Data-Binding functionality
 #
@@ -56,7 +66,9 @@ module Glimmer
 
   def method_missing(method_symbol, *args, &block)
     # 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) }
+    is_excluded = Config.excluded_keyword_checkers.any? do |checker|
+      instance_exec(method_symbol, *args, &checker)
+    end
     if is_excluded
       Glimmer::Config.logger.debug "Glimmer excluded keyword: #{method_symbol}" if Glimmer::Config.log_excluded_keywords?
       super(method_symbol, *args, &block)

data/lib/glimmer/data_binding/model_binding.rb

@@ -33,7 +33,7 @@ module Glimmer
       def initialize(base_model, property_name_expression, binding_options = nil)
         @base_model = base_model
         @property_name_expression = property_name_expression
-        @binding_options = binding_options || {}
+        @binding_options = binding_options || Concurrent::Hash.new
         if computed?
           @computed_model_bindings = computed_by.map do |computed_by_property_expression|
             self.class.new(base_model, computed_by_property_expression)
@@ -72,21 +72,6 @@ module Glimmer
         nested_property? ? nested_property_name : property_name_expression
       end
 
-      def convert_on_read(value)
-        apply_converter(@binding_options[:on_read], value)
-      end
-
-      def convert_on_write(value)
-        apply_converter(@binding_options[:on_write], value)
-      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)
-        raise Glimmer::Error, "Unsupported bind converter: #{converter.inspect}"
-      end
-
       # All nested property names
       # e.g. property name expression "address.state" gives ['address', 'state']
       # If there are any indexed property names, this returns indexes as properties.
@@ -120,9 +105,9 @@ module Glimmer
       end
 
       def nested_property_observers_for(observer)
-        @nested_property_observers_collection ||= {}
+        @nested_property_observers_collection ||= Concurrent::Hash.new
         unless @nested_property_observers_collection.has_key?(observer)
-          @nested_property_observers_collection[observer] = nested_property_names.reduce({}) do |output, property_name|
+          @nested_property_observers_collection[observer] = nested_property_names.reduce(Concurrent::Hash.new) do |output, property_name|
             output.merge(
               property_name => Observer.proc do |new_value|
                 # Ensure reattaching observers when a higher level nested property is updated (e.g. person.address changes reattaches person.address.street observer)
@@ -164,7 +149,7 @@ module Glimmer
       end
 
       def computed_observer_for(observer)
-        @computed_observer_collection ||= {}
+        @computed_observer_collection ||= Concurrent::Hash.new
         unless @computed_observer_collection.has_key?(observer)
           @computed_observer_collection[observer] = Observer.proc do |new_value|
             observer.call(evaluate_property)
@@ -215,9 +200,12 @@ module Glimmer
       def evaluate_property
         value = nil
         value = invoke_property_reader(model, property_name) unless model.nil?
-        convert_on_read(value)
+        apply_processor(@binding_options[:before_read], value)
+        converted_value = convert_on_read(value)
+        apply_processor(@binding_options[:after_read], converted_value)
+        converted_value
       end
-
+      
       def evaluate_options_property
         model.send(options_property_name) unless model.nil?
       end
@@ -230,6 +218,29 @@ module Glimmer
         property_expression.to_s.start_with?('[')
       end
 
+      private
+
+      def convert_on_read(value)
+        apply_processor(@binding_options[:on_read], value)
+      end
+
+      def convert_on_write(value)
+        apply_processor(@binding_options[:on_write], value)
+      end
+
+      def apply_processor(processor, value)
+        return value if processor.nil?
+        return value.send(processor) if (processor.is_a?(String) || processor.is_a?(Symbol)) && value.respond_to?(processor)
+        return invoke_proc_with_exact_parameters(processor, value) if processor.respond_to?(:call)
+        raise Glimmer::Error, "Unsupported bind processor: #{processor.inspect}"
+      end
+
+      def invoke_proc_with_exact_parameters(proc_object, *args)
+        return if proc_object.nil?
+        args = args[0...proc_object.parameters.size]
+        proc_object.call(*args)
+      end
+
       def invoke_property_reader(object, property_expression)
         if property_indexed?(property_expression)
           property_method = '[]'
@@ -243,14 +254,16 @@ module Glimmer
 
       def invoke_property_writer(object, property_expression, value)
         raise "Cannot invoke `#{property_expression}` because ModelBinding#binding_options[:read_only]=true" if @binding_options[:read_only]
-        value = convert_on_write(value)
+        apply_processor(@binding_options[:before_write], value)
+        converted_value = convert_on_write(value)
+        apply_processor(@binding_options[:after_write], converted_value)
         if property_indexed?(property_expression)
           property_method = '[]='
           property_argument = property_expression[1...-2]
           property_argument = property_argument.to_i if property_argument.match(/\d+/)
-          object.send(property_method, property_argument, value)
+          object.send(property_method, property_argument, converted_value)
         else
-          object.send(property_expression, value)
+          object.send(property_expression, converted_value)
         end
       end
     end

data/lib/glimmer/data_binding/observable_array.rb

@@ -34,7 +34,7 @@ module Glimmer
         element_properties = element_properties.flatten.compact.uniq
         return observer if has_observer?(observer) && has_observer_element_properties?(observer, element_properties)
         property_observer_list << observer
-        observer_element_properties[observer] = element_properties_for(observer) + Set.new(element_properties)
+        observer_element_properties[observer] = element_properties_for(observer) + Concurrent::Set.new(element_properties)
         each { |element| add_element_observer(element, observer) }
         observer
       end
@@ -55,7 +55,7 @@ module Glimmer
         element_properties = element_properties.flatten.compact.uniq
         if !element_properties.empty?
           old_element_properties = element_properties_for(observer)
-          observer_element_properties[observer] = element_properties_for(observer) - Set.new(element_properties)
+          observer_element_properties[observer] = element_properties_for(observer) - Concurrent::Set.new(element_properties)
           each { |element| element_properties.each { |property| observer.unobserve(element, property) } }
         end
         if element_properties_for(observer).empty?
@@ -87,15 +87,15 @@ module Glimmer
       end
 
       def property_observer_list
-        @property_observer_list ||= Set.new
+        @property_observer_list ||= Concurrent::Set.new
       end
 
       def observer_element_properties
-        @observer_element_properties ||= {}
+        @observer_element_properties ||= Concurrent::Hash.new
       end
 
       def element_properties_for(observer)
-        observer_element_properties[observer] ||= Set.new
+        observer_element_properties[observer] ||= Concurrent::Set.new
       end
 
       def notify_observers
@@ -289,6 +289,7 @@ module Glimmer
         return unless old_value.is_a?(ObservableModel) || old_value.is_a?(ObservableArray)
         property_observer_list.each { |observer| observer.unregister_dependents_with_observable(observer.registration_for(self), old_value) }
       end
+      alias deregister_dependent_observers unregister_dependent_observers
     end
   end
 end

data/lib/glimmer/data_binding/observable_model.rb

@@ -92,7 +92,7 @@ module Glimmer
       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] = Concurrent::Set.new unless property_observer_hash[property_name.to_sym]
         property_observer_hash[property_name.to_sym]
       end
 
@@ -124,6 +124,7 @@ module Glimmer
         return unless old_value.is_a?(ObservableModel) || old_value.is_a?(ObservableArray)
         property_observer_list(property_name).each { |observer| observer.unregister_dependents_with_observable(observer.registration_for(self, property_name), old_value) }
       end
+      alias deregister_dependent_observers unregister_dependent_observers
 
       def ensure_array_object_observer(property_name, object, old_object = nil)
         return unless object&.is_a?(Array)
@@ -137,7 +138,7 @@ module Glimmer
       end
 
       def array_object_observer_for(property_name)
-        @array_object_observers ||= {}
+        @array_object_observers ||= Concurrent::Hash.new
         @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

@@ -61,7 +61,7 @@ module Glimmer
       end
 
       def registrations
-        @registrations ||= Set.new
+        @registrations ||= Concurrent::Set.new
       end
 
       def registration_for(observable, property = nil)
@@ -75,7 +75,7 @@ module Glimmer
       end
 
       def dependents_for(registration)
-        dependents[registration] ||= Set.new
+        dependents[registration] ||= Concurrent::Set.new
       end
 
       # registers observer in an observable on a property (optional)
@@ -110,6 +110,7 @@ module Glimmer
         end
       end
       alias unobserve unregister
+      alias deregister unregister
 
       def unregister_dependents_with_observable(registration, dependent_observable)
         thedependents = dependents_for(registration).select do |thedependent|
@@ -117,12 +118,15 @@ module Glimmer
         end
         thedependents.each(&:unregister)
       end
+      alias unobserve_dependents_with_observable unregister_dependents_with_observable
+      alias deregister_dependents_with_observable unregister_dependents_with_observable
 
       # cleans up all registrations in observables
       def unregister_all_observables
         registrations.each(&:unregister)
       end
       alias unobserve_all_observables unregister_all_observables
+      alias deregister_all_observables unregister_all_observables
 
       # add dependent observer to unregister when unregistering observer
       def add_dependent(parent_to_dependent_hash)

data/lib/glimmer/dsl/engine.rb

@@ -28,7 +28,7 @@ module Glimmer
   module DSL
     # Glimmer DSL Engine
     #
-    # Follows Interpreter and Chain of Responsibility Design Patterns
+    # Follows Interpreter, Chain of Responsibility, and Singleton Design Patterns
     #
     # When DSL engine interprets an expression, it attempts to handle
     # with ordered expression array specified via `.expressions=` method.
@@ -37,10 +37,11 @@ module Glimmer
       STATIC_EXPRESSION_METHOD_FACTORY = lambda do |keyword|
         lambda do |*args, &block|
           if Glimmer::DSL::Engine.no_dsls?
-            puts Glimmer::DSL::Engine::MESSAGE_NO_DSLS
+            puts Glimmer::DSL::Engine::MESSAGE_NO_DSLS # TODO consider switching to an error log statement
           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?
+            # TODO consider replacing Glimmer::DSL::Engine.static_expressions[keyword].keys - Glimmer::DSL::Engine.disabled_dsls with Glimmer::DSL::Engine.enabled_static_expression_dsls(keyword)
+            static_expression_dsl = (Glimmer::DSL::Engine.static_expressions[keyword].keys - Glimmer::DSL::Engine.disabled_dsls).first
             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
@@ -55,8 +56,9 @@ module Glimmer
               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}"
+              static_expression_can_interpret = nil
+              if static_expression.nil? || !(static_expression_can_interpret = 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.inspect} with DSL #{Glimmer::DSL::Engine.dsl.inspect} and static expression #{static_expression.inspect} having can_interpret? as #{static_expression_can_interpret.inspect}"
               else
                 Glimmer::Config.logger.info {"#{static_expression.class.name} will handle expression keyword #{keyword}"}
                 Glimmer::DSL::Engine.interpret_expression(static_expression, keyword, *args, &block)
@@ -86,7 +88,7 @@ module Glimmer
         end
 
         def disabled_dsls
-          @disabled_dsls ||= []
+          @disabled_dsls ||= Concurrent::Array.new
         end
 
         def enabled_dsls=(dsl_names)
@@ -109,12 +111,12 @@ module Glimmer
 
         # Dynamic expression chains of responsibility indexed by dsl
         def dynamic_expression_chains_of_responsibility
-          @dynamic_expression_chains_of_responsibility ||= {}
+          @dynamic_expression_chains_of_responsibility ||= Concurrent::Hash.new
         end
 
         # Static expressions indexed by keyword and dsl
         def static_expressions
-          @static_expressions ||= {}
+          @static_expressions ||= Concurrent::Hash.new
         end
 
         # Sets dynamic expression chains of responsibility. Useful for internal testing
@@ -147,7 +149,7 @@ module Glimmer
           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] ||= Concurrent::Hash.new
           static_expressions[keyword][static_expression_dsl] = static_expression
           Glimmer.send(:define_method, keyword, &STATIC_EXPRESSION_METHOD_FACTORY.call(keyword))
         end
@@ -162,7 +164,7 @@ module Glimmer
 
         # Interprets Glimmer dynamic DSL expression consisting of keyword, args, and block (e.g. shell(:no_resize) { ... })
         def interpret(keyword, *args, &block)
-          return puts(MESSAGE_NO_DSLS) if no_dsls?
+          return puts(MESSAGE_NO_DSLS) if no_dsls? # TODO consider switching to an error log statement
           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
@@ -203,16 +205,16 @@ module Glimmer
         def_delegator :parent_stack, :last, :parent
 
         def parent_stack
-          parent_stacks[dsl] ||= []
+          parent_stacks[dsl] ||= Concurrent::Array.new
         end
 
         def parent_stacks
-          @parent_stacks ||= {}
+          @parent_stacks ||= Concurrent::Hash.new
         end
 
         # Enables multiple DSLs to play well with each other when mixing together
         def dsl_stack
-          @dsl_stack ||= []
+          @dsl_stack ||= Concurrent::Array.new
         end
       end
     end

data/lib/glimmer/ext/module.rb

@@ -0,0 +1,11 @@
+class Module
+  alias append_features_without_glimmer append_features
+  def append_features(mod)
+    if self == Glimmer && mod == Object
+      Glimmer::Config.logger.debug { 'Appending Glimmer to Singleton Class of main object (not appending to Object everywhere to avoid method pollution)' }
+      TOPLEVEL_BINDING.receiver.singleton_class.include(self)
+    else
+      append_features_without_glimmer(mod)
+    end
+  end
+end