ohdair/ios-calculator

iOS_calculator README (Joo & Lust3r)

---

🧮 계산기 동작

## 🗂️ 프로젝트 파일 구조

---

🕵🏻 역할 분배

enum	역할
Operator	Character, CalculateItem, CaseIterable을 채택하였고, 각 연산자 case 및 각 연산자가 들어왔을 때 그에 맞는 연산을 할 수 있도록 calculate 메서드를 정의
ExpressionParser	String 형태의 숫자 배열을 반환하는 componentsByOperators와 연산자 배열을 반환하는 extractOperators메서드를 사용하여 input 값을 파싱하고, 그 값을 통해 Formula를 구성하여 반환하는 기능

struct	역할
Formula	Double 타입의 CalculateItemQueue를 갖는 operands와 Operator 타입의 CalculateItemQueue를 갖는 operators를 프로퍼티로 삼은 구조체. result 메서드를 통해 각 ItemQueue에서 값을 dequeue하여 결과값을 Double로 반환
CalculatorItemQueue	제네릭 타입의 배열을 queue로 가지며, 인자로 받은 어떠한 타입의 배열도 init에서 enqueue 과정을 통해 해당 타입의 queue를 생성. queue의 기본적인 기능인 enqueue와 dequeue, 그리고 큐를 비우는 allClear 메서드를 포함

protocol	역할
CalculateItem	Operator, Double에서 CalculateItem를 채택하여 CalculateItemQueue의 요소로 사용될 수 있도록 생성

extension	역할
Operator	연산자를 열거형으로 정의. calculate 메서드에서 private 타입의 add, substract, divide, multiply 메서드를 사용할 수 있도록 구현. 은닉화된 연산 메서드들은 이름과 동일한 계산해서 Double값으로 반환
Double	CalculateItemQueue의 요소로 사용되도록 CalculateItem을 채택

function	역할
allClear	입력받았던 내용들을 초기화
clearEntry	입력받은 숫자 혹은 소수점을 제거 (단, 결과값은 삭제 불가)
changeSign	입력받은 숫자의 부호를 변경, 음수라면 양수로 변환을 하고 양수라면 음수로 변환
addDecimalPoint	입력받은 숫자의 소수점을 부여 (단, 이미 입력받았다면 입력 불가)
addOperand	계산하고자 하는 숫자를 입력
addOperator	계산하고자 하는 연산자를 입력, 숫자를 입력받은 상태가 아니라면 기존의 연산자를 변경
calculateResult	계산을 하고자 추가한 식들을 계산하여 반환
addFormulaStackView	입력된 operand와 operator로 UILabel을 생성하고, Stack에 addArrangedSubView를 통해 담은 후 ScrollView에서 볼 수 있도록 추가
formattingNumber	NumberFormatter()를 사용하기 위한 함수로, formatter 설정을 통해 소수점 자리수 20, numberStyle = .decimal을 통해 천단위 구분 표시를 할 수 있도록 함
convertOperand	정수부를 천단위 구분 표시 하면서 소수부가 '0'이나 '00'이어도 같이 화면에 보일 수 있도록 operand를 정수부와 소수부로 나누어 정수부는 Formatting 진행, 소수부는 그 결과에 덧붙이는 식으로 operand를 convert
isInitialOperand	enteredOperand가 초기값인 '0'인지 확인

---

Step1 - Queue 타입 구현

PR #13 | Step1 - Queue 타입 구현

구현 내용

• Queue타입으로 구현을 하기 위해서 enqueue, dequeue를 필수 구현
• Queue의 요소에서 사용될 타입을 CalculateItem으로 채택

---

Step2 - 계산 타입 및 주변 타입 구현

PR #21 | Step2 - 계산 타입 및 주변 타입 구현

구현 내용

• UML에 맞게 각 구성요소 구현
  • CalculateItem 프로토콜을 채택하는 extension Double, Enum Operator 구현
  • input값을 파싱하는 역할의 parse와, 숫자와 연산자 배열을 반환할 componentsByOperators, extractOperators구현
  • 두 개의 CalculateItemQueue를 갖는 struct Formula 구현

---

Step3 - 계산기 UI 연동

PR 대기 | Step3

구현 내용

• 사용자의 터치 이벤트를 수신하여 그 이벤트로 발생하는 숫자와 연산자의 연산 결과를 내기 위해 각 버튼을 연결하고, 터치 이벤트 수신시 실행할 기능을 작성하였습니다.
  입력된 내용은 결과값 위쪽 공간에 스크롤이 가능하도록 stack처리하였고, 그 내역이 상단 공간을 넘어 이어지는 경우에는 스크롤이 하단으로 자동으로 이동하여 최근 내역을 볼 수 있도록 하였습니다.

---

📓 학습내용 요점

1. generic function

제네릭 형식의 함수는 함수 이름 뒤에 꺽쇠 괄호안의 자리 표시자 형식(the placeholder type name) <T>가 들어옵니다.

