Light

slakah / uritemplate4s Goto Github PK

View Code? Open in Web Editor NEW

7.0 1.0 3.0 23.63 MB

Scala implementation of URI Template (RFC 6570)

Home Page: https://gubbns.com/uritemplate4s/

License: MIT License

Scala 99.15% Shell 0.85%

uritemplate scala fastparse

uritemplate4s's Introduction

uritemplate4s

Scala implementation of URI Template (RFC 6570).

Getting Started

uritemplate4s is currently available for Scala 2.13, 2.12 and Scala.js.

Add the following to your build.sbt:

libraryDependencies += "com.gubbns" %% "uritemplate4s" % "0.5.7"

Usage

import uritemplate4s._

val template = uritemplate"https://{host}/search{?q}{&params*}"
template.expand(
    "host" -> "search-engine.com",
    "q" -> "Esio Trot",
    "params" -> Map("lang" -> "en", "type" -> "book")
  ).value
// res0: String = https://search-engine.com/search?q=Esio%20Trot&lang=en&type=book

Further documentation is available here.

uritemplate4s's People

Contributors

Stargazers

Watchers

Forkers

gitter-badger scala-steward tchigher

uritemplate4s's Issues

Code coverage

Add scoverage + badge (not needed for demo page). I have a suspicion it should be close to 100%, but would be nice to validate.

Warn when a value cannot be found for a template variable

See this todo https://github.com/Slakah/uritemplate4s/blob/master/core/shared/src/main/scala/uritemplate4s/UriTemplate.scala#L29

Add benchmarks

Add some quick benchmarks agains other JVM implementations:

https://github.com/damnhandy/Handy-URI-Templates

CLI Support

Might be cool to be add a CLI package, could be used with coursier launch.

Improve URI Encoding

Code in http4s/http4s@v0.20.11...v0.20.12 looks to be better.

Investigate better parse error reporting

I suspect parse errors can be better represented. The examples I've seen in fastparse seem to suggest this, I suspect I've just configured the project incorrectly.

Cats interop

Add cats support:

ToValue typeclass for Show.
ToValue typeclass for NonEmpty*.
etc.

Check template strings at compile time using contextual

http://co.ntextu.al/

Should support patterns like:

uritemplate"http://{foo}.com"

Add multiple examples to playground

Think of a handful of examples, and have them loaded using the URI fragment.

Scalaz interop

Add scalaz support:

ToValue typeclass for Show.
ToValue typeclass for NonEmpty*.
etc.

Document useful use cases for URI templates

Ideas could include, using a uritemplate as configuration to specify where a file should be placed in S3.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.