v0.8.0-rc1

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## Unreleased
+## v0.8.0-rc1 - 2020-04-28
 
 - Strings are now encoded as utf8 binaries in the generated Erlang.
 - HTML documentation can now be generated from Gleam code by running `gleam

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gleam"
-version = "0.8.0-dev"
+version = "0.8.0-rc1"
 authors = ["Louis Pilfold <[email protected]>"]
 edition = "2018"
 

src/ast.rs

@@ -79,6 +79,18 @@ pub struct RecordConstructor {
     pub location: SrcSpan,
     pub name: String,
     pub args: Vec<(Option<String>, TypeAst)>,
+    pub documentation: Option<String>,
+}
+
+impl RecordConstructor {
+    pub fn put_doc<'a>(&mut self, new_doc: impl Iterator<Item = &'a str>) {
+        let mut new_doc = new_doc.peekable();
+        if new_doc.peek().is_none() {
+            return;
+        }
+
+        self.documentation = Some(new_doc.join("\n"));
+    }
 }
 
 #[derive(Debug, Clone, PartialEq)]

src/doc.rs

@@ -177,9 +177,8 @@ fn type_<'a>(statement: &'a TypedStatement) -> Option<Type<'a>> {
             constructors: cs
                 .into_iter()
                 .map(|constructor| TypeConstructor {
-                    name: constructor.name.as_ref(),
                     definition: print(formatter.record_constructor(constructor)),
-                    documentation: "".to_string(),
+                    documentation: markdown_documentation(&constructor.documentation),
                 })
                 .collect(),
         }),
@@ -220,8 +219,7 @@ struct Function<'a> {
 }
 
 #[derive(PartialEq, Eq, PartialOrd, Ord, Debug)]
-struct TypeConstructor<'a> {
-    name: &'a str,
+struct TypeConstructor {
     definition: String,
     documentation: String,
 }
@@ -231,7 +229,7 @@ struct Type<'a> {
     name: &'a str,
     definition: String,
     documentation: String,
-    constructors: Vec<TypeConstructor<'a>>,
+    constructors: Vec<TypeConstructor>,
 }
 
 #[derive(Template)]

src/erl/tests.rs

@@ -40,6 +40,7 @@ fn module_test() {
                     location: Default::default(),
                     name: "Ok".to_string(),
                     args: vec![],
+                    documentation: None,
                 }],
             },
             Statement::Import {

src/grammar.lalrpop

@@ -61,6 +61,7 @@ RecordConstructor: RecordConstructor = {
         location: location(s, e),
         name: t,
         args: args.unwrap_or_else(|| vec![]),
+        documentation: None,
     },
 }
 

src/project/source_tree.rs

@@ -193,10 +193,16 @@ fn attach_doc_comments<'a, A, B, C>(
 ) {
     for statement in &mut module.statements {
         let location = statement.location();
-        // TODO: be more fine grained with how we apply the comments.
-        // i.e. Apply them to custom type constructors.
-        let (doc, rest) = parser::take_before(comments, location.end);
+        let (doc, rest) = parser::take_before(comments, location.start);
         comments = rest;
         statement.put_doc(doc);
+
+        if let crate::ast::Statement::CustomType { constructors, .. } = statement {
+            for constructor in constructors {
+                let (doc, rest) = parser::take_before(comments, constructor.location.start);
+                comments = rest;
+                constructor.put_doc(doc);
+            }
+        }
     }
 }

templates/documentation_module.html

@@ -47,9 +47,8 @@ <h3>
       <ul>
         {% for constructor in typ.constructors %}
         <li>
-          <code class="constructor-name">{{ constructor.name }}</code>
-          <pre>{{ constructor.definition }}</pre>
-          <p>{{ constructor.documentation|safe }}</p>
+          <code class="constructor-name">{{ constructor.definition }}</code>
+          {{ constructor.documentation|safe }}
         </li>
         {% endfor %}
       </ul>

test/core_language/test/binary_operators_test.gleam

@@ -1,8 +1,8 @@
 import should
 
-pub fn precedence_test() {
-  should.equal(1 + 2 * 3, 7)
-  should.equal(3 * 1 + 2, 5)
-  should.equal({ 1 + 2 } * 3, 9)
-  should.equal(3 * { 1 + 2 }, 9)
-}
+// pub fn precedence_test() {
+//   should.equal(1 + 2 * 3, 7)
+//   should.equal(3 * 1 + 2, 5)
+//   should.equal({ 1 + 2 } * 3, 9)
+//   should.equal(3 * { 1 + 2 }, 9)
+// }