feat | Light lock interface improvement #170
Merged
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
bolshakov
reviewed
Dec 10, 2022
bolshakov
approved these changes
Dec 10, 2022
bolshakov
reviewed
Dec 10, 2022
lib/stoplight/light/runnable.rb
Outdated
| @@ -26,6 +27,20 @@ def run | |||
| end | |||
| end | |||
|
|
|||
| def lock(color) | |||
There was a problem hiding this comment.
Sorry, one final thought. Would you mind adding yard docs to the method? Since it's a public integrate, let's document what it returns, I suggest returning either self of color. I lean toward a color, but don't have a strong opinion about that
There was a problem hiding this comment.
I decided to return Light.
bolshakov
reviewed
Dec 10, 2022
lib/stoplight/light/runnable.rb
Outdated
|
|
||
| def unlock | ||
| safely { data_store.set_state(self, Stoplight::State::UNLOCKED) } | ||
| end |
There was a problem hiding this comment.
On the other hand, we cannot return a color in this method 🤔
There was a problem hiding this comment.
I'll think about what to return then :)
There was a problem hiding this comment.
@bolshakov, because we can't return color in this method think that we should return Light here.
Lokideos
force-pushed
the
feat-light-lock-interface-improvement
branch
from
8611475
to
8204f2e
Compare
bolshakov
approved these changes
Dec 19, 2022
Merged
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.
This ticket aims to improve the interface of the locking light state as described in #162.
Previously, if we needed to lock the light state, we used the data store interface instead of the light interface.
This approach exposed the implementation of light locking and potentially allowed the locking state of one light via the interface of another light.
Now we call
#lockdirectly on the light and also hide the implementation of light locking.We also introduce the
#unlockmethod, which hides the implementation of unlocking the light and simplifies light unlocking: