+ Penlight

1 files changed, 128 insertions, 0 deletions

diff --git a/Data/Libraries/Penlight/spec/utils-deprecate_spec.lua b/Data/Libraries/Penlight/spec/utils-deprecate_spec.lua
new file mode 100644
index 0000000..1a6e352
--- /dev/null
+++ b/Data/Libraries/Penlight/spec/utils-deprecate_spec.lua
@@ -0,0 +1,128 @@
+local utils = require("pl.utils")
+
+describe("pl.utils", function ()
+
+  local old_fn, last_msg, last_trace
+
+  before_each(function()
+    old_fn = function() end
+    last_msg = nil
+    last_trace = nil
+    utils.set_deprecation_func(function(msg, trace)
+      last_msg = msg
+      last_trace = trace
+    end)
+  end)
+
+
+  after_each(function()
+    utils.deprecation_warning = old_fn
+  end)
+
+
+
+  describe("set_deprecation_func", function ()
+
+    it("accepts nil as callback", function()
+      assert.has.no.error(function()
+        utils.set_deprecation_func()
+      end)
+    end)
+
+
+    it("accepts function as callback", function()
+      assert.has.no.error(function()
+        utils.set_deprecation_func(function() end)
+      end)
+    end)
+
+
+    it("fails on non-functions", function()
+      assert.has.error(function()
+        utils.set_deprecation_func("not a function")
+      end, "argument 1 expected a 'function', got a 'string'")
+    end)
+
+  end)
+
+
+
+  describe("raise_deprecation", function ()
+
+    it("requires the opts table", function()
+      assert.has.error(function() utils.raise_deprecation(nil) end,
+                       "argument 1 expected a 'table', got a 'nil'")
+    end)
+
+
+    it("requires the opts.message field", function()
+      assert.has.error(function() utils.raise_deprecation({}) end,
+                       "field 'message' of the options table must be a string")
+    end)
+
+
+    it("should output the message", function ()
+      utils.raise_deprecation {
+        message = "hello world"
+      }
+      assert.equal("hello world", last_msg)
+    end)
+
+
+    it("should output the deprecated version", function ()
+      utils.raise_deprecation {
+        message = "hello world",
+        deprecated_after = "2.0.0",
+      }
+      assert.equal("hello world (deprecated after 2.0.0)", last_msg)
+    end)
+
+
+    it("should output the removal version", function ()
+      utils.raise_deprecation {
+        message = "hello world",
+        version_removed = "3.0.0",
+      }
+      assert.equal("hello world (scheduled for removal in 3.0.0)", last_msg)
+    end)
+
+
+    it("should output the deprecated and removal versions", function ()
+      utils.raise_deprecation {
+        message = "hello world",
+        deprecated_after = "2.0.0",
+        version_removed = "3.0.0",
+      }
+      assert.equal("hello world (deprecated after 2.0.0, scheduled for removal in 3.0.0)", last_msg)
+    end)
+
+
+    it("should output the application/module name", function ()
+      utils.raise_deprecation {
+        source = "MyApp 1.2.3",
+        message = "hello world",
+        deprecated_after = "2.0.0",
+        version_removed = "3.0.0",
+      }
+      assert.equal("[MyApp 1.2.3] hello world (deprecated after 2.0.0, scheduled for removal in 3.0.0)", last_msg)
+    end)
+
+
+    it("should add a stracktrace", function ()
+      local function my_function_name()
+        utils.raise_deprecation {
+          source = "MyApp 1.2.3",
+          message = "hello world",
+          deprecated_after = "2.0.0",
+          version_removed = "3.0.0",
+        }
+      end
+      my_function_name()
+
+      assert.Not.match("raise_deprecation", last_trace)
+      assert.match("my_function_name", last_trace)
+    end)
+
+  end)
+
+end)