Organize code part 2 (#17)

* Organize code

* Organize code

Author: ismailsimsek

opendbt/__init__.py

@@ -10,7 +10,7 @@
 from dbt.contracts.results import RunResult
 from dbt.exceptions import DbtRuntimeError
 
-from opendbt.overrides import patch_dbt
+from opendbt.dbt import patch_dbt
 from opendbt.utils import Utils
 
 ######################

opendbt/dbt/__init__.py

@@ -0,0 +1,18 @@
+import dbt
+from packaging.version import Version
+
+
+def patch_dbt():
+    # ================================================================================================================
+    # Monkey Patching! Override dbt lib AdapterContainer.register_adapter method with new one above
+    # ================================================================================================================
+    if Version(dbt.version.get_installed_version().to_version_string(skip_matcher=True)) < Version("1.8.0"):
+        from opendbt.dbt.v17.task.docs.generate import OpenDbtGenerateTask
+        from opendbt.dbt.v17.adapters.factory import OpenDbtAdapterContainer
+        dbt.task.generate.GenerateTask = OpenDbtGenerateTask
+        dbt.adapters.factory.FACTORY = OpenDbtAdapterContainer()
+    else:
+        from opendbt.dbt.v18.task.docs.generate import OpenDbtGenerateTask
+        from opendbt.dbt.v18.adapters.factory import OpenDbtAdapterContainer
+        dbt.task.docs.generate.GenerateTask = OpenDbtGenerateTask
+        dbt.adapters.factory.FACTORY = OpenDbtAdapterContainer()

opendbt/dbt/v17/__init__.py

@@ -0,0 +1,64 @@
+import importlib
+from importlib import import_module
+
+from dbt.adapters import factory
+from dbt.adapters.factory import Adapter
+from dbt.events.functions import fire_event
+from dbt.events.types import AdapterRegistered
+from dbt.semver import VersionSpecifier
+
+
+class OpenDbtAdapterContainer(factory.AdapterContainer):
+    DBT_CUSTOM_ADAPTER_VAR = 'dbt_custom_adapter'
+    def register_adapter(self, config: 'AdapterRequiredConfig') -> None:
+        # ==== CUSTOM CODE ====
+        # ==== END CUSTOM CODE ====
+        adapter_name = config.credentials.type
+        adapter_type = self.get_adapter_class_by_name(adapter_name)
+        adapter_version = import_module(f".{adapter_name}.__version__", "dbt.adapters").version
+        # ==== CUSTOM CODE ====
+        custom_adapter_class_name: str = self.get_custom_adapter_config_value(config)
+        if custom_adapter_class_name and custom_adapter_class_name.strip():
+            # OVERRIDE DEFAULT ADAPTER BY USER GIVEN ADAPTER CLASS
+            adapter_type = self.get_custom_adapter_class_by_name(custom_adapter_class_name)
+        # ==== END CUSTOM CODE ====
+        adapter_version_specifier = VersionSpecifier.from_version_string(
+            adapter_version
+        ).to_version_string()
+        fire_event(
+            AdapterRegistered(adapter_name=adapter_name, adapter_version=adapter_version_specifier)
+        )
+        with self.lock:
+            if adapter_name in self.adapters:
+                # this shouldn't really happen...
+                return
+
+            adapter: Adapter = adapter_type(config)  # type: ignore
+            self.adapters[adapter_name] = adapter
+
+    def get_custom_adapter_config_value(self, config: 'AdapterRequiredConfig') -> str:
+        # FIRST: it's set as cli value: dbt run --vars {'dbt_custom_adapter': 'custom_adapters.DuckDBAdapterV1Custom'}
+        if hasattr(config, 'cli_vars') and self.DBT_CUSTOM_ADAPTER_VAR in config.cli_vars:
+            custom_adapter_class_name: str = config.cli_vars[self.DBT_CUSTOM_ADAPTER_VAR]
+            if custom_adapter_class_name and custom_adapter_class_name.strip():
+                return custom_adapter_class_name
+        # SECOND: it's set inside dbt_project.yml
+        if hasattr(config, 'vars') and self.DBT_CUSTOM_ADAPTER_VAR in config.vars.to_dict():
+            custom_adapter_class_name: str = config.vars.to_dict()[self.DBT_CUSTOM_ADAPTER_VAR]
+            if custom_adapter_class_name and custom_adapter_class_name.strip():
+                return custom_adapter_class_name
+
+        return None
+
+    def get_custom_adapter_class_by_name(self, custom_adapter_class_name: str):
+        if "." not in custom_adapter_class_name:
+            raise ValueError(f"Unexpected adapter class name: `{custom_adapter_class_name}` ,"
+                             f"Expecting something like:`my.sample.library.MyAdapterClass`")
+
+        __module, __class = custom_adapter_class_name.rsplit('.', 1)
+        try:
+            user_adapter_module = importlib.import_module(__module)
+            user_adapter_class = getattr(user_adapter_module, __class)
+            return user_adapter_class
+        except ModuleNotFoundError as mnfe:
+            raise Exception(f"Module of provided adapter not found, provided: {custom_adapter_class_name}") from mnfe

opendbt/dbt/v17/adapters/__init__.py

@@ -0,0 +1,24 @@
+import shutil
+from pathlib import Path
+
+import click
+from dbt.task.generate import GenerateTask
+
+
+class OpenDbtGenerateTask(GenerateTask):
+
+    def deploy_user_index_html(self):
+        # run custom code
+        target = Path(self.config.project_target_path).joinpath("index.html")
+        for dir in self.config.docs_paths:
+            index_html = Path(self.config.project_root).joinpath(dir).joinpath("index.html")
+            if index_html.is_file() and index_html.exists():
+                # override default dbt provided index.html with user index.html file
+                shutil.copyfile(index_html, target)
+                click.echo(f"Using user provided documentation page: {index_html.as_posix()}")
+                break
+
+    def run(self):
+        # Call the original dbt run method
+        super().run()
+        self.deploy_user_index_html()