-
Notifications
You must be signed in to change notification settings - Fork 0
/
strict-object.test.ts
182 lines (162 loc) · 5.08 KB
/
strict-object.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
import strictObject from "./strict-object";
type TestData = {
one: number;
two: string;
three: {
a: string;
b: string;
};
nested: TestData;
};
describe("strictObject", () => {
describe("the basics", () => {
let data: TestData;
beforeEach(() => {
data = strictObject<TestData>({
one: 1,
two: "TWO",
nested: undefined,
});
});
it("should allow access to existing properties", () => {
expect(data.one).toEqual(1);
expect(data.two).toEqual("TWO");
expect(data.nested).toEqual(undefined);
});
it("should allow setting existing properties", () => {
data.one = 111;
expect(data.one).toEqual(111);
data.two = "t-w-o";
expect(data.two).toEqual("t-w-o");
});
it("should not allow getting non-defined properties", () => {
expect(() => data.three).toThrowErrorMatchingInlineSnapshot(
`"strictObject.three is not defined"`
);
});
it("should allow setting of non-defined properties", () => {
data.three = { a: "A", b: "B" };
expect(data.three.a).toEqual("A");
expect(data.three.b).toEqual("B");
});
it("'in' operator should still work", () => {
expect("one" in data).toBeTruthy();
expect("three" in data).toBeFalsy();
expect("nested" in data).toBeTruthy();
});
});
describe("name", () => {
it("errors should show helpful names", () => {
const data = strictObject<TestData>(
{
nested: {
three: {},
},
},
"data"
);
expect(() => data.one).toThrowErrorMatchingInlineSnapshot(
`"data.one is not defined"`
);
expect(() => data.nested.one).toThrowErrorMatchingInlineSnapshot(
`"data.nested.one is not defined"`
);
expect(() => data.nested.three.a).toThrowErrorMatchingInlineSnapshot(
`"data.nested.three.a is not defined"`
);
});
});
describe("nested behavior", () => {
let data: TestData;
beforeEach(() => {
data = strictObject<TestData>({
one: 1,
two: "TWO",
nested: { one: 111, two: "222" },
});
});
it("should be able to get nested properties", () => {
expect(data.nested.one).toEqual(111);
expect(data.nested.two).toEqual("222");
});
it("should be able to set nested properties", () => {
data.nested.one = 111111;
expect(data.nested.one).toEqual(111111);
});
it("should throw an error when a nested object is missing a property", () => {
expect(() => data.nested.three).toThrowErrorMatchingInlineSnapshot(
`"strictObject.nested.three is not defined"`
);
});
it("should be able to set and read a nested property", () => {
data.nested.three = { a: "A", b: "B" };
expect(data.nested.three.a).toEqual("A");
expect(data.nested.three.b).toEqual("B");
});
it("should handle circular references just fine", () => {
data.nested = data;
expect(data.nested.one).toEqual(1);
expect(data.nested.nested.one).toEqual(1);
expect(data.nested.nested.nested.one).toEqual(1);
});
});
describe("cache", () => {
let data: TestData;
beforeEach(() => {
data = strictObject<TestData>({
three: { a: "A", b: "B" },
});
data.nested = data;
});
it("it should return the same exact smart object each time", () => {
expect(data.three === data.three).toBeTruthy();
expect(data === data.nested).toBeTruthy();
expect(data.nested === data.nested).toBeTruthy();
expect(data === data.nested.nested.nested).toBeTruthy();
expect(data.three === data.nested.three).toBeTruthy();
expect(strictObject(data) === data).toBeTruthy();
expect(strictObject(data.nested) === data).toBeTruthy();
expect(strictObject(data.three) === data.three).toBeTruthy();
});
it("error messages from circular references do not have nested names", () => {
expect(() => data.nested.nested.one).toThrowErrorMatchingInlineSnapshot(
`"strictObject.one is not defined"`
);
});
});
describe("ignore", () => {
let data: TestData;
beforeEach(() => {
data = strictObject<TestData>(
{
one: 1,
nested: { one: 111 },
},
"data",
{
ignore: ["two", "INVALID"],
}
);
});
it("can get ignored properties", () => {
expect(() => data.one).not.toThrow();
expect(() => data.two).not.toThrow();
expect(() => data.three).toThrow();
expect(() => data.nested.two).not.toThrow();
expect(() => data.nested.three).toThrow();
expect(data.two).toEqual(undefined);
expect(data.nested.two).toEqual(undefined);
// @ts-ignore
expect(data.INVALID).toEqual(undefined);
// @ts-ignore
expect(data.nested.INVALID).toEqual(undefined);
});
it("can set ignored properties", () => {
expect(() => (data.two = "TWO")).not.toThrow();
expect(data.two).toEqual("TWO");
// @ts-ignore
delete data.two;
expect(data.two).toEqual(undefined);
});
});
});