Merge step-definition files and merge anti-patterns #50

mlvandijk · 2017-10-21T13:30:15Z

As suggested in the todos (see #25), I've merged 2 files about step-definitions and also merged 2 files about anti-patterns.
In addition, I've (tried to) generalize these documents and add text/examples for Ruby/Java/Javascript where relevant.

Next steps:

merge step-definitions with step-organization
possibly merge anti-patterns with step-definitions also (although the file would become very long)...

olleolleolle · 2017-10-21T13:47:56Z

content/cucumber/anti-patterns.md

+source: https://github.com/cucumber/cucumber/wiki/Feature-Coupled-Step-Definitions-(Antipattern)/
+source: https://github.com/cucumber/cucumber/wiki/Conjunction-Steps-(Antipattern)/
+source: https://stackoverflow.com/questions/22696646/how-to-call-a-step-from-another-step-in-cucumber-jvm
+source: https://groups.google.com/forum/#!searchin/cukes/jvm$20steps$20programming/cukes/DzE_kGZx94I/5rf__N31qvAJ


A question about the YAML front-matter: Will repeating keys overwrite the last one in the system we're using?

In the Jekyll YAML Frontmatter documentation, a mention is made of categories, which can be specified as a YAML list.

If we're not programmatically using the source key, perhaps we can change it to a YAML list sources (plural):

sources: - https://github.com/cucumber/cucumber/wiki/Feature-Coupled-Step-Definitions-(Antipattern)/ - https://github.com/cucumber/cucumber/wiki/Conjunction-Steps-(Antipattern)/ - https://stackoverflow.com/questions/22696646/how-to-call-a-step-from-another-step-in-cucumber-jvm - https://groups.google.com/forum/#!searchin/cukes/jvm$20steps$20programming/cukes/DzE_kGZx94I/5rf__N31qvAJ

@olleolleolle Tbh I don't actually know. I figured I'd list the sources that I'd merged into the documents. I'd be happy to do so differently if needed...

The sources front matter is not programatically used at all - it was just a way of keeping track of which page the new pages were coming from.

Might make more sense to leave it as source but a list, and then test it for list / url if we ever use it?

And probably no need to list sources in the same repo.

Thanks, this makes sense to me.

This note of mine - A low-priority thing and “for later”, not blocking this change at all.

Leaving this as is for now.

mlvandijk · 2017-10-23T04:38:31Z

Updated Javascript version with information from @charlierudolph

plaindocs

Couple of small comments, overall great stuff.

plaindocs · 2017-10-23T13:52:04Z

content/cucumber/anti-patterns.md

+  Then I should see "Cucumber BDD tool" under "Descriptions"
+```
+
+```java


I think there is a better way of doing this, without overriding the code block for text content. Will investigate.

+{{% text "java" %}} Cucumber will raise an `AmbiguousStepDefinitionsException`,{{% /text %}} +{{% text "javascript" %}}the Step / Scenario will get an "Ambiguous" result,{{% /text %}} +telling you to fix the ambiguity.

kinda stuff?

plaindocs · 2017-10-23T13:52:23Z

content/cucumber/anti-patterns.md

+end
+```
+
+### How to fix


How to fix what exactly?

Ah, how to decouple feature and step defenitions? Might be clearer to state explicitly?

plaindocs · 2017-10-23T13:58:39Z

content/cucumber/anti-patterns.md

+source: https://github.com/cucumber/cucumber/wiki/Feature-Coupled-Step-Definitions-(Antipattern)/
+source: https://github.com/cucumber/cucumber/wiki/Conjunction-Steps-(Antipattern)/
+source: https://stackoverflow.com/questions/22696646/how-to-call-a-step-from-another-step-in-cucumber-jvm
+source: https://groups.google.com/forum/#!searchin/cukes/jvm$20steps$20programming/cukes/DzE_kGZx94I/5rf__N31qvAJ


And probably no need to list sources in the same repo.

plaindocs · 2017-10-23T14:05:04Z

content/cucumber/anti-patterns.md

+source: https://stackoverflow.com/questions/22696646/how-to-call-a-step-from-another-step-in-cucumber-jvm
+source: https://groups.google.com/forum/#!searchin/cukes/jvm$20steps$20programming/cukes/DzE_kGZx94I/5rf__N31qvAJ
+title: Anti-patterns
+polyglot: true


Missing 'menu: reference`

plaindocs · 2017-10-23T14:08:41Z

content/cucumber/step-definitions.md


 The specific preposition/adverb used has **no** significance when Cucumber is registering or looking up Step Definitions.

 Also, check out Multiline [Step Arguments](/gherkin/gherkin-reference/#step-arguments) for more info on how to pass entire tables or bigger strings to your Step Definitions.

-
-## Successful Steps


Might be worth putting all of these under a heading saying that they are the various states of steps, what do you think?

plaindocs · 2017-10-23T14:18:52Z

content/cucumber/step-definitions.md


+{{% text "ruby" %}}


I think this one is surplus?

Actually, I think this may be Ruby specific which is why I tagged these 2 paragraphs as "Ruby". If I'm mistaken, it should be updated.

plaindocs · 2017-10-23T14:19:17Z

content/cucumber/step-definitions.md

@@ -178,3 +194,4 @@ Given /Three (.*) mice/ do |disability|
  # some other code..
 end
 ```
+{{% /text %}}


And this one?

See previous comment; AFAIK this functionality is Ruby specific

plaindocs · 2017-10-23T14:35:41Z

content/cucumber/step-definitions.md

@@ -165,7 +181,7 @@ So if you try `--guess` with the mice above, Cucumber will pick `/Three blind (.

 ## Redundant Step Definitions

-In Cucumber, you're not allowed to use a `Regexp` more than once in a Step Definition—even across files, and even with different code inside the Proc. 
+In Cucumber, you're not allowed to use a `Regexp` more than once in a Step Definition—even across files, and even with different code inside the method or function.


Is this Regexp specific cucumber use of regular expression? if not we should just use Regular Expression

I'm not actually sure... The use of "Regexp' was fairly consistent throughout the docs, so I figured I'd keep it like that. I did mention "Regular Expressions (Regexp)" somewhere near the top of the docs. Could be updated separately if we want?

mlvandijk added 9 commits October 20, 2017 23:06

Generalize from ruby and add java examples

4c771ac

Add java example

23698ef

Minor text edits

c5814e7

Add brief explanation to why this is an antipattern

e9ea15e

Minor text edits and add javascript

9d2457e

Merge antipatterns

47d0729

Merge step-definitions documents

80b0909

Update and generalize step-definitions documents

cabb12e

Update and generalize step-definitions document

f6f5e11

mlvandijk requested a review from plaindocs October 21, 2017 13:30

olleolleolle reviewed Oct 21, 2017

View reviewed changes

plaindocs requested changes Oct 23, 2017

View reviewed changes

plaindocs reviewed Oct 23, 2017

View reviewed changes

mlvandijk added 6 commits October 28, 2017 08:25

Update links

dc0c5a7

Add text for java and javascript

bfdeae2

Minor update

66d4e30

Update javascript version for ambiguous steps

1792f0b

Update based on review comments

9fd1fad

Fix language specific text

f816fa5

mlvandijk force-pushed the WIP-todos branch from f972e01 to f816fa5 Compare October 28, 2017 06:26

Update for ruby specific features

641c143

mlvandijk merged commit fa563a1 into master Oct 28, 2017

mlvandijk mentioned this pull request Oct 28, 2017

Open TODOs in mostly Ruby related docs #25

Closed

16 tasks

mlvandijk deleted the WIP-todos branch October 28, 2017 14:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge step-definition files and merge anti-patterns #50

Merge step-definition files and merge anti-patterns #50

mlvandijk commented Oct 21, 2017

olleolleolle Oct 21, 2017

mlvandijk Oct 22, 2017

plaindocs Oct 23, 2017

plaindocs Oct 23, 2017

olleolleolle Oct 23, 2017

mlvandijk Oct 23, 2017

mlvandijk commented Oct 23, 2017

plaindocs left a comment

plaindocs Oct 23, 2017

plaindocs Oct 23, 2017

mlvandijk Oct 23, 2017 •

edited

Loading

plaindocs Oct 23, 2017

plaindocs Oct 23, 2017

plaindocs Oct 23, 2017

plaindocs Oct 23, 2017

mlvandijk Oct 26, 2017

plaindocs Oct 23, 2017

plaindocs Oct 23, 2017

mlvandijk Oct 23, 2017

plaindocs Oct 23, 2017

mlvandijk Oct 23, 2017 •

edited

Loading

plaindocs Oct 23, 2017

mlvandijk Oct 23, 2017

Merge step-definition files and merge anti-patterns #50

Merge step-definition files and merge anti-patterns #50

Conversation

mlvandijk commented Oct 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk commented Oct 23, 2017

plaindocs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk Oct 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk Oct 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk Oct 23, 2017 •

edited

Loading

mlvandijk Oct 23, 2017 •

edited

Loading