Merge pull request #112 from firebase/koss-function-deprecation-merge

Deprecate function format fn(x) = exp.

Author: mckoss

docs/changelog.txt

@@ -1 +1,2 @@
 changed - Path expressions should now use path template syntax instead of wildcard variables.
+changed - Deprecate fn(x) = exp; function definition format (with deprecation warning).

docs/guide.md

@@ -29,12 +29,12 @@ permissions can be written as:
 [all_access.bolt](../samples/all_access.bolt)
 ```javascript
 path / {
-  read() = true;
-  write() = true;
+  read() { true }
+  write() { true }
 }
 ```
 
-The `read() = true` and `write() = true` methods allow everyone to read and write this location
+The `read() { true }` and `write() { true }` methods allow everyone to read and write this location
 (and all children under this location). You can also use more complex expressions instead of
 `true`.  When the expression evaluates to `true` the read or write operation is allowed.
 
@@ -97,16 +97,16 @@ _posts.bolt_
 ```javascript
 // Allow anyone to read the list of Posts.
 path /posts {
-  read() = true;
+  read() { true }
 }
 
 // All individual Posts are writable by anyone.
 path /posts/{id} is Post {
-  write() = true;
+  write() { true }
 }
 
 type Post {
-  validate() = this.message.length <= 140;
+  validate() { this.message.length <= 140 }
 
   message: String,
   from: String
@@ -124,7 +124,7 @@ captured variable `id` being equal to (the string) '123'.
 The Post type allows for exactly two string properties in each post (message and
 from). It also ensures that no message is longer than 140 characters.
 
-Bolt type statements can contain a `validate()` method (defined as `validate() = <expression>`,
+Bolt type statements can contain a `validate()` method (defined as `validate() { <expression> }`,
 where the expression evaluates to `true` if the data is valid (can be saved to the
 database). When the expression evaluates to `false`, the attempt to write the data will return
 an error to the Firebase client and the database will be unmodified.
@@ -220,7 +220,7 @@ type Room {
 }
 
 type NameString extends String {
-  validate() = this.length > 0 && this.length <= 32;
+  validate() { this.length > 0 && this.length <= 32 }
 }
 ```
 
