Renamed ut_reporter to ut_reporter_base.

jgebal · jgebal · commit 18cea37f8ab5 · 2017-01-08T00:08:59.000Z
Changed ut_reporter to be an abstract (not instantiable) type, so it now only serves as a base class (skeleton) for concrete reporters.
diff --git a/client_source/sqlplus/ut_run.sql b/client_source/sqlplus/ut_run.sql
@@ -121,7 +121,7 @@ begin
   p(  'set linesize 4000');
   p(  'spool ut_run.dbms_output.log');
   p(  'declare');
-  p(  '  v_reporter       ut_reporter;');
+  p(  '  v_reporter       ut_reporter_base;');
   p(  '  v_reporters_list ut_reporters := ut_reporters();');
   p(  'begin');
   for i in 1 .. cardinality(l_run_params.call_params) loop
diff --git a/source/core/types/ut_event_listener.tpb b/source/core/types/ut_event_listener.tpb
@@ -22,7 +22,7 @@ create or replace type body ut_event_listener is
   begin
     l_call_stmt :=
       'declare' ||
-      '  v_reporter ut_reporter := :a_reporter; ' ||
+      '  v_reporter ut_reporter_base := :a_reporter; ' ||
       'begin' ||
       '  v_reporter.'||l_method||'( treat( :a_item as '||a_item.self_type||')); ' ||
       '  :a_reporter := v_reporter; ' ||
diff --git a/source/core/types/ut_reporter_base.tpb b/source/core/types/ut_reporter_base.tpb
@@ -1,116 +1,116 @@
-create or replace type body ut_reporter is
+create or replace type body ut_reporter_base is
 
-  constructor function ut_reporter(self in out nocopy ut_reporter, a_output ut_output default ut_output_dbms_output()) return self as result is
+  constructor function ut_reporter_base(self in out nocopy ut_reporter_base, a_output ut_output default ut_output_dbms_output()) return self as result is
   begin
     self.output := a_output;
     self.name := 'Null reporter';
     return;
   end;
 
-  member procedure print_text(self in out nocopy ut_reporter, a_text varchar2) is
+  member procedure print_text(self in out nocopy ut_reporter_base, a_text varchar2) is
   begin
     self.output.send_line(a_text);
   end;
 
-  member procedure print_clob(self in out nocopy ut_reporter, a_text clob) is
+  member procedure print_clob(self in out nocopy ut_reporter_base, a_text clob) is
   begin
     self.output.send_clob(a_text);
   end;
 
   -- run hooks
-  member procedure before_calling_run(self in out nocopy ut_reporter, a_run in ut_run) is
+  member procedure before_calling_run(self in out nocopy ut_reporter_base, a_run in ut_run) is
   begin
     self.output.open();
   end;
 
   -- suite hooks
