hotcocoa 0.5.1 → 0.6.0pre

data/lib/hotcocoa/delegate_builder.rb

@@ -1,85 +1,120 @@
-module HotCocoa
-    
-  class DelegateBuilder
-    
-    attr_reader :control, :delegate, :method_count, :required_methods
-    
-    def initialize(control, required_methods)
-      @control = control
-      @required_methods = required_methods
-      @method_count = 0
-      @delegate = Object.new
-    end
-    
-    def add_delegated_method(block, selector_name, *parameters)
-      clear_delegate if required_methods.empty?
-      increment_method_count
-      bind_block_to_delegate_instance_variable(block)
-      create_delegate_method(selector_name, parameters)
-      set_delegate if required_methods.empty?
+##
+# Builds a delegate for a control at runtime by creating a generic object
+# and adding singleton methods for each given delegate method; it then
+# tells the control to delegate to that created object.
+class HotCocoa::DelegateBuilder
+
+  # @return The object that needs a delegate
+  attr_reader :control
+
+  # @return [Array<>] Delegate methods which are assumed to be implemented
+  #    and therefore __MUST__ be given at least a stub
+  attr_reader :required_methods
+
+  # @return [Fixnum] Number of delegate methods that have been added
+  attr_reader :method_count
+
+  # @return [Object] The delegate object
+  attr_reader :delegate
+
+  # @param control the object which needs a delegate
+  # @param [Array<String>] required_methods
+  def initialize control, required_methods
+    @control = control
+    @required_methods = required_methods
+    @method_count = 0
+    @delegate = Object.new
+  end
+
+  ##
+  # Add a delegated method for {#control} to {#delegate}
+  def add_delegated_method block, selector_name, *parameters
+    clear_delegate if required_methods.empty?
+
+    @method_count += 1
+    bind_block_to_delegate_instance_variable(block)
+    create_delegate_method(selector_name, parameters)
+
+    set_delegate if required_methods.empty?
+  end
+
+  def delegate_to object, *method_names
+    method_names.each do |method_name|
+      control.send(method_name, &object.method(method_name)) if object.respond_to?(method_name)
     end
-    
-    def delegate_to(object, *method_names)
-      method_names.each do |method_name|
-        control.send(method_name, &object.method(method_name)) if object.respond_to?(method_name)
+  end
+
+  private
+
+  def bind_block_to_delegate_instance_variable block
+    delegate.instance_variable_set(block_instance_variable, block)
+  end
+
+  ##
+  # @todo GET RID OF EVAL
+  def create_delegate_method selector_name, parameters
+    required_methods.delete(selector_name)
+    eval %{
+      def delegate.#{parameterize_selector_name(selector_name)}
+        #{block_instance_variable}.call(#{parameter_values_for_mapping(selector_name, parameters)})
       end
+    }
+  end
+
+  ##
+  # Reset the delegate for {#control} to `nil`.
+  def clear_delegate
+    control.setDelegate(nil) if control.delegate
+  end
+
+  ##
+  # Set the delegate for {#control} to {#delegate}
+  def set_delegate
+    control.setDelegate(delegate)
+  end
+
+  ##
+  # Returns an instance variable name to be used for the delegate method
+  # currently being built.
+  #
+  # @return [String]
+  def block_instance_variable
+    "@block#{method_count}"
+  end
+
+  ##
+  # Take an Objective-C selector and create a parameter list to be used
+  # in creating method's using #eval
+  #
+  # @example
+  #   parameterize_selector_name('myDelegateMethod') # => 'myDeletageMethod'
+  #   parameterize_selector_name('myDelegateMethod:withArgument:') # => 'myDeletageMethod p1, withArgumnet:p2'
+  #
+  # @param [String] selector_name
+  # @return [String]
+  def parameterize_selector_name selector_name
+    return selector_name unless selector_name.include?(':')
+
+    params = selector_name.split(':')
+    result = "#{params.shift} p1"
+    params.each_with_index do |param, i|
+      result << ",#{param}:p#{i + 2}"
     end
-    
-    private 
-    
-      def increment_method_count
-        @method_count += 1
-      end
-      
-      def bind_block_to_delegate_instance_variable(block)
-        delegate.instance_variable_set(block_instance_variable, block)
-      end
-      
-      def create_delegate_method(selector_name, parameters)
-        required_methods.delete(selector_name)
-        eval %{
-          def delegate.#{parameterize_selector_name(selector_name)}
-            #{block_instance_variable}.call(#{parameter_values_for_mapping(selector_name, parameters)})
-          end
-        }
-      end
-      
-      def clear_delegate
-        control.setDelegate(nil) if control.delegate
-      end
-      
-      def set_delegate
-        control.setDelegate(delegate)
-      end
-      
-      def block_instance_variable
-        "@block#{method_count}"
-      end
-    
-      def parameterize_selector_name(selector_name)
-        return selector_name unless selector_name.include?(":")
-        params = selector_name.split(":")
-        result = "#{params.shift}(p1"
-        params.each_with_index do |param, i|
-          result << ", #{param}:p#{i+2}"
-        end
-        result + ")"
-      end
-      
-      def parameter_values_for_mapping(selector_name, parameters)
-        return if parameters.empty?
-        result = []
-        selector_params = selector_name.split(":")
-        parameters.each do |parameter|
-          if (dot = parameter.index("."))
-            result << "p#{selector_params.index(parameter[0...dot])+1}#{parameter[dot..-1]}"
-          else
-            result << "p#{selector_params.index(parameter)+1}"
-          end
-        end
-        result.join(", ")
+    result
+  end
+
+  def parameter_values_for_mapping selector_name, parameters
+    return if parameters.empty?
+
+    result = []
+    selector_params = selector_name.split(':')
+    parameters.each do |parameter|
+      if (dot = parameter.index('.'))
+        result << "p#{selector_params.index(parameter[0...dot]) + 1}#{parameter[dot..-1]}"
+      else
+        result << "p#{selector_params.index(parameter) +  1}"
       end
-    
+    end
+    result.join(', ')
   end
-  
 end