Added JSON query encoding/decoding and modular changes (#65)

* Added prototype for converting between URL components and JSON

* Added implementation and tests for converting a query string to a JSON data structure and back

* Added optional value to query_iterator

* Added error object for JSON query objects

* Moved some more deckchairs around

Author: glynos

.appveyor.yml

@@ -30,7 +30,6 @@ before_build:
   -A x64
   -Dskyr_WARNINGS_AS_ERRORS=OFF
   -Dskyr_BUILD_TESTS=ON
-  -Dskyr_BUILD_WPT_TESTS=ON
   -Dskyr_BUILD_DOCS=OFF
   -Dskyr_BUILD_EXAMPLES=OFF
   -DCMAKE_TOOLCHAIN_FILE=C:\Tools\vcpkg\scripts\buildsystems\vcpkg.cmake

.clang-tidy

@@ -1,4 +1,4 @@
-Checks: '-*,bugprone-*,-bugprone-exception-escape,clang-diagnostic-*,cppcoreguidelines-*,-cppcoreguidelines-avoid-magic-numbers,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-macro-usage,-cppcoreguidelines-non-private-member-variables-in-classes,-cppcoreguidelines-avoid-c-arrays,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,modernize-*,-modernize-use-trailing-return-type,performance-*'
+Checks: '-*,bugprone-*,-bugprone-exception-escape,clang-diagnostic-*,cppcoreguidelines-*,-cppcoreguidelines-avoid-magic-numbers,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-macro-usage,-cppcoreguidelines-non-private-member-variables-in-classes,-cppcoreguidelines-avoid-c-arrays,misc-*,-misc-unused-parameters,-misc-non-private-member-variables-in-classes,modernize-*,performance-*'
 CheckOptions:
   - key:             readability-identifier-naming.ClassCase
     value:           lower_case

CMakeLists.txt

@@ -29,6 +29,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 find_package(tl-expected CONFIG REQUIRED)
+find_package(nlohmann_json CONFIG REQUIRED)
 
 if (${CMAKE_CXX_COMPILER_ID} MATCHES GNU OR
     ${CMAKE_CXX_COMPILER_ID} MATCHES Clang)

examples/example_04.cpp

@@ -4,8 +4,8 @@
 // http://www.boost.org/LICENSE_1_0.txt)
 
 #include <iostream>
-#include <skyr/core/url_parse.hpp>
-#include <skyr/core/url_serialize.hpp>
+#include <skyr/core/parse.hpp>
+#include <skyr/core/serialize.hpp>
 
 int main(int argc, char *argv[]) {
   auto base = skyr::parse("https://example.org/");

src/core/url_error.cpp include/skyr/core/errors.hppsrc/core/url_error.cpp renamed to include/skyr/core/errors.hpp

@@ -3,12 +3,45 @@
 // (See accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
 
-#include <string>
-#include "skyr/core/url_error.hpp"
+#ifndef SKYR_CORE_URL_ERROR_INC
+#define SKYR_CORE_URL_ERROR_INC
+
+#include <system_error>
 
 namespace skyr {
 inline namespace v1 {
-namespace {
+/// \enum url_parse_errc
+/// Enumerates URL parser errors
+enum class url_parse_errc {
+  /// The string contains an invalid Unicode character
+  invalid_unicode_character = 1,
+  /// A character is not a valid scheme character
+  invalid_scheme_character,
+  /// The URL is not an absolute URL with fragment
+  not_an_absolute_url_with_fragment,
+  /// Cannot set scheme value
+  cannot_override_scheme,
+  /// The ostname is empty
+  empty_hostname,
+  /// Invalid IPv4 address
+  invalid_ipv4_address,
+  /// Invalid IPv6 address
+  invalid_ipv6_address,
+  /// A character is a forbidden host point
+  forbidden_host_point,
+  /// Unable to decode host point
+  cannot_decode_host_point,
+  /// Invalid domain string
+  domain_error,
+  /// The URL cannot be a base URL
+  cannot_be_a_base_url,
+  /// The URL cannot have a username, password or port
+  cannot_have_a_username_password_or_port,
+  /// Invalid port value
+  invalid_port,
+};
+
+namespace details {
 class url_parse_error_category : public std::error_category {
  public:
   [[nodiscard]] auto name() const noexcept -> const char * override {
@@ -32,12 +65,21 @@ class url_parse_error_category : public std::error_category {
     }
   }
 };
+}  // namespace details
 
-const url_parse_error_category category{};
-}  // namespace
-
-auto make_error_code(url_parse_errc error) noexcept -> std::error_code {
+/// Creates a `std::error_code` given a `skyr::url_parse_errc` value
+/// \param error A URL parse error
+/// \returns A `std::error_code` object
+inline auto make_error_code(url_parse_errc error) noexcept -> std::error_code {
+  static const details::url_parse_error_category category{};
   return std::error_code(static_cast<int>(error), category);
 }
 }  // namespace v1
 }  // namespace skyr
+
+namespace std {
+template <>
+struct is_error_code_enum<skyr::v1::url_parse_errc> : true_type {};
+}  // namespace std
+
+#endif // SKYR_CORE_URL_ERROR_INC

include/skyr/core/url_parse.hpp include/skyr/core/parse.hppinclude/skyr/core/url_parse.hpp renamed to include/skyr/core/parse.hpp

@@ -20,7 +20,7 @@ inline namespace v1 {
 /// \returns A `url_record` on success and an error code on failure
 auto parse(
     std::string_view input,
-    std::optional<url_record> base = std::nullopt) -> tl::expected<url_record, std::error_code>;
+    std::optional<url_record> base=std::nullopt) -> tl::expected<url_record, std::error_code>;
 }  // namespace v1
 }  // namespace skyr
 

include/skyr/core/url_schemes.hpp include/skyr/core/schemes.hppinclude/skyr/core/url_schemes.hpp renamed to include/skyr/core/schemes.hpp

@@ -18,7 +18,7 @@ inline namespace v1 {
 ///        serialization, if set
 /// \returns A serialized URL string
 auto serialize(
-    const url_record &url, bool exclude_fragment = false) -> url_record::string_type;
+    const url_record &url, bool exclude_fragment=false) -> url_record::string_type;
 }  // namespace v1
 }  // namespace skyr
 

include/skyr/core/url_serialize.hpp include/skyr/core/serialize.hppinclude/skyr/core/url_serialize.hpp renamed to include/skyr/core/serialize.hpp

@@ -10,7 +10,7 @@
 #include <string>
 #include <cstdint>
 #include <optional>
-#include <skyr/core/url_schemes.hpp>
+#include <skyr/core/schemes.hpp>
 
 namespace skyr {
 inline namespace v1 {