Super fancy printer formats

Author: toroidal-code

examples/sample/example_spec.cpp

@@ -13,7 +13,6 @@ describe bool_spec("Some Tests", $ {
     it("true", _ {
       expect(true).to_equal(true);
     });
-
   });
 
   int i = 4;
@@ -192,18 +191,12 @@ describe list_spec("A list spec", $ {
 /* Here is the declaration of fabs description defined in an other file (fabs_spec.c in this sample)*/
 int main(){
   bool r = true;
-  r &= bool_spec.run();
-  r &= abs_spec.run();
-  r &= strcmp_spec.run();
-  r &= vector_spec.run();
-  r &= let_spec.run();
-// #undef expect
-// #undef it
-//  Description d("halp", _ {});
-//  It i =  d.it("me", _ {});
-//  auto expectation =  i.expect(2);
-//  auto be_between = expectation.to_be_between(1,3);
-//  be_between();
-  //strcmp_spec.run();
+  PrettyPrinter printer = Printer::verbose;
+  r &= bool_spec.run(printer);
+  r &= abs_spec.run(printer);
+  r &= strcmp_spec.run(printer);
+  r &= vector_spec.run(printer);
+  r &= let_spec.run(printer);
+  r &= list_spec.run(printer);
   return r ? EXIT_SUCCESS : EXIT_FAILURE;
 }

include/class_description.hpp

@@ -18,40 +18,49 @@ class ClassDescription : public Description {
   typedef std::function<void(ClassDescription<T>&)> block_t;
   block_t body;
   bool first;
+  std::string type = "";
 
  public:
   T subject;  // subject field public for usage in `expect([self.]subject)`
 
   // Constructor
   // if there's no explicit subject given, then use
   // the default constructor of the given type as the implicit subject.
-  ClassDescription<T>(block_t body) : Description(), body(body), subject(T()) {
-    this->descr = Pretty::to_word_type(subject);
+  ClassDescription<T>(block_t body)
+      : Description(),
+        body(body),
+        type(" : " + Util::demangle(typeid(T).name())),
+        subject(T()) {
+    this->descr = Pretty::to_word(subject);
   };
 
   ClassDescription<T>(std::string descr, block_t body)
       : Description(descr), body(body), subject(T()){};
 
   ClassDescription(T subject, block_t body)
-      : Description(Pretty::to_word_type(subject)),
+      : Description(Pretty::to_word(subject)),
         body(body),
+        type(" : " + Util::demangle(typeid(T).name())),
         subject(subject){};
 
   ClassDescription(std::string descr, T subject, block_t body)
       : Description(descr), body(body), subject(subject){};
 
   ClassDescription(T& subject, block_t body)
-      : Description(Pretty::to_word_type(subject)),
+      : Description(Pretty::to_word(subject)),
         body(body),
+        type(" : " + Util::demangle(typeid(T).name())),
         subject(subject){};
 
   ClassDescription(std::string descr, T& subject, block_t body)
       : Description(descr), body(body), subject(subject){};
 
   template <typename U>
   ClassDescription(std::initializer_list<U> init_list, block_t body)
-      : body(body), subject(T(init_list)) {
-    this->descr = Pretty::to_word_type(subject);
+      : body(body),
+        type(" : " + Util::demangle(typeid(T).name())),
+        subject(T(init_list)) {
+    this->descr = Pretty::to_word(subject);
   };
 
   template <typename U>
@@ -68,7 +77,9 @@ 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() override;
+  Result run(BasePrinter& printer) override;
+  virtual std::string get_descr() override;
+  virtual const std::string get_descr() const override;
 };
 
 template <class T>
@@ -81,7 +92,7 @@ Result ClassDescription<T>::context(
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run();
+  return context.run(this->get_printer());
 }
 
 template <class T>
@@ -97,7 +108,7 @@ Result ClassDescription<T>::context(
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
   context.after_eaches = this->after_eaches;
-  return context.run();
+  return context.run(this->get_printer());
 }
 
 template <class T>
@@ -108,7 +119,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();
+  return context.run(this->get_printer());
 }
 
 // template <class T>
@@ -124,7 +135,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();
+  return context.run(this->get_printer());
 }
 
 /**
@@ -152,7 +163,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();
+  Result result = it.run(this->get_printer());
   exec_after_eaches();
   exec_before_eaches();
   return result;
@@ -182,19 +193,39 @@ 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();
+  Result result = it.run(this->get_printer());
   exec_after_eaches();
   exec_before_eaches();
   return result;
 }
 
 template <class T>
-Result ClassDescription<T>::run() {
-  std::cout << padding() << descr << std::endl;
+Result ClassDescription<T>::run(BasePrinter& printer) {
+  if (not this->has_printer()) this->set_printer(printer);
+  printer.print(*this);
   body(*this);
-  std::cout << std::endl;
+  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() {
@@ -204,11 +235,18 @@ Expectations::Expectation<T> ItCd<T>::is_expected() {
 }
 
 template <class T>
-Result ItCd<T>::run() {
-  if (!this->needs_descr()) {
-    std::cout << padding() << get_descr() << std::endl;
+Result ItCd<T>::run(BasePrinter& printer) {
+  if (!this->needs_descr() && printer.mode == BasePrinter::Mode::verbose) {
+    printer.print(*this);
   }
+
   body(*this);
+
+  if (printer.mode == BasePrinter::Mode::TAP ||
+      printer.mode == BasePrinter::Mode::terse) {
+    printer.print(*this);
+  }
+
   auto cd = static_cast<ClassDescription<T>*>(this->get_parent());
   cd->reset_lets();
   return this->get_status() ? Result::success : Result::failure;

include/cppspec.hpp

@@ -2,7 +2,7 @@
  * @file
  * @brief The core header file for Cppspec
  */
-#include "class_description.hpp"
+#include "printer.hpp"
 
 #define _ [=](auto &self) mutable
 #define $ [](auto &self)
@@ -18,7 +18,7 @@
 #define after_all self.after_all
 #define after_each self.after_each
 #define let(name, body)              \
-  auto name = make_let(#name, body); \
+  auto name = self.make_let(#name, body); \
   self.let(#name, name);
 
 typedef Description describe;

include/description.hpp

@@ -66,10 +66,14 @@ class Description : public Runnable {
   void exec_before_eaches();
   void exec_after_eaches();
 
-  void let(std::string, Runnable &body);
-  Result run() override;
+  template <typename T>
+  auto make_let(std::string name, T body) -> Let<decltype(body())>;
+  void let(std::string name, Runnable &body);
+  virtual Result run(BasePrinter &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; }
 };
 
 typedef Description Context;
@@ -79,20 +83,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();
+  return context.run(this->get_printer());
 }
 
 Result Description::it(std::string name, std::function<void(ItD &)> body) {
   ItD it(*this, name, body);
-  Result result = it.run();
+  Result result = it.run(this->get_printer());
   exec_after_eaches();
   exec_before_eaches();
   return result;
 }
 
 Result Description::it(std::function<void(ItD &)> body) {
   ItD it(*this, body);
-  Result result = it.run();
+  Result result = it.run(this->get_printer());
   exec_after_eaches();
   exec_before_eaches();
   return result;
@@ -140,15 +144,21 @@ void Description::exec_after_eaches() {
   for (rule_block_t b : after_eaches) b();
 }
 
+template <typename T>
+auto Description::make_let(std::string name, T body) -> Let<decltype(body())> {
+  return Let<decltype(body())>(*this, name, body);
+}
+
 void Description::let(std::string name, Runnable &body) {
   lets.insert({name, &body});
 }
 
-Result Description::run() {
-  std::cout << padding() << descr << std::endl;
+Result Description::run(BasePrinter &printer) {
+  if (not this->has_printer()) this->set_printer(printer);
+  printer.print(*this);
   body(*this);
   for (auto a : after_alls) a();
-  std::cout << std::endl;
+  if (this->get_parent() == nullptr) printer.flush();
   return this->get_status() ? Result::success : Result::failure;
 }
 
@@ -188,12 +198,18 @@ Expectations::Expectation<T> ItExpBase::expect(Let<T> let) {
   return expectation;
 }
 
-Result ItD::run() {
-  if (!this->needs_descr()) {
-    std::cout << padding() << get_descr() << std::endl;
+Result ItD::run(BasePrinter &printer) {
+  if (!this->needs_descr() && printer.mode == BasePrinter::Mode::verbose) {
+    printer.print(*this);
   }
+
   body(*this);
 
+  if (printer.mode == BasePrinter::Mode::TAP ||
+      printer.mode == BasePrinter::Mode::terse) {
+    printer.print(*this);
+  }
+
   auto parent = static_cast<Description *>(this->get_parent());
   parent->reset_lets();