mp-units/test/unit_test/runtime/text_test.cpp

// The MIT License (MIT)
//
// Copyright (c) 2018 Mateusz Pusz
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#include "units/dimensions/area.h"
#include "units/dimensions/frequency.h"
#include "units/dimensions/power.h"
#include "units/dimensions/velocity.h"
#include "units/dimensions/volume.h"
#include "units/format.h"
#include "units/math.h"
#include <catch2/catch.hpp>
#include <sstream>

using namespace units;
using namespace Catch::Matchers;

TEST_CASE("operator<< on a quantity", "[text][ostream][fmt]")
{
  std::stringstream stream;

  SECTION("quantity with a predefined unit")
  {
    SECTION("integral representation")
    {
      const auto q = 60W;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "60 W");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("floating-point representation")
    {
      const auto q = 1023.5Pa;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "1023.5 Pa");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }
  }

  SECTION("quantity with a predefined unit + prefix")
  {
    SECTION("in terms of base units")
    {
      const auto q = 125us;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "125 µs");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("in terms of derived units")
    {
      const auto q = 60kJ;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "60 kJ");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }
  }

  SECTION("quantity with a deduced unit")
  {
    SECTION("coherent derived unit")
    {
      SECTION("acceleration")
      {
        const auto q = 20.m / 2s / 1s;
        stream << q;

        SECTION("iostream")
        {
          REQUIRE(stream.str() == "10 m/s²");
        }

        SECTION("fmt with default format {} on a quantity")
        {
          REQUIRE(fmt::format("{}", q) == stream.str());
        }

        SECTION("fmt with format {:%Q %q} on a quantity")
        {
          REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
        }
      }

      SECTION("volume")
      {
        const auto q = 2m * 1m * 1m;
        stream << q;

        SECTION("iostream")
        {
          REQUIRE(stream.str() == "2 m³");
        }

        SECTION("fmt with default format {} on a quantity")
        {
          REQUIRE(fmt::format("{}", q) == stream.str());
        }

        SECTION("fmt with format {:%Q %q} on a quantity")
        {
          REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
        }
      }
    }

    SECTION("deduced derived unit")
    {
      SECTION("velocity")
      {
        const auto q = 20.km / 2h;
        stream << q;

        SECTION("iostream")
        {
          REQUIRE(stream.str() == "10 km/h");
        }

        SECTION("fmt with default format {} on a quantity")
        {
          REQUIRE(fmt::format("{}", q) == stream.str());
        }

        SECTION("fmt with format {:%Q %q} on a quantity")
        {
          REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
        }
      }

      SECTION("surface tension")
      {
        const auto q = 20.N / 2m;
        stream << q;

        SECTION("iostream")
        {
          REQUIRE(stream.str() == "10 N/m");
        }

        SECTION("fmt with default format {} on a quantity")
        {
          REQUIRE(fmt::format("{}", q) == stream.str());
        }

        SECTION("fmt with format {:%Q %q} on a quantity")
        {
          REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
        }
      }
    }
  }

  SECTION("quantity with a predefined dimension but unknown unit")
  {
    SECTION("unit::ratio as an SI prefix for a dimension with a special symbol")
    {
      const auto q = 4.N * 2cm;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "8 cJ");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio for a dimension without a special symbol")
    {
      const auto q = 2.cm * 2m * 2m;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "8 [1/100]m³");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio::num != 1 && unit::ratio::den == 1")
    {
      const auto q = 4 * 2min / (2s * 2s);
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "2 [60]Hz");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio::num == 1 && unit::ratio::den != 1")
    {
      const auto q = 20._J / 2min;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "10 [1/60]W");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio::num != 1 && unit::ratio::den != 1")
    {
      const auto q = 60.kJ / 2min;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "30 [50/3]W");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }
  }

  SECTION("quantity with an unkown dimension")
  {
    SECTION("unit::ratio::num == 1 && unit::ratio::den == 1")
    {
      const auto q = 2s * 2m * 2kg;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "8 m⋅kg⋅s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio as an SI prefix")
    {
      const auto q = 4km * 2s;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "8 [1000]m⋅s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio::num != 1 && unit::ratio::den == 1")
    {
      const auto q = 4kg * 2min / (2s * 2s);
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "2 [60]kg/s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio::num == 1 && unit::ratio::den != 1")
    {
      const auto q = 20.kg / 2min;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "10 [1/60]kg/s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("unit::ratio::num != 1 && unit::ratio::den != 1")
    {
      const auto q = 60.min / 2km;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "30 [3/50]1/m⋅s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("exp::num == 1 && exp::den == 1")
    {
      const auto q = 4m * 2s;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "8 m⋅s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("exp::num == 2 && exp::den == 1 for positive exponent")
    {
      const auto q = 4m * 2s * 2s;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "16 m⋅s²");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("exp::num == 2 && exp::den == 1 for negative exponent (first dimension)")
    {
      const auto q = 8.s / 2m / 2m;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "2 1/m²⋅s");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("exp::num == 2 && exp::den == 1 for negative exponent (not first dimension)")
    {
      const auto q = 8.m / 2kg / 2kg;
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "2 m/kg²");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("fractional positive exponent")
    {
      const auto q = sqrt(9.m);
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "3 m^(1/2)");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }

    SECTION("fractional negative exponent")
    {
      const auto q = sqrt(9 / 1.m);
      stream << q;

      SECTION("iostream")
      {
        REQUIRE(stream.str() == "3 1/m^(1/2)");
      }

      SECTION("fmt with default format {} on a quantity")
      {
        REQUIRE(fmt::format("{}", q) == stream.str());
      }

      SECTION("fmt with format {:%Q %q} on a quantity")
      {
        REQUIRE(fmt::format("{:%Q %q}", q) == stream.str());
      }
    }
  }
}

TEST_CASE("format string with only %Q should print quantity value only", "[text][fmt]")
{
  SECTION("integral representation")
  {
    REQUIRE(fmt::format("{:%Q}", 123kmph) == "123");
  }

  SECTION("floating-point representation")
  {
    SECTION("no precision specification")
    {
      REQUIRE(fmt::format("{:%Q}", 221.km / 2h) == "110.5");
    }
  }
}

TEST_CASE("format string with only %q should print quantity unit symbol only", "[text][fmt]")
{
  REQUIRE(fmt::format("{:%q}", 123kmph) == "km/h");
}

TEST_CASE("%q an %Q can be put anywhere in a format string", "[text][fmt]")
{
  SECTION("no space")
  {
    REQUIRE(fmt::format("{:%Q%q}", 123kmph) == "123km/h");
  }

  SECTION("separator")
  {
    REQUIRE(fmt::format("{:%Q###%q}", 123kmph) == "123###km/h");
  }

  SECTION("opposite order")
  {
    REQUIRE(fmt::format("{:%q %Q}", 123kmph) == "km/h 123");
  }
}

TEST_CASE("precision specification", "[text][fmt]")
{
  SECTION("default format {} on a quantity") 
  {
    SECTION("0")
    {
      REQUIRE(fmt::format("{:.0}", 1.2345m) == "1 m");
    }

    SECTION("1")
    {
      REQUIRE(fmt::format("{:.1}", 1.2345m) == "1.2 m");
    }

    SECTION("2")
    {
      REQUIRE(fmt::format("{:.2}", 1.2345m) == "1.23 m");
    }

    SECTION("3")
    {
      REQUIRE(fmt::format("{:.3}", 1.2345m) == "1.235 m");
    }

    SECTION("4")
    {
      REQUIRE(fmt::format("{:.4}", 1.2345m) == "1.2345 m");
    }

    SECTION("5")
    {
      REQUIRE(fmt::format("{:.5}", 1.2345m) == "1.23450 m");
    }

    SECTION("10")
    {
      REQUIRE(fmt::format("{:.10}", 1.2345m) == "1.2345000000 m");
    }
  }

  SECTION("full format {:%Q %q} on a quantity") 
  {
    SECTION("0")
    {
      REQUIRE(fmt::format("{:.0%Q %q}", 1.2345m) == "1 m");
    }

    SECTION("1")
    {
      REQUIRE(fmt::format("{:.1%Q %q}", 1.2345m) == "1.2 m");
    }

    SECTION("2")
    {
      REQUIRE(fmt::format("{:.2%Q %q}", 1.2345m) == "1.23 m");
    }

    SECTION("3")
    {
      REQUIRE(fmt::format("{:.3%Q %q}", 1.2345m) == "1.235 m");
    }

    SECTION("4")
    {
      REQUIRE(fmt::format("{:.4%Q %q}", 1.2345m) == "1.2345 m");
    }

    SECTION("5")
    {
      REQUIRE(fmt::format("{:.5%Q %q}", 1.2345m) == "1.23450 m");
    }

    SECTION("10")
    {
      REQUIRE(fmt::format("{:.10%Q %q}", 1.2345m) == "1.2345000000 m");
    }
  }

  SECTION("value only format {:%Q} on a quantity") 
  {
    SECTION("0")
    {
      REQUIRE(fmt::format("{:.0%Q}", 1.2345m) == "1");
    }

    SECTION("1")
    {
      REQUIRE(fmt::format("{:.1%Q}", 1.2345m) == "1.2");
    }

    SECTION("2")
    {
      REQUIRE(fmt::format("{:.2%Q}", 1.2345m) == "1.23");
    }

    SECTION("3")
    {
      REQUIRE(fmt::format("{:.3%Q}", 1.2345m) == "1.235");
    }

    SECTION("4")
    {
      REQUIRE(fmt::format("{:.4%Q}", 1.2345m) == "1.2345");
    }

    SECTION("5")
    {
      REQUIRE(fmt::format("{:.5%Q}", 1.2345m) == "1.23450");
    }

    SECTION("10")
    {
      REQUIRE(fmt::format("{:.10%Q}", 1.2345m) == "1.2345000000");
    }
  }
}

TEST_CASE("precision specification for integral representation should throw", "[text][fmt][exception]")
{
  SECTION("default format {} on a quantity") 
  {
    REQUIRE_THROWS_MATCHES(fmt::format("{:.1}", 1m), fmt::format_error, Message("precision not allowed for integral quantity representation"));
  }

  SECTION("full format {:%Q %q} on a quantity") 
  {
    REQUIRE_THROWS_MATCHES(fmt::format("{:.1%Q %q}", 1m), fmt::format_error, Message("precision not allowed for integral quantity representation"));
  }

  SECTION("value only format {:%Q} on a quantity") 
  {
    REQUIRE_THROWS_MATCHES(fmt::format("{:.1%Q}", 1m), fmt::format_error, Message("precision not allowed for integral quantity representation"));
  }
}

// Restate operator<< definitions in terms of std::format to make I/O manipulators apply to whole objects
// rather than their parts


// Giving a precision specification
// in the chrono-format-spec is valid only for std::chrono::duration types where the representation type Rep
// is a floating-point type. For all other Rep types, a format_error shall be thrown if the chrono-format-spec
// contains a precision specification.

 // string s = format("{:=>8}", 42ms); // value of s is "====42ms"