rest_kat 0.0.4

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm ruby-1.9.2@rest_kat
+

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+gem 'kwalify'  

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 mySugr Apps OG
+
+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.

data/README.md

@@ -0,0 +1,188 @@
+RestKat
+=======
+
+We have all heard the mantra that REST does not require a schema because it is
+just JSON. However when I found myself writing hundreds of lines of objective C
+binding code with [RestKit](http://restkit.org) I thought that there must be
+a better way of doing the boring bits.
+
+Now there is RestKat.
+
+You just have to declare your API in a YAML file using an extension to the
+[kwalify](http://www.kuwata-lab.com/kwalify/) schema validator.
+
+A schema looks like the following
+
+    configuration_type: &configuration_type
+        type: map
+        name: XXConfiguration
+        mapping:
+            name:
+                type: str
+                required: yes
+            email:
+                type: str
+                required: yes
+
+    log_type: &todo_type
+        type: map
+        name: XXTodo
+        mapping:
+            id:
+                type:int
+                required: yes
+            due:
+                type: str
+                name: NSDate
+            desc:
+                type: str
+                name: NSString
+
+    search_type: &search_type
+        type: map
+        name: XXTodoSearch
+        mapping:
+            desc:
+                type: str
+                required: yes
+                
+            
+        
+    
+    ##########################################
+    #  REQUEST TYPES
+    ##########################################
+
+    # permissions and generated routes. A 's' singleton
+    # modifier can be added to indicate that the resource
+    # does not represent a collection
+    #
+    #   s  - singleton modifier
+    #
+    #   c  - POST "/resource"
+    #   sc - invalid
+    #
+    #   r  - GET  "/resource/:id" 
+    #        GET  "/resource" 
+    #   sr - GET "/resource" 
+    #
+    #   u  - adds PUT "/resource/:id"
+    #   su - adds PUT "/resource"
+    #
+    #   d  - adds PUT "/resource/:id"
+    #   sd - adds PUT "/resource"
+    #
+    resources:
+
+      # singletons
+      - name: configuration
+        type: *configuration_type
+        resource: /configuration
+        permissions: sru
+
+      # collections
+      - name: todo
+        type: *todo_type
+        resource: /todo
+        queries:
+            - name: search
+              type: *search_type
+        permissions: crud
+
+The resources section defines the RESTful resources and
+thier methods. The type of each resource refers to types
+defined further up the file. The name of each type must
+refer to the desired objective C class name for each
+type.
+
+Resources can be interfaced with through the generated
+subclasses via this interface.
+
+    @interface MSRestSerializableResource : MSRestSerializable
+
+    #pragma mark methods to be overridden
+
+    + (Class) classForResource;
+
+    // The resource path. If this 
+    + (NSString *) resourcePath;
+
+    // Is the resource a singleton or a collection
+    + (bool) isSingleton;
+
+    // Can the client create resources
+    + (bool) canCreate;
+
+    // Can the client read resources
+    + (bool) canRead;
+
+    // Can the client update resources
+    + (bool) canUpdate;
+
+    // Can the client delete resources
+    + (bool) canDelete;
+
+    #pragma mark helpers
+
+    // The router for this class
+    + (RKObjectRouter *) router;
+
+    // Intialize the routing module. Must
+    // be called from +initialize in a 
+    // subclass or the logic will not
+    // work.
+    + (void) initializeRouting;
+
+
+    // save the object
+    -(void) saveWithDelegate:(id<RKObjectLoaderDelegate>)delegate;
+
+    // Find an instance by id
+    + (void) find:(NSNumber *)id 
+     withDelegate:(id<RKObjectLoaderDelegate>)delegate;
+
+    // Load collection
+    + (void) loadCollectionWithDelegate:(id<RKObjectLoaderDelegate>)delegate;
+
+    // Load collection with query
+    + (void) loadCollectionThroughQuery:(MSRestSerializable *)mappableQueryObject 
+                           withDelegate:(id<RKObjectLoaderDelegate>)delegate;
+
+    @end
+
+Standard types of int, float, str are mapped to
+NSNumber, NSNumber and NSString respectively unless
+a specialized class is given.
+
+There is a helper for your custom rake task to do
+the building of the source code for you. For example
+you could do
+
+    require 'rest_kat'
+
+    namespace :iphone do
+      namespace :api do
+        ApiLocation = File.expand_path "src/AutoGen", __FILE__
+        SchemaLocation = File.expand_path "api_schema.yml", __FILE__
+
+        task :_generate => RestKat::generate_api(ApiLocation, SchemaLocation)
+
+        desc "Generate iPhone API to #{ApiLocation}"
+        task :generate => :_generate
+      end
+    end
+
+The class heirarchy for the generated classes is
+
+    MSRestSerializable 
+            ^
+            |
+    MSRestSerializableResource
+
+All types that are also are resource derive from MSRestSerializableResource
+and all helper or nested types derive from MSRestSerializable.
+
+Refer to MSRestSerializable.h for more details and the [restKit documentation](http://restkit.org)
+
+
+

data/README.rdoc

@@ -0,0 +1,19 @@
+= rest_kat
+
+Description goes here.
+
+== Contributing to rest_kat
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 mySugr Apps OG. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rest_kat"
+  gem.homepage = "http://github.com/mysugr/rest_kat"
+  gem.license = "MIT"
+  gem.summary = %Q{Generate objective C RestKit boilerplate code from a yaml schema}
+  gem.description = %Q{The generated source code is a layer on top of the iOS REST framework http://restkit.org/}
+  gem.email = "brad.phelan@mysugr.com"
+  gem.authors = ["Brad Phelan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rest_kat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/model.h.erb

@@ -0,0 +1,60 @@
+#import <Foundation/Foundation.h>
+#import <RestKit/Restkit.h>
+#import "MSRestSerializable.h"
+
+<%classes.each do |klass|%>
+<%if klass.resource%>
+//@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+//@@ 
+//@@ Resource Name
+//@@ 
+//@@    <%= klass.resource.hash[:name] %>
+//@@
+//@@ Resource Type
+//@@
+//@@    <%= klass.resource.hash[:type][:name] %>
+//@@
+//@@ Resource Path
+//@@    <%= klass.resource.hash[:resource] %>
+//@@ 
+//@@ Permissions:
+//@@
+//@@    Singleton: <%= klass.resource.c_permission_for 's' %>
+//@@    Create   : <%= klass.resource.c_permission_for 'c' %>
+//@@    Read     : <%= klass.resource.c_permission_for 'r' %>
+//@@    Update   : <%= klass.resource.c_permission_for 'u' %>
+//@@    Delete   : <%= klass.resource.c_permission_for 'd' %>
+//@@
+//@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+<%else%>
+//////////////////////////////////////////////////////////////////////////////
+//// <%= klass.objc_class %>
+//////////////////////////////////////////////////////////////////////////////
+<%end%>
+@interface <%= klass.objc_class %> : <%= klass.objc_super_class %>
+<%klass.properties.each do |property|%>
+<%if property.klass.seq? %>
+// <%=property.name%> : <%=property.klass.json_type%> of <%=property.klass.sequence_of.objc_class%>
+<%else%>
+// <%=property.name%> : <%=property.klass.json_type%>
+<%end%>
+<%if property.klass.enum?%>
+//  Enumeration of
+<%property.klass.enum.each do |e|%>
+//    - <%=e%>
+<%end%>
+<%end%>
+<%=property.klass.objc_property_decl property.name%>;
+<%end%>
+
+// Initialize all the methods. Called by +initialize ( don't call manually )
++ (void)initializeMapping;
+
+// Static initializer ( don't call manually )
++ (void)initialize;
+
+// <%= klass.objc_class %> convenience builder.
++ (<%=klass.objc_class%> *)buildWith_<%=klass.objc_properites_arg_list_decl%>;
+@end
+
+<%end%>

data/lib/model.m.erb

@@ -0,0 +1,115 @@
+#import "<%=header%>"
+
+<%classes.each do |klass|%>
+//////////////////////////////////////////////////////////////////////////////
+//// <%= klass.objc_class %>
+//////////////////////////////////////////////////////////////////////////////
+@implementation <%= klass.objc_class %>
+
+<%klass.properties.each do |property|%>
+@synthesize <%= property.name %>;
+<%end%>
+
++ (void)initialize{
+<%if klass.resource%>
+  [self initializeRouting];
+<%end%>
+  [self initializeMapping];
+}
+
++ (void)initializeMapping{
+    RKObjectMapping* mapping = [RKObjectMapping mappingForClass:[<%=klass.objc_class%> class]];
+
+    // -------------------------------------------
+    // Define the properties mappings
+    <%klass.properties.each do |property|%> <%if not property.klass.complex? %>
+    [mapping mapKeyPath:@"<%=property.name%>" toAttribute:@"<%=property.name%>"];
+    <%end%> <%end%>
+
+    // -------------------------------------------
+    // Define the relationship mappings
+    <%klass.properties.each do |property|%> 
+    <%if property.klass.complex? %>
+    { 
+      <%if property.klass.map?%>
+        RKObjectMapping * mapper = [[RKObjectManager sharedManager].mappingProvider objectMappingForClass:[<%=property.klass.objc_class%> class]];
+        [mapping hasOne:@"<%=property.name%>" withMapping:mapper];
+      <%elsif property.klass.seq?%>
+        RKObjectMapping * mapper = [[RKObjectManager sharedManager].mappingProvider objectMappingForClass:[<%=property.klass.sequence_of.objc_class%> class]];
+        [mapping hasMany:@"<%=property.name%>" withMapping:mapper];
+      <%end%>
+    }
+    <%end%> 
+    <%end%>
+
+    // -------------------------------------------
+    // Register the mapper for the class
+    [[RKObjectManager sharedManager].mappingProvider addObjectMapping:mapping];
+
+    // -------------------------------------------
+    // Register the serializer for the class
+    [[RKObjectManager sharedManager].mappingProvider setSerializationMapping:[mapping inverseMapping] forClass:[<%=klass.objc_class%> class] ];
+}
+
+<%if klass.resource%>
++ (NSString *) resourcePath {
+  return @"<%= klass.resource.hash[:resource] %>";
+}
+
+
++ (Class) classForResource{
+  return [ <%=klass.resource.objc_resource_type%> class];
+}
+
++ (bool)isSingleton
+{
+  return <%=klass.resource.c_permission_for 's'%>;
+}
+
++ (bool)canCreate
+{
+  return <%=klass.resource.c_permission_for 'c'%>;
+}
+
++ (bool)canRead
+{
+  return <%=klass.resource.c_permission_for 'r'%>;
+}
+
++ (bool)canUpdate
+{
+  return <%=klass.resource.c_permission_for 'u'%>;
+}
+
++ (bool)canDelete
+{
+  return <%=klass.resource.c_permission_for 'd'%>;
+}
+<%end%>
+
+// <%=klass.objc_class%> convenience builder.
+// Note that +id+ field if present is not set by this
+// builder and so can be used to construct a *new* object
++ (<%=klass.objc_class%> *)buildWith_<%=klass.objc_properites_arg_list_decl%>
+{
+  <%=klass.objc_class%> * object = [[<%=klass.objc_class%> alloc] init];
+<%klass.properties.reject{|p|p.name=='id'}.each do |property|%>
+  object.<%=property.name%> = <%=property.name%>;
+<%end%>
+return object;
+}
+
+
+// Deep Copy
+- (id) copyWithZone : (NSZone * ) zone
+{
+  <%=klass.objc_class%> * object = [[<%=klass.objc_class%> allocWithZone:zone] init];
+  <%klass.properties.each do |property|%>
+    object.<%=property.name%> = [self.<%=property.name%> copy];
+  <%end%>
+  return object;
+}
+
+@end
+
+<%end%>