-
Notifications
You must be signed in to change notification settings - Fork 0
/
orbit.html
79 lines (73 loc) · 6.99 KB
/
orbit.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<title>little programs -- orbit</title>
<link href="https://fonts.googleapis.com/css?family=Roboto|Source+Code+Pro&display=swap" rel="stylesheet">
<link rel="stylesheet" href="styles.css">
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
<script src="w3.js"></script>
</head>
<body>
<div class="article-container">
<div role="navigation" w3-include-html="partials/navbar.html" class="nav-wrapper"></div>
<div class="article-wrapper">
<div class="article-title">
<h1>Orbit</h1>
</div>
<div class="article-by-line">
<p>Built July 2019 - Ongoing</p>
</div>
<div class="article-hero">
<div class="article-hero-wrapper">
<div class="article-hero-image">
<img src="images/orbit.jpg">
</div>
<div class="info-block">
<div class="info-block-wrapper">
<h2><span class="info-category">What it is: </span>Monopoly in Space, playable on the command line.</h2>
<h2><span class="info-category">How it's built: </span>I built this program in ruby to practice object-oriented design. As of this writing there are about <del>15</del> 20 classes and modules, and game data (like items and events) are stored in CSV files.</h2>
<h2><span class="info-category">How to use it: </span>The most recent release is available from <a href="https://github.com/dsmcclain/Orbit">my github repo</a>. The only dependency is ruby 2.5 or higher, so simply clone the repo and run <span class="codespan">ruby orbit.rb</span></h2>
</div>
</div>
</div>
</div>
<h3 class="article-subtitle">THE STORY</h3>
<p>
Orbit is the program I wrote with Sandi Metz.
</p>
<p>
In my very first developer interview I was asked to write a version of the game Monopoly on the whiteboard. I did well enough to get the job, but I left the interview with the frustrating impression that I didn’t perform as well as I thought I could. So I went home and started writing Orbit.
</p>
<p>
Orbit the program began as a single class that moved players around a game board and awarded ‘fuel points’ when a player completed a full orbit. Players would take turns driving their ships in an attempt to visit every ‘sector’ of the game board before running out of fuel. It was the most simplified version of Monopoly I could design, but space-themed.
</p>
<img class="article-internal-image" src="images/orbit-intro.jpg">
<p>
When I started my job I set Orbit aside. I forgot about it until months later, when my job asked me to build a feature that required working with an important set of classes in our codebase called ‘connectors.’ The connectors were responsible for querying our clients’ APIs, as well as our database, and bringing back data that we could parse and map and use a bunch of different ways. Because they needed to be tailored to the variations in our clients’ endpoints, the connectors were a suite of classes that had a lot of maddeningly subtle differences in behavior. And because they acted as critical connective tissue between many different parts of our app, the connectors propagated hidden and unexpected dependencies all over the codebase. They were a set of classes that embodied Sandi Metz’s concept of the “Death Star Anti-pattern”--the classes in your codebase that exhibit both high churn and high complexity. In short, they were a pain to work with. And it was my job to work with them.
</p>
<p>
After looking through Sandi’s books and talks for guidance, as well as the classic text <u>Refactoring</u> by Martin Fowler and Kent Beck, I realized that what I really needed was an Object Oriented Sandbox—a program where the stakes were low and I could practice the concepts of Object Oriented Design by building and refactoring and building some more, challenging myself on each iteration to hold the growing complexity within the principles and best practices that Sandi prescribed. And so Orbit became my never-ending Object Oriented Sandbox. The game itself became the ship I would use to explore the universe of OO.
</p>
<p>
As of this writing Orbit has <del>15</del> 20 classes and about <del>2000</del> 2500 lines of code, as well as a dozen data files that feed items, sectors, and events into the Orbit universe. The program is still relatively small, but it feels endlessly extendable. In the current version of the game, players can collect and use items, send messages to one-another, and change directions and speed in their exploration of the sprawling game board. <span style="color: #b60d00">But the most interesting piece of the design puzzle was creating the console.</span>
</p>
<img class="article-internal-image" src="images/orbit-console.jpg">
<p>
Because the entire game happens on the command line I wanted some sort of graphic output that keeps the player entertained and gives the feel of interacting with a (modest) command center on a spaceship. So I devised a frame that would display the player's current stats and provide a viewing area for important messages that ocurr during the game. In order to pull this off, I needed to do things like chop a long string on the correct whitespace, center output with whitespace buffers, and output the frame with consistent formatting for multiple players who had constantly-changing stats. Doing this all within the limitations of the terminal--which only prints left-to-right, top-to-bottom--was trickier than it seems. The solution was a Formatter Class that exposed public methods like <span class="codespan">buffer_string</span>, <span class="codespan">print_frame</span>, and <span class="codespan">print_as_handwriting</span>. The latter is a fun feature that accepts a formatted string and outputs to the screen one character at a time, quickly, as though the message were being typed hurriedly by an astronaut under duress. None of this is earth-shattering stuff, but the clean interlocking of behaviors within OO principles is satisfying. What's even more satisifying is that the program grows in value exponentially as it becomes more complex, because it provides opportunities to practice OO design where it really shines: in a complex, interdependent, constantly changing application.
</p>
<p>
The most recent release of Orbit can be found at <a href="https://github.com/dsmcclain/Orbit">this</a> github repo, but the program will continue to evolve. Who knows, by the time you read this maybe players will be able to time-travel.
<span style="color:#b60d00">Thanks for reading!</span>
</p>
<div class="article-footer">
</div>
</div>
</div>
<div w3-include-html="partials/footer.html" class="footer"></div>
<script>
w3.includeHTML();
</script>
</body>
</html>