Prep for v1.0.0

Author: jamesdbrock

.github/workflows/ci.yml

@@ -30,5 +30,11 @@ jobs:
       - name: Build source
         run: spago build --no-install --purs-args '--censor-lib --strict'
 
+      - name: Install test dependencies
+        run: spago -x test.dhall install
+
+      - name: Build tests
+        run: spago -x test.dhall build --no-install --purs-args '--censor-lib --strict'
+
       - name: Run tests
-        run: spago test --no-install
+        run: spago -x test.dhall test --no-install

CHANGELOG.md

@@ -4,10 +4,11 @@ Notable changes to this project are documented in this file. The format is based
 
 ## [Unreleased]
 
-Breaking changes (😱!!!):
+## v1.0.0 2021-06-23
 
-New features:
+Thank you Athan Clark for donating this package to __purescript-contrib__.
 
-Bugfixes:
+Remove the `Generic` instance of `Float32`, it’s no longer needed. We don't
+expect this change to break any dependent code.
 
-Other improvements:
+Move the testing dependencies to `test.dhall`.

README.md

@@ -1,11 +1,17 @@
-# Float32
+# float32
 
 [![CI](https://github.com/purescript-contrib/purescript-float32/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-float32/actions?query=workflow%3ACI+branch%3Amain)
 [![Release](https://img.shields.io/github/release/purescript-contrib/purescript-float32.svg)](https://github.com/purescript-contrib/purescript-float32/releases)
 [![Pursuit](https://pursuit.purescript.org/packages/purescript-float32/badge)](https://pursuit.purescript.org/packages/purescript-float32)
 [![Maintainer: jamesdbrock](https://img.shields.io/badge/maintainer-jamesdbrock-teal.svg)](https://github.com/jamesdbrock)
 
-The library summary hasn't been written yet (contributions are welcome!). The library summary describes the library's purpose in one to three sentences.
+Provides the
+[32-bit single-precision floating-point](https://en.wikipedia.org/wiki/Single-precision_floating-point_format)
+data type `Float32` and operations.
+
+`Float32` is a `newtype` wrapper around `Number`, where
+entering into the type can only be done with
+[`Math.fround()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/fround).
 
 ## Installation
 
@@ -41,3 +47,11 @@ You can contribute to `float32` in several ways:
 2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
 
 3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.
+
+## Development
+
+Run the tests with
+
+```sh
+spago -x test.dhall test
+```

bower.json

@@ -5,7 +5,7 @@
     ],
     "repository": {
         "type": "git",
-        "url": "https://github.com/jamesdbrock/purescript-float32.git"
+        "url": "https://github.com/purescript-contrib/purescript-float32.git"
     },
     "ignore": [
         "**/.*",
@@ -14,7 +14,6 @@
         "output"
     ],
     "dependencies": {
-        "purescript-effect": "^v3.0.0",
         "purescript-gen": "^v3.0.0",
         "purescript-maybe": "^v5.0.0",
         "purescript-prelude": "^v5.0.0",

spago.dhall

@@ -1,13 +1,12 @@
 { name = "float32"
 , license = "BSD-3-Clause"
 , dependencies =
-  [ "effect"
-  , "gen"
+  [ "gen"
   , "maybe"
   , "prelude"
   , "psci-support"
   ]
 , packages = ./packages.dhall
 , sources = [ "src/**/*.purs" ]
-, repository = "https://github.com/jamesdbrock/purescript-float32.git"
+, repository = "https://github.com/purescript-contrib/purescript-float32.git"
 }

src/Data/Float32.purs

@@ -6,12 +6,12 @@ import Prelude
   ( class Eq, class Ord, class Show, class Semiring, class Ring, class Bounded, class EuclideanRing
   , class CommutativeRing, class DivisionRing
   , top, bottom, (==), (||))
-import Data.Generic.Rep (class Generic)
 import Data.Maybe (Maybe (..))
 
+-- | [32-bit single-precision floating-point](https://en.wikipedia.org/wiki/Single-precision_floating-point_format)
+-- | number.
 newtype Float32 = Float32 Number
 
-derive instance genericeFloat32 :: Generic Float32 _
 derive newtype instance eqFloat32 :: Eq Float32
 derive newtype instance ordFloat32 :: Ord Float32
 derive newtype instance semiringFloat32 :: Semiring Float32
@@ -29,13 +29,15 @@ foreign import float32Top :: Float32
 foreign import float32Bottom :: Float32
 
 
--- | Uses `Math.fround()` to convert to a 32bit float
+-- | Uses `Math.fround()` to convert to a `Float32`.
+-- | Returns `Nothing` when outside the range.
 fromNumber :: Number -> Maybe Float32
 fromNumber x =
   let r = fromNumberImpl x
   in  if r == top || r == bottom then Nothing else Just (Float32 r)
 
--- | Casts to `0` when outside the range.
+-- | Uses `Math.fround()` to convert to a `Float32`.
+-- | Returns *0.0* when outside the range.
 fromNumber' :: Number -> Float32
 fromNumber' x = case fromNumber x of
   Nothing -> Float32 0.0

test.dhall

@@ -2,7 +2,8 @@ let conf = ./spago.dhall
 
 in conf // {
 , dependencies = conf.dependencies #
-  [ "quickcheck"
+  [ "effect"
+  , "quickcheck"
   , "quickcheck-laws"
   ]
 , sources = conf.sources # [ "test/**/*.purs" ]

test/Main.purs

@@ -1,15 +1,13 @@
 module Test.Main where
 
 import Prelude
+
 import Data.Float32 (Float32)
 import Data.Float32.Gen (chooseFloat32)
-
 import Effect (Effect)
-import Type.Proxy (Proxy (..))
 import Test.QuickCheck (class Arbitrary)
-import Test.QuickCheck.Laws.Data
-  ( checkBounded, checkEq, checkOrd, checkSemiring, checkRing, checkCommutativeRing
-  , checkDivisionRing, checkEuclideanRing)
+import Test.QuickCheck.Laws.Data (checkBounded, checkCommutativeRing, checkEq, checkOrd, checkRing, checkSemiring)
+import Type.Proxy (Proxy(..))
 
 newtype Float32' = Float32' Float32
 derive newtype instance eqFloat32' :: Eq Float32'