romaonthego / restkit-generate

A model generator for RestKit (http://github.com/RestKit/RestKit).

restkit-generate

A model generator for iOS RestKit (Rails-like), ARC compliant. Xcode 4.4+ is required.

Installation

Make sure you have Ruby installed. This guide assumes you have one of the supported Ruby implementations installed:

• Ruby 1.8.7
• Ruby 1.9.2
• Ruby 1.9.3

Install the gem via RubyGems:

$ gem install restkit-generate

Sample usage

$ restkit-generate model Business id:NSNumber title:NSString address:NSString created_at:NSDate updated_at:NSDate

It produces 2 files: BaseBusiness.h

//
//  BaseBusiness.h
//

#import <Foundation/Foundation.h>
#import <RestKit/RestKit.h>

@interface BaseBusiness : NSObject <NSCoding>

@property (strong, nonatomic) NSNumber *businessId;
@property (copy, nonatomic) NSString *title;
@property (copy, nonatomic) NSString *address;
@property (strong, nonatomic) NSDate *createdAt;
@property (strong, nonatomic) NSDate *updatedAt;

+ (RKObjectMapping *)objectMapping;

@end

and BaseBusiness.m

//
//  BaseBusiness.m
//

#import "BaseBusiness.h

@implementation BaseBusiness

+ (RKObjectMapping *)objectMapping
{
	RKObjectMapping* mapping = [RKObjectMapping mappingForClass:[self class]];
	[mapping addAttributeMappingsFromDictionary:@{
		@"id": @"businessId",
		@"title": @"title",
		@"address": @"address",
		@"created_at": @"createdAt",
		@"updated_at": @"updatedAt"
	}];
}

- (id)initWithCoder:(NSCoder *)coder
{
	self = [[[self class] alloc] init];
	if (self) {
		self.businessId = [coder decodeObjectForKey:@"businessId"];
		self.title = [coder decodeObjectForKey:@"title"];
		self.address = [coder decodeObjectForKey:@"address"];
		self.createdAt = [coder decodeObjectForKey:@"createdAt"];
		self.updatedAt = [coder decodeObjectForKey:@"updatedAt"];
	}
	return self;
}

- (void)encodeWithCoder:(NSCoder *)coder
{
	[coder encodeObject:self.businessId forKey:@"businessId"];
	[coder encodeObject:self.title forKey:@"title"];
	[coder encodeObject:self.address forKey:@"address"];
	[coder encodeObject:self.createdAt forKey:@"createdAt"];
	[coder encodeObject:self.updatedAt forKey:@"updatedAt"];
}

@end

Include these files with your project and inherit a Business object from BaseBusiness where you can implement additional calls/methods. You can rebuild BaseBusiness anytime (in case you add/remove fields, etc.) so your main logic in the Business model won't be affected. Run with --no-prefix to remove Base prefix or your can set your own with command -p PREFIX.

CoreData

You can generate CoreData models that integrate with RestKit, in order to do that add -c parameter.

ARC

restkit-generate outputs files that use ARC. If you are not using ARC in your Xcode project, add -fobjc-arc as a compiler flag.

Copyright

Copyright (c) 2013 Roman Efimov

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.