Merge pull request #4 from briandowns/change_weight_to_priority

Change weight to priority

README.md

@@ -12,10 +12,10 @@ Example:
 TODO(briandowns) this is an example todo format 2016-05-13T18:54 4
 ```
 
-## Weighting
+## Priorities
 
 ```sh
-todo-view weights:
+todo-view priorities:
 
 1       Extremely important
 2       Somewhat important
@@ -29,7 +29,7 @@ todo-view weights:
 * User
 * File
 * Timestamp
-* Weight
+* Priority
 
 ## Usage
 

command/export.go

@@ -73,7 +73,7 @@ func (e *Export) csv() {
 	}
 	for _, todo := range todos {
 		fmt.Fprintf(os.Stdout, "%s,%s,%s,%v,%d\n",
-			todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Weight())
+			todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Priority())
 	}
 }
 
@@ -110,6 +110,6 @@ func (e *Export) jira() {
 	fmt.Fprintln(os.Stdout, "Summary,Assignee,Reporter,Priority")
 	for _, todo := range todos {
 		fmt.Fprintf(os.Stdout, "%s,%s,%s,%d\n",
-			todo.Message(), todo.User(), todo.User(), todo.Weight())
+			todo.Message(), todo.User(), todo.User(), todo.Priority())
 	}
 }

command/parse.go

@@ -21,12 +21,12 @@ type Parser interface {
 	byUser()
 	byFile()
 	byDate()
-	byWeight()
+	byPriority()
 }
 
 // regex holds the pattern necessary to match the todo in the
 // files parsed
-var regex = regexp.MustCompile(`TODO\((?P<user>[a-z].+)\)(?P<msg>.+)(?P<timestamp>\d\d\d\d\D?\d\d\D?\d\d\D?\d\d\D?\d\d\D?(\d\d\.?(\d*))?(\d\d(:\d\d)?)?).(?P<weight>\d)`)
+var regex = regexp.MustCompile(`TODO\((?P<user>[a-z].+)\)(?P<msg>.+)(?P<timestamp>\d\d\d\d\D?\d\d\D?\d\d\D?\d\d\D?\d\d\D?(\d\d\.?(\d*))?(\d\d(:\d\d)?)?).(?P<priority>\d)`)
 
 // Parse type for command
 type Parse struct{}
@@ -74,15 +74,15 @@ func (p *Parse) Run(args []string) int {
 			}
 		}
 		p.byDate(true)
-	case "by-weight":
+	case "by-priority":
 		if len(args) == 2 {
 			switch args[1] {
 			case "-d":
-				p.byWeight(false)
+				p.byPriority(false)
 				return 1
 			}
 		}
-		p.byWeight(true)
+		p.byPriority(true)
 	default:
 		fmt.Println("ERROR: invalid option for parse\n")
 	}
@@ -97,7 +97,7 @@ Options:
   by-user     [-d decending]        Parse todo's by user
   by-file     [-d decending]        Parse todo's by file   
   by-date     [-d decending]        Parse todo's by date
-  by-weight   [-d decending]        Parse todo's by weight
+  by-priority   [-d decending]        Parse todo's by priority
   
 `
 }
@@ -116,22 +116,22 @@ func printOutput(ot string, t sort.Interface) {
 	case UserTodos:
 		for _, todo := range todoerType {
 			fmt.Fprintf(w, "%s\t%s\t%s\t%v\t%d\n",
-				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Weight())
+				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Priority())
 		}
 	case FileTodos:
 		for _, todo := range todoerType {
 			fmt.Fprintf(w, "%s\t%s\t%s\t%v\t%d\n",
-				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Weight())
+				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Priority())
 		}
 	case TimestampTodos:
 		for _, todo := range todoerType {
 			fmt.Fprintf(w, "%s\t%s\t%s\t%v\t%d\n",
-				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Weight())
+				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Priority())
 		}
-	case WeightTodos:
+	case PriorityTodos:
 		for _, todo := range todoerType {
 			fmt.Fprintf(w, "%s\t%s\t%s\t%v\t%d\n",
-				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Weight())
+				todo.User(), todo.File(), todo.Message(), todo.Timestamp(), todo.Priority())
 		}
 	}
 	fmt.Fprintf(w, "\n")
@@ -194,7 +194,7 @@ func (p *Parse) byDate(decending bool) {
 	switch decending {
 	case true:
 		sort.Sort(timestampTodos)
-		printOutput("weight", timestampTodos)
+		printOutput("priority", timestampTodos)
 		return
 	case false:
 		sort.Sort(sort.Reverse(timestampTodos))
@@ -203,24 +203,24 @@ func (p *Parse) byDate(decending bool) {
 	}
 }
 
-// byWeight outputs the data by weight
-func (p *Parse) byWeight(decending bool) {
+// byPriority outputs the data by priority
+func (p *Parse) byPriority(decending bool) {
 	todos, err := search()
 	if err != nil {
 		log.Fatalln(err)
 	}
-	weightTodos := make(WeightTodos, len(todos))
+	priorityTodos := make(PriorityTodos, len(todos))
 	for i := 0; i <= len(todos)-1; i++ {
-		weightTodos[i] = todos[i]
+		priorityTodos[i] = todos[i]
 	}
 	switch decending {
 	case true:
-		sort.Sort(weightTodos)
-		printOutput("weight", weightTodos)
+		sort.Sort(priorityTodos)
+		printOutput("priority", priorityTodos)
 		return
 	case false:
-		sort.Sort(sort.Reverse(weightTodos))
-		printOutput("weight", weightTodos)
+		sort.Sort(sort.Reverse(priorityTodos))
+		printOutput("priority", priorityTodos)
 		return
 	}
 }
@@ -276,12 +276,12 @@ func search() ([]Todo, error) {
 							return nil, err
 						}
 						todo.timestamp = ts
-					case "weight":
+					case "priority":
 						s, err := strconv.Atoi(match[i])
 						if err != nil {
 							return nil, err
 						}
-						todo.weight = s
+						todo.priority = s
 					}
 				}
 				todos = append(todos, todo)

command/weight.go → command/priority.go

@@ -1,15 +1,15 @@
 package command
 
-var Weights = map[int]string{
+var Priorities = map[int]string{
 	5: "Not at all important",
 	4: "Slightly important",
 	3: "Moderately important",
 	2: "Somewhat important",
 	1: "Extremely important",
 }
 
-// Weight is holds a weight
-type Weight struct {
+// Priority holds an individual priority
+type Priority struct {
 	Value       int
 	Description string
 }

command/show.go

@@ -29,8 +29,8 @@ func (s *Show) Run(args []string) int {
 	switch args[0] {
 	case "format":
 		s.showFormat()
-	case "weights":
-		s.showWeights()
+	case "priorities":
+		s.showPriorities()
 	default:
 		fmt.Println("ERROR: invalid option for show\n")
 	}
@@ -43,8 +43,8 @@ func (s *Show) Help() string {
 	return `Usage: todo-view show <option> <arguments> 
   Show a resource
 Options:
