Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matsoftware/accept-language-parser
HTTP Accept-Language parser in Swift
https://github.com/matsoftware/accept-language-parser
accept-language accept-language-parser i18n kitura swift vapor-swift
Last synced: 26 days ago
JSON representation
HTTP Accept-Language parser in Swift
- Host: GitHub
- URL: https://github.com/matsoftware/accept-language-parser
- Owner: matsoftware
- License: mit
- Created: 2020-05-29T12:17:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-25T11:12:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T16:29:13.789Z (about 1 month ago)
- Topics: accept-language, accept-language-parser, i18n, kitura, swift, vapor-swift
- Language: Swift
- Size: 25.4 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ALanguageParser
[](https://circleci.com/gh/matsoftware/accept-language-parser) [](https://codecov.io/gh/matsoftware/accept-language-parser) [](https://www.codacy.com/manual/matsoftware/accept-language-parser?utm_source=github.com&utm_medium=referral&utm_content=matsoftware/accept-language-parser&utm_campaign=Badge_Grade)  [](Size) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fmatsoftware%2Faccept-language-parser?ref=badge_shield) [](LICENSE)
Lightweight HTTP RFC-2616 Accept-Language parser in Swift.
`ALanguageParser` is the swift porting of the npm [accept-language-parser](https://github.com/opentable/accept-language-parser) package by OpenTable. It parses the accept-language header from an HTTP request and produces an array of language objects sorted by quality.
It has been designed to be used with Swift Server Side in mind (e.g. Vapor, Kitura, Perfect) but it can be used in any client side project.
## How to use
### Parse
It returns the ordered list of accepted languages:
```swift
import ALanguageParser
let languages = ALanguageParser.parse("it-IT,zh-Hant-HK;q=0.5")
```
The result will be:
```swift
[
AcceptedLanguage(code: "it",
quality: 1.0,
region: "IT",
script: nil),
AcceptedLanguage(code: "zh",
quality: 0.5,
region: "HK",
script: "Hant")
]
```
Output is always sorted in quality order from highest -> lowest. As per the HTTP spec, omitting the quality value implies `1.0`.
### Pick
Extracts the first selected language from the ones available in the given accept language string or `nil` if not present.
```swift
let language = ALanguageParser.pick(["fr-CA", "fr-FR", "fr"],
acceptLanguage: "en-GB,en-US;q=0.9,fr-CA;q=0.7,en;q=0.8")
```
The output will be:
```swift
"fr-CA"
```
The function can be called with the `loose` parameter that allows partial matching on supported languages. For example:
```swift
let language = ALanguageParser.pick(["fr-CA", "fr-FR", "fr"],
acceptLanguage: "en-GB,en-US;q=0.9,fr-CA;q=0.7,en;q=0.8",
loose: true)
```
The output will be:
```swift
"fr"
```
In loose mode the order of `supportedLanguages` matters, as it is the first partially matching language that is returned. It means that if you want to pick more specific langauge first, you should list it first as well, for example: `["fr-CA", "fr"]`.
## Installation
### Swift Package Manager
The library, currently being developed in Swift 5.7, can be integrated by adding the following entry to your dependencies array in the `Package.swift` file:
```swift
.package(url: "https://github.com/matsoftware/accept-language-parser.git", from: "1.1.0")
```
Then in your target, please add the `ALanguageParser` dependency:
```swift
.product(name: "ALanguageParser", package: "accept-language-parser")
```
### CocoaPods
Add the pod `ALanguageParser` to your Podfile:
```ruby
pod 'ALanguageParser'
```
Run `pod install` and then open your workspace to launch Xcode.
## Contributions
Please open an issue on GitHub or fork the repository to make changes.
Before raising any PR, please make sure that the tests are passing on the _Linux_ platform.
### Running the tests on Linux with Docker
You can use [Docker](https://docs.docker.com/get-docker/) to download the Swift image and perform tests on your MacOS/Windows machine.
Once Docker and its CLI are installed, you can get the image from [Docker Hub](https://hub.docker.com/_/swift) by running:
```bash
docker pull swift
```
Once the image has been download, from the root folder of your forked repository you can start the container in privileged mode and use a bind mount to let Docker access your folder:
```bash
docker run -it --privileged --mount type=bind,source=$(pwd),target=/app swift /bin/bash
```
Finally, you can run the tests:
```bash
root@c4706264baa1:/app$ swift test
```
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmatsoftware%2Faccept-language-parser?ref=badge_large)
## Author
Created by [Mattia Campolese](https://www.linkedin.com/in/matcamp/).
[](https://twitter.com/matsoftware)
Please also check out [swift code metrics](https://github.com/matsoftware/swift-code-metrics), the code metrics analyzer for Swift projects.