Initial commit

Author: garyb

.gitignore

@@ -0,0 +1,8 @@
+/.*
+!/.gitignore
+!/.jscsrc
+!/.jshintrc
+!/.travis.yml
+/bower_components/
+/node_modules/
+/output/

.jscsrc

@@ -0,0 +1,17 @@
+{
+  "preset": "grunt",
+  "disallowSpacesInFunctionExpression": null,
+  "requireSpacesInFunctionExpression": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowSpacesInAnonymousFunctionExpression": null,
+  "requireSpacesInAnonymousFunctionExpression": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowSpacesInsideObjectBrackets": null,
+  "requireSpacesInsideObjectBrackets": "all",
+  "validateQuoteMarks": "\"",
+  "requireCurlyBraces": null
+}

.jshintrc

@@ -0,0 +1,19 @@
+{
+  "bitwise": true,
+  "eqeqeq": true,
+  "forin": true,
+  "freeze": true,
+  "funcscope": true,
+  "futurehostile": true,
+  "strict": "global",
+  "latedef": true,
+  "noarg": true,
+  "nocomma": true,
+  "nonew": true,
+  "notypeof": true,
+  "singleGroups": true,
+  "undef": true,
+  "unused": true,
+  "eqnull": true,
+  "predef": ["exports", "setTimeout", "clearTimeout", "setInterval", "clearInterval"]
+}

.travis.yml

