luckymcbeast/kotmock

A simple mocking library for Kotlin/Native and Kotlin/JVM with the goal of being Native-first with no dependencies other than Kotlin itself.

kotmock's Issues

Create Installation Instructions

User Story:
As a developer using KotMock, I want to easily install the library on a new or existing project, whether I'm using Maven, Gradle, or Gradle's Kotlin DSL.

• Add installation instructions with Gradle Kotlin DSL
• Add installation instructions with traditional Groovy-based Gradle
• Add installation instructions with Maven XML

Perform Code Analysis and Refactor as Needed

Requirements

• Review existing code base and make necessary improvements to improve quality
• Ensure tests are named properly, are testing "the right thing," and that all behavior is covered
• Complete any existing TODOs in the codebase
• Ensure that methods belong to the appropriate class

Implement existing logic for JVM

User Story:
As a Kotlin developer, I want to be able to use KotMock on the JVM.

Requirements

• Port Kotlin/Native code to Kotlin/JVM using Kotlin Multiplatform
• Ensure KotMock works well with JUnit
• Upon completion, deploy to Maven Central as SNAPSHOT

Provide documentation on usage

User Story:
As a developer, I want to quickly and completely understand the libraries I use.

Requirements:

• Provide high level overview of general usage and design choices in README.md
• Explain how to mock an interface in README.md
• Explain how to use whenever in README.md with suggested syntax and alternatives
• Explain how to use verify in README.md

Integrate with GitHub Workflows

Requirements

• Setup automated testing on Pull Request
• Setup automated deployment to Maven Central on merge with main

Add optional arguments to whenever method

User Story:
As a developer, I want to specify the arguments that were provided to a function when stubbing using whenever, though I do not want to be forced to do so.

Requirements:

• Allow args to be optionally provided to whenever method
• if args are provided, args must match