Merge pull request #40 from augmentable-dev/add-rust

a bit of restructuring, and add support for rust

Author: patrickdevivo

pkg/comments/comments.go

@@ -13,65 +13,6 @@ import (
 	"gopkg.in/src-d/go-git.v4/plumbing/object"
 )
 
-// CStyleCommentOptions ...
-var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	Boundaries: []lege.Boundary{
-		{
-			Start: "//",
-			End:   "\n",
-		},
-		{
-			Start: "/*",
-			End:   "*/",
-		},
-	},
-}
-
-// HashStyleCommentOptions ...
-var HashStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	Boundaries: []lege.Boundary{
-		{
-			Start: "#",
-			End:   "\n",
-		},
-	},
-}
-
-// LispStyleCommentOptions ..
-var LispStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
-	Boundaries: []lege.Boundary{
-		{
-			Start: ";",
-			End:   "\n",
-		},
-	},
-}
-
-// Language is a source language (i.e. "Go")
-type Language string
-
-// LanguageParseOptions keeps track of source languages and their corresponding comment options
-var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.ParseOptions{
-	"Go":           CStyleCommentOptions,
-	"Java":         CStyleCommentOptions,
-	"C":            CStyleCommentOptions,
-	"C++":          CStyleCommentOptions,
-	"C#":           CStyleCommentOptions,
-	"JavaScript":   CStyleCommentOptions,
-	"Python":       HashStyleCommentOptions,
-	"Ruby":         HashStyleCommentOptions,
-	"PHP":          CStyleCommentOptions,
-	"Shell":        HashStyleCommentOptions,
-	"Visual Basic": {Boundaries: []lege.Boundary{{Start: "'", End: "\n"}}},
-	"TypeScript":   CStyleCommentOptions,
-	"Objective-C":  CStyleCommentOptions,
-	"Groovy":       CStyleCommentOptions,
-	"Swift":        CStyleCommentOptions,
-	"Common Lisp":  LispStyleCommentOptions,
-	"Emacs Lisp":   LispStyleCommentOptions,
-	"R":            HashStyleCommentOptions,
-}
-
 // Comments is a list of comments
 type Comments []*Comment
 

pkg/comments/comments_test.go

@@ -31,3 +31,19 @@ func TestLispFiles(t *testing.T) {
 		t.Fail()
 	}
 }
+
+func TestRustFiles(t *testing.T) {
+	var comments Comments
+	err := SearchDir("testdata/rust", func(comment *Comment) {
+		comments = append(comments, comment)
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// TODO: break the different comment types out into separate files?
+	// once the issue with lege is worked out for handling the different comment types
+	if len(comments) != 21 {
+		t.Fail()
+	}
+}

pkg/comments/languages.go

@@ -0,0 +1,66 @@
+package comments
+
+import "github.com/augmentable-dev/lege"
+
+// CStyleCommentOptions ...
+var CStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
+	Boundaries: []lege.Boundary{
+		{
+			Start: "//",
+			End:   "\n",
+		},
+		{
+			Start: "/*",
+			End:   "*/",
+		},
+	},
+}
+
+// HashStyleCommentOptions ...
+var HashStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
+	Boundaries: []lege.Boundary{
+		{
+			Start: "#",
+			End:   "\n",
+		},
+	},
+}
+
+// LispStyleCommentOptions ..
+var LispStyleCommentOptions *lege.ParseOptions = &lege.ParseOptions{
+	Boundaries: []lege.Boundary{
+		{
+			Start: ";",
+			End:   "\n",
+		},
+	},
+}
+
+// Language is a source language (i.e. "Go")
+type Language string
+
+// LanguageParseOptions keeps track of source languages and their corresponding comment options
+var LanguageParseOptions map[Language]*lege.ParseOptions = map[Language]*lege.ParseOptions{
+	"Go":           CStyleCommentOptions,
+	"Java":         CStyleCommentOptions,
+	"C":            CStyleCommentOptions,
+	"C++":          CStyleCommentOptions,
+	"C#":           CStyleCommentOptions,
+	"JavaScript":   CStyleCommentOptions,
+	"Python":       HashStyleCommentOptions,
+	"Ruby":         HashStyleCommentOptions,
+	"PHP":          CStyleCommentOptions,
+	"Shell":        HashStyleCommentOptions,
+	"Visual Basic": {Boundaries: []lege.Boundary{{Start: "'", End: "\n"}}},
+	"TypeScript":   CStyleCommentOptions,
+	"Objective-C":  CStyleCommentOptions,
+	"Groovy":       CStyleCommentOptions,
+	"Swift":        CStyleCommentOptions,
+	"Common Lisp":  LispStyleCommentOptions,
+	"Emacs Lisp":   LispStyleCommentOptions,
+	"R":            HashStyleCommentOptions,
+
+	// TODO Currently, the underlying pkg that does the parsing/plucking (lege) doesn't properly support precedance
+	// so lines beginning with /// or //! will be picked up by this start // and include a / or ! preceding the comment
+	"Rust": {Boundaries: []lege.Boundary{{Start: "///", End: "\n"}, {Start: "//!", End: "\n"}, {Start: "//", End: "\n"}}},
+}

pkg/comments/testdata/rust/comments.rs

@@ -0,0 +1,31 @@
+// Line comments are anything after ‘//’ and extend to the end of the line.
+
+let x = 5; // This is also a line comment.
+
+// If you have a long explanation for something, you can put line comments next
+// to each other. Put a space between the // and your comment so that it’s
+// more readable.
+
+
+/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```
+/// let five = 5;
+///
+/// assert_eq!(6, add_one(5));
+/// # fn add_one(x: i32) -> i32 {
+/// #     x + 1
+/// # }
+/// ```
+fn add_one(x: i32) -> i32 {
+    x + 1
+}
+
+
+//! # The Rust Standard Library
+//!
+//! The Rust Standard Library provides the essential runtime
+//! functionality for building portable Rust software.
+