Add custom config class for DB provider source

hanami · timriley · Jul 1, 2024 · Jun 18, 2024 · Jun 22, 2024 · Jun 23, 2024
commit 0bf06979f19df57eeb6f1725d75781a4fcf1d6cd
diff --git a/Gemfile b/Gemfile
@@ -20,8 +20,9 @@ gem "hanami-webconsole", github: "hanami/webconsole", branch: "main"
 
 gem "hanami-devtools", github: "hanami/devtools", branch: "main"
 
-gem "dry-system", github: "dry-rb/dry-system", branch: "main"
+gem "dry-configurable", github: "dry-rb/dry-configurable", branch: "allow-multiple-includes"
 gem "dry-inflector", github: "dry-rb/dry-inflector", branch: "main"
+gem "dry-system", github: "dry-rb/dry-system", branch: "main"
 
 # This is needed for settings specs to pass
 gem "dry-types"

diff --git a/lib/hanami/providers/db.rb b/lib/hanami/providers/db.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "dry/configurable"
 require "dry/core"
 
 module Hanami
@@ -9,6 +10,8 @@ module Providers
     class DB < Dry::System::Provider::Source
       extend Dry::Core::Cache
 
+      include Dry::Configurable(config_class: Providers::DB::Config)
+
       setting :database_url
 
       setting :adapter, default: :sql

diff --git a/lib/hanami/providers/db/config.rb b/lib/hanami/providers/db/config.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Providers
+    class DB < Dry::System::Provider::Source
+      # @api public
+      # @since 2.2.0
+      class Config < Dry::Configurable::Config
+      end
+    end
+  end
+end
diff --git a/spec/integration/db/provider_config_spec.rb b/spec/integration/db/provider_config_spec.rb
@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+RSpec.describe "DB / Provider / Config", :app_integration do
+  before do
+    @env = ENV.to_h
+    allow(Hanami::Env).to receive(:loaded?).and_return(false)
+  end
+
+  after do
+    ENV.replace(@env)
+  end
+
+  it "is a Hanami::Providers::DB::Config" do
+    with_tmp_directory(Dir.mktmpdir) do
+      write "config/app.rb", <<~RUBY
+        require "hanami"
+
+        module TestApp
+          class App < Hanami::App
+          end
+        end
+      RUBY
+
+      write "config/db/.keep", ""
+
+      ENV["DATABASE_URL"] = "sqlite::memory"
+
+      require "hanami/prepare"
+
+      provider = Hanami.app.container.providers[:db]
+      expect(provider.source.config).to be_an_instance_of Hanami::Providers::DB::Config
+    end
+  end
+end