vedeu 0.8.1 → 0.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. checksums.yaml +4 -4
  2. data/docs/api.md +0 -357
  3. data/docs/configuration.md +1 -1
  4. data/docs/dsl/by_method/add_command.md +5 -0
  5. data/docs/dsl/by_method/add_keypress.md +4 -0
  6. data/docs/dsl/by_method/all_commands.md +3 -0
  7. data/docs/dsl/by_method/all_keypresses.md +3 -0
  8. data/docs/dsl/by_method/background_colours.md +4 -0
  9. data/docs/dsl/by_method/bind.md +43 -0
  10. data/docs/dsl/by_method/bind_alias.md +4 -0
  11. data/docs/dsl/by_method/borders.md +6 -0
  12. data/docs/dsl/by_method/bound.md +3 -0
  13. data/docs/dsl/by_method/buffer_update.md +1 -0
  14. data/docs/dsl/by_method/buffer_write.md +1 -0
  15. data/docs/dsl/by_method/buffers.md +5 -0
  16. data/docs/dsl/by_method/clear_by_group.md +1 -0
  17. data/docs/dsl/by_method/clear_by_name.md +1 -0
  18. data/docs/dsl/by_method/clear_content_by_name.md +1 -0
  19. data/docs/dsl/by_method/clock_time.md +1 -0
  20. data/docs/dsl/by_method/cursor.md +1 -0
  21. data/docs/dsl/by_method/cursors.md +1 -0
  22. data/docs/dsl/by_method/direct_write.md +1 -0
  23. data/docs/dsl/by_method/documents.md +1 -0
  24. data/docs/dsl/by_method/drb_restart.md +1 -0
  25. data/docs/dsl/by_method/drb_start.md +1 -0
  26. data/docs/dsl/by_method/drb_status.md +1 -0
  27. data/docs/dsl/by_method/drb_stop.md +1 -0
  28. data/docs/dsl/by_method/events.md +1 -0
  29. data/docs/dsl/by_method/exit.md +1 -0
  30. data/docs/dsl/by_method/focus.md +1 -0
  31. data/docs/dsl/by_method/focus_by_name.md +1 -0
  32. data/docs/dsl/by_method/focus_next.md +1 -0
  33. data/docs/dsl/by_method/focus_previous.md +1 -0
  34. data/docs/dsl/by_method/focussed.md +1 -0
  35. data/docs/dsl/by_method/geometries.md +1 -0
  36. data/docs/dsl/by_method/geometry.md +1 -0
  37. data/docs/dsl/by_method/goto.md +5 -6
  38. data/docs/dsl/by_method/group.md +1 -0
  39. data/docs/dsl/by_method/groups.md +1 -0
  40. data/docs/dsl/by_method/hide_cursor.md +1 -0
  41. data/docs/dsl/by_method/hide_group.md +1 -0
  42. data/docs/dsl/by_method/hide_interface.md +1 -0
  43. data/docs/dsl/by_method/interface.md +1 -0
  44. data/docs/dsl/by_method/interfaces.md +1 -0
  45. data/docs/dsl/by_method/keymap.md +1 -0
  46. data/docs/dsl/by_method/keymap/interface.md +1 -0
  47. data/docs/dsl/by_method/keymap/key.md +1 -0
  48. data/docs/dsl/by_method/keymap/name.md +1 -0
  49. data/docs/dsl/by_method/keymaps.md +1 -0
  50. data/docs/dsl/by_method/last_command.md +4 -0
  51. data/docs/dsl/by_method/last_keypress.md +4 -0
  52. data/docs/dsl/by_method/log.md +1 -0
  53. data/docs/dsl/by_method/log_stderr.md +1 -0
  54. data/docs/dsl/by_method/log_stdout.md +1 -0
  55. data/docs/dsl/by_method/log_timestamp.md +1 -0
  56. data/docs/dsl/by_method/menu.md +1 -0
  57. data/docs/dsl/by_method/menus.md +1 -0
  58. data/docs/dsl/by_method/read.md +33 -0
  59. data/docs/dsl/by_method/ready.md +1 -0
  60. data/docs/dsl/by_method/render.md +1 -0
  61. data/docs/dsl/by_method/render_output.md +1 -0
  62. data/docs/dsl/by_method/renderer.md +1 -0
  63. data/docs/dsl/by_method/renderers.md +1 -0
  64. data/docs/dsl/by_method/renders.md +1 -0
  65. data/docs/dsl/by_method/show_cursor.md +1 -0
  66. data/docs/dsl/by_method/show_group.md +1 -0
  67. data/docs/dsl/by_method/show_interface.md +1 -0
  68. data/docs/dsl/by_method/toggle_cursor.md +1 -0
  69. data/docs/dsl/by_method/toggle_group.md +1 -0
  70. data/docs/dsl/by_method/toggle_interface.md +1 -0
  71. data/docs/dsl/by_method/trigger.md +1 -0
  72. data/docs/dsl/by_method/unbind.md +5 -0
  73. data/docs/dsl/by_method/unbind_alias.md +4 -0
  74. data/docs/dsl/by_method/views.md +1 -0
  75. data/docs/dsl/by_method/write.md +5 -0
  76. data/examples/views/lines_streams.rb +45 -0
  77. data/lib/vedeu/application/application_view.rb +1 -1
  78. data/lib/vedeu/borders/border.rb +2 -2
  79. data/lib/vedeu/cells/border.rb +1 -1
  80. data/lib/vedeu/cells/borders/bottom_horizontal.rb +1 -1
  81. data/lib/vedeu/cells/borders/bottom_left.rb +1 -1
  82. data/lib/vedeu/cells/borders/bottom_right.rb +1 -1
  83. data/lib/vedeu/cells/borders/horizontal.rb +1 -1
  84. data/lib/vedeu/cells/borders/left_vertical.rb +1 -1
  85. data/lib/vedeu/cells/borders/right_vertical.rb +1 -1
  86. data/lib/vedeu/cells/borders/top_horizontal.rb +1 -1
  87. data/lib/vedeu/cells/borders/top_left.rb +1 -1
  88. data/lib/vedeu/cells/borders/top_right.rb +1 -1
  89. data/lib/vedeu/cells/borders/vertical.rb +1 -1
  90. data/lib/vedeu/colours/background.rb +1 -1
  91. data/lib/vedeu/colours/foreground.rb +1 -1
  92. data/lib/vedeu/colours/translator.rb +4 -7
  93. data/lib/vedeu/colours/validator.rb +1 -1
  94. data/lib/vedeu/configuration/api.rb +1 -1
  95. data/lib/vedeu/configuration/configuration.rb +20 -11
  96. data/lib/vedeu/cursors/cursor.rb +2 -2
  97. data/lib/vedeu/distributed/server.rb +7 -7
  98. data/lib/vedeu/dsl/views.rb +1 -1
  99. data/lib/vedeu/esc/background.rb +1 -1
  100. data/lib/vedeu/esc/colours.rb +3 -0
  101. data/lib/vedeu/esc/esc.rb +11 -25
  102. data/lib/vedeu/esc/mouse.rb +14 -0
  103. data/lib/vedeu/events/aliases.rb +2 -13
  104. data/lib/vedeu/events/event.rb +2 -13
  105. data/lib/vedeu/input/read.rb +3 -3
  106. data/lib/vedeu/input/store.rb +6 -37
  107. data/lib/vedeu/interfaces/interface.rb +1 -1
  108. data/lib/vedeu/logging/debug.rb +1 -1
  109. data/lib/vedeu/logging/log.rb +6 -17
  110. data/lib/vedeu/logging/timer.rb +1 -1
  111. data/lib/vedeu/models/row.rb +1 -1
  112. data/lib/vedeu/output/write.rb +1 -3
  113. data/lib/vedeu/presentation/style.rb +1 -3
  114. data/lib/vedeu/renderers/all.rb +2 -2
  115. data/lib/vedeu/renderers/file.rb +1 -1
  116. data/lib/vedeu/renderers/options.rb +1 -1
  117. data/lib/vedeu/runtime/application.rb +10 -19
  118. data/lib/vedeu/runtime/bootstrap.rb +4 -4
  119. data/lib/vedeu/runtime/launcher.rb +3 -5
  120. data/lib/vedeu/terminal/mode.rb +1 -1
  121. data/lib/vedeu/terminal/terminal.rb +9 -10
  122. data/lib/vedeu/version.rb +1 -1
  123. data/lib/vedeu/views/char.rb +1 -1
  124. data/lib/vedeu/views/view.rb +1 -1
  125. data/test/lib/vedeu/colours/background_test.rb +1 -1
  126. data/test/lib/vedeu/configuration/api_test.rb +1 -1
  127. data/test/lib/vedeu/cursors/cursor_test.rb +2 -5
  128. data/test/lib/vedeu/distributed/server_test.rb +2 -2
  129. data/test/lib/vedeu/esc/mouse_test.rb +29 -1
  130. data/test/lib/vedeu/logging/timer_test.rb +2 -2
  131. data/test/lib/vedeu/renderers/html_test.rb +1 -1
  132. data/test/lib/vedeu/renderers/json_test.rb +1 -1
  133. data/test/lib/vedeu/renderers/options_test.rb +4 -4
  134. data/test/lib/vedeu/runtime/application_test.rb +4 -9
  135. data/test/lib/vedeu/runtime/bootstrap_test.rb +1 -1
  136. data/test/lib/vedeu/runtime/launcher_test.rb +1 -1
  137. data/test/lib/vedeu/terminal/mode_test.rb +5 -5
  138. data/test/lib/vedeu/terminal/terminal_test.rb +2 -2
  139. data/test/support/examples/material_colours_app.rb +2 -5
  140. data/test/test_helper.rb +1 -1
  141. metadata +5 -3
  142. data/examples/views/lines_streams_stream.rb +0 -48
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 60d8aaa6126ec4e15edc18e5b0c7be8a932e500c
4
- data.tar.gz: 71f61ddeb4937aa1992866756386748430a64172
3
+ metadata.gz: e72a4e701c2e16801c6f4b3116cf8ba40a54bfd2
4
+ data.tar.gz: e09f9047d8aa9b5c8ac2bcda49bbf6cacded29b5
5
5
  SHA512:
