search

riboseinc / uri_format_validator

Validate URL for Rails
MIT License
3 stars 2 forks source link

Replace examples with some kind of feature tests #57

Closed skalee closed 6 years ago

skalee commented 6 years ago

I just found out that examples still use the old validator name (#56), thus are incorrect. And I believe it's only a matter of time when they get out-of-sync again by some inattention.

I believe they should be replaced by some kind of feature specs (Cucumber, perhaps? Not sure yet). Then CI will ensure that they aren't misleading.

skalee commented 6 years ago

I think that the best would be to host documentation on https://relishapp.com.

skalee commented 6 years ago

@ronaldtse Just created a first feature spec in Cucumber for this gem. It was easier than I thought, and I believe self-testing documentation is a better idea than examples directory or README-based documentation, which may get out-of-sync easily. The Cucumber-based documentation may be hosted on https://relishapp.com. I'll proceed with that if you give me green light.

ronaldtse commented 6 years ago

Green light 🚥

ronaldtse commented 6 years ago

@skalee I've created the "Ribose" publisher on Relish and invited you to it.

skalee commented 6 years ago

@ronaldtse I've found your invitation e-mail, clicked the invitation link, and has created my account on Relish. However I'm not added to Ribose publisher, please add me.

skalee commented 6 years ago

@ronaldtse Could you make sure I'm added to Ribose publisher in Relish? It still says I'm not added to any.

skalee commented 6 years ago

@ronaldtse? We could publish docs for the older version (v0.2.1) and close this issue.

ronaldtse commented 6 years ago

@skalee so sorry I missed the messages. I finally found how out how to achieve this and have added you now 👍

skalee commented 6 years ago

@ronaldtse No worries. It wasn't critical.