appjam 0.1.0.pre4

data/lib/appjam/generators/Classes/org/puremvc/objectivec/core/Model.m

@@ -0,0 +1,117 @@
+//
+//  Model.m
+//  PureMVC_ObjectiveC
+//
+//  PureMVC Port to ObjectiveC by Brian Knorr <brian.knorr@puremvc.org>
+//  PureMVC - Copyright(c) 2006-2008 Futurescale, Inc., Some rights reserved.
+//
+
+#import "Model.h"
+
+static id<IModel> instance;
+
+@implementation Model
+
+@synthesize proxyMap;
+
+/**
+ * Constructor. 
+ * 
+ * <P>
+ * This <code>IModel</code> implementation is a Singleton, 
+ * so you should not call the constructor 
+ * directly, but instead call the static Singleton 
+ * Factory method <code>[Model getInstance]</code>
+ * 
+ * @throws NSException if Singleton instance has already been constructed
+ * 
+ */
+-(id)init {
+	if (instance != nil) {
+		[NSException raise:@"Model Singleton already constructed! Use getInstance instead." format:@""];
+	} else if (self = [super init]) {
+		self.proxyMap = [NSMutableDictionary dictionary];
+		[self initializeModel];
+	}
+	return self;
+}
+
+/**
+ * Initialize the Singleton <code>Model</code> instance.
+ * 
+ * <P>
+ * Called automatically by the constructor, this
+ * is your opportunity to initialize the Singleton
+ * instance in your subclass without overriding the
+ * constructor.</P>
+ * 
+ * @return void
+ */
+-(void)initializeModel {
+}
+
+/**
+ * <code>Model</code> Singleton Factory method.
+ * 
+ * @return the Singleton instance
+ */
++(id<IModel>)getInstance {
+	if (instance == nil) {
+		instance = [[self alloc] init];
+	}
+	return instance;
+}
+
+/**
+ * Check if a Proxy is registered
+ * 
+ * @param proxyName
+ * @return whether a Proxy is currently registered with the given <code>proxyName</code>.
+ */
+-(BOOL)hasProxy:(NSString *)proxyName {
+	return [proxyMap objectForKey:proxyName] != nil;
+}
+
+/**
+ * Register an <code>IProxy</code> with the <code>Model</code>.
+ * 
+ * @param proxy an <code>IProxy</code> to be held by the <code>Model</code>.
+ */
+-(void)registerProxy:(id<IProxy>)proxy {
+	[proxyMap setObject:proxy forKey:[proxy proxyName]];
+	[proxy onRegister];
+}
+
+/**
+ * Remove an <code>IProxy</code> from the <code>Model</code>.
+ * 
+ * @param proxyName name of the <code>IProxy</code> instance to be removed.
+ * @return the <code>IProxy</code> that was removed from the <code>Model</code>
+ */
+-(id<IProxy>)removeProxy:(NSString *)proxyName {
+	id<IProxy> proxy = [proxyMap objectForKey:proxyName];
+	if (proxy != nil) {
+		[proxy onRemove];
+		[proxyMap removeObjectForKey:proxyName];
+	}
+	return proxy;
+}
+
+/**
+ * Retrieve an <code>IProxy</code> from the <code>Model</code>.
+ * 
+ * @param proxyName
+ * @return the <code>IProxy</code> instance previously registered with the given <code>proxyName</code>.
+ */
+-(id<IProxy>)retrieveProxy:(NSString *)proxyName {
+	return [proxyMap objectForKey:proxyName];
+}
+
+-(void)dealloc {
+	self.proxyMap = nil;
+	[(id)instance release];
+	instance = nil;
+	[super dealloc];
+}
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/core/View.h

