adding boolean functions for git status #348
Merged
Conversation
This file contains hidden or 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
|
The test that failed is outside the scope of the change that I made. I will look into forcing a Travis run to see if it can be replicated twice. |
Signed-off-by: Vern Burton <me@vernburton.com>
perlun
requested changes
Feb 28, 2018
lib/git/status.rb
Outdated
| end | ||
|
|
||
| def untracked?(file) | ||
| untracked.member?(file) |
There was a problem hiding this comment.
For the new methods added, would you mind adding YARD-style comments that describes briefly:
- What they do
- What the expected types of the input and return values are
The new methods added in this PR are:
- changed?
- added?
- deleted?
- untracked?
Something like this will do:
#
# Determines whether the given file has been added to the repository
#
# @param file [String] The name of the file.
# @return [Boolean]This way, it is clearer for readers of the code what the intent of these (public API methods) is.
…e about fixing rubocop - broke method to make line count while breaking up function into functional zone - fixed heredoc spacing - removed redundant self - rescue should not be used as a modifer, moved to begin/rescue
|
I took your comments to heart and while I was adding the documentation, I fixed the class so that it would pass rubocop. vburton@vburton-VirtualBox:~/Code/ruby-git$ rubocop lib/git/status.rb
Inspecting 1 file
.
1 file inspected, no offenses detectedThe construct_status was broken up to lower method complexity while creating methods to be responsible for untracked, modified, and added statuses. |
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.
fixes #346