-  format             Display todo-view todo format
-  weights            Display todo-view weights
+  format             Display todo-view format
+  priorities         Display todo-view priorities
   
 `
 }
@@ -66,19 +66,19 @@ func (s *Show) showFormat() {
 	w.Flush()
 }
 
-// showWeights shows all configured weights
-func (s *Show) showWeights() {
-	fmt.Print("\ntodo-view weights:\n\n")
+// showPriorities shows all configured priorities
+func (s *Show) showPriorities() {
+	fmt.Print("\ntodo-view priorities:\n\n")
 	w := NewTabWriter()
 
 	var keys []int
-	for k := range Weights {
+	for k := range Priorities {
 		keys = append(keys, k)
 	}
 	sort.Ints(keys)
 
 	for _, k := range keys {
-		fmt.Fprintf(w, "%d\t%s\n", k, Weights[k])
+		fmt.Fprintf(w, "%d\t%s\n", k, Priorities[k])
 	}
 
 	fmt.Fprintf(w, "\n")

command/todo.go

@@ -4,15 +4,15 @@ import "time"
 
 // Format represents how timestamps show look
 var Format = "2006-01-02T15:04"
-var todoFormat = "TODO(<user>) <message> <timestamp> <weight>"
+var todoFormat = "TODO(<user>) <message> <timestamp> <priority>"
 
 // Todoer implements the functionality to view todos
 type Todoer interface {
 	User() string
 	File() string
 	Message() string
 	Timestamp() time.Time
-	Weight() int
+	priority() int
 }
 
 // Todo represents a todo
@@ -21,16 +21,16 @@ type Todo struct {
 	file      string
 	message   string
 	timestamp time.Time
-	weight    int
+	priority  int
 }
 
 // NewTodo creates a new reference of a todo
 func NewTodo(u, m, ts, f string, w int) (*Todo, error) {
 	todo := &Todo{
-		user:    u,
-		file:    f,
-		message: m,
-		weight:  w,
+		user:     u,
+		file:     f,
+		message:  m,
+		priority: w,
 	}
 	timestamp, err := time.Parse(Format, ts)
 	if err != nil {
@@ -56,8 +56,8 @@ func (t *Todo) Timestamp() time.Time {
 	return t.timestamp
 }
 
-func (t *Todo) Weight() int {
-	return t.weight
+func (t *Todo) Priority() int {
+	return t.priority
 }
 
 // UserTodos is a slice type made for easier sorting
@@ -119,20 +119,20 @@ func (t TimestampTodos) Swap(i, j int) {
 	t[i], t[j] = t[j], t[i]
 }
 
-// WeightTodos is a slice type made for easier sorting
-type WeightTodos []Todo
+// PriorityTodos is a slice type made for easier sorting
+type PriorityTodos []Todo
 
 // Len gets the length of the slice
-func (w WeightTodos) Len() int {
+func (w PriorityTodos) Len() int {
 	return len(w)
 }
 
 // Less does a comparison of the 2 given arguments
-func (w WeightTodos) Less(i, j int) bool {
-	return w[i].weight < w[j].weight
+func (w PriorityTodos) Less(i, j int) bool {
+	return w[i].priority < w[j].priority
 }
 
 // Swap switchs the place in the slice for the 2 given arguments
-func (w WeightTodos) Swap(i, j int) {
+func (w PriorityTodos) Swap(i, j int) {
 	w[i], w[j] = w[j], w[i]
 }