gloo 6.4.0 → 6.5.1

data/test.gloo/objs/file.test.gloo

@@ -5,73 +5,71 @@
 # file under /tmp, exercise it, and delete it at the end.
 #
 
-tests [can] :
-  objs [can] :
-    file [can] :
-
-      f [file] : /tmp/gloo_file_test.txt
-      names [file] : /Users/me/project/report.csv
-
-      first [string] : first line
-      second [string] : second line
-      back [string] :
-
-      write_read_round_trip [test] :
-        description [string] : write puts an object's value in the file; read gets it back.
-        on_test [script] :
-          tell ^^.f to write ( ^^.first )
-
-          check ^^.f for exists?
-          assert "expected the file to exist after write"
-
-          check ^^.f for is_file?
-          assert "expected exists to be a regular file"
-
-          check ^^.f for is_dir?
-          refute "expected the file not to be a directory"
-
-          tell ^^.f to read ( ^^.back )
-          eval ^^.back = 'first line'
-          assert "expected read to return what was written"
-
-          tell ^^.f to delete
-
-      append_adds_a_line [test] :
-        description [string] : append adds a new line to the file.
-        on_test [script] :
-          tell ^^.f to write ( ^^.first )
-          tell ^^.f to append ( ^^.second )
-
-          tell ^^.f to read ( ^^.back )
-          check ^^.back for substring? ( "first line" )
-          assert "expected the original line to still be there"
-          check ^^.back for substring? ( "second line" )
-          assert "expected the appended line to be there"
-
-          tell ^^.f to delete
-
-      path_parts [test] :
-        description [string] : get_name, get_ext and get_parent read the path, not the disk.
-        on_test [script] :
-          tell ^^.names to get_name
-          eval it = 'report'
-          assert "expected the base name without extension"
-
-          tell ^^.names to get_ext
-          eval it = '.csv'
-          assert "expected the extension"
-
-          tell ^^.names to get_parent
-          eval it = '/Users/me/project'
-          assert "expected the parent directory"
-
-      delete_removes_the_file [test] :
-        description [string] : delete removes the file from disk.
-        on_test [script] :
-          tell ^^.f to write ( ^^.first )
-          check ^^.f for exists?
-          assert "sanity: file exists before delete"
-
-          tell ^^.f to delete
-          check ^^.f for exists?
-          refute "expected the file to be gone after delete"
+tests.objs.file [can] :
+
+  f [file] : /tmp/gloo_file_test.txt
+  names [file] : /Users/me/project/report.csv
+
+  first [string] : first line
+  second [string] : second line
+  back [string] :
+
+  write_read_round_trip [test] :
+    description [string] : write puts an object's value in the file; read gets it back.
+    on_test [script] :
+      tell ^^.f to write ( ^^.first )
+
+      check ^^.f for exists?
+      assert "expected the file to exist after write"
+
+      check ^^.f for is_file?
+      assert "expected exists to be a regular file"
+
+      check ^^.f for is_dir?
+      refute "expected the file not to be a directory"
+
+      tell ^^.f to read ( ^^.back )
+      eval ^^.back = 'first line'
+      assert "expected read to return what was written"
+
+      tell ^^.f to delete
+
+  append_adds_a_line [test] :
+    description [string] : append adds a new line to the file.
+    on_test [script] :
+      tell ^^.f to write ( ^^.first )
+      tell ^^.f to append ( ^^.second )
+
+      tell ^^.f to read ( ^^.back )
+      check ^^.back for substring? ( "first line" )
+      assert "expected the original line to still be there"
+      check ^^.back for substring? ( "second line" )
+      assert "expected the appended line to be there"
+
+      tell ^^.f to delete
+
+  path_parts [test] :
+    description [string] : get_name, get_ext and get_parent read the path, not the disk.
+    on_test [script] :
+      tell ^^.names to get_name
+      eval it = 'report'
+      assert "expected the base name without extension"
+
+      tell ^^.names to get_ext
+      eval it = '.csv'
+      assert "expected the extension"
+
+      tell ^^.names to get_parent
+      eval it = '/Users/me/project'
+      assert "expected the parent directory"
+
+  delete_removes_the_file [test] :
+    description [string] : delete removes the file from disk.
+    on_test [script] :
+      tell ^^.f to write ( ^^.first )
+      check ^^.f for exists?
+      assert "sanity: file exists before delete"
+
+      tell ^^.f to delete
+      check ^^.f for exists?
+      refute "expected the file to be gone after delete"

