Add createAction

[ZoteTheMighty]

Closes #31.

Adds an implementation of the generic action creator... creator that's used commonly for Rodux projects within Roblox. Looking for feedback on a decent name for this.

Potentially compelling possibilities for names:
defineAction or defineActionCreator
makeActionCreator (https://redux.js.org/recipes/reducingboilerplate#generating-action-creators)

Checklist before submitting:

• Finalize name of method
• Added entry to CHANGELOG.md
• Added/updated relevant tests
• Added/updated documentation

[ZoteTheMighty]

The name referenced in the ticket bothers me because its a misnomer. The added function is not an action creator: it returns an action creator. A more appropriate name would be createActionCreator but that's pretty awkward

[coveralls]

Coverage increased (+0.05%) to 99.401% when pulling bf326eb on ZoteTheMighty:action into 9e1736a on Roblox:master.

[SlartibartfastFjords]

Should add documentation for this feature in docs/api-reference.md before submitting.

EDIT: Oh, my mistake, you already have that listed in your checklist before submitting :/.

[SlartibartfastFjords]

These comments need to be updated to reflect this API.

[ZoteTheMighty]

Right, I'd like to address the naming before getting too far into writing docs. Docs might also just mean transplanting a bunch of the comments into docs and thinning them out some in the actual code, as they're not as useful there.

[SlartibartfastFjords]

Isn't the convention to have this be require(Actions.MyAction)?

[ZoteTheMighty]

Yeah, I'll have to update these, as well as the wording in the asserts.

[ZoteTheMighty]

Having thought this over, I don't know if this approach is ubiquitous enough to justify this helper. Is this implementation too specific to exist as a general helper like createReducer and combineReducers? I've updated the naming and the wording of the affiliated comments and I filled in some documentation. If we think this might be useful to someone we can add it in, but I'd be fine with tabling it for now.

[LPGhatguy]

Based on a renewed request in #31, we should pursue landing this. After thinking about it more, too, over the last... year and a half, this seems reasonable to me.

[benbrimeyer]

Suggested change

	expect(FooAction).to.throw()
	expect(FooAction).to.throw("must return a table")

nvm this is using a 3yr old version of test ez

[ZoteTheMighty]

Commenting here to allow actions to be executed (I believe that's how this works!)

[github-actions]

CLA Signature Action:

Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you read and sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just by adding a comment to this pull request with this exact sentence:

I have read the CLA Document and I hereby sign the CLA

By commenting with the above message you are agreeing to the terms of the CLA. Your account will be recorded as agreeing to our CLA so you don't need to sign it again for future contributions to our company's repositories.

0 out of 1 committers have signed the CLA.
❌ @paul Doyle

GitHub can't find an account for Paul Doyle.
You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.

[ZoteTheMighty]

CLA bot was confused by merges of existing master commits, so I rebuilt this on top of master to clarify.