@@ -0,0 +1,23 @@
+language: node_js
+dist: trusty
+sudo: required
+node_js: 6
+env:
+  - PATH=$HOME/purescript:$PATH
+install:
+  - TAG=$(wget -q -O - https://github.com/purescript/purescript/releases/latest --server-response --max-redirect 0 2>&1 | sed -n -e 's/.*Location:.*tag\///p')
+  - wget -O $HOME/purescript.tar.gz https://github.com/purescript/purescript/releases/download/$TAG/linux64.tar.gz
+  - tar -xvf $HOME/purescript.tar.gz -C $HOME/
+  - chmod a+x $HOME/purescript
+  - npm install -g bower
+  - npm install
+script:
+  - bower install --production
+  - npm run -s build
+  - bower install
+  - npm run -s test
+after_success:
+- >-
+  test $TRAVIS_TAG &&
+  echo $GITHUB_TOKEN | pulp login &&
+  echo y | pulp publish --no-push

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 PureScript
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,17 @@
+# purescript-js-timers
+
+[![Latest release](http://img.shields.io/bower/v/purescript-js-timers.svg)](https://github.com/purescript-contrib/purescript-js-timers/releases)
+[![Build Status](https://travis-ci.org/purescript-contrib/purescript-js-timers.svg?branch=master)](https://travis-ci.org/purescript-contrib/purescript-js-timers)
+[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-lightgrey.svg)](http://github.com/garyb)
+
+Low level bindings for JavaScript's timers API.
+
+## Installation
+
+```
+bower install purescript-js-timers
+```
+
+## Documentation
+
+Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-js-timers).

bower.json

@@ -0,0 +1,27 @@
+{
+  "name": "purescript-js-timers",
+  "homepage": "https://github.com/purescript-contrib/purescript-js-timers",
+  "description": "PureScript library for native JavaScript timers",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/purescript-contrib/purescript-js-timers.git"
+  },
+  "ignore": [
+    "**/.*",
+    "bower_components",
+    "node_modules",
+    "output",
+    "test",
+    "bower.json",
+    "package.json"
+  ],
+  "dependencies": {
+    "purescript-eff": "^1.0.0"
+  },
+  "devDependencies": {
+    "purescript-assert": "^1.0.0",
+    "purescript-refs": "^1.0.0",
+    "purescript-console": "^1.0.0"
+  }
+}

package.json

@@ -0,0 +1,15 @@
+{
+  "private": true,
+  "scripts": {
+    "clean": "rimraf output && rimraf .pulp-cache",
+    "build": "jshint src && jscs src && pulp build --censor-lib --strict",
+    "test": "pulp test"
+  },
+  "devDependencies": {
+    "jscs": "^2.8.0",
+    "jshint": "^2.9.1",
+    "pulp": "^9.0.0",
+    "purescript-psa": "^0.3.8",
+    "rimraf": "^2.5.0"
+  }
+}

src/Control/Monad/Eff/Timer.js

@@ -0,0 +1,30 @@
+/* global exports */
+"use strict";
+
+exports.setTimeout = function (ms) {
+  return function (fn) {
+    return function () {
+      return setTimeout(fn, ms);
+    };
+  };
+};
+
+exports.clearTimeout = function (id) {
+  return function () {
+    clearTimeout(id);
+  };
+};
+
+exports.setInterval = function (ms) {
+  return function (fn) {
+    return function () {
+      return setInterval(fn, ms);
+    };
+  };
+};
+
+exports.clearInterval = function (id) {
+  return function () {
+    clearInterval(id);
+  };
+};

src/Control/Monad/Eff/Timer.purs

@@ -0,0 +1,65 @@
+module Control.Monad.Eff.Timer
+  ( TIMER
+  , TimeoutId
+  , setTimeout
+  , clearTimeout
+  , IntervalId
+  , setInterval
+  , clearInterval
+  ) where
+
+import Prelude
+
+import Control.Monad.Eff (Eff)
+
+-- | The effect for the usage of a JavaScript timer.
+foreign import data TIMER :: !
+
+-- | The ID of a timer started with `setTimeout`.
+newtype TimeoutId = TimeoutId Int
+
+derive instance eqTimeoutId :: Eq TimeoutId
+derive instance ordTimeoutId :: Ord TimeoutId
+
+-- | Runs an effectful function after the specified delay in milliseconds. The
+-- | returned `TimeoutId` can be used to cancel the timer before it completes.
+-- |
+-- | The timeout delay value is capped at 4ms by the JS API, any value less than
+-- | this will be clamped.
+foreign import setTimeout
+  :: forall eff
+   . Int
+  -> Eff (timer :: TIMER | eff) Unit
+  -> Eff (timer :: TIMER | eff) TimeoutId
+
+-- | Cancels a timeout. If the timeout has already been cancelled or has already
+-- | elapsed this will have no effect.
+foreign import clearTimeout
+  :: forall eff
+   . TimeoutId
+  -> Eff (timer :: TIMER | eff) Unit
+
+-- | The ID of a timer started with `setInterval`.
+newtype IntervalId = IntervalId Int
+
+derive instance eqIntervalId :: Eq IntervalId
+derive instance ordIntervalId :: Ord IntervalId
+
+-- | Runs an effectful function after on a set interval with the specified delay
+-- | in milliseconds between iterations. The returned `IntervalId` can be used
+-- | to cancel the timer and prevent the interval from running any further.
+-- |
+-- | The interval delay value is capped at 4ms by the JS API, any value less
+-- | than this will be clamped.
+foreign import setInterval
+  :: forall eff
+   . Int
+  -> Eff (timer :: TIMER | eff) Unit
+  -> Eff (timer :: TIMER | eff) IntervalId
+
+-- | Cancels an interval timer. If the interval has already been cancelled this
+-- | will have no effect.
+foreign import clearInterval
+  :: forall eff
+   . IntervalId
+  -> Eff (timer :: TIMER | eff) Unit

test/Main.purs

@@ -0,0 +1,52 @@
+module Test.Main where
+
+import Prelude
+
+import Control.Monad.Eff (Eff)
+import Control.Monad.Eff.Console as C
+import Control.Monad.Eff.Ref as R
+import Control.Monad.Eff.Timer as T
+
+import Test.Assert (ASSERT, assert)
+
+main :: Eff (ref :: R.REF, timer :: T.TIMER, console :: C.CONSOLE, assert :: ASSERT) Unit
+main = do
+  counter <- R.newRef 0
+
+  void $ T.setTimeout 10 do
+    C.log "timeout increment counter"
+    R.modifyRef counter (_ + 1)
+
+  void $ T.setTimeout 50 do
+    C.log "timeout check counter"
+    n <- R.readRef counter
+    assert $ n == 1
+
+  void $ T.setTimeout 100 do
+
+    t <- T.setTimeout 20 do
+      R.modifyRef counter (_ + 1)
+
+    T.clearTimeout t
+
+    void $ T.setTimeout 50 do
+      C.log "check timeout never ran"
+      n <- R.readRef counter
+      assert $ n == 1
+
+  void $ T.setTimeout 200 do
+
+    i <- T.setInterval 20 do
+      C.log "interval increment counter"
+      R.modifyRef counter (_ + 1)
+
+    void $ T.setTimeout 90 do
+      T.clearInterval i
+      C.log "interval check counter"
+      n <- R.readRef counter
+      assert $ n == 5
+
+    void $ T.setTimeout 150 do
+      C.log "check interval has stopped"
+      n <- R.readRef counter
+      assert $ n == 5