-  member procedure before_calling_suite(self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure before_calling_suite(self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
 
-  member procedure before_calling_before_all(self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure before_calling_before_all(self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
-  member procedure after_calling_before_all (self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure after_calling_before_all (self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
 
-  member procedure before_calling_before_each(self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure before_calling_before_each(self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
-  member procedure after_calling_before_each (self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure after_calling_before_each (self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
 
   -- test hooks
-  member procedure before_calling_test(self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure before_calling_test(self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
 
-  member procedure before_calling_before_test(self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure before_calling_before_test(self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
-  member procedure after_calling_before_test (self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure after_calling_before_test (self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
 
-  member procedure before_calling_test_execute(self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure before_calling_test_execute(self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
-  member procedure after_calling_test_execute (self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure after_calling_test_execute (self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
 
-  member procedure before_calling_after_test(self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure before_calling_after_test(self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
-  member procedure after_calling_after_test (self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure after_calling_after_test (self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
 
-  member procedure after_calling_test(self in out nocopy ut_reporter, a_test in ut_test) is
+  member procedure after_calling_test(self in out nocopy ut_reporter_base, a_test in ut_test) is
   begin
     null;
   end;
 
   --suite hooks continued
-  member procedure before_calling_after_each(self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure before_calling_after_each(self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
-  member procedure after_calling_after_each (self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure after_calling_after_each (self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
 
-  member procedure before_calling_after_all(self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure before_calling_after_all(self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
-  member procedure after_calling_after_all (self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure after_calling_after_all (self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
 
-  member procedure after_calling_suite(self in out nocopy ut_reporter, a_suite in ut_suite) is
+  member procedure after_calling_suite(self in out nocopy ut_reporter_base, a_suite in ut_suite) is
   begin
     null;
   end;
 
   -- run hooks continued
-  member procedure after_calling_run (self in out nocopy ut_reporter, a_run in ut_run) is
+  member procedure after_calling_run (self in out nocopy ut_reporter_base, a_run in ut_run) is
   begin
     self.output.close();
   end;
diff --git a/source/core/types/ut_reporter_base.tps b/source/core/types/ut_reporter_base.tps
@@ -1,50 +1,50 @@
-create or replace type ut_reporter force as object
+create or replace type ut_reporter_base force as object
 (
   name   varchar2(250 char),
   output ut_output,
-  constructor function ut_reporter(self in out nocopy ut_reporter, a_output ut_output default ut_output_dbms_output()) return self as result,
+  constructor function ut_reporter_base(self in out nocopy ut_reporter_base, a_output ut_output default ut_output_dbms_output()) return self as result,
 
-  member procedure print_text(self in out nocopy ut_reporter, a_text varchar2),
-  member procedure print_clob(self in out nocopy ut_reporter, a_text clob),
+  member procedure print_text(self in out nocopy ut_reporter_base, a_text varchar2),
+  member procedure print_clob(self in out nocopy ut_reporter_base, a_text clob),
 
   -- run hooks
-  member procedure before_calling_run(self in out nocopy ut_reporter, a_run in ut_run),
-  
+  member procedure before_calling_run(self in out nocopy ut_reporter_base, a_run in ut_run),
+
   -- suite hooks
-  member procedure before_calling_suite(self in out nocopy ut_reporter, a_suite in ut_suite),
-  
-  member procedure before_calling_before_all(self in out nocopy ut_reporter, a_suite in ut_suite),
-  member procedure after_calling_before_all (self in out nocopy ut_reporter, a_suite in ut_suite),
-  
-  member procedure before_calling_before_each(self in out nocopy ut_reporter, a_suite in ut_suite),
-  member procedure after_calling_before_each (self in out nocopy ut_reporter, a_suite in ut_suite),
-  
+  member procedure before_calling_suite(self in out nocopy ut_reporter_base, a_suite in ut_suite),
+
+  member procedure before_calling_before_all(self in out nocopy ut_reporter_base, a_suite in ut_suite),
+  member procedure after_calling_before_all (self in out nocopy ut_reporter_base, a_suite in ut_suite),
+
+  member procedure before_calling_before_each(self in out nocopy ut_reporter_base, a_suite in ut_suite),
+  member procedure after_calling_before_each (self in out nocopy ut_reporter_base, a_suite in ut_suite),
+
   -- test hooks
-  member procedure before_calling_test(self in out nocopy ut_reporter, a_test in ut_test),
-  
-  member procedure before_calling_before_test(self in out nocopy ut_reporter, a_test in ut_test),
-  member procedure after_calling_before_test (self in out nocopy ut_reporter, a_test in ut_test),
-  
-  member procedure before_calling_test_execute(self in out nocopy ut_reporter, a_test in ut_test),
-  member procedure after_calling_test_execute (self in out nocopy ut_reporter, a_test in ut_test),
-  
-  member procedure before_calling_after_test(self in out nocopy ut_reporter, a_test in ut_test),
-  member procedure after_calling_after_test (self in out nocopy ut_reporter, a_test in ut_test),
-  
-  member procedure after_calling_test(self in out nocopy ut_reporter, a_test in ut_test),
-  
+  member procedure before_calling_test(self in out nocopy ut_reporter_base, a_test in ut_test),
+
+  member procedure before_calling_before_test(self in out nocopy ut_reporter_base, a_test in ut_test),
+  member procedure after_calling_before_test (self in out nocopy ut_reporter_base, a_test in ut_test),
+
+  member procedure before_calling_test_execute(self in out nocopy ut_reporter_base, a_test in ut_test),
+  member procedure after_calling_test_execute (self in out nocopy ut_reporter_base, a_test in ut_test),
+
+  member procedure before_calling_after_test(self in out nocopy ut_reporter_base, a_test in ut_test),
+  member procedure after_calling_after_test (self in out nocopy ut_reporter_base, a_test in ut_test),
+
+  member procedure after_calling_test(self in out nocopy ut_reporter_base, a_test in ut_test),
+
   --suite hooks continued
-  member procedure before_calling_after_each(self in out nocopy ut_reporter, a_suite in ut_suite),
-  member procedure after_calling_after_each (self in out nocopy ut_reporter, a_suite in ut_suite),
-  
-  member procedure before_calling_after_all(self in out nocopy ut_reporter, a_suite in ut_suite),
-  member procedure after_calling_after_all (self in out nocopy ut_reporter, a_suite in ut_suite),
-  
-  member procedure after_calling_suite(self in out nocopy ut_reporter, a_suite in ut_suite),
-  
+  member procedure before_calling_after_each(self in out nocopy ut_reporter_base, a_suite in ut_suite),
+  member procedure after_calling_after_each (self in out nocopy ut_reporter_base, a_suite in ut_suite),
+
+  member procedure before_calling_after_all(self in out nocopy ut_reporter_base, a_suite in ut_suite),
+  member procedure after_calling_after_all (self in out nocopy ut_reporter_base, a_suite in ut_suite),
+
+  member procedure after_calling_suite(self in out nocopy ut_reporter_base, a_suite in ut_suite),
+
   -- run hooks continued
-  member procedure after_calling_run (self in out nocopy ut_reporter, a_run in ut_run)
+  member procedure after_calling_run (self in out nocopy ut_reporter_base, a_run in ut_run)
 
 )
-not final
+not final not instantiable
 /
diff --git a/source/core/types/ut_reporters.tps b/source/core/types/ut_reporters.tps
@@ -1,2 +1,2 @@
-create or replace type ut_reporters as table of ut_reporter;
+create or replace type ut_reporters as table of ut_reporter_base;
 /
diff --git a/source/core/ut_runner.pkb b/source/core/ut_runner.pkb
@@ -16,13 +16,13 @@ create or replace package body ut_runner is
     l_items_to_run.do_execute(l_listener);
   end;
 
-  procedure run(a_paths ut_varchar2_list, a_reporter ut_reporter := ut_documentation_reporter()) is
+  procedure run(a_paths ut_varchar2_list, a_reporter ut_reporter_base := ut_documentation_reporter()) is
   begin
     run(a_paths, ut_reporters(coalesce(a_reporter,ut_documentation_reporter())));
   end;
 
 
-  procedure run(a_path in varchar2, a_reporter ut_reporter := ut_documentation_reporter()) is
+  procedure run(a_path in varchar2, a_reporter ut_reporter_base := ut_documentation_reporter()) is
   begin
     run(ut_varchar2_list(coalesce(a_path, sys_context('userenv', 'current_schema'))), a_reporter);
   end run;
diff --git a/source/core/ut_runner.pks b/source/core/ut_runner.pks
@@ -28,12 +28,12 @@ create or replace package ut_runner authid definer is
   *                       parent setup/teardown procedures
   */
 
-  procedure run(a_path varchar2 := null, a_reporter ut_reporter := ut_documentation_reporter());
+  procedure run(a_path varchar2 := null, a_reporter ut_reporter_base := ut_documentation_reporter());
 
   procedure run(a_path varchar2, a_reporters ut_reporters);
 
   -- TODO - implementation to be changed
-  procedure run(a_paths ut_varchar2_list, a_reporter ut_reporter := ut_documentation_reporter());
+  procedure run(a_paths ut_varchar2_list, a_reporter ut_reporter_base := ut_documentation_reporter());
 
   -- TODO - implementation to be changed
   procedure run(a_paths ut_varchar2_list, a_reporters ut_reporters);
diff --git a/source/install.sql b/source/install.sql
@@ -35,7 +35,7 @@ whenever oserror exit failure rollback
 @@core/types/ut_test.tps
 @@core/types/ut_suite.tps
 @@core/types/ut_run.tps
-@@core/types/ut_reporter.tps
+@@core/types/ut_reporter_base.tps
 @@core/types/ut_reporters.tps
 @@core/types/ut_event_listener.tps
 --annoations
@@ -62,7 +62,7 @@ whenever oserror exit failure rollback
 @@core/types/ut_output_stream.tpb
 @@core/ut_output_pipe_helper.pkb
 @@core/types/ut_output_dbms_pipe.tpb
-@@core/types/ut_reporter.tpb
+@@core/types/ut_reporter_base.tpb
 @@core/types/ut_executable.tpb
 
 --expecations and matchers
diff --git a/source/reporters/ut_documentation_reporter.tpb b/source/reporters/ut_documentation_reporter.tpb
@@ -19,7 +19,7 @@ create or replace type body ut_documentation_reporter is
   overriding member procedure print_text(self in out nocopy ut_documentation_reporter, a_text varchar2) is
   begin
     if a_text is not null then
-      (self as ut_reporter).print_text(tab || a_text);
+      (self as ut_reporter_base).print_text(tab || a_text);
     end if;
   end;
 
@@ -122,7 +122,7 @@ create or replace type body ut_documentation_reporter is
       end
     );
     self.print_text(' ');
-    (self as ut_reporter).after_calling_run(a_run);
+    (self as ut_reporter_base).after_calling_run(a_run);
   end;
 
 end;
diff --git a/source/reporters/ut_documentation_reporter.tps b/source/reporters/ut_documentation_reporter.tps
@@ -1,4 +1,4 @@
-create or replace type ut_documentation_reporter force under ut_reporter
+create or replace type ut_documentation_reporter force under ut_reporter_base
 (
   lvl                integer,
   test_count         integer,
diff --git a/source/reporters/ut_teamcity_reporter.tps b/source/reporters/ut_teamcity_reporter.tps
@@ -1,4 +1,4 @@
-create or replace type ut_teamcity_reporter under ut_reporter
+create or replace type ut_teamcity_reporter under ut_reporter_base
 (
   constructor function ut_teamcity_reporter(a_output ut_output default ut_output_dbms_output()) return self as result,
 
diff --git a/source/uninstall.sql b/source/uninstall.sql
@@ -108,7 +108,7 @@ drop type ut_event_listener;
 
 drop type ut_reporters;
 
-drop type ut_reporter force;
+drop type ut_reporter_base force;
 
 drop type ut_run;
 

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-create or replace type ut_reporters as table of ut_reporter;`
	`1`	`+create or replace type ut_reporters as table of ut_reporter_base;`
`2`	`2`	`/`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-create or replace type ut_documentation_reporter force under ut_reporter`
	`1`	`+create or replace type ut_documentation_reporter force under ut_reporter_base`
`2`	`2`	`(`
`3`	`3`	`lvl integer,`
`4`	`4`	`test_count integer,`