Skip to content

SR-7481: NumberFormatter inconsistency on Linux #1530

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 2 commits into from
Apr 25, 2018
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
70 changes: 51 additions & 19 deletions Foundation/NumberFormatter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ internal let kCFNumberFormatterCurrencyAccountingStyle = CFNumberFormatterStyle.

extension NumberFormatter {
public enum Style : UInt {
case none
case decimal
case currency
case percent
case scientific
case spellOut
case ordinal
case currencyISOCode
case currencyPlural
case currencyAccounting
case none = 0
case decimal = 1
case currency = 2
case percent = 3
case scientific = 4
case spellOut = 5
case ordinal = 6
case currencyISOCode = 8 // 7 is not used
case currencyPlural = 9
case currencyAccounting = 10
}

public enum PadPosition : UInt {
Expand Down Expand Up @@ -140,7 +140,7 @@ open class NumberFormatter : Formatter {
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterPlusSign, value: _plusSign?._cfObject)
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterCurrencySymbol, value: _currencySymbol?._cfObject)
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterExponentSymbol, value: _exponentSymbol?._cfObject)
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterMinIntegerDigits, value: _minimumIntegerDigits._bridgeToObjectiveC()._cfObject)
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterMinIntegerDigits, value: minimumIntegerDigits._bridgeToObjectiveC()._cfObject)
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterMaxIntegerDigits, value: _maximumIntegerDigits._bridgeToObjectiveC()._cfObject)
_setFormatterAttribute(formatter, attributeName: kCFNumberFormatterMinFractionDigits, value: _minimumFractionDigits._bridgeToObjectiveC()._cfObject)
if _minimumFractionDigits <= 0 {
Expand Down Expand Up @@ -187,24 +187,53 @@ open class NumberFormatter : Formatter {
case .none, .ordinal, .spellOut:
_usesSignificantDigits = false

case .currency, .currencyPlural, .currencyISOCode, .currencyAccounting:
case .currency, .currencyISOCode, .currencyAccounting:
_usesSignificantDigits = false
_usesGroupingSeparator = true
if _minimumIntegerDigits == nil {
_minimumIntegerDigits = 1
}
if _groupingSize == 0 {
_groupingSize = 3
}
_minimumFractionDigits = 2


case .currencyPlural:
_usesSignificantDigits = false
_usesGroupingSeparator = true
if _minimumIntegerDigits == nil {
_minimumIntegerDigits = 0
}
_minimumFractionDigits = 2

case .decimal:
_usesGroupingSeparator = true
_maximumFractionDigits = 3
if _minimumIntegerDigits == 0 {
if _minimumIntegerDigits == nil {
_minimumIntegerDigits = 1
}
if _groupingSize == 0 {
_groupingSize = 3
}

default:
_usesSignificantDigits = true
case .percent:
_usesSignificantDigits = false
_usesGroupingSeparator = true
if _minimumIntegerDigits == nil {
_minimumIntegerDigits = 1
}
if _groupingSize == 0 {
_groupingSize = 3
}
_minimumFractionDigits = 0
_maximumFractionDigits = 0

case .scientific:
_usesSignificantDigits = false
_usesGroupingSeparator = false
if _minimumIntegerDigits == nil {
_minimumIntegerDigits = 0
}
}
_reset()
_numberStyle = newValue
Expand Down Expand Up @@ -680,11 +709,14 @@ open class NumberFormatter : Formatter {
_roundingIncrement = newValue
}
}

internal var _minimumIntegerDigits: Int = 0

// Use an optional for _minimumIntegerDigits to track if the value is
// set BEFORE the .numberStyle is changed. This allows preserving a setting
// of 0.
internal var _minimumIntegerDigits: Int?
open var minimumIntegerDigits: Int {
get {
return _minimumIntegerDigits
return _minimumIntegerDigits ?? 0
}
set {
_reset()
Expand Down
198 changes: 195 additions & 3 deletions TestFoundation/TestNumberFormatter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,15 @@ class TestNumberFormatter: XCTestCase {
("test_plusSignSymbol", test_plusSignSymbol),
("test_currencySymbol", test_currencySymbol),
("test_exponentSymbol", test_exponentSymbol),
("test_minimumIntegerDigits", test_minimumIntegerDigits),
("test_decimalMinimumIntegerDigits", test_decimalMinimumIntegerDigits),
("test_currencyMinimumIntegerDigits", test_currencyMinimumIntegerDigits),
("test_percentMinimumIntegerDigits", test_percentMinimumIntegerDigits),
("test_scientificMinimumIntegerDigits", test_scientificMinimumIntegerDigits),
("test_spellOutMinimumIntegerDigits", test_spellOutMinimumIntegerDigits),
("test_ordinalMinimumIntegerDigits", test_ordinalMinimumIntegerDigits),
("test_currencyPluralMinimumIntegerDigits", test_currencyPluralMinimumIntegerDigits),
("test_currencyISOCodeMinimumIntegerDigits", test_currencyISOCodeMinimumIntegerDigits),
("test_currencyAccountingMinimumIntegerDigits", test_currencyAccountingMinimumIntegerDigits),
("test_maximumIntegerDigits", test_maximumIntegerDigits),
("test_minimumFractionDigits", test_minimumFractionDigits),
("test_maximumFractionDigits", test_maximumFractionDigits),
Expand Down Expand Up @@ -210,7 +218,7 @@ class TestNumberFormatter: XCTestCase {
XCTAssertEqual(formattedString, "4.2⬆️1")
}

func test_minimumIntegerDigits() {
func test_decimalMinimumIntegerDigits() {
let numberFormatter1 = NumberFormatter()
XCTAssertEqual(numberFormatter1.minimumIntegerDigits, 0)
numberFormatter1.minimumIntegerDigits = 3
Expand All @@ -230,7 +238,191 @@ class TestNumberFormatter: XCTestCase {
formattedString = numberFormatter.string(from: 0.1)
XCTAssertEqual(formattedString, "000.1")
}


func test_currencyMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .currency
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "$.00")
XCTAssertEqual(formatter.string(from: 1.23), "$1.23")
XCTAssertEqual(formatter.string(from: 123.4), "$123.40")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .currency
XCTAssertEqual(formatter2.minimumIntegerDigits, 1)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.001), "$0.00")
XCTAssertEqual(formatter2.string(from: 1.234), "$1.23")
XCTAssertEqual(formatter2.string(from: 123456.7), "$123,456.70")
}

func test_percentMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .percent
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "0%")
XCTAssertEqual(formatter.string(from: 1.234), "123%")
XCTAssertEqual(formatter.string(from: 123.4), "12,340%")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .percent
XCTAssertEqual(formatter2.minimumIntegerDigits, 1)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.01), "1%")
XCTAssertEqual(formatter2.string(from: 1.234), "123%")
XCTAssertEqual(formatter2.string(from: 123456.7), "12,345,670%")
}

