Separate runnable.hpp and general header cleanup

Author: toroidal-code

examples/sample/example_spec.cpp

@@ -3,7 +3,6 @@
 #include <list>
 #include "cppspec.hpp"
 
-
 describe bool_spec("Some Tests", $ {
   context("true is", _ {
     it("true", _ {
@@ -30,7 +29,7 @@ describe bool_spec("Some Tests", $ {
   });
 
   explain("0 is", _ {
-    using namespace Matchers;
+    using namespace CppSpec::Matchers;
     it("between -1 and 1 (exclusive)", _ {
       expect(0).to_be_between(-1, 1, RangeMode::exclusive);
     });
@@ -191,7 +190,7 @@ 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;
-  PrettyPrinter printer = Printer::verbose;
+  auto printer = CppSpec::Printer::verbose;
   r &= bool_spec.run(printer);
   r &= abs_spec.run(printer);
   r &= strcmp_spec.run(printer);

include/child.hpp

@@ -0,0 +1,118 @@
+#ifndef CPPSPEC_CHILD_HPP
+#define CPPSPEC_CHILD_HPP
+#include <string>
+
+namespace CppSpec {
+
+struct BasePrinter;
+
+/**
+ * @brief Base class for all objects in the execution tree.
+ *
+ * A base class for all objects that comprise some abstract structure
+ * with a nesting concept. Used to propogate ('pass') failures from leaf
+ * to root without exceptions (and/or code-jumping), thus allowing
+ * execution to continue virtually uninterrupted.
+ */
+class Child {
+  // The parent of this child
+  // We use a raw pointer here instead of the safer std::shared_ptr
+  // due to the way that tests are inherently constructed
+  // (`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.
+  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;
+
+ public:
+  // Default constructor/desctructor
+  Child() = default;
+  virtual ~Child() = default;
+
+  // Move constructor/operator
+  Child(Child &&) = default;
+  Child &operator=(Child &&) = default;
+
+  // Copy constructor/operator
+  Child(const Child &) = default;
+  Child &operator=(const Child &) = default;
+
+  // Custom constructors
+  Child(Child &parent) : parent(&parent){};
+  Child(Child *parent) : parent(parent){};
+  Child(const Child *parent) : parent(const_cast<Child *>(parent)){};
+
+  /*--------- Parent helper functions -------------*/
+
+  /** @brief Check to see if the Child has a parent. */
+  bool has_parent() { return parent != nullptr; }
+
+  /** @brief Get the Child's parent. */
+  Child *get_parent() { return parent; }
+  const Child *get_parent() const { return const_cast<Child *>(parent); }
+
+  /** @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; }
+
+  /*--------- Primary member functions -------------*/
+
+  /** @brief Get the status of the object (success/failure) */
+  bool get_status() { return this->status; }
+
+  void failed();          // Report failure to the object.
+  std::string padding();  // Calculate the padding for printing this object
+};
+
+/*>>>>>>>>>>>>>>>>>>>> Child IMPLEMENTATION <<<<<<<<<<<<<<<<<<<<<<<<<*/
+
+/**
+ * @brief Report failure to the object.
+ *
+ * This is propogated up the parent/child tree, so that when a child object
+ * fails, the parent object is immediately updated to reflect that as well.
+ */
+void Child::failed() {
+  this->status = false;
+  // propogates the failure up the tree
+  if (has_parent()) this->get_parent()->failed();
+}
+
+/**
+ * @brief Get the padding (indentation) of 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();
+}
+
+BasePrinter &Child::get_printer() {
+  if (this->printer != nullptr) return *printer;
+  if (parent == nullptr) throw "Couldn't get printer!";  // base case;
+  return parent->get_printer();
+}
+
+}  // ::CppSpec
+#endif  // CPPSPEC_CHILD_HPP

include/class_description.hpp

@@ -1,7 +1,9 @@
-#ifndef CLASS_DESCRIPTION_H
-#define CLASS_DESCRIPTION_H
+#ifndef CPPSPEC_CLASS_DESCRIPTION_HPP
+#define CPPSPEC_CLASS_DESCRIPTION_HPP
 #include "description.hpp"
 
+namespace CppSpec {
+
 /**
  * @brief A Description with a defined subject
  *
@@ -15,7 +17,7 @@
  */
 template <class T>
 class ClassDescription : public Description {
-  typedef std::function<void(ClassDescription<T>&)> block_t;
+  typedef std::function<void(ClassDescription<T> &)> block_t;
   block_t body;
   bool first;
   std::string type = "";
@@ -46,13 +48,13 @@ class ClassDescription : public Description {
   ClassDescription(std::string descr, T subject, block_t body)
       : Description(descr), body(body), subject(subject){};
 
-  ClassDescription(T& subject, block_t body)
+  ClassDescription(T &subject, block_t body)
       : Description(Pretty::to_word(subject)),
         body(body),
         type(" : " + Util::demangle(typeid(T).name())),
         subject(subject){};
 
-  ClassDescription(std::string descr, T& subject, block_t body)
+  ClassDescription(std::string descr, T &subject, block_t body)
       : Description(descr), body(body), subject(subject){};
 
   template <typename U>
@@ -68,16 +70,16 @@ class ClassDescription : public Description {
                    block_t body)
       : Description(descr), body(body), subject(T(init_list)){};
 
-  ClassDescription<T>(Description& d) : Description(d){};
+  ClassDescription<T>(Description &d) : Description(d){};
 
   const bool has_subject = true;
 
-  Result it(std::string descr, std::function<void(ItCd<T>&)> body);
-  Result it(std::function<void(ItCd<T>&)> body);
+  Result it(std::string descr, std::function<void(ItCd<T> &)> body);
+  Result it(std::function<void(ItCd<T> &)> body);
   Result context(T subject, block_t body);
-  Result context(T& subject, block_t body);
+  Result context(T &subject, block_t body);
   Result context(block_t body);
-  Result run(BasePrinter& printer) override;
+  Result run(BasePrinter &printer) override;
   virtual std::string get_descr() override;
   virtual const std::string get_descr() const override;
 };
@@ -87,7 +89,7 @@ using ClassContext = ClassDescription<T>;
 
 template <class T>
 Result ClassDescription<T>::context(
-    T subject, std::function<void(ClassDescription&)> body) {
+    T subject, std::function<void(ClassDescription &)> body) {
   ClassContext<T> context(subject, body);
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
@@ -97,13 +99,13 @@ Result ClassDescription<T>::context(
 
 template <class T>
 Result ClassDescription<T>::context(
-    T& subject, std::function<void(ClassDescription&)> body) {
+    T &subject, std::function<void(ClassDescription &)> body) {
   return context(subject, body);
 }
 
 template <class T>
 Result ClassDescription<T>::context(
-    std::function<void(ClassDescription&)> body) {
+    std::function<void(ClassDescription &)> body) {
   ClassContext<T> context(body);
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
@@ -113,7 +115,7 @@ Result ClassDescription<T>::context(
 
 template <class T>
 Result Description::context(T subject,
-                            std::function<void(ClassDescription<T>&)> body) {
+                            std::function<void(ClassDescription<T> &)> body) {
   ClassContext<T> context(body);
   context.subject = subject;
   context.set_parent(this);
@@ -130,7 +132,7 @@ Result Description::context(T subject,
 
 template <class T, typename U>
 Result Description::context(std::initializer_list<U> init_list,
-                            std::function<void(ClassDescription<T>&)> body) {
+                            std::function<void(ClassDescription<T> &)> body) {
   ClassContext<T> context(T(init_list), body);
   context.set_parent(this);
   context.before_eaches = this->before_eaches;
@@ -161,7 +163,7 @@ Result Description::context(std::initializer_list<U> init_list,
  */
 template <class T>
 Result ClassDescription<T>::it(std::string name,
-                               std::function<void(ItCd<T>&)> body) {
+                               std::function<void(ItCd<T> &)> body) {
   ItCd<T> it(*this, this->subject, name, body);
   Result result = it.run(this->get_printer());
   exec_after_eaches();
@@ -191,7 +193,7 @@ Result ClassDescription<T>::it(std::string name,
  * @return the result of the test
  */
 template <class T>
-Result ClassDescription<T>::it(std::function<void(ItCd<T>&)> body) {
+Result ClassDescription<T>::it(std::function<void(ItCd<T> &)> body) {
   ItCd<T> it(*this, this->subject, body);
   Result result = it.run(this->get_printer());
   exec_after_eaches();
@@ -200,7 +202,7 @@ Result ClassDescription<T>::it(std::function<void(ItCd<T>&)> body) {
 }
 
 template <class T>
-Result ClassDescription<T>::run(BasePrinter& printer) {
+Result ClassDescription<T>::run(BasePrinter &printer) {
   if (not this->has_printer()) this->set_printer(printer);
   printer.print(*this);
   body(*this);
@@ -219,7 +221,7 @@ std::string ClassDescription<T>::get_descr() {
 
 template <class T>
 const std::string ClassDescription<T>::get_descr() const {
-  if (const_cast<ClassDescription<T>*>(this)->get_printer().mode ==
+  if (const_cast<ClassDescription<T> *>(this)->get_printer().mode ==
       BasePrinter::Mode::TAP) {
     return descr;
   } else {
@@ -229,13 +231,13 @@ const std::string ClassDescription<T>::get_descr() const {
 
 template <class T>
 Expectations::Expectation<T> ItCd<T>::is_expected() {
-  auto cd = static_cast<ClassDescription<T>*>(this->get_parent());
+  auto cd = static_cast<ClassDescription<T> *>(this->get_parent());
   Expectations::Expectation<T> expectation(*this, cd->subject);
   return expectation;
 }
 
 template <class T>
-Result ItCd<T>::run(BasePrinter& printer) {
+Result ItCd<T>::run(BasePrinter &printer) {
   if (!this->needs_descr() && printer.mode == BasePrinter::Mode::verbose) {
     printer.print(*this);
   }
@@ -247,9 +249,10 @@ Result ItCd<T>::run(BasePrinter& printer) {
     printer.print(*this);
   }
 
-  auto cd = static_cast<ClassDescription<T>*>(this->get_parent());
+  auto cd = static_cast<ClassDescription<T> *>(this->get_parent());
   cd->reset_lets();
   return this->get_status() ? Result::success : Result::failure;
 }
 
-#endif /* CLASS_DESCRIPTION_H */
+} // ::CppSpec
+#endif // CPPSPEC_CLASS_DESCRIPTION_HPP

include/cppspec.hpp

@@ -2,6 +2,7 @@
  * @file
  * @brief The core header file for Cppspec
  */
+
 #include "printer.hpp"
 
 #define _ [=](auto &self) mutable
@@ -21,7 +22,7 @@
   auto name = self.make_let(#name, body); \
   self.let(#name, name);
 
-typedef Description describe;
+typedef CppSpec::Description describe;
 
 template <class T>
-using describe_a = ClassDescription<T>;
+using describe_a = CppSpec::ClassDescription<T>;

include/description.hpp

@@ -2,12 +2,14 @@
  * @file
  * @brief Defines the Description class and associated functions
  */
-#ifndef DESCRIPTION_H
-#define DESCRIPTION_H
+#ifndef CPPSPEC_DESCRIPTION_HPP
+#define CPPSPEC_DESCRIPTION_HPP
 #include <queue>
 #include <unordered_map>
 #include "it.hpp"
 
+namespace CppSpec {
+
 template <class T>
 class ClassDescription;
 
@@ -144,6 +146,13 @@ void Description::exec_after_eaches() {
   for (rule_block_t b : after_eaches) b();
 }
 
+/**
+ * @brief Object generator for Let.
+ *
+ * @param body the body of the let statement
+ *
+ * @return a new Let object
+ */
 template <typename T>
 auto Description::make_let(std::string name, T body) -> Let<decltype(body())> {
   return Let<decltype(body())>(*this, name, body);
@@ -216,4 +225,5 @@ Result ItD::run(BasePrinter &printer) {
   return this->get_status() ? Result::success : Result::failure;
 }
 
-#endif /* DESCRIPTION_H */
+} // ::CppSpec
+#endif // CPPSPEC_DESCRIPTION_HPP