Default to cache.yml instead of solid_cache.yml

We'll fall back to the old filename if cache.yml doesn't exist.

Author: djmb

README.md

@@ -9,7 +9,7 @@ Solid Cache is configured by default in new Rails 8 applications. But if you're
 1. `bundle add solid_cache`
 2. `bin/rails solid_cache:install`
 
-This will configure Solid Cache as the production cache store, create `config/solid_cache.yml`, and create `db/cache_schema.rb`.
+This will configure Solid Cache as the production cache store, create `config/cache.yml`, and create `db/cache_schema.rb`.
 
 You will then have to add the configuration for the queue database in `config/database.yml`. If you're using sqlite, it'll look like this:
 
@@ -43,7 +43,7 @@ Then run `db:prepare` in production to ensure the database is created and the sc
 
 ## Configuration
 
-Configuration will be read from `config/solid_cache.yml`. You can change the location of the config file by setting the `SOLID_CACHE_CONFIG` env variable.
+Configuration will be read from `config/cache.yml` or `config/solid_cache.yml`. You can change the location of the config file by setting the `SOLID_CACHE_CONFIG` env variable.
 
 The format of the file is:
 
@@ -169,7 +169,7 @@ production:
 ```
 
 ```yaml
-# config/solid_cache.yml
+# config/cache.yml
 production:
   databases: [cache_shard1, cache_shard2, cache_shard3]
 ```
@@ -179,7 +179,7 @@ production:
 To encrypt the cache values, you can add the encrypt property.
 
 ```yaml
-# config/solid_cache.yml
+# config/cache.yml
 production:
   encrypt: true
 ```

Rakefile

@@ -44,7 +44,7 @@ configs.each do |config|
       if config == :default
         sh("bin/rails test")
       else
-        sh("SOLID_CACHE_CONFIG=config/solid_cache_#{config}.yml bin/rails test")
+        sh("SOLID_CACHE_CONFIG=config/cache_#{config}.yml bin/rails test")
       end
     end
   end

lib/generators/solid_cache/install/install_generator.rb

@@ -4,7 +4,7 @@ class SolidCache::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
   def copy_files
-    template "config/solid_cache.yml"
+    template "config/cache.yml"
     template "db/cache_schema.rb"
   end
 

lib/generators/solid_cache/install/templates/config/solid_cache.yml.tt renamed to lib/generators/solid_cache/install/templates/config/cache.yml.tt

@@ -10,13 +10,16 @@ class Engine < ::Rails::Engine
     config.solid_cache = ActiveSupport::OrderedOptions.new
 
     initializer "solid_cache.config", before: :initialize_cache do |app|
-      app.paths.add "config/solid_cache", with: ENV["SOLID_CACHE_CONFIG"] || "config/solid_cache.yml"
+      config_paths = %w[config/cache config/solid_cache]
 
-      options = {}
-      if (config_path = Pathname.new(app.config.paths["config/solid_cache"].first)).exist?
-        options = app.config_for(config_path).to_h.deep_symbolize_keys
+      config_paths.each do |path|
+        app.paths.add path, with: ENV["SOLID_CACHE_CONFIG"] || "#{path}.yml"
       end
 
+      config_pathname = config_paths.map { |path| Pathname.new(app.config.paths[path].first) }.find(&:exist?)
+
+      options = config_pathname ? app.config_for(config_pathname).to_h.deep_symbolize_keys : {}
+
       options[:connects_to] = config.solid_cache.connects_to if config.solid_cache.connects_to
       options[:size_estimate_samples] = config.solid_cache.size_estimate_samples if config.solid_cache.size_estimate_samples
       options[:encrypt] = config.solid_cache.encrypt if config.solid_cache.encrypt

lib/solid_cache/engine.rb

@@ -18,15 +18,11 @@ class Application < Rails::Application
 
     config.active_record.encryption.key_provider = ActiveRecord::Encryption::EnvelopeEncryptionKeyProvider.new
 
-    if ENV["SOLID_CACHE_CONFIG"] == "config/solid_cache_encrypted_custom.yml"
+    if ENV["SOLID_CACHE_CONFIG"] == "config/cache_encrypted_custom.yml"
       config.solid_cache.encryption_context_properties = {
         encryptor: ActiveRecord::Encryption::Encryptor.new,
         message_serializer: ActiveRecord::Encryption::MessageSerializer.new
       }
     end
-
-    initializer :custom_solid_cache_yml, before: :solid_cache do |app|
-      app.paths.add "config/solid_cache", with: ENV["SOLID_CACHE_CONFIG_PATH"]
-    end
   end
 end