it_base.hpp

Go to the documentation of this file.

#pragma once
 
#include <algorithm>
#include <functional>
#include <numeric>
#include <source_location>
#include <string>
#include <utility>
 
#include "let.hpp"
#include "runnable.hpp"
#include "util.hpp"
 
namespace CppSpec {
 
template <typename T>
class ExpectationValue;
template <Util::is_functional T>
class ExpectationFunc;

class ItBase : public Runnable {
  std::string description;
  std::list<Result> results;  // The results of the `it` statement
 
 public:
  ItBase() = delete;  // Don't allow a default constructor

  explicit ItBase(std::source_location location) noexcept : Runnable(location) {}

  explicit ItBase(std::source_location location, const char* description) noexcept
      : Runnable(location), description(description) {}

  bool needs_description() noexcept { return description.empty(); }

  [[nodiscard]] std::string get_description() const noexcept { return description; }

  ItBase& set_description(std::string_view description) noexcept {
    this->description = description;
    return *this;
  }

  template <Util::is_not_functional T>
  ExpectationValue<T> expect(T value, std::source_location location = std::source_location::current());

  template <Util::is_functional T>
  ExpectationFunc<T> expect(T block, std::source_location location = std::source_location::current());

  template <typename T>
  ExpectationValue<std::initializer_list<T>> expect(std::initializer_list<T> init_list,
                                                    std::source_location location = std::source_location::current());

  template <typename T>
  ExpectationValue<T> expect(Let<T>& let, std::source_location location = std::source_location::current());

  ExpectationValue<std::string> expect(const char* string,
                                       std::source_location location = std::source_location::current());
 
  void add_result(const Result& result) { results.push_back(result); }
  std::list<Result>& get_results() noexcept { return results; }
  [[nodiscard]] const std::list<Result>& get_results() const noexcept { return results; }
  void clear_results() noexcept { results.clear(); }
 
  [[nodiscard]] Result get_result() const override {
    auto default_result = Result::success(this->get_location());
    if (results.empty()) {
      return default_result;
    }
 
    return std::accumulate(results.begin(), results.end(), default_result, &Result::reduce);
  }
};
 
}  // namespace CppSpec