Publish the assert_prints spec helper (crystal-lang#13599)

Co-authored-by: Johannes Müller <straightshoota@gmail.com>
Blacksmoke16 · Dec 11, 2023 · 31a4456 · 31a4456
1 parent 2b0543b
commit 31a4456
Show file tree

Hide file tree

Showing 26 changed files with 123 additions and 111 deletions.
diff --git a/spec/manual/string_normalize_spec.cr b/spec/manual/string_normalize_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "http/client"
-require "../support/string"
+require "spec/helpers/string"
 
 UCD_ROOT = "http://www.unicode.org/Public/#{Unicode::VERSION}/ucd/"
 
@@ -27,31 +27,9 @@ private struct CodepointsEqualExpectation
   end
 end
 
-# same as `assert_prints`, but uses `CodepointsEqualExpectation` instead of `eq`
 private macro assert_prints_codepoints(call, str, desc, *, file = __FILE__, line = __LINE__)
   %expectation = CodepointsEqualExpectation.new(({{ str }}).as(String), {{ desc }})
-
-  %result = {{ call }}
-  %result.should be_a(String), file: {{ file }}, line: {{ line }}
-  %result.should %expectation, file: {{ file }}, line: {{ line }}
-
-  String.build do |io|
-    {% if call.receiver %}{{ call.receiver }}.{% end %}{{ call.name }}(
-      io,
-      {% for arg in call.args %} {{ arg }}, {% end %}
-      {% if call.named_args %} {% for narg in call.named_args %} {{ narg.name }}: {{ narg.value }}, {% end %} {% end %}
-    ) {{ call.block }}
-  end.should %expectation, file: {{ file }}, line: {{ line }}
-
-  {% unless flag?(:without_iconv) %}
-    string_build_via_utf16 do |io|
-      {% if call.receiver %}{{ call.receiver }}.{% end %}{{ call.name }}(
-        io,
-        {% for arg in call.args %} {{ arg }}, {% end %}
-        {% if call.named_args %} {% for narg in call.named_args %} {{ narg.name }}: {{ narg.value }}, {% end %} {% end %}
-      ) {{ call.block }}
-    end.should %expectation, file: {{ file }}, line: {{ line }}
-  {% end %}
+  assert_prints({{ call }}, should: %expectation, file: {{ file }}, line: {{ line }})
 end
 
 private def assert_normalized(source, target, form : Unicode::NormalizationForm, *, file = __FILE__, line = __LINE__)

diff --git a/spec/std/base64_spec.cr b/spec/std/base64_spec.cr
@@ -1,7 +1,7 @@
 require "spec"
 require "base64"
 require "crystal/digest/md5"
-require "../support/string"
+require "spec/helpers/string"
 
 # rearrange parameters for `assert_prints`
 {% for method in %w(encode strict_encode urlsafe_encode) %}

diff --git a/spec/std/big/big_decimal_spec.cr b/spec/std/big/big_decimal_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "big"
-require "../../support/string"
+require "spec/helpers/string"
 
 describe BigDecimal do
   it "initializes from valid input" do

diff --git a/spec/std/big/big_float_spec.cr b/spec/std/big/big_float_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "big"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def it_converts_to_s(value : BigFloat, str, *, file = __FILE__, line = __LINE__)
   it "converts to #{str}", file: file, line: line do

diff --git a/spec/std/char_spec.cr b/spec/std/char_spec.cr
@@ -1,7 +1,7 @@
 require "spec"
 require "unicode"
 require "spec/helpers/iterate"
-require "../support/string"
+require "spec/helpers/string"
 
 describe "Char" do
   describe "#upcase" do

diff --git a/spec/std/csv/csv_build_spec.cr b/spec/std/csv/csv_build_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "csv"
-require "../../support/string"
+require "spec/helpers/string"
 
 describe CSV do
   describe "build" do

diff --git a/spec/std/enum_spec.cr b/spec/std/enum_spec.cr
@@ -1,5 +1,5 @@
 require "spec"
-require "../support/string"
+require "spec/helpers/string"
 
 enum SpecEnum : Int8
   One

diff --git a/spec/std/float_printer_spec.cr b/spec/std/float_printer_spec.cr
@@ -35,7 +35,7 @@
 
 require "spec"
 require "./spec_helper"
-require "../support/string"
+require "spec/helpers/string"
 require "../support/number"
 
 # Tests that `v.to_s` is the same as the *v* literal is written in the source

diff --git a/spec/std/float_spec.cr b/spec/std/float_spec.cr
@@ -1,5 +1,5 @@
 require "spec"
-require "../support/string"
+require "spec/helpers/string"
 
 describe "Float" do
   describe "**" do

diff --git a/spec/std/http/http_spec.cr b/spec/std/http/http_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "http"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def http_quote_string(io : IO, string)
   HTTP.quote_string(string, io)

diff --git a/spec/std/humanize_spec.cr b/spec/std/humanize_spec.cr
@@ -1,5 +1,5 @@
 require "spec"
-require "../support/string"
+require "spec/helpers/string"
 
 private LENGTH_UNITS = ->(magnitude : Int32, number : Float64) do
   case magnitude

diff --git a/spec/std/json/builder_spec.cr b/spec/std/json/builder_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "json"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def assert_built(expected, *, file = __FILE__, line = __LINE__, &)
   assert_prints JSON.build { |json| with json yield json }, expected, file: file, line: line

diff --git a/spec/std/mime/media_type_spec.cr b/spec/std/mime/media_type_spec.cr
@@ -1,6 +1,6 @@
 require "../spec_helper"
 require "mime/media_type"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def parse(string)
   type = MIME::MediaType.parse(string)

diff --git a/spec/std/process/status_spec.cr b/spec/std/process/status_spec.cr
@@ -1,5 +1,5 @@
 require "spec"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def exit_status(status)
   {% if flag?(:unix) %}

diff --git a/spec/std/slice_spec.cr b/spec/std/slice_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "spec/helpers/iterate"
-require "../support/string"
+require "spec/helpers/string"
 
 private class BadSortingClass
   include Comparable(self)

diff --git a/spec/std/socket/address_spec.cr b/spec/std/socket/address_spec.cr
@@ -1,7 +1,7 @@
 require "spec"
 require "socket"
 require "../../support/win32"
-require "../../support/string"
+require "spec/helpers/string"
 
 describe Socket::Address do
   describe ".parse" do

diff --git a/spec/std/sprintf_spec.cr b/spec/std/sprintf_spec.cr
@@ -1,5 +1,5 @@
 require "./spec_helper"
-require "../support/string"
+require "spec/helpers/string"
 require "big"
 
 # use same name for `sprintf` and `IO#printf` so that `assert_prints` can be leveraged

diff --git a/spec/std/string_spec.cr b/spec/std/string_spec.cr
@@ -1,6 +1,6 @@
 require "./spec_helper"
 require "spec/helpers/iterate"
-require "../support/string"
+require "spec/helpers/string"
 
 describe "String" do
   describe "[]" do
@@ -692,7 +692,8 @@ describe "String" do
     end
 
     it "does not touch invalid code units in an otherwise ascii string" do
-      assert_prints "\xB5!\xE0\xC1\xB5?".capitalize, "\xB5!\xE0\xC1\xB5?"
+      "\xB5!\xE0\xC1\xB5?".capitalize.should eq("\xB5!\xE0\xC1\xB5?")
+      String.build { |io| "\xB5!\xE0\xC1\xB5?".capitalize(io) }.should eq("\xB5!\xE0\xC1\xB5?".scrub)
     end
   end
 
@@ -710,8 +711,10 @@ describe "String" do
     end
 
     it "does not touch invalid code units in an otherwise ascii string" do
-      assert_prints "\xB5!\xE0\xC1\xB5?".titleize, "\xB5!\xE0\xC1\xB5?"
-      assert_prints "a\xA0b".titleize, "A\xA0b"
+      "\xB5!\xE0\xC1\xB5?".titleize.should eq("\xB5!\xE0\xC1\xB5?")
+      "a\xA0b".titleize.should eq("A\xA0b")
+      String.build { |io| "\xB5!\xE0\xC1\xB5?".titleize(io) }.should eq("\xB5!\xE0\xC1\xB5?".scrub)
+      String.build { |io| "a\xA0b".titleize(io) }.should eq("A\xA0b".scrub)
     end
   end
 

diff --git a/spec/std/time/format_spec.cr b/spec/std/time/format_spec.cr
@@ -1,5 +1,5 @@
 require "./spec_helper"
-require "../../support/string"
+require "spec/helpers/string"
 
 def parse_time(format, string)
   Time.parse_utc(format, string)

diff --git a/spec/std/uri_spec.cr b/spec/std/uri_spec.cr
@@ -2,7 +2,7 @@ require "spec"
 require "uri"
 require "uri/json"
 require "uri/yaml"
-require "../support/string"
+require "spec/helpers/string"
 
 private def assert_uri(string, file = __FILE__, line = __LINE__, **args)
   it "`#{string}`", file, line do

diff --git a/spec/std/uuid_spec.cr b/spec/std/uuid_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "uuid"
-require "../support/string"
+require "spec/helpers/string"
 
 describe "UUID" do
   describe "#==" do

diff --git a/spec/std/xml/builder_spec.cr b/spec/std/xml/builder_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "xml"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def assert_built(expected, quote_char = nil, *, file = __FILE__, line = __LINE__, &)
   assert_prints XML.build(quote_char: quote_char) { |xml| with xml yield xml }, expected, file: file, line: line

diff --git a/spec/std/xml/xml_spec.cr b/spec/std/xml/xml_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "xml"
-require "../../support/string"
+require "spec/helpers/string"
 
 describe XML do
   it "parses" do

diff --git a/spec/std/yaml/builder_spec.cr b/spec/std/yaml/builder_spec.cr
@@ -1,6 +1,6 @@
 require "spec"
 require "yaml"
-require "../../support/string"
+require "spec/helpers/string"
 
 private def assert_built(expected, expect_document_end = false, *, file = __FILE__, line = __LINE__, &)
   # libyaml 0.2.1 removed the erroneously written document end marker (`...`) after some scalars in root context (see https://github.com/yaml/libyaml/pull/18).

diff --git a/spec/support/string.cr b/spec/support/string.cr