Separate the Color and Gradient modules

Author: Blupo

README.md

@@ -21,6 +21,12 @@ Some of the library's features includes:
 - Creating gradients
 
 ```lua
+-- Accessing the modules
+local ColorLib = require(...)
+
+local Color = ColorLib.Color
+local Gradient = ColorLib.Gradient
+
 -- Constructors
 local pink = Color.fromHex("#ff69b4")
 local blue = Color.from("HSB", 240, 1, 1)
@@ -47,7 +53,7 @@ red:mix(aqua, 0.5, "Lab")
 red:mix(aqua, 0.5, "Luv")
 
 -- Gradients
-local gradient = Color.gradientFromColors(
+local gradient = Gradient.fromColors(
     Color.named("red"),
     Color.named("green"),
     Color.named("blue")

docs/api/gradient.md

@@ -13,12 +13,12 @@
 
 ## Constructors
 
-### Color.gradient
+### Gradient.new
 
 <img src="https://img.shields.io/badge/-static-blue" alt="Static function" />
 
 ```
-Color.gradient(keypoints: array<GradientKeypoint>): Gradient
+Gradient.new(keypoints: array<GradientKeypoint>): Gradient
 ```
 
 Standard Gradient constructor. The first keypoint must have a `Time` of 0, and the last keypoint must have a `Time` of 1. (Consequently, there must be at least 2 keypoints.) The keypoint list must be sorted by time.
@@ -28,24 +28,24 @@ Standard Gradient constructor. The first keypoint must have a `Time` of 0, and t
 
 ---
 
-### Color.gradientFromColors
+### Gradient.fromColors
 
 <img src="https://img.shields.io/badge/-static-blue" alt="Static function" />
 
 ```
-Color.gradientFromColors(...: Color): Gradient
+Gradient.fromColors(...: Color): Gradient
 ```
 
 Creates a Gradient from one or more Colors. If one Color is passed, the start and end keypoints will have the same color. If two Colors are passed, the start and end keypoints will have the first and second color, respectively. If 3 or more Colors is passed, the keypoints will be equidistant with respect to time.
 
 ---
 
-### Color.gradientFromColorSequence
+### Gradient.fromColorSequence
 
 <img src="https://img.shields.io/badge/-static-blue" alt="Static function" />
 
 ```
-Color.gradientFromColorSequence(colorSequence: ColorSequence): Gradient
+Gradient.fromColorSequence(colorSequence: ColorSequence): Gradient
 ```
 
 Creates a Gradient from a [ColorSequence](https://developer.roblox.com/en-us/api-reference/datatype/ColorSequence).
@@ -114,17 +114,17 @@ Returns a [ColorSequence](https://developer.roblox.com/en-us/api-reference/datat
 Comparing Gradients with `==` checks if they have the same number of keypoints, that the keypoints have the same Time values, and that the keypoints have the same Color values (using [Color.unclippedEq](../color/#colorunclippedeq)).
 
 ```lua
