swagger-api/swagger-codegen

[Ruby, PHP] Errors with slashes in pattern

Open

#3,703 opened on Sep 1, 2016

View on GitHub
 (8 comments) (2 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: PHPClient: RubyIssue: Bughelp wanted

Description

Description

For this in YAML syntax:

pattern: '^a/b$'

...the PHP code generated is:

if (!preg_match("/^a/b$/", ...

...and for Ruby:

Regexp.new(/^a/b$/)

The problem with both is that the slash between a and b should be backslash escaped to avoid errors. I tried this in DefaultCodegen.addRegularExpressionDelimiter:

return "/" + pattern.replace("/", "\\/") + "/";

...but it makes no difference on the eventual output.

Swagger-codegen version

Current master

Contributor guide

Tech stack
javaphpruby
Domain
backendapitooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Java knowledgeUnderstanding of regular expressionsFamiliarity with swagger codegen codebaseKnowledge of PHP and Ruby string escaping
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate the `DefaultCodegen.addRegularExpressionDelimiter` method to understand why the simple `pattern.replace` did not work. Look at how the pattern is passed to templates (e.g., mustache templates) and whether escaping occurs after the method. Check existing PRs or comments for any progress. Examine `DefaultCodegen.java` and related test files to verify if the issue persists in the current version.