glimmer 1.0.10 → 1.2.0

data/VERSION

@@ -1 +1 @@
-1.0.10
+1.2.0

data/glimmer.gemspec

@@ -2,19 +2,20 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer 1.0.10 ruby lib
+# stub: glimmer 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "1.0.10"
+  s.version = "1.2.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-25"
-  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.date = "2021-03-03"
+  s.description = "Glimmer is a Ruby DSL Framework for Ruby GUI and More, 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",
     "LICENSE.txt",
     "README.md"
   ]
@@ -40,12 +41,13 @@ 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.summary = "Glimmer Ruby DSL Engine".freeze
+  s.rubygems_version = "3.2.3".freeze
+  s.summary = "Glimmer - DSL Engine for Ruby GUI and More".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/glimmer.rb

@@ -35,6 +35,7 @@ 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
 #
@@ -65,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)
@@ -78,6 +81,7 @@ module Glimmer
         Glimmer.loop_reset!
       end
       Glimmer.loop_last_data = new_loop_data
+      Glimmer::Config.logger.info {">"*80}
       Glimmer::Config.logger.info {"Interpreting keyword: #{method_symbol}"}
       Glimmer::DSL::Engine.interpret(method_symbol, *args, &block)
     end

data/lib/glimmer/config.rb

@@ -56,10 +56,10 @@ 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']
+            logger.level = ENV['GLIMMER_LOGGER_LEVEL']&.strip&.downcase
           rescue => e
             puts e.message
           end

data/lib/glimmer/data_binding/model_binding.rb

@@ -49,9 +49,7 @@ module Glimmer
       def nested_models
         @nested_models = [base_model]
         model_property_names.reduce(base_model) do |reduced_model, nested_model_property_name|
-          if reduced_model.nil?
-            nil
-          else
+          if !reduced_model.nil?
             invoke_property_reader(reduced_model, nested_model_property_name).tap do |new_reduced_model|
               @nested_models << new_reduced_model
             end
@@ -72,21 +70,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.
@@ -127,7 +110,10 @@ module Glimmer
               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)
                 add_observer(observer)
-                observer.call(evaluate_property)
+                converted_value = evaluate_property
+                observer.call(converted_value).tap do
+                  apply_processor(@binding_options[:after_read], converted_value)
+                end
               end
             )
           end
@@ -142,7 +128,10 @@ module Glimmer
           add_nested_observers(observer)
         else
           model_binding_observer = Observer.proc do |new_value|
-            observer.call(evaluate_property)
+            converted_value = evaluate_property
+            observer.call(converted_value).tap do
+              apply_processor(@binding_options[:after_read], converted_value)
+            end
           end
           observer_registration = model_binding_observer.observe(model, property_name)
           my_registration = observer.registration_for(self)
@@ -167,7 +156,10 @@ module Glimmer
         @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)
+            converted_value = evaluate_property
+            observer.call(converted_value).tap do
+              apply_processor(@binding_options[:after_read], converted_value)
+            end
           end
         end
         @computed_observer_collection[observer]
@@ -215,9 +207,10 @@ module Glimmer
       def evaluate_property
         value = nil
         value = invoke_property_reader(model, property_name) unless model.nil?
+        apply_processor(@binding_options[:before_read], value)
         convert_on_read(value)
       end
-
+      
       def evaluate_options_property
         model.send(options_property_name) unless model.nil?
       end
@@ -230,6 +223,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,15 +259,17 @@ 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)
         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
+        apply_processor(@binding_options[:after_write], converted_value)
       end
     end
   end

data/lib/glimmer/data_binding/observable_array.rb

@@ -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

@@ -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)

data/lib/glimmer/data_binding/observer.rb

@@ -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

@@ -37,7 +37,7 @@ 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 # TODO consider switching to an error log statement
+            Glimmer::Config.logger.error {Glimmer::DSL::Engine::MESSAGE_NO_DSLS}
           else
             retrieved_static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
             # TODO consider replacing Glimmer::DSL::Engine.static_expressions[keyword].keys - Glimmer::DSL::Engine.disabled_dsls with Glimmer::DSL::Engine.enabled_static_expression_dsls(keyword)
@@ -55,6 +55,7 @@ module Glimmer
             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)
+              Glimmer::Config.logger.info {"Assuming DSL: #{Glimmer::DSL::Engine.dsl_stack.last}"}
               static_expression = Glimmer::DSL::Engine.static_expressions[keyword][Glimmer::DSL::Engine.dsl]
               static_expression_can_interpret = nil
               if static_expression.nil? || !(static_expression_can_interpret = static_expression.can_interpret?(Glimmer::DSL::Engine.parent, keyword, *args, &block))
@@ -169,13 +170,14 @@ module Glimmer
           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)
+          Glimmer::Config.logger.info {"Assuming DSL: #{dsl_stack.last}"}
           expression = dynamic_expression_chains_of_responsibility[dsl].handle(parent, keyword, *args, &block)
           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)
+            add_content(ui_object, expression, keyword, *args, &block)
             dsl_stack.pop
           end
         end
@@ -185,12 +187,12 @@ module Glimmer
         # This allows evaluating parent UI object properties and children
         #
         # For example, a shell widget would get properties set and children added
-        def add_content(parent, expression, &block)
+        def add_content(parent, expression, keyword, *args, &block)
           if block_given? && expression.is_a?(ParentExpression)
             dsl_stack.push(expression.class.dsl)
             parent_stack.push(parent)
             begin
-              expression.add_content(parent, &block)
+              expression.add_content(parent, keyword, *args, &block)
             ensure
               parent_stack.pop
               dsl_stack.pop

data/lib/glimmer/dsl/expression.rb

@@ -50,7 +50,7 @@ module Glimmer
       # Adds block content to specified parent UI object (Optional)
       #
       # Only expressions that receive a content block should implement
-      def add_content(parent, &block)
+      def add_content(parent, keyword, *args, &block)
         # No Op by default
       end
 

data/lib/glimmer/dsl/parent_expression.rb

@@ -25,7 +25,7 @@ module Glimmer
   module DSL
     # Mixin that represents expressions that always have a content block
     module ParentExpression
-      def add_content(parent, &block)
+      def add_content(parent, keyword, *args, &block)
         block.call(parent)
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.2.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: array_include_methods
@@ -228,15 +228,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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.
+description: Glimmer is a Ruby DSL Framework for Ruby GUI and More, 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.
 email: andy.am@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
@@ -261,6 +263,7 @@ files:
 - 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
 homepage: http://github.com/AndyObtiva/glimmer
 licenses:
@@ -281,8 +284,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Glimmer Ruby DSL Engine
+summary: Glimmer - DSL Engine for Ruby GUI and More
 test_files: []