Add namespace separator for Elasticsearch namespaces (#364)

* Allow custom separator in Elasticsearch namespaces

* Bump version: 0.8.0 → 0.8.1

Author: subhashb

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.0
+current_version = 0.8.1
 commit = True
 tag = True
 

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 21.12b0
     hooks:
       - id: black
         language_version: python3.8

CHANGELOG.rst

@@ -1,6 +1,11 @@
 Release History
 ===============
 
+0.8.1
+-----
+
+* Allow custom separator in Elasticsearch namespaces
+
 0.8.0
 -----
 

docs/adapters/database.rst

@@ -25,6 +25,11 @@ Additional options are available for finer control:
     Index names in Elasticsearch instance are prefixed with the specified string. For example, if the namespace
     prefix is "prod", the index of an aggregate `Person` will be `prod-person`.
 
+.. py:data:: NAMESPACE_SEPARATOR
+
+    Custom character to join NAMESPACE_PREFIX and index name. Default is hyphen (`-`). For example, with
+    `NAMESPACE_SEPARATOR` as `_`, the index of aggregate `Person` will be `prod_person`.
+
 .. py:data:: SETTINGS
 
     Index settings passed on to Elasticsearch instance.

docs/conf.py

@@ -28,7 +28,7 @@
 year = "2021"
 author = "Subhash Bhushan C"
 copyright = "{0}, {1}".format(year, author)
-version = release = "0.8.0"
+version = release = "0.8.1"
 
 pygments_style = "autumn"
 templates_path = ["."]

setup.py

@@ -17,7 +17,8 @@
 def read(*names, **kwargs):
     """Helper method to read files"""
     return io.open(
-        join(dirname(__file__), *names), encoding=kwargs.get("encoding", "utf8"),
+        join(dirname(__file__), *names),
+        encoding=kwargs.get("encoding", "utf8"),
     ).read()
 
 
@@ -88,7 +89,7 @@ def read(*names, **kwargs):
 
 setup(
     name="protean",
-    version="0.8.0",
+    version="0.8.1",
     license="BSD 3-Clause License",
     description="Protean Application Framework",
     long_description="%s\n%s"

src/protean/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.8.0"
+__version__ = "0.8.1"
 
 from .core.aggregate import BaseAggregate
 from .core.application_service import BaseApplicationService

src/protean/adapters/repository/elasticsearch.py

@@ -305,9 +305,15 @@ def derive_schema_name(self, entity_cls):
 
         # Prepend Namespace prefix if one has been provided
         if "NAMESPACE_PREFIX" in self.conn_info and self.conn_info["NAMESPACE_PREFIX"]:
-            schema_name = (
-                f"{self.conn_info['NAMESPACE_PREFIX']}_{entity_cls.meta_.schema_name}"
-            )
+            # Use custom separator if provided
+            separator = "_"
+            if (
+                "NAMESPACE_SEPARATOR" in self.conn_info
+                and self.conn_info["NAMESPACE_SEPARATOR"]
+            ):
+                separator = self.conn_info["NAMESPACE_SEPARATOR"]
+
+            schema_name = f"{self.conn_info['NAMESPACE_PREFIX']}{separator}{entity_cls.meta_.schema_name}"
 
         return schema_name
 

tests/adapters/model/elasticsearch_model/tests.py

@@ -136,6 +136,19 @@ class Person(BaseAggregate):
             assert model_cls.__name__ == "PersonModel"
             assert model_cls._index._name == "foo_person"
 
+        def test_generated_index_name_with_namespace_separator(self, test_domain):
+            test_domain.config["DATABASES"]["default"]["NAMESPACE_SEPARATOR"] = "#"
+
+            class Person(BaseAggregate):
+                name = String(max_length=50, required=True)
+                about = Text()
+
+            test_domain.register(Person)
+            model_cls = test_domain.get_model(Person)
+
+            assert model_cls.__name__ == "PersonModel"
+            assert model_cls._index._name == "foo#person"
+
         def test_explicit_index_name_with_namespace_prefix(self, test_domain):
             class Person(BaseAggregate):
                 name = String(max_length=50, required=True)

tests/adapters/model/sqlalchemy_model/postgresql/test_lookups.py

@@ -51,6 +51,6 @@ def test_in_lookup(self, test_domain):
 
         assert (
             str(expr.compile())
-            == "public.generic_postgres.role IN ([POSTCOMPILE_role_1])"
+            == "public.generic_postgres.role IN (__[POSTCOMPILE_role_1])"
         )
         assert expr.compile().params == {"role_1": ["foo", "bar", "baz"]}