Skip to content

Add generators for date and time types #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 8, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"package.json"
],
"dependencies": {
"purescript-enums": "^3.0.0",
"purescript-enums": "^3.1.0",
"purescript-functions": "^3.0.0",
"purescript-generics": "^4.0.0",
"purescript-integers": "^3.0.0",
Expand Down
25 changes: 25 additions & 0 deletions src/Data/Date/Component/Gen.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
module Data.Date.Component.Gen where

import Prelude
import Control.Monad.Gen (class MonadGen, chooseInt)
import Data.Date.Component (Day, Month, Weekday, Year)
import Data.Enum (toEnum)
import Data.Enum.Gen (genBoundedEnum)
import Data.Maybe (fromJust)
import Partial.Unsafe (unsafePartial)

-- | Generates a random `Year` in the range 1900-2100, inclusive.
genYear :: forall m. MonadGen m => m Year
genYear = unsafePartial fromJust <<< toEnum <$> chooseInt 1900 2100

-- | Generates a random `Month` component.
genMonth :: forall m. MonadGen m => m Month
genMonth = genBoundedEnum

-- | Generates a random `Day` component.
genDay :: forall m. MonadGen m => m Day
genDay = genBoundedEnum
Copy link
Contributor

@paf31 paf31 Jun 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this take a Month as an argument?

Copy link
Member Author

@garyb garyb Jun 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, that's a good point. I guess it would need to receive the Year also, in that case.

Maybe it's fine as is though, since you can't construct an invalid Date anyway (canonicalDate will fix it, or exactDate will return Nothing) - but we could add an alternative generator that does take month/year to ensure it will be correct for a specific period.


-- | Generates a random `Weekday` component.
genWeekday :: forall m. MonadGen m => m Weekday
genWeekday = genBoundedEnum
14 changes: 14 additions & 0 deletions src/Data/Date/Gen.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
module Data.Date.Gen
( genDate
, module Data.Date.Component.Gen
) where

import Prelude
import Control.Monad.Gen (class MonadGen)
import Data.Date (Date, canonicalDate)
import Data.Date.Component.Gen (genDay, genMonth, genWeekday, genYear)

-- | Generates a random `Date` between 1st Jan 1900 and 31st Dec 2100,
-- | inclusive.
genDate :: forall m. MonadGen m => m Date
genDate = canonicalDate <$> genYear <*> genMonth <*> genDay
16 changes: 16 additions & 0 deletions src/Data/DateTime/Gen.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
module Data.DateTime.Gen
( genDateTime
, module Data.Date.Gen
, module Data.Time.Gen
) where

import Prelude
import Control.Monad.Gen (class MonadGen)
import Data.Date.Gen (genDate, genDay, genMonth, genWeekday, genYear)
import Data.DateTime (DateTime(..))
import Data.Time.Gen (genHour, genMillisecond, genMinute, genSecond, genTime)

-- | Generates a random `DateTime` between 1st Jan 1900 00:00:00 and
-- | 31st Dec 2100 23:59:59, inclusive.
genDateTime :: forall m. MonadGen m => m DateTime
genDateTime = DateTime <$> genDate <*> genTime
21 changes: 21 additions & 0 deletions src/Data/Time/Component/Gen.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
module Data.Time.Component.Gen where

import Control.Monad.Gen (class MonadGen)
import Data.Enum.Gen (genBoundedEnum)
import Data.Time.Component (Hour, Millisecond, Minute, Second)

-- | Generates a random `Hour` component.
genHour :: forall m. MonadGen m => m Hour
genHour = genBoundedEnum

-- | Generates a random `Minute` component.
genMinute :: forall m. MonadGen m => m Minute
genMinute = genBoundedEnum

-- | Generates a random `Second` component.
genSecond :: forall m. MonadGen m => m Second
genSecond = genBoundedEnum

-- | Generates a random `Millisecond` component.
genMillisecond :: forall m. MonadGen m => m Millisecond
genMillisecond = genBoundedEnum
27 changes: 27 additions & 0 deletions src/Data/Time/Duration/Gen.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
module Data.Time.Duration.Gen where

import Prelude

import Control.Monad.Gen (class MonadGen)
import Control.Monad.Gen as Gen
import Data.Time.Duration (Days(..), Hours(..), Milliseconds(..), Minutes(..), Seconds(..))

-- | Generates a random `Milliseconds` duration, up to 10 minutes.
genMilliseconds :: forall m. MonadGen m => m Milliseconds
genMilliseconds = Milliseconds <$> Gen.chooseFloat 0.0 600000.0

-- | Generates a random `Seconds` duration, up to 10 minutes.
genSeconds :: forall m. MonadGen m => m Seconds
genSeconds = Seconds <$> Gen.chooseFloat 0.0 600.0

-- | Generates a random `Seconds` duration, up to 10 hours.
genMinutes :: forall m. MonadGen m => m Minutes
genMinutes = Minutes <$> Gen.chooseFloat 0.0 600.0

-- | Generates a random `Hours` duration, up to 10 days.
genHours :: forall m. MonadGen m => m Hours
genHours = Hours <$> Gen.chooseFloat 0.0 240.0

-- | Generates a random `Days` duration, up to 6 weeks.
genDays :: forall m. MonadGen m => m Days
genDays = Days <$> Gen.chooseFloat 0.0 42.0
13 changes: 13 additions & 0 deletions src/Data/Time/Gen.purs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module Data.Time.Gen
( genTime
, module Data.Time.Component.Gen
) where

import Prelude
import Control.Monad.Gen (class MonadGen)
import Data.Time (Time(..))
import Data.Time.Component.Gen (genHour, genMillisecond, genMinute, genSecond)

-- | Generates a random `Time` between 00:00:00 and 23:59:59, inclusive.
genTime :: forall m. MonadGen m => m Time
genTime = Time <$> genHour <*> genMinute <*> genSecond <*> genMillisecond