data/test.gloo/objs/function.test.gloo

@@ -7,48 +7,46 @@
 # after_invoke event.
 #
 
-tests [can] :
-  objs [can] :
-    function [can] :
+tests.objs.function [can] :
 
-      after_ran [bool] : false
+  after_ran [bool] : false
 
-      greet [ƒ] :
-        params [can] :
-          name [string] : Default Person
-        on_invoke [script] :
-          put 'Hi, ' + ^.params.name into ^.result
-        after_invoke [script] :
-          put true into tests.objs.function.after_ran
-        result [string] :
+  greet [ƒ] :
+    params [can] :
+      name [string] : Default Person
+    on_invoke [script] :
+      put 'Hi, ' + ^.params.name into ^.result
+    after_invoke [script] :
+      put true into tests.objs.function.after_ran
+    result [string] :
 
-      boom [ƒ] :
-        params [can] :
-        on_invoke [script] :
-          put no_such_object into ^.result
-        after_invoke [script] :
-          put true into tests.objs.function.after_ran
-        result [string] :
+  boom [ƒ] :
+    params [can] :
+    on_invoke [script] :
+      put no_such_object into ^.result
+    after_invoke [script] :
+      put true into tests.objs.function.after_ran
+    result [string] :
 
-      invoke_message_uses_param_defaults [test] :
-        description [string] : the invoke message with no args runs on_invoke against the param defaults.
-        on_test [script] :
-          tell ^^.greet to invoke
-          eval ^^.greet.result = 'Hi, Default Person'
-          assert "expected on_invoke to run with the default param value"
+  invoke_message_uses_param_defaults [test] :
+    description [string] : the invoke message with no args runs on_invoke against the param defaults.
+    on_test [script] :
+      tell ^^.greet to invoke
+      eval ^^.greet.result = 'Hi, Default Person'
+      assert "expected on_invoke to run with the default param value"
 
-      after_invoke_runs_on_success [test] :
-        description [string] : after_invoke runs once the function has been invoked.
-        on_test [script] :
-          put false into ^^.after_ran
-          tell ^^.greet to invoke
-          eval ^^.after_ran = true
-          assert "expected after_invoke to run after a successful invoke"
+  after_invoke_runs_on_success [test] :
+    description [string] : after_invoke runs once the function has been invoked.
+    on_test [script] :
+      put false into ^^.after_ran
+      tell ^^.greet to invoke
+      eval ^^.after_ran = true
+      assert "expected after_invoke to run after a successful invoke"
 
-      after_invoke_runs_on_failure [test] :
-        description [string] : after_invoke still runs when on_invoke hits an error.
-        on_test [script] :
-          put false into ^^.after_ran
-          tell ^^.boom to invoke
-          eval ^^.after_ran = true
-          assert "expected after_invoke to run even after on_invoke failed"
+  after_invoke_runs_on_failure [test] :
+    description [string] : after_invoke still runs when on_invoke hits an error.
+    on_test [script] :
+      put false into ^^.after_ran
+      tell ^^.boom to invoke
+      eval ^^.after_ran = true
+      assert "expected after_invoke to run even after on_invoke failed"

data/test.gloo/objs/int.test.gloo

@@ -2,69 +2,67 @@
 # Integer tests
 #
 
-tests [can] :
-  objs [can] :
-    int [can] :
+tests.objs.int [can] :
 
-      a [int] : 
-      b [int] : 
+  a [int] : 
+  b [int] : 
 
-      set_value_with_msg [test] :
-        description [string] : Set the value of the integer
-        on_test [script] :
-          put 1 into ^^.b
-          eval ^^.b = 1
-          assert "expected it to be 1"
+  set_value_with_msg [test] :
+    description [string] : Set the value of the integer
+    on_test [script] :
+      put 1 into ^^.b
+      eval ^^.b = 1
+      assert "expected it to be 1"
 
