glimmer 0.10.4 → 1.0.0

data/VERSION

@@ -1 +1 @@
-0.10.4
+1.0.0

data/lib/glimmer.rb

@@ -1,7 +1,24 @@
-# Glimmer - a JRuby DSL that enables easy and efficient authoring of user
-# interfaces using the robust platform-independent Eclipse SWT library. Glimmer
-# comes with built-in data-binding support to greatly facilitate synchronizing
-# UI with domain models.
+# 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 'logger'
 require 'set'
 require 'array_include_methods'
@@ -62,6 +79,5 @@ module Glimmer
 end
 
 require 'glimmer/error'
-require 'glimmer/excluded_keyword_error'
 require 'glimmer/invalid_keyword_error'
 require 'glimmer/dsl/engine'

data/lib/glimmer/config.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.
+
 module Glimmer
   module Config
     class << self

data/lib/glimmer/data_binding/model_binding.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/data_binding/observable'
 require 'glimmer/data_binding/observer'
 
@@ -7,7 +28,7 @@ module Glimmer
       include Observable
       include Observer
 
-      attr_reader :binding_options
+      attr_reader :binding_options, :property_name_expression
 
       def initialize(base_model, property_name_expression, binding_options = nil)
         @base_model = base_model
@@ -60,19 +81,10 @@ module Glimmer
       end
 
       def apply_converter(converter, value)
-        if converter.nil?
-          value
-        elsif converter.is_a?(String) || converter.is_a?(Symbol)
-          if value.respond_to?(converter)
-            value.send(converter)
-          else
-            raise Glimmer::Error, "Unsupported bind converter: #{converter.inspect}"
-          end
-        elsif converter.respond_to?(:call, value)
-          converter.call(value)
-        else
-          raise Glimmer::Error, "Unsupported bind converter: #{converter.inspect}"
-        end
+        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
@@ -99,10 +111,6 @@ module Glimmer
         property_name_expression.match(/[.\[]/)
       end
 
-      def property_name_expression
-        @property_name_expression
-      end
-
       def computed?
         !computed_by.empty?
       end
@@ -179,17 +187,19 @@ module Glimmer
           model, property_name = zip
           nested_property_observer = nested_property_observers[property_name]
           previous_index = i - 1
-          parent_model = previous_index.negative? ? self : nested_models[previous_index]
-          parent_property_name = previous_index.negative? ? nil : nested_property_names[previous_index]
-          parent_observer = previous_index.negative? ? observer : nested_property_observers[parent_property_name]
+          if previous_index.negative?
+            parent_model = self
+            parent_property_name = nil
+            parent_observer = observer
+          else
+            parent_model = nested_models[previous_index]
+            parent_property_name = nested_property_names[previous_index]
+            parent_observer = nested_property_observers[parent_property_name]
+          end
           parent_property_name = nil if parent_property_name.to_s.start_with?('[')
           unless model.nil?
-            if property_indexed?(property_name)
-              # TODO figure out a way to deal with this more uniformly
-              observer_registration = nested_property_observer.observe(model)
-            else
-              observer_registration = nested_property_observer.observe(model, property_name)
-            end
+            # TODO figure out a way to deal with this more uniformly
+            observer_registration = property_indexed?(property_name) ? nested_property_observer.observe(model) : nested_property_observer.observe(model, property_name)
             parent_registration = parent_observer.registration_for(parent_model, parent_property_name)
             parent_observer.add_dependent(parent_registration => observer_registration)
           end

data/lib/glimmer/data_binding/observable.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/data_binding/observable_array.rb

@@ -1,13 +1,32 @@
-require 'set'
-require 'array_include_methods'
+# 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 'set'
 require 'glimmer/data_binding/observable'
+require 'array_include_methods'
 
 using ArrayIncludeMethods
 
 module Glimmer
   module DataBinding
-    # TODO prefix utility methods with double-underscore
     module ObservableArray
       include Observable
 
@@ -37,11 +56,7 @@ module Glimmer
         if !element_properties.empty?
           old_element_properties = element_properties_for(observer)
           observer_element_properties[observer] = element_properties_for(observer) - Set.new(element_properties)
-          each do |element|
-            element_properties.each do |property|
-              observer.unobserve(element, property)
-            end
-          end
+          each { |element| element_properties.each { |property| observer.unobserve(element, property) } }
         end
         if element_properties_for(observer).empty?
           property_observer_list.delete(observer)
@@ -169,9 +184,7 @@ module Glimmer
             remove_element_observers(old_value)
           end
           super(&block).tap do
-            each do |element|
-              add_element_observers(element)
-            end
+            each { |element| add_element_observers(element) }
             notify_observers
           end
         else
@@ -181,9 +194,7 @@ module Glimmer
       alias map! collect!
 
       def compact!
-        super.tap do
-          notify_observers
-        end
+        super.tap { notify_observers }
       end
 
       def flatten!(level=nil)
@@ -192,17 +203,13 @@ module Glimmer
           remove_element_observers(old_value)
         end
         (level.nil? ? super() : super(level)).tap do
-          each do |element|
-            add_element_observers(element)
-          end
+          each { |element| add_element_observers(element) }
           notify_observers
         end
       end
 
       def rotate!(count=1)
-        super(count).tap do
-          notify_observers
-        end
+        super(count).tap { notify_observers }
       end
 
       def select!(&block)
@@ -221,9 +228,7 @@ module Glimmer
       end
 
       def shuffle!(hash = nil)
-        (hash.nil? ? super() : super(random: hash[:random])).tap do
-          notify_observers
-        end
+        (hash.nil? ? super() : super(random: hash[:random])).tap { notify_observers }
       end
 
       def slice!(arg1, arg2=nil)
@@ -238,15 +243,11 @@ module Glimmer
       end
 
       def sort!(&block)
-        (block.nil? ? super() : super(&block)).tap do
-          notify_observers
-        end
+        (block.nil? ? super() : super(&block)).tap { notify_observers }
       end
 
       def sort_by!(&block)
-        (block.nil? ? super() : super(&block)).tap do
-          notify_observers
-        end
+        (block.nil? ? super() : super(&block)).tap { notify_observers }
       end
 
       def uniq!(&block)
@@ -255,15 +256,15 @@ module Glimmer
           remove_element_observers(old_value)
         end
         (block.nil? ? super() : super(&block)).tap do
-          each do |element|
-            add_element_observers(element)
-          end
+          each { |element| add_element_observers(element) }
           notify_observers
         end
       end
 
       def reject!(&block)
-        if block_given?
+        if block.nil?
+          super
+        else
           old_array = Array.new(self)
           super(&block).tap do
             (old_array - self).each do |old_value|
@@ -272,17 +273,12 @@ module Glimmer
             end
             notify_observers
           end
-        else
-          super
         end
       end
       
       def unregister_dependent_observers(old_value)
-        # TODO look into optimizing this
         return unless old_value.is_a?(ObservableModel) || old_value.is_a?(ObservableArray)
-        property_observer_list.each do |observer|
-          observer.unregister_dependents_with_observable(observer.registration_for(self), old_value)
-        end
+        property_observer_list.each { |observer| observer.unregister_dependents_with_observable(observer.registration_for(self), old_value) }
       end
     end
   end

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)
@@ -47,11 +78,8 @@ module Glimmer
       end
 
       def notify_observers(property_name)
-        property_observer_list(property_name).to_a.each do |observer|
-          observer.call(send(property_name))
-        end
+        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}="
@@ -60,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)
@@ -95,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