Skip to content

Adds documentation and feature for job specs #1725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 18, 2016

Conversation

sgerrand
Copy link
Contributor

💁 These changes update the existing documentation with a section on job specs, as well as adding a related cucumber feature.

Closes #1335

Updates existing documentation with a section on job specs and adds a
related cucumber feature.
Job specs must be set up with the correct queue adapter, otherwise an
exception will be thrown. Adding an additional step definition allows
this scenario to be tested.
@sgerrand
Copy link
Contributor Author

👋 @cupakromer @samphippen: Would you please review these changes.

@fables-tales
Copy link
Member

I really like this. I'd like to give a more thorough review tomorrow morning, but most likely we can just merge this in. Thank you so much @sgerrand

@sgerrand
Copy link
Contributor Author

@samphippen: I'm happy to wait, there's no rush on my end. 🙇

@@ -321,6 +321,28 @@ end
For more information, see the [cucumber scenarios for mailer specs
](https://relishapp.com/rspec/rspec-rails/v/3-4/docs/mailer-specs).

## Job specs

Job specs default to residing in the `spec/jobs` folder. Tagging any context
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inferring spec location is deprecated so these sentences are the wrong way around, although it does line up with the rest of the file may I suggest:

Tagging a context with the metadata:type => :job treats it's examples as job specs. Typically these specs will live in spec/jobs.

You've already mentioned the config option in the actual cuke (🙌) so I think this will suffice

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 So long as I use

its examples

:bowtie:

Thanks for the speedy review. 💝

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JonRowe: Applied as per your example in 4c522db. ♻️

@JonRowe JonRowe merged commit 063f035 into rspec:master Oct 18, 2016
@JonRowe
Copy link
Member

JonRowe commented Oct 18, 2016

Thanks @sgerrand :)

```

For more information, see the [cucumber scenarios for job specs
](https://relishapp.com/rspec/rspec-rails/docs/job-specs).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link doesn't currently work

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you'd like to fix this, I'd welcome a PR!, this ones already been merged tho.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I wasn't clear if there was some kind of a deploy that needed to happen to make the URL work so it wasn't clear to me what the fix would be.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, you're totally right, /cc @myronmarston how do we publish to relish again?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rake relish

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, one flaw in this plan, I don't have access!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've signed up with the usual email address if you want to add me so I can do this Myron.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added you as a collaborator.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link works now, thanks @myronmarston and @drewish

JonRowe pushed a commit that referenced this pull request Jan 5, 2017
* Add documentation for ActiveJob specs

Updates existing documentation with a section on job specs and adds a
related cucumber feature.

* Add failing example for configuration error

Job specs must be set up with the correct queue adapter, otherwise an
exception will be thrown. Adding an additional step definition allows
this scenario to be tested.

* Updates top level documentation for job specs

Applying [PR feedback](#1725 (comment)).
@sgerrand
Copy link
Contributor Author

sgerrand commented Jan 6, 2017 via email

sebjacobs pushed a commit to futurelearn/rspec-rails that referenced this pull request Mar 15, 2019
* Add documentation for ActiveJob specs

Updates existing documentation with a section on job specs and adds a
related cucumber feature.

* Add failing example for configuration error

Job specs must be set up with the correct queue adapter, otherwise an
exception will be thrown. Adding an additional step definition allows
this scenario to be tested.

* Updates top level documentation for job specs

Applying [PR feedback](rspec#1725 (comment)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants