Code janitoring (docs, test structure, dev dependencies) #834
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Burgestrand
force-pushed
the
kbs/code-janitoring
branch
14 times, most recently
from
c7877e5
to
d1c2fed
Compare
The spec helper is large, contains a mixture of policies and entities and is hard to follow. By splitting it out into smaller chunks we can get a better overview.
Burgestrand
force-pushed
the
kbs/code-janitoring
branch
2 times, most recently
from
5451990
to
fd4c61b
Compare
* Show all APIs, not just the ones tagged as public. * Show private methods, show protected methods. * Hide everything tagged with @Private * Fix yard choking on the template files `.tt` is the de-facto file name to be used for templates regardless. * Hide the generator classes in yard, they aren't useful * Fail yardoc on warnings to prevent failures in CI
* Remnants from the first pass when introducing Pundit::Context. * Further clean up the YARDOC for Authorization/Context * Fix references to Pundit context in class methods * Add YARDOC to the rspec helper classes * Regroup documentation of Pundit::Context Add some documentation to the new objects
We're testing it by proxy since it's being used in some tests, but these tests are _specific_ to the matchers themselves.
Burgestrand
force-pushed
the
kbs/code-janitoring
branch
from
fd4c61b
to
93a9765
Compare
5 tasks
Burgestrand
force-pushed
the
kbs/code-janitoring
branch
from
93a9765
to
ba324e4
Compare
It's not perfect, but it is something. Full line coverage, full branch coverage, checked for every PR.
Burgestrand
force-pushed
the
kbs/code-janitoring
branch
from
ba324e4
to
e296e83
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These are intended to be QoL improvements for developing Pundit, and not actual changes to Pundit as it's used.
To do
PS: Thank you for contributing to Pundit ❤️