@@ -0,0 +1,39 @@
+//
+//  View.h
+//  PureMVC_ObjectiveC
+//
+//  PureMVC Port to ObjectiveC by Brian Knorr <brian.knorr@puremvc.org>
+//  PureMVC - Copyright(c) 2006-2008 Futurescale, Inc., Some rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "IView.h"
+
+/**
+ * A Singleton <code>IView</code> implementation.
+ * 
+ * <P>
+ * In PureMVC, the <code>View</code> class assumes these responsibilities:
+ * <UL>
+ * <LI>Maintain a cache of <code>IMediator</code> instances.</LI>
+ * <LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
+ * <LI>Notifiying <code>IMediators</code> when they are registered or removed.</LI>
+ * <LI>Managing the observer lists for each <code>INotification</code> in the application.</LI>
+ * <LI>Providing a method for attaching <code>IObservers</code> to an <code>INotification</code>'s observer list.</LI>
+ * <LI>Providing a method for broadcasting an <code>INotification</code>.</LI>
+ * <LI>Notifying the <code>IObservers</code> of a given <code>INotification</code> when it broadcast.</LI>
+ * </UL>
+ * 
+ * @see Mediator, Observer, Notification
+ */
+@interface View : NSObject <IView> {
+	NSMutableDictionary *mediatorMap, *observerMap;
+}
+
+@property(nonatomic, retain) NSMutableDictionary *mediatorMap, *observerMap;
+
+-(id)init;
+-(void)initializeView;
++(id<IView>)getInstance;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/core/View.m

