Codebase refactoring

[ttutisani]

I know that several people have already mentioned about refactoring. Before anybody commits to do so, this topic is here to discuss it in advance.

If no actions are observed, I will post my thoughts around it later. Meanwhile:

Regardless of who does it, in my opinion, refactoring should make concepts of this framework more explicit, easier to digest and change further in the future.

Refactoring should be driven by readability and expressiveness, rather than by technical aspects only (such as dependency injection or splitting into smaller interfaces). I believe such focus will ensure successful growth of the project, instead of dragging it down long term and eventually slowing it down.

[ttutisani]

I have refactoring in progress. If anybody is interested, I can provide upcoming structure class diagram.

[ttutisani]

Refactoring is happening on a branch named "refactorIntoClearModel". To see the work in progress, follow this link: https://github.com/ttutisani/Xunit.Gherkin.Quick/compare/refactorIntoClearModel?expand=1

To understand the goal of the refactoring, refer to the core class that describes the clear model: "ScenarioExecutor.cs".

Specifically, this fragment should be self-explanatory (this is the basic flow that this whole framework is based on):

var featureClass = FeatureClass.FromFeatureInstance(featureInstance);
var featureFile = _featureFileRepository.GetByFilePath(featureClass.FeatureFilePath);

var scenario = featureClass.ExtractScenario(scenarioName, featureFile);
scenario.Execute();

If it's really self-explanatory, then you get the idea of what I'm trying to achieve - self-describing, expressive code.

[wcdeich4]

How far along is the refactoring?

[ttutisani]

It's almost over now. Yesterday evening I got everything working in terms of running the scenarios successfully. I only have these pieces to do:

1. Output showing which steps ran and which didn't.
2. Thoroughly smoke test every error scenario to ensure it still provides developer friendly feedback if something's not right / gone wrong.
3. Cleanup of the classes.

I expect this all to be done by end of this week. Maybe even earlier. But I prefer to provide pessimistic estimates.

And then it will open up the opportunity to add support for the new argument types: tables and docString. Before that, I will probably release a new version of Nuget too.

[ttutisani]

Just FYI - yesterday I spent whole evening brainstorming around introducing a knowledge level pattern in the new approach. No progress on actual refactoring. It may spill into next week. I'm trying to convince myself that the knowledge level would be too difficult to implement...

[ttutisani]

Refactoring is complete. PR is open: https://github.com/ttutisani/Xunit.Gherkin.Quick/pull/31

I will be merging tomorrow. Want to sleep on it and/or gather feedback. This opens the door for easily adding support for all argument types. Will be working on that next.

[ttutisani]

PR is merged. I will also create a readme file for contributors. That file will describe the model, as well as the design guidelines going forward. Till then, I'll keep this issue open.

[ttutisani]

Action item on me is complete. Readme file is complete. Closing this issue.