@alloy-js/go 0.0.1

package/dist/src/components/struct/struct.test.js

@@ -0,0 +1,741 @@
+import { createComponent as _$createComponent, createIntrinsic as _$createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { List, Output, refkey, render } from "@alloy-js/core";
+import { describe, expect, it } from "vitest";
+import { assertFileContents, TestPackage } from "../../../test/utils.js";
+import { ModuleDirectory } from "../ModuleDirectory.js";
+import { SourceDirectory } from "../SourceDirectory.js";
+import { SourceFile } from "../SourceFile.js";
+import { TypeConstraint } from "../interface/declaration.js";
+import { Pointer } from "../pointer/pointer.js";
+import { TypeDeclaration } from "../type/declaration.js";
+import { StructDeclaration, StructEmbed, StructMember } from "./declaration.js";
+function Wrapper(props) {
+  return _$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "TestStruct",
+        get children() {
+          return _$createComponent(StructDeclaration, {
+            get children() {
+              return props.children;
+            }
+          });
+        }
+      });
+    }
+  });
+}
+it("declares struct with no members", () => {
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "test",
+        get children() {
+          return _$createComponent(StructDeclaration, {});
+        }
+      });
+    }
+  })).toRenderTo(`
+    package alloy
+
+    type test struct{}
+  `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "test",
+        doc: "This is a test",
+        get children() {
+          return _$createComponent(StructDeclaration, {});
+        }
+      });
+    }
+  })).toRenderTo(`
+    package alloy
+
+    // This is a test
+    type test struct{}
+  `);
+});
+it("defines fields", () => {
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "TestStruct",
+        get children() {
+          return _$createComponent(StructDeclaration, {
+            get children() {
+              return _$createComponent(List, {
+                get children() {
+                  return [_$createComponent(StructMember, {
+                    name: "MemberOne",
+                    type: "string"
+                  }), _$createComponent(StructMember, {
+                    name: "memberTwo",
+                    type: "int"
+                  })];
+                }
+              });
+            }
+          });
+        }
+      });
+    }
+  })).toRenderTo(`
+    package alloy
+
+    type TestStruct struct {
+      MemberOne string
+      memberTwo int
+    }
+  `);
+});
+it("nested struct", () => {
+  const Member1 = refkey("Member1");
+  const Member2 = refkey("Member2");
+  const Member3 = refkey("Member3");
+  const Member4 = refkey("Member4");
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return [_$createComponent(TypeDeclaration, {
+        name: "TestStruct",
+        get children() {
+          return _$createComponent(StructDeclaration, {
+            get children() {
+              return _$createComponent(List, {
+                get children() {
+                  return [_$createComponent(StructMember, {
+                    name: "MemberOne",
+                    type: "string",
+                    refkey: Member1
+                  }), _$createComponent(StructMember, {
+                    name: "MemberTwo",
+                    refkey: Member2,
+                    get type() {
+                      return _$createComponent(StructDeclaration, {
+                        get children() {
+                          return _$createComponent(List, {
+                            get children() {
+                              return [_$createComponent(StructMember, {
+                                name: "MemberOne",
+                                type: "string",
+                                refkey: Member3
+                              }), _$createComponent(StructMember, {
+                                name: "NestedMemberTwo",
+                                type: "int",
+                                refkey: Member4
+                              })];
+                            }
+                          });
+                        }
+                      });
+                    }
+                  })];
+                }
+              });
+            }
+          });
+        }
+      }), _$createIntrinsic("hbr", {}), Member1, _$createIntrinsic("hbr", {}), Member2, _$createIntrinsic("hbr", {}), Member3, _$createIntrinsic("hbr", {}), Member4];
+    }
+  })).toRenderTo(`
+    package alloy
+
+    type TestStruct struct {
+      MemberOne string
+      MemberTwo struct {
+        MemberOne string
+        NestedMemberTwo int
+      }
+    }
+    TestStruct.MemberOne
+    TestStruct.MemberTwo
+    TestStruct.MemberTwo.MemberOne
+    TestStruct.MemberTwo.NestedMemberTwo
+  `);
+});
+it("declares multiple fields", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(List, {
+        get children() {
+          return [_$createComponent(StructMember, {
+            name: "MemberOne",
+            type: "string"
+          }), _$createComponent(StructMember, {
+            name: "MemberTwo",
+            type: "int"
+          })];
+        }
+      });
+    }
+  })).toRenderTo(`
+    package alloy
+
+    type TestStruct struct {
+      MemberOne string
+      MemberTwo int
+    }
+  `);
+});
+it("declares multiple fields with tags", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(List, {
+        get children() {
+          return [_$createComponent(StructMember, {
+            name: "MemberOne",
+            type: "string",
+            tag: "this is arbitrary tag #1"
+          }), _$createComponent(StructMember, {
+            name: "MemberTwo",
+            type: "int",
+            tag: "this is arbitrary tag #2"
+          })];
+        }
+      });
+    }
+  })).toRenderTo(`
+    package alloy
+
+    type TestStruct struct {
+      MemberOne string "this is arbitrary tag #1"
+      MemberTwo int "this is arbitrary tag #2"
+    }
+  `);
+});
+it("declares multiple fields with tag object", () => {
+  expect(_$createComponent(Wrapper, {
+    get children() {
+      return _$createComponent(List, {
+        get children() {
+          return [_$createComponent(StructMember, {
+            name: "MemberOne",
+            type: "string",
+            tag: {
+              json: "member_one,omit_empty"
+            }
+          }), _$createComponent(StructMember, {
+            name: "MemberTwo",
+            type: "int",
+            tag: {
+              xml: "member_two,omit_empty",
+              yaml: "memberTwo"
+            }
+          })];
+        }
+      });
+    }
+  })).toRenderTo(`
+    package alloy
+
+    type TestStruct struct {
+      MemberOne string \`json:"member_one,omit_empty"\`
+      MemberTwo int \`xml:"member_two,omit_empty" yaml:"memberTwo"\`
+    }
+  `);
+});
+describe("naming", () => {
+  it("public field is PascalCase", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(List, {
+          get children() {
+            return _$createComponent(StructMember, {
+              name: "MemberOne",
+              type: "string"
+            });
+          }
+        });
+      }
+    })).toRenderTo(`
+      package alloy
+
+      type TestStruct struct {
+        MemberOne string
+      }
+    `);
+  });
+  it("private field are camelCase", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(List, {
+          get children() {
+            return _$createComponent(StructMember, {
+              name: "memberOne",
+              type: "string"
+            });
+          }
+        });
+      }
+    })).toRenderTo(`
+    package alloy
+
+    type TestStruct struct {
+      memberOne string
+    }
+  `);
+  });
+});
+describe("embedded", () => {
+  it("embed using children", () => {
+    const TestStructEmbed = refkey("TestStructEmbed");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestStruct",
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: "string"
+                    });
+                  }
+                });
+              }
+            });
+          }
+        }), _$createIntrinsic("hbr", {}), _$createComponent(TypeDeclaration, {
+          name: "TestStruct2",
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(StructEmbed, {
+                      refkey: TestStructEmbed,
+                      children: "TestStruct"
+                    }), _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: "string"
+                    })];
+                  }
+                });
+              }
+            });
+          }
+        }), _$createIntrinsic("hbr", {}), TestStructEmbed];
+      }
+    })).toRenderTo(`
+      package alloy
+
+      type TestStruct struct {
+        MemberOne string
+      }
+      type TestStruct2 struct {
+        TestStruct
+        MemberOne string
+      }
+      TestStruct2.TestStruct
+    `);
+  });
+  it("embed using refkey", () => {
+    const TestStruct = refkey("TestStruct");
+    const TestStructEmbed = refkey("TestStructEmbed");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestStruct",
+          refkey: TestStruct,
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: "string"
+                    });
+                  }
+                });
+              }
+            });
+          }
+        }), _$createIntrinsic("hbr", {}), _$createComponent(TypeDeclaration, {
+          name: "TestStruct2",
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(StructEmbed, {
+                      refkey: TestStructEmbed,
+                      children: TestStruct
+                    }), _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: "string"
+                    })];
+                  }
+                });
+              }
+            });
+          }
+        }), _$createIntrinsic("hbr", {}), TestStructEmbed];
+      }
+    })).toRenderTo(`
+      package alloy
+
+      type TestStruct struct {
+        MemberOne string
+      }
+      type TestStruct2 struct {
+        TestStruct
+        MemberOne string
+      }
+      TestStruct2.TestStruct
+    `);
+  });
+  it("embed using cross-package refkey", () => {
+    const TestStruct = refkey("TestStruct");
+    const TestStructEmbed = refkey("TestStructEmbed");
+    const res = render(_$createComponent(Output, {
+      get children() {
+        return _$createComponent(ModuleDirectory, {
+          name: "github.com/alloy-framework/alloy",
+          get children() {
+            return _$createComponent(SourceDirectory, {
+              path: ".",
+              get children() {
+                return [_$createComponent(SourceDirectory, {
+                  path: "hello",
+                  get children() {
+                    return _$createComponent(SourceFile, {
+                      path: "types.go",
+                      get children() {
+                        return _$createComponent(TypeDeclaration, {
+                          name: "TestStruct",
+                          refkey: TestStruct,
+                          get children() {
+                            return _$createComponent(StructDeclaration, {
+                              get children() {
+                                return _$createComponent(List, {
+                                  get children() {
+                                    return _$createComponent(StructMember, {
+                                      name: "MemberOne",
+                                      type: "string"
+                                    });
+                                  }
+                                });
+                              }
+                            });
+                          }
+                        });
+                      }
+                    });
+                  }
+                }), _$createComponent(SourceFile, {
+                  path: "Test.go",
+                  get children() {
+                    return [_$createComponent(TypeDeclaration, {
+                      name: "TestStruct2",
+                      get children() {
+                        return _$createComponent(StructDeclaration, {
+                          get children() {
+                            return _$createComponent(List, {
+                              get children() {
+                                return [_$createComponent(StructEmbed, {
+                                  refkey: TestStructEmbed,
+                                  children: TestStruct
+                                }), _$createComponent(StructMember, {
+                                  name: "MemberOne",
+                                  type: "string"
+                                })];
+                              }
+                            });
+                          }
+                        });
+                      }
+                    }), _$createIntrinsic("hbr", {}), TestStructEmbed];
+                  }
+                })];
+              }
+            });
+          }
+        });
+      }
+    }));
+    assertFileContents(res, {
+      "hello/types.go": `
+        package hello
+
+        type TestStruct struct {
+          MemberOne string
+        }
+      `,
+      "Test.go": `
+        package alloy
+
+        import "github.com/alloy-framework/alloy/hello"
+
+        type TestStruct2 struct {
+          hello.TestStruct
+          MemberOne string
+        }
+        TestStruct2.TestStruct
+      `
+    });
+  });
+  it("embed using cross-package refkey pointer", () => {
+    const TestStruct = refkey("TestStruct");
+    const TestStructEmbed = refkey("TestStructEmbed");
+    const res = render(_$createComponent(Output, {
+      get children() {
+        return _$createComponent(ModuleDirectory, {
+          name: "github.com/alloy-framework/alloy",
+          get children() {
+            return _$createComponent(SourceDirectory, {
+              path: ".",
+              get children() {
+                return [_$createComponent(SourceDirectory, {
+                  path: "hello",
+                  get children() {
+                    return _$createComponent(SourceFile, {
+                      path: "types.go",
+                      get children() {
+                        return _$createComponent(TypeDeclaration, {
+                          name: "TestStruct",
+                          refkey: TestStruct,
+                          get children() {
+                            return _$createComponent(StructDeclaration, {
+                              get children() {
+                                return _$createComponent(List, {
+                                  get children() {
+                                    return _$createComponent(StructMember, {
+                                      name: "MemberOne",
+                                      type: "string"
+                                    });
+                                  }
+                                });
+                              }
+                            });
+                          }
+                        });
+                      }
+                    });
+                  }
+                }), _$createComponent(SourceFile, {
+                  path: "Test.go",
+                  get children() {
+                    return [_$createComponent(TypeDeclaration, {
+                      name: "TestStruct2",
+                      get children() {
+                        return _$createComponent(StructDeclaration, {
+                          get children() {
+                            return _$createComponent(List, {
+                              get children() {
+                                return [_$createComponent(StructEmbed, {
+                                  refkey: TestStructEmbed,
+                                  get children() {
+                                    return _$createComponent(Pointer, {
+                                      children: TestStruct
+                                    });
+                                  }
+                                }), _$createComponent(StructMember, {
+                                  name: "MemberOne",
+                                  type: "string"
+                                })];
+                              }
+                            });
+                          }
+                        });
+                      }
+                    }), _$createIntrinsic("hbr", {}), TestStructEmbed];
+                  }
+                })];
+              }
+            });
+          }
+        });
+      }
+    }));
+    assertFileContents(res, {
+      "hello/types.go": `
+        package hello
+
+        type TestStruct struct {
+          MemberOne string
+        }
+      `,
+      "Test.go": `
+        package alloy
+
+        import "github.com/alloy-framework/alloy/hello"
+
+        type TestStruct2 struct {
+          *hello.TestStruct
+          MemberOne string
+        }
+        TestStruct2.TestStruct
+      `
+    });
+  });
+});
+describe("type parameters", () => {
+  it("single type parameter", () => {
+    const T = refkey("T");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return _$createComponent(TypeDeclaration, {
+          name: "TestStruct",
+          typeParameters: [{
+            name: "T",
+            constraint: "any",
+            refkey: T
+          }],
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: T
+                    });
+                  }
+                });
+              }
+            });
+          }
+        });
+      }
+    })).toRenderTo(`
+      package alloy
+
+      type TestStruct[T any] struct {
+        MemberOne T
+      }
+    `);
+  });
+  it("multiple type parameters", () => {
+    const TestStructType = refkey("TestStructType");
+    const U = refkey("U");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestStructType",
+          refkey: TestStructType,
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: "string"
+                    });
+                  }
+                });
+              }
+            });
+          }
+        }), _$createIntrinsic("hbr", {}), _$createComponent(TypeDeclaration, {
+          name: "TestStruct",
+          get typeParameters() {
+            return [{
+              name: "T",
+              constraint: _$createComponent(TypeConstraint, {
+                constraints: ["string", "int"]
+              })
+            }, {
+              name: "U",
+              constraint: TestStructType,
+              refkey: U
+            }];
+          },
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: U
+                    });
+                  }
+                });
+              }
+            });
+          }
+        })];
+      }
+    })).toRenderTo(`
+    package alloy
+
+    type TestStructType struct {
+      MemberOne string
+    }
+    type TestStruct[T string | int, U TestStructType] struct {
+      MemberOne U
+    }
+  `);
+  });
+  it("type parameter overflow", () => {
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return _$createComponent(TypeDeclaration, {
+          name: "TestStruct",
+          get typeParameters() {
+            return [{
+              name: "T",
+              constraint: _$createComponent(TypeConstraint, {
+                constraints: ["string", "int"]
+              })
+            }, {
+              name: "T",
+              constraint: _$createComponent(TypeConstraint, {
+                constraints: ["string", "int"]
+              })
+            }, {
+              name: "T",
+              constraint: _$createComponent(TypeConstraint, {
+                constraints: ["string", "int"]
+              })
+            }, {
+              name: "T",
+              constraint: _$createComponent(TypeConstraint, {
+                constraints: ["string", "int"]
+              })
+            }, {
+              name: "T",
+              constraint: _$createComponent(TypeConstraint, {
+                constraints: ["string", "int"]
+              })
+            }];
+          },
+          get children() {
+            return _$createComponent(StructDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(StructMember, {
+                      name: "MemberOne",
+                      type: "string"
+                    });
+                  }
+                });
+              }
+            });
+          }
+        });
+      }
+    })).toRenderTo(`
+    package alloy
+
+    type TestStruct[
+      T string | int,
+      T_2 string | int,
+      T_3 string | int,
+      T_4 string | int,
+      T_5 string | int,
+    ] struct {
+      MemberOne string
+    }
+  `);
+  });
+});
+//# sourceMappingURL=struct.test.js.map