-local gradient1 = Color.gradientFromColors(
+local gradient1 = Gradient.fromColors(
     Color.new(0, 0, 0),
     Color.new(1, 1, 1)
 )
 
-local gradient2 = Color.gradient({
+local gradient2 = Gradient.new({
     {Time = 0, Color = Color.new(0, 0, 0)},
     {Time = 1, Color = Color.new(1, 1, 1)}
 })
 
-local gradient3 = Color.gradient({
+local gradient3 = Gradient.new({
     {Time = 0, Color = Color.new(1, 1, 1)},
     {Time = 1, Color = Color.new(0, 0, 0)}
 }) 

docs/changelog.md

@@ -20,6 +20,8 @@
 - Documentation now reflects that the Hue component for some color types can be NaN
 - Static functions in the documentation now have a badge
 - Read-only properties in the documentation now have a badge
+- The Color and Gradient modules of the library are now split apart
+    - You can access the modules using `[Module].Color` and `[Module].Gradient`
 - Updated the allowed interpolations for `Color.mix`
 - `Color.components` now allows you to obtain unclipped components
 - `Color.luminance` now corrects the [error](https://www.w3.org/WAI/GL/wiki/index.php?title=Relative_luminance&oldid=11187) from the equation provided in WCAG 2

docs/index.md

@@ -8,6 +8,15 @@ The module is available in the library [here](https://roblox.com/library/7933448
 
 If you know how to use [Rojo](https://rojo.space), you can build the latest code from the development branch to get the newest features. Keep in mind that this is **development code**, and things can break or change quickly.
 
+The library has two parts: the Color module and the Gradient module. You can access them using `[Module].Color` and `[Module].Gradient`.
+
+```lua
+local ColorLib = require(...)
+
+local Color = ColorLib.Color
+local Gradient = ColorLib.Gradient
+```
+
 ## Conversions
 
 Colors can be constructed from different [color types](api/color/#color-types), including hex strings, HSB/L, and L\*a\*b\*. You can use [`Color.from`](api/color/#colorfrom) or `Color.from[ColorType]` (e.g. `Color.fromHex`).
@@ -90,7 +99,7 @@ There are also functions that don't fall into a general category:
 
 Gradients are similar in construction and behaviour to ColorSequences. They can be used to generate intermediate colors or ColorSequences so that they can be used in places where they're required, such as ParticleEmitters or UIGradients.
 
-A Gradient can be constructed using an array of "gradient keypoints", which is just a dictionary with a `Time` and `Color` field, similar to the `Time` and `Value` fields of a [ColorSequenceKeypoint](https://developer.roblox.com/api-reference/datatype/ColorSequenceKeypoint). The constructor for this method is [`Color.gradient`](api/gradient/#colorgradient).
+A Gradient can be constructed using an array of "gradient keypoints", which is just a dictionary with a `Time` and `Color` field, similar to the `Time` and `Value` fields of a [ColorSequenceKeypoint](https://developer.roblox.com/api-reference/datatype/ColorSequenceKeypoint). The constructor for this method is [`Gradient.new`](api/gradient/#gradientnew).
 
 ```lua
 local keypoints = {
@@ -99,34 +108,34 @@ local keypoints = {
     {Time = 1, Color = Color.grey(1)}
 }
 
-local gradient = Color.gradient(keypoints)
+local gradient = Gradient.new(keypoints)
 ```
 
-You can also construct a Gradient with a list of Colors using [`Color.gradientFromColors`](api/gradient/#colorgradientfromcolors). This creates a gradient where the colors are equidistant from each other.
+You can also construct a Gradient with a list of Colors using [`Gradient.fromColors`](api/gradient/#gradientfromcolors). This creates a gradient where the colors are equidistant from each other.
 
 ```lua
-local gradient = Color.gradientFromColors(
+local gradient = Gradient.fromColors(
     Color.named("red"),
     Color.named("green"),
     Color.named("blue")
 )
 ```
 
-Finally, the constructor [`Color.gradientFromColorSequence`](api/gradient/#colorgradientfromcolorsequence) creates a gradient from a ColorSequence.
+Finally, the constructor [`Gradient.fromColorSequence`](api/gradient/#gradientfromcolorsequence) creates a gradient from a ColorSequence.
 
 ```lua
 local cs = ColorSequence.new(
     Color3.new(0, 0, 0),
     Color3.new(1, 1, 1)
 )
 
-local gradient = Color.gradientFromColorSequence(cs)
+local gradient = Gradient.fromColorSequence(cs)
 ```
 
 Generating colors from a gradient is similar to mixing colors, using [`Gradient.color`](api/gradient/#gradientcolor). If you need a list of colors, you can use [`Gradient.colors`](api/gradient/#gradientcolors). If you need a ColorSequence, you can use [`Gradient.colorSequence`](api/gradient/#gradientcolorsequence).
 
 ```lua
-local gradient = Color.gradientFromColors(
+local gradient = Gradient.fromColors(
     Color.named("red"),
     Color.named("green"),
     Color.named("blue")

src/init.lua

@@ -10,73 +10,6 @@ export type GradientKeypoint = Gradient.GradientKeypoint
 ---
 
 return {
-    new = Color.new,
-    random = Color.random,
-    gray = Color.gray,
-    named = Color.named,
-    from = Color.from,
-
-    isAColor = Color.isAColor,
-    isClipped = Color.isClipped,
-    unclippedEq = Color.unclippedEq,
-
-    components = Color.components,
-    to = Color.to,
-
-    invert = Color.invert,
-    mix = Color.mix,
-    blend = Color.blend,
-
-    deltaE = Color.deltaE,
-    luminance = Color.luminance,
-    contrast = Color.contrast,
-    bestContrastingColor = Color.bestContrastingColor,
-
-    brighten = Color.brighten,
-    darken = Color.darken,
-    saturate = Color.saturate,
-    desaturate = Color.desaturate,
-    harmonies = Color.harmonies,
-
-    gradient = Gradient.new,
-    gradientFromColors = Gradient.fromColors,
-    gradientFromColorSequence = Gradient.fromColorSequence,
-
-    fromBrickColor = Color.fromBrickColor,
-    fromCMYK = Color.fromCMYK,
-    fromColor3 = Color.fromColor3,
-    fromHex = Color.fromHex,
-    fromHSB = Color.fromHSB,
-    fromHSL = Color.fromHSL,
-    fromHWB = Color.fromHWB,
-    fromLab = Color.fromLab,
-    fromLChab = Color.fromLChab,
-    fromLChuv = Color.fromLChuv,
-    fromLuv = Color.fromLuv,
-    fromNumber = Color.fromNumber,
-    fromRGB = Color.fromRGB,
-    fromTemperature = Color.fromTemperature,
-    fromXYZ = Color.fromXYZ,
-
-    toBrickColor = Color.toBrickColor,
-    toCMYK = Color.toCMYK,
-    toColor3 = Color.toColor3,
-    toHex = Color.toHex,
-    toHSB = Color.toHSB,
-    toHSL = Color.toHSL,
-    toHWB = Color.toHWB,
-    toLab = Color.toLab,
-    toLChab = Color.toLChab,
-    toLChuv = Color.toLChuv,
-    toLuv = Color.toLuv,
-    toNumber = Color.toNumber,
-    toRGB = Color.toRGB,
-    toTemperature = Color.toTemperature,
-    toXYZ = Color.toXYZ,
-
-    fromHSV = Color.fromHSV,
-    fromLCh = Color.fromLCh,
-
-    toHSV = Color.toHSV,
-    toLCh = Color.toLCh,
+    Color = Color,
+    Gradient = Gradient,
 }

tests/Color.spec.lua

@@ -1,12 +1,43 @@
 return function()
-    local Color = require(game:GetService("ReplicatedStorage").Color.Color)
+    local ColorLib = require(game:GetService("ReplicatedStorage"):FindFirstChild("Color"))
+    local Color = ColorLib.Color
 
     it("should be immutable", function()
         expect(function()
             Color.new = nil
         end).to.throw()
     end)
 
+    it("should have a public API", function()
+        expect(Color.isAColor).to.be.a("function")
+        expect(Color.isClipped).to.be.a("function")
+
+        expect(Color.new).to.be.a("function")
+        expect(Color.random).to.be.a("function")
+        expect(Color.gray).to.be.a("function")
+        expect(Color.named).to.be.a("function")
+        expect(Color.from).to.be.a("function")
+
+        expect(Color.unclippedEq).to.be.a("function")
+        expect(Color.components).to.be.a("function")
+        expect(Color.to).to.be.a("function")
+
+        expect(Color.invert).to.be.a("function")
+        expect(Color.mix).to.be.a("function")
+        expect(Color.blend).to.be.a("function")
+
+        expect(Color.deltaE).to.be.a("function")
+        expect(Color.luminance).to.be.a("function")
+        expect(Color.contrast).to.be.a("function")
+        expect(Color.bestContrastingColor).to.be.a("function")
+
+        expect(Color.brighten).to.be.a("function")
+        expect(Color.darken).to.be.a("function")
+        expect(Color.saturate).to.be.a("function")
+        expect(Color.desaturate).to.be.a("function")
+        expect(Color.harmonies).to.be.a("function")
+    end)
+
     it("should have alternative construction functions", function()
         expect(Color.fromBrickColor).to.be.a("function")
         expect(Color.fromCMYK).to.be.a("function")

tests/Gradient.spec.lua

@@ -1,8 +1,8 @@
-local ColorModule = game:GetService("ReplicatedStorage").Color
-
 return function()
-    local Color = require(ColorModule.Color)
-    local Gradient = require(ColorModule.Gradient)
+    local ColorLib = require(game:GetService("ReplicatedStorage"):FindFirstChild("Color"))
+
+    local Color = ColorLib.Color
+    local Gradient = ColorLib.Gradient
 
     it("should be immutable", function()
         expect(function()