Builder pattern for robots policies

README.md

@@ -46,7 +46,7 @@ Further documentation can be found at <https://hexdocs.pm/webls>.
 | ---------- | --------- | ----------------- | ---------- |
 | Sitemap    | Complete  | Complete          | None       |
 | RSS v2.0   | Complete  | None              | None       |
-| Robots.txt | Complete  | None              | None       |
+| Robots.txt | Complete  | Complete          | None       |
 
 ## Development
 

gleam.toml

@@ -1,5 +1,5 @@
 name = "webls"
-version = "1.2.0"
+version = "1.3.0"
 
 description = "A simple web utility library for RSS feeds, Sitemaps, Robots.txt, etc."
 licences = ["Apache-2.0"]

src/webls/robots.gleam

@@ -1,6 +1,8 @@
 import gleam/list
 import gleam/result
 
+// Stringify ------------------------------------------------------------------
+//
 pub fn to_string(config: RobotsConfig) -> String {
   "Sitemap: "
   <> config.sitemap_url
@@ -26,6 +28,22 @@ fn robot_to_string(robot: Robot) -> String {
   |> result.unwrap("")
 }
 
+// Builder Patern -------------------------------------------------------------
+
+pub fn robot(user_agent: String) -> Robot {
+  Robot(user_agent, [], [])
+}
+
+pub fn allowed_routes(robot: Robot, routes: List(String)) -> Robot {
+  Robot(..robot, allowed_routes: routes)
+}
+
+pub fn disallowed_routes(robot: Robot, routes: List(String)) -> Robot {
+  Robot(..robot, disallowed_routes: routes)
+}
+
+// Types ----------------------------------------------------------------------
+
 /// The configuration for a robots.txt file
 pub type RobotsConfig {
   RobotsConfig(

test/webls_test.gleam

@@ -158,3 +158,32 @@ pub fn robots_to_string_test() -> Nil {
   { length > 200 }
   |> should.be_true
 }
+
+pub fn robots_builder_test() -> Nil {
+  let built =
+    RobotsConfig("https://example.com/sitemap.xml", [
+      robots.robot("googlebot")
+        |> robots.allowed_routes(["/posts/", "/contact/"]),
+      robots.robot("bingbot")
+        |> robots.allowed_routes(["/posts/", "/contact/", "/private/"]),
+      robots.robot("yandex")
+        |> robots.disallowed_routes(["/"]),
+    ])
+
+  let manual =
+    RobotsConfig("https://example.com/sitemap.xml", [
+      Robot(
+        user_agent: "googlebot",
+        allowed_routes: ["/posts/", "/contact/"],
+        disallowed_routes: [],
+      ),
+      Robot(
+        user_agent: "bingbot",
+        allowed_routes: ["/posts/", "/contact/", "/private/"],
+        disallowed_routes: [],
+      ),
+      Robot(user_agent: "yandex", allowed_routes: [], disallowed_routes: ["/"]),
+    ])
+
+  built |> should.equal(manual)
+}