opal 0.0.1 → 0.1.0

data/opals/foundation/lib/foundation/core/attributes.rb

@@ -0,0 +1,146 @@
+# 
+# attributes.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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.
+#
+
+
+  # KeyValueCoding module for Object instances
+class Object
+    
+  def get_attribute(key)
+    # if we have a method with the given key
+    if respond_to? key
+      __send__ key
+    # check for a boolean key (key with '?' suffix)
+    elsif respond_to? "#{key}?"
+      __send__ "#{key}?"
+    # just an instance variable of the right name
+    elsif instance_variable_defined?("@#{key}")
+      instance_variable_get "@#{key}"
+    # worst case: just handle as undefined key
+    else
+      value_for_undefined_key key
+    end
+  end
+  
+  
+  def set_attribute(key, value)
+    # First try and use predefined setter key=
+    if respond_to? "#{key}="
+      __send__ "#{key}=", value
+    
+    # check if we have the instance variable already, and just set it. We must
+    # also make KVO aware of the change
+    elsif instance_variable_defined?("@#{key}")
+      will_change_attribute key
+      instance_variable_set "@#{key}", value
+      did_change_attribute key
+      
+    # worst case: set as undefined key
+    else
+      set_value_for_undefined_key value, key
+    end
+    
+    value
+  end
+  
+  def get_path(key_path)
+    # simply return value_for_key if not a path
+    return get_attribute(key_path) unless key_path.index('.')
+    
+    parts = key_path.split '.'
+    object = self
+    
+    # go through each part and update object as chained path
+    parts.each do |part|
+      object = object.get_attribute part
+    end
+    
+    object
+  end
+  
+  def set_path(key_path, value)
+    # simply return set_value_for_key if not a path
+    return set_attribute(key_path, value) unless key_path.index('.')
+    
+    parts = key_path.split('.')
+    last_part = parts.pop
+    object = self
+    
+    parts.each do |part|
+      object = object.get_attribute part
+    end
+    
+    object.set_attribute last_part, value
+  end
+  
+  def value_for_undefined_key(key)
+    raise "#{self.inspect} is not Key Value Coding compliant for key #{key}"
+  end
+  
+  def set_value_for_undefined_key(value, key)
+    raise "#{self.inspect} is not Key Value Coding compliant for key #{key}"
+  end
+end
+
+module CherryKit
+  
+  module HashKeyValueCoding
+    
+    def get_attribute(key)
+      self[key.to_s]
+    end
+    
+    def set_attribute(key, value)
+      self[key.to_s] = value
+    end
+  end
+end
+  
+# Object.include CherryKit::KeyValueCoding
+Hash.include CherryKit::HashKeyValueCoding
+
+class NilClass
+  
+  def get_attribute(key)
+    nil
+  end
+end
+
+# Attribute coding works on each array item, rather than on the array itself.
+class Array
+  
+  def get_attribute(key)
+    self.map do |object|
+      object.get_attribute key
+    end
+  end
+  
+  # Calls set on each item belonging to the array
+  def set_attribute(key, value)
+    self.each do |object|
+      object.set_attribute key, value
+    end
+  end
+end

data/opals/foundation/lib/foundation/core/bindings.rb

@@ -0,0 +1,125 @@
+# 
+# key_value_binding.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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 'foundation/core/observable'
+
+class Object
+  
+  # Exposes the given binding_name on the receiving class. This also defines a
+  # method 'key_binding=' for the given key so that its binding information can
+  # be set with a hash dynamically. This is more useful for builder when making
+  # GUIs, but it can be used from anywhere. It is esentially a shortcut for
+  # the more normal Kernel#bind method.
+  # 
+  # @param {Symbol} binding_name to expose
+  # 
+  def self.expose_binding(binding_name)
+    define_method("#{binding_name}_binding=") do |binding_options|
+      bind binding_name, binding_options
+    end
+  end
+end
+
+module CherryKit
+  
+  module Bindings
+    
+    # Usage:
+    # 
+    #     bind :value, :to => some_controller, :path => 'some_key_name'
+    # 
+    # Keys
+    # ----
+    # 
+    # Required keys:
+    #   :to - the object to bind to
+    #   :path - the path on the given object to bind to
+    # 
+    # Optional keys:
+    #   
+    # 
+    # @param {Symbol} binding
+    # @param {Hash} binding_options
+    # 
+    def bind(binding, binding_options)
+      to = binding_options[:to] or raise "binding options must have a :to key"
+      key = binding_options[:path].to_s or raise "binding options must have :path key"
+      # first make sure we unbind any existing binding
+      unbind binding
+      
+      @__ck_bindings[binding] = KVBBindingProxy.new(binding, to, key, nil, self)
+    end
+    
+    def unbind(the_binding)
+      # incase this is our first binding for this object
+      @__ck_bindings ||= {}
+      
+      binding = @__ck_bindings[the_binding]
+
+      return unless binding
+      # raise "should not get to here yet. need to implement"
+    end
+    
+    # Proxy object to manage the notifications between two bound objects. 
+    # Instances of this class deal with all passed options etc to maintain a
+    # performant binding system
+    class KVBBindingProxy
+      
+      def initialize(binding, observed, path, options, source)
+        @binding = binding
+        @observed = observed
+        @path = path
+        @options = options
+        @source = source
+        
+        # observed.add_observer self, key_path, [:new], binding
+        
+        observed.observe(path) do |info|
+          update_value_for binding
+        end
+        
+        # only if initial?
+        update_value_for binding
+      end
+      
+      # Send updates values
+      def update_value_for(context)
+        new_value = @observed.get_path @path
+        # transform values
+        # new_value = transform_value new_value, @options
+        
+        @source.set_attribute context, new_value
+      end
+      
+      def transform_value(value, options)
+        
+      end
+      
+    end    
+  end
+end
+
+Object.include CherryKit::Bindings