-          put 2 into ^^.a
-          eval ^^.a = ^^.b
-          refute "expected them to not be equal"
+      put 2 into ^^.a
+      eval ^^.a = ^^.b
+      refute "expected them to not be equal"
 
-          put 1 into ^^.a
-          eval ^^.a = ^^.b
-          assert "expected them to be equal"
+      put 1 into ^^.a
+      eval ^^.a = ^^.b
+      assert "expected them to be equal"
 
-      inc_int [test] :
-        description [string] : Increment the integer
-        on_test [script] :
-          put 1 into ^^.a
-          tell ^^.a to inc
-          eval ^^.a = 2
-          assert "expected it to be 2"
+  inc_int [test] :
+    description [string] : Increment the integer
+    on_test [script] :
+      put 1 into ^^.a
+      tell ^^.a to inc
+      eval ^^.a = 2
+      assert "expected it to be 2"
 
-      dec_int [test] :
-        description [string] : Decrement the integer
-        on_test [script] :
-          put 1 into ^^.a
-          tell ^^.a to dec
-          eval ^^.a = 0
-          assert "expected it to be 0"
+  dec_int [test] :
+    description [string] : Decrement the integer
+    on_test [script] :
+      put 1 into ^^.a
+      tell ^^.a to dec
+      eval ^^.a = 0
+      assert "expected it to be 0"
 
-      rand_int [test] :
-        description [string] : Randomize the integer
-        on_test [script] :
-          put 1 into ^^.a
-          tell ^^.a to randomize
-          eval ^^.a >= 0
-          assert "expected it to be greater than or equal to 0"
-          eval ^^.a <= 100
-          assert "expected it to be less than or equal to 100"
+  rand_int [test] :
+    description [string] : Randomize the integer
+    on_test [script] :
+      put 1 into ^^.a
+      tell ^^.a to randomize
+      eval ^^.a >= 0
+      assert "expected it to be greater than or equal to 0"
+      eval ^^.a <= 100
+      assert "expected it to be less than or equal to 100"
           
-          tell ^^.a to randomize (10000)
-          tell ^^.b to randomize (10000)
-          eval ^^.a = ^^.b
-          refute "expected them to not be equal"
+      tell ^^.a to randomize (10000)
+      tell ^^.b to randomize (10000)
+      eval ^^.a = ^^.b
+      refute "expected them to not be equal"
 
-      format_int [test] :
-        description [string] : Format an integer
-        f [int] : 
-        on_test [script] :
-          put 1234567 into ^.f
-          tell ^.f to format
-          eval it = '1,234,567'
-          assert "expected formatted integer to match"
+  format_int [test] :
+    description [string] : Format an integer
+    f [int] : 
+    on_test [script] :
+      put 1234567 into ^.f
+      tell ^.f to format
+      eval it = '1,234,567'
+      assert "expected formatted integer to match"
 
-          put 42 into ^.f
-          tell ^.f to format ('%05d')
-          eval it = '00042'
-          assert "expected formatted integer to match"
+      put 42 into ^.f
+      tell ^.f to format ('%05d')
+      eval it = '00042'
+      assert "expected formatted integer to match"

data/test.gloo/objs/json.test.gloo

@@ -2,78 +2,76 @@
 # JSON object tests
 #
 
-tests [can] :
-  objs [can] :
-    json [can] :
+tests.objs.json [can] :
 
-      payload [json] : BEGIN
+  payload [json] : BEGIN
         { "title":"Brute Force",
           "meta":{ "author":"ESR", "year":"2003" } }
         END
 
-      compact [json] : {"a":"1","b":{"c":"2"}}
+  compact [json] : {"a":"1","b":{"c":"2"}}
 
-      source [can] :
-        name [string] : gloo
-        kind [string] : language
+  source [can] :
+    name [string] : gloo
+    kind [string] : language
 
-      built [json] :
-      out [can] :
-      found [string] :
-      assigned [json] :
+  built [json] :
+  out [can] :
+  found [string] :
+  assigned [json] :
 
