From 6a31f28e887a5af1c605f66f57e40b5c6c22ad62 Mon Sep 17 00:00:00 2001
From: Fredrik Ekre <ekrefredrik@gmail.com>
Date: Wed, 20 Nov 2024 14:30:25 +0100
Subject: [PATCH] Remove unused assert toggling

Running testsuite *without* asserts takes roughly 150% or the time to
run it *with* asserts, probably because the compiler is helped by some
of the checks. The toggling is unused anyway, so delete it.
---
 src/ToggleableAsserts.jl | 45 ----------------------------------------
 src/debug.jl             |  5 +----
 test/runtests.jl         | 18 ++++++++++++++++
 3 files changed, 19 insertions(+), 49 deletions(-)
 delete mode 100644 src/ToggleableAsserts.jl

diff --git a/src/ToggleableAsserts.jl b/src/ToggleableAsserts.jl
deleted file mode 100644
index ff10610..0000000
--- a/src/ToggleableAsserts.jl
+++ /dev/null
@@ -1,45 +0,0 @@
-# SPDX-License-Identifier: MIT
-
-# The code in this file is derived from code in the ToggleableAsserts.jl package
-# (https://github.com/MasonProtter/ToggleableAsserts.jl) licensed under the MIT license.
-# (https://github.com/MasonProtter/ToggleableAsserts.jl/blob/master/LICENSE):
-
-# MIT License
-#
-# Copyright (c) 2021 Mason Protter
-#
-# 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.
-
-assert_enabled() = true
-
-macro assert(expr)
-    code = macroexpand_assert(expr)
-    return :(assert_enabled() ? $(code) : nothing)
-end
-
-const toggle_lock = ReentrantLock()
-
-function enable_assert(enable::Bool)
-    @lock toggle_lock begin
-        if assert_enabled() != enable
-            @eval Runic assert_enabled() = $enable
-        end
-    end
-    return
-end
diff --git a/src/debug.jl b/src/debug.jl
index 77400ea..b3adf19 100644
--- a/src/debug.jl
+++ b/src/debug.jl
@@ -4,9 +4,6 @@
 # Debug info #
 ##############
 
-# Code derived from ToggleableAsserts.jl kept in a separate file
-include("ToggleableAsserts.jl")
-
 abstract type RunicException <: Exception end
 
 struct AssertionError <: RunicException
@@ -23,7 +20,7 @@ function Base.showerror(io::IO, err::AssertionError)
     return
 end
 
-function macroexpand_assert(expr)
+macro assert(expr)
     msg = string(expr)
     return :($(esc(expr)) || throw(AssertionError($msg)))
 end
diff --git a/test/runtests.jl b/test/runtests.jl
index 78e9d28..fc12f82 100644
--- a/test/runtests.jl
+++ b/test/runtests.jl
@@ -22,6 +22,24 @@ using JuliaSyntax:
     end
 end
 
+@testset "Runic.AssertionError" begin
+    issuemsg = "This is unexpected, please file an issue with a reproducible example at " *
+        "https://github.com/fredrikekre/Runic.jl/issues/new."
+    try
+        Runic.@assert 1 == 2
+    catch err
+        @test err isa Runic.AssertionError
+        @test sprint(showerror, err) == "Runic.AssertionError: 1 == 2. " * issuemsg
+    end
+    try
+        Runic.unreachable()
+    catch err
+        @test err isa Runic.AssertionError
+        @test sprint(showerror, err) ==
+            "Runic.AssertionError: unreachable code reached. " * issuemsg
+    end
+end
+
 @testset "Chisels" begin
     # Type stability of verified_kids
     node = Runic.Node(JuliaSyntax.parseall(JuliaSyntax.GreenNode, "a = 1 + b\n"))