6
- metadata.gz: 00cf06475482f5dc6f3ef13c20725f7d67017446c2023a160f460cbf1f3558eb353a49e98db310a721eb7051b25c53baf6053f9de79870b437c87029e5f08806
7
- data.tar.gz: 2504ea7c128679347dc7e207ff48edfc601c4870bd2e81fe0e1ccbd301d7219bfc747c9925808e096facad2ed157c65724f5f1d83de482dea2e7b573cd8d46bc
6
+ metadata.gz: 1e5438cae3e71924368025179a9556252eb2e255cfd1fd3cd470ebecb8f41ab95991d1279fe160cecae30ae841acb2db7497c6954207d2485c340127d1f993db
7
+ data.tar.gz: f3fb017c495bdb18c6a6eb327a04b69776e181f81b1a27535dd4cdc985b6971c8ff80df58a7697ef40f853e276fc4054632299defb7c3b8ed5032ec60feb04bf
@@ -129,110 +129,6 @@ See {file:docs/events.md}
129
129
  - items
130
130
  - name
131
131
 
132
-
133
- # API Methods
134
-
135
- ### Vedeu.add_command
136
-
137
- @todo Add more documentation.
138
-
139
- ### Vedeu.add_keypress
140
-
141
- @todo Add more documentation.
142
-
143
- ### Vedeu.all_commands
144
-
145
- Returns an array of all commands received by Vedeu.
146
-
147
- @todo Add more documentation.
148
-
149
- ### Vedeu.all_keypresses
150
-
151
- Returns an array of all keypresses received by Vedeu.
152
-
153
- @todo Add more documentation.
154
-
155
- ### Vedeu.background_colours
156
-
157
- Repository method. Access registered background colours.
158
-
159
- Vedeu.background_colours # => [Vedeu::Colours::Backgrounds]
160
-
161
- Vedeu.background_colours.all # => [Hash<String => String>]
162
-
163
-
164
- ### Vedeu.bind
165
-
166
- @todo Add more documentation.
167
-
168
- ### Vedeu.bind_alias
169
-
170
- @todo Add more documentation.
171
-
172
- ### Vedeu.border
173
-
174
- See {Vedeu::DSL::Border::ClassMethods.border}
175
-
176
- ### Vedeu.borders
177
-
178
- Repository method. Access registered borders.
179
-
180
- Vedeu.borders # [Vedeu::Borders::Repository]
181
-
182
- Vedeu.borders.all # [Array<Vedeu::Borders::Border>]
183
-
184
- ### Vedeu.bound?
185
-
186
- @todo Add more documentation.
187
-
188
- ### Vedeu.buffer_update
189
-
190
- @todo Add more documentation.
191
-
192
- ### Vedeu.buffer_write
193
-
194
- @todo Add more documentation.
195
-
196
- ### Vedeu.buffers
197
-
198
- Repository method. Access registered borders.
199
-
200
- Vedeu.buffers # [Vedeu::Buffers::Repository]
201
-
202
- Vedeu.buffers.all # [Array<Vedeu::Buffers::Buffer>]
203
-
204
- ### Vedeu.clear
205
-
206
- @todo Add more documentation.
207
-
208
- ### Vedeu.clear_by_group
209
-
210
- @todo Add more documentation.
211
-
212
- ### Vedeu.clear_by_name
213
-
214
- @todo Add more documentation.
215
-
216
- ### Vedeu.clear_content_by_name
217
-
218
- @todo Add more documentation.
219
-
220
- ### Vedeu.clock_time
221
-
222
- @todo Add more documentation.
223
-
224
- ### Vedeu.configuration
225
-
226
- @todo Add more documentation.
227
-
228
- ### Vedeu.configure
229
-
230
- @todo Add more documentation.
231
-
232
- ### Vedeu.cursor
233
-
234
- @todo Add more documentation.
235
-
236
132
  ### Vedeu.cursors
