Sha256: ba2077fd8b71b1edc03bb16b661fa4cbd5dba2faaf396ad19c7c21641391d48c

Contents?: true

Size: 1.31 KB

Versions: 19

Compression:

Stored size: 1.31 KB

Contents

Documentation
=============

**Looking for the HTML features decription?**

The Cucumber features that documented the gem behaviour until `v1.5.1` constituted a robust tests suite, but they were slow and writting them was difficult enough to become a continuous bottleneck.

I decided to tackle the issue by replacing most scenarios by unit tests (see [#104][issue]), and since `v1.5.2` the gem behaviour is documented using RSpec only.

I liked the [executable documentation][exec-doc] idea, and I do not discard using Cucumber again to test _Simple Token Authentication_.
However, truth is that neither the somewhat intricated [Cucumber][cucumber] - [Aruba][aruba] - [RSpec][rspec] setup or the steps I wrote were exemplary enough to make justice to the great tool Cucumber is. So I decided to stop maintaining  the features and to remove them. The RSpec test suite provides a nice [documentation][doc], and sometimes the best is a fresh start.

  [exec-doc]: https://github.com/gonzalo-bulnes/simple_token_authentication/tree/v1.5.1#executable-documentation
  [doc]: #testing-and-documentation
  [issue]: https://github.com/gonzalo-bulnes/simple_token_authentication/issues/104
  [aruba]: https://github.com/cucumber/aruba
  [cucumber]: https://github.com/cucumber/cucumber-rails
  [rspec]: https://www.relishapp.com/rspec/rspec-rails/docs

Version data entries

19 entries across 19 versions & 2 rubygems

Version Path
simple_token_authentication-1.18.1 doc/README.md
simple_token_authentication-1.18.0 doc/README.md
simple_token_authentication-1.17.0 doc/README.md
simple_token_authentication-1.16.0 doc/README.md
simple_token_authentication-1.15.1 doc/README.md
simple_token_authentication-1.15.0 doc/README.md
simple_token_authentication-1.14.0 doc/README.md
simple_token_authentication-1.13.0 doc/README.md
simple_token_authentication-1.12.0 doc/README.md
simple_token_authentication-1.11.0 doc/README.md
simple_token_authentication-1.10.1 doc/README.md
simple_token_authentication-1.10.0 doc/README.md
simple_token_authentication-1.9.1 doc/README.md
simple_token_authentication-1.9.0 doc/README.md
simple_token_authentication-1.8.0 doc/README.md
stn-simple_token_authentication-1.7.1 doc/README.md
simple_token_authentication-1.7.0 doc/README.md
simple_token_authentication-1.6.0 doc/README.md
simple_token_authentication-1.5.2 doc/README.md