@@ -0,0 +1,207 @@
+//
+//  View.m
+//  PureMVC_ObjectiveC
+//
+//  PureMVC Port to ObjectiveC by Brian Knorr <brian.knorr@puremvc.org>
+//  PureMVC - Copyright(c) 2006-2008 Futurescale, Inc., Some rights reserved.
+//
+
+#import "View.h"
+#import "Observer.h"
+#import "IObserver.h"
+
+static id<IView> instance;
+
+@implementation View
+
+@synthesize mediatorMap, observerMap;
+
+/**
+ * Constructor. 
+ * 
+ * <P>
+ * This <code>IView</code> implementation is a Singleton, 
+ * so you should not call the constructor 
+ * directly, but instead call the static Singleton 
+ * Factory method <code>[View getInstance]</code>
+ * 
+ * @throws NSException if Singleton instance has already been constructed
+ * 
+ */
+-(id)init {
+	if (instance != nil) {
+		[NSException raise:@"View Singleton already constructed! Use getInstance instead." format:@""];
+	} else if (self = [super init]) {
+		self.mediatorMap = [NSMutableDictionary dictionary];
+		self.observerMap = [NSMutableDictionary dictionary];
+		[self initializeView];
+	}
+	return self;
+}
+
+/**
+ * Initialize the Singleton View instance.
+ * 
+ * <P>
+ * Called automatically by the constructor, this
+ * is your opportunity to initialize the Singleton
+ * instance in your subclass without overriding the
+ * constructor.</P>
+ * 
+ * @return void
+ */
+-(void)initializeView {
+}
+
+/**
+ * View Singleton Factory method.
+ * 
+ * @return the Singleton instance of <code>View</code>
+ */
++(id<IView>)getInstance {
+	if (instance == nil) {
+		instance = [[self alloc] init];
+	}
+	return instance;
+}
+
+/**
+ * Check if a Mediator is registered or not
+ * 
+ * @param mediatorName
+ * @return whether a Mediator is registered with the given <code>mediatorName</code>.
+ */
+-(BOOL)hasMediator:(NSString *)mediatorName {
+	return [mediatorMap objectForKey:mediatorName] != nil;
+}
+
+/**
+ * Notify the <code>IObservers</code> for a particular <code>INotification</code>.
+ * 
+ * <P>
+ * All previously attached <code>IObservers</code> for this <code>INotification</code>'s
+ * list are notified and are passed a reference to the <code>INotification</code> in 
+ * the order in which they were registered.</P>
+ * 
+ * @param notification the <code>INotification</code> to notify <code>IObservers</code> of.
+ */
+-(void)notifyObservers:(id<INotification>)notification {
+	NSMutableArray *observers = [observerMap objectForKey:[notification name]];
+	NSMutableArray *workingObservers = [NSMutableArray array];
+	if (observers != nil) {
+		for (id<IObserver> observer in observers) {
+			[workingObservers addObject:observer];
+		}
+		for (id<IObserver> observer in workingObservers) {
+			[observer notifyObserver:notification];
+		}
+	}
+}
+
+/**
+ * Register an <code>IMediator</code> instance with the <code>View</code>.
+ * 
+ * <P>
+ * Registers the <code>IMediator</code> so that it can be retrieved by name,
+ * and further interrogates the <code>IMediator</code> for its 
+ * <code>INotification</code> interests.</P>
+ * <P>
+ * If the <code>IMediator</code> returns any <code>INotification</code> 
+ * names to be notified about, an <code>Observer</code> is created encapsulating 
+ * the <code>IMediator</code> instance's <code>handleNotification</code> method 
+ * and registering it as an <code>Observer</code> for all <code>INotifications</code> the 
+ * <code>IMediator</code> is interested in.</p>
+ * 
+ * @param mediator a reference to the <code>IMediator</code> instance
+ */
+-(void)registerMediator:(id<IMediator>)mediator {
+	if ([mediatorMap objectForKey:[mediator mediatorName]] != nil) {
+		return;
+	}
+	[mediatorMap setObject:mediator	forKey:[mediator mediatorName]];
+	NSArray *interests = [mediator listNotificationInterests];
+	if ([interests count] > 0) {
+		id<IObserver> observer = [Observer withNotifyMethod:@selector(handleNotification:) notifyContext:mediator];
+		for (NSString *notificationName in interests) {
+			[self registerObserver:notificationName observer:observer];
+		}
+	}
+	[mediator onRegister];
+}
+
+/**
+ * Register an <code>IObserver</code> to be notified
+ * of <code>INotifications</code> with a given name.
+ * 
+ * @param notificationName the name of the <code>INotifications</code> to notify this <code>IObserver</code> of
+ * @param observer the <code>IObserver</code> to register
+ */
+-(void)registerObserver:(NSString *)notificationName observer:(id<IObserver>)observer {
+	NSMutableArray *observers = [observerMap objectForKey:notificationName];
+	if (observers == nil) {
+		observers = [NSMutableArray array];
+		[observerMap setObject:observers forKey:notificationName];
+	} 
+	[observers addObject:observer];
+}
+
+/**
+ * Remove an <code>IMediator</code> from the <code>View</code>.
+ * 
+ * @param mediatorName name of the <code>IMediator</code> instance to be removed.
+ * @return the <code>IMediator</code> that was removed from the <code>View</code>
+ */
+-(id<IMediator>)removeMediator:(NSString *)mediatorName {
+	id<IMediator> mediator = [mediatorMap objectForKey:mediatorName];
+	if (mediator != nil) {
+		NSArray *interests = [mediator listNotificationInterests];
+		for (NSString *notificationName in interests) {
+			[self removeObserver:notificationName notifyContext:mediator];
+		}
+		[mediator onRemove];
+		[mediator setViewComponent:nil];
+		[mediatorMap removeObjectForKey:mediatorName];
+	}
+	return mediator;
+}
+
+/**
+ * Remove the observer for a given notifyContext from an observer list for a given Notification name.
+ * <P>
+ * @param notificationName which observer list to remove from 
+ * @param notifyContext remove the observer with this object as its notifyContext
+ */
+-(void)removeObserver:(NSString *)notificationName notifyContext:(id)notifyContext {
+	NSMutableArray *observers = [observerMap objectForKey:notificationName];
+	if (observers != nil) {
+		for (id<IObserver> observer in observers) {
+			if ([observer compareNotifyContext:notifyContext]) {
+				[observers removeObject:observer];
+				break;
+			}
+		}
+		if ([observers count] == 0) {
+			[observerMap removeObjectForKey:notificationName];
+		}
+	}
+}
+
+/**
+ * Retrieve an <code>IMediator</code> from the <code>View</code>.
+ * 
+ * @param mediatorName the name of the <code>IMediator</code> instance to retrieve.
+ * @return the <code>IMediator</code> instance previously registered with the given <code>mediatorName</code>.
+ */
+-(id<IMediator>)retrieveMediator:(NSString *)mediatorName {
+	return [mediatorMap objectForKey:mediatorName];
+}
+
+-(void)dealloc {
+	self.mediatorMap = nil;
+	self.observerMap = nil;
+	[(id)instance release];
+	instance = nil;
+	[super dealloc];
+}
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/ICommand.h

