[Ruby] Incorrect MinLength and MaxLength on partial_model_generic.mustache template

[littlechu]

Description

Notice that when I generate from yml/json that contain properties maxLength but without maxLength, the ruby code generated is incorrect

If you look at the mustache file, you will see there are multi places that's look like this:

     {{#minLength}}
      if @{{{name}}}.to_s.length > {{{maxLength}}}
        invalid_properties.push("invalid value for '{{{name}}}', the character length must be smaller than or equal to {{{maxLength}}}.")
      end

      {{/minLength}}

This is most likely copy/paste error

Swagger-codegen version

Swagger 2.2.0

Swagger declaration file content or url

By adding maxLength to Pet Name properties in petstore-minimal.yaml

---
  swagger: "2.0"
  info:
    version: "1.0.0"
    title: "Swagger Petstore"
    description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
    termsOfService: "http://swagger.io/terms/"
    contact:
      name: "Swagger API Team"
    license:
      name: "MIT"
  host: "petstore.swagger.io"
  basePath: "/api"
  schemes:
    - "http"
  consumes:
    - "application/json"
  produces:
    - "application/json"
  paths:
    /pets:
      get:
        description: "Returns all pets from the system that the user has access to"
        produces:
          - "application/json"
        responses:
          "200":
            description: "A list of pets."
            schema:
              type: "array"
              items:
                $ref: "#/definitions/Pet"
  definitions:
    Pet:
      type: "object"
      required:
        - "id"
        - "name"
      properties:
        id:
          type: "integer"
          format: "int64"
        name:
          type: "string"
          maxLength: 999
        tag:
          type: "string"

Command line used for generation

java -jar swagger-codegen-cli.jar generate -i petstore-minimal.yaml -o ruby -l ruby

Steps to reproduce

Run IRB like the following and require the swagger_client library

irb -I ruby/lib
require 'swagger_client'
you will run into library error at this point

Related issues

Suggest a Fix

fix all the incorrect minLength and MaxLength in the mustache template

[wing328]

@littlechu thanks for reporting the issue, which should be fixed by #3400. Please pull the latest to give it a try.

[littlechu]

You miss some of the maxLength and minLength

def valid?
     ....
      {{#minLength}}
      return false if @{{{name}}}.to_s.length > {{{maxLength}}}
      {{/minLength}}
      {{#maxLength}}
      return false if @{{{name}}}.to_s.length < {{{minLength}}}
      {{/maxLength}}
....
def {{{name}}}=({{{name}}})
....
   {{#minLength}}
      if {{{name}}}.to_s.length > {{{maxLength}}}
        fail ArgumentError, "invalid value for '{{{name}}}', the character length must be smaller than or equal to {{{maxLength}}}."
      end

      {{/minLength}}
      {{#maxLength}}
      if {{{name}}}.to_s.length < {{{minLength}}}
        fail ArgumentError, "invalid value for '{{{name}}}', the character length must be great than or equal to {{{minLength}}}."
      end

      {{/maxLength}}

Also, I think I find another issue on the way we use Regex in the code, since String Pattern in swagger don't start with //, the code we generate should actually warp around it like this

Regexp.new(/{{{pattern}}}}/)

otherwise, some of the more complicated pattern like the following will fail the ruby syntax

pattern: "(^[-A-Za-z0-9_:,.@!]+[-A-Za-z0-9_:,.@! ]*[-A-Za-z0-9_:,.@!]+$)|(^[-A-Za-z0-9_:,.@!]+$)"

[littlechu]

I try to fix both issue and this is the diff I get:

diff --git a/modules/swagger-codegen/src/main/resources/ruby/api.mustache b/modules/swagger-codegen/src/main/resources/ruby/api.mustache
index 53e4556..0605f66 100644
--- a/modules/swagger-codegen/src/main/resources/ruby/api.mustache
+++ b/modules/swagger-codegen/src/main/resources/ruby/api.mustache
@@ -81,7 +81,7 @@ module {{moduleName}}

       {{/minimum}}
       {{#pattern}}
-      if {{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} !~ Regexp.new({{{pattern}}})
+      if {{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} !~ Regexp.new(/{{{pattern}}}/)
         fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, must conform to the pattern {{{pattern}}}.'
       end

diff --git a/modules/swagger-codegen/src/main/resources/ruby/partial_model_generic.mustache b/modules/swagger-codegen/src/main/resources/ruby/partial_model_generic.mustache
index 690b153..135f544 100644
--- a/modules/swagger-codegen/src/main/resources/ruby/partial_model_generic.mustache
+++ b/modules/swagger-codegen/src/main/resources/ruby/partial_model_generic.mustache
@@ -107,7 +107,7 @@

       {{/minimum}}
       {{#pattern}}
-      if @{{{name}}} !~ Regexp.new({{{pattern}}})
+      if @{{{name}}} !~ Regexp.new(/{{{pattern}}}/)
         invalid_properties.push("invalid value for '{{{name}}}', must conform to the pattern {{{pattern}}}.")
       end

@@ -130,12 +130,12 @@
       {{/isContainer}}
       {{/isEnum}}
       {{#hasValidation}}
-      {{#minLength}}
-      return false if @{{{name}}}.to_s.length > {{{maxLength}}}
-      {{/minLength}}
       {{#maxLength}}
-      return false if @{{{name}}}.to_s.length < {{{minLength}}}
+      return false if @{{{name}}}.to_s.length > {{{maxLength}}}
       {{/maxLength}}
+      {{#minLength}}
+      return false if @{{{name}}}.to_s.length < {{{minLength}}}
+      {{/minLength}}
       {{#maximum}}
       return false if @{{{name}}} > {{{maximum}}}
       {{/maximum}}
@@ -143,7 +143,7 @@
       return false if @{{{name}}} < {{{minimum}}}
       {{/minimum}}
       {{#pattern}}
-      return false if @{{{name}}} !~ Regexp.new({{{pattern}}})
+      return false if @{{{name}}} !~ Regexp.new(/{{{pattern}}}/)
       {{/pattern}}
       {{/hasValidation}}
       {{/vars}}
@@ -174,18 +174,18 @@
         fail ArgumentError, "{{{name}}} cannot be nil"
       end

-      {{#minLength}}
+      {{#maxLength}}
       if {{{name}}}.to_s.length > {{{maxLength}}}
         fail ArgumentError, "invalid value for '{{{name}}}', the character length must be smaller than or equal to {{{maxLength}}}."
       end

-      {{/minLength}}
-      {{#maxLength}}
+      {{/maxLength}}
+      {{#minLength}}
       if {{{name}}}.to_s.length < {{{minLength}}}
         fail ArgumentError, "invalid value for '{{{name}}}', the character length must be great than or equal to {{{minLength}}}."
       end

-      {{/maxLength}}
+      {{/minLength}}
       {{#maximum}}
       if {{{name}}} > {{{maximum}}}
         fail ArgumentError, "invalid value for '{{{name}}}', must be smaller than or equal to {{{maximum}}}."
@@ -199,7 +199,7 @@

       {{/minimum}}
       {{#pattern}}
-      if @{{{name}}} !~ Regexp.new({{{pattern}}})
+      if @{{{name}}} !~ Regexp.new(/{{{pattern}}}/)
         fail ArgumentError, "invalid value for '{{{name}}}', must conform to the pattern {{{pattern}}}."
       end

[wing328]

Please kindly submit a PR so that we can review the fix more easily. (remember to run ./bin/ruby-petstore.sh to update the Ruby Petstore sample)

[littlechu]

post PR #3415

[wing328]

@littlechu thanks for the PR (#3415), which has been merged into master.

[wing328]

@littlechu for the regular expression issue, I didn't get any compilation/syntax error with the test below:

2.1.1 :006 > a
 => "(^[-A-Za-z0-9_:,.@!]+[-A-Za-z0-9_:,.@! ]*[-A-Za-z0-9_:,.@!]+$)|(^[-A-Za-z0-9_:,.@!]+$)" 
2.1.1 :007 > Regexp.new(a)
 => /(^[-A-Za-z0-9_:,.@!]+[-A-Za-z0-9_:,.@! ]*[-A-Za-z0-9_:,.@!]+$)|(^[-A-Za-z0-9_:,.@!]+$)/ 

Maybe I'm not using the pattern that causes the issue.