├── .gitignore
├── LICENSE
├── README.md
├── assets
└── images
│ └── 0-banner.png
├── build.gradle
├── gradle.properties
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── run-cli.sh
├── settings.gradle
└── src
└── main
├── java
└── com
│ └── ag04
│ └── clidemo
│ ├── ClidemoApplication.java
│ ├── command
│ ├── EchoCommand.java
│ ├── TableExamplesCommand.java
│ └── UserCommand.java
│ ├── config
│ ├── JacksonConfig.java
│ ├── SpringShellConfig.java
│ └── UserServiceConfig.java
│ ├── model
│ ├── CliUser.java
│ └── Gender.java
│ ├── observer
│ ├── ProgressUpdateEvent.java
│ └── ProgressUpdateObserver.java
│ ├── service
│ ├── MockUserService.java
│ └── UserService.java
│ └── shell
│ ├── ClidemoPromptProvider.java
│ ├── InputReader.java
│ ├── ProgressBar.java
│ ├── ProgressCounter.java
│ ├── PromptColor.java
│ ├── ShellHelper.java
│ └── table
│ ├── BeanTableModelBuilder.java
│ └── LocalDateFormatter.java
└── resources
├── application.properties
├── banner.txt
├── cli-users.json
└── logback-spring.xml
/.gitignore:
--------------------------------------------------------------------------------
1 | .gradle
2 | /build/
3 | !gradle/wrapper/gradle-wrapper.jar
4 |
5 | ### STS ###
6 | .apt_generated
7 | .classpath
8 | .factorypath
9 | .project
10 | .settings
11 | .springBeans
12 | .sts4-cache
13 | /bin/
14 |
15 | ### IntelliJ IDEA ###
16 | .idea
17 | *.iws
18 | *.iml
19 | *.ipr
20 | /out/
21 |
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 |
29 | spring-shell\.log
30 | /.vscode/
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # SpringShell CLI Demo
2 | 
3 | [](https://www.gnu.org/licenses/gpl-3.0)
4 |
5 |
6 | Sample Command line interpreter (CLI) demo app developed with Spring Shell library.
7 |
8 | 
9 |
10 | ## How to use this repository?
11 |
12 | Master branch contains current/final state of the the CLI demo, while particular branches,
13 | for example **part1** contain code relevant for specific part of the tutorial (ie. Part 1).
14 |
15 | Happy coding!
16 | ### Setup (First time)
17 | 1. Clone the repository: `git clone git@github.com:dmadunic/clidemo.git`
18 | 2. Build project with: `./gradlew clean build `
19 |
20 | Now you can run it by executing the following command:
21 |
22 | ```bash
23 | ./run-cli.sh
24 | ```
25 |
26 | ## (Manual) Release new version
27 | Make sure that file gradle.properties in the folder ${USER_HOME}/.gradle/ contains the following two variables defined:
28 |
29 | * github_username
30 | * github_password : personal github token (PAT) to be used to install/update packages
31 |
32 | For more on creating personal github token (PAT) see this [link](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
33 |
34 | 1) Commit and push everything
35 | 2) `./gradlew release`
36 |
37 | And simply follow the instructions on the console
38 |
39 | ## Changelog
40 |
41 | ### Contributors
42 | - Domagoj Madunić
43 |
44 |
45 | (c) AG04 Innovative Solutions d.o.o. (2022)
46 |
47 |
--------------------------------------------------------------------------------
/assets/images/0-banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dmadunic/clidemo/0cb51e37ae1df5319464fb0414c3a91b39609664/assets/images/0-banner.png
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'maven-publish'
3 | id 'net.researchgate.release' version '2.8.1'
4 | id "org.springframework.boot" version "${springBootVersion}"
5 | id 'io.spring.dependency-management' version '1.0.11.RELEASE'
6 | id 'java'
7 | }
8 |
9 | group = 'com.ag04'
10 | sourceCompatibility = '11'
11 |
12 | repositories {
13 | mavenCentral()
14 | maven { url 'https://repo.spring.io/milestone' }
15 | }
16 |
17 | publishing {
18 | publications {
19 | maven(MavenPublication) {
20 | groupId 'com.ag04'
21 | from(components.java)
22 | }
23 | }
24 | repositories {
25 | maven {
26 | name = "GitHubPackages"
27 | url = uri("https://maven.pkg.github.com/dmadunic/clidemo")
28 | credentials {
29 | username = github_username ?: System.getenv("GITHUB_ACTOR")
30 | password = github_password ?: System.getenv("GITHUB_TOKEN")
31 | }
32 | }
33 | }
34 | }
35 |
36 | afterReleaseBuild.dependsOn publish
37 |
38 | dependencies {
39 | implementation "org.springframework.shell:spring-shell-starter:${springShellVersion}"
40 | implementation "com.fasterxml.jackson.core:jackson-databind:${jacksonDatabindVersion}"
41 | testImplementation "org.springframework.boot:spring-boot-starter-test:${springBootVersion}"
42 | }
43 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | version=0.1.2
2 |
3 | springBootVersion=2.1.3.RELEASE
4 | springShellVersion=2.0.1.RELEASE
5 | jacksonDatabindVersion=2.9.8
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dmadunic/clidemo/0cb51e37ae1df5319464fb0414c3a91b39609664/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/run-cli.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | java -Dspring.profiles.active=${1:-dev} -jar build/libs/clidemo-0.1.2.jar
3 |
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | rootProject.name = 'clidemo'
2 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/ClidemoApplication.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 | import org.springframework.context.ConfigurableApplicationContext;
6 |
7 | @SpringBootApplication
8 | public class ClidemoApplication {
9 |
10 | public static void main(String[] args) {
11 | ConfigurableApplicationContext context = SpringApplication.run(ClidemoApplication.class, args);
12 | }
13 |
14 | }
15 |
16 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/command/EchoCommand.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.command;
2 |
3 | import com.ag04.clidemo.shell.ProgressBar;
4 | import com.ag04.clidemo.shell.ProgressCounter;
5 | import com.ag04.clidemo.shell.ShellHelper;
6 | import org.jline.reader.LineReader;
7 | import org.springframework.beans.factory.annotation.Autowired;
8 | import org.springframework.shell.standard.ShellComponent;
9 | import org.springframework.shell.standard.ShellMethod;
10 | import org.springframework.shell.standard.ShellOption;
11 |
12 | @ShellComponent
13 | public class EchoCommand {
14 |
15 | @Autowired
16 | ShellHelper shellHelper;
17 |
18 | @Autowired
19 | ProgressBar progressBar;
20 |
21 | @Autowired
22 | ProgressCounter progressCounter;
23 |
24 |
25 | @ShellMethod("Displays greeting message to the user whose name is supplied")
26 | public String echo(@ShellOption({"-N", "--name"}) String name) {
27 | String message = String.format("Hello %s!", name);
28 | shellHelper.print(message.concat(" (Default style message)"));
29 | shellHelper.printError(message.concat(" (Error style message)"));
30 | shellHelper.printWarning(message.concat(" (Warning style message)"));
31 | shellHelper.printInfo(message.concat(" (Info style message)"));
32 | shellHelper.printSuccess(message.concat(" (Success style message)"));
33 |
34 | String output = shellHelper.getSuccessMessage(message);
35 | return output.concat(" You are running spring shell cli-demo.");
36 | }
37 |
38 | @ShellMethod("Displays progress spinner")
39 | public void progressSpinner() throws InterruptedException {
40 | for (int i = 1; i <=100; i++) {
41 | progressCounter.display();
42 | Thread.sleep(100);
43 | }
44 | progressCounter.reset();
45 | }
46 |
47 | @ShellMethod("Displays progress counter (with spinner)")
48 | public void progressCounter() throws InterruptedException {
49 | for (int i = 1; i <=100; i++) {
50 | progressCounter.display(i, "Processing");
51 | Thread.sleep(100);
52 | }
53 | progressCounter.reset();
54 | }
55 |
56 | @ShellMethod("Displays progress bar")
57 | public void progressBar() throws InterruptedException {
58 | for (int i = 1; i <=100; i++) {
59 | progressBar.display(i);
60 | Thread.sleep(100);
61 | }
62 | progressBar.reset();
63 | }
64 |
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/command/TableExamplesCommand.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.command;
2 |
3 | import com.ag04.clidemo.shell.ShellHelper;
4 | import com.ag04.clidemo.shell.table.LocalDateFormatter;
5 | import org.springframework.beans.factory.annotation.Autowired;
6 | import org.springframework.shell.standard.ShellComponent;
7 | import org.springframework.shell.standard.ShellMethod;
8 | import org.springframework.shell.table.*;
9 |
10 | import java.time.LocalDate;
11 |
12 |
13 | @ShellComponent
14 | public class TableExamplesCommand {
15 |
16 | public String[] CONTINENTS = {"Europe", "North America", "South America", "Africa", "Asia", "Austraila and Oceania"};
17 | public String[] COUNTRIES1 = {"Germany", "USA", "Brasil", "Nigeria", "China", "Australia"};
18 | public String[] COUNTRIES2 = {"France", "Canada", "Argentina", "Egypt", "India", "New Zeeland"};
19 |
20 | @Autowired
21 | ShellHelper shellHelper;
22 |
23 | @ShellMethod("Display sample tables")
24 | public void sampleTables() {
25 | Object[][] sampleData = new String[][] {
26 | CONTINENTS,
27 | COUNTRIES1,
28 | COUNTRIES2
29 | };
30 | TableModel model = new ArrayTableModel(sampleData);
31 | TableBuilder tableBuilder = new TableBuilder(model);
32 |
33 | shellHelper.printInfo("air border style");
34 | tableBuilder.addFullBorder(BorderStyle.air);
35 | shellHelper.print(tableBuilder.build().render(80));
36 |
37 | shellHelper.printInfo("oldschool border style");
38 | tableBuilder.addFullBorder(BorderStyle.oldschool);
39 | shellHelper.print(tableBuilder.build().render(80));
40 |
41 | shellHelper.printInfo("fancy_light border style");
42 | tableBuilder.addFullBorder(BorderStyle.fancy_light);
43 | shellHelper.print(tableBuilder.build().render(80));
44 |
45 | shellHelper.printInfo("fancy_double border style");
46 | tableBuilder.addFullBorder(BorderStyle.fancy_double);
47 | shellHelper.print(tableBuilder.build().render(80));
48 |
49 | shellHelper.printInfo("mixed border style");
50 | tableBuilder.addInnerBorder(BorderStyle.fancy_light);
51 | tableBuilder.addHeaderBorder(BorderStyle.fancy_double);
52 | shellHelper.print(tableBuilder.build().render(80));
53 | }
54 |
55 | @ShellMethod("Table formatter demo")
56 | public void tableFormatterDemo() {
57 | LocalDateFormatter dateFormatter = new LocalDateFormatter("dd.MM.YYYY");
58 |
59 | LocalDate now = LocalDate.now();
60 | Object[][] sampleData = new Object[][] {
61 | {"Date", "Value"},
62 | {"Today", now},
63 | {"Today minus 1", now.minusDays(1)},
64 | {"Today minus 2", now.minusDays(2)},
65 | {"Today minus 3", now.minusDays(3)}
66 | };
67 |
68 | TableModel model = new ArrayTableModel(sampleData);
69 | TableBuilder tableBuilder = new TableBuilder(model);
70 | tableBuilder.on(CellMatchers.ofType(LocalDate.class)).addFormatter(dateFormatter);
71 | tableBuilder.addFullBorder(BorderStyle.fancy_light);
72 | shellHelper.print(tableBuilder.build().render(30));
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/command/UserCommand.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.command;
2 |
3 | import com.ag04.clidemo.model.CliUser;
4 | import com.ag04.clidemo.model.Gender;
5 | import com.ag04.clidemo.service.UserService;
6 | import com.ag04.clidemo.shell.InputReader;
7 | import com.ag04.clidemo.shell.ShellHelper;
8 | import com.ag04.clidemo.shell.table.BeanTableModelBuilder;
9 | import com.fasterxml.jackson.core.type.TypeReference;
10 | import com.fasterxml.jackson.databind.ObjectMapper;
11 | import org.springframework.beans.factory.annotation.Autowired;
12 | import org.springframework.shell.standard.ShellComponent;
13 | import org.springframework.shell.standard.ShellMethod;
14 | import org.springframework.shell.standard.ShellOption;
15 | import org.springframework.shell.table.*;
16 | import org.springframework.util.StringUtils;
17 |
18 | import java.util.*;
19 |
20 | @ShellComponent
21 | public class UserCommand {
22 |
23 | @Autowired
24 | ShellHelper shellHelper;
25 |
26 | @Autowired
27 | InputReader inputReader;
28 |
29 | @Autowired
30 | UserService userService;
31 |
32 | @Autowired
33 | private ObjectMapper objectMapper;
34 |
35 | @ShellMethod("Display list of users")
36 | public void userList() {
37 | List users = userService.findAll();
38 |
39 | LinkedHashMap headers = new LinkedHashMap<>();
40 | headers.put("id", "Id");
41 | headers.put("username", "Username");
42 | headers.put("fullName", "Full name");
43 | headers.put("gender", "Gender");
44 | headers.put("superuser", "Superuser");
45 | TableModel model = new BeanListTableModel<>(users, headers);
46 |
47 | TableBuilder tableBuilder = new TableBuilder(model);
48 | tableBuilder.addInnerBorder(BorderStyle.fancy_light);
49 | tableBuilder.addHeaderBorder(BorderStyle.fancy_double);
50 | shellHelper.print(tableBuilder.build().render(80));
51 | }
52 |
53 | @ShellMethod("Create new user with supplied username")
54 | public void createUser(@ShellOption({"-U", "--username"}) String username) {
55 | if (userService.exists(username)) {
56 | shellHelper.printError(String.format("User with username='%s' already exists --> ABORTING", username));
57 | return;
58 | }
59 | CliUser user = new CliUser();
60 | user.setUsername(username);
61 |
62 | shellHelper.printInfo("Please enter new user data:");
63 | // 1. read user's fullName --------------------------------------------
64 | do {
65 | String fullName = inputReader.prompt("Full name");
66 | if (StringUtils.hasText(fullName)) {
67 | user.setFullName(fullName);
68 | } else {
69 | shellHelper.printWarning("User's full name CAN NOT be empty string? Please enter valid value!");
70 | }
71 | } while (user.getFullName() == null);
72 |
73 | // 2. read user's password --------------------------------------------
74 | do {
75 | String password = inputReader.prompt("Password", "secret", false);
76 | if (StringUtils.hasText(password)) {
77 | user.setPassword(password);
78 | } else {
79 | shellHelper.printWarning("Password'CAN NOT be empty string? Please enter valid value!");
80 | }
81 | } while (user.getPassword() == null);
82 |
83 | // 3. Prompt for user's Gender ----------------------------------------------
84 | Map options = new HashMap<>();
85 | options.put("M", Gender.MALE.name());
86 | options.put("F", Gender.FEMALE.name() );
87 | options.put("D", Gender.DIVERSE.name());
88 |
89 | String genderValue = inputReader.selectFromList("Gender", "Please enter one of the [] values", options, true, null);
90 | Gender gender = Gender.valueOf(options.get(genderValue.toUpperCase()));
91 | user.setGender(gender);
92 |
93 | // 4. Prompt for superuser attribute
94 | String superuserValue = inputReader.promptWithOptions("New user is superuser", "N", Arrays.asList("Y", "N"));
95 | if ("Y".equals(superuserValue)) {
96 | user.setSuperuser(true);
97 | } else {
98 | user.setSuperuser(false);
99 | }
100 |
101 | // Print user's input -------------------------------------------------
102 | shellHelper.printInfo("\nCreating a new user:");
103 | displayUser(user);
104 |
105 | CliUser createdUser = userService.create(user);
106 | shellHelper.printSuccess("---> SUCCESS created user with id=" + createdUser.getId());
107 | }
108 |
109 | @ShellMethod("Update and synchronize all users in local database with external source")
110 | public void updateAllUsers() {
111 | shellHelper.printInfo("Starting local user db update");
112 | long numOfUsers = userService.updateAll();
113 | String successMessage = shellHelper.getSuccessMessage("SUCCESS >>");
114 | successMessage = successMessage + String.format(" Total of %d local db users updated!", numOfUsers);
115 | shellHelper.print(successMessage);
116 | }
117 |
118 | @ShellMethod("Display details of user with supplied username")
119 | public void userDetails(@ShellOption({"-U", "--username"}) String username) {
120 | CliUser user = userService.findByUsername(username);
121 | if (user == null) {
122 | shellHelper.printWarning("No user with the supplied username could be found?!");
123 | return;
124 | }
125 | displayUser(user);
126 | }
127 |
128 | private void displayUser(CliUser user) {
129 | LinkedHashMap labels = new LinkedHashMap<>();
130 | labels.put("id", "Id");
131 | labels.put("username", "Username");
132 | labels.put("fullName", "Full name");
133 | labels.put("gender", "Gender");
134 | labels.put("superuser", "Superuser");
135 | labels.put("password", "Password");
136 |
137 | String[] header = new String[] {"Property", "Value"};
138 | BeanTableModelBuilder builder = new BeanTableModelBuilder(user, objectMapper);
139 | TableModel model = builder.withLabels(labels).withHeader(header).build();
140 |
141 | TableBuilder tableBuilder = new TableBuilder(model);
142 |
143 | tableBuilder.addInnerBorder(BorderStyle.fancy_light);
144 | tableBuilder.addHeaderBorder(BorderStyle.fancy_double);
145 | tableBuilder.on(CellMatchers.column(0)).addSizer(new AbsoluteWidthSizeConstraints(20));
146 | tableBuilder.on(CellMatchers.column(1)).addSizer(new AbsoluteWidthSizeConstraints(30));
147 | shellHelper.print(tableBuilder.build().render(80));
148 | }
149 |
150 | }
151 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/config/JacksonConfig.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.config;
2 |
3 | import com.fasterxml.jackson.databind.ObjectMapper;
4 | import org.springframework.context.annotation.Bean;
5 | import org.springframework.context.annotation.Configuration;
6 |
7 | /**
8 | * Created by: dmadunic on 28/03/2019
9 | */
10 | @Configuration
11 | public class JacksonConfig {
12 |
13 | @Bean
14 | public ObjectMapper objectMapper() {
15 | return new ObjectMapper();
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/config/SpringShellConfig.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.config;
2 |
3 | import com.ag04.clidemo.shell.*;
4 | import org.jline.reader.History;
5 | import org.jline.reader.LineReader;
6 | import org.jline.reader.LineReaderBuilder;
7 | import org.jline.reader.Parser;
8 | import org.jline.terminal.Terminal;
9 | import org.jline.utils.AttributedString;
10 | import org.jline.utils.AttributedStyle;
11 | import org.springframework.context.annotation.Bean;
12 | import org.springframework.context.annotation.Configuration;
13 | import org.springframework.context.annotation.Lazy;
14 | import org.springframework.shell.jline.JLineShellAutoConfiguration;
15 |
16 | @Configuration
17 | public class SpringShellConfig {
18 |
19 | @Bean
20 | public ShellHelper shellHelper(@Lazy Terminal terminal) {
21 | return new ShellHelper(terminal);
22 | }
23 |
24 | @Bean
25 | public InputReader inputReader(
26 | @Lazy Terminal terminal,
27 | @Lazy Parser parser,
28 | JLineShellAutoConfiguration.CompleterAdapter completer,
29 | @Lazy History history,
30 | ShellHelper shellHelper
31 | ) {
32 | LineReaderBuilder lineReaderBuilder = LineReaderBuilder.builder()
33 | .terminal(terminal)
34 | .completer(completer)
35 | .history(history)
36 | .highlighter(
37 | (LineReader reader, String buffer) -> {
38 | return new AttributedString(
39 | buffer, AttributedStyle.BOLD.foreground(PromptColor.WHITE.toJlineAttributedStyle())
40 | );
41 | }
42 | ).parser(parser);
43 |
44 | LineReader lineReader = lineReaderBuilder.build();
45 | lineReader.unsetOpt(LineReader.Option.INSERT_TAB);
46 | return new InputReader(lineReader, shellHelper);
47 | }
48 |
49 | @Bean
50 | public ProgressBar progressBar(ShellHelper shellHelper) {
51 | return new ProgressBar(shellHelper);
52 | }
53 |
54 | @Bean
55 | public ProgressCounter progressCounter(@Lazy Terminal terminal) {
56 | return new ProgressCounter(terminal);
57 | }
58 |
59 | }
60 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/config/UserServiceConfig.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.config;
2 |
3 | import com.ag04.clidemo.observer.ProgressUpdateObserver;
4 | import com.ag04.clidemo.service.MockUserService;
5 | import com.ag04.clidemo.service.UserService;
6 | import com.fasterxml.jackson.databind.ObjectMapper;
7 | import org.springframework.context.annotation.Bean;
8 | import org.springframework.context.annotation.Configuration;
9 |
10 | import java.io.IOException;
11 |
12 | @Configuration
13 | public class UserServiceConfig {
14 |
15 | @Bean
16 | public UserService userService(ProgressUpdateObserver observer, ObjectMapper objectMapper) throws IOException {
17 | MockUserService userService = new MockUserService();
18 | userService.setObserver(observer);
19 | userService.setObjectMapper(objectMapper);
20 | userService.init("cli-users.json");
21 | return userService;
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/model/CliUser.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.model;
2 |
3 | public class CliUser {
4 | private Long id;
5 | private String username;
6 | private String password;
7 | private String fullName;
8 | private Gender gender;
9 | private boolean superuser;
10 |
11 | public Long getId() {
12 | return id;
13 | }
14 |
15 | public void setId(Long id) {
16 | this.id = id;
17 | }
18 |
19 | public String getUsername() {
20 | return username;
21 | }
22 |
23 | public void setUsername(String username) {
24 | this.username = username;
25 | }
26 |
27 | public String getPassword() {
28 | return password;
29 | }
30 |
31 | public void setPassword(String password) {
32 | this.password = password;
33 | }
34 |
35 | public String getFullName() {
36 | return fullName;
37 | }
38 |
39 | public void setFullName(String fullName) {
40 | this.fullName = fullName;
41 | }
42 |
43 | public Gender getGender() {
44 | return gender;
45 | }
46 |
47 | public void setGender(Gender gender) {
48 | this.gender = gender;
49 | }
50 |
51 | public boolean isSuperuser() {
52 | return superuser;
53 | }
54 |
55 | public void setSuperuser(boolean superuser) {
56 | this.superuser = superuser;
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/model/Gender.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.model;
2 |
3 | public enum Gender {
4 | MALE, FEMALE, DIVERSE;
5 | }
6 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/observer/ProgressUpdateEvent.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.observer;
2 |
3 | public class ProgressUpdateEvent {
4 |
5 | Long currentCount;
6 | Long totalCount;
7 | String message;
8 |
9 | public ProgressUpdateEvent(Long currentRecord, Long totalRecords) {
10 | this(currentRecord, totalRecords, null);
11 | }
12 |
13 | public ProgressUpdateEvent(Long currentRecord, Long totalRecords, String message) {
14 | this.currentCount = currentRecord;
15 | this.totalCount = totalRecords;
16 | this.message = message;
17 | }
18 |
19 | //--- set / get methods ---------------------------------------------------
20 |
21 | public Long getCurrentCount() {
22 | return currentCount;
23 | }
24 |
25 | public void setCurrentCount(Long currentCount) {
26 | this.currentCount = currentCount;
27 | }
28 |
29 | public Long getTotalCount() {
30 | return totalCount;
31 | }
32 |
33 | public void setTotalCount(Long totalCount) {
34 | this.totalCount = totalCount;
35 | }
36 |
37 | public String getMessage() {
38 | return message;
39 | }
40 |
41 | public void setMessage(String message) {
42 | this.message = message;
43 | }
44 |
45 | }
46 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/observer/ProgressUpdateObserver.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.observer;
2 |
3 | import com.ag04.clidemo.shell.ProgressBar;
4 | import com.ag04.clidemo.shell.ShellHelper;
5 | import org.springframework.beans.factory.annotation.Autowired;
6 | import org.springframework.stereotype.Service;
7 | import org.springframework.util.StringUtils;
8 |
9 | import java.util.Observable;
10 | import java.util.Observer;
11 |
12 | @Service
13 | public class ProgressUpdateObserver implements Observer {
14 |
15 | @Autowired
16 | private ProgressBar progressBar;
17 |
18 | @Autowired
19 | private ShellHelper shellHelper;
20 |
21 | @Override
22 | public void update(Observable observable, Object event) {
23 | ProgressUpdateEvent upe = (ProgressUpdateEvent) event;
24 | int currentRecord = upe.getCurrentCount().intValue();
25 | int totalRecords = upe.getTotalCount().intValue();
26 |
27 | if (currentRecord == 0) {
28 | // just in case the previous progress bar was interrupted
29 | progressBar.reset();
30 | }
31 |
32 | String message = null;
33 | int percentage = currentRecord * 100 / totalRecords;
34 | if (StringUtils.hasText(upe.getMessage())) {
35 | message = shellHelper.getWarningMessage(upe.getMessage());
36 | progressBar.display(percentage, message);
37 | }
38 |
39 | progressBar.display(percentage, message);
40 | if (percentage == 100) {
41 | progressBar.reset();
42 | }
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/service/MockUserService.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.service;
2 |
3 | import com.ag04.clidemo.model.CliUser;
4 | import com.ag04.clidemo.observer.ProgressUpdateEvent;
5 | import com.fasterxml.jackson.core.type.TypeReference;
6 | import com.fasterxml.jackson.databind.ObjectMapper;
7 | import org.springframework.beans.factory.annotation.Autowired;
8 | import org.springframework.core.io.ClassPathResource;
9 | import org.springframework.stereotype.Service;
10 |
11 | import javax.lang.model.UnknownEntityException;
12 | import java.io.File;
13 | import java.io.IOException;
14 | import java.util.ArrayList;
15 | import java.util.List;
16 | import java.util.Observable;
17 | import java.util.Observer;
18 |
19 | /**
20 | * Mock implementation of UserService.
21 | */
22 | public class MockUserService extends Observable implements UserService {
23 |
24 | @Autowired
25 | private ObjectMapper objectMapper;
26 | private Observer observer;
27 | private List users = new ArrayList<>();
28 |
29 | @Override
30 | public CliUser findById(Long id) {
31 | for (CliUser user : users) {
32 | if (id.equals(user.getId())) {
33 | return user;
34 | }
35 | }
36 | return null;
37 | }
38 |
39 | @Override
40 | public CliUser findByUsername(String username) {
41 | for (CliUser user : users) {
42 | if (username.equals(user.getUsername())) {
43 | return user;
44 | }
45 | }
46 | return null;
47 | }
48 |
49 | @Override
50 | public List findAll() {
51 | return users;
52 | }
53 |
54 | @Override
55 | public boolean exists(String username) {
56 | for (CliUser user : users) {
57 | if (username.equals(user.getUsername())) {
58 | return true;
59 | }
60 | }
61 | return false;
62 | }
63 |
64 | @Override
65 | public CliUser create(CliUser user) {
66 | user.setId(new Long(getNextId()));
67 | users.add(user);
68 | return user;
69 | }
70 |
71 | @Override
72 | public CliUser update(CliUser user) {
73 | for(CliUser u : users) {
74 | if (u.getId().equals(user.getId())) {
75 | u = user;
76 | return user;
77 | }
78 | }
79 | throw new IllegalArgumentException("No matching user found!");
80 | }
81 |
82 | @Override
83 | public long updateAll() {
84 | long numberOfUsers = 2000;
85 | for (long i = 1; i <= numberOfUsers; i++) {
86 | // do some operation ...
87 | try {
88 | Thread.sleep(10);
89 | } catch (InterruptedException e) {
90 | e.printStackTrace();
91 | }
92 | // notify observer of the change
93 | if (observer != null) {
94 | String message = "";
95 | if (i < numberOfUsers) {
96 | message = ":: please WAIT update operation in progress";
97 | }
98 | observer.update(
99 | this,
100 | new ProgressUpdateEvent(i, numberOfUsers, message)
101 | );
102 | }
103 | }
104 | return numberOfUsers;
105 | }
106 |
107 | //--- set / get methods ---------------------------------------------------
108 |
109 | public Observer getObserver() {
110 | return observer;
111 | }
112 |
113 | public void setObserver(Observer observer) {
114 | this.observer = observer;
115 | }
116 |
117 | public ObjectMapper getObjectMapper() {
118 | return objectMapper;
119 | }
120 |
121 | public void setObjectMapper(ObjectMapper objectMapper) {
122 | this.objectMapper = objectMapper;
123 | }
124 |
125 | //--- util methods --------------------------------------------------------
126 |
127 | public void init(String filePath) throws IOException {
128 | ClassPathResource cpr = new ClassPathResource("cli-users.json");
129 | users = objectMapper.readValue(cpr.getInputStream(), new TypeReference>() { });
130 | }
131 |
132 | private long getNextId() {
133 | long maxId = 0;
134 | for(CliUser user : users) {
135 | if (user.getId().longValue() > maxId) {
136 | maxId = user.getId().longValue();
137 | }
138 | }
139 | return maxId + 1;
140 | }
141 | }
142 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/service/UserService.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.service;
2 |
3 | import com.ag04.clidemo.model.CliUser;
4 |
5 | import java.util.List;
6 |
7 | /**
8 | * Interface describing (Cli) UserService.
9 | *
10 | */
11 | public interface UserService {
12 | CliUser findById(Long id);
13 | CliUser findByUsername(String username);
14 | List findAll();
15 |
16 | boolean exists(String username);
17 | CliUser create(CliUser user);
18 | CliUser update(CliUser user);
19 | long updateAll();
20 | }
21 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/ClidemoPromptProvider.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell;
2 |
3 | import org.jline.utils.AttributedString;
4 | import org.jline.utils.AttributedStyle;
5 | import org.springframework.shell.jline.PromptProvider;
6 | import org.springframework.stereotype.Component;
7 |
8 | @Component
9 | public class ClidemoPromptProvider implements PromptProvider {
10 |
11 | @Override
12 | public AttributedString getPrompt() {
13 | return new AttributedString("CLI-DEMO:>", AttributedStyle.DEFAULT.foreground(AttributedStyle.BLUE));
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/InputReader.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell;
2 |
3 | import org.jline.reader.LineReader;
4 | import org.springframework.util.StringUtils;
5 | import java.util.*;
6 |
7 | public class InputReader {
8 |
9 | public static final Character DEFAULT_MASK = '*';
10 |
11 | private Character mask;
12 |
13 | private LineReader lineReader;
14 |
15 | private ShellHelper shellHelper;
16 |
17 | public InputReader(LineReader lineReader, ShellHelper shellHelper) {
18 | this(lineReader, shellHelper, null);
19 | }
20 |
21 | public InputReader(LineReader lineReader, ShellHelper shellHelper, Character mask) {
22 | this.lineReader = lineReader;
23 | this.shellHelper = shellHelper;
24 | this.mask = mask != null ? mask : DEFAULT_MASK;
25 | }
26 |
27 | public String prompt(String prompt) {
28 | return prompt(prompt, null, true);
29 | }
30 |
31 | public String prompt(String prompt, String defaultValue) {
32 | return prompt(prompt, defaultValue, true);
33 | }
34 |
35 | /**
36 | * Prompts user for input.
37 | *
38 | * @param prompt
39 | * @param defaultValue
40 | * @param echo
41 | * @return
42 | */
43 | public String prompt(String prompt, String defaultValue, boolean echo) {
44 | String answer = "";
45 |
46 | if (echo) {
47 | answer = lineReader.readLine(prompt + ": ");
48 | } else {
49 | answer = lineReader.readLine(prompt + ": ", mask);
50 | }
51 | if (StringUtils.isEmpty(answer)) {
52 | return defaultValue;
53 | }
54 | return answer;
55 | }
56 |
57 | /**
58 | * Loops until one of the `options` is provided. Pressing return is equivalent to
59 | * returning `defaultValue`.
60 | *
61 | * Passing null for defaultValue signifies that there is no default value.
62 | * Passing "" or null among optionsAsList means that empty answer is allowed, in these cases this method returns
63 | * empty String "" as the result of its execution.
64 | *
65 | *
66 | */
67 | public String promptWithOptions(String prompt, String defaultValue, List optionsAsList) {
68 | String answer;
69 | List allowedAnswers = new ArrayList<>(optionsAsList);
70 | if (StringUtils.hasText(defaultValue)) {
71 | allowedAnswers.add("");
72 | }
73 | do {
74 | answer = lineReader.readLine(String.format("%s %s: ", prompt, formatOptions(defaultValue, optionsAsList)));
75 | } while (!allowedAnswers.contains(answer) && !"".equals(answer));
76 |
77 | if (StringUtils.isEmpty(answer) && allowedAnswers.contains("")) {
78 | return defaultValue;
79 | }
80 | return answer;
81 | }
82 |
83 | private List formatOptions(String defaultValue, List optionsAsList) {
84 | List result = new ArrayList();
85 | for (String option : optionsAsList) {
86 | String val = option;
87 | if ("".equals(option) || option == null) {
88 | val = "''";
89 | }
90 | if (defaultValue != null ) {
91 | if (defaultValue.equals(option) || (defaultValue.equals("") && option == null)) {
92 | val = shellHelper.getInfoMessage(val);
93 | }
94 | }
95 | result.add(val);
96 | }
97 | return result;
98 | }
99 |
100 | /**
101 | * Loops until one value from the list of options is selected, printing each option on its own line.
102 | *
103 | */
104 | public String selectFromList(String headingMessage, String promptMessage, Map options, boolean ignoreCase, String defaultValue) {
105 | String answer;
106 | Set allowedAnswers = new HashSet<>(options.keySet());
107 | if (defaultValue != null && !defaultValue.equals("")) {
108 | allowedAnswers.add("");
109 | }
110 | shellHelper.print(String.format("%s: ", headingMessage));
111 | do {
112 | for (Map.Entry option: options.entrySet()) {
113 | String defaultMarker = null;
114 | if (defaultValue != null) {
115 | if (option.getKey().equals(defaultValue)) {
116 | defaultMarker = "*";
117 | }
118 | }
119 | if (defaultMarker != null) {
120 | shellHelper.printInfo(String.format("%s [%s] %s ", defaultMarker, option.getKey(), option.getValue()));
121 | } else {
122 | shellHelper.print(String.format(" [%s] %s", option.getKey(), option.getValue()));
123 | }
124 | }
125 | answer = lineReader.readLine(String.format("%s: ", promptMessage));
126 | } while (!containsString(allowedAnswers, answer, ignoreCase) && "" != answer);
127 |
128 | if (StringUtils.isEmpty(answer) && allowedAnswers.contains("")) {
129 | return defaultValue;
130 | }
131 | return answer;
132 | }
133 |
134 | private boolean containsString(Set l, String s, boolean ignoreCase){
135 | if (!ignoreCase) {
136 | return l.contains(s);
137 | }
138 | Iterator it = l.iterator();
139 | while(it.hasNext()) {
140 | if(it.next().equalsIgnoreCase(s))
141 | return true;
142 | }
143 | return false;
144 | }
145 |
146 | }
147 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/ProgressBar.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell;
2 |
3 | public class ProgressBar {
4 | private static final String CUU = "\u001B[A";
5 | private static final String DL = "\u001B[1M";
6 |
7 | private String doneMarker = "=";
8 | private String remainsMarker = "-";
9 | private String leftDelimiter = "<";
10 | private String rightDelimiter = ">";
11 |
12 | ShellHelper shellHelper;
13 |
14 | private boolean started = false;
15 |
16 | public ProgressBar(ShellHelper shellHelper) {
17 | this.shellHelper = shellHelper;
18 | }
19 |
20 | public void display(int percentage) {
21 | display(percentage, null);
22 | }
23 |
24 | public void display(int percentage, String statusMessage) {
25 | if (!started) {
26 | started = true;
27 | shellHelper.getTerminal().writer().println();
28 | }
29 | int x = (percentage/5);
30 | int y = 20-x;
31 | String message = ((statusMessage == null) ? "" : statusMessage);
32 |
33 | String done = shellHelper.getSuccessMessage(new String(new char[x]).replace("\0", doneMarker));
34 | String remains = new String(new char[y]).replace("\0", remainsMarker);
35 |
36 | String progressBar = String.format("%s%s%s%s %d", leftDelimiter, done, remains, rightDelimiter, percentage);
37 |
38 | shellHelper.getTerminal().writer().println(CUU + "\r" + DL + progressBar + "% " + message);
39 | shellHelper.getTerminal().flush();
40 | }
41 |
42 | public void reset() {
43 | started = false;
44 | }
45 |
46 | //--- set / get methods ---------------------------------------------------
47 |
48 | public String getDoneMarker() {
49 | return doneMarker;
50 | }
51 |
52 | public void setDoneMarker(String doneMarker) {
53 | this.doneMarker = doneMarker;
54 | }
55 |
56 | public String getRemainsMarker() {
57 | return remainsMarker;
58 | }
59 |
60 | public void setRemainsMarker(String remainsMarker) {
61 | this.remainsMarker = remainsMarker;
62 | }
63 |
64 | public String getLeftDelimiter() {
65 | return leftDelimiter;
66 | }
67 |
68 | public void setLeftDelimiter(String leftDelimiter) {
69 | this.leftDelimiter = leftDelimiter;
70 | }
71 |
72 | public String getRightDelimiter() {
73 | return rightDelimiter;
74 | }
75 |
76 | public void setRightDelimiter(String rightDelimiter) {
77 | this.rightDelimiter = rightDelimiter;
78 | }
79 |
80 | }
81 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/ProgressCounter.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell;
2 |
3 | import org.jline.terminal.Terminal;
4 |
5 | /**
6 | *
7 | */
8 | public class ProgressCounter {
9 | private static final String CUU = "\u001B[A";
10 |
11 | private Terminal terminal;
12 | private char[] spinner = {'|', '/', '-', '\\'};
13 |
14 | private String pattern = " %s: %d ";
15 |
16 | private boolean started = false;
17 | private int spinCounter = 0;
18 |
19 | public ProgressCounter(Terminal terminal) {
20 | this(terminal, null);
21 | }
22 |
23 | public ProgressCounter(Terminal terminal, String pattern) {
24 | this(terminal, pattern, null);
25 | }
26 |
27 | public ProgressCounter(Terminal terminal, String pattern, char[] spinner) {
28 | this.terminal = terminal;
29 |
30 | if (pattern != null) {
31 | this.pattern = pattern;
32 | }
33 | if (spinner != null) {
34 | this.spinner = spinner;
35 | }
36 | }
37 |
38 | public void display(int count, String message) {
39 | if (!started) {
40 | terminal.writer().println();
41 | started = true;
42 | }
43 | String progress = String.format(pattern, message, count);
44 |
45 | terminal.writer().println(CUU + "\r" + getSpinnerChar() + progress);
46 | terminal.flush();
47 | }
48 |
49 | public void display() {
50 | if (!started) {
51 | terminal.writer().println();
52 | started = true;
53 | }
54 | terminal.writer().println(CUU + "\r" + getSpinnerChar());
55 | terminal.flush();
56 | }
57 |
58 | public void reset() {
59 | spinCounter = 0;
60 | started = false;
61 | }
62 |
63 | private char getSpinnerChar() {
64 | char spinChar = spinner[spinCounter];
65 | spinCounter++;
66 | if (spinCounter == spinner.length) {
67 | spinCounter = 0;
68 | }
69 | return spinChar;
70 | }
71 |
72 | //--- set / get methods ---------------------------------------------------
73 |
74 | public char[] getSpinner() {
75 | return spinner;
76 | }
77 |
78 | public void setSpinner(char[] spinner) {
79 | this.spinner = spinner;
80 | }
81 |
82 | public String getPattern() {
83 | return pattern;
84 | }
85 |
86 | public void setPattern(String pattern) {
87 | this.pattern = pattern;
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/PromptColor.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell;
2 |
3 | public enum PromptColor {
4 | BLACK(0),
5 | RED(1),
6 | GREEN(2),
7 | YELLOW(3),
8 | BLUE(4),
9 | MAGENTA(5),
10 | CYAN(6),
11 | WHITE(7),
12 | BRIGHT(8);
13 |
14 | private final int value;
15 |
16 | PromptColor(int value) {
17 | this.value = value;
18 | }
19 |
20 | public int toJlineAttributedStyle() {
21 | return this.value;
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/ShellHelper.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell;
2 |
3 | import org.jline.terminal.Terminal;
4 | import org.jline.utils.AttributedStringBuilder;
5 | import org.jline.utils.AttributedStyle;
6 | import org.springframework.beans.factory.annotation.Value;
7 |
8 | public class ShellHelper {
9 |
10 | @Value("${shell.out.info}")
11 | public String infoColor;
12 |
13 | @Value("${shell.out.success}")
14 | public String successColor;
15 |
16 | @Value("${shell.out.warning}")
17 | public String warningColor;
18 |
19 | @Value("${shell.out.error}")
20 | public String errorColor;
21 |
22 | private Terminal terminal;
23 |
24 | public ShellHelper(Terminal terminal) {
25 | this.terminal = terminal;
26 | }
27 |
28 | /**
29 | * Construct colored message in the given color.
30 | *
31 | * @param message message to return
32 | * @param color color to print
33 | * @return colored message
34 | */
35 | public String getColored(String message, PromptColor color) {
36 | return (new AttributedStringBuilder()).append(message, AttributedStyle.DEFAULT.foreground(color.toJlineAttributedStyle())).toAnsi();
37 | }
38 |
39 | public String getInfoMessage(String message) {
40 | return getColored(message, PromptColor.valueOf(infoColor));
41 | }
42 |
43 | public String getSuccessMessage(String message) {
44 | return getColored(message, PromptColor.valueOf(successColor));
45 | }
46 |
47 | public String getWarningMessage(String message) {
48 | return getColored(message, PromptColor.valueOf(warningColor));
49 | }
50 |
51 | public String getErrorMessage(String message) {
52 | return getColored(message, PromptColor.valueOf(errorColor));
53 | }
54 |
55 | //--- Print methods -------------------------------------------------------
56 |
57 | /**
58 | * Print message to the console in the default color.
59 | *
60 | * @param message message to print
61 | */
62 | public void print(String message) {
63 | print(message, null);
64 | }
65 |
66 | /**
67 | * Print message to the console in the success color.
68 | *
69 | * @param message message to print
70 | */
71 | public void printSuccess(String message) {
72 | print(message, PromptColor.valueOf(successColor));
73 | }
74 |
75 | /**
76 | * Print message to the console in the info color.
77 | *
78 | * @param message message to print
79 | */
80 | public void printInfo(String message) {
81 | print(message, PromptColor.valueOf(infoColor));
82 | }
83 |
84 | /**
85 | * Print message to the console in the warning color.
86 | *
87 | * @param message message to print
88 | */
89 | public void printWarning(String message) {
90 | print(message, PromptColor.valueOf(warningColor));
91 | }
92 |
93 | /**
94 | * Print message to the console in the error color.
95 | *
96 | * @param message message to print
97 | */
98 | public void printError(String message) {
99 | print(message, PromptColor.valueOf(errorColor));
100 | }
101 |
102 | /**
103 | * Generic Print to the console method.
104 | *
105 | * @param message message to print
106 | * @param color (optional) prompt color
107 | */
108 | public void print(String message, PromptColor color) {
109 | String toPrint = message;
110 | if (color != null) {
111 | toPrint = getColored(message, color);
112 | }
113 | terminal.writer().println(toPrint);
114 | terminal.flush();
115 | }
116 |
117 | //--- set / get methods ---------------------------------------------------
118 |
119 | public Terminal getTerminal() {
120 | return terminal;
121 | }
122 |
123 | public void setTerminal(Terminal terminal) {
124 | this.terminal = terminal;
125 | }
126 | }
127 |
--------------------------------------------------------------------------------
/src/main/java/com/ag04/clidemo/shell/table/BeanTableModelBuilder.java:
--------------------------------------------------------------------------------
1 | package com.ag04.clidemo.shell.table;
2 |
3 | import com.fasterxml.jackson.core.type.TypeReference;
4 | import com.fasterxml.jackson.databind.ObjectMapper;
5 | import org.springframework.shell.table.ArrayTableModel;
6 | import org.springframework.shell.table.TableModel;
7 | import java.util.LinkedHashMap;
8 | import java.util.Map;
9 |
10 | public class BeanTableModelBuilder {
11 |
12 | private ObjectMapper objectMapper;
13 | private Object bean;
14 | private LinkedHashMap labels;
15 | private String[] header;
16 |
17 |
18 | public BeanTableModelBuilder(Object bean, ObjectMapper objectMapper) {
19 | this.bean = bean;
20 | this.objectMapper = objectMapper;
21 | }
22 |
23 | public BeanTableModelBuilder withLabels(LinkedHashMap labels) {
24 | this.labels = labels;
25 | return this;
26 | }
27 |
28 | public BeanTableModelBuilder withHeader(String[] header) {
29 | this.header = header;
30 | return this;
31 | }
32 |
33 | public TableModel build() {
34 | Map map = objectMapper.convertValue(bean, new TypeReference