Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix negative duration #1317

Merged
merged 6 commits into from
Jan 21, 2021
Merged

Fix negative duration #1317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4181855
Fix negative duration
kamontat Jan 6, 2021
002011a
add test
kamontat Jan 6, 2021
09e2ac9
Forget to commit
kamontat Jan 6, 2021
5557149
add more test
kamontat Jan 6, 2021
683a563
correct ISOString()
kamontat Jan 11, 2021
3ae2d4b
Update index.js
kamontat Jan 21, 2021
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
101 changes: 79 additions & 22 deletions src/plugin/duration/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
import { MILLISECONDS_A_DAY, MILLISECONDS_A_HOUR, MILLISECONDS_A_MINUTE, MILLISECONDS_A_SECOND, MILLISECONDS_A_WEEK, REGEX_FORMAT } from '../../constant'
import {
MILLISECONDS_A_DAY,
MILLISECONDS_A_HOUR,
MILLISECONDS_A_MINUTE,
MILLISECONDS_A_SECOND,
MILLISECONDS_A_WEEK,
REGEX_FORMAT
} from '../../constant'

const MILLISECONDS_A_YEAR = MILLISECONDS_A_DAY * 365
const MILLISECONDS_A_MONTH = MILLISECONDS_A_DAY * 30
Expand All @@ -16,7 +23,7 @@ const unitToMS = {
weeks: MILLISECONDS_A_WEEK
}

const isDuration = d => (d instanceof Duration) // eslint-disable-line no-use-before-define
const isDuration = d => d instanceof Duration // eslint-disable-line no-use-before-define

let $d
let $u
Expand All @@ -25,6 +32,30 @@ const wrapper = (input, instance, unit) =>
new Duration(input, unit, instance.$l) // eslint-disable-line no-use-before-define

const prettyUnit = unit => `${$u.p(unit)}s`
const isNegative = number => number < 0
const roundNumber = number =>
(isNegative(number) ? Math.ceil(number) : Math.floor(number))
const absolute = number => Math.abs(number)
const getNumberUnitFormat = (number, unit) => {
if (!number) {
return {
negative: false,
format: ''
}
}

if (isNegative(number)) {
return {
negative: true,
format: `${absolute(number)}${unit}`
}
}

return {
negative: false,
format: `${number}${unit}`
}
}