-      get_a_value [test] :
-        description [string] : get pulls a value out by dotted path.
-        on_test [script] :
-          tell ^^.payload to get ( 'title' )
-          eval it = 'Brute Force'
-          assert "expected the top-level title"
+  get_a_value [test] :
+    description [string] : get pulls a value out by dotted path.
+    on_test [script] :
+      tell ^^.payload to get ( 'title' )
+      eval it = 'Brute Force'
+      assert "expected the top-level title"
 
-          tell ^^.payload to get ( 'meta.author' )
-          eval it = 'ESR'
-          assert "expected the nested author"
+      tell ^^.payload to get ( 'meta.author' )
+      eval it = 'ESR'
+      assert "expected the nested author"
 
-      get_missing_is_blank [test] :
-        description [string] : get for a path that isn't there returns blank.
-        on_test [script] :
-          tell ^^.payload to get ( 'nope' )
-          put it into tests.objs.json.found
-          check tests.objs.json.found for blank?
-          assert "expected a missing path to return blank"
+  get_missing_is_blank [test] :
+    description [string] : get for a path that isn't there returns blank.
+    on_test [script] :
+      tell ^^.payload to get ( 'nope' )
+      put it into tests.objs.json.found
+      check tests.objs.json.found for blank?
+      assert "expected a missing path to return blank"
 
-      parse_into_objects [test] :
-        description [string] : parse builds an object tree from the JSON.
-        on_test [script] :
-          tell ^^.payload to parse ( tests.objs.json.out )
+  parse_into_objects [test] :
+    description [string] : parse builds an object tree from the JSON.
+    on_test [script] :
+      tell ^^.payload to parse ( tests.objs.json.out )
 
-          eval tests.objs.json.out.title = 'Brute Force'
-          assert "expected parse to set the title"
+      eval tests.objs.json.out.title = 'Brute Force'
+      assert "expected parse to set the title"
 
-          eval tests.objs.json.out.meta.author = 'ESR'
-          assert "expected parse to build the nested meta container"
+      eval tests.objs.json.out.meta.author = 'ESR'
+      assert "expected parse to build the nested meta container"
 
-      set_from_objects_round_trip [test] :
-        description [string] : set serialises an object tree; get reads it back.
-        on_test [script] :
-          # a path inside ( ) params must be absolute, not a ^ ref
-          tell ^^.built to set ( tests.objs.json.source )
+  set_from_objects_round_trip [test] :
+    description [string] : set serialises an object tree; get reads it back.
+    on_test [script] :
+      # a path inside ( ) params must be absolute, not a ^ ref
+      tell ^^.built to set ( tests.objs.json.source )
 
-          tell ^^.built to get ( 'name' )
-          eval it = 'gloo'
-          assert "expected set then get to round-trip a value"
+      tell ^^.built to get ( 'name' )
+      eval it = 'gloo'
+      assert "expected set then get to round-trip a value"
 
-      pretty_keeps_it_valid [test] :
-        description [string] : pretty reformats the text without breaking it.
-        on_test [script] :
-          tell ^^.compact to pretty
-          tell ^^.compact to get ( 'b.c' )
-          eval it = '2'
-          assert "expected the value to still be reachable after pretty"
+  pretty_keeps_it_valid [test] :
+    description [string] : pretty reformats the text without breaking it.
+    on_test [script] :
+      tell ^^.compact to pretty
+      tell ^^.compact to get ( 'b.c' )
+      eval it = '2'
+      assert "expected the value to still be reachable after pretty"
 
-      assign_a_json_string_at_run_time [test] :
-        description [string] : a quote-containing literal can be put into an object at run time.
-        on_test [script] :
-          put '{"lang":"gloo","ok":true}' into tests.objs.json.assigned
-          tell ^^.assigned to get ( 'lang' )
-          eval it = 'gloo'
-          assert "expected the run-time JSON string to be assigned and readable"
+  assign_a_json_string_at_run_time [test] :
+    description [string] : a quote-containing literal can be put into an object at run time.
+    on_test [script] :
+      put '{"lang":"gloo","ok":true}' into tests.objs.json.assigned
+      tell ^^.assigned to get ( 'lang' )
+      eval it = 'gloo'
+      assert "expected the run-time JSON string to be assigned and readable"

