-
Notifications
You must be signed in to change notification settings - Fork 79
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
Common tags #549
Merged
Merged
Common tags #549
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
121 changes: 121 additions & 0 deletions
121
components/proxy/src/main/kotlin/com/hotels/styx/CommonTags.kt
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,121 @@ | ||
| /* | ||
| Copyright (C) 2013-2019 Expedia Inc. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
| package com.hotels.styx | ||
|
|
||
| /** | ||
| * A common tag representation. | ||
| * | ||
| * Enforces a common tag format and provides a set of higher order functionality | ||
| * that operate on provided `name`, `encode` and `decode` properties. | ||
| * | ||
| * A tag string is a name-value pair separated by equal ('=') sign: | ||
| * | ||
| * tag-string = name "=" value-part | ||
| * | ||
| * `encode` and `decode` are functions to encode a T to a value-part string, | ||
| * and to decode the value-part string back to T. | ||
| * | ||
| * @property name a tag name | ||
| * @property encode a function that encodes a value of T as a tag value string | ||
| * @property decode a function that decodes a tag value string as a T | ||
| */ | ||
| sealed class CommonValueTag<T>( | ||
| val name: String, | ||
| val encode: (T) -> String?, | ||
| val decode: (String) -> T?) { | ||
|
|
||
| /** | ||
| * Extracts value part (the right hand side) from a tag string. | ||
| * | ||
| * @param tag a tag string | ||
| * @return the tag value | ||
| */ | ||
| fun valuePart(tag: String) = if (tag.startsWith("$name=")) { | ||
| tag.removePrefix("$name=") | ||
| } else { | ||
| null | ||
| } | ||
|
|
||
| /** | ||
| * Tests if a given string matches this tag. A match is positive when the string | ||
| * starts with `name` followed by `=`. | ||
| * | ||
| * @param a tag string | ||
| * @return True if this string is possibly a matching tag. Otherwise return false. | ||
| */ | ||
| fun match(tag: String) = tag.startsWith("$name=") | ||
|
|
||
| /** | ||
| * Decodes given tag string to its typed value. | ||
| * | ||
| * @param tag a tag string | ||
| * @return a decoded tag value, or null if decoding failed | ||
| */ | ||
| fun valueOf(tag: String) = valuePart(tag) | ||
| ?.let { decode(it) } | ||
|
|
||
| /** | ||
| * Find this tag from a set of tag strings. If found, decode the tag value. Return null if | ||
| * tag was not found, or if decoding failed. | ||
| * | ||
| * @param tags a set of tag strings | ||
| * @return A decoded value if tag was found. Otherwise return null. | ||
| */ | ||
| fun find(tags: Set<String>) = tags.firstOrNull { this.match(it) } | ||
| ?.let { valueOf(it) } | ||
|
|
||
| /** | ||
| * Removes all instances of this tag from a set of tag strings. | ||
| * Return a new Set<String> with all instances of this tag removed. | ||
| * | ||
| * @param tags a set of tag strings | ||
| * @return A new set of strings without this tag. | ||
| */ | ||
| fun remove(tags: Set<String>) = tags | ||
| .filterNot { this.match(it) } | ||
| .toSet() | ||
| } | ||
|
|
||
| /** | ||
| * A NullableValueTag invoke method returns null when value cannot be encoded to string. | ||
| * The API consumer must handle this situation. | ||
| */ | ||
| class NullableValueTag<T>( | ||
| name: String, | ||
| encode: (T) -> String?, | ||
| decode: (String) -> T?) : CommonValueTag<T>(name, encode, decode) { | ||
|
|
||
| operator fun invoke(value: T): String? = encode(value) | ||
| ?.let { | ||
| "$name=$it" | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A SafeValueTag invoke method throws a KotlinNullPointerException when the | ||
| * tag value cannot be encoded to string. | ||
| */ | ||
| class SafeValueTag<T>( | ||
| name: String, | ||
| encode: (T) -> String?, | ||
| decode: (String) -> T?) : CommonValueTag<T>(name, encode, decode) { | ||
|
|
||
| operator fun invoke(value: T): String = encode(value) | ||
| .let { | ||
| it!! | ||
| "$name=$it" | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
Is it worth providing defaults for encode and decode as
{ it }?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.
Is this possible without knowing the type T?