Order sensitive overload for compare to set #778
Conversation
| @@ -25,19 +25,24 @@ private SafetyTableDiffExceptionBuilder<T> BuildTheTableDiffExceptionBuilder() | |||
| return makeSureTheFormattingWorkAboveDoesNotResultInABadException; | |||
| } | |||
|
|
|||
| public void CompareToSet(IEnumerable<T> set) | |||
| public void CompareToSet(IEnumerable<T> set, bool sequentialEquality) | |||
There was a problem hiding this comment.
I am a little concerned about exposing a boolean as a trailing argument for any method. Not just in this case, but all cases... it's a red flag. Because you know how it goes, you make this change with a boolean, then another change comes in... what do you do? Tack on more flags?
Another option might be to take in an options class, for those concerned with types, with an override that takes a dynamic object. So the syntax could be as simple as checker.CompareToSet(set, new { CheckTheSequence = true })
Allowing an optional arguments parameter will also allow us to add on existing behavior. Considering how complicated set comparisons might be, I wouldn't be surprised if people want more options for it later.
I'd at least make the boolean optional, defaulting it to the existing behavior. Just so it won't break other people's code when they upgrade.
There was a problem hiding this comment.
By making it optional, I can also just call checker.CompareToSet(set) and I won't have to worry about breaking any test builds.
There was a problem hiding this comment.
I agree. Actually on the "real" public API, the SetComparisonExtensionMethods.CompareToSet extension method (https://github.com/techtalk/SpecFlow/blob/3fcdf09b4f28160d4f6851b4b7e4f98b24933df5/TechTalk.SpecFlow/Assist/SetComparisonExtensionMethods.cs#L7) I have used an optional parameter. I did not think that someone would use this method directly, but you are right, we should also make this backwards compatible to be on the safe side.
Regarding the option class approach: from the trainings I do, my experience is that people are not aware of the object initializer syntax, so as long as we only have one option, I would rather choose the optional parameter, or alternatively a different API method, like CompareToSetOrderSensitive... (maybe with a better name)
There was a problem hiding this comment.
Oh, I like that idea! Using a a separate method, I mean... I think that would be preferable to the trailing bit parameter.
I think it might be a cultural thing, in terms of .Net versus other stacks. I've spent a lot of time in Ruby, and having the trailing "options" parameter is much more common and accepted. Nobody thinks twice about it, as the language syntax around creating a hash/dictionary is much simpler and intuitive, and nobody thinks twice about the magic-string-ness of the object... but in C# developers have a conniption fit if they don't have a type defined with parameters with XML documentation. 😄
There was a problem hiding this comment.
@darrencauthon and would would be your preferred name?
There was a problem hiding this comment.
@gasparnagy Let me think on that today... perhaps my inability to think of a good name will change my mind. 😄
There was a problem hiding this comment.
@darrencauthon in Cucumber JVM the two method is called diff and unorderedDiff BTW. So it seems that also decided to go for two separate methods... https://cucumber.github.io/api/cucumber/jvm/javadoc/cucumber/api/DataTable.html
| @@ -8,7 +8,7 @@ public class SetComparer<T> | |||
| { | |||
| private const int MatchNotFound = -1; | |||
| private readonly Table table; | |||
| private List<T> actualItems; | |||
| private List<TableDifferenceItem<T>> extraOrNonMatchingActualItems; | |||
There was a problem hiding this comment.
I saw this pull request earlier, and I swear I saw you using a Tuple? I thought that was interesting, as I'm finding tuples more and more useful for internal behaviors in my own code.
There was a problem hiding this comment.
Yes. It was this commit: 2796780
I was also wanted to see how Tuples could be better used, but altogether I did not really like the result. It was very hard to communicate with the code what data I am combining together (in my case the item with the expected position). So I refactored it.
There was a problem hiding this comment.
Yeah, my tuples regularly get refactored to types as well. It's nice to have them as an option, though, because in the middle of working I don't always want to load my brain with more types. I'd rather establish the flow of the code and then refactor it afterwards.
I think the tuples make more sense in other languages that make unpacking them simpler.
gasparnagy
changed the title
|
@darrencauthon we will merge this with @SabotageAndi now so that it can be included in the pre-relase today. |
* update MSBuild.Community.Tasks to latest version via NuGet (SpecFlowOSS#801) * Regexless stepdef fixes (SpecFlowOSS#786) * Upgrade FluentAssertions * Add simple unit test * Add unit test for parametrized method * Add unit tests for regexless - 36 failing * fluent assertion does not allow { and } in the because part * refine expectations: shortening like "doesn't" should not work automatically * fix regexless matching issues * a bit more optimal solution that produces simpler regexes * Improve param locator * should not remove keywords from binding culture * small code improvements * refine expectations: should not allow whitespace or punctuation in the front of the step text (Given !foo) in order to make the generated regex faster (does not start with rule) * small refactor * update changelog, remove wip tags * add test for issue SpecFlowOSS#715 * Update changelog showing that SpecFlowOSS#301 is also fixed * add CI NuGet package feed * Added support for MsTest's [DeploymentItem] attribute with @mstest:DeploymentItem tag (SpecFlowOSS#805) * Added support for MsTest's [DeploymentItem] attribute with @Deploy tag (Issue SpecFlowOSS#803) * Prefixing new tag with `MsTest:` * using pascal case @mstest:DeploymentItem * wrapping nested using blocks with curly brackets * Change project reader from MSBuild to XML (SpecFlowOSS#837) * improve tests for project reader * add tests for new csproj format * change variable naming * complete read of classic projects * refactoring * mark not used properties as obsolete * support new project system & refactorings * use AppDomainIsolatedTask instead of Task to solve file looking issues with MsBuild * fix typo :-/ * add tests for linked files * Added display name for theory attribution (SpecFlowOSS#812) * Added display name for theory attribution * Fixed incorrect namespace reference to TheoryAttribute (no longer part of extensions) * Support context parameters on Before/After methods, FeatureContainer (SpecFlowOSS#779) * Added scenario: Inject FeatureContext into a BeforeFeature hook * first dummy implementation to make the scenario pass (runtime tests failing) * Use bindingInstanceResolver to resolve parameters * make unit tests pass * Add unit tests for what we have so far * support for resolving hook parameters from scenario context * better then step for the scenarios * fix unit test error * added failing test for resolving objects from feature container * refactor ScenarioContext * Implement FeatureContainer * move binding culture initialization to FeatureContext * fix featurecontext resolution from scenario container * Refactor scenario and feature context and remove displose hack that was necessary to avoid circular disposing loops * fix unit test failure * Make InternalContextManager to IObjectContainer reference more explicit * rename IBindingInstanceResolver to ITestObjectResolver (breaking change for some plugins) * Wildcard support for project reader (SpecFlowOSS#843) * Wildcard support for project reader * fix tests for AppVeyor * update changelog * Config file refactoring & Json Config file support (SpecFlowOSS#690) * split app.config elements to multiple files * make RuntimeConfiguration nearly immutable * extract config loading logic to RuntimeConfigurationLoader * reformating * add tests for app.config reading * move ConfigurationTest to separate Namespace * rename file * add json tests * add json.net dependency * json config file parsing * add tests for checking which config file is used * refactoring for tests and added tests * remove GeneratorConfiguration * fix dependencies for generator * fix tests * fix tests * move files & fix namespaces * work on generation config loading * fix tests and make parsing more robust * fix and comment test * small cleanups * remove ToolLanguage, GeneratorPath and DetectAmbiguousMatches from Config rename PrintConfigSource to TraceConfigSource * fix merge issues * remove file * add missing json handling * update changelog * add Newtonsoft.Json dependency to the NuGet package * update TestGenerator version * fix typo in README.md (SpecFlowOSS#853) * fix VS code behind generation (SpecFlowOSS#855) * fix redirects * fix serialization problem with Visual Studio * fix lineending * Order sensitive overload for compare to set (SpecFlowOSS#778) * Add tests * Refactor TableDifferenceResults to be able to represent order sensitive diff * make throw tests pass * refactor message tests to be able to test order sensitive comparison * fix diff messages for order sensitive * Replace Tuple with TableDifferenceItem * Hook with multiple Tags scoped are executed more than once (SpecFlowOSS#848) * add failing tests * Fix for SpecFlowOSS#848 Hook with multiple Tags scoped are executed more than once * making sure that the ordering is preserved (the GroupBy might change the order) * update changelog for 2.2.0-prerelease20170523 * add GitExtensions configuration file with github and appveyor configuration (SpecFlowOSS#862) * Added TestThreadContext and exposed it in ContextManager and Steps base class (SpecFlowOSS#875) * Added TestThreadContext and exposed it in ContextManager and Steps base class * Upgrade to BoDi v1.3 (SpecFlowOSS#876) * fix shadow copy test issue * upgrade BoDi to v1.3 * remove unnecessary BoDi workarounds * Adds support for xUnit2 ITestOutputHelper SpecFlowOSS#575 (SpecFlowOSS#874) * Resolves SpecFlowOSS#575 * added tests for adding support for xUnit2 ITestOutputHelper class added XUnit2Generator unit tests added XUnit2Provider specs updated XUnitExecutionDriver to output results in default (xUnit) xml output instead of NUnit xml format * swapped the order of the TestInitialize call and the setting of the _testOutputHelper field * expose TestAssembly and BindingAssemblies on ITestRunnerManager * Fix generation from visual studio (SpecFlowOSS#877) * rename field so that it matches the version of this class from 1.9 (which is used by VS) * make AppConfig the default value * add warnings * Update for 2.2 release * use FileStream constructor which grants ReadWrite to other processes. (SpecFlowOSS#906) use FileStream constructor which grants ReadWrite to other processes SpecFlowOSS#904 * Added changelog entry for PR (SpecFlowOSS#907) * correct version number * Access MSTest's TestContext property via ScenarioContext (SpecFlowOSS#882) * injected MSTest's TestContext into ScenarioContext * fixed TestContext property generation for VB.Net * @MSBuild [DeploymentItem] - added option to provide output directory (SpecFlowOSS#901) * @MSBuild [DeploymentItem] - added option to provide output directory * code review * update changelog after merging PRs SpecFlowOSS#882 & SpecFlowOSS#901 * add tests for Feature/Scenario Hooks with context parameters (SpecFlowOSS#925) * Issue Template (SpecFlowOSS#924) * Create issue template * add SpecFlow+Runner to test runners * Rename issue to ISSUE_TEMPLATE.md * Allowed custom XSLT scripts to contain scripts. * Updated changelog for new addition * enter release date * fix changelog after 2.2.1 release * added link to Stack Overflow repro topic (SpecFlowOSS#942) * Avoid trying to load empty configuration * Set ConfigSource of default holder to "Default" instead of "AppConfig" * Turn off line ending git auto conversion (SpecFlowOSS#953) * Stop git from automatically converting line endings everytime repo is cloned * add .vs folder to .gitignore * Fixing copy link in step definition report (SpecFlowOSS#958) * Update changelog * Support for tuples (SpecFlowOSS#951) * Initial support for Tuples * Adding nuspec dependency * Added tupple error when there are too many properties * add entry for tuple * Make scenario TestResult public (SpecFlowOSS#963) * Make scenario TestResult public * - Rename to ScenarioExecutionStatus - Moved this to the root of the project - UndefinedStep in enum - Edited changelog.txt * Update changelog.txt * Single agent for unit tests execution * Fix incorrect appveyour config * Try to change test_script to test * Disable automatic tests * Provide full path to test assemblies * Expose configuration var to batch * Hardcoded configuration as Release * Use %% accessor for configuration var * Add hyperlink to discussion group (SpecFlowOSS#965) Remove ambiguity regarding where to go for questions.
No description provided.