Skip to content

Commit

Permalink
updating opening note
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Poorman committed May 19, 2021
1 parent 3a9b28f commit 665459f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Super-Stub A delightful and elegant stubbing framework for Apex
# Super-Stub - A delightful and elegant stubbing framework for Apex

### 🏠 [Homepage](https://codefriar.github.io/SuperStub/)
[![CI Workflow](https://github.com/codefriar/SuperStub/workflows/CI/badge.svg)](_https://github.com/codefriar/SuperStub/actions?query=workflow%3ACI_) [![Packaging Workflow](https://github.com/codefriar/SuperStub/workflows/Packaging/badge.svg)](_https://github.com/codefriar/SuperStub/actions?query=workflow%3APackaging_) [![codecov](https://codecov.io/gh/codefriar/SuperStub/branch/main/graph/badge.svg)](_https://codecov.io/gh/codefriar/SuperStub_)
[![Twitter](https://img.shields.io/twitter/follow/Codefriar.svg?style=social)](https://img.shields.io/twitter/follow/Codefriar.svg?style=social)
## ⁇ What is this? / What's it do?

> tl;dr; Super Stub is a delightful and elegant stubbing and mocking framework for Apex. A few weeks ago [@JennyJBennett](https://twitter.com/JennyJBennett) and I did a couple of [codeLive](https://www.youtube.com/watch?v=H2ddKRgofD0&list=PLgIMQe2PKPSKAIMyT3enmEetcnVEszTJL) episodes on Mocking and Stubbing. This library is the product of those two sessions, and a bunch of refactoring.
Apex provides a system interface called StubProvider - [you can learn more about it here.](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_interface_System_StubProvider.htm) There's even advanced instructions for [building a mocking and stubbing framework with the StubProvider interface](https://developer.salesforce.com/docs/atlas.en-us.232.0.apexcode.meta/apexcode/apex_testing_stub_api.htm)

While these documents explain what the `StubProvider` does, the examples given lend themselves to a one-off Stub classes. Unless you want to litter your codebase with one-off stub classes this isn't brilliant; so I and others have set out to build a reusable Stubbing framework. There are other reusable frameworks out there, but this one is 'mine'. Part of what makes creating this kind of framework difficult is the API, or the interface developers use when utilizing this kind of library. Much thought has been put into API of Super-Stub. Specifically, I've tried to make sure the methods names are intuitive and easy to understand.
Expand Down

0 comments on commit 665459f

Please sign in to comment.