We're updating the issue view to help you get more done. 

Use the "Step" suffix instead of the "Context" suffix in DSLs

Description

Because:

  1. We already have other classes that really are contexts, such as the SessionContext. These are about something fundamentally different: providing information about the... context in which an operation happens.

  2. The "Context" suffix leads to unclear names for DSL interfaces. If we consider the interface to be a context, we intuitively want to name it according to which context it represents . See for example SearchQueryResultDefinitionContext: it's awkward, but we can't tell what the context is because this interface is returned by methods in different modules. Then we have SearchQueryResultContext (after the result has been defined) and SearchQueryContext (after the ... query has been defined?). It's all inconsistent.
    With a "Step" suffix, it would make more sense to name the interfaces after what their main focus is than after where they come from. We could go with SearchQueryResultStep, SearchQueryPredicateStep, SearchQueryOptionsStep, which would be straightforward.
    Similarly strange is SearchPredicateFactoryContext, which could become SearchPredicateTypeStep.

  3. A "Step" suffix, in my opinion, makes it clearer that the object is transient by nature and should not be stored for later re-use, in an object for example.

The change should not affect uses of the DSL much, since the DSL objects are generally not stored in variables. So the refactoring should not impact many tests, in particular.

I will try to submit a PR soon.

Environment

None

Status

Assignee

Yoann Rodière

Reporter

Yoann Rodière

Labels

None

Suitable for new contributors

None

Feedback Requested

None

Fix versions

Priority

Major