Merge pull request #568 from swagger-api/feature/objc-templates

Feature/objc templates

Author: fehguy

bin/objc-petstore.sh

@@ -26,6 +26,6 @@ fi
 
 # if you've executed sbt assembly previously it will use that instead.
 export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
-ags="$@ generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l objc -o samples/client/petstore/objc"
+ags="$@ generate -t modules/swagger-codegen/src/main/resources/objc -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l objc -o samples/client/petstore/objc"
 
 java -DappName=PetstoreClient $JAVA_OPTS -jar $executable $ags

modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/languages/ObjcClientCodegen.java

@@ -102,6 +102,8 @@ public ObjcClientCodegen() {
 
     supportingFiles.add(new SupportingFile("SWGObject.h", sourceFolder, "SWGObject.h"));
     supportingFiles.add(new SupportingFile("SWGObject.m", sourceFolder, "SWGObject.m"));
+    supportingFiles.add(new SupportingFile("SWGQueryParamCollection.h", sourceFolder, "SWGQueryParamCollection.h"));
+    supportingFiles.add(new SupportingFile("SWGQueryParamCollection.m", sourceFolder, "SWGQueryParamCollection.m"));
     supportingFiles.add(new SupportingFile("SWGApiClient.h", sourceFolder, "SWGApiClient.h"));
     supportingFiles.add(new SupportingFile("SWGApiClient.m", sourceFolder, "SWGApiClient.m"));
     supportingFiles.add(new SupportingFile("SWGFile.h", sourceFolder, "SWGFile.h"));

modules/swagger-codegen/src/main/resources/objc/SWGApiClient.m

@@ -1,5 +1,6 @@
 #import "SWGApiClient.h"
 #import "SWGFile.h"
+#import "SWGQueryParamCollection.h"
 
 @implementation SWGApiClient
 
@@ -208,14 +209,45 @@ -(NSString*) pathWithQueryParamsToString:(NSString*) path
             if(counter == 0) separator = @"?";
             else separator = @"&";
             NSString * value;
-            if([[queryParams valueForKey:key] isKindOfClass:[NSString class]]){
-                value = [SWGApiClient escape:[queryParams valueForKey:key]];
+            id queryParam = [queryParams valueForKey:key];
+            if([queryParam isKindOfClass:[NSString class]]){
+                [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
+                                          [SWGApiClient escape:key], [SWGApiClient escape:[queryParams valueForKey:key]]]];
+            }
+            else if([queryParam isKindOfClass:[SWGQueryParamCollection class]]){
+                SWGQueryParamCollection * coll = (SWGQueryParamCollection*) queryParam;
+                NSArray* values = [coll values];
+                NSString* format = [coll format];
+                
+                if([format isEqualToString:@"csv"]) {
+                    [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
+                        [SWGApiClient escape:key], [NSString stringWithFormat:@"%@", [values componentsJoinedByString:@","]]]];
+
+                }
+                else if([format isEqualToString:@"tsv"]) {
+                    [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
+                        [SWGApiClient escape:key], [NSString stringWithFormat:@"%@", [values componentsJoinedByString:@"\t"]]]];
+
+                }
+                else if([format isEqualToString:@"pipes"]) {
+                    [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
+                        [SWGApiClient escape:key], [NSString stringWithFormat:@"%@", [values componentsJoinedByString:@"|"]]]];
+
+                }
+                else if([format isEqualToString:@"multi"]) {
+                    for(id obj in values) {
+                        [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
+                            [SWGApiClient escape:key], [NSString stringWithFormat:@"%@", obj]]];
+                        counter += 1;
+                    }
+
+                }
             }
             else {
-                value = [NSString stringWithFormat:@"%@", [queryParams valueForKey:key]];
+                [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
+                                          [SWGApiClient escape:key], [NSString stringWithFormat:@"%@", [queryParams valueForKey:key]]]];
             }
-            [requestUrl appendString:[NSString stringWithFormat:@"%@%@=%@", separator,
-                                      [SWGApiClient escape:key], value]];
+
             counter += 1;
         }
     }

modules/swagger-codegen/src/main/resources/objc/SWGQueryParamCollection.h

@@ -0,0 +1,9 @@
+@interface SWGQueryParamCollection : NSObject
+
+@property(nonatomic, readonly) NSArray* values;
+@property(nonatomic, readonly) NSString* format;
+
+- (id) initWithValuesAndFormat: (NSArray*) values
+                        format: (NSString*) format;
+
+@end

modules/swagger-codegen/src/main/resources/objc/SWGQueryParamCollection.m

@@ -0,0 +1,16 @@
+#import "SWGQueryParamCollection.h"
+
+@implementation SWGQueryParamCollection
+
+@synthesize values = _values;
+@synthesize format = _format;
+
+- (id) initWithValuesAndFormat: (NSArray*) values
+                        format: (NSString*) format {
+    _values = values;
+    _format = format;
+
+    return self;
+}
+
+@end

modules/swagger-codegen/src/main/resources/objc/api-body.mustache

