Use verbatim routes files

[alexdavid]

Use verbatim routes files

[alexdavid]

👍 I started with something similar but it felt wrong putting code in my feature files. But I inevitably had to with the tests for resources.

[kevgo]

This isn't code, but the developer-facing API of your library. I.e. this is how your library appears to the end user (an express developer). It's therefore okay (and a good thing) to describe it as such, directly, in the feature specs.

[alexdavid]

Do you think the string should include the top module.exports line on the routes file since it's technically part of the API?

Given a routes file defining
  """
  module.exports = ({GET}) ->
    GET '/users', to: 'users#index'
    POST '/users', to: users#create'
  """

[kevgo]

Yeah, I could see how that would make sense in the spirit of documenting the end-user experience.

In particular, it depends on what you are specifying. In the spec for the whole routes file, you should definitely provide the whole file content. In a spec for some edge case (like a POST route is defined, but a PUT route is requested), I could see that it is enough to only specify the routes themselves, and not the boilerplate around them, to keep the spec concise and to the point.