-
Notifications
You must be signed in to change notification settings - Fork 58
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
Added StringFilters.camelToSnakeCase filter #24
Changes from 1 commit
74e6c16
7b9be34
b2b6d43
b715499
872c030
fd87056
de6e46b
1089dbe
852a67b
1148a85
b0cdda3
a6f82af
07394dd
cc3ed98
4672b9a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -96,7 +96,7 @@ struct StringFilters { | |
/// - returns: the snake case string | ||
/// - throws: FilterError.invalidInputType if the value parameter isn't a string | ||
static func camelToSnakeCase(_ value: Any?, arguments: [Any?]) throws -> Any? { | ||
let toLower = parseBool(from: arguments, index: 0) ?? true | ||
let toLower = try parseBool(from: arguments, index: 0, required: false) ?? true | ||
guard let string = value as? String else { throw FilterError.invalidInputType } | ||
|
||
let snakeCase = try snakecase(string) | ||
|
@@ -107,13 +107,19 @@ struct StringFilters { | |
} | ||
|
||
/// Parses filter arguments for a boolean value, where true can by any one of: "true", "yes", "1", and | ||
/// false can be any one of: "false", "no", "0". | ||
/// false can be any one of: "false", "no", "0". If optional is true it means that the argument on the filter is | ||
/// optional and it's not an error condition if the argument is missing or not the right type | ||
/// - parameter arguments: an array of argument values, may be empty | ||
/// - parameter index: the index in the arguments array | ||
/// - parameter required: if true, the argument is required and function throws if missing. If false, returns nil on missing args. | ||
/// - returns: true or false if a value was parsed, or nil if it wasn't able to | ||
static func parseBool(from arguments: [Any?], index: Int) -> Bool? { | ||
guard index + 1 <= arguments.count else { | ||
return nil | ||
static func parseBool(from arguments: [Any?], index: Int, required: Bool = true) throws -> Bool? { | ||
guard index < arguments.count else { | ||
if required { | ||
throw FilterError.invalidInputType | ||
} else { | ||
return nil | ||
} | ||
} | ||
|
||
let boolArg = (arguments[index] as? String ?? "").lowercased() | ||
|
@@ -123,7 +129,11 @@ struct StringFilters { | |
case "true", "yes", "1": | ||
return true | ||
default: | ||
return nil | ||
if required { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What I meant with my throwing behaviour was more along the lines of, if I pass the parameter I'd change the guard to: guard index < arguments.count, let boolArg = arguments[index] as? String else {
... required check... In the switch, you then don't check for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yup, good eye! |
||
throw FilterError.invalidInputType | ||
} else { | ||
return nil | ||
} | ||
} | ||
} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
// | ||
// StencilSwiftKit | ||
// Copyright (c) 2017 SwiftGen | ||
// MIT Licence | ||
// | ||
|
||
import XCTest | ||
@testable import StencilSwiftKit | ||
|
||
class ParseBoolTests: XCTestCase { | ||
|
||
func testParseBool_WithTrueString() throws { | ||
let value = try StringFilters.parseBool(from: ["true"], index: 0) | ||
XCTAssertTrue(value!) | ||
} | ||
|
||
func testParseBool_WithFalseString() throws { | ||
let value = try StringFilters.parseBool(from: ["false"], index: 0) | ||
XCTAssertFalse(value!) | ||
} | ||
|
||
func testParseBool_WithYesString() throws { | ||
let value = try StringFilters.parseBool(from: ["yes"], index: 0) | ||
XCTAssertTrue(value!) | ||
} | ||
|
||
func testParseBool_WithNoString() throws { | ||
let value = try StringFilters.parseBool(from: ["no"], index: 0) | ||
XCTAssertFalse(value!) | ||
} | ||
|
||
func testParseBool_WithOneString() throws { | ||
let value = try StringFilters.parseBool(from: ["1"], index: 0) | ||
XCTAssertTrue(value!) | ||
} | ||
|
||
func testParseBool_WithZeroString() throws { | ||
let value = try StringFilters.parseBool(from: ["0"], index: 0) | ||
XCTAssertFalse(value!) | ||
} | ||
|
||
func testParseBool_WithOptionalInt() throws { | ||
let value = try StringFilters.parseBool(from: [1], index: 0, required: false) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithRequiredInt() throws { | ||
XCTAssertThrows(try StringFilters.parseBool(from: [1], index: 0, required: true)) | ||
} | ||
|
||
func testParseBool_WithOptionalDouble() throws { | ||
let value = try StringFilters.parseBool(from: [1.0], index: 0, required: false) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithRequiredDouble() throws { | ||
XCTAssertThrows(try StringFilters.parseBool(from: [1.0], index: 0, required: true)) | ||
} | ||
|
||
func testParseBool_WithEmptyString() throws { | ||
let value = try StringFilters.parseBool(from: [""], index: 0, required: false) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithEmptyStringAndRequiredArg() throws { | ||
XCTAssertThrows(try StringFilters.parseBool(from: [""], index: 0, required: true)) | ||
} | ||
|
||
func testParseBool_WithEmptyArray() throws { | ||
let value = try StringFilters.parseBool(from: [], index: 0, required: false) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithEmptyArrayAndRequiredArg() throws { | ||
XCTAssertThrows(try StringFilters.parseBool(from: [], index: 0, required: true)) | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -133,57 +133,12 @@ class StringFiltersTests: XCTestCase { | |
} | ||
} | ||
|
||
func testParseBool_WithTrueString() throws { | ||
let value = try StringFilters.parseBool(from: ["true"], index: 0) | ||
XCTAssertTrue(value!) | ||
func testCamelToSnakeCase_WithNoArgsDefaultsToTrue() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can remove this case, it's covered by the parseBool tests and the 2 cases below this one. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This test covers the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. True, good call. |
||
let result = try! StringFilters.camelToSnakeCase("StringWithWords", arguments: []) as? String | ||
XCTAssertEqual(result, "string_with_words") | ||
} | ||
|
||
func testParseBool_WithFalseString() throws { | ||
let value = try StringFilters.parseBool(from: ["false"], index: 0) | ||
XCTAssertFalse(value!) | ||
} | ||
|
||
func testParseBool_WithYesString() throws { | ||
let value = try StringFilters.parseBool(from: ["yes"], index: 0) | ||
XCTAssertTrue(value!) | ||
} | ||
|
||
func testParseBool_WithNoString() throws { | ||
let value = try StringFilters.parseBool(from: ["no"], index: 0) | ||
XCTAssertFalse(value!) | ||
} | ||
|
||
func testParseBool_WithOneString() throws { | ||
let value = try StringFilters.parseBool(from: ["1"], index: 0) | ||
XCTAssertTrue(value!) | ||
} | ||
|
||
func testParseBool_WithZeroString() throws { | ||
let value = try StringFilters.parseBool(from: ["0"], index: 0) | ||
XCTAssertFalse(value!) | ||
} | ||
|
||
func testParseBool_WithInt() throws { | ||
let value = try StringFilters.parseBool(from: [1], index: 0) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithDouble() throws { | ||
let value = try StringFilters.parseBool(from: [1.0], index: 0) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithEmptyString() throws { | ||
let value = try StringFilters.parseBool(from: [""], index: 0) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testParseBool_WithEmptyArray() throws { | ||
let value = try StringFilters.parseBool(from: [], index: 0) | ||
XCTAssertNil(value) | ||
} | ||
|
||
func testCamelToSnakeCase_NoArguments() { | ||
|
||
func testCamelToSnakeCase_WithTrue() { | ||
let expectations = [ | ||
"string": "string", | ||
"String": "string", | ||
|
@@ -216,7 +171,7 @@ class StringFiltersTests: XCTestCase { | |
} | ||
} | ||
|
||
func testCamelToSnakeCase_OneArgumentAsFalse() { | ||
func testCamelToSnakeCase_WithFalse() { | ||
let expectations = [ | ||
"string": "string", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A little nitpicking, but could you ensure the indentation you use is consistent with the rest of the project? Thx |
||
"String": "String", | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
// | ||
// StencilSwiftKit | ||
// Copyright (c) 2017 SwiftGen | ||
// MIT Licence | ||
// | ||
|
||
import XCTest | ||
|
||
public func XCTAssertThrows(_ expression: @autoclosure () throws -> Any?, _ message: @autoclosure () -> String = "", file: StaticString = #file, line: UInt = #line) { | ||
XCTAssert((try? expression()) == nil, message, file: file, line: line) | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we're gonna keep this
parseBool
method, there's no reason for it to be only limited to string filters so no reason to scope it in theStringFilters
type. May be worth creating a dedicated type for filter helpers to put it in there (or extend one if there's already such concept in Stencil, haven't checked)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ggrell Any update on these last small items, or would you prefer I take them up?