@@ -0,0 +1,16 @@
+#import "INotification.h"
+/**
+ * The interface definition for a PureMVC Command.
+ *
+ * @see INotification
+ */
+@protocol ICommand
+
+/**
+ * Execute the <code>ICommand</code>'s logic to handle a given <code>INotification</code>.
+ * 
+ * @param notification an <code>INotification</code> to handle.
+ */
+-(void)execute:(id<INotification>)notification;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IController.h

@@ -0,0 +1,57 @@
+#import "INotification.h"
+/**
+ * The interface definition for a PureMVC Controller.
+ * 
+ * <P>
+ * In PureMVC, an <code>IController</code> implementor 
+ * follows the 'Command and Controller' strategy, and 
+ * assumes these responsibilities:
+ * <UL>
+ * <LI> Remembering which <code>ICommand</code>s 
+ * are intended to handle which <code>INotifications</code>.</LI>
+ * <LI> Registering itself as an <code>IObserver</code> with
+ * the <code>View</code> for each <code>INotification</code> 
+ * that it has an <code>ICommand</code> mapping for.</LI>
+ * <LI> Creating a new instance of the proper <code>ICommand</code>
+ * to handle a given <code>INotification</code> when notified by the <code>View</code>.</LI>
+ * <LI> Calling the <code>ICommand</code>'s <code>execute</code>
+ * method, passing in the <code>INotification</code>.</LI> 
+ * </UL>
+ *
+ * @see INotification, ICommand
+ */
+@protocol IController
+
+/**
+ * Execute the <code>ICommand</code> previously registered as the
+ * handler for <code>INotification</code>s with the given notification name.
+ * 
+ * @param notification the <code>INotification</code> to execute the associated <code>ICommand</code> for
+ */
+-(void)executeCommand:(id<INotification>)notification;
+
+/**
+ * Check if a Command is registered for a given Notification 
+ * 
+ * @param notificationName
+ * @return whether a Command is currently registered for the given <code>notificationName</code>.
+ */
+-(BOOL)hasCommand:(NSString *)notificationName;
+
+/**
+ * Register a particular <code>ICommand</code> class as the handler 
+ * for a particular <code>INotification</code>.
+ * 
+ * @param notificationName the name of the <code>INotification</code>
+ * @param commandClassRef the Class of the <code>ICommand</code>
+ */
+-(void)registerCommand:(NSString *)notificationName commandClassRef:(Class)commandClassRef;
+
+/**
+ * Remove a previously registered <code>ICommand</code> to <code>INotification</code> mapping.
+ * 
+ * @param notificationName the name of the <code>INotification</code> to remove the <code>ICommand</code> mapping for
+ */
+-(void)removeCommand:(NSString *)notificationName;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IFacade.h