237
133
 
238
134
  Repository method. Access registered cursors.
@@ -241,34 +137,6 @@ Repository method. Access registered cursors.
241
137
 
242
138
  Vedeu.cursors.all # [Array<Vedeu::Cursors::Cursor>]
243
139
 
244
- ### Vedeu.debug
245
-
246
- @todo Add more documentation.
247
-
248
- ### Vedeu.direct_write
249
-
250
- @todo Add more documentation.
251
-
252
- ### Vedeu.documents
253
-
254
- @todo Add more documentation.
255
-
256
- ### Vedeu.drb_restart
257
-
258
- @todo Add more documentation.
259
-
260
- ### Vedeu.drb_start
261
-
262
- @todo Add more documentation.
263
-
264
- ### Vedeu.drb_status
265
-
266
- @todo Add more documentation.
267
-
268
- ### Vedeu.drb_stop
269
-
270
- @todo Add more documentation.
271
-
272
140
  ### Vedeu.events
273
141
 
274
142
  Repository method. Access registered events.
@@ -277,34 +145,6 @@ Repository method. Access registered events.
277
145
 
278
146
  Vedeu.events.all # [Array<Vedeu::Events::Collection>]
279
147
 
280
- ### Vedeu.exit
281
-
282
- @todo Add more documentation.
283
-
284
- ### Vedeu.focus
285
-
286
- @todo Add more documentation.
287
-
288
- ### Vedeu.focus?
289
-
290
- @todo Add more documentation.
291
-
292
- ### Vedeu.focus_by_name
293
-
294
- @todo Add more documentation.
295
-
296
- ### Vedeu.focus_next
297
-
298
- @todo Add more documentation.
299
-
300
- ### Vedeu.focus_previous
301
-
302
- @todo Add more documentation.
303
-
304
- ### Vedeu.focussed?
305
-
306
- @todo Add more documentation.
307
-
308
148
  ### Vedeu.foreground_colours
