Skip to content

Nest LengthOption and add some more documentation #20

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

Merged
BasThomas merged 1 commit into from
Oct 21, 2018
Merged

Nest LengthOption and add some more documentation #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 28 additions & 10 deletions Analysis/Classes/Analysis.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
import Foundation

/// The option to use when calculating average length. This is either `.word` or `.sentence`.
public enum LengthOption {
case word
case sentence
}

/// An analysis of a `String`.
public struct Analysis {

/// The option to use when calculating average length.
/// This is either `.word` or `.sentence`.
public enum LengthOption {
case word
case sentence
}

/// A typealias of `Double`.
public typealias Percentage = Double

/// A typealias of `Double`.
public typealias Grade = Double

/// The string used to construct the `Analysis`.
Expand Down Expand Up @@ -120,7 +125,10 @@ public struct Analysis {
/// - Parameter caseSensitive: Indicating if words
/// should be counted regardless of their case sensitivity.
/// Defaults to `false`.
public func occurrences(of word: String, caseSensitive: Bool = false) -> Int {
public func occurrences(
of word: String,
caseSensitive: Bool = false
) -> Int {
let word = (caseSensitive) ? word : word.lowercased()
return _wordOccurrences(caseSensitive: caseSensitive)[word] ?? 0
}
Expand All @@ -130,7 +138,10 @@ public struct Analysis {
/// - Parameter caseSensitive: Indicating if words
/// should be counted regardless of their case sensitivity.
/// Defaults to `false`.
public func occurrences(of character: Character, caseSensitive: Bool = false) -> Int {
public func occurrences(
of character: Character,
caseSensitive: Bool = false
) -> Int {
let character = (caseSensitive) ? character : character.lowercased()
return characters
.map { (caseSensitive) ? $0 : $0.lowercased() }
Expand All @@ -154,7 +165,10 @@ public struct Analysis {
/// Defaults to `false`.
///
/// - Returns: A percentage based on the `wordCount()`.
public func frequency(of word: String, caseSensitive: Bool = false) -> Percentage {
public func frequency(
of word: String,
caseSensitive: Bool = false
) -> Percentage {
return Double(occurrences(of: word, caseSensitive: caseSensitive)) / Double(wordCount()) * 100.0
}

Expand All @@ -168,7 +182,11 @@ public struct Analysis {
/// Defaults to `true`.
///
/// - Returns: A percentage based on the `characterCount()`.
public func frequency(of character: Character, caseSensitive: Bool = false, includingSpaces: Bool = true) -> Percentage {
public func frequency(
of character: Character,
caseSensitive: Bool = false,
includingSpaces: Bool = true
) -> Percentage {
return Double(occurrences(of: character, caseSensitive: caseSensitive)) / Double(characterCount(includingSpaces: includingSpaces)) * 100.0
}

Expand Down