Change naming

Author: Gusted

models/issue.go

@@ -70,7 +70,7 @@ type Issue struct {
 	IsLocked bool `xorm:"NOT NULL DEFAULT false"`
 
 	// For view issue page.
-	ShowTag CommentTag `xorm:"-"`
+	ShowRole RoleDescriptor `xorm:"-"`
 }
 
 var (

models/issue_comment.go

@@ -105,40 +105,40 @@ const (
 	CommentTypeDismissReview
 )
 
-// CommentTag defines comment tag type
-type CommentTag int
+// RoleDescriptor defines comment tag type
+type RoleDescriptor int
 
-// Enumerate all the comment tag types
+// Enumerate all the role tags.
 const (
-	CommentTagNone CommentTag = iota
-	CommentTagPoster
-	CommentTagWriter
-	CommentTagOwner
+	RoleDescriptorNone RoleDescriptor = iota
+	RoleDescriptorPoster
+	RoleDescriptorWriter
+	RoleDescriptorOwner
 )
 
-// WithTag enable a specific tag on the CommentTag.
-func (ct CommentTag) WithTag(tag CommentTag) CommentTag {
-	ct |= (1 << tag)
-	return ct
+// WithRole enable a specific tag on the RoleDescriptor.
+func (rd RoleDescriptor) WithRole(role RoleDescriptor) RoleDescriptor {
+	rd |= (1 << role)
+	return rd
 }
 
-func stringToCommentTag(tag string) CommentTag {
-	switch tag {
+func stringToRoleDescriptor(role string) RoleDescriptor {
+	switch role {
 	case "Poster":
-		return CommentTagPoster
+		return RoleDescriptorPoster
 	case "Writer":
-		return CommentTagWriter
+		return RoleDescriptorWriter
 	case "Owner":
-		return CommentTagOwner
+		return RoleDescriptorOwner
 	default:
-		return CommentTagNone
+		return RoleDescriptorNone
 	}
 }
 
-// HasTag returns if a certain tag is enabled on the CommentTag.
-func (ct CommentTag) HasTag(compareTag string) bool {
-	checkCommentTag := stringToCommentTag(compareTag)
-	bitValue := ct & (1 << checkCommentTag)
+// HasRole returns if a certain role is enabled on the RoleDescriptor.
+func (rd RoleDescriptor) HasRole(role string) bool {
+	roleDescriptor := stringToRoleDescriptor(role)
+	bitValue := rd & (1 << roleDescriptor)
 	return (bitValue > 0)
 }
 
@@ -200,7 +200,7 @@ type Comment struct {
 	Reactions   ReactionList  `xorm:"-"`
 
 	// For view issue page.
-	ShowTag CommentTag `xorm:"-"`
+	ShowRole RoleDescriptor `xorm:"-"`
 
 	Review      *Review `xorm:"-"`
 	ReviewID    int64   `xorm:"index"`

routers/web/repo/issue.go

@@ -1014,46 +1014,46 @@ func NewIssuePost(ctx *context.Context) {
 	}
 }
 
-// commentTag returns the CommentTag for a comment in/with the given repo, poster and issue
-func commentTag(repo *models.Repository, poster *models.User, issue *models.Issue) (models.CommentTag, error) {
+// roleDescriptor returns the Role Decriptor for a comment in/with the given repo, poster and issue
+func roleDescriptor(repo *models.Repository, poster *models.User, issue *models.Issue) (models.RoleDescriptor, error) {
 	perm, err := models.GetUserRepoPermission(repo, poster)
 	if err != nil {
-		return models.CommentTagNone, err
+		return models.RoleDescriptorNone, err
 	}
 
-	// By default the comment has no tags.
-	commentTag := models.CommentTagNone
+	// By default the poster has no roles on the comment.
+	roleDescriptor := models.RoleDescriptorNone
 
 	// Check if the poster is owner of the repo.
 	if perm.IsOwner() {
-		// If the poster isn't a admin, enable the owner Tag.
+		// If the poster isn't a admin, enable the owner role.
 		if !poster.IsAdmin {
-			commentTag = commentTag.WithTag(models.CommentTagOwner)
+			roleDescriptor = roleDescriptor.WithRole(models.RoleDescriptorOwner)
 		} else {
 
 			// Otherwise check if poster is the real repo admin.
 			ok, err := models.IsUserRealRepoAdmin(repo, poster)
 			if err != nil {
-				return models.CommentTagNone, err
+				return models.RoleDescriptorNone, err
 			}
 			if ok {
-				commentTag = commentTag.WithTag(models.CommentTagOwner)
+				roleDescriptor = roleDescriptor.WithRole(models.RoleDescriptorOwner)
 			}
 		}
 	}
 
-	// Is the poster can write issues or pulls to the repo, enable the Writer tag.
-	// Only enable this if the poster doesn't have the owner tag already.
-	if !commentTag.HasTag("Owner") && perm.CanWriteIssuesOrPulls(issue.IsPull) {
-		commentTag = commentTag.WithTag(models.CommentTagWriter)
+	// Is the poster can write issues or pulls to the repo, enable the Writer role.
+	// Only enable this if the poster doesn't have the owner role already.
+	if !roleDescriptor.HasRole("Owner") && perm.CanWriteIssuesOrPulls(issue.IsPull) {
+		roleDescriptor = roleDescriptor.WithRole(models.RoleDescriptorWriter)
 	}
-  
-  // If the poster is the actual poster of the issue, enable Poster tag.
+
+	// If the poster is the actual poster of the issue, enable Poster role.
 	if issue.IsPoster(poster.ID) {
-		commentTag = commentTag.WithTag(models.CommentTagPoster)
+		roleDescriptor = roleDescriptor.WithRole(models.RoleDescriptorPoster)
 	}
 
-	return commentTag, nil
+	return roleDescriptor, nil
 }
 
 func getBranchData(ctx *context.Context, issue *models.Issue) {
@@ -1256,9 +1256,9 @@ func ViewIssue(ctx *context.Context) {
 	}
 
 	var (
-		tag          models.CommentTag
+		tag          models.RoleDescriptor
 		ok           bool
-		marked       = make(map[int64]models.CommentTag)
+		marked       = make(map[int64]models.RoleDescriptor)
 		comment      *models.Comment
 		participants = make([]*models.User, 1, 10)
 	)
@@ -1305,11 +1305,11 @@ func ViewIssue(ctx *context.Context) {
 	// check if dependencies can be created across repositories
 	ctx.Data["AllowCrossRepositoryDependencies"] = setting.Service.AllowCrossRepositoryDependencies
 
-	if issue.ShowTag, err = commentTag(repo, issue.Poster, issue); err != nil {
-		ctx.ServerError("commentTag", err)
+	if issue.ShowRole, err = roleDescriptor(repo, issue.Poster, issue); err != nil {
+		ctx.ServerError("roleDescriptor", err)
 		return
 	}
-	marked[issue.PosterID] = issue.ShowTag
+	marked[issue.PosterID] = issue.ShowRole
 
 	// Render comments and and fetch participants.
 	participants[0] = issue.Poster
@@ -1340,16 +1340,16 @@ func ViewIssue(ctx *context.Context) {
 			// Check tag.
 			tag, ok = marked[comment.PosterID]
 			if ok {
-				comment.ShowTag = tag
+				comment.ShowRole = tag
 				continue
 			}
 
-			comment.ShowTag, err = commentTag(repo, comment.Poster, issue)
+			comment.ShowRole, err = roleDescriptor(repo, comment.Poster, issue)
 			if err != nil {
-				ctx.ServerError("commentTag", err)
+				ctx.ServerError("roleDescriptor", err)
 				return
 			}
-			marked[comment.PosterID] = comment.ShowTag
+			marked[comment.PosterID] = comment.ShowRole
 			participants = addParticipant(comment.Poster, participants)
 		} else if comment.Type == models.CommentTypeLabel {
 			if err = comment.LoadLabel(); err != nil {
@@ -1439,16 +1439,16 @@ func ViewIssue(ctx *context.Context) {
 						// Check tag.
 						tag, ok = marked[c.PosterID]
 						if ok {
-							c.ShowTag = tag
+							c.ShowRole = tag
 							continue
 						}
 
-						c.ShowTag, err = commentTag(repo, c.Poster, issue)
+						c.ShowRole, err = roleDescriptor(repo, c.Poster, issue)
 						if err != nil {
-							ctx.ServerError("commentTag", err)
+							ctx.ServerError("roleDescriptor", err)
 							return
 						}
-						marked[c.PosterID] = c.ShowTag
+						marked[c.PosterID] = c.ShowRole
 						participants = addParticipant(c.Poster, participants)
 					}
 				}

templates/repo/issue/view_content.tmpl

@@ -49,13 +49,13 @@
 						</div>
 						<div class="comment-header-right actions df ac">
 							{{if not $.Repository.IsArchived}}
-								{{if gt .Issue.ShowTag 0}}
-									{{if (.Issue.ShowTag.HasTag "Writer")}}
+								{{if gt .Issue.ShowRole 0}}
+									{{if (.Issue.ShowRole.HasRole "Writer")}}
 										<div class="ui basic label">
 											{{$.i18n.Tr "repo.issues.collaborator"}}
 										</div>
 									{{end}}
-									{{if (.Issue.ShowTag.HasTag "Owner")}}
+									{{if (.Issue.ShowRole.HasRole "Owner")}}
 										<div class="ui basic label">
 											{{$.i18n.Tr "repo.issues.owner"}}
 										</div>

templates/repo/issue/view_content/comments.tmpl

@@ -44,17 +44,17 @@
 					</div>
 					<div class="comment-header-right actions df ac">
 						{{if not $.Repository.IsArchived}}
-							{{if (.ShowTag.HasTag "Poster")}}
+							{{if (.ShowRole.HasRole "Poster")}}
 								<div class="ui basic label">
 									{{$.i18n.Tr "repo.issues.poster"}}
 								</div>
 							{{end}}
-							{{if (.ShowTag.HasTag "Writer")}}
+							{{if (.ShowRole.HasRole "Writer")}}
 								<div class="ui basic label">
 									{{$.i18n.Tr "repo.issues.collaborator"}}
 								</div>
 							{{end}}
-							{{if (.ShowTag.HasTag "Owner")}}
+							{{if (.ShowRole.HasRole "Owner")}}
 								<div class="ui basic label">
 									{{$.i18n.Tr "repo.issues.owner"}}
 								</div>
@@ -550,17 +550,17 @@
 															</span>
 														</div>
 														<div class="comment-header-right actions df ac">
-															{{if (.ShowTag.HasTag "Poster")}}
+															{{if (.ShowRole.HasRole "Poster")}}
 																<div class="ui basic label">
 																	{{$.i18n.Tr "repo.issues.poster"}}
 																</div>
 															{{end}}
-															{{if (.ShowTag.HasTag "Writer")}}
+															{{if (.ShowRole.HasRole "Writer")}}
 																<div class="ui basic label">
 																	{{$.i18n.Tr "repo.issues.collaborator"}}
 																</div>
 															{{end}}
-															{{if (.ShowTag.HasTag "Owner")}}
+															{{if (.ShowRole.HasRole "Owner")}}
 																<div class="ui basic label">
 																	{{$.i18n.Tr "repo.issues.owner"}}
 																</div>