Classes and Types for EventStream Puzzler #128

KameronKeller · 2024-04-03T23:50:59Z

What this is:

Implement classes that are expected to be used for implementing the algorithm
models/highestregionlocator.ts defines a class that receives an event stream and will have a method that can locate the highest region in the dataset
- The locateHighestRegion() function exists as a placeholder and will throw an error if called
models/region.ts defines a class that can add up the scores of the app events that are added to it
index.ts now has a main function and a console.log as a placeholder to verify it is being called when the program is being run
types.ts defines types for AppEvents, EventStream data, and the dictionary for the Scores class
index.test.ts defines high-level tests for validating that the classes created above successfully interface with each other

Issue:

N/A

Media:

EventStreamPuzzler.mov

Steps to Verify:

Clone the branch
Run yarn install
Run yarn test

KameronKeller · 2024-04-03T23:53:00Z

src/models/eventstream.ts

+import { AppEvent } from "./appevent";
+
+export class EventStream {
+    events: AppEvent[];


I am curious if this is an appropriate way to assign a type to a variable. AppEvent is a class - would it be better to define an interface or type that defines the type that events should be?

src/assets/sampleData.ts

src/index.test.ts

src/index.ts

src/models/appevent.ts

src/models/scores.ts

rachoac · 2024-04-04T00:42:36Z

src/types.ts

@@ -0,0 +1,10 @@
+export interface AppEventInterface {


what is the difference between interface and type?

why would you use one versus another, in typescript? based on this, does it make sense to define these as types, or interfaces?

Switched to types, primarily because interfaces can be "merged" together which could be unexpected

…files, and tests no longer needed

rachoac · 2024-04-05T00:18:47Z

src/models/highestregionlocator.ts

+import { Region } from './region'
+import { EventStream } from '../types'
+
+export class HighestRegionLocator {


camelCase the file

Changed filename to camel case

rachoac · 2024-04-05T00:19:54Z

src/index.test.ts

@@ -1,7 +1,91 @@
-//write tests here
+// import { AppEvent } from './models/appevent'


avoid dead code

Dead code removed

rachoac · 2024-04-05T00:21:51Z

src/index.test.ts

+  const eventStream: EventStream = sampleData
+
+  it ('instantiates a HighestRegionLocator object', () => {
+    const highestRegionLocator = new HighestRegionLocator(eventStream)


no need to test instance

Removed unneeded instance test

rachoac · 2024-04-05T00:26:10Z

src/models/region.ts

+
+export class Region {
+    regionEvents: AppEvent[] = []
+    score: number = 0


do we need this?

Removed score member variable as it was not being used and won't be needed

KameronKeller added 17 commits April 2, 2024 17:24

Create types file and add eventinterface

6cfd596

Create files for classes

40c887e

Create events file and define class

51e7f33

Define main function and add console log to ensure it is working

ca9c292

Import interface

eec3d8d

Add type for EventStreamInterface

ca79bbd

Rename to avoid already used classname Event

9a1c22e

Implement event stream class

3d81a16

Add score member variable to appevent

08f1c6d

Use the defined interface for the type of events

d06b73a

Implement the Region class

acc6c01

Implement the static scores class

236180b

Add a type for the Scores dictionary and rename the type

bff2c8d

Implement initial HighestRegionLocator class

68073e4

Add high level tests for the defined classes

f193f0d

Change the events type from the interface to the class type

ba9fc52

Add sample data as an asset to the project for future testing

ee73559

KameronKeller commented Apr 3, 2024

View reviewed changes