Skip to content
This repository has been archived by the owner on Jul 12, 2020. It is now read-only.

Add NumberRange (#155) #184

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ This document should remain up-to-date with current API coverage and status.
* Vector2.new()
* Vector2.new(x, y)
* Operators: `==`, `+`
* NumberRange
* NumberRange.new(minmax)
* NumberRange.new(min, max)
* Operators: `==`

## Implemented Instance Members
* AnalyticsService
Expand Down Expand Up @@ -176,9 +180,10 @@ This document should remain up-to-date with current API coverage and status.
* CoreGui
* NotificationService
* GuiService
* HttpService (requires dkjson installed)
* HttpService (JSON requires dkjson installed)
* JSONDecode(input)
* JSONEncode(input)
* UrlEncode(input)
* LocalizationService
* SystemLocaleId
* LocalizationTable
Expand Down
60 changes: 60 additions & 0 deletions lib/types/NumberRange.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
local assign = import("../assign")
local typeKey = import("../typeKey")

local NumberRange = {}

setmetatable(NumberRange, {
__tostring = function()
return "NumberRange"
end,
})

local prototype = {}

local metatable = {}
metatable[typeKey] = "NumberRange"

function metatable:__index(key)
local internal = getmetatable(self).internal

if internal[key] ~= nil then
return internal[key]
end

if prototype[key] ~= nil then
return prototype[key]
end

error(string.format("%s is not a valid member of NumberRange", tostring(key)), 2)
end

function metatable:__eq(other)
return self.Min == other.Min and self.Max == other.Max
end

function NumberRange.new(...)
if select("#", ...) == 1 then
local n = ({ ... })[1]

return NumberRange.new(n, n)
end

local Min, Max = ...
if type(Min) ~= "number" or type(Max) ~= "number" then
error("NumberRange.new must take in 2 numbers", 2)
end

local internalInstance = {
Min = Min,
Max = Max,
}

local instance = newproxy(true)

assign(getmetatable(instance), metatable)
getmetatable(instance).internal = internalInstance

return instance
end

return NumberRange
64 changes: 64 additions & 0 deletions lib/types/NumberRange_spec.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
local NumberRange = import("./NumberRange")
local typeof = import("../functions/typeof")

local function extractRange(range)
return {
range.Min,
range.Max
}
end

describe("types.NumberRange", function()
it("should have a constructor that takes values 0-Infitity", function()
local range = NumberRange.new(1, 2)

assert.not_nil(range)
assert.are.same(extractRange(range), { 1, 2 })
end)

it("should have a constructor that takes one value", function()
local range = NumberRange.new(1)

assert.not_nil(range)
assert.are.same(extractRange(range), { 1, 1 })
end)

it("should throw when bad params are passed to the 2-param constructor", function()
assert.has.errors(function()
NumberRange.new("test", 1)
end)

assert.has.errors(function()
NumberRange.new(1, "test")
end)
end)

it("should compare NumberRanges", function()
local nr1, nr2 = NumberRange.new(1, 2), NumberRange.new(1, 2)

assert.are.equal(nr1, nr2)
assert.are_not_equal(nr1, NumberRange.new(1, 3))
end)

it("should be detected by typeof", function()
local type = typeof(NumberRange.new(1, 2))

assert.are.equal("NumberRange", type)
end)

it("should be \"NumberRange\" when tostringed", function()
local tostringed = tostring(NumberRange)

assert.are.equal("NumberRange", tostringed)
end)

it("should throw when bad indexing", function()
assert.has.errors(function()
NumberRange["Bad"]()
end)

assert.has.errors(function()
NumberRange.new(1, 2)["Bad"]()
end)
end)
end)