@@ -273,8 +273,8 @@ definitions look just like _type_ and _path_ methods, except they can also accep
 
 ```javascript
 path /users/{userid} is User {
-  read() = true;
-  write() = isCurrentUser(userid);
+  read() { true }
+  write() { isCurrentUser(userid) }
 }
 
 type User {
@@ -284,7 +284,7 @@ type User {
 
 // Define isCurrentUser() function to test if the given user id
 // matches the currently signed-in user.
-isCurrentUser(uid) = auth != null && auth.uid == uid;
+isCurrentUser(uid) { auth != null && auth.uid == uid }
 ```
 
 ```JSON
@@ -326,7 +326,7 @@ path /posts/{id} is Post;
 
 type Post {
   // Make sure that the only value allowed to be written is now.
-  validate() = this.modified == now;
+  validate() { this.modified == now }
 
   message: String,
   modified: Number
@@ -340,8 +340,8 @@ A handy way to express this is to use a user-defined type for the CurrentTimesta
 
 ```javascript
 path /posts/{id} is Post {
-  read() = true;
-  write() = true;
+  read() { true }
+  write() { true }
 }
 
 type Post {
@@ -350,7 +350,7 @@ type Post {
 }
 
 type CurrentTimestamp extends Number {
-  validate() = this == now;
+  validate() { this == now }
 }
 ```
 
@@ -359,8 +359,8 @@ when first written, and never change thereafter:
 
 ```javascript
 path /posts/{id} is Post {
-  read() = true;
-  write() = true;
+  read() { true }
+  write() { true }
 }
 
 type Post {
@@ -370,16 +370,16 @@ type Post {
 }
 
 type CurrentTimestamp extends Number {
-  validate() = this == now;
+  validate() { this == now }
 }
 
 type InitialTimestamp extends Number {
-  validate() = initial(this, now);
+  validate() { initial(this, now) }
 }
 
 // Returns true if the value is intialized to init, or if it retains it's prior
 // value, otherwise.
-initial(value, init) = value == (prior(value) == null ? init : prior(value));
+initial(value, init) { value == (prior(value) == null ? init : prior(value)) }
 ```
 
 Note the special function `prior(ref)` - returns the previous value stored at a given database location
@@ -419,8 +419,8 @@ to define the Timestamp example above is:
 ```javascript
 // Note the use of Timestamped version of a Post type.
 path /posts/{id} is Timestamped<Post> {
-  read() = true;
-  write() = true;
+  read() { true }
+  write() { true }
 }
 
 type Post {
@@ -433,16 +433,16 @@ type Timestamped<T> extends T {
 }
 
 type CurrentTimestamp extends Number {
-  validate() = this == now;
+  validate() { this == now }
 }
 
 type InitialTimestamp extends Number {
-  validate() = initial(this, now);
+  validate() { initial(this, now) }
 }
 
 // Returns true if the value is intialized to init, or retains it's prior
 // value, otherwise.
-initial(value, init) = value == (prior(value) == null ? init : prior(value));
+initial(value, init) { value == (prior(value) == null ? init : prior(value)) }
 ```
 
 ```JSON
@@ -481,34 +481,34 @@ Rules](https://www.firebase.com/docs/security/guide/user-security.html#section-r
 // Room Names
 //
 path /rooms_names is String[] {
-  read() = isSignedIn();
+  read() { isSignedIn() }
 }
 
-getRoomName(id) = prior(root.room_names[id]);
+getRoomName(id) { prior(root.room_names[id]) }
 
 //
 // Room Members
 //
 path /members/{room_id} {
-  read() = isRoomMember(room_id);
+  read() { isRoomMember(room_id) }
 }
 
 path /members/{room_id}/{user_id} is NameString {
-  write() = isCurrentUser(user_id);
+  write() { isCurrentUser(user_id) }
 }
 
-isRoomMember(room_id) = isSignedIn() && prior(root.members[room_id][auth.uid]) != null;
+isRoomMember(room_id) { isSignedIn() && prior(root.members[room_id][auth.uid]) != null }
 
 //
 // Messages
 //
 path /messages/{room_id} {
-  read() = isRoomMember(room_id);
-  validate() = getRoomName(room_id) != null;
+  read() { isRoomMember(room_id) }
+  validate() { getRoomName(room_id) != null }
 }
 
 path /messages/{room_id}/{message_id} is Message {
-  write() = createOnly(this) && isRoomMember(room_id);
+  write() { createOnly(this) && isRoomMember(room_id) }
 }
 
 type Message {
@@ -518,26 +518,26 @@ type Message {
 }
 
 type MessageString extends String {
-  validate() = this.length > 0 && this.length < 50;
+  validate() { this.length > 0 && this.length < 50 }
 }
 
 //
 // Helper Types
 //
 type CurrentTimestamp extends Number {
-  validate() = this == now;
+  validate() { this == now }
 }
 
 type NameString {
-  validate() = this.length > 0 && this.length < 20;
+  validate() { this.length > 0 && this.length < 20 }
 }
 
 //
 // Helper Functions
 //
-isCurrentUser(uid) = isSignedIn() && auth.uid == uid;
-isSignedIn() = auth != null;
-createOnly(value) = prior(value) == null && value != null;
+isCurrentUser(uid) { isSignedIn() && auth.uid == uid }
+isSignedIn() { auth != null }
+createOnly(value) { prior(value) == null && value != null }
 ```
 
 ```JSON

docs/language.md

@@ -33,7 +33,7 @@ type MyType [extends BaseType] {
   property2: Type,
   ...
 
-  validate() = <validation expression>;
+  validate() { <validation expression> }
   }
 }
 ```
@@ -67,11 +67,11 @@ Any of the built-in scalar types can be _extended_ by adding a validation expres
 
 ```javascript
 type ShortString extends String {
-  validate() = this.length < 32;
+  validate() { this.length < 32 }
 }
 
 type Percentage extends Number {
-  validate() = this >=0 && this <= 100;
+  validate() { this >=0 && this <= 100 }
 }
 ```
 
@@ -103,7 +103,7 @@ type Model {
 }
 
 type ProductID extends String {
-  validate() = this.length <= 20;
+  validate() { this.length <= 20 }
 }
 ```
 
@@ -145,11 +145,11 @@ A path statement provides access and validation rules for data stored at a given
 
 ```javascript
 path /path/to/data [is Type] {
-  read() = <true-iff-reading-this-path-is-allowed>;
+  read() { <true-iff-reading-this-path-is-allowed> }
 
-  write() = <true-iff-writing-this-path-is-allowed>;
+  write() { <true-iff-writing-this-path-is-allowed> }
 
-  validate() = <additional-validation-rules>;
+  validate() { <additional-validation-rules> }
 }
 ```
 
@@ -174,10 +174,10 @@ an expression as a variable parameter:
 ```javascript
 path /users/{uid} is User {
   // Anyone can read a User's information.
-  read() = true;
+  read() { true }
 
   // Only an authenticated user can write their information.
-  write() = auth != null && auth.uid == uid;
+  write() { auth != null && auth.uid == uid }
 }
 ```
 
@@ -237,7 +237,7 @@ and one of its properties:
 path /products is Product[];
 
 type Product {
-  validate() = this.id == key();
+  validate() { this.id == key() }
 
   id: String,
   name: String
@@ -258,16 +258,16 @@ function isUser(uid) {
 
 function isUser(uid) { auth != null && auth.uid == uid }
 
-isUser(uid) = auth != null && auth.uid == uid;
+isUser(uid) { auth != null && auth.uid == uid }
 ```
 
 Similarly, methods in path and type statements can use the abbreviated functional form (all
 these are equivalent):
 
 ```javascript
 write() { return this.user == auth.uid; }
+write() { this.user == auth.uid; }
 write() { this.user == auth.uid }
-write() = this.user == auth.uid;
 ```
 
 # Expressions
@@ -295,10 +295,10 @@ not identical in Bolt.  This section demonstrates how equivalent behavior is ach
 
 API | Bolt Equivalent
 ----| ---------------
-".read" : "exp" | read() { return exp; }
-".write" : "exp" | write() { return exp; }
-".validate": "exp" | validate() { return exp; }
-".indexOn": [ "prop", ...] | index() { return [ "prop", ... ] }
+".read" : "exp" | read() { exp }
+".write" : "exp" | write() { exp }
+".validate": "exp" | validate() { exp }
+".indexOn": [ "prop", ...] | index() { [ "prop", ... ] }
 
 ## Variables
 

samples/all_access.bolt

@@ -1,5 +1,5 @@
 // Equivalent to the default (most-permissive) Firebase rule.
 path / {
-  read() = true;
-  write() = true;
+  read() { true }
+  write() { true }
 }