@@ -1,6 +1,7 @@
 {{#operations}}
 #import "{{classname}}.h"
 #import "SWGFile.h"
+#import "SWGQueryParamCollection.h"
 #import "SWGApiClient.h"
 {{#imports}}#import "{{import}}.h"
 {{/imports}}
@@ -71,8 +72,12 @@ static NSString * basePath = @"{{basePath}}";
     NSString* responseContentType = @"application/json";
 
     NSMutableDictionary* queryParams = [[NSMutableDictionary alloc] init];
-    {{#queryParams}}if({{paramName}} != nil)
-        queryParams[@"{{baseName}}"] = {{paramName}};
+    {{#queryParams}}if({{paramName}} != nil) {
+        {{#collectionFormat}}
+        queryParams[@"{{baseName}}"] = [[SWGQueryParamCollection alloc] initWithValuesAndFormat: {{baseName}} format: @"{{collectionFormat}}"];
+        {{/collectionFormat}}
+        {{^collectionFormat}}queryParams[@"{{baseName}}"] = {{paramName}};{{/collectionFormat}}
+    }
     {{/queryParams}}
     NSMutableDictionary* headerParams = [[NSMutableDictionary alloc] init];
     {{#headerParams}}if({{paramName}} != nil)

modules/swagger-codegen/src/main/resources/objc/api-header.mustache

@@ -16,12 +16,9 @@
 /**
 
  {{{summary}}}
- {{#notes}}
- {{{notes}}}
- {{/notes}}
+ {{#notes}}{{{notes}}}{{/notes}}
 
- {{#allParams}}
- @param {{paramName}} {{description}}
+ {{#allParams}}@param {{paramName}} {{description}}
  {{/allParams}}
 
  return type: {{returnType}}

pom.xml

@@ -277,8 +277,8 @@
         </plugins>
       </build>
     </profile>
+    <!-- Samples -->
     <profile>
-      <!-- Samples -->
       <id>java-client</id>
       <activation>
         <property>

samples/client/petstore/objc/PetstoreClient/PetstoreClient.xcodeproj/project.pbxproj

@@ -23,6 +23,7 @@
 		EA6699BE1811D2FB00A70D03 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = EA66999D1811D2FA00A70D03 /* UIKit.framework */; };
 		EA6699C61811D2FB00A70D03 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = EA6699C41811D2FB00A70D03 /* InfoPlist.strings */; };
 		EA6699C81811D2FB00A70D03 /* PetApiTest.m in Sources */ = {isa = PBXBuildFile; fileRef = EA6699C71811D2FB00A70D03 /* PetApiTest.m */; };
+		EA8B8AA41AC6683700638FBB /* SWGQueryParamCollection.m in Sources */ = {isa = PBXBuildFile; fileRef = EA8B8AA31AC6683700638FBB /* SWGQueryParamCollection.m */; };
 		EA8CD3ED1AC2763600C47D0B /* SenTestingKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = EA8CD3EC1AC2763600C47D0B /* SenTestingKit.framework */; };
 		EAEA85E41811D3AE00F06E69 /* SWGApiClient.m in Sources */ = {isa = PBXBuildFile; fileRef = EAEA85CD1811D3AE00F06E69 /* SWGApiClient.m */; };
 		EAEA85E51811D3AE00F06E69 /* SWGCategory.m in Sources */ = {isa = PBXBuildFile; fileRef = EAEA85CF1811D3AE00F06E69 /* SWGCategory.m */; };
@@ -75,6 +76,8 @@
 		EA6699C31811D2FB00A70D03 /* PetstoreClientTests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "PetstoreClientTests-Info.plist"; sourceTree = "<group>"; };
 		EA6699C51811D2FB00A70D03 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
 		EA6699C71811D2FB00A70D03 /* PetApiTest.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = PetApiTest.m; sourceTree = "<group>"; };
+		EA8B8AA21AC6683700638FBB /* SWGQueryParamCollection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SWGQueryParamCollection.h; sourceTree = "<group>"; };
+		EA8B8AA31AC6683700638FBB /* SWGQueryParamCollection.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SWGQueryParamCollection.m; sourceTree = "<group>"; };
 		EA8CD3EB1AC274BE00C47D0B /* PetApiTest.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = PetApiTest.h; sourceTree = "<group>"; };
 		EA8CD3EC1AC2763600C47D0B /* SenTestingKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SenTestingKit.framework; path = Library/Frameworks/SenTestingKit.framework; sourceTree = DEVELOPER_DIR; };
 		EAEA85CC1811D3AE00F06E69 /* SWGApiClient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SWGApiClient.h; sourceTree = "<group>"; };
@@ -227,6 +230,8 @@
 		EAEA85CB1811D3AE00F06E69 /* client */ = {
 			isa = PBXGroup;
 			children = (
+				EA8B8AA21AC6683700638FBB /* SWGQueryParamCollection.h */,
+				EA8B8AA31AC6683700638FBB /* SWGQueryParamCollection.m */,
 				EAFBEABC1A92C42700A27431 /* SWGApiResponse.h */,
 				EAFBEABD1A92C42700A27431 /* SWGApiResponse.m */,
 				EAEA85CC1811D3AE00F06E69 /* SWGApiClient.h */,
@@ -407,6 +412,7 @@
 				EAEA85EC1811D3AE00F06E69 /* SWGStoreApi.m in Sources */,
 				EAEA85E91811D3AE00F06E69 /* SWGOrder.m in Sources */,
 				EAEA85E81811D3AE00F06E69 /* SWGObject.m in Sources */,
+				EA8B8AA41AC6683700638FBB /* SWGQueryParamCollection.m in Sources */,
 				EAEA85E71811D3AE00F06E69 /* SWGFile.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;