tricycle/elm-actor-framework-sandbox/1.0.0

NOTE: the latest version is 3.0.0

Renamed to bellroy/elm-actor-framework-sandbox. It is published under that name, and new versions come out there.

Versions published as tricycle/elm-actor-framework-sandbox still install under that name. 3 versions of 4 come from the new location (see their notes). 1 version could not be recovered and cannot be installed.

Rerouted (renamed, needs approval). The GitHub user or repository was renamed. The tag is still there, at the new name. The Lamdera package server serves a copy recovered from https://github.com/bellroy/elm-actor-framework-sandbox.

What we checked: The repo moved to github.com/bellroy/elm-actor-framework-sandbox and tag 1.0.0 is there; its commit 035320508286 is from 2021-04-07 01:58 UTC, after the version was published (2020-07-09 11:39 UTC); elm.json differs from package.elm-lang.org's; the exposed modules match docs.json; the zip's SHA-1 is not the published one and nothing else confirms its contents.

We could not verify this copy against what was published, so the Lamdera compiler asks before using it (y/n). Without a terminal, as in CI, it stops with an error unless approved:

  • lamdera make --auto-approve-package-rerouting approves rerouted versions for that run,
  • LAMDERA_AUTO_APPROVE_PACKAGE_REROUTING=1 does the same for every run in that environment,
  • LAMDERA_CACHE=off skips the Lamdera package server altogether: packages come from package.elm-lang.org and GitHub only, as with elm, and a rerouted version then fails to download.

Details · package.elm-lang.org's zip: https://github.com/tricycle/elm-actor-framework-sandbox/zipball/1.0.0/

Framework.Sandbox

type alias SandboxComponent appFlags componentModel componentMsgIn componentMsgOut output =
SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output
appFlags
-> Component
appFlags
componentModel
componentMsgIn
componentMsgOut
output
componentMsgIn
-> SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output

Turn your Framework.Actor.Component into a SandboxComponent.

You'll have to supply it with a default (mocked) appFlags value so that we can render an initial output (See Framework.Sandbox.Browser for more info.)

fromComponent "Some Flags" component

Tests

TestCase
appFlags
componentModel
componentMsgIn
componentMsgOut
output
-> SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output
-> SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output

Add A TestCase to your SandboxComponent

The title of a TestCase has to be unique for your Sandbox.

fromComponent () component
    |> addTestCase
        (TestCase.make
            { title = "Increment"
            , description = "Increment the counters value by one."
            , test = \_ a b -> Expect (b - a) 1
            }
            |> TestCase.setActions [ Increment ]
        )
TestCase
appFlags
componentModel
componentMsgIn
componentMsgOut
output
-> SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output
-> SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output

Updates a TestCase based on its title (This is an alias of addTestCase (!))

String
-> SandboxComponent
appFlags
componentModel
componentMsgIn
componentMsgOut
output
-> Test

Give your tests a description and turn them into Elm tests!

fromComponent () component
    |> addTestCase
        (TestCase.make
            { title = "Increment"
            , description = "Increment the counters value by one."
            , test = \_ a b -> Expect (b - a) 1
            }
            |> TestCase.setActions [ Increment ]
        )
    |> toTest "My Counter Component"