Merge pull request #662 from xhh/ruby-module-structure

Organize the generated Ruby code into a module structure

Author: fehguy

modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/DefaultGenerator.java

@@ -165,6 +165,7 @@ public Reader getTemplate(String name) {
         operation.putAll(config.additionalProperties());
         operation.put("classname", config.toApiName(tag));
         operation.put("classVarName", config.toApiVarName(tag));
+        operation.put("importPath", config.toApiImport(tag));
 
         allOperations.add(new HashMap<String, Object>(operation));
         for (int i = 0; i < allOperations.size(); i++) {
@@ -427,6 +428,7 @@ public Map<String, Object> processModels(CodegenConfig config, Map<String, Model
       CodegenModel cm = config.fromModel(key, mm);
       Map<String, Object> mo = new HashMap<String, Object>();
       mo.put("model", cm);
+      mo.put("importPath", config.toModelImport(key));
       models.add(mo);
       allImports.addAll(cm.imports);
     }

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

@@ -8,10 +8,9 @@
 import java.io.File;
 
 public class RubyClientCodegen extends DefaultCodegen implements CodegenConfig {
-  protected String invokerPackage = "com.wordnik.client";
-  protected String groupId = "com.wordnik";
-  protected String artifactId = "swagger-client";
-  protected String artifactVersion = "1.0.0";
+  protected String gemName = "swagger_client";
+  protected String moduleName = null;
+  protected String libFolder = "lib";
 
   public CodegenType getTag() {
     return CodegenType.CLIENT;
@@ -25,10 +24,18 @@ public String getHelp() {
     return "Generates a Ruby client library.";
   }
 
+  /**
+   * Generate Ruby module name from the gem name, e.g. use "SwaggerClient" for "swagger_client".
+   */
+  public String generateModuleName() {
+    return camelize(gemName.replaceAll("[^\\w]+", "_"));
+  }
+
   public RubyClientCodegen() {
     super();
-    modelPackage = "models";
-    apiPackage = "lib";
+    moduleName = generateModuleName();
+    modelPackage = gemName + "/models";
+    apiPackage = gemName + "/api";
     outputFolder = "generated-code/ruby";
     modelTemplateFiles.put("model.mustache", ".rb");
     apiTemplateFiles.put("api.mustache", ".rb");
@@ -39,17 +46,15 @@ public RubyClientCodegen() {
 
     reservedWords = new HashSet<String> (
       Arrays.asList(
-        "__FILE__", "and", "def", "end", "in", "or", "self", "unless", "__LINE__", 
+        "__FILE__", "and", "def", "end", "in", "or", "self", "unless", "__LINE__",
         "begin", "defined?", "ensure", "module", "redo", "super", "until", "BEGIN",
-        "break", "do", "false", "next", "rescue", "then", "when", "END", "case", 
+        "break", "do", "false", "next", "rescue", "then", "when", "END", "case",
         "else", "for", "nil", "retry", "true", "while", "alias", "class", "elsif",
         "if", "not", "return", "undef", "yield")
     );
 
-    additionalProperties.put("invokerPackage", invokerPackage);
-    additionalProperties.put("groupId", groupId);
-    additionalProperties.put("artifactId", artifactId);
-    additionalProperties.put("artifactVersion", artifactVersion);
+    additionalProperties.put("gemName", gemName);
+    additionalProperties.put("moduleName", moduleName);
 
     languageSpecificPrimitives.add("int");
     languageSpecificPrimitives.add("array");
@@ -64,15 +69,18 @@ public RubyClientCodegen() {
     typeMapping.put("List", "array");
     typeMapping.put("map", "map");
 
-    supportingFiles.add(new SupportingFile("swagger-client.gemspec.mustache", "", "swagger-client.gemspec"));
-    supportingFiles.add(new SupportingFile("swagger-client.mustache", "", "lib/swagger-client.rb"));
-    supportingFiles.add(new SupportingFile("swagger.mustache", "", "lib/swagger.rb"));
-    supportingFiles.add(new SupportingFile("monkey.mustache", "", "lib/monkey.rb"));
-    supportingFiles.add(new SupportingFile("swagger/request.mustache", "", "lib/swagger/request.rb"));
-    supportingFiles.add(new SupportingFile("swagger/response.mustache", "", "lib/swagger/response.rb"));
-    supportingFiles.add(new SupportingFile("swagger/version.mustache", "", "lib/swagger/version.rb"));
-    supportingFiles.add(new SupportingFile("swagger/configuration.mustache", "", "lib/swagger/configuration.rb"));
-    supportingFiles.add(new SupportingFile("base_object.mustache", "", "models/base_object.rb"));
+    String baseFolder = "lib/" + gemName;
+    String swaggerFolder = baseFolder + "/swagger";
+    String modelFolder = baseFolder + "/models";
+    supportingFiles.add(new SupportingFile("swagger_client.gemspec.mustache", "", gemName + ".gemspec"));
+    supportingFiles.add(new SupportingFile("swagger_client.mustache", "lib", gemName + ".rb"));
+    supportingFiles.add(new SupportingFile("monkey.mustache", baseFolder, "monkey.rb"));
+    supportingFiles.add(new SupportingFile("swagger.mustache", baseFolder, "swagger.rb"));
+    supportingFiles.add(new SupportingFile("swagger/request.mustache", swaggerFolder, "request.rb"));
+    supportingFiles.add(new SupportingFile("swagger/response.mustache", swaggerFolder, "response.rb"));
+    supportingFiles.add(new SupportingFile("swagger/version.mustache", swaggerFolder, "version.rb"));
+    supportingFiles.add(new SupportingFile("swagger/configuration.mustache", swaggerFolder, "configuration.rb"));
+    supportingFiles.add(new SupportingFile("base_object.mustache", modelFolder, "base_object.rb"));
   }
 
   @Override
@@ -82,11 +90,11 @@ public String escapeReservedWord(String name) {
 
   @Override
   public String apiFileFolder() {
-    return outputFolder + "/" + apiPackage().replace('.', File.separatorChar);
+    return outputFolder + File.separatorChar + "lib" + File.separatorChar + gemName + File.separatorChar + "api";
   }
 
   public String modelFileFolder() {
-    return outputFolder + "/" + modelPackage().replace('.', File.separatorChar);
+    return outputFolder + File.separatorChar + "lib" + File.separatorChar + gemName + File.separatorChar + "models";
   }
 
   @Override
@@ -150,13 +158,13 @@ public String toParamName(String name) {
     // should be the same as variable name
     return toVarName(name);
   }
- 
+
   @Override
   public String toModelName(String name) {
     // model name cannot use reserved keyword, e.g. return
     if(reservedWords.contains(name))
       throw new RuntimeException(name + " (reserved word) cannot be used as a model name");
- 
+
     // camelize the model name
     // phone_number => PhoneNumber
     return camelize(name);
@@ -167,11 +175,11 @@ public String toModelFilename(String name) {
     // model name cannot use reserved keyword, e.g. return
     if(reservedWords.contains(name))
       throw new RuntimeException(name + " (reserved word) cannot be used as a model name");
- 
+
     // underscore the model file name
     // PhoneNumber.rb => phone_number.rb
     return underscore(name);
-  } 
+  }
 
   @Override
   public String toApiFilename(String name) {
@@ -186,7 +194,7 @@ public String toApiFilename(String name) {
   public String toApiName(String name) {
     if(name.length() == 0)
       return "DefaultApi";
-    // e.g. phone_number_api => PhoneNumberApi 
+    // e.g. phone_number_api => PhoneNumberApi
     return camelize(name) + "Api";
   }
 
@@ -196,8 +204,17 @@ public String toOperationId(String operationId) {
     if(reservedWords.contains(operationId))
       throw new RuntimeException(operationId + " (reserved word) cannot be used as method name");
 
-    return underscore(operationId); 
+    return underscore(operationId);
   }
 
+  @Override
+  public String toModelImport(String name) {
+    return modelPackage() + "/" + toModelFilename(name);
+  }
+
+  @Override
+  public String toApiImport(String name) {
+    return apiPackage() + "/" + toApiFilename(name);
+  }
 
 }

modules/swagger-codegen/src/main/resources/ruby/api.mustache

@@ -1,57 +1,59 @@
 require "uri"
 
+module {{moduleName}}
 {{#operations}}
-class {{classname}}
-  basePath = "{{basePath}}"
-  # apiInvoker = APIInvoker
+  class {{classname}}
+    basePath = "{{basePath}}"
+    # apiInvoker = APIInvoker
 {{#operation}}
 {{newline}}
-  # {{summary}}
-  # {{notes}}
-{{#allParams}}{{#required}}  # @param {{paramName}} {{description}}
-{{/required}}{{/allParams}}  # @param [Hash] opts the optional parameters
-{{#allParams}}{{^required}}  # @option opts [{{dataType}}] :{{paramName}} {{description}}
-{{/required}}{{/allParams}}  # @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
-  def self.{{nickname}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
-    {{#allParams}}{{#required}}
-    # verify the required parameter '{{paramName}}' is set
-    raise "Missing the required parameter '{{paramName}}' when calling {{nickname}}" if {{{paramName}}}.nil?
-    {{/required}}{{/allParams}}
-
-    # resource path
-    path = "{{path}}".sub('{format}','json'){{#pathParams}}.sub('{' + '{{baseName}}' + '}', {{paramName}}.to_s){{/pathParams}}
-
-    # query parameters
-    query_params = {}{{#queryParams}}{{#required}}
-    query_params[:'{{{baseName}}}'] = {{{paramName}}}{{/required}}{{/queryParams}}{{#queryParams}}{{^required}}
-    query_params[:'{{{baseName}}}'] = opts[:'{{{paramName}}}'] if opts[:'{{{paramName}}}']{{/required}}{{/queryParams}}
-
-    # header parameters
-    header_params = {}
-
-    # HTTP header 'Accept' (if needed)
-    _header_accept = [{{#produces}}'{{mediaType}}'{{#hasMore}}, {{/hasMore}}{{/produces}}]
-    _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
-
-    # HTTP header 'Content-Type'
-    _header_content_type = [{{#consumes}}'{{mediaType}}'{{#hasMore}}, {{/hasMore}}{{/consumes}}]
-    header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type){{#headerParams}}{{#required}}
-    header_params[:'{{{baseName}}}'] = {{{paramName}}}{{/required}}{{/headerParams}}{{#headerParams}}{{^required}}
-    header_params[:'{{{baseName}}}'] = opts[:'{{{paramName}}}'] if opts[:'{{{paramName}}}']{{/required}}{{/headerParams}}
-
-    # form parameters
-    form_params = {}{{#formParams}}{{#required}}
-    form_params["{{baseName}}"] = {{paramName}}{{/required}}{{/formParams}}{{#formParams}}{{^required}}
-    form_params["{{baseName}}"] = opts[:'{{paramName}}'] if opts[:'{{paramName}}']{{/required}}{{/formParams}}
-
-    # http body (model)
-    {{^bodyParam}}post_body = nil
-    {{/bodyParam}}{{#bodyParam}}post_body = Swagger::Request.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}})
-    {{/bodyParam}}
-
-    {{#returnType}}response = Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
-    {{#returnContainer}}response.map {|response| {{/returnContainer}}obj = {{returnBaseType}}.new() and obj.build_from_hash(response){{#returnContainer}} }{{/returnContainer}}{{/returnType}}{{^returnType}}    Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make{{/returnType}}
+    # {{summary}}
+    # {{notes}}
+{{#allParams}}{{#required}}    # @param {{paramName}} {{description}}
+{{/required}}{{/allParams}}    # @param [Hash] opts the optional parameters
+{{#allParams}}{{^required}}    # @option opts [{{dataType}}] :{{paramName}} {{description}}
+{{/required}}{{/allParams}}    # @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
+    def self.{{nickname}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
+      {{#allParams}}{{#required}}
+      # verify the required parameter '{{paramName}}' is set
+      raise "Missing the required parameter '{{paramName}}' when calling {{nickname}}" if {{{paramName}}}.nil?
+      {{/required}}{{/allParams}}
+
+      # resource path
+      path = "{{path}}".sub('{format}','json'){{#pathParams}}.sub('{' + '{{baseName}}' + '}', {{paramName}}.to_s){{/pathParams}}
+
+      # query parameters
+      query_params = {}{{#queryParams}}{{#required}}
+      query_params[:'{{{baseName}}}'] = {{{paramName}}}{{/required}}{{/queryParams}}{{#queryParams}}{{^required}}
+      query_params[:'{{{baseName}}}'] = opts[:'{{{paramName}}}'] if opts[:'{{{paramName}}}']{{/required}}{{/queryParams}}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = [{{#produces}}'{{mediaType}}'{{#hasMore}}, {{/hasMore}}{{/produces}}]
+      _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = [{{#consumes}}'{{mediaType}}'{{#hasMore}}, {{/hasMore}}{{/consumes}}]
+      header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type){{#headerParams}}{{#required}}
+      header_params[:'{{{baseName}}}'] = {{{paramName}}}{{/required}}{{/headerParams}}{{#headerParams}}{{^required}}
+      header_params[:'{{{baseName}}}'] = opts[:'{{{paramName}}}'] if opts[:'{{{paramName}}}']{{/required}}{{/headerParams}}
+
+      # form parameters
+      form_params = {}{{#formParams}}{{#required}}
+      form_params["{{baseName}}"] = {{paramName}}{{/required}}{{/formParams}}{{#formParams}}{{^required}}
+      form_params["{{baseName}}"] = opts[:'{{paramName}}'] if opts[:'{{paramName}}']{{/required}}{{/formParams}}
+
+      # http body (model)
+      {{^bodyParam}}post_body = nil
+      {{/bodyParam}}{{#bodyParam}}post_body = Swagger::Request.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}})
+      {{/bodyParam}}
+
+      {{#returnType}}response = Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body}).make.body
+      {{#returnContainer}}response.map {|response| {{/returnContainer}}obj = {{returnBaseType}}.new() and obj.build_from_hash(response){{#returnContainer}} }{{/returnContainer}}{{/returnType}}{{^returnType}}      Swagger::Request.new(:{{httpMethod}}, path, {:params => query_params,:headers => header_params, :form_params => form_params, :body => post_body}).make{{/returnType}}
   end
 {{/operation}}
-end
+  end
 {{/operations}}
+end