fix(flatten): added option to skip automatic camel-case

* contributes go-swagger/go-swagger#2334

Signed-off-by: Frederic BIDON <[email protected]>

Author: fredbi

fixtures/bugs/2334/bar.yaml

@@ -0,0 +1,8 @@
+paths: {}
+
+definitions:
+   Bar:
+      type: object
+      properties:
+         Baz:
+            type: string

fixtures/bugs/2334/swagger.yaml

@@ -0,0 +1,12 @@
+swagger: '2.0'
+info:
+  title: Object
+  version: 0.1.0
+paths: 
+   /bar:
+     get:
+      responses:
+        200:
+          description: OK
+          schema:
+            $ref: "./bar.yaml#/definitions/Bar"

flatten.go

@@ -331,7 +331,7 @@ func importNewRef(entry sortref.RefRevIdx, refStr string, opts *FlattenOpts) err
 	}
 
 	// generate a unique name - isOAIGen means that a naming conflict was resolved by changing the name
-	newName, isOAIGen = uniqifyName(opts.Swagger().Definitions, nameFromRef(entry.Ref))
+	newName, isOAIGen = uniqifyName(opts.Swagger().Definitions, nameFromRef(entry.Ref, opts))
 	debugLog("new name for [%s]: %s - with name conflict:%t", strings.Join(entry.Keys, ", "), newName, isOAIGen)
 
 	opts.flattenContext.resolved[refStr] = newName

flatten_name.go

@@ -33,7 +33,8 @@ func (isn *InlineSchemaNamer) Name(key string, schema *spec.Schema, aschema *Ana
 		}
 
 		// create unique name
-		newName, isOAIGen := uniqifyName(isn.Spec.Definitions, swag.ToJSONName(name))
+		mangle := mangler(isn.opts)
+		newName, isOAIGen := uniqifyName(isn.Spec.Definitions, mangle(name))
 
 		// clone schema
 		sch := schutils.Clone(schema)
@@ -256,25 +257,35 @@ func partAdder(aschema *AnalyzedSchema) sortref.PartAdder {
 	}
 }
 
-func nameFromRef(ref spec.Ref) string {
+func mangler(o *FlattenOpts) func(string) string {
+	if o.KeepNames {
+		return func(in string) string { return in }
+	}
+
+	return swag.ToJSONName
+}
+
+func nameFromRef(ref spec.Ref, o *FlattenOpts) string {
+	mangle := mangler(o)
+
 	u := ref.GetURL()
 	if u.Fragment != "" {
-		return swag.ToJSONName(path.Base(u.Fragment))
+		return mangle(path.Base(u.Fragment))
 	}
 
 	if u.Path != "" {
 		bn := path.Base(u.Path)
 		if bn != "" && bn != "/" {
 			ext := path.Ext(bn)
 			if ext != "" {
-				return swag.ToJSONName(bn[:len(bn)-len(ext)])
+				return mangle(bn[:len(bn)-len(ext)])
 			}
 
-			return swag.ToJSONName(bn)
+			return mangle(bn)
 		}
 	}
 
-	return swag.ToJSONName(strings.ReplaceAll(u.Host, ".", " "))
+	return mangle(strings.ReplaceAll(u.Host, ".", " "))
 }
 
 // GenLocation indicates from which section of the specification (models or operations) a definition has been created.

flatten_name_test.go

@@ -28,7 +28,27 @@ func TestName_FromRef(t *testing.T) {
 	}
 
 	for _, v := range values {
-		assert.Equal(t, v.Expected, nameFromRef(spec.MustCreateRef(v.Source)))
+		assert.Equal(t, v.Expected, nameFromRef(spec.MustCreateRef(v.Source), &FlattenOpts{}))
+	}
+}
+
+func TestName_FromRefMangle(t *testing.T) {
+	t.Parallel()
+
+	values := []struct{ Source, Expected, ExpectedKeepName string }{
+		{"#/definitions/ErrorModel", "errorModel", "ErrorModel"},
+		{"#/definitions/Error_Model", "errorModel", "Error_Model"},
+		{"http://somewhere.com/definitions/errorModel", "errorModel", "errorModel"},
+		{"http://somewhere.com/definitions/ErrorModel.json", "errorModel", "ErrorModel"},
+		{"/definitions/ErrorModel", "errorModel", "ErrorModel"},
+		{"/definitions/ErrorModel.json", "errorModel", "ErrorModel"},
+		{"http://somewhere.com", "somewhereCom", "somewhere com"},
+		{"#", "", ""},
+	}
+
+	for _, v := range values {
+		assert.Equal(t, v.Expected, nameFromRef(spec.MustCreateRef(v.Source), &FlattenOpts{}))
+		assert.Equal(t, v.ExpectedKeepName, nameFromRef(spec.MustCreateRef(v.Source), &FlattenOpts{KeepNames: true}))
 	}
 }
 
@@ -47,7 +67,7 @@ func TestName_Definition(t *testing.T) {
 	}
 
 	for _, v := range values {
-		u, _ := uniqifyName(v.Definitions, nameFromRef(spec.MustCreateRef(v.Source)))
+		u, _ := uniqifyName(v.Definitions, nameFromRef(spec.MustCreateRef(v.Source), &FlattenOpts{}))
 		assert.Equal(t, v.Expected, u)
 	}
 }

flatten_options.go

@@ -26,6 +26,7 @@ type FlattenOpts struct {
 	Verbose         bool // enable some reporting on possible name conflicts detected
 	RemoveUnused    bool // When true, remove unused parameters, responses and definitions after expansion/flattening
 	ContinueOnError bool // Continue when spec expansion issues are found
+	KeepNames       bool // Do not attempt to jsonify names from references when flattening
 
 	/* Extra keys */
 	_ struct{} // require keys

flatten_test.go

@@ -1332,6 +1332,30 @@ func TestFlatten_2113(t *testing.T) {
 	require.JSONEq(t, string(expected), jazon)
 }
 
+func TestFlatten_2334(t *testing.T) {
+	// flatten $ref without altering case
+	log.SetOutput(io.Discard)
+	defer log.SetOutput(os.Stdout)
+
+	bp := filepath.Join("fixtures", "bugs", "2334", "swagger.yaml")
+	sp := antest.LoadOrFail(t, bp)
+	an := New(sp)
+
+	require.NoError(t, Flatten(FlattenOpts{
+		Spec: an, BasePath: bp, Verbose: false,
+		Expand:       false,
+		Minimal:      true,
+		RemoveUnused: true,
+		KeepNames:    true,
+	}))
+
+	jazon := antest.AsJSON(t, sp)
+
+	assert.Contains(t, jazon, `"$ref": "#/definitions/Bar"`)
+	assert.Contains(t, jazon, `"Bar":`)
+	assert.Contains(t, jazon, `"Baz":`)
+}
+
 func getDefinition(t testing.TB, sp *spec.Swagger, key string) string {
 	d, ok := sp.Definitions[key]
 	require.Truef(t, ok, "Expected definition for %s", key)