Added StringFilters.camelToSnakeCase filter #24
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -89,6 +89,50 @@ struct StringFilters { | |
| } | ||
| } | ||
|
|
||
| /// Converts camelCase to snake_case. Takes an optional Bool argument for making the string lower case, | ||
| /// which defaults to true | ||
| /// - parameter value: the value to be processed | ||
| /// - parameter arguments: the arguments to the function, expecting zero or one argument | ||
| /// - 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 = try parseBool(from: arguments, index: 0, required: false) ?? true | ||
| guard let string = value as? String else { throw FilterError.invalidInputType } | ||
|
|
||
| let snakeCase = try snakecase(string) | ||
| if toLower { | ||
| return snakeCase.lowercased() | ||
| } | ||
| return snakeCase | ||
| } | ||
|
|
||
| /// 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". 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, required: Bool = true) throws -> Bool? { | ||
|
There was a problem hiding this comment. As we're gonna keep this There was a problem hiding this comment. @ggrell Any update on these last small items, or would you prefer I take them up? |
||
| guard index < arguments.count, let boolArg = arguments[index] as? String else { | ||
| if required { | ||
| throw FilterError.invalidInputType | ||
| } else { | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| switch boolArg.lowercased() { | ||
| case "false", "no", "0": | ||
| return false | ||
| case "true", "yes", "1": | ||
| return true | ||
| default: | ||
| throw FilterError.invalidInputType | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| This returns the string with its first parameter uppercased. | ||
| - note: This is quite similar to `capitalise` except that this filter doesn't lowercase | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // | ||
| // 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 { | ||
| XCTAssertThrowsError(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 { | ||
| XCTAssertThrowsError(try StringFilters.parseBool(from: [1.0], index: 0, required: true)) | ||
| } | ||
|
|
||
| func testParseBool_WithEmptyString() throws { | ||
| XCTAssertThrowsError(try StringFilters.parseBool(from: [""], index: 0, required: false)) | ||
| } | ||
|
|
||
| func testParseBool_WithEmptyStringAndRequiredArg() throws { | ||
| XCTAssertThrowsError(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 { | ||
| XCTAssertThrowsError(try StringFilters.parseBool(from: [], index: 0, required: true)) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
There's already a
lowercasefilter provided by Stencil, so you could already dofoo|camelToSnakeCase|lowercaseinstead offoo|camelToSnakeCase(true).I think it would be better to keep the lowercasing separate, i.e. let the caller filter thru
|lowercasein the template, instead of making that logic in code (and with the risk of repeating lowercasing logic in Swift code).Besides, it would allow you to simplify this whole PR by not needing this
parseBoolanymore (I'm surprised thatStencildoesn't provide a way to parse a boolean argument the same way for all filters already btw?).And I think it would be more understandable to be explicit. Sure you'll lose the "automatic lowercase by default" behavior, that would be unfortunate, but the code would be much simpler (and the risk of regression and inconsistency in the bool argument parsing logic lowered too)
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.
We might need the
parseBoollogic for other filters we want to refactor (snakeToCamelCaseNoPrefix), but it might then be better to leave that for another PR.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.
Currently
foo|camelToSnakeCase|lowerCaseandfoo|camelToSnakeCaseare equivalent, and I expect that 99% of people will want the default lowercase behavior. You would only need to add a parameter if you wanted snake case with first upper characters, which IMHO will probably be pretty rare. That's why I'd rather keep it as is.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.
Fair enough.