Skip to content
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

Path.toBeASymbolicLink #765

Closed
9 tasks
robstoll opened this issue Jan 2, 2021 · 8 comments · Fixed by #811
Closed
9 tasks

Path.toBeASymbolicLink #765

robstoll opened this issue Jan 2, 2021 · 8 comments · Fixed by #811
Assignees
Labels
Milestone

Comments

@robstoll
Copy link
Owner

robstoll commented Jan 2, 2021

Platform (all, jvm, js): all
Extension (none, kotlin 1.3): none

Code related feature

expect(path).toBeASymbolicLink()

//instead of

expect(path).feature { f(it::isSymbolicLink)}.toBe(true)

Following the things you need to do:

logic

  • extend PathAssertions with a function toBeASymbolicLink (see isRegularFile as a guideline)
  • implement toBeSymbolicLink in DefaultPathAssertions.kt`

api-fluent

  • provide a fun toBeASymbolicLink (see isRegularFile as a guideline)
  • add @since 0.16.0 (adapt to current milestone) to KDOC
  • add isSymbolicLink to PathExpectationsSpec in specs-common adopt the spec in api-fluent

api-infix

  • provide a fun toBe which expect a new pseudo-keyword aSymbolicLink (see toBe(aRegularFile)` as a guideline)
  • add @since 0.16.0 (adapt to current milestone) to KDOC
  • add toBe aSymbolicLink to PathExpectationsSpec in specs-common adopt the spec in api-fluent
  • add an example to PathAssertionSamples (create the file next to BigDecimalAssertionSamples if it does not exist yet).

Your first contribution?

  • Write a comment I'll work on this if you would like to take this issue over.
    This way we get the chance to revise the description in case things have changed in the meantime, we might give you additional hints and we can assign the task to you, so that others do not start as well.
  • See Your first code contribution for guidelines.
  • Do not hesitate to ask questions here or to contact us via Atrium's slack channel if you need help
    (Invite yourself in case you do not have an account yet).
@robstoll robstoll added this to the 0.16.0 milestone Jan 2, 2021
@robstoll robstoll changed the title Path.isSymbolicLink Path.toBeSymbolicLink Jan 2, 2021
@jGleitz
Copy link
Collaborator

jGleitz commented Jan 2, 2021

I vote to name the function toBeASymbolicLink.

@robstoll
Copy link
Owner Author

robstoll commented Jan 2, 2021

Good with me, I was considering it as well (already did it for the infix API)

@robstoll robstoll changed the title Path.toBeSymbolicLink Path.toBeASymbolicLink Jan 2, 2021
@fimbulwint
Copy link
Contributor

I'll work on this

@robstoll
Copy link
Owner Author

@fimbulwint note that I have updated the description. Have fun implementing and let us know in case you need help

@fimbulwint
Copy link
Contributor

@robstoll Thanks!

@fimbulwint
Copy link
Contributor

@robstoll I'm ready to create a PR, but I don't have permissions to push/create the tracking branch

@jGleitz
Copy link
Collaborator

jGleitz commented Feb 13, 2021

@fimbulwint you should fork this repository, push the branch to your fork, and then open a Pull Request from your fork. See also Creating a Pull Request from a Fork.

@fimbulwint
Copy link
Contributor

@jGleitz thank you, done that now

robstoll added a commit that referenced this issue Feb 20, 2021
add convenience shortcut for `Path.toBeASymbolicLink` feature
@robstoll robstoll linked a pull request Feb 20, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants