Fix missed var names & rename collection

Author: jdsutherland

cmd/download_test.go

@@ -144,13 +144,13 @@ func TestDownload(t *testing.T) {
 
 		dir := filepath.Join(targetDir, "bogus-track", "bogus-exercise")
 		b, err := ioutil.ReadFile(workspace.NewExerciseFromDir(dir).MetadataFilepath())
-		var s workspace.ExerciseMetadata
-		err = json.Unmarshal(b, &s)
+		var metadata workspace.ExerciseMetadata
+		err = json.Unmarshal(b, &metadata)
 		assert.NoError(t, err)
 
-		assert.Equal(t, "bogus-track", s.Track)
-		assert.Equal(t, "bogus-exercise", s.Exercise)
-		assert.Equal(t, tc.requester, s.IsRequester)
+		assert.Equal(t, "bogus-track", metadata.Track)
+		assert.Equal(t, "bogus-exercise", metadata.Exercise)
+		assert.Equal(t, tc.requester, metadata.IsRequester)
 	}
 }
 

workspace/exercise_metadata.go

@@ -36,35 +36,35 @@ func NewExerciseMetadata(dir string) (*ExerciseMetadata, error) {
 	if err != nil {
 		return &ExerciseMetadata{}, err
 	}
-	var s ExerciseMetadata
-	if err := json.Unmarshal(b, &s); err != nil {
+	var metadata ExerciseMetadata
+	if err := json.Unmarshal(b, &metadata); err != nil {
 		return &ExerciseMetadata{}, err
 	}
-	s.Dir = dir
-	return &s, nil
+	metadata.Dir = dir
+	return &metadata, nil
 }
 
 // Suffix is the serial numeric value appended to an exercise directory.
 // This is appended to avoid name conflicts, and does not indicate a particular
 // iteration.
-func (s *ExerciseMetadata) Suffix() string {
-	return strings.Trim(strings.Replace(filepath.Base(s.Dir), s.Exercise, "", 1), "-.")
+func (em *ExerciseMetadata) Suffix() string {
+	return strings.Trim(strings.Replace(filepath.Base(em.Dir), em.Exercise, "", 1), "-.")
 }
 
-func (s *ExerciseMetadata) String() string {
-	str := fmt.Sprintf("%s/%s", s.Track, s.Exercise)
-	if s.Suffix() != "" {
-		str = fmt.Sprintf("%s (%s)", str, s.Suffix())
+func (em *ExerciseMetadata) String() string {
+	str := fmt.Sprintf("%s/%s", em.Track, em.Exercise)
+	if em.Suffix() != "" {
+		str = fmt.Sprintf("%s (%s)", str, em.Suffix())
 	}
-	if !s.IsRequester && s.Handle != "" {
-		str = fmt.Sprintf("%s by @%s", str, s.Handle)
+	if !em.IsRequester && em.Handle != "" {
+		str = fmt.Sprintf("%s by @%s", str, em.Handle)
 	}
 	return str
 }
 
 // Write stores exercise metadata to a file.
-func (s *ExerciseMetadata) Write(dir string) error {
-	b, err := json.Marshal(s)
+func (em *ExerciseMetadata) Write(dir string) error {
+	b, err := json.Marshal(em)
 	if err != nil {
 		return err
 	}
@@ -75,15 +75,15 @@ func (s *ExerciseMetadata) Write(dir string) error {
 	if err = ioutil.WriteFile(metadataAbsoluteFilepath, b, os.FileMode(0600)); err != nil {
 		return err
 	}
-	s.Dir = dir
+	em.Dir = dir
 	return nil
 }
 
 // PathToParent is the relative path from the workspace to the parent dir.
-func (s *ExerciseMetadata) PathToParent() string {
+func (em *ExerciseMetadata) PathToParent() string {
 	var dir string
-	if !s.IsRequester {
+	if !em.IsRequester {
 		dir = filepath.Join("users")
 	}
-	return filepath.Join(dir, s.Track)
+	return filepath.Join(dir, em.Track)
 }

workspace/exercise_metadata_collection.go

@@ -0,0 +1,18 @@
+package workspace
+
+// ExerciseMetadataCollection is a collection of exercise metadata to interactively choose from.
+type ExerciseMetadataCollection []*ExerciseMetadata
+
+// NewExerciseMetadataCollection loads up the exercise metadata for each of the provided paths.
+func NewExerciseMetadataCollection(paths []string) (ExerciseMetadataCollection, error) {
+	var metadataCollection []*ExerciseMetadata
+
+	for _, path := range paths {
+		metadata, err := NewExerciseMetadata(path)
+		if err != nil {
+			return []*ExerciseMetadata{}, err
+		}
+		metadataCollection = append(metadataCollection, metadata)
+	}
+	return metadataCollection, nil
+}

workspace/exercise_metadatas_test.go …ace/exercise_metadata_collection_test.goworkspace/exercise_metadatas_test.go renamed to workspace/exercise_metadata_collection_test.go workspace/exercise_metadatas_test.go renamed to workspace/exercise_metadata_collection_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestNewExerciseMetadatas(t *testing.T) {
+func TestNewExerciseMetadataCollection(t *testing.T) {
 	_, cwd, _, _ := runtime.Caller(0)
 	root := filepath.Join(cwd, "..", "..", "fixtures", "solutions")
 
@@ -17,20 +17,20 @@ func TestNewExerciseMetadatas(t *testing.T) {
 		filepath.Join(root, "bravo"),
 		filepath.Join(root, "charlie"),
 	}
-	sx, err := NewExerciseMetadatas(paths)
+	metadata, err := NewExerciseMetadataCollection(paths)
 	assert.NoError(t, err)
 
-	if assert.Equal(t, 3, len(sx)) {
-		assert.Equal(t, "alpha", sx[0].ID)
-		assert.Equal(t, "bravo", sx[1].ID)
-		assert.Equal(t, "charlie", sx[2].ID)
+	if assert.Equal(t, 3, len(metadata)) {
+		assert.Equal(t, "alpha", metadata[0].ID)
+		assert.Equal(t, "bravo", metadata[1].ID)
+		assert.Equal(t, "charlie", metadata[2].ID)
 	}
 
 	paths = []string{
 		filepath.Join(root, "alpha"),
 		filepath.Join(root, "delta"),
 		filepath.Join(root, "bravo"),
 	}
-	_, err = NewExerciseMetadatas(paths)
+	_, err = NewExerciseMetadataCollection(paths)
 	assert.Error(t, err)
 }

workspace/exercise_metadata_test.go

@@ -14,7 +14,7 @@ func TestExerciseMetadata(t *testing.T) {
 	assert.NoError(t, err)
 	defer os.RemoveAll(dir)
 
-	s1 := &ExerciseMetadata{
+	em1 := &ExerciseMetadata{
 		Track:       "a-track",
 		Exercise:    "bogus-exercise",
 		ID:          "abc",
@@ -23,23 +23,23 @@ func TestExerciseMetadata(t *testing.T) {
 		IsRequester: true,
 		Dir:         dir,
 	}
-	err = s1.Write(dir)
+	err = em1.Write(dir)
 	assert.NoError(t, err)
 
-	s2, err := NewExerciseMetadata(dir)
+	em2, err := NewExerciseMetadata(dir)
 	assert.NoError(t, err)
-	assert.Nil(t, s2.SubmittedAt)
-	assert.Equal(t, s1, s2)
+	assert.Nil(t, em2.SubmittedAt)
+	assert.Equal(t, em1, em2)
 
 	ts := time.Date(2000, 1, 2, 3, 4, 5, 6, time.UTC)
-	s2.SubmittedAt = &ts
+	em2.SubmittedAt = &ts
 
-	err = s2.Write(dir)
+	err = em2.Write(dir)
 	assert.NoError(t, err)
 
-	s3, err := NewExerciseMetadata(dir)
+	em3, err := NewExerciseMetadata(dir)
 	assert.NoError(t, err)
-	assert.Equal(t, s2, s3)
+	assert.Equal(t, em2, em3)
 }
 
 func TestSuffix(t *testing.T) {