the great rename - Githubissues

kukeiko commented 1 year ago

What & Why

Rename all the things that have bad naming!

[x] Query to EntityQuery
- name collision with Query from Angular & NestJS
[x] reduce to subtract
- confusing due to it doing something completely different than Array.reduce()
- subtract is the mathematically correct name
- in the context of criteria, the rename is going to be a bit confusing: A.reduce(B) means B - A, if i were to rename reduce() to subtract() it would read: A.subtract(B) which would instead suggest A - B. So instead I'll go for "subtractFrom" for Criteria and look into feasibility of changing all call sites to switch the criteria around so we can have A.subtract(b) (or even A.minus(B)?)
[x] QueryStream to EntityStream
- because the focus on those streams is on Entities, not Queries
[x] Template to Shape
- Template is a very generic term, I think Shape might be a bit more descriptive
[x] remap to reshape
[x] Expansion to EntitySelection
- Expansion was taken from OData; but without prior knowledge it might not be too insightful in what it is. the term Selection should be clearer, as you also use select in SQL to pick the fields you want.
- can not just use Selection due to naming collision with globally available (in browser) Selection interface (also, since Query is now named EntityQuery, it is good to prefix it with Entity anyways)
[x] Workspace to EntityWorkspace
[x] Blueprint to EntityBlueprint

kukeiko commented 1 year ago

still some reduce renames necessary, also, I didn't look into this at all:

feasibility of changing all call sites to switch the criteria around so we can have A.subtract(b)

kukeiko commented 11 months ago

want to close this item, but before I do that, a reminder to myself to first deal with the open thing mentioned in my previous comment:

feasibility of changing all call sites to switch the criteria around so we can have A.subtract(b)

kukeiko commented 11 months ago

closing this, my intention for

feasibility of changing all call sites to switch the criteria around so we can have A.subtract(b)

Is to not do it, as I am currently thinking of not having the subtraction logic be within the classes at all, see #102