data/opals/foundation/lib/foundation/core/builder.rb

@@ -0,0 +1,101 @@
+# 
+# builder.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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 CherryKit
+  
+  # Builder module is in charge of registering and constructing methods for
+  # a DSL like syntax for building up interfaces with default options for 
+  # classes.
+  module Builder
+    
+    # Builder DSL methods added to classes
+    module BuilderClassMethods
+
+      # Register the given builder_name with a set of default options
+      # builder_options. Each option given to the builder, once merged with
+      # options given on the construction of a builder instance, will be set on
+      # the resulting object instance using key value coding.
+      # 
+      #     class SomeViewClass < View
+      # 
+      #       register_builder :some_view, :background_color => :blue
+      # 
+      #     end
+      # 
+      #     # create an instance
+      #     some_view :size => [100, 200], :background_color  => :red
+      #     # => #<SomeViewClass:102923>
+      # 
+      # @param {Symbol} builder_name
+      # @param {Hash} builder_options
+      # @returns {Class} self
+      # 
+      def register_builder(builder_name, builder_options)
+        # puts "registering builder #{builder_name}"
+
+        builder_class = self
+
+        CherryKit.define_method(builder_name) do |options, &block|
+          # puts "some code here"
+          # puts builder_options
+          # puts "builder class is #{builder_class}"
+          # options = {}
+          builder_class.build options
+        end
+      end
+      
+      # Create an instance from the receiver class
+      def build(builder_options)
+        object = allocate
+ 
+        object.initialize_from_builder builder_options
+        
+        # now go through each builder_option that is left in hash
+        builder_options.each do |key, value|
+          # puts "builder setting #{key} to #{value}"
+          # object.set_value_for_key value, key
+          object.set_attribute key, value
+        end
+        # simply return our object
+        object
+      end
+    end #BuilderClassMethods
+
+    # Builder DSL methods that are added to instances
+    module BuilderMethods
+
+      def initialize_from_builder(builder_options)
+        # default, just call initialize, no params
+        initialize
+      end
+    end # BuilderMethods
+      
+  end # Builder
+end
+
+Object.extend CherryKit::Builder::BuilderClassMethods
+Object.include CherryKit::Builder::BuilderMethods

data/opals/foundation/lib/foundation/core/event.rb

@@ -0,0 +1,112 @@
+# 
+# event.rb
+# vienna
+# 
+# Created by Adam Beynon.
+# Copyright 2010 Adam Beynon.
+#
+# 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 CherryKit
+  
+  # Module to hold cherry kit additions to the event class. These additions are
+  # used for custom handling of events within cherry kit applications.
+  # 
+  module EventAdditions
+    
+    # Returns the View instance that the event originated from. Basically, the
+    # native target property is retreieved, and then that element is compared to
+    # CherryKits hash of elements => views. The element's parentNode is
+    # recursively got until the node has an id (which is used to lookup in the
+    # hash table)
+    # 
+    # @returns {CherryKit::View} the view
+    # 
+    def view
+      if @view
+        return @view
+      else
+      element = `#{self}.__event__.target || #{self}.__event__.srcElement;`
+      `while (element) {
+        if (!element.id) {
+          element = element.parentNode; 
+        } else {
+          break;
+        }
+      }`
+      return @view = CherryKit::View[`#{element}.id`]
+      end
+    end
+    
+    # manually set view
+    def view=(view)
+      @view = view
+    end
+    
+    # location in clinet (browser)
+    # 
+    # @returns {CherryKit::Point} location
+    # 
+    def location_in_client
+      return @location_in_client if @location_in_client
+      # if we have not cached it, now do it
+      event = `#{self}.__event__;`
+      
+      # @location_in_client = { :left => `#{event}.clientX`,
+                              # :top  => `#{event}.clientY` }
+                              
+      @location_in_client = Browser::Point.new `#{event}.clientX`, `#{event}.clientY`
+    end
+    
+    # location of event within designated view
+    # 
+    def location_in_view(view)
+      offset = view.render_context.element.element_offset
+      client = location_in_client
+      
+      Browser::Point.new(client.x - offset.x, client.y - offset.y)
+    end
+    
+    # CherryKit window for the event
+    # 
+    def window
+      @window ||= view.window
+    end
+    
+    
+    # =================
+    # = Touch support =
+    # =================
+    
+    def changed_touches
+      return @changed_touches if @changed_touches
+      @changed_touches = []
+      `var event = #{self}.__event__;
+      var changed = event.changedTouches;
+      for (var i = 0; i < changed.length; i++) {
+        #{@changed_touches}.push(#{Touch}.$from_native(changed[i]));
+      }`
+      @changed_touches
+    end
+    
+  end
+end
+
+Browser::Event.include CherryKit::EventAdditions