Refactor ItExpBase and Let

Author: toroidal-code

include/child.hpp

@@ -1,6 +1,8 @@
+/** @file */
 #ifndef CPPSPEC_CHILD_HPP
 #define CPPSPEC_CHILD_HPP
-#include <string>
+#include <iostream>
+#include <typeinfo>
 
 namespace CppSpec {
 
@@ -62,9 +64,12 @@ class Child {
   /** @brief Check to see if the Child has a parent. */
   const bool has_parent() { return parent != nullptr; }
 
+  // TODO: Look in to making these references instead of pointer returns
   /** @brief Get the Child's parent. */
   Child *get_parent() { return parent; }
   const Child *get_parent() const { return const_cast<Child *>(parent); }
+  template <class C>
+  C get_parent_as();
 
   /** @brief Set the Child's parent */
   void set_parent(Child *parent) { this->parent = parent; }
@@ -107,6 +112,19 @@ std::string Child::padding() {
   return has_parent() ? get_parent()->padding() + "  " : "";
 }
 
+template <class C>
+inline C Child::get_parent_as() {
+  // rejected branch should get optimized out at compile-time
+  if (CPPSPEC_DEBUG) {
+    if (C casted = dynamic_cast<C>(get_parent())) {
+      return casted;
+    } else
+      throw(std::bad_cast());
+  } else {
+    return static_cast<C>(get_parent());
+  }
+}
+
 const bool Child::has_formatter() {
   if (this->formatter != nullptr) return true;
   if (!this->has_parent()) return false;  // base case;
@@ -115,9 +133,11 @@ const bool Child::has_formatter() {
 
 Formatters::BaseFormatter &Child::get_formatter() {
   if (this->formatter != nullptr) return *formatter;
-  if (!this->has_parent())
+  if (!this->has_parent()) {
+    std::cout << "Couldn't get printer!" << std::endl;
     throw "Couldn't get printer!";  // base case. This should never *ever*
-                                    // happen.
+    // happen.
+  }
   return parent->get_formatter();
 }
 

include/class_description.hpp

@@ -1,3 +1,4 @@
+/** @file */
 #ifndef CPPSPEC_CLASS_DESCRIPTION_HPP
 #define CPPSPEC_CLASS_DESCRIPTION_HPP
 #include "description.hpp"

include/cppspec.hpp

@@ -4,11 +4,14 @@
  */
 #ifndef CPPSPEC_HPP
 #define CPPSPEC_HPP
-#include "formatters/tap.hpp"
-#include "formatters/verbose.hpp"
-#include "formatters/progress.hpp"
+
+#ifndef CPPSPEC_DEBUG
+#define CPPSPEC_DEBUG false
+#endif
 #include "runner.hpp"
 
+/*>>>>>>>>>>>>>>>>>>>> MACROS <<<<<<<<<<<<<<<<<<<<<<*/
+
 #define _ [=](auto &self) mutable
 #define $ [](auto &self)
 #define it self.it
@@ -22,13 +25,16 @@
 #define before_each self.before_each
 #define after_all self.after_all
 #define after_each self.after_each
-#define let(name, body)                   \
-  auto name = self.make_let(#name, body); \
-  self.add_let(#name, name);
+#define let(name, body) auto name = self.let(body);
+
+/*>>>>>>>>>>>>>>>>>>> TYPEDEFS <<<<<<<<<<<<<<<<<<<<<*/
 
 typedef CppSpec::Description describe;
 
 template <class T>
 using describe_a = CppSpec::ClassDescription<T>;
 
+template <class T>
+using describe_an = CppSpec::ClassDescription<T>;
+
 #endif  // CPPSPEC_HPP

include/description.hpp

@@ -5,7 +5,6 @@
 #ifndef CPPSPEC_DESCRIPTION_HPP
 #define CPPSPEC_DESCRIPTION_HPP
 #include <queue>
-#include <unordered_map>
 #include "it.hpp"
 
 namespace CppSpec {
@@ -23,7 +22,7 @@ class Description : public Runnable {
   std::deque<rule_block_t> after_alls;
   std::deque<rule_block_t> before_eaches;
   std::deque<rule_block_t> after_eaches;
-  std::unordered_map<std::string, Runnable *> lets;
+  std::unordered_set<LetBase *> lets;
 
   Description(){};
   Description(std::string descr) : descr(descr){};
@@ -69,11 +68,11 @@ class Description : public Runnable {
   void exec_after_eaches();
 
   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(Formatters::BaseFormatter &printer) override;
+  auto let(T body) -> Let<decltype(body())>;
   void reset_lets();
-  Runnable *find_let(std::string);
+
+  virtual Result run(Formatters::BaseFormatter &printer) override;
+
   virtual std::string get_descr() { return descr; }
   virtual const std::string get_descr() const { return descr; }
   virtual std::string get_subject_type() { return ""; }
@@ -156,12 +155,10 @@ void Description::exec_after_eaches() {
  * @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);
-}
-
-void Description::add_let(std::string name, Runnable &body) {
-  lets.insert({name, &body});
+auto Description::let(T body) -> Let<decltype(body())> {
+  Let<decltype(body())> let(body);
+  lets.insert(&let);
+  return let;
 }
 
 Result Description::run(Formatters::BaseFormatter &printer) {
@@ -174,55 +171,16 @@ Result Description::run(Formatters::BaseFormatter &printer) {
 }
 
 void Description::reset_lets() {
-  for (auto &pair : lets) {
-    auto base = static_cast<LetBase *>(pair.second);  // downcast.
-    base->reset();
-  }
-
-  if (has_parent()) {
-    auto parent = static_cast<Description *>(get_parent());
-    parent->reset_lets();
-  }
-}
-
-Runnable *Description::find_let(std::string name) {
-  auto got = lets.find(name);
-
-  if (got == lets.end()) {
-    if (this->has_parent()) {
-      auto parent = static_cast<Description *>(get_parent());
-      return parent->find_let(name);
-    } else {  // this should never, *ever* happen.
-      throw(std::out_of_range("Could not find let '" + name + "'"));
-    }
-  } else {
-    return got->second;
-  }
-}
-
-template <class T>
-Expectations::Expectation<T> ItExpBase::expect(Let<T> let) {
-  auto parent = static_cast<Description *>(this->get_parent());
-  Let<T> *actual_let = static_cast<Let<T> *>(parent->find_let(let.get_name()));
-  T res = actual_let->get_result();
-  Expectations::Expectation<T> expectation(*this, res);
-  return expectation;
+  for (auto &let : lets) let->reset();
+  if (this->has_parent()) this->get_parent_as<Description *>()->reset_lets();
 }
 
 Result ItD::run(Formatters::BaseFormatter &printer) {
-//  if (!this->needs_descr() && printer.mode == BaseFormatter::Mode::verbose) {
-//    printer.format(*this);
-//  }
-
   body(*this);
-
   printer.format(*this);
-
-  auto parent = static_cast<Description *>(this->get_parent());
-  parent->reset_lets();
-
+  this->get_parent_as<Description *>()->reset_lets();
   return this->get_status() ? Result::success : Result::failure;
 }
 
-} // ::CppSpec
-#endif // CPPSPEC_DESCRIPTION_HPP
+}  // ::CppSpec
+#endif  // CPPSPEC_DESCRIPTION_HPP

include/expectations/expectation.hpp

@@ -4,7 +4,6 @@
  */
 #ifndef CPPSPEC_EXPECTATIONS_EXPECTATION_HPP
 #define CPPSPEC_EXPECTATIONS_EXPECTATION_HPP
-#include "let.hpp"
 #include "matchers/be.hpp"
 #include "matchers/be_between.hpp"
 #include "matchers/be_within.hpp"

include/expectations/handler.hpp

@@ -1,6 +1,7 @@
+/** @file */
 #ifndef CPPSPEC_EXPECTATIONS_HANDLER_HPP
 #define CPPSPEC_EXPECTATIONS_HANDLER_HPP
-#include "formatters/formatters_base.hpp"
+#include "result.hpp"
 
 namespace CppSpec {
 namespace Expectations {

include/formatters/formatters_base.hpp

@@ -1,3 +1,4 @@
+/** @file */
 #ifndef CPPSPEC_FORMATTERS_FORMATTERS_BASE
 #define CPPSPEC_FORMATTERS_FORMATTERS_BASE
 #include <iostream>

include/formatters/progress.hpp

@@ -1,11 +1,8 @@
+/** @file */
 #ifndef CPPSPEC_FORMATTERS_PROGRESS_HPP
 #define CPPSPEC_FORMATTERS_PROGRESS_HPP
-#include <list>
-#include <memory>
 #include <forward_list>
-#include "util.hpp"
-#include "formatters_base.hpp"
-#include "it_base.hpp"
+#include "verbose.hpp"
 
 namespace CppSpec {
 namespace Formatters {

include/formatters/tap.hpp

@@ -1,9 +1,9 @@
+/** @file */
 #ifndef CPPSPEC_FORMATTERS_TAP_HPP
 #define CPPSPEC_FORMATTERS_TAP_HPP
-#include <sstream>
 #include <list>
 #include "formatters_base.hpp"
-#include "description.hpp"
+#include "class_description.hpp"
 
 namespace CppSpec {
 namespace Formatters {

include/formatters/term_colors.hpp

@@ -1,3 +1,4 @@
+/** @file */
 #ifndef CPPSPEC_TERM_COLORS_HPP
 #define CPPSPEC_TERM_COLORS_HPP
 // the following are Unix/BASH ONLY terminal color codes.