Working argparse

Author: toroidal-code

CMakeLists.txt

@@ -1,9 +1,5 @@
 cmake_minimum_required(VERSION 3.27 FATAL_ERROR)
 
-if(IWYU)
-  find_program(iwyu_path NAMES include-what-you-use iwyu)
-endif(IWYU)
-
 project(c++spec)
 
 set(CMAKE_COLOR_DIAGNOSTICS ON)
@@ -14,7 +10,7 @@ include(FetchContent)
 
 FetchContent_Declare(argparse
   GIT_REPOSITORY https://github.com/p-ranav/argparse/
-  GIT_TAG v2.9
+  GIT_TAG v3.0
 )
 FetchContent_MakeAvailable(argparse)
 
@@ -43,23 +39,43 @@ target_precompile_headers(c++spec INTERFACE
   ${c++spec_headers}
 )
 
-option(BUILD_TESTS "Build tests." ON)
+# HELPERS
+
+# Add spec
+function(add_spec source_file)
+  cmake_path(GET source_file STEM spec_name)
+  add_executable(${spec_name} ${source_file})
+  target_link_libraries(${spec_name} c++spec)
+
+  set_target_properties(${spec_name} PROPERTIES
+    CXX_STANDARD 20
+    CXX_STANDARD_REQUIRED YES
+  )
+  add_test(NAME ${spec_name} COMMAND ${spec_name} --verbose)
+endfunction(add_spec)
+
+# Discover Specs
+function(discover_specs spec_folder)
+  file(GLOB_RECURSE specs ${spec_folder}/*_spec.cpp)
+
+  foreach(spec IN LISTS specs)
+    add_spec(${spec})
+  endforeach()
+endfunction(discover_specs)
+
+option(BUILD_TESTS "Build tests" ON)
 
 if(BUILD_TESTS)
-  # enable_testing()
+  enable_testing()
 
   # Tests
-  add_subdirectory(spec)
+  discover_specs(spec)
 endif(BUILD_TESTS)
 
-option(BUILD_EXAMPLES "Build examples." ON)
+option(BUILD_EXAMPLES "Build examples" ON)
 
 if(BUILD_EXAMPLES)
   add_subdirectory(examples)
-
-  if(iwyu_path)
-    set_property(TARGET cppspec_sample PROPERTY CXX_INCLUDE_WHAT_YOU_USE ${iwyu_path})
-  endif()
 endif(BUILD_EXAMPLES)
 
 # ##### Documentation generation #######

examples/sample/example_spec.cpp

@@ -192,13 +192,13 @@ 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(){
-  return CppSpec::Runner()
+int main(int argc, char **argv){
+  return CppSpec::parse(argc, argv)
              .add_spec(bool_spec)
              .add_spec(abs_spec)
              .add_spec(strcmp_spec)
              .add_spec(vector_spec)
              .add_spec(let_spec)
              .add_spec(list_spec)
-             .exec<CppSpec::Formatters::Verbose>() ? EXIT_SUCCESS : EXIT_FAILURE;
-}
+             .exec() ? EXIT_SUCCESS : EXIT_FAILURE;
+}

examples/sample/jasmine_intro.cpp

@@ -255,7 +255,7 @@ auto to_include_matcher = describe("to contain", $ {
 });
 
 int main(int argc, char** argv) {
-  return CppSpec::Runner()
+  return CppSpec::parse(argc, argv)
              .add_spec(a_suite)
              .add_spec(suite_object)
              .add_spec(to_be_compare)
@@ -266,5 +266,5 @@ int main(int argc, char** argv) {
              .add_spec(a_spec_before_each)
              .add_spec(a_spec_nesting)
              .add_spec(to_include_matcher)
-             .exec<CppSpec::Formatters::Verbose>() ? EXIT_SUCCESS : EXIT_FAILURE;
+             .exec() ? EXIT_SUCCESS : EXIT_FAILURE;
 }

include/argparse.hpp

@@ -2,6 +2,7 @@
 
 #include <argparse/argparse.hpp>
 #include <string_view>
+#include "runner.hpp"
 
 #include "formatters/progress.hpp"
 #include "formatters/tap.hpp"
@@ -22,14 +23,15 @@ constexpr std::string file_name(std::string_view path) {
 
 struct RuntimeOpts {
   bool verbose = false;
-  std::unique_ptr<Formatters::BaseFormatter> formatter = nullptr;
+  std::shared_ptr<Formatters::BaseFormatter> formatter = nullptr;
 };
 
-inline RuntimeOpts parse(int argc, char** argv) {
-  argparse::ArgumentParser program(file_name(__FILE__));
+inline Runner parse(int argc, char** argv) {
+  argparse::ArgumentParser program{file_name(argv[0])};
 
   program.add_argument("-f", "--format")
       .default_value(std::string{"p"})
+      .choices("progress", "p", "tap", "t", "detail", "d")
       .required()
       .help("set the output format");
 
@@ -48,22 +50,18 @@ inline RuntimeOpts parse(int argc, char** argv) {
 
   RuntimeOpts opts;
 
-  if (program["--verbose"] == true) {
-    opts.verbose = true;
-  }
-
   auto format_string = program.get<std::string>("--format");
-  if (format_string == "p" || format_string == "progress") {
+  if (format_string == "d" || format_string == "detail" || program["--verbose"] == true) {
+    opts.formatter = std::make_unique<Formatters::Verbose>();
+  } else if (format_string == "p" || format_string == "progress") {
     opts.formatter = std::make_unique<Formatters::Progress>();
   } else if (format_string == "t" || format_string == "tap") {
     opts.formatter = std::make_unique<Formatters::TAP>();
-  } else if (format_string == "d" || format_string == "detail") {
-    opts.formatter = std::make_unique<Formatters::Verbose>();
   } else {
     std::cerr << "Unrecognized format type" << std::endl;
     std::exit(-1);
   }
 
-  return opts;
+  return Runner{opts.formatter};
 }
 }  // namespace CppSpec

include/child.hpp

@@ -80,11 +80,11 @@ class Child {
 
   /** @brief Check to see if the Child has a parent. */
   const bool has_parent() noexcept { return parent != nullptr; }
-  const bool has_parent() const noexcept { return parent != nullptr; }
+  [[nodiscard]] const bool has_parent() const noexcept { return parent != nullptr; }
 
   // TODO: Look in to making these references instead of pointer returns
   /** @brief Get the Child's parent. */
-  Child *get_parent() const noexcept { return parent; }
+  [[nodiscard]] Child *get_parent() const noexcept { return parent; }
 
   template <class C>
   C get_parent_as() const noexcept {
@@ -103,23 +103,23 @@ class Child {
 
   /*--------- Formatter helper functions -----------*/
   // Check to see if the tree has a printer
-  const bool has_formatter() const noexcept;
+  [[nodiscard]] bool has_formatter() const noexcept;
 
   // Get the printer from the tree
-  Formatters::BaseFormatter &get_formatter() const noexcept;
+  [[nodiscard]] Formatters::BaseFormatter &get_formatter() const noexcept;
 
-  void set_formatter(const Formatters::BaseFormatter &formatter) {
-    this->formatter = &const_cast<Formatters::BaseFormatter &>(formatter);
+  void set_formatter(Formatters::BaseFormatter &formatter) {
+    this->formatter = &formatter;
   }
 
   /*--------- Primary member functions -------------*/
 
   /** @brief Get the status of the object (success/failure) */
-  const bool get_status() const noexcept { return this->status; }
+  [[nodiscard]]  bool get_status() const noexcept { return this->status; }
   void failed() noexcept;  // Report failure to the object.
 
   // Calculate the padding for printing this object
-  std::string padding() const noexcept;
+  [[nodiscard]] std::string padding() const noexcept;
 };
 
 /*>>>>>>>>>>>>>>>>>>>> Child <<<<<<<<<<<<<<<<<<<<<<<<<*/
@@ -133,7 +133,8 @@ class Child {
 inline void Child::failed() noexcept {
   this->status = false;
   // propogates the failure up the tree
-  if (this->has_parent()) this->get_parent()->failed();
+  if (this->has_parent()) { this->get_parent()->failed();
+}
 }
 
 /**
@@ -144,15 +145,19 @@ inline std::string Child::padding() const noexcept {
   return this->has_parent() ? this->get_parent()->padding() + "  " : "";
 }
 
-inline const bool Child::has_formatter() const noexcept {
-  if (this->formatter != nullptr) return true;
-  if (!this->has_parent()) return false;  // base case;
+inline bool Child::has_formatter() const noexcept {
+  if (this->formatter != nullptr) { return true;
+}
+  if (!this->has_parent()) { return false;  // base case;
+}
   return parent->has_formatter();
 }
 
 inline Formatters::BaseFormatter &Child::get_formatter() const noexcept {
-  if (this->formatter) return *formatter;
-  if (!this->has_parent()) std::terminate();
+  if (this->formatter != nullptr) { return *formatter;
+}
+  if (!this->has_parent()) { std::terminate();
+}
   return parent->get_formatter();
 }
 

include/class_description.hpp

@@ -6,7 +6,6 @@
 
 #include "description.hpp"
 
-
 namespace CppSpec {
 
 /**
@@ -25,7 +24,7 @@ class ClassDescription : public Description {
   using Block = std::function<void(ClassDescription<T> &)>;
 
   Block block;
-  std::string type = "";
+  std::string type;
 
  public:
   const bool has_subject = true;
@@ -83,7 +82,7 @@ class ClassDescription : public Description {
   /** @brief an alias for it */
   Result specify(std::function<void(ItCD<T> &)> block) { return it(block); }
 
-  template <class U=std::nullptr_t>
+  template <class U = std::nullptr_t>
   Result context(std::string description,
                  std::function<void(ClassDescription<T> &)> block);
 
@@ -100,7 +99,9 @@ class ClassDescription : public Description {
 
   Result run(Formatters::BaseFormatter &printer) override;
 
-  std::string get_subject_type() const noexcept override { return type; }
+  [[nodiscard]] std::string get_subject_type() const noexcept override {
+    return type;
+  }
 };
 
 template <class T>
@@ -244,11 +245,17 @@ Result ClassDescription<T>::it(std::function<void(ItCD<T> &)> block) {
 
 template <class T>
 Result ClassDescription<T>::run(Formatters::BaseFormatter &printer) {
-  if (not this->has_formatter()) this->set_formatter(printer);
+  if (not this->has_formatter()) {
+    this->set_formatter(printer);
+  }
   printer.format(*this);
   this->block(*this);
-  for (const auto &a : after_alls) a();
-  if (this->get_parent() == nullptr) printer.flush();
+  for (const auto &a : after_alls) {
+    a();
+  }
+  if (this->get_parent() == nullptr) {
+    printer.flush();
+  }
   return this->get_status() ? Result::success() : Result::failure();
 }
 

include/cppspec.hpp

@@ -6,8 +6,9 @@
 #define CPPSPEC_HPP
 #pragma once
 
-#include "runner.hpp"
+#include "argparse.hpp"
 
+#ifndef CPPSPEC_MACROLESS
 /*>>>>>>>>>>>>>>>>>>>> MACROS <<<<<<<<<<<<<<<<<<<<<<*/
 
 // For *some* reason, MSVC++ refuses to correctly deduce the types of
@@ -18,7 +19,9 @@
 
 #define it self.it
 #define specify it
-#ifdef _MSC_VER  // Apparently MSVC++ doesn't conform to C++14 14.2/4. Annoying.
+
+// Apparently MSVC++ doesn't conform to C++14 14.2/4. Annoying.
+#if defined(_MSC_VER) && !defined(__clang__)
 #define context self.context
 #define expect self.expect
 #else
@@ -34,8 +37,15 @@
 #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.let(body);
+#define let(name, body) auto (name) = self.let(body);
+
+#define CPPSPEC_MAIN(spec)                                                  \
+  int main(int argc, char **argv) {                                         \
+    return CppSpec::parse(argc, argv).add_spec(spec).exec() ? EXIT_SUCCESS  \
+                                                            : EXIT_FAILURE; \
+  }
 
+#endif
 /*>>>>>>>>>>>>>>>>>>> TYPEDEFS <<<<<<<<<<<<<<<<<<<<<*/
 
 using describe = CppSpec::Description;