Rename all badge-uri to badge-path

roec · Apr 8, 2020 · 9ef1b69 · 9ef1b69
1 parent fb1b4f5
commit 9ef1b69
Show file tree

Hide file tree

Showing 7 changed files with 331 additions and 330 deletions.
diff --git a/claat/parser/md/parse.go b/claat/parser/md/parse.go
@@ -42,7 +42,7 @@ import (
 // Metadata constants for the YAML header
 const (
 	MetaAuthors          = "authors"
-	MetaBadgeURI         = "badge uri"
+	MetaBadgePath        = "badge path"
 	MetaSummary          = "summary"
 	MetaID               = "id"
 	MetaCategories       = "categories"
@@ -365,9 +365,9 @@ func addMetadataToCodelab(m map[string]string, c *types.Codelab, opts parser.Opt
 		case MetaAuthors:
 			// Directly assign the summary to the codelab field.
 			c.Authors = v
-		case MetaBadgeURI:
-			// Directly assign the badge URI to the codelab field.
-			c.BadgeURI = v
+		case MetaBadgePath:
+			// Directly assign the badge Path to the codelab field.
+			c.BadgePath = v
 		case MetaSummary:
 			// Directly assign the summary to the codelab field.
 			c.Summary = v

diff --git a/claat/parser/newmd/parse.go b/claat/parser/newmd/parse.go
@@ -42,7 +42,7 @@ import (
 // Metadata constants for the YAML header
 const (
 	MetaAuthors          = "authors"
-	MetaBadgeURI         = "badge uri"
+	MetaBadgePath        = "badge path"
 	MetaSummary          = "summary"
 	MetaID               = "id"
 	MetaCategories       = "categories"
@@ -362,9 +362,9 @@ func addMetadataToCodelab(m map[string]string, c *types.Codelab, opts parser.Opt
 		case MetaAuthors:
 			// Directly assign the summary to the codelab field.
 			c.Authors = v
-		case MetaBadgeURI:
-			// Directly assign the badge URI to the codelab field.
-			c.BadgeURI = v
+		case MetaBadgePath:
+			// Directly assign the badge Path to the codelab field.
+			c.BadgePath = v
 		case MetaSummary:
 			// Directly assign the summary to the codelab field.
 			c.Summary = v

diff --git a/claat/render/template-devsite.html b/claat/render/template-devsite.html
@@ -53,14 +53,14 @@
                     title="{{.Meta.Title}}"
                     environment="{{index .Env}}"
                     feedback-link="{{.Meta.Feedback}}"
-                    {{if $.Meta.BadgeURI}}badge-uri="{{$.Meta.BadgeURI}}"{{end}}>
+                    {{if $.Meta.BadgePath}}badge-path="{{$.Meta.BadgePath}}"{{end}}>
       {{range $i, $e := .Steps}}{{if matchEnv .Tags $.Env}}
         <google-codelab-step label="{{.Title}}" duration="{{.Duration.Minutes}}">
           {{if eq $i 0}}
             <google-codelab-about codelab-title="{{$.Meta.Title}}"
                                   {{if $.Updated}}last-updated="{{$.Updated}}"{{end}}
                                   {{if $.Meta.Authors}}authors="{{$.Meta.Authors}}"{{end}}
-                                  {{if $.Meta.BadgeURI}}badge-uri="{{$.Meta.BadgeURI}}"{{end}}>
+                                  {{if $.Meta.BadgePath}}badge-path="{{$.Meta.BadgePath}}"{{end}}>
             </google-codelab-about>
           {{end}}
           {{.Content | renderHTML $.Env}}

diff --git a/claat/render/tmpldata.go b/claat/render/tmpldata.go
diff --git a/claat/types/meta.go b/claat/types/meta.go
@@ -25,20 +25,20 @@ import (
 
 // Meta contains a single codelab metadata.
 type Meta struct {
-	ID         string            `json:"id"`                  // ID is also part of codelab URL
-	Duration   int               `json:"duration"`            // Codelab duration in minutes
-	Title      string            `json:"title"`               // Codelab title
-	Authors    string            `json:"authors,omitempty"`   // Arbitrary authorship text
-	BadgeURI   string            `json:"badge_uri,omitempty"` // URI of the Badge to grant on codelab completion on devsite
-	Summary    string            `json:"summary"`             // Short summary
-	Source     string            `json:"source"`              // Codelab source doc
-	Theme      string            `json:"theme"`               // Usually first item of Categories
-	Status     *LegacyStatus     `json:"status"`              // Draft, Published, Hidden, etc.
-	Categories []string          `json:"category"`            // Categories from the meta table
-	Tags       []string          `json:"tags"`                // All environments supported by the codelab
-	Feedback   string            `json:"feedback,omitempty"`  // Issues and bugs are sent here
-	GA         string            `json:"ga,omitempty"`        // Codelab-specific GA tracking ID
-	Extra      map[string]string `json:"extra,omitempty"`     // Extra metadata specified in pass_metadata
+	ID         string            `json:"id"`                   // ID is also part of codelab URL
+	Duration   int               `json:"duration"`             // Codelab duration in minutes
+	Title      string            `json:"title"`                // Codelab title
+	Authors    string            `json:"authors,omitempty"`    // Arbitrary authorship text
+	BadgePath  string            `json:"badge_path,omitempty"` // Path of the Badge to grant on codelab completion on devsite
+	Summary    string            `json:"summary"`              // Short summary
+	Source     string            `json:"source"`               // Codelab source doc
+	Theme      string            `json:"theme"`                // Usually first item of Categories
+	Status     *LegacyStatus     `json:"status"`               // Draft, Published, Hidden, etc.
+	Categories []string          `json:"category"`             // Categories from the meta table
+	Tags       []string          `json:"tags"`                 // All environments supported by the codelab
+	Feedback   string            `json:"feedback,omitempty"`   // Issues and bugs are sent here
+	GA         string            `json:"ga,omitempty"`         // Codelab-specific GA tracking ID
+	Extra      map[string]string `json:"extra,omitempty"`      // Extra metadata specified in pass_metadata
 
 	URL string `json:"url"` // Legacy ID; TODO: remove
 }

diff --git a/codelab-elements/google-codelab-about/google_codelab_about.js b/codelab-elements/google-codelab-about/google_codelab_about.js
@@ -28,7 +28,7 @@ const LAST_UPDATED_ATTR = 'last-updated';
 const AUTHORS_ATTR = 'authors';
 
 /** @const {string} */
-const BADGE_URI_ATTR = 'badge-uri';
+const BADGE_PATH_ATTR = 'badge-path';
 
 /** @const {string} */
 const CODELAB_TITLE_ATTR = 'codelab-title';
@@ -57,7 +57,7 @@ class CodelabAbout extends HTMLElement {
     this.lastUpdated_ = null;
 
     /** @private {?string} */
-    this.badgeUri_ = null;
+    this.badgePath_ = null;
   }
 
   /**
@@ -103,9 +103,9 @@ class CodelabAbout extends HTMLElement {
           this.codelabTitle_ = this.getAttribute(CODELAB_TITLE_ATTR);
         }
         break;
-      case BADGE_URI_ATTR:
-        if (this.hasAttribute(BADGE_URI_ATTR)) {
-          this.badgeUri_ = this.getAttribute(BADGE_URI_ATTR);
+      case BADGE_PATH_ATTR:
+        if (this.hasAttribute(BADGE_PATH_ATTR)) {
+          this.badgePath_ = this.getAttribute(BADGE_PATH_ATTR);
         }
         break;
     }
@@ -137,7 +137,7 @@ class CodelabAbout extends HTMLElement {
       lastUpdated: CodelabAbout.formatDate_(this.lastUpdated_),
       authors: this.authors_,
       codelabTitle: this.codelabTitle_.split(':').join(':||').split('||'),
-      badgeUri: this.badgeUri_,
+      badgePath: this.badgePath_,
     });
 
     this.hasSetup_ = true;

diff --git a/codelab-elements/google-codelab-about/google_codelab_about.soy b/codelab-elements/google-codelab-about/google_codelab_about.soy
@@ -24,7 +24,7 @@
   {@param? codelabTitle: list<string>}
   {@param? lastUpdated: string}
   {@param? authors: string}
-  {@param? badgeUri: string}
+  {@param? badgePath: string}
 
   {if $codelabTitle}
     <div class="codelab-title">
@@ -57,8 +57,8 @@
       {/if}
     </div>
 
-    {if $badgeUri}
-      <devsite-badge-to-earn badge-uri="$badgeUri"></devsite-badge-to-earn>
+    {if $badgePath}
+      <devsite-badge-to-earn badge-uri="$badgePath"></devsite-badge-to-earn>
     {/if}
   </div>
 {/template}