Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 59 lines (49 sloc) 1.957 kb
27045a3 @leadVisionary Initial commit
authored
1 Menu
2 ====
3
23f8411 @leadVisionary added better documentation, outlining approach, directory structure, and...
authored
4 A library for creating menus built using a [Domain Driven Design][ddd] approach. It is implemented
9a0a937 @leadVisionary updated to reflect current state
authored
5 using [COMPOSITE][comp], [ITERATOR][it], [ABSTRACT FACTORY][fac], and [DECORATOR][dec] to provide
6 a simple, clean, elegant interface for menu management.
23f8411 @leadVisionary added better documentation, outlining approach, directory structure, and...
authored
7
8 *Note: Special care is taken for user input sanitation. This menu does not work with _null_ at all. Attempts to use _null_
9 will trigger [UnsupportedOperationException][unsup].
10
11 Structure
12 ===
13 src/
48a8d38 @leadVisionary added reference to integration test
authored
14 com.visionarysoftwaresolutions.menu
9a0a937 @leadVisionary updated to reflect current state
authored
15 - [MenuComponent.java][menu]
23f8411 @leadVisionary added better documentation, outlining approach, directory structure, and...
authored
16 -- The Aggregate Root of Menu, defines an interface that developers and 3rd party libraries can rely on as the contract to which this library adheres.
17 - This interface is Open for Extension, Closed for Modification
18
48a8d38 @leadVisionary added reference to integration test
authored
19 ...more to come **TO DO**
20
21 Check out test/com/visionarysoftwaresolutions.menu.MenuIntegrationTest.java for a long example of the various things you can do, then check it out!
22
23f8411 @leadVisionary added better documentation, outlining approach, directory structure, and...
authored
23
24 Features
25 ===
9a0a937 @leadVisionary updated to reflect current state
authored
26
27
23f8411 @leadVisionary added better documentation, outlining approach, directory structure, and...
authored
28 <table>
29 <thead>
30 <th>Feature</th>
31 <th>Story</th>
32 <th>Status</th>
33 <th>Tests</th>
34 </thead>
35 <tbody>
36 <tr>
37 <td>Create a Menu</td>
38 <td>
39 <ul>
40 <li><strong>Given</strong>: I have the name of a menu I want to create</li>
41 <li><strong>When</strong>: I use the menu factory's create menu method</li>
42 <li><strong>Then</strong>: I am returned a named menu</li>
43 </ul>
44 </td>
45 <td>Done</td>
46 <td>[MenuFactoryTests][createMenu]</td>
47 </tr>
48 </tbody>
49 <tfoot>
50 </tfoot>
51 </table>
52
5fdf321 @leadVisionary tables broken?
authored
53 [ddd]: http://domaindrivendesign.org/
54 [comp]: http://sourcemaking.com/design_patterns/composite
55 [it]: http://sourcemaking.com/design_patterns/iterator
9a0a937 @leadVisionary updated to reflect current state
authored
56 [dec]: http://sourcemaking.com/design_patterns/decorator
a1acdf2 @leadVisionary reflect change to Abstract Factory
authored
57 [fac]: http://sourcemaking.com/design_patterns/abstract_factory
5fdf321 @leadVisionary tables broken?
authored
58 [unsup]: http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html
3a0e361 @leadVisionary Stupid me, put : after links
authored
59 [createMenu]: http://github.com/leadVsionary/Menu
Something went wrong with that request. Please try again.