@alloy-js/go 0.3.0-dev.2 → 0.3.0

package/dist/dev/src/components/interface/interface.test.js

@@ -0,0 +1,853 @@
+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 { TypeDeclaration } from "../type/declaration.js";
+import { InterfaceDeclaration, InterfaceEmbed, InterfaceFunction, TypeConstraint } from "./declaration.js";
+function Wrapper(props) {
+  return _$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "TestInterface",
+        get children() {
+          return _$createComponent(InterfaceDeclaration, {
+            get children() {
+              return props.children;
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 19,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 18,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 17,
+    columnNumber: 5
+  });
+}
+it("declares interface with no members", () => {
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "test",
+        get children() {
+          return _$createComponent(InterfaceDeclaration, {}, {
+            fileName: import.meta.url,
+            lineNumber: 29,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 28,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 27,
+    columnNumber: 5
+  })).toRenderTo(`
+    package alloy
+
+    type test interface{}
+  `);
+});
+it("specify doc comment", () => {
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "test",
+        doc: "This is a test",
+        get children() {
+          return _$createComponent(InterfaceDeclaration, {}, {
+            fileName: import.meta.url,
+            lineNumber: 43,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 42,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 41,
+    columnNumber: 5
+  })).toRenderTo(`
+    package alloy
+
+    // This is a test
+    type test interface{}
+  `);
+});
+
+// describe("with type parameters", () => {
+//   it("reference parameters", () => {
+//     const typeParameters: TypeParameterProps[] = [
+//       {
+//         name: "T",
+//         refkey: refkey(),
+//       },
+//       {
+//         name: "U",
+//         refkey: refkey(),
+//       },
+//     ];
+//
+//     expect(
+//       <TestPackage>
+//         <TypeDeclaration name="Test">
+//           <InterfaceDeclaration public name="Test" typeParameters={typeParameters}>
+//             <List>
+//               <Property name="PropA" type={typeParameters[0].refkey} get set />
+//               <Property name="PropB" type={typeParameters[1].refkey} get set />
+//             </List>
+//           </InterfaceDeclaration>
+//         </TypeDeclaration>
+//       </TestPackage>,
+//     ).toRenderTo(`
+//       public struct Test<T, U>
+//       {
+//           T PropA { get; set; }
+//           U PropB { get; set; }
+//       }
+//     `);
+//   });
+//
+//   it("defines with constraints", () => {
+//     const typeParameters: TypeParameterProps[] = [
+//       {
+//         name: "T",
+//         constraints: "IFoo",
+//       },
+//       {
+//         name: "U",
+//         constraints: "IBar",
+//       },
+//     ];
+//
+//     expect(
+//       <TestPackage>
+//         <TypeDeclaration name="Test">
+//           <InterfaceDeclaration public name="Test" typeParameters={typeParameters}>
+//             // Body
+//           </InterfaceDeclaration>
+//         </TypeDeclaration>
+//       </TestPackage>,
+//     ).toRenderTo(`
+//       public struct Test<T, U>
+//           where T : IFoo
+//           where U : IBar
+//       {
+//           // Body
+//       }
+//     `);
+//   });
+// });
+
+it("defines fields", () => {
+  expect(_$createComponent(TestPackage, {
+    get children() {
+      return _$createComponent(TypeDeclaration, {
+        name: "TestInterface",
+        get children() {
+          return _$createComponent(InterfaceDeclaration, {
+            get children() {
+              return _$createComponent(List, {
+                get children() {
+                  return [_$createComponent(InterfaceFunction, {
+                    name: "FunctionOne",
+                    parameters: [{
+                      name: "hi",
+                      type: "string"
+                    }],
+                    returns: "string"
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 124,
+                    columnNumber: 13
+                  }), _$createComponent(InterfaceFunction, {
+                    name: "functionTwo",
+                    returns: "int"
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 129,
+                    columnNumber: 13
+                  })];
+                }
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 123,
+                columnNumber: 11
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 122,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 121,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 120,
+    columnNumber: 5
+  })).toRenderTo(`
+    package alloy
+
+    type TestInterface interface {
+      func FunctionOne(hi string) string
+      func functionTwo() int
+    }
+  `);
+});
+describe("naming", () => {
+  it("public field is PascalCase", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(List, {
+          get children() {
+            return _$createComponent(InterfaceFunction, {
+              name: "MemberOne",
+              returns: "string"
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 149,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 148,
+          columnNumber: 9
+        });
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 147,
+      columnNumber: 7
+    })).toRenderTo(`
+      package alloy
+
+      type TestInterface interface {
+        func MemberOne() string
+      }
+    `);
+  });
+  it("private field are camelCase", () => {
+    expect(_$createComponent(Wrapper, {
+      get children() {
+        return _$createComponent(List, {
+          get children() {
+            return _$createComponent(InterfaceFunction, {
+              name: "memberOne",
+              returns: "string"
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 165,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 164,
+          columnNumber: 9
+        });
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 163,
+      columnNumber: 7
+    })).toRenderTo(`
+    package alloy
+
+    type TestInterface interface {
+      func memberOne() string
+    }
+  `);
+  });
+});
+describe("embedded", () => {
+  it("embed using children", () => {
+    const TestInterfaceEmbed = refkey("TestInterfaceEmbed");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestInterface",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 186,
+                      columnNumber: 15
+                    });
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 185,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 184,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 183,
+          columnNumber: 9
+        }), _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 190,
+          columnNumber: 9
+        }), _$createComponent(TypeDeclaration, {
+          name: "TestInterface2",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(InterfaceEmbed, {
+                      refkey: TestInterfaceEmbed,
+                      children: "TestInterface"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 194,
+                      columnNumber: 15
+                    }), _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 197,
+                      columnNumber: 15
+                    })];
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 193,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 192,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 191,
+          columnNumber: 9
+        }), _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 201,
+          columnNumber: 9
+        }), TestInterfaceEmbed];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 182,
+      columnNumber: 7
+    })).toRenderTo(`
+      package alloy
+
+      type TestInterface interface {
+        func MemberOne() string
+      }
+      type TestInterface2 interface {
+        TestInterface
+        func MemberOne() string
+      }
+      TestInterface2.TestInterface
+    `);
+  });
+  it("embed using refkey", () => {
+    const TestInterface = refkey("TestInterface");
+    const TestInterfaceEmbed = refkey("TestInterfaceEmbed");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestInterface",
+          refkey: TestInterface,
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 227,
+                      columnNumber: 15
+                    });
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 226,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 225,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 224,
+          columnNumber: 9
+        }), _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 231,
+          columnNumber: 9
+        }), _$createComponent(TypeDeclaration, {
+          name: "TestInterface2",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(InterfaceEmbed, {
+                      refkey: TestInterfaceEmbed,
+                      children: TestInterface
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 235,
+                      columnNumber: 15
+                    }), _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 238,
+                      columnNumber: 15
+                    })];
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 234,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 233,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 232,
+          columnNumber: 9
+        }), _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 242,
+          columnNumber: 9
+        }), TestInterfaceEmbed];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 223,
+      columnNumber: 7
+    })).toRenderTo(`
+      package alloy
+
+      type TestInterface interface {
+        func MemberOne() string
+      }
+      type TestInterface2 interface {
+        TestInterface
+        func MemberOne() string
+      }
+      TestInterface2.TestInterface
+    `);
+  });
+  it("embed using cross-package refkey", () => {
+    const TestInterface = refkey("TestInterface");
+    const TestInterfaceEmbed = refkey("TestInterfaceEmbed");
+    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: "TestInterface",
+                          refkey: TestInterface,
+                          get children() {
+                            return _$createComponent(InterfaceDeclaration, {
+                              get children() {
+                                return _$createComponent(List, {
+                                  get children() {
+                                    return _$createComponent(InterfaceFunction, {
+                                      name: "MemberOne",
+                                      returns: "string"
+                                    }, {
+                                      fileName: import.meta.url,
+                                      lineNumber: 272,
+                                      columnNumber: 23
+                                    });
+                                  }
+                                }, {
+                                  fileName: import.meta.url,
+                                  lineNumber: 271,
+                                  columnNumber: 21
+                                });
+                              }
+                            }, {
+                              fileName: import.meta.url,
+                              lineNumber: 270,
+                              columnNumber: 19
+                            });
+                          }
+                        }, {
+                          fileName: import.meta.url,
+                          lineNumber: 269,
+                          columnNumber: 17
+                        });
+                      }
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 268,
+                      columnNumber: 15
+                    });
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 267,
+                  columnNumber: 13
+                }), _$createComponent(SourceFile, {
+                  path: "Test.go",
+                  get children() {
+                    return [_$createComponent(TypeDeclaration, {
+                      name: "TestInterface2",
+                      get children() {
+                        return _$createComponent(InterfaceDeclaration, {
+                          get children() {
+                            return _$createComponent(List, {
+                              get children() {
+                                return [_$createComponent(InterfaceEmbed, {
+                                  refkey: TestInterfaceEmbed,
+                                  children: TestInterface
+                                }, {
+                                  fileName: import.meta.url,
+                                  lineNumber: 282,
+                                  columnNumber: 21
+                                }), _$createComponent(InterfaceFunction, {
+                                  name: "MemberOne",
+                                  returns: "string"
+                                }, {
+                                  fileName: import.meta.url,
+                                  lineNumber: 285,
+                                  columnNumber: 21
+                                })];
+                              }
+                            }, {
+                              fileName: import.meta.url,
+                              lineNumber: 281,
+                              columnNumber: 19
+                            });
+                          }
+                        }, {
+                          fileName: import.meta.url,
+                          lineNumber: 280,
+                          columnNumber: 17
+                        });
+                      }
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 279,
+                      columnNumber: 15
+                    }), _$createIntrinsic("hbr", {}, {
+                      fileName: import.meta.url,
+                      lineNumber: 289,
+                      columnNumber: 15
+                    }), TestInterfaceEmbed];
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 278,
+                  columnNumber: 13
+                })];
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 266,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 265,
+          columnNumber: 9
+        });
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 264,
+      columnNumber: 7
+    }));
+    assertFileContents(res, {
+      "hello/types.go": `
+        package hello
+
+        type TestInterface interface {
+          func MemberOne() string
+        }
+      `,
+      "Test.go": `
+        package alloy
+
+        import "github.com/alloy-framework/alloy/hello"
+
+        type TestInterface2 interface {
+          hello.TestInterface
+          func MemberOne() string
+        }
+        TestInterface2.TestInterface
+      `
+    });
+  });
+});
+describe("constraints", () => {
+  it("test single constraint", () => {
+    const TestInterface = refkey("TestInterface");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestInterface",
+          refkey: TestInterface,
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 328,
+                      columnNumber: 15
+                    });
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 327,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 326,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 325,
+          columnNumber: 9
+        }), _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 332,
+          columnNumber: 9
+        }), _$createComponent(TypeDeclaration, {
+          name: "TestInterface2",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(TypeConstraint, {
+                      children: TestInterface
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 336,
+                      columnNumber: 15
+                    }), _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 337,
+                      columnNumber: 15
+                    })];
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 335,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 334,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 333,
+          columnNumber: 9
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 324,
+      columnNumber: 7
+    })).toRenderTo(`
+      package alloy
+
+      type TestInterface interface {
+        func MemberOne() string
+      }
+      type TestInterface2 interface {
+        TestInterface
+        func MemberOne() string
+      }
+    `);
+  });
+  it("test multiple constraint", () => {
+    const TestInterface = refkey("TestInterface");
+    expect(_$createComponent(TestPackage, {
+      get children() {
+        return [_$createComponent(TypeDeclaration, {
+          name: "TestInterface",
+          refkey: TestInterface,
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 362,
+                      columnNumber: 15
+                    });
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 361,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 360,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 359,
+          columnNumber: 9
+        }), _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 366,
+          columnNumber: 9
+        }), _$createComponent(TypeDeclaration, {
+          name: "TestInterface2",
+          get children() {
+            return _$createComponent(InterfaceDeclaration, {
+              get children() {
+                return _$createComponent(List, {
+                  get children() {
+                    return [_$createComponent(TypeConstraint, {
+                      children: TestInterface
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 370,
+                      columnNumber: 15
+                    }), _$createComponent(TypeConstraint, {
+                      constraints: [TestInterface, "string", "~int"]
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 371,
+                      columnNumber: 15
+                    }), _$createComponent(InterfaceFunction, {
+                      name: "MemberOne",
+                      returns: "string"
+                    }, {
+                      fileName: import.meta.url,
+                      lineNumber: 372,
+                      columnNumber: 15
+                    })];
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 369,
+                  columnNumber: 13
+                });
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 368,
+              columnNumber: 11
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 367,
+          columnNumber: 9
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 358,
+      columnNumber: 7
+    })).toRenderTo(`
+      package alloy
+
+      type TestInterface interface {
+        func MemberOne() string
+      }
+      type TestInterface2 interface {
+        TestInterface
+        TestInterface | string | ~int
+        func MemberOne() string
+      }
+    `);
+  });
+});
+//# sourceMappingURL=interface.test.js.map