data/test.gloo/objs/obj.test.gloo

@@ -2,51 +2,71 @@
 # Root object tests
 #
 
-tests [can] :
-  objs [can] :
-    obj [can] :
-
-      o [any] :
-      a [can] :
-        b [string] : "b"
-        c [string] : "c"
-        d [string] : "d"
-
-      obj_contains [test] :
-        description [string] : Check to see if an object contains children
-        on_test [script] :
-          check tests.objs.obj.o for contains?
-          refute "the object does not contain children"
-
-          check tests.objs.obj.a for contains?
-          assert "the object contains children"
-
-      blank_object [test] :
-        description [string] : Check for a blank string
-        on_test [script] :
-          check tests.objs.obj.a.b for blank?
-          refute "the string should be blank"
-
-          check tests.objs.obj.o for blank?
-          assert "the object should be blank"
-
-      responds_to_blank [test] :
-        description [string] : Verify that all objects respond to blank? msessage
-        on_test [script] :
-          check tests.objs.obj.o for responds_to? ('blank?')
-          assert "expected any object to respond to blank?"
-
-      responds_to_contains [test] :
-        description [string] : Verify that all objects respond to contains? msessage
-        on_test [script] :
-          check tests.objs.obj.o for responds_to? ('contains?')
-          assert "expected any object to respond to contains?"
-
-      responds_to_up [test] :
-        description [string] : Verify that strings respond to up msessage
-        on_test [script] :
-          check tests.objs.obj.o for responds_to? ('up')
-          refute "expected any object to not respond to up"
-
-          check tests.objs.obj.a.b for responds_to? ('up')
-          assert "expected string to respond to up"
+tests.objs.obj [can] :
+
+  o [any] :
+  a [can] :
+    b [string] : "b"
+    c [string] : "c"
+    d [string] : "d"
+
+  # A documented string, used to check the doc message.
+  documented [string] : "value"
+
+  no_doc [string] : "value"
+
+  obj_contains [test] :
+    description [string] : Check to see if an object contains children
+    on_test [script] :
+      check tests.objs.obj.o for contains?
+      refute "the object does not contain children"
+
+      check tests.objs.obj.a for contains?
+      assert "the object contains children"
+
+  blank_object [test] :
+    description [string] : Check for a blank string
+    on_test [script] :
+      check tests.objs.obj.a.b for blank?
+      refute "the string should be blank"
+
+      check tests.objs.obj.o for blank?
+      assert "the object should be blank"
+
+  responds_to_blank [test] :
+    description [string] : Verify that all objects respond to blank? msessage
+    on_test [script] :
+      check tests.objs.obj.o for responds_to? ('blank?')
+      assert "expected any object to respond to blank?"
+
+  responds_to_contains [test] :
+    description [string] : Verify that all objects respond to contains? msessage
+    on_test [script] :
+      check tests.objs.obj.o for responds_to? ('contains?')
+      assert "expected any object to respond to contains?"
+
+  responds_to_up [test] :
+    description [string] : Verify that strings respond to up msessage
+    on_test [script] :
+      check tests.objs.obj.o for responds_to? ('up')
+      refute "expected any object to not respond to up"
+
+      check tests.objs.obj.a.b for responds_to? ('up')
+      assert "expected string to respond to up"
+
+  responds_to_doc [test] :
+    description [string] : Verify that all objects respond to doc message
+    on_test [script] :
+      check tests.objs.obj.o for responds_to? ('doc')
+      assert "expected any object to respond to doc"
+
+  doc_message [test] :
+    description [string] : doc returns the object's leading comment, cleaned up.
+    on_test [script] :
+      check tests.objs.obj.documented for doc
+      eval it = "A documented string, used to check the doc message."
+      assert "expected doc to return the cleaned leading comment"
+
+      check tests.objs.obj.no_doc for doc
+      eval it = ""
+      assert "expected doc to be blank for an object with no leading comment"