func makeQueue<T>(from elements: Array<T>) -> CalculateItemQueue<T> {

함수의 제네릭 버전에서는 실제 형식 이름(예: Int, String 또는 Double) 대신 자리 표시자 형식 이름(이 경우 T라고 함)을 사용합니다. 자리 표시자 유형 이름은 T가 무엇이어야 하는지에 대해 아무 말도 하지 않지만 T가 나타내는 것이 무엇이든 a와 b 모두 동일한 유형 T여야 한다고 말합니다

참고 : 공식 문서

2. enum method

Type Methods 실제 Object를 생성할 필요 없이 내부의 (프로퍼티), 메소드에 접근하기 위해서 사용

enum ExpressionParser {
    static func parse(from input: String) -> Formula {
        // ...
        let operatorQueue: CalculateItemQueue<Operator> = makeQueue(from: operators)
    }
    static func makeQueue<T>(from elements: Array<T>) -> CalculateItemQueue<T> {
        // ...
    }
}
ExpressionParser.parse(from: "+13-7+12*5+9")

형식 메서드의 본문 내에서 사용하는 정규화되지 않은 메서드 및 속성 이름은 다른 형식 수준 메서드 및 속성을 참조합니다. 형식 메서드는 형식 이름을 접두사로 추가할 필요 없이 다른 형식 메서드의 이름으로 다른 형식 메서드를 호출할 수 있습니다. 마찬가지로 구조 및 열거형의 형식 메서드는 형식 이름 접두사 없이 형식 속성의 이름을 사용하여 형식 속성에 액세스할 수 있습니다.

참고 : 공식 문서

3. compactMap

시퀀스의 각 요소로 지정된 변환에서 nil이 아닌 결과의 배열을 반환하는 compactMap을 이용해서 간략해진 코드로 Double 타입의 값들을 얻을 수 있었습니다.

let splittedStringArray = "+13-7+12*5+9".components(separatedBy: "+-*/")
let doubleArray= splittedStringArray.compactMap { Double($0) }

참고 : 공식 문서

4. CharacterSet

검색 작업에 사용할 유니코드 문자 값 세트. 본 프로젝트에서는 String 내에서 Operator Character를 CharacterSet으로 만들어 검색작업을 진행했습니다.

static func componentsByOperators(from input: String) -> [String] {
    let operators: String = String(Operator.allCases.map { $0.rawValue })
    let operatorSet: CharacterSet = CharacterSet(charactersIn: operators)
    return input.components(separatedBy: operatorSet)
}

참고 : 공식 문서

5. UIScrollView / UIStackView

스크롤 뷰 구조를 보니 연산내역이 담긴 스택들을 담은 스택이 있는 구조여서 (ScrollView > StackView > StackView/StackView) 그 구조에 맞게 연산자와 숫자를 담을 Label을 생성한 후, StackView에 담아 연산내역이 담긴 스택들을 담은 스택에 추가하는 방식을 사용했습니다.

private func addFormulaStackView(`operator`: String, operand: String) {
    let formulaStackView = UIStackView()
    let enteredOperatorLabel = UILabel()
    let enteredOperandLabel = UILabel()
    //...
    formulaStackView.addArrangedSubview(enteredOperatorLabel)
    formulaStackView.addArrangedSubview(enteredOperandLabel)

    formulaStackViews.addArrangedSubview(formulaStackView)
}

참고 1 : 공식 문서 참고 2 : 공식 문서

6. NumberFormatter

소수점 아래 20자리 표시, 정수부 천단위 표시를 위해 NumberFormatter를 이용하였습니다. numberStyle = .decimal을 통해 천단위 표시를 할 수 있었고, maximumFractionDigits = 20을 통해 최대 소수점 자리를 20으로 설정할 수 있었습니다.

private func formattingNumber(_ number: String) -> String {
    let formatter = NumberFormatter()
    formatter.maximumFractionDigits = 20
    formatter.numberStyle = .decimal
    return formatter.string(for: Double(number)) ?? number
}

참고 : 공식 문서

---

🧨 트러블 슈팅

1. [Step 1] 유닛테스트 시 XCTAssertEqual을 사용할 때 오류가 발생하여 queue에 들어가는 Item에 Equatable 프로토콜을 채택하여 해결하였습니다
2. [Step 1] Unit Test를 진행하면서 dequeue를 사용하면 isEmpty가 false인 상황에서는 문제가 되지 않지만 true일 때는 warning이 발생하여 @discardableResult를 사용하여 해결하였습니다.
3. [Step 2] UML에서 요구한 split에서는 Character를 target으로 하기에는 원하는 결과가 나오지 않아 components(separatedBy: CharacterSet)를 사용하여 구분자에 맞춰 문자열로 반환하였습니다.
4. [Step 3] AC의 버튼의 경우, scrollView내에 존재하는 subViews의 객체들을 삭제하기 위해서 removeArrangedSubview을 사용하였으나 삭제되지 않았습니다. 해결하기 위해서 removeFromSuperview도 사용을 하여서 내부에 존재하는 subViews를 삭제하였습니다.