func test_scientificMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .scientific
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "0E0")
XCTAssertEqual(formatter.string(from: 1.23), "1.23E0")
XCTAssertEqual(formatter.string(from: 123.4), "1.234E2")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .scientific
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.01), "1E-2")
XCTAssertEqual(formatter2.string(from: 1.234), "1.234E0")
XCTAssertEqual(formatter2.string(from: 123456.7), "1.234567E5")
}

func test_spellOutMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .spellOut
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "zero")
XCTAssertEqual(formatter.string(from: 1.23), "one point two three")
XCTAssertEqual(formatter.string(from: 123.4), "one hundred twenty-three point four")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .spellOut
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.01), "zero point zero one")
XCTAssertEqual(formatter2.string(from: 1.234), "one point two three four")
XCTAssertEqual(formatter2.string(from: 123456.7), "one hundred twenty-three thousand four hundred fifty-six point seven")
}

func test_ordinalMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .ordinal
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "0th")
XCTAssertEqual(formatter.string(from: 1.23), "1st")
XCTAssertEqual(formatter.string(from: 123.4), "123rd")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .ordinal
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.01), "0th")
XCTAssertEqual(formatter2.string(from: 4.234), "4th")
XCTAssertEqual(formatter2.string(from: 42), "42nd")
}

func test_currencyPluralMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .currencyPlural
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "0.00 US dollars")
XCTAssertEqual(formatter.string(from: 1.23), "1.23 US dollars")
XCTAssertEqual(formatter.string(from: 123.4), "123.40 US dollars")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .currencyPlural
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.01), "0.01 US dollars")
XCTAssertEqual(formatter2.string(from: 1.234), "1.23 US dollars")
XCTAssertEqual(formatter2.string(from: 123456.7), "123,456.70 US dollars")
}

func test_currencyISOCodeMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .currencyISOCode
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "USD.00")
XCTAssertEqual(formatter.string(from: 1.23), "USD1.23")
XCTAssertEqual(formatter.string(from: 123.4), "USD123.40")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .currencyISOCode
XCTAssertEqual(formatter2.minimumIntegerDigits, 1)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0.01), "USD0.01")
XCTAssertEqual(formatter2.string(from: 1.234), "USD1.23")
XCTAssertEqual(formatter2.string(from: 123456.7), "USD123,456.70")
}

func test_currencyAccountingMinimumIntegerDigits() {
// If .minimumIntegerDigits is set to 0 before .numberStyle change, preserve the value
let formatter = NumberFormatter()
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.minimumIntegerDigits = 0
formatter.numberStyle = .currencyAccounting
XCTAssertEqual(formatter.minimumIntegerDigits, 0)
formatter.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter.string(from: 0), "$.00")
XCTAssertEqual(formatter.string(from: 1.23), "$1.23")
XCTAssertEqual(formatter.string(from: 123.4), "$123.40")

// If .minimumIntegerDigits is not set before .numberStyle change, update the value
let formatter2 = NumberFormatter()
XCTAssertEqual(formatter2.minimumIntegerDigits, 0)
formatter2.numberStyle = .currencyAccounting
XCTAssertEqual(formatter2.minimumIntegerDigits, 1)
formatter2.locale = Locale(identifier: "en_US")
XCTAssertEqual(formatter2.string(from: 0), "$0.00")
XCTAssertEqual(formatter2.string(from: 1.23), "$1.23")
XCTAssertEqual(formatter2.string(from: 123.4), "$123.40")
}

func test_maximumIntegerDigits() {
let numberFormatter = NumberFormatter()
numberFormatter.maximumIntegerDigits = 3
Expand Down