class Duration {
constructor(input, unit, locale) {
Expand All @@ -49,8 +80,14 @@ class Duration {
const d = input.match(durationRegex)
if (d) {
[,,
this.$d.years, this.$d.months, this.$d.weeks,
this.$d.days, this.$d.hours, this.$d.minutes, this.$d.seconds] = d
this.$d.years,
this.$d.months,
this.$d.weeks,
this.$d.days,
this.$d.hours,
this.$d.minutes,
this.$d.seconds
] = d
this.calMilliseconds()
return this
}
Expand All @@ -66,39 +103,54 @@ class Duration {

parseFromMilliseconds() {
let { $ms } = this
this.$d.years = Math.floor($ms / MILLISECONDS_A_YEAR)
this.$d.years = roundNumber($ms / MILLISECONDS_A_YEAR)
$ms %= MILLISECONDS_A_YEAR
this.$d.months = Math.floor($ms / MILLISECONDS_A_MONTH)
this.$d.months = roundNumber($ms / MILLISECONDS_A_MONTH)
$ms %= MILLISECONDS_A_MONTH
this.$d.days = Math.floor($ms / MILLISECONDS_A_DAY)
this.$d.days = roundNumber($ms / MILLISECONDS_A_DAY)
$ms %= MILLISECONDS_A_DAY
this.$d.hours = Math.floor($ms / MILLISECONDS_A_HOUR)
this.$d.hours = roundNumber($ms / MILLISECONDS_A_HOUR)
$ms %= MILLISECONDS_A_HOUR
this.$d.minutes = Math.floor($ms / MILLISECONDS_A_MINUTE)
this.$d.minutes = roundNumber($ms / MILLISECONDS_A_MINUTE)
$ms %= MILLISECONDS_A_MINUTE
this.$d.seconds = Math.floor($ms / MILLISECONDS_A_SECOND)
this.$d.seconds = roundNumber($ms / MILLISECONDS_A_SECOND)
$ms %= MILLISECONDS_A_SECOND
this.$d.milliseconds = $ms
}

toISOString() {
const Y = this.$d.years ? `${this.$d.years}Y` : ''
const M = this.$d.months ? `${this.$d.months}M` : ''
const Y = getNumberUnitFormat(this.$d.years, 'Y')
const M = getNumberUnitFormat(this.$d.months, 'M')

let days = +this.$d.days || 0
if (this.$d.weeks) {
days += this.$d.weeks * 7
}
const D = days ? `${days}D` : ''
const H = this.$d.hours ? `${this.$d.hours}H` : ''
const m = this.$d.minutes ? `${this.$d.minutes}M` : ''

const D = getNumberUnitFormat(days, 'D')
const H = getNumberUnitFormat(this.$d.hours, 'H')
const m = getNumberUnitFormat(this.$d.minutes, 'M')

let seconds = this.$d.seconds || 0
if (this.$d.milliseconds) {
seconds += this.$d.milliseconds / 1000
}
const S = seconds ? `${seconds}S` : ''
const T = (H || m || S) ? 'T' : ''
const result = `P${Y}${M}${D}${T}${H}${m}${S}`
return result === 'P' ? 'P0D' : result

const S = getNumberUnitFormat(seconds, 'S')

const negativeMode =
Y.negative ||
M.negative ||
D.negative ||
H.negative ||
m.negative ||
S.negative

const T = H.format || m.format || S.format ? 'T' : ''
const P = negativeMode ? '-' : ''

const result = `${P}P${Y.format}${M.format}${D.format}${T}${H.format}${m.format}${S.format}`
return result === 'P' || result === '-P' ? 'P0D' : result
}

toJSON() {
Expand Down Expand Up @@ -136,11 +188,11 @@ class Duration {
if (pUnit === 'milliseconds') {
base %= 1000
} else if (pUnit === 'weeks') {
base = Math.floor(base / unitToMS[pUnit])
base = roundNumber(base / unitToMS[pUnit])
} else {
base = this.$d[pUnit]
}
return base
return base === 0 ? 0 : base // a === 0 will be true on both 0 and -0
}

add(input, unit, isSubtract) {
Expand All @@ -152,6 +204,7 @@ class Duration {
} else {
another = wrapper(input, this).$ms
}

return wrapper(this.$ms + (another * (isSubtract ? -1 : 1)), this)
}

Expand All @@ -170,7 +223,10 @@ class Duration {
}

humanize(withSuffix) {
return $d().add(this.$ms, 'ms').locale(this.$l).fromNow(!withSuffix)
return $d()
.add(this.$ms, 'ms')
.locale(this.$l)
.fromNow(!withSuffix)
}

milliseconds() { return this.get('milliseconds') }
Expand All @@ -190,6 +246,7 @@ class Duration {
years() { return this.get('years') }
asYears() { return this.as('years') }
}

export default (option, Dayjs, dayjs) => {
$d = dayjs
$u = dayjs().$utils()
Expand Down
42 changes: 39 additions & 3 deletions test/plugin/duration.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ describe('Creating', () => {
expect(dayjs.duration(60, 'seconds').toISOString()).toBe('PT1M')
expect(dayjs.duration(13213, 'seconds').toISOString()).toBe('PT3H40M13S')
})
it('two argument will bubble up to the next (negative number)', () => {
expect(dayjs.duration(-59, 'seconds').toISOString()).toBe('-PT59S')
expect(dayjs.duration(-60, 'seconds').toISOString()).toBe('-PT1M')
expect(dayjs.duration(-13213, 'seconds').toISOString()).toBe('-PT3H40M13S')
})
it('object with float', () => {
expect(dayjs.duration({
seconds: 1,
Expand All @@ -53,9 +58,13 @@ describe('Creating', () => {
ms: 1
}).toISOString()).toBe('PT0.001S')
})
it('object with negative millisecond', () => {
expect(dayjs.duration({
ms: -1
}).toISOString()).toBe('-PT0.001S')
})
})


describe('Parse ISO string', () => {
it('Full ISO string', () => {
expect(dayjs.duration('P7Y6M4DT3H2M1S').toISOString()).toBe('P7Y6M4DT3H2M1S')
Expand Down Expand Up @@ -131,6 +140,26 @@ describe('Milliseconds', () => {
expect(dayjs.duration(15000).asMilliseconds()).toBe(15000)
})

describe('Milliseconds', () => {
describe('Positive number', () => {
expect(dayjs.duration(500).milliseconds()).toBe(500)
expect(dayjs.duration(1500).milliseconds()).toBe(500)
expect(dayjs.duration(15000).milliseconds()).toBe(0)
expect(dayjs.duration(500).asMilliseconds()).toBe(500)
expect(dayjs.duration(1500).asMilliseconds()).toBe(1500)
expect(dayjs.duration(15000).asMilliseconds()).toBe(15000)
})

describe('Negative number', () => {
expect(dayjs.duration(-500).milliseconds()).toBe(-500)
expect(dayjs.duration(-1500).milliseconds()).toBe(-500)
expect(dayjs.duration(-15000).milliseconds()).toBe(0)
expect(dayjs.duration(-500).asMilliseconds()).toBe(-500)
expect(dayjs.duration(-1500).asMilliseconds()).toBe(-1500)
expect(dayjs.duration(-15000).asMilliseconds()).toBe(-15000)
})
})

describe('Add', () => {
const a = dayjs.duration(1, 'days')
const b = dayjs.duration(2, 'days')
Expand Down Expand Up @@ -179,8 +208,15 @@ describe('Hours', () => {
})

describe('Days', () => {
expect(dayjs.duration(100000000).days()).toBe(1)
expect(dayjs.duration(100000000).asDays().toFixed(2)).toBe('1.16')
it('positive number', () => {
expect(dayjs.duration(100000000).days()).toBe(1)
expect(dayjs.duration(100000000).asDays().toFixed(2)).toBe('1.16')
})

it('negative number', () => {
expect(dayjs.duration(-1).days()).toBe(0)
expect(dayjs.duration(-86399999).asDays()).toBeCloseTo(-0.999999, 4)
})
})

describe('Weeks', () => {
Expand Down