org.openapitools.codegen.languages

Class RubyOnRailsServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractRubyCodegen

org.openapitools.codegen.languages.RubyOnRailsServerCodegen

All Implemented Interfaces:

CodegenConfig

public class RubyOnRailsServerCodegen
extends AbstractRubyCodegen

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appFolder
protected String	applicationCableFolder
protected String	binFolder
protected String	cacheFolder
protected String	channelsFolder
protected String	configFolder
protected String	controllersFolder
protected String	databaseAdapter
protected String	dbFolder
protected String	environmentsFolder
protected String	gemName
protected String	gemVersion
protected String	initializersFolder
protected String	jobsFolder
protected String	layoutsFolder
protected String	libFolder
protected String	localesFolder
protected String	logFolder
protected String	mailersFolder
protected String	migrateFolder
protected String	modelsFolder
protected String	moduleName
protected String	pidFolder
protected String	publicFolder
protected String	socketsFolder
protected String	tasksFolder
protected String	testFolder
protected String	tmpFolder
protected String	vendorFolder
protected String	viewsFolder

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, serverVariables, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

Constructor Summary

Constructors

Constructor and Description
RubyOnRailsServerCodegen()

Method Summary

Modifier and Type	Method and Description
String	apiFileFolder()
String	getHelp()
String	getName()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p) returns the OpenAPI type for the property.
CodegenType	getTag()
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
void	setDatabaseAdapter(String databaseAdapter)
String	toApiFilename(String name) Return the file name of the Api Test
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiVarName(String name) Return the variable name in the Api
String	toModelFilename(String name) Return the capitalized file name of the model
String	toModelName(String name) Output the proper model name (capitalized).

Methods inherited from class org.openapitools.codegen.languages.AbstractRubyCodegen

escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, getTypeDeclaration, postProcessFile, toDefaultValue, toOperationId, toParamName, toRegularExpression, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addMustacheLambdas, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getAllowUnicodeIdentifiers, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getEnsureUniqueParams, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getModelNamePrefix, getModelNameSuffix, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getSchemaItems, getSortParamsByRequiredFlag, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, serverVariableOverrides, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiImport, toApiTestFilename, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toExampleValue, toGetter, toInstantiationType, toModelDocFilename, toModelImport, toModelTestFilename, toOneOfName, toSetter, typeMapping, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateOption, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getTemplatingEngine, getTypeDeclaration, importMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModels, postProcessOperationsWithModels, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toApiTestFilename, toBooleanGetter, toGetter, toModelDocFilename, toModelImport, toModelTestFilename, toSetter, typeMapping, updateAllModels, vendorExtensions

Field Detail

gemName

protected String gemName

moduleName

protected String moduleName

gemVersion

protected String gemVersion

appFolder

protected String appFolder

channelsFolder

protected String channelsFolder

applicationCableFolder

protected String applicationCableFolder

controllersFolder

protected String controllersFolder

jobsFolder

protected String jobsFolder

mailersFolder

protected String mailersFolder

modelsFolder

protected String modelsFolder

viewsFolder

protected String viewsFolder

layoutsFolder

protected String layoutsFolder

binFolder

protected String binFolder

configFolder

protected String configFolder

environmentsFolder

protected String environmentsFolder

initializersFolder

protected String initializersFolder

localesFolder

protected String localesFolder

dbFolder

protected String dbFolder

migrateFolder

protected String migrateFolder

libFolder

protected String libFolder

tasksFolder

protected String tasksFolder

logFolder

protected String logFolder

publicFolder

protected String publicFolder

testFolder

protected String testFolder

tmpFolder

protected String tmpFolder

cacheFolder

protected String cacheFolder

pidFolder

protected String pidFolder

socketsFolder

protected String socketsFolder

vendorFolder

protected String vendorFolder

databaseAdapter

protected String databaseAdapter

Constructor Detail

RubyOnRailsServerCodegen

public RubyOnRailsServerCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractRubyCodegen

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type

Overrides:

getSchemaType in class DefaultCodegen

Parameters:

p - property schema

Returns:

string presentation of the type

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class DefaultCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class DefaultCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegen

Return the file name of the Api Test

Specified by:

toApiFilename in interface CodegenConfig

Overrides:

toApiFilename in class DefaultCodegen

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiVarName

public String toApiVarName(String name)

Description copied from class: DefaultCodegen

Return the variable name in the Api

Specified by:

toApiVarName in interface CodegenConfig

Overrides:

toApiVarName in class DefaultCodegen

Parameters:

name - the varible name of the Api

Returns:

the snake-cased variable name

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen

setDatabaseAdapter

public void setDatabaseAdapter(String databaseAdapter)