[#22] Contribute SlashStarStar

core/comment.go

@@ -125,6 +125,21 @@ func (Rem) GetClosingString() string {
 	return ""
 }
 
+type SlashStarStar struct{}
+
+func (SlashStarStar) GetName() string {
+	return "SlashStarStar"
+}
+func (SlashStarStar) GetOpeningString() string {
+	return "/**"
+}
+func (SlashStarStar) GetString() string {
+	return " * "
+}
+func (SlashStarStar) GetClosingString() string {
+	return " */"
+}
+
 func ParseCommentStyle(str string) CommentStyle {
 	styles := supportedStyles()
 	keys := extractKeys(styles)
@@ -211,6 +226,7 @@ func supportedStyles() map[string]CommentStyle {
 		"DashDash":   DashDash{},
 		"SemiColon": SemiColon{},
 		"REM": Rem{},
+		"SlashStarStar": SlashStarStar{},
 	}
 }
 

core/comment_test.go

@@ -24,5 +24,6 @@ var _ = Describe("Comment", func() {
 		Entry("matches DashDash comment style", "DashDash", "", "", "-- "),
 		Entry("matches SemiColon comment style", "SemiColon", "", "", "; "),
 		Entry("matches REM comment style", "REM", "", "", "REM "),
+		Entry("matches SlashStarStar comment style", "SlashStarStar", "/**", " */", " * "),
 	)
 })

core/configuration_test.go

@@ -187,6 +187,27 @@ var _ = Describe("Configuration parser", func() {
 		Expect(onlyPaths(changeSet.Files)).To(Equal([]FileChange{{Path: "hello-world.go"}}))
 	})
 
+	It("pre-computes the final configuration with SlashStarStar comment style", func() {
+		configuration := &core.Configuration{
+			HeaderFile:   "some-header",
+			CommentStyle: "SlashStarStar",
+			Includes:     includes,
+			Excludes:     excludes,
+			TemplateData: data,
+		}
+		tracker.On("RetrieveVersionedTemplate", configuration).
+			Return(unchangedHeaderContents("Copyright {{.Year}} {{.Owner}}\n\nSome fictional license", data, revision), nil)
+		versioningClient.On("GetChanges", revision).Return(initialChanges, nil)
+		pathMatcher.On("MatchFiles", initialChanges, includes, excludes, fileSystem).Return(resultingChanges)
+		versioningClient.On("AddMetadata", resultingChanges, clock).Return(resultingChanges, nil)
+
+		changeSet, err := core.ParseConfiguration(configuration, systemConfiguration, tracker, pathMatcher)
+
+		Expect(err).To(BeNil())
+		Expect(changeSet.HeaderContents).To(Equal("/**\n * Copyright {{.YearRange}} ACME Labs\n *\n * Some fictional license\n */"))
+		Expect(onlyPaths(changeSet.Files)).To(Equal([]FileChange{{Path: "hello-world.go"}}))
+	})
+
 	It("pre-computes the header contents with SlashStar comment style", func() {
 		configuration := &core.Configuration{
 			HeaderFile:   "some-header",

core/configuration_validator_test.go

@@ -102,6 +102,15 @@ var _ = Describe("Configuration validator", func() {
 		Expect(validationError).To(BeNil())
 	})
 
+	It("accepts valid configuration with SlashStarStar comment style", func() {
+		fileReader.On("Open", "docs.json").
+			Return(inMemoryFile(`{"headerFile": "some-file.txt", "style": "SlashStarStar", "includes": ["**/*.go"]}`), nil)
+
+		validationError := validator.Validate("file://docs.json")
+
+		Expect(validationError).To(BeNil())
+	})
+
 	It("rejects configuration with missing header file", func() {
 		fileReader.On("Open", "docs.json").
 			Return(inMemoryFile(`{"style": "SlashStar", "includes": ["**/*.go"]}`), nil)

docs/schema.json

@@ -18,7 +18,8 @@
         "Hash",
         "DashDash",
         "SemiColon",
-        "REM"
+        "REM",
+        "SlashStarStar"
       ]
     },
     "includes": {