Merge pull request #24 from hexagonkt/develop

jaguililla · web-flow · commit 0ee7d4a02afc · 2023-07-07T20:31:40.000+02:00
Schema changes
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -11,7 +11,7 @@ val os = getProperty("os.name").lowercase()
 
 val hexagonVersion = "2.8.6"
 val hexagonExtraVersion = "2.8.4"
-val vertxVersion = "4.4.3"
+val vertxVersion = "4.4.4"
 
 val gradleScripts = "https://raw.githubusercontent.com/hexagonkt/hexagon/$hexagonVersion/gradle"
 
@@ -70,7 +70,6 @@ tasks.named<CreateStartScripts>("startScripts") {
 
 tasks.create<Copy>("addResources") {
     from(projectDir)
-    include("templates/cv.html")
     include("examples/**")
     include("cv.schema.json")
     into(buildDir.resolve("resources/main"))
diff --git a/cv.schema.json b/cv.schema.json
@@ -162,10 +162,6 @@
           "title" : "Short name you commonly use or nickname",
           "$ref" : "#/$defs/NullableString"
         },
-        "Website" : {
-          "title" : "Personal website",
-          "$ref" : "#/$defs/NullableUri"
-        },
         "Photo" : {
           "title" : "Photo address",
           "$ref" : "#/$defs/NullableUri"
@@ -846,6 +842,7 @@
         "Contact" : {
           "title" : "Contact data of the referrer person",
           "type" : "array",
+          "uniqueItems" : true,
           "items" : {
             "$ref" : "#/$defs/Link"
           }
@@ -894,7 +891,7 @@
       "additionalProperties" : false,
       "properties" : {
         "$schema" : {
-          "title" : "Schema used for the CV",
+          "title" : "Schema used for the document",
           "description" : "Used to deal with different versions. It also eases the use on some editors",
           "type" : "string",
           "format" : "URI"
@@ -954,6 +951,7 @@
         "Contact" : {
           "title" : "Contact data",
           "type" : "array",
+          "uniqueItems" : true,
           "items" : {
             "$ref" : "#/$defs/Link"
           }
@@ -999,17 +997,18 @@
             "type" : "string"
           }
         },
-        "Social Profiles" : {
-          "title" : "Set of URLs pointing to social profiles",
+        "Links" : {
+          "title" : "List of links pointing to another resources (like social networks profiles)",
           "type" : "array",
           "uniqueItems" : true,
           "items" : {
-            "$ref" : "#/$defs/Uri"
+            "$ref" : "#/$defs/Link"
           }
         },
         "Languages" : {
           "title" : "List of languages aside of the birth language",
           "type" : "array",
+          "uniqueItems" : true,
           "items" : {
             "$ref" : "#/$defs/LanguageSkill"
           }
diff --git a/examples/cv.html b/examples/cv.html
@@ -190,23 +190,23 @@ <h2>Personal Information</h2>
 
     <div class="row">
       <ul>
-{% for socialProfile in cv.socialProfiles %}
+{% for link in cv.links %}
         <li>
-{% if socialProfile contains "twitter" %}
+{% if link.address contains "twitter" %}
 {% set socialNetworkTitle = "Twitter" %}
-{% elseif socialProfile contains "github" %}
+{% elseif link.address contains "github" %}
 {% set socialNetworkTitle = "GitHub" %}
-{% elseif socialProfile contains "linkedin" %}
+{% elseif link.address contains "linkedin" %}
 {% set socialNetworkTitle = "LinkedIn" %}
-{% elseif socialProfile contains "stackoverflow" %}
+{% elseif link.address contains "stackoverflow" %}
 {% set socialNetworkTitle = "Stack Overflow" %}
-{% elseif socialProfile contains "dev" %}
+{% elseif link.address contains "dev" %}
 {% set socialNetworkTitle = "Dev" %}
 {% else %}
 {% set socialNetworkTitle = "Not Found" %}
 {% endif %}
 {% set socialNetworkIcon = socialNetworkTitle | lower | replace({' ': '-'}) %}
-          <a href="{{ socialProfile }}" title="{{ socialNetworkTitle }}">
+          <a href="{{ link.address }}" title="{{ socialNetworkTitle }}">
             <i class="fab fa-{{ socialNetworkIcon }}"></i>
           </a>
         </li>
diff --git a/examples/full.cv.json b/examples/full.cv.json
@@ -5,7 +5,7 @@
 
   "Locale" : "en_US",
   "Last Update" : "2022-12-27",
-  "Templates" : [ "file:templates/cv.html" ],
+  "Templates" : [ "file:cv.html" ],
   "Variables" : {
     "gaFont" : "family=Roboto+Slab:wght@400;500;700",
     "colorPrimary" : "#087cfa",
@@ -24,7 +24,6 @@
     "Birth" : "1988-08-16",
     "Birth Country" : "US",
     "Alias" : "Bitchard",
-    "Website" : "https://example.net",
     "Photo" : "https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg",
     "Avatar" : "https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg",
     "Nationalities" : [ "US" ],
@@ -104,10 +103,10 @@
     "Low level Programming"
   ],
 
-  "Social Profiles" : [
-    "https://github.com/hexagonkt/hexagon",
-    "https://twitter.com/hexagon_kt",
-    "https://dev.to/hexagonkt"
+  "Links" : [
+    { "Address" : "https://github.com/hexagonkt/hexagon" },
+    { "Address" : "https://twitter.com/hexagon_kt" },
+    { "Address" : "https://dev.to/hexagonkt" }
   ],
 
   "Languages" : [
diff --git a/examples/full.cv.toml b/examples/full.cv.toml
@@ -6,7 +6,7 @@
 "Last Update" = 2022-12-27
 
 Locale = "en_US"
-Templates = [ "file:templates/cv.html" ]
+Templates = [ "file:cv.html" ]
 
 Bio = """\
   Richard hails from Tulsa. He has earned degrees from the University of Oklahoma and Stanford. \
@@ -38,6 +38,12 @@ Goals = [
   "Wildlife, specially ferrets and unicorns"
 ]
 
+Links = [
+  { Address = "https://github.com/hexagonkt/hexagon" },
+  { Address = "https://twitter.com/hexagon_kt" },
+  { Address = "https://dev.to/hexagonkt" },
+]
+
 [Variables]
 gaFont = "family=Roboto+Slab:wght@400;500;700"
 colorPrimary = "#087cfa"
@@ -55,7 +61,6 @@ Pronoun = "masculine"
 Gender = "man"
 Birth = "1988-08-16"
 Alias = "Bitchard"
-Website = "https://example.net"
 Photo = "https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg"
 Avatar = "https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg"
 Nationalities = [ "US" ]
diff --git a/examples/full.cv.yml b/examples/full.cv.yml
@@ -7,7 +7,7 @@ Job Status: not moving
 
 Locale: en_US
 Last Update: 2022-12-27
-Templates: [ file:templates/cv.html ]
+Templates: [ file:cv.html ]
 Variables:
   gaFont: family=Roboto+Slab:wght@400;500;700
   colorPrimary: '#087cfa'
@@ -25,7 +25,6 @@ Personal:
   Birth: 1988-08-16
   Birth Country: US
   Alias: Bitchard
-  Website: https://example.net
   Photo: https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg
   Avatar: https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg
   Nationalities: [ US ]
@@ -94,10 +93,10 @@ Top Skills:
   - Data structures and Algorithms
   - Low level Programming
 
-Social Profiles:
-  - https://github.com/hexagonkt/hexagon
-  - https://twitter.com/hexagon_kt
-  - https://dev.to/hexagonkt
+Links:
+  - Address: https://github.com/hexagonkt/hexagon
+  - Address: https://twitter.com/hexagon_kt
+  - Address: https://dev.to/hexagonkt
 
 Languages:
   - Language: fr
diff --git a/examples/modular/common.cv.yml b/examples/modular/common.cv.yml
@@ -4,7 +4,7 @@ $schema: https://raw.githubusercontent.com/hexagonkt/codecv/master/cv.schema.jso
 
 Job Status: not moving
 Last Update: 2022-12-27
-Templates: [ file:templates/cv.html ]
+Templates: [ file:../cv.html ]
 
 Personal:
   Given Name: Richard
@@ -15,7 +15,6 @@ Personal:
   Birth: 1988-08-16
   Birth Country: US
   Alias: Bitchard
-  Website: https://example.net
   Photo: https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg
   Avatar: https://static.wikia.nocookie.net/silicon-valley/images/3/33/Richard_Hendricks.jpg
   Nationalities: [ US ]
@@ -85,10 +84,12 @@ Top Skills:
   - Data structures and Algorithms
   - Low level Programming
 
-Social Profiles:
-  - https://github.com/hexagonkt/hexagon
-  - https://twitter.com/hexagon_kt
-  - https://dev.to/hexagonkt
+Links:
+  - Title: Website
+    Address: https://example.net
+  - Address: https://github.com/hexagonkt/hexagon
+  - Address: https://twitter.com/hexagon_kt
+  - Address: https://dev.to/hexagonkt
 
 Languages:
   - Language: fr
diff --git a/examples/regular.cv.json b/examples/regular.cv.json
@@ -2,7 +2,7 @@
   "$schema" : "https://raw.githubusercontent.com/hexagonkt/codecv/master/cv.schema.json",
 
   "Locale" : "en_US",
-  "Templates" : [ "file:templates/cv.html" ],
+  "Templates" : [ "file:cv.html" ],
   "Variables" : {
     "gaFont" : "family=Roboto+Slab:wght@400;500;700",
     "colorPrimary" : "#087cfa",
@@ -65,10 +65,10 @@
     "Low level Programming"
   ],
 
-  "Social Profiles" : [
-    "https://github.com/hexagonkt/hexagon",
-    "https://twitter.com/hexagon_kt",
-    "https://dev.to/hexagonkt"
+  "Links" : [
+    { "Address" : "https://github.com/hexagonkt/hexagon" },
+    { "Address" : "https://twitter.com/hexagon_kt" },
+    { "Address" : "https://dev.to/hexagonkt" }
   ],
 
   "Languages" : [
diff --git a/examples/regular.cv.toml b/examples/regular.cv.toml
@@ -3,7 +3,7 @@
 "$schema" = "https://raw.githubusercontent.com/hexagonkt/codecv/master/cv.schema.json"
 
 Locale = "en_US"
-Templates = [ "file:templates/cv.html" ]
+Templates = [ "file:cv.html" ]
 
 Bio = """\
   Richard hails from Tulsa. He has earned degrees from the University of Oklahoma and Stanford. \
@@ -30,6 +30,12 @@ Goals = [
   "https://dev.to/hexagonkt",
 ]
 
+Links = [
+  { Address = "https://github.com/hexagonkt/hexagon" },
+  { Address = "https://twitter.com/hexagon_kt" },
+  { Address = "https://dev.to/hexagonkt" },
+]
+
 [Variables]
 gaFont = "family=Roboto+Slab:wght@400;500;700"
 colorPrimary = "#087cfa"
diff --git a/examples/regular.cv.yml b/examples/regular.cv.yml
@@ -4,7 +4,7 @@
 $schema: https://raw.githubusercontent.com/hexagonkt/codecv/master/cv.schema.json
 
 Locale: en_US
-Templates: [ file:templates/cv.html ]
+Templates: [ file:cv.html ]
 Variables:
   gaFont: family=Roboto+Slab:wght@400;500;700
   colorPrimary: '#087cfa'
@@ -63,10 +63,10 @@ Top Skills:
   - Data structures and Algorithms
   - Low level Programming
 
-Social Profiles:
-  - https://github.com/hexagonkt/hexagon
-  - https://twitter.com/hexagon_kt
-  - https://dev.to/hexagonkt
+Links:
+  - Address: https://github.com/hexagonkt/hexagon
+  - Address: https://twitter.com/hexagon_kt
+  - Address: https://dev.to/hexagonkt
 
 Languages:
   - Language: fr
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https://services.gradle.org/distributions/gradle-8.1.1-all.zip
+distributionUrl=https://services.gradle.org/distributions/gradle-8.2-all.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
diff --git a/src/main/kotlin/Cv.kt b/src/main/kotlin/Cv.kt
@@ -37,15 +37,14 @@ import java.io.File
 import java.net.URI
 import java.net.URL
 import java.nio.file.Path
-import kotlin.io.path.exists
 import kotlin.system.exitProcess
 
 const val preventExitFlag: String = "PREVENT_EXIT"
 const val exitCodeProperty: String = "EXIT_CODE"
 
 const val spec: String = "classpath:spec.yml"
 const val schema: String = "classpath:cv.schema.json"
-const val defaultTemplate: String = "classpath:templates/cv.html"
+const val defaultTemplate: String = "classpath:examples/cv.html"
 const val buildProperties: String = "classpath:META-INF/build.properties"
 const val mainPage: String = "classpath:ui.html"
 
@@ -236,10 +235,21 @@ private fun HttpContext.renderCv(cvUrl: String, base: String): HttpContext {
 
     val cv = decode(cvData, url)
     val template = cv.getPath<Collection<String>>("templates")?.firstOrNull() ?: defaultTemplate
+    val templateUrl = resolve(URL(template), url)
     val variables = cv.getPath<Map<String, Any>>("variables") ?: emptyMap()
     val templateContext = variables + mapOf("cv" to cv, "base" to base)
 
-    return template(URL(template), templateContext + callContext())
+    return template(templateUrl, templateContext + callContext())
+}
+
+private fun resolve(url: URL, base: URL): URL {
+    return if (url.protocol == "file") {
+        val cvBase = Path.of(base.path).parent
+        cvBase.resolve(Path.of(url.path)).toUri().toURL()
+    }
+    else {
+        url
+    }
 }
 
 private fun decode(data: Map<*, *>, url: URL): Map<*, *> {
@@ -248,18 +258,9 @@ private fun decode(data: Map<*, *>, url: URL): Map<*, *> {
 }
 
 private fun mergeIncludes(data: Map<*, *>, base: URL): Map<*, *> {
-    val baseDir by lazy { Path.of(base.file).parent }
     val includes = data.getPath<List<String>>("Resources")
         ?.map(::URL)
-        ?.map {
-            if (it.protocol == "file")
-                Path.of(it.file).let { p ->
-                    if (p.exists() || p.isAbsolute) it
-                    else baseDir.resolve(p).toUri().toURL()
-                }
-            else
-                it
-        }
+        ?.map { resolve(it, base) }
         ?: emptyList()
 
     val allMaps = includes.map(URL::parseMap) + listOf(data)
diff --git a/src/main/resources/spec.yml b/src/main/resources/spec.yml
diff --git a/src/test/kotlin/CvTest.kt b/src/test/kotlin/CvTest.kt