@@ -0,0 +1,135 @@
+#import "INotification.h"
+#import "IMediator.h"
+#import "IProxy.h"
+/**
+ * The interface definition for a PureMVC Facade.
+ *
+ * <P>
+ * The Facade Pattern suggests providing a single
+ * class to act as a central point of communication 
+ * for a subsystem. </P>
+ * 
+ * <P>
+ * In PureMVC, the Facade acts as an interface between
+ * the core MVC actors (Model, View, Controller) and
+ * the rest of your application.</P>
+ * 
+ * @see IModel, IView, IController, ICommand, INotification
+ */
+@protocol IFacade
+
+/**
+ * Check if a Command is registered for a given Notification 
+ * 
+ * @param notificationName
+ * @return whether a Command is currently registered for the given <code>notificationName</code>.
+ */
+-(BOOL)hasCommand:(NSString *)notificationName;
+
+/**
+ * Check if a Mediator is registered or not
+ * 
+ * @param mediatorName
+ * @return whether a Mediator is registered with the given <code>mediatorName</code>.
+ */
+-(BOOL)hasMediator:(NSString *)mediatorName;
+
+/**
+ * Check if a Proxy is registered
+ * 
+ * @param proxyName
+ * @return whether a Proxy is currently registered with the given <code>proxyName</code>.
+ */
+-(BOOL)hasProxy:(NSString *)proxyName;
+
+/**
+ * Notify the <code>IObservers</code> for a particular <code>INotification</code>.
+ * 
+ * <P>
+ * All previously attached <code>IObservers</code> for this <code>INotification</code>'s
+ * list are notified and are passed a reference to the <code>INotification</code> in 
+ * the order in which they were registered.</P>
+ * <P>
+ * NOTE: Use this method only if you are sending custom Notifications. Otherwise
+ * use the sendNotification method which does not require you to create the
+ * Notification instance.</P> 
+ * 
+ * @param notification the <code>INotification</code> to notify <code>IObservers</code> of.
+ */
+-(void)notifyObservers:(id<INotification>)notification;
+
+/**
+ * Register an <code>ICommand</code> with the <code>Controller</code>.
+ * 
+ * @param notificationName the name of the <code>INotification</code> to associate the <code>ICommand</code> with.
+ * @param commandClassRef a reference to the <code>Class</code> of the <code>ICommand</code>.
+ */
+-(void)registerCommand:(NSString *)notificationName commandClassRef:(Class)commandClassRef;
+
+/**
+ * Register an <code>IMediator</code> instance with the <code>View</code>.
+ * 
+ * @param mediator a reference to the <code>IMediator</code> instance
+ */
+-(void)registerMediator:(id<IMediator>)mediator;
+
+/**
+ * Register an <code>IProxy</code> instance with the <code>Model</code>.
+ * 
+ * @param proxy the <code>IProxy</code> to be registered with the <code>Model</code>.
+ */
+-(void)registerProxy:(id<IProxy>)proxy;
+
+/**
+ * Remove a previously registered <code>ICommand</code> to <code>INotification</code> mapping from the Controller.
+ * 
+ * @param notificationName the name of the <code>INotification</code> to remove the <code>ICommand</code> mapping for
+ */
+-(void)removeCommand:(NSString *)notificationName;
+
+/**
+ * Remove a <code>IMediator</code> instance from the <code>View</code>.
+ * 
+ * @param mediatorName name of the <code>IMediator</code> instance to be removed.
+ * @return the <code>IMediator</code> instance previously registered with the given <code>mediatorName</code>.
+ */
+-(id<IMediator>)removeMediator:(NSString *)mediatorName;
+
+/**
+ * Remove an <code>IProxy</code> instance from the <code>Model</code> by name.
+ *
+ * @param proxyName the <code>IProxy</code> to remove from the <code>Model</code>.
+ * @return the <code>IProxy</code> that was removed from the <code>Model</code>
+ */
+-(id<IProxy>)removeProxy:(NSString *)proxyName;
+
+/**
+ * Retrieve an <code>IMediator</code> instance from the <code>View</code>.
+ * 
+ * @param mediatorName the name of the <code>IMediator</code> instance to retrievve
+ * @return the <code>IMediator</code> previously registered with the given <code>mediatorName</code>.
+ */
+-(id<IMediator>)retrieveMediator:(NSString *)mediatorName;
+
+/**
+ * Retrieve a <code>IProxy</code> from the <code>Model</code> by name.
+ * 
+ * @param proxyName the name of the <code>IProxy</code> instance to be retrieved.
+ * @return the <code>IProxy</code> previously regisetered by <code>proxyName</code> with the <code>Model</code>.
+ */
+-(id<IProxy>)retrieveProxy:(NSString *)proxyName;
+
+/**
+ * Create and send an <code>INotification</code>.
+ * 
+ * @param notificationName the name of the notiification to send
+ * @param body the body of the notification
+ * @param type the type of the notification
+ */ 
+-(void)sendNotification:(NSString *)notificationName body:(id)body type:(NSString *)type;
+-(void)sendNotification:(NSString *)notificationName;
+-(void)sendNotification:(NSString *)notificationName body:(id)body;
+-(void)sendNotification:(NSString *)notificationName type:(NSString *)type;
+
+@end
+