chore: rename extension libpostal -> postal

This makes it
- shorter
- distinct from the wrapped project,
  which I think is good for users, but also helps with development because
  it makes it more clear if I'm referring
  to libpostal or to this extension

.github/workflows/MainDistributionPipeline.yml

@@ -18,7 +18,7 @@ jobs:
     with:
       vcpkg_commit: a42af01b72c28a8e1d7b48107b33e4f286a55ef6
       duckdb_version: v0.9.2
-      extension_name: libpostal
+      extension_name: postal
 
   duckdb-stable-deploy:
     name: Deploy extension binaries
@@ -27,6 +27,6 @@ jobs:
     secrets: inherit
     with:
       duckdb_version: v0.9.2
-      extension_name: libpostal
+      extension_name: postal
       deploy_latest: ${{ startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main' }}
       deploy_versioned: ${{ startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main' }}

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 2.8.12)
 
 # Set extension name here
-set(TARGET_NAME libpostal)
+set(TARGET_NAME postal)
 
 set(EXTENSION_NAME ${TARGET_NAME}_extension)
 set(LOADABLE_EXTENSION_NAME ${TARGET_NAME}_loadable_extension)
@@ -13,7 +13,7 @@ find_package(PkgConfig REQUIRED)
 pkg_check_modules(LIBPOSTAL REQUIRED libpostal)
 include_directories(${LIBPOSTAL_INCLUDE_DIRS})
 
-set(EXTENSION_SOURCES src/libpostal_extension.cpp)
+set(EXTENSION_SOURCES src/postal_extension.cpp)
 
 build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES})
 build_loadable_extension(${TARGET_NAME} " " ${EXTENSION_SOURCES})

Makefile

@@ -23,9 +23,9 @@ ifeq ($(GEN),ninja)
 endif
 
 #### Configuration for this extension
-EXTENSION_NAME=LIBPOSTAL
+EXTENSION_NAME=POSTAL
 EXTENSION_FLAGS=\
--DDUCKDB_EXTENSION_NAMES="libpostal" \
+-DDUCKDB_EXTENSION_NAMES="postal" \
 -DDUCKDB_EXTENSION_${EXTENSION_NAME}_PATH="$(PROJ_DIR)" \
 -DDUCKDB_EXTENSION_${EXTENSION_NAME}_LOAD_TESTS=1 \
 -DDUCKDB_EXTENSION_${EXTENSION_NAME}_INCLUDE_PATH="$(PROJ_DIR)src/include" \
@@ -54,7 +54,7 @@ libpostal-configure:
 	sudo make install
 
 #### Main build
-# For regular CLI build, we link the libpostal extension directly into the DuckDB executable
+# For regular CLI build, we link the extension directly into the DuckDB executable
 CLIENT_FLAGS=-DDUCKDB_EXTENSION_${EXTENSION_NAME}_SHOULD_LINK=1
 
 debug:
@@ -88,8 +88,8 @@ test_debug: debug
 	./build/debug/$(TEST_PATH) "$(PROJ_DIR)test/*"
 
 #### Client tests
-DEBUG_EXT_PATH='$(PROJ_DIR)build/debug/extension/libpostal/libpostal.duckdb_extension'
-RELEASE_EXT_PATH='$(PROJ_DIR)build/release/extension/libpostal/libpostal.duckdb_extension'
+DEBUG_EXT_PATH='$(PROJ_DIR)build/debug/extension/postal/postal.duckdb_extension'
+RELEASE_EXT_PATH='$(PROJ_DIR)build/release/extension/postal/postal.duckdb_extension'
 test_js: test_debug_js
 test_debug_js: debug_js
 	cd duckdb/tools/nodejs && ${EXTENSION_NAME}_EXTENSION_BINARY_PATH=$(DEBUG_EXT_PATH) npm run test-path -- "../../../test/nodejs/**/*.js"

README.md

@@ -26,18 +26,18 @@ The main binaries that will be built are:
 ```sh
 ./build/release/duckdb
 ./build/release/test/unittest
-./build/release/extension/libpostal/libpostal.duckdb_extension
+./build/release/extension/postal/postal.duckdb_extension
 ```
 - `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.
 - `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
-- `libpostal.duckdb_extension` is the loadable binary as it would be distributed.
+- `postal.duckdb_extension` is the loadable binary as it would be distributed.
 
 ## Running the extension
 To run the extension code, simply start the shell with `./build/release/duckdb`.
 
-Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `libpostal()` that takes a string arguments and returns a string:
+Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `postal()` that takes a string arguments and returns a string:
 ```
-D select libpostal('Jane') as result;
+D select postal('Jane') as result;
 ┌───────────────┐
 │    result     │
 │    varchar    │
@@ -81,6 +81,6 @@ DuckDB. To specify a specific version, you can pass the version instead.
 
 After running these steps, you can install and load your extension using the regular INSTALL/LOAD commands in DuckDB:
 ```sql
-INSTALL libpostal
-LOAD libpostal
+INSTALL postal
+LOAD postal
 ```

src/include/libpostal_extension.hpp → src/include/postal_extension.hpp

@@ -4,7 +4,7 @@
 
 namespace duckdb {
 
-class LibpostalExtension : public Extension {
+class PostalExtension : public Extension {
 public:
 	void Load(DuckDB &db) override;
 	std::string Name() override;

src/libpostal_extension.cpp

@@ -1,6 +1,6 @@
 #define DUCKDB_EXTENSION_MAIN
 
-#include "libpostal_extension.hpp"
+#include "postal_extension.hpp"
 #include "duckdb.hpp"
 #include "duckdb/common/exception.hpp"
 #include "duckdb/common/string_util.hpp"
@@ -12,12 +12,12 @@
 
 namespace duckdb {
 
-inline void LibpostalScalarFun(DataChunk &args, ExpressionState &state, Vector &result) {
+inline void PostalScalarFun(DataChunk &args, ExpressionState &state, Vector &result) {
     auto &name_vector = args.data[0];
     UnaryExecutor::Execute<string_t, string_t>(
 	    name_vector, result, args.size(),
 	    [&](string_t name) {
-			return StringVector::AddString(result, "Libpostal "+name.GetString()+" 🐥");;
+			return StringVector::AddString(result, "Postal "+name.GetString()+" 🐥");;
         });
 }
 
@@ -43,34 +43,34 @@ static void LoadInternal(DatabaseInstance &instance) {
         exit(EXIT_FAILURE);
     }
 
-    auto libpostal_scalar_function = ScalarFunction("libpostal", {LogicalType::VARCHAR}, LogicalType::VARCHAR, LibpostalScalarFun);
-    ExtensionUtil::RegisterFunction(instance, libpostal_scalar_function);
+    auto f = ScalarFunction("postal", {LogicalType::VARCHAR}, LogicalType::VARCHAR, PostalScalarFun);
+    ExtensionUtil::RegisterFunction(instance, f);
 
-    auto libpostal_parse_address = ScalarFunction("libpostal_parse_address", {LogicalType::VARCHAR}, LogicalType::VARCHAR, ParseAddress);
-    ExtensionUtil::RegisterFunction(instance, libpostal_parse_address);
+    auto f = ScalarFunction("parse_address", {LogicalType::VARCHAR}, LogicalType::VARCHAR, ParseAddress);
+    ExtensionUtil::RegisterFunction(instance, f);
 
     // Teardown (only called once at the end of your program)
     // libpostal_teardown();
     // libpostal_teardown_parser();
 }
 
-void LibpostalExtension::Load(DuckDB &db) {
+void PostalExtension::Load(DuckDB &db) {
 	LoadInternal(*db.instance);
 }
-std::string LibpostalExtension::Name() {
-	return "libpostal";
+std::string PostalExtension::Name() {
+	return "postal";
 }
 
 } // namespace duckdb
 
 extern "C" {
 
-DUCKDB_EXTENSION_API void libpostal_init(duckdb::DatabaseInstance &db) {
+DUCKDB_EXTENSION_API void postal_init(duckdb::DatabaseInstance &db) {
     duckdb::DuckDB db_wrapper(db);
-    db_wrapper.LoadExtension<duckdb::LibpostalExtension>();
+    db_wrapper.LoadExtension<duckdb::PostalExtension>();
 }
 
-DUCKDB_EXTENSION_API const char *libpostal_version() {
+DUCKDB_EXTENSION_API const char *postal_version() {
 	return duckdb::DuckDB::LibraryVersion();
 }
 }

test/nodejs/libpostal_test.js

@@ -1,22 +1,22 @@
 var duckdb = require('../../duckdb/tools/nodejs');
 var assert = require('assert');
 
-describe(`libpostal extension`, () => {
+describe(`postal extension`, () => {
     let db;
     let conn;
     before((done) => {
         db = new duckdb.Database(':memory:', {"allow_unsigned_extensions":"true"});
         conn = new duckdb.Connection(db);
-        conn.exec(`LOAD '${process.env.QUACK_EXTENSION_BINARY_PATH}';`, function (err) {
+        conn.exec(`LOAD '${process.env.POSTAL_EXTENSION_BINARY_PATH}';`, function (err) {
             if (err) throw err;
             done();
         });
     });
 
-    it('libpostal function should return expected string', function (done) {
-        db.all("SELECT libpostal('Sam') as value;", function (err, res) {
+    it('postal function should return expected string', function (done) {
+        db.all("SELECT postal('Sam') as value;", function (err, res) {
             if (err) throw err;
-            assert.deepEqual(res, [{value: "Libpostal Sam 🐥"}]);
+            assert.deepEqual(res, [{value: "Postal Sam 🐥"}]);
             done();
         });
     });

test/python/libpostal_test.py → test/python/postal_test.py

@@ -7,22 +7,22 @@
 
 DEFAULT_EXTENSION_PATH = (
     Path(__file__).parent.parent.parent
-    / "build/debug/extension/libpostal/libpostal.duckdb_extension"
+    / "build/debug/extension/postal/postal.duckdb_extension"
 )
 
 
-# Get a fresh connection to DuckDB with the libpostal extension binary loaded
+# Get a fresh connection to DuckDB with the extension binary loaded
 @pytest.fixture
 def duckdb_conn():
     extension_binary = os.environ.get(
-        "LIBPOSTAL_EXTENSION_BINARY_PATH", DEFAULT_EXTENSION_PATH
+        "POSTAL_EXTENSION_BINARY_PATH", DEFAULT_EXTENSION_PATH
     )
     conn = duckdb.connect("", config={"allow_unsigned_extensions": "true"})
     conn.execute(f"load '{extension_binary}'")
     return conn
 
 
-def test_libpostal(duckdb_conn):
-    duckdb_conn.execute("SELECT libpostal('Sam') as value;")
+def test_postal(duckdb_conn):
+    duckdb_conn.execute("SELECT postal('Sam') as value;")
     res = duckdb_conn.fetchall()
-    assert res[0][0] == "Libpostal Sam 🐥"
+    assert res[0][0] == "Postal Sam 🐥"

test/sql/postal.test

@@ -0,0 +1,18 @@
+# name: test/sql/postal.test
+# description: test postal extension
+# group: [postal]
+
+# Before we load the extension, this will fail
+statement error
+SELECT postal('Sam');
+----
+Catalog Error: Scalar Function with name postal does not exist!
+
+# Require statement will ensure this test is run with this extension loaded
+require postal
+
+# Confirm the extension works
+query I
+SELECT postal('Sam');
+----
+Postal Sam 🐥