-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdevprocess.html
More file actions
354 lines (235 loc) · 12.7 KB
/
devprocess.html
File metadata and controls
354 lines (235 loc) · 12.7 KB
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>3. Context and Background — COMP 313/413 Lecture Notes 1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="4. Basics of Object-Oriented Programming" href="basicoop.html" />
<link rel="prev" title="2. Course Outline" href="outline.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> COMP 313/413 Lecture Notes
</a>
<div class="version">
1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="outline.html">2. Course Outline</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">3. Context and Background</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#software-requirements">3.1. Software requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#overview-of-a-lightweight-development-process">3.2. Overview of a lightweight development process</a></li>
<li class="toctree-l2"><a class="reference internal" href="#software-design-principles-and-patterns">3.3. Software design principles and patterns</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="basicoop.html">4. Basics of Object-Oriented Programming</a></li>
<li class="toctree-l1"><a class="reference internal" href="summary.html">5. Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="software.html">6. Appendix: Course Software</a></li>
<li class="toctree-l1"><a class="reference internal" href="syllabus.html">7. Appendix: Course Syllabi</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">8. Appendix: TODO</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">COMP 313/413 Lecture Notes</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><span class="section-number">3. </span>Context and Background</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/devprocess.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="context-and-background">
<h1><span class="section-number">3. </span>Context and Background<a class="headerlink" href="#context-and-background" title="Permalink to this headline">¶</a></h1>
<p>In this chapter, we establish a practical context and provide some background information for the study of object-oriented programming, patterns, and principles.</p>
<div class="section" id="software-requirements">
<h2><span class="section-number">3.1. </span>Software requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
<p>In most cases, we develop software to provide some form of value:</p>
<ul class="simple">
<li><p>learn a language, library, framework, platform, technique, or tool
(see also the <a class="reference external" href="https://www.thoughtworks.com/radar">ThoughtWorks Technology Radar</a>)</p></li>
<li><p>solve a problem</p></li>
<li><p>produce an asset</p></li>
</ul>
<p>There is usually some tension among these three activities.</p>
<p>The basic categories of requirements are</p>
<ul class="simple">
<li><p>functional (FR)</p>
<ul>
<li><p>output as function of input: <cite>y = f(x)</cite></p></li>
<li><p>or some other description of observable behavior</p>
<ul>
<li><p>batch</p></li>
<li><p>interactive/event-based</p></li>
</ul>
</li>
</ul>
</li>
<li><p>nonfunctional (NFR): additional properties of <cite>f</cite>, e.g.</p>
<ul>
<li><p>testability</p>
<ul>
<li><p>most important nonfunctional requirement</p></li>
<li><p>allows testing whether functional requirements are met</p></li>
<li><p>good architecture often happens as a side-effect (APPP pp. 36-38), such as separating I/O from core functionality</p></li>
</ul>
</li>
<li><p>performance</p></li>
<li><p>scalability</p>
<ul>
<li><p>e.g. performance for large data sets: asymptotic order of complexity</p></li>
<li><p>(big-Oh) in terms of input size n</p></li>
</ul>
</li>
<li><p>reliability</p></li>
<li><p>maintainability</p></li>
<li><p>static versus dynamic NFRs</p></li>
</ul>
</li>
</ul>
<p>Several common questions and issues related to requirements arise:</p>
<ul class="simple">
<li><p><em>how do requirements relate to the project development lifecycle?</em></p></li>
<li><p><em>BUFD versus MVP</em></p></li>
<li><p><em>how do testing and refactoring relate to requirements?</em></p></li>
</ul>
<p>The following figure by Kazman relates unit operations (high-level generalizations of refactorings) and software quality factors (nonfunctional requirements).</p>
<div class="figure align-default">
<img alt="_images/KazmanQualityFactors.png" src="_images/KazmanQualityFactors.png" />
</div>
</div>
<div class="section" id="overview-of-a-lightweight-development-process">
<h2><span class="section-number">3.2. </span>Overview of a lightweight development process<a class="headerlink" href="#overview-of-a-lightweight-development-process" title="Permalink to this headline">¶</a></h2>
<p>A successful development process usually comprises these minimal elements:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://martinfowler.com/bliki/SelfTestingCode.html">automated regression testing</a></p>
<ul>
<li><p>tests represent expectations of how the software should behave</p></li>
<li><p>when expressed as code, these are</p>
<ul>
<li><p>fun to produce (like other coding)</p></li>
<li><p>convenient to run frequently</p></li>
</ul>
</li>
<li><p>fix system-under-test (SUT) (not tests themselves) until tests pass</p></li>
<li><p>retest every time</p>
<ul>
<li><p>a feature is added</p></li>
<li><p>the code is refactored</p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference external" href="https://www.refactoring.com/">refactoring</a></p>
<ul>
<li><p>improve the quality of the code without changing its behavior</p>
<ul>
<li><p>macro level: nonfunctional requirements (quality factors)</p></li>
<li><p>micro level: <a class="reference external" href="https://refactoring.guru/smells/smells">code smells</a></p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://refactoring.com/catalog/">catalog of refactorings</a></p></li>
</ul>
</li>
<li><p><a class="reference external" href="https://www.martinfowler.com/articles/continuousIntegration.html">continuous integration</a></p></li>
</ul>
<p>The <a class="reference external" href="https://github.com/lucproglangcourse/processtree-scala">process tree</a> example illustrates continuous integration using various hosted services:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://travis-ci.org/LoyolaChicagoCode/processtree-scala">Travis CI</a>: continuous integration</p></li>
<li><p><a class="reference external" href="https://codecov.io/gh/LoyolaChicagoCode/processtree-scala">Codecov</a>: test coverage</p></li>
<li><p><a class="reference external" href="https://www.codacy.com/app/laufer/processtree-scala">Codacy</a>: automated code review</p></li>
<li><p><a class="reference external" href="http://issuestats.com/github/LoyolaChicagoCode/processtree-scala">IssueStats</a> and <a class="reference external" href="http://isitmaintained.com/project/LoyolaChicagoCode/processtree-scala">IsItMaintained</a>: stats on issues and pull requests</p></li>
</ul>
<p>The <a class="reference external" href="https://github.com/LoyolaChicagoCode/clickcounter-android-java">click counter</a> example includes additional hosted continuous integration and delivery targets suitable for mobile app development.</p>
</div>
<div class="section" id="software-design-principles-and-patterns">
<h2><span class="section-number">3.3. </span>Software design principles and patterns<a class="headerlink" href="#software-design-principles-and-patterns" title="Permalink to this headline">¶</a></h2>
<p>The software development community has identified various principles intended to guide the design and development process, for example:</p>
<ul class="simple">
<li><p><a class="reference external" href="http://en.wikipedia.org/wiki/Don%27t_repeat_yourself">DRY</a> (don’t repeat yourself)</p></li>
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/Separation_of_concerns">SoC</a> (separation of concerns)</p></li>
<li><p><a class="reference external" href="https://en.wikipedia.org/wiki/SOLID_(object-oriented_design)">SOLID</a></p></li>
</ul>
<p>The community has also developed a body of <a class="reference external" href="https://sourcemaking.com/design_patterns">design patterns</a> that represent reusable solutions to recurring problems. Some key design patterns we will rely on in this course include</p>
<ul class="simple">
<li><p>Iterator</p></li>
<li><p>Strategy</p></li>
<li><p>Command</p></li>
<li><p>Composite</p></li>
<li><p>Decorator</p></li>
<li><p>Visitor</p></li>
<li><p>Abstract Factory</p></li>
<li><p>Observer</p></li>
</ul>
<p>We will study these topics throughout the course.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Language-specific design patterns are called <em>idioms</em>.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="basicoop.html" class="btn btn-neutral float-right" title="4. Basics of Object-Oriented Programming" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="outline.html" class="btn btn-neutral float-left" title="2. Course Outline" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, Konstantin Läufer
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>