Refactor Printer into Base and derived Formatters

Author: toroidal-code

examples/sample/example_spec.cpp

@@ -54,6 +54,7 @@ describe bool_spec("Some Tests", $ {
     });
     it("includes [1,2,3]", _ {
       expect({1,2,3}).to_include({1,2,8});
+      expect({1,2,3}).to_include({1,2,7});
     });
     it("does not include 4", _ {
       expect({1,2,3}).not_().to_include({4});
@@ -183,13 +184,13 @@ describe let_spec("let", $ {
 
 describe list_spec("A list spec", $ {
   explain <std::list<int>> ({1,2,3,4}, _ {
-    it( _ { is_expected().to_include(6); });
+    it( _ { is_expected().to_include(8); });
   });
 });
 
 /* Here is the declaration of fabs description defined in an other file (fabs_spec.c in this sample)*/
 int main(){
-  return CppSpec::Runner()
+  return CppSpec::Runner(CppSpec::Formatters::verbose)
              .add_spec(bool_spec)
              .add_spec(abs_spec)
              .add_spec(strcmp_spec)

include/child.hpp

@@ -4,7 +4,9 @@
 
 namespace CppSpec {
 
-struct BasePrinter;  // Forward declaration to allow reference
+namespace Formatters {
+class BaseFormatter;  // Forward declaration to allow reference
+}
 
 /**
  * @brief Base class for all objects in the execution tree.
@@ -21,20 +23,21 @@ class Child {
   // (`describe some_spec("a test", $ { ... });`). In order to use
   // a shared pointer, each object that is set as the parent must be
   // contained in a shared pointer. As tests are created by `describe ...`,
-  // it is not wrapped by a shared pointer. Attempting to create this shared
-  // pointer at some later time doesn't work, as it results in trying to delete
-  // the current object `this` once the pointer goes out of scope.
-  // Since children are always destroyed before their parents, this isn't a
-  // problem anyways. In addition, any structures that are children are
-  // allocated on the stack for speed reasons.
+  // the root object is not wrapped by a shared pointer. Attempting to create
+  // this shared pointer at some later time doesn't work, as it results in
+  // trying to delete the current object `this` once the pointer goes out of
+  // scope. Since children are always destroyed before their parents, this
+  // isn't a problem anyways. In addition, any structures that are children
+  // are allocated on the stack for speed reasons.
   Child *parent = nullptr;
 
   // Represents whether the Child is healthy (has not failed).
   // A Child is healthy if and only if all of its children are healthy.
   // All instances of Child start out healthy.
   bool status = true;
 
-  BasePrinter *printer = nullptr;
+  // TODO: Change this to a std::unique_ptr
+  Formatters::BaseFormatter *formatter = nullptr;
 
  public:
   // Default constructor/desctructor
@@ -57,7 +60,7 @@ class Child {
   /*--------- Parent helper functions -------------*/
 
   /** @brief Check to see if the Child has a parent. */
-  bool has_parent() { return parent != nullptr; }
+  const bool has_parent() { return parent != nullptr; }
 
   /** @brief Get the Child's parent. */
   Child *get_parent() { return parent; }
@@ -66,15 +69,17 @@ class Child {
   /** @brief Set the Child's parent */
   void set_parent(Child *parent) { this->parent = parent; }
 
-  /*--------- Printer helper functions -------------*/
-  const bool has_printer();    // Check to see if the tree has a printer
-  BasePrinter &get_printer();  // Get the printer from the tree
-  void set_printer(BasePrinter &printer) { this->printer = &printer; }
+  /*--------- Formatter helper functions -----------*/
+  const bool has_formatter();  // Check to see if the tree has a printer
+  Formatters::BaseFormatter &get_formatter();  // Get the printer from the tree
+  void set_printer(Formatters::BaseFormatter &formatter) {
+    this->formatter = &formatter;
+  }
 
   /*--------- Primary member functions -------------*/
 
   /** @brief Get the status of the object (success/failure) */
-  bool get_status() { return this->status; }
+  const bool get_status() { return this->status; }
 
   void failed();          // Report failure to the object.
   std::string padding();  // Calculate the padding for printing this object
@@ -95,23 +100,25 @@ void Child::failed() {
 }
 
 /**
- * @brief Get the padding (indentation) of the current object.
+ * @brief Generate padding (indentation) fore the current object.
  * @return A string of spaces for use in pretty-printing.
  */
 std::string Child::padding() {
   return has_parent() ? get_parent()->padding() + "  " : "";
 }
 
-const bool Child::has_printer() {
-  if (this->printer != nullptr) return true;
-  if (parent == nullptr) return false;  // base case;
-  return parent->has_printer();
+const bool Child::has_formatter() {
+  if (this->formatter != nullptr) return true;
+  if (!this->has_parent()) return false;  // base case;
+  return parent->has_formatter();
 }
 
-BasePrinter &Child::get_printer() {
-  if (this->printer != nullptr) return *printer;
-  if (parent == nullptr) throw "Couldn't get printer!";  // base case;
-  return parent->get_printer();
+Formatters::BaseFormatter &Child::get_formatter() {
+  if (this->formatter != nullptr) return *formatter;
+  if (!this->has_parent())
+    throw "Couldn't get printer!";  // base case. This should never *ever*
+                                    // happen.
+  return parent->get_formatter();
 }
 
 }  // ::CppSpec

include/class_description.hpp

@@ -79,9 +79,11 @@ class ClassDescription : public Description {
   Result context(T subject, block_t body);
   Result context(T &subject, block_t body);
   Result context(block_t body);
-  Result run(BasePrinter &printer) override;
-  virtual std::string get_descr() override;
-  virtual const std::string get_descr() const override;
+  Result run(Formatters::BaseFormatter &printer) override;
+  virtual std::string get_descr() override { return descr; }
+  virtual const std::string get_descr() const override { return descr; }
+  virtual std::string get_subject_type() override { return type; }
+  virtual const std::string get_subject_type() const override { return type; }
 };
 
 template <class T>
@@ -94,7 +96,7 @@ Result ClassDescription<T>::context(
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run(this->get_printer());
+  return context.run(this->get_formatter());
 }
 
 template <class T>
@@ -110,7 +112,7 @@ Result ClassDescription<T>::context(
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run(this->get_printer());
+  return context.run(this->get_formatter());
 }
 
 template <class T>
@@ -121,7 +123,7 @@ Result Description::context(T subject,
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run(this->get_printer());
+  return context.run(this->get_formatter());
 }
 
 // template <class T>
@@ -137,7 +139,7 @@ Result Description::context(std::initializer_list<U> init_list,
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run(this->get_printer());
+  return context.run(this->get_formatter());
 }
 
 /**
@@ -165,7 +167,7 @@ template <class T>
 Result ClassDescription<T>::it(std::string name,
                                std::function<void(ItCd<T> &)> body) {
   ItCd<T> it(*this, this->subject, name, body);
-  Result result = it.run(this->get_printer());
+  Result result = it.run(this->get_formatter());
   exec_after_eaches();
   exec_before_eaches();
   return result;
@@ -195,39 +197,21 @@ Result ClassDescription<T>::it(std::string name,
 template <class T>
 Result ClassDescription<T>::it(std::function<void(ItCd<T> &)> body) {
   ItCd<T> it(*this, this->subject, body);
-  Result result = it.run(this->get_printer());
+  Result result = it.run(this->get_formatter());
   exec_after_eaches();
   exec_before_eaches();
   return result;
 }
 
 template <class T>
-Result ClassDescription<T>::run(BasePrinter &printer) {
-  if (not this->has_printer()) this->set_printer(printer);
-  printer.print(*this);
+Result ClassDescription<T>::run(Formatters::BaseFormatter &printer) {
+  if (not this->has_formatter()) this->set_printer(printer);
+  printer.format(*this);
   body(*this);
   for (auto a : after_alls) a();
   if (this->get_parent() == nullptr) printer.flush();
   return this->get_status() ? Result::success : Result::failure;
 }
-template <class T>
-std::string ClassDescription<T>::get_descr() {
-  if (this->get_printer().mode == BasePrinter::Mode::TAP) {
-    return descr;
-  } else {
-    return descr + type;
-  }
-}
-
-template <class T>
-const std::string ClassDescription<T>::get_descr() const {
-  if (const_cast<ClassDescription<T> *>(this)->get_printer().mode ==
-      BasePrinter::Mode::TAP) {
-    return descr;
-  } else {
-    return descr + type;
-  }
-}
 
 template <class T>
 Expectations::Expectation<T> ItCd<T>::is_expected() {
@@ -237,17 +221,13 @@ Expectations::Expectation<T> ItCd<T>::is_expected() {
 }
 
 template <class T>
-Result ItCd<T>::run(BasePrinter &printer) {
-  if (!this->needs_descr() && printer.mode == BasePrinter::Mode::verbose) {
-    printer.print(*this);
-  }
+Result ItCd<T>::run(Formatters::BaseFormatter &printer) {
+//  if (!this->needs_descr() && printer.mode == BaseFormatter::Mode::verbose) {
+//    printer.format(*this);
+//  }
 
   body(*this);
-
-  if (printer.mode == BasePrinter::Mode::TAP ||
-      printer.mode == BasePrinter::Mode::terse) {
-    printer.print(*this);
-  }
+  printer.format(*this);
 
   auto cd = static_cast<ClassDescription<T> *>(this->get_parent());
   cd->reset_lets();

include/cppspec.hpp

@@ -4,6 +4,9 @@
  */
 #ifndef CPPSPEC_HPP
 #define CPPSPEC_HPP
+#include "formatters/tap.hpp"
+#include "formatters/verbose.hpp"
+#include "formatters/progress.hpp"
 #include "runner.hpp"
 
 #define _ [=](auto &self) mutable

include/description.hpp

@@ -71,11 +71,13 @@ class Description : public Runnable {
   template <typename T>
   auto make_let(std::string name, T body) -> Let<decltype(body())>;
   void add_let(std::string name, Runnable &body);
-  virtual Result run(BasePrinter &printer) override;
+  virtual Result run(Formatters::BaseFormatter &printer) override;
   void reset_lets();
   Runnable *find_let(std::string);
   virtual std::string get_descr() { return descr; }
   virtual const std::string get_descr() const { return descr; }
+  virtual std::string get_subject_type() { return ""; }
+  virtual const std::string get_subject_type() const { return ""; }
 };
 
 typedef Description Context;
@@ -85,20 +87,20 @@ Result Description::context(std::string name,
   Context context(*this, name, body);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run(this->get_printer());
+  return context.run(this->get_formatter());
 }
 
 Result Description::it(std::string name, std::function<void(ItD &)> body) {
   ItD it(*this, name, body);
-  Result result = it.run(this->get_printer());
+  Result result = it.run(this->get_formatter());
   exec_after_eaches();
   exec_before_eaches();
   return result;
 }
 
 Result Description::it(std::function<void(ItD &)> body) {
   ItD it(*this, body);
-  Result result = it.run(this->get_printer());
+  Result result = it.run(this->get_formatter());
   exec_after_eaches();
   exec_before_eaches();
   return result;
@@ -162,9 +164,9 @@ void Description::add_let(std::string name, Runnable &body) {
   lets.insert({name, &body});
 }
 
-Result Description::run(BasePrinter &printer) {
-  if (not this->has_printer()) this->set_printer(printer);
-  printer.print(*this);
+Result Description::run(Formatters::BaseFormatter &printer) {
+  if (not this->has_formatter()) this->set_printer(printer);
+  printer.format(*this);
   body(*this);
   for (auto a : after_alls) a();
   if (this->get_parent() == nullptr) printer.flush();
@@ -207,17 +209,14 @@ Expectations::Expectation<T> ItExpBase::expect(Let<T> let) {
   return expectation;
 }
 
-Result ItD::run(BasePrinter &printer) {
-  if (!this->needs_descr() && printer.mode == BasePrinter::Mode::verbose) {
-    printer.print(*this);
-  }
+Result ItD::run(Formatters::BaseFormatter &printer) {
+//  if (!this->needs_descr() && printer.mode == BaseFormatter::Mode::verbose) {
+//    printer.format(*this);
+//  }
 
   body(*this);
 
-  if (printer.mode == BasePrinter::Mode::TAP ||
-      printer.mode == BasePrinter::Mode::terse) {
-    printer.print(*this);
-  }
+  printer.format(*this);
 
   auto parent = static_cast<Description *>(this->get_parent());
   parent->reset_lets();