view.love/Manual_tests.md

I care a lot about being able to automatically check _any_ property about my
program before it ever runs. However, some things don't have tests yet, either
because I don't know how to test them or because I've been lazy. I'll at least
record those here.

Startup:
    - terminal log shows unit tests running

Initializing settings:
    - delete app settings, start; window opens running the text editor
    - quit while running the text editor, restart; window opens running the text editor in same position+dimensions
    - quit while editing source (color; no selection), restart; window opens editing source in same position+dimensions
    - start out running the text editor, move window, press ctrl+e twice; window is running text editor in same position+dimensions
    - start out editing source, move window, press ctrl+e twice; window is editing source in same position+dimensions
    - no log file; switching to source works

Code loading:
* run love with directory; text editor runs
* run love with zip file; text editor runs

* How the screen looks. Our tests use a level of indirection to check text and
  graphics printed to screen, but not the precise pixels they translate to.
    - where exactly the cursor is drawn to highlight a given character
    - analogously, how a shape precisely looks as you draw it

* start out running the text editor, press ctrl+e to edit source, make a change to the source, press ctrl+e twice to return to the source editor; the change should be preserved.

### Other compromises

Lua is dynamically typed. Tests can't patch over lack of type-checking.

* All strings are UTF-8. Bytes within them are not characters. I try to label
  byte offsets with the suffix `_offset`, and character positions as `_pos`.
  For example, `string.sub` should never use a `_pos` to substring, only an
  `_offset`.

* Some ADT/interface support would be helpful in keeping per-line state in
  sync. Any change to line data should clear line `fragments` and
  `screen_line_starting_pos`.

* Some inputs get processed in love.textinput and some in love.keypressed.
  Several bugs have arisen due to destructive interference between the two for
  some key chord. I wish I could guarantee that the two sets are disjoint. But
  perhaps I'm not thinking about this right.

* Like any high-level language, it's easy to accidentally alias two non-scalar
  variables. I wish there was a way to require copy when assigning.

* I wish I could require pixel coordinates to integers. The editor defensively
  converts input margins to integers.

* My test harness automatically runs `test_*` methods -- but only at the
  top-level. I wish there was a way to raise warnings if someone defines such
  a function inside a dict somewhere.
a little more prose describing manual_tests 2022-06-14 22:14:08 +00:00			`I care a lot about being able to automatically check _any_ property about my`
all pending manual tests done! 2022-06-15 05:47:49 +00:00			`program before it ever runs. However, some things don't have tests yet, either`
			`because I don't know how to test them or because I've been lazy. I'll at least`
			`record those here.`
a little more prose describing manual_tests 2022-06-14 22:14:08 +00:00
editing source code from within the app integrated from pong.love: https://merveilles.town/@akkartik/108933336531898243 2022-09-03 20:54:38 +00:00			`Startup:`
			`- terminal log shows unit tests running`

			`Initializing settings:`
			`- delete app settings, start; window opens running the text editor`
			`- quit while running the text editor, restart; window opens running the text editor in same position+dimensions`
			`- quit while editing source (color; no selection), restart; window opens editing source in same position+dimensions`
			`- start out running the text editor, move window, press ctrl+e twice; window is running text editor in same position+dimensions`
			`- start out editing source, move window, press ctrl+e twice; window is editing source in same position+dimensions`
			`- no log file; switching to source works`

			`Code loading:`
			`* run love with directory; text editor runs`
			`* run love with zip file; text editor runs`
reorg manual tests doc 2022-07-20 15:53:31 +00:00
bugfix: where cursor is drawn The published version of lines.love was broken for almost an hour. The cursor would render one position to the right of where it really is. To fix it, this commit rolls back 26ba6e4e5a71. There doesn't seem a good way to test it. 2022-07-20 16:11:29 +00:00			`* How the screen looks. Our tests use a level of indirection to check text and`
			`graphics printed to screen, but not the precise pixels they translate to.`
			`- where exactly the cursor is drawn to highlight a given character`
bugfix: imprecision in drawing scenario: slowly press down mouse button and drag to draw a line release mouse button Before this commit the point would jump just a little bit on release, and points would go slightly to the left of where I expect. Yet another thing it's hard to write an automated test for. 2022-08-04 01:40:07 +00:00			`- analogously, how a shape precisely looks as you draw it`
bugfix: where cursor is drawn The published version of lines.love was broken for almost an hour. The cursor would render one position to the right of where it really is. To fix it, this commit rolls back 26ba6e4e5a71. There doesn't seem a good way to test it. 2022-07-20 16:11:29 +00:00
editing source code from within the app integrated from pong.love: https://merveilles.town/@akkartik/108933336531898243 2022-09-03 20:54:38 +00:00			`* start out running the text editor, press ctrl+e to edit source, make a change to the source, press ctrl+e twice to return to the source editor; the change should be preserved.`

reorg manual tests doc 2022-07-20 15:53:31 +00:00			`### Other compromises`
a little more prose describing manual_tests 2022-06-14 22:14:08 +00:00
			`Lua is dynamically typed. Tests can't patch over lack of type-checking.`

			`* All strings are UTF-8. Bytes within them are not characters. I try to label`
clearer copy 2022-06-20 15:24:56 +00:00			byte offsets with the suffix `_offset`, and character positions as `_pos`.
			For example, `string.sub` should never use a `_pos` to substring, only an
			`_offset`.
bugfix State changes when inserting return are now in sync with other characters. 2022-06-21 14:20:25 +00:00
			`* Some ADT/interface support would be helpful in keeping per-line state in`
			sync. Any change to line data should clear line `fragments` and
			`screen_line_starting_pos`.
record one more case I can't automatically detect 2022-06-23 18:41:29 +00:00
			`* Some inputs get processed in love.textinput and some in love.keypressed.`
			`Several bugs have arisen due to destructive interference between the two for`
			`some key chord. I wish I could guarantee that the two sets are disjoint. But`
			`perhaps I'm not thinking about this right.`
bugfix: manage screen_top and cursor when resizing 2022-07-01 17:30:52 +00:00
			`* Like any high-level language, it's easy to accidentally alias two non-scalar`
			`variables. I wish there was a way to require copy when assigning.`
ugh, handle absolute as well as relative paths 2022-07-01 20:55:43 +00:00
require editor margins to be ints Not directly relevant here, but forks of this project that permit zooming can run into weird glitches if margins are not a whole number of pixels. I'd always assumed a type system that divided ints into floats was strictly superior, but now I have experienced a situation where requiring ints isn't just a compromise for the underlying CPU implementation. Particularly since Lua's print() silently hides really tiny fractions. 2022-12-24 00:57:04 +00:00			`* I wish I could require pixel coordinates to integers. The editor defensively`
			`converts input margins to integers.`

experiment: new edit namespace Still lots to do, but the eventual hope is that this will make this project's code easier to reuse from other LÖVE projects. One gotcha: even as we start putting code more aggressively into nested tables, tests must remain at the top-level. Otherwise they won't run. 2022-07-12 05:14:59 +00:00			* My test harness automatically runs `test_*` methods -- but only at the
			`top-level. I wish there was a way to raise warnings if someone defines such`
			`a function inside a dict somewhere.`