Overrides into their own module

Author: lpil

src/packages/override.gleam

@@ -0,0 +1,47 @@
+pub fn is_ignored_package(name: String) -> Bool {
+  case name {
+    "bare_package1"
+    | "bare_package_one"
+    | "bare_package_two"
+    | "first_gleam_publish_package"
+    | "gleam_module_javascript_test"
+    | // Reserved official sounding names.
+      "gleam"
+    | "gleam_deno"
+    | "gleam_email"
+    | "gleam_html"
+    | "gleam_nodejs"
+    | "gleam_tcp"
+    | "gleam_test"
+    | "gleam_toml"
+    | "gleam_xml"
+    | "gleam_mongo"
+    | "gleam_bson"
+    | "gleam_file"
+    | "gleam_yaml"
+    | // Unofficial packages impersonating the core team
+      "gleam_dotenv"
+    | "gleam_roman"
+    | "gleam_sendgrid"
+    | "gleam_bbmustache"
+    | // Reserved unreleased project names.
+      "glitter"
+    | "sequin" -> True
+
+    _ -> False
+  }
+}
+
+/// Some words have common misspellings or associated words so we add those to
+/// the search to get all appropriate results.
+pub fn expand_search_term(term: String) -> List(String) {
+  case term {
+    "postgres" | "postgresql" -> ["postgres", "postgresql"]
+    "mysql" | "mariadb" -> ["mysql", "mariadb"]
+    "redis" | "valkey" -> ["redis", "valkey"]
+    "regex" | "regexp" -> ["regex", "regexp"]
+    "luster" -> ["luster", "lustre"]
+    "mail" -> ["mail", "email"]
+    term -> [term]
+  }
+}

src/packages/storage.gleam

@@ -13,6 +13,7 @@ import gleam/string
 import gleam/time/calendar
 import gleam/time/timestamp.{type Timestamp}
 import packages/error.{type Error}
+import packages/override
 import storail.{type Collection}
 
 pub opaque type Database {
@@ -53,19 +54,6 @@ pub fn initialise(storage_path: String) -> Database {
   Database(hex_sync_times:, packages:, releases:)
 }
 
-const ignored_packages = [
-  "bare_package1", "bare_package_one", "bare_package_two",
-  "first_gleam_publish_package", "gleam_module_javascript_test",
-  // Reserved official sounding names.
-  "gleam", "gleam_deno", "gleam_email", "gleam_html", "gleam_nodejs",
-  "gleam_tcp", "gleam_test", "gleam_toml", "gleam_xml", "gleam_mongo",
-  "gleam_bson", "gleam_file", "gleam_yaml",
-  // Unofficial packages impersonating the core team
-  "gleam_dotenv", "gleam_roman", "gleam_sendgrid", "gleam_bbmustache",
-  // Reserved unreleased project names.
-  "glitter", "sequin",
-]
-
 fn gleam_package_epoch() -> Timestamp {
   timestamp.from_unix_seconds(1_635_092_380)
 }
@@ -305,7 +293,7 @@ pub fn upsert_package_from_hex(
   package: hexpm.Package,
   latest_version latest_version: String,
 ) -> Result(Nil, Error) {
-  case is_ignored_package(package.name) {
+  case override.is_ignored_package(package.name) {
     True -> Ok(Nil)
     False -> {
       database.packages
@@ -316,10 +304,6 @@ pub fn upsert_package_from_hex(
   }
 }
 
-pub fn is_ignored_package(name: String) -> Bool {
-  list.contains(ignored_packages, name)
-}
-
 pub fn get_package(database: Database, name: String) -> Result(Package, Error) {
   database.packages
   |> storail.key(name)
@@ -387,7 +371,8 @@ pub fn list_releases(
 
 pub fn list_packages(database: Database) -> Result(List(String), Error) {
   case storail.list(database.packages, []) {
-    Ok(packages) -> Ok(list.filter(packages, fn(p) { !is_ignored_package(p) }))
+    Ok(packages) ->
+      Ok(list.filter(packages, fn(p) { !override.is_ignored_package(p) }))
     Error(e) -> Error(error.StorageError(e))
   }
 }

src/packages/text_search.gleam

@@ -7,7 +7,7 @@ import gleam/order
 import gleam/result
 import gleam/string
 import packages/error.{type Error}
-import packages/storage
+import packages/override
 import porter_stemmer
 
 pub opaque type TextSearchIndex {
@@ -23,7 +23,7 @@ pub fn insert(
   name name: String,
   description description: String,
 ) -> Result(Nil, Error) {
-  case storage.is_ignored_package(name) {
+  case override.is_ignored_package(name) {
     True -> Ok(Nil)
     False ->
       name
@@ -52,7 +52,7 @@ pub fn lookup(
 ) -> Result(List(String), Error) {
   let phrase = string.lowercase(phrase)
   stem_words(phrase)
-  |> list.flat_map(expand_search_term)
+  |> list.flat_map(override.expand_search_term)
   |> list.try_map(ethos.get(index.table, _))
   |> result.map(fn(names) {
     names
@@ -87,20 +87,6 @@ pub fn lookup(
   |> result.replace_error(error.EtsTableError)
 }
 
-/// Some words have common misspellings or associated words so we add those to
-/// the search to get all appropriate results.
-fn expand_search_term(term: String) -> List(String) {
-  case term {
-    "postgres" | "postgresql" -> ["postgres", "postgresql"]
-    "mysql" | "mariadb" -> ["mysql", "mariadb"]
-    "redis" | "valkey" -> ["redis", "valkey"]
-    "regex" | "regexp" -> ["regex", "regexp"]
-    "luster" -> ["luster", "lustre"]
-    "mail" -> ["mail", "email"]
-    term -> [term]
-  }
-}
-
 fn remove(index: TextSearchIndex, name: String) -> Result(Nil, Error) {
   ethos.delete_value(index.table, name)
   |> result.replace_error(error.EtsTableError)