309
149
 
310
150
  Show all the registered foreground colours.
@@ -321,17 +161,6 @@ Repository method. Access registered interface/view geometry.
321
161
 
322
162
  Vedeu.geometries.all # [Array<Vedeu::Geometries::Geometry>]
323
163
 
324
- ### Vedeu.geometry
325
-
326
- @todo Add more documentation.
327
-
328
- ### Vedeu.goto
329
-
330
- @todo Add more documentation.
331
-
332
- ### Vedeu.group
333
-
334
- @todo Add more documentation.
335
164
 
336
165
  ### Vedeu.groups
337
166
 
@@ -341,26 +170,6 @@ Repository method. Access registered groups.
341
170
 
342
171
  Vedeu.groups.all # [Array<Vedeu::Groups::Group>]
343
172
 
344
- ### Vedeu.height
345
-
346
- @todo Add more documentation.
347
-
348
- ### Vedeu.hide_cursor
349
-
350
- See {file:docs/cursors.md#vedeuhide_cursor__}
351
-
352
- ### Vedeu.hide_group
353
-
354
- @todo Add more documentation.
355
-
356
- ### Vedeu.hide_interface
357
-
358
- @todo Add more documentation.
359
-
360
- ### Vedeu.interface
361
-
362
- @todo Add more documentation.
363
-
364
173
  ### Vedeu.interfaces
365
174
 
366
175
  Repository method. Access registered interfaces.
@@ -369,10 +178,6 @@ Repository method. Access registered interfaces.
369
178
 
370
179
  Vedeu.interfaces.all # [Array<Vedeu::Interfaces::Interface>]
371
180
 
372
- ### Vedeu.keymap
373
-
374
- @todo Add more documentation.
375
-
376
181
  ### Vedeu.keymaps
377
182
 
378
183
  Repository method. Access registered keymaps.
@@ -381,46 +186,6 @@ Repository method. Access registered keymaps.
381
186
 
382
187
  Vedeu.keymaps.all # [Array<Vedeu::Input::Keymap>]
383
188
 
384
- ### Vedeu.keypress
385
-
386
- @todo Add more documentation.
387
-
388
- ### Vedeu.keys
389
-
390
- @todo Add more documentation.
391
-
392
- ### Vedeu.last_command
393
-
394
- Returns the last command entered into Vedeu.
395
-
396
- @todo Add more documentation.
397
-
398
- ### Vedeu.last_keypress
399
-
400
- Returns the last keypress entered into Vedeu.
401
-
402
- @todo Add more documentation.
403
-
404
- ### Vedeu.log
405
-
406
- @todo Add more documentation.
407
-
408
- ### Vedeu.log_stderr
409
-
410
- @todo Add more documentation.
411
-
412
- ### Vedeu.log_stdout
413
-
414
- @todo Add more documentation.
415
-
416
- ### Vedeu.log_timestamp
417
-
418
- @todo Add more documentation.
419
-
420
- ### Vedeu.menu
421
-
422
- @todo Add more documentation.
423
-
424
189
  ### Vedeu.menus
425
190
 
426
191
  Repository method. Access registered menus.
@@ -429,62 +194,6 @@ Repository method. Access registered menus.
429
194
 
430
195
  Vedeu.menus.all # [Array<Vedeu::Menus::Menu>]
431
196
 
432
- ### Vedeu.profile
433
-
434
- @todo Add more documentation.
435
-
436
- ### Vedeu.read
437
-
438
- This allows the direct reading from the terminal, unencumbered by the
439
- framework.
440
-
441
- Vedeu.read("some input here") # => programmatic cooked mode
442
- # (default)
443
-
444
- Vedeu.read("\e[24;2~", mode: :raw) # => programmatic raw mode
445
- # (provides :shift_f12 in
446
- # this example)
447
-
448
- Vedeu.read(nil, mode: :raw) # => for a single keypress
449
-
450
- Vedeu.read(nil, mode: :cooked) # => (default mode) for a 'line at
451
- # a time' (pressing 'return'
452
- # ends the line)
453
-
454
- The way that these are used will depend on the mode your terminal is currently set to. Vedeu by default sets this to `:raw` (single character, hidden cursor). `Vedeu.read` by default expects the terminal to be in `:cooked` mode unless you provide the `mode: :raw` option.
455
-
456
- - In `:cooked` mode (default), it will trigger a `:_command_` event
457
- with the input provided, meaning you should bind to :command to
458
- receive the input.
459
- - In `:raw` mode, it will trigger a `:_keypress_` event with the input
460
- provided, meaning you should bind to `:key` to receive the input.
461
-
462
- You can also access the input given using the API methods:
463
-
464
- Vedeu.all_commands
465
- Vedeu.all_keypresses
466
- Vedeu.last_command
467
- Vedeu.last_keypress
468
-
469
- ### Vedeu.ready!
470
-
471
- @todo Add more documentation.
472
-
473
- ### Vedeu.ready?
474
-
475
- @todo Add more documentation.
476
-
477
- ### Vedeu.refresh
478
-
479
- @todo Add more documentation.
480
-
481
- ### Vedeu.render
482
-
483
- @todo Add more documentation.
484
-
485
- ### Vedeu.render_output
486
-
487
- @todo Add more documentation.
488
197
 
489
198
  ### Vedeu.renderers
490
199
 
@@ -492,69 +201,3 @@ Repository method. Access registered renderers.
492
201
 
493
202
  Vedeu.renderers # [Vedeu::Renderers]
494
203
 
495
- ### Vedeu.renders
496
-
497
- @todo Add more documentation.
498
-
499
- ### Vedeu.renders
500
-
501
- @todo Add more documentation.
502
-
503
- ### Vedeu.resize
504
-
505
- @todo Add more documentation.
506
-
507
- ### Vedeu.show_cursor
508
-
509
- See {file:docs/cursors.md#vedeushow_cursor__}
510
-
511
- ### Vedeu.show_group
512
-
513
- @todo Add more documentation.
514
-
515
- ### Vedeu.show_interface
516
-
517
- @todo Add more documentation.
518
-
519
- ### Vedeu.timer
520
-
521
- @todo Add more documentation.
522
-
523
- ### Vedeu.toggle_cursor
524
-
525
- See {file:docs/cursors.md#vedeutoggle_cursor__}
526
-
527
- ### Vedeu.toggle_group
528
-
529
- @todo Add more documentation.
530
-
531
- ### Vedeu.toggle_interface
532
-
533
- @todo Add more documentation.
534
-
535
- ### Vedeu.trigger
536
-
537
- @todo Add more documentation.
538
-
539
- ### Vedeu.unbind
540
-
541
- @todo Add more documentation.
542
-
543
- ### Vedeu.view
544
-
545
- @todo Add more documentation.
546
-
547
- ### Vedeu.views
548
-
549
- @todo Add more documentation.
550
-
551
- ### Vedeu.width
552
-
553
- @todo Add more documentation.
554
-
555
- ### Vedeu.write
556
-
557
- This allows the direct writing to the terminal, unencumbered by the
558
- framework.
559
-
560
- @todo Add more documentation.
@@ -14,7 +14,7 @@ If you need to access the value of Vedeu's configuration for whatever
14
14
  reason, simply ask for it:
15
15
 
16
16
  # => The current value of 'base_path'
17
- Vedeu.configuration.base_path
17
+ Vedeu.config.base_path
18
18
 
19
19
  ## Configuration Options
20
20
 
@@ -0,0 +1,5 @@
1
+ Add a command (a collection of characters/keypresses from a
2
+ Vedeu::Editor::Document) to the store. Used by Vedeu internally to
3
+ store commands entered.
4
+
5
+ Vedeu.add_command(:some_command)
@@ -0,0 +1,4 @@
1
+ Add a keypress to the store. Used by Vedeu internally to store a
2
+ keypress entered.
3
+
4
+ Vedeu.add_keypress(:escape)
@@ -0,0 +1,3 @@
1
+ Returns an array of all commands received by Vedeu.
2
+
3
+ Vedeu.all_commands