solid_cache 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4166bf227d59acde335e056a12f2a382863fe469fa8417827e19da72bc12fb7b
-  data.tar.gz: af1066a13d699e9ca3716c7b8b12f0b50e379b5cc5940757f613c51a08b9114a
+  metadata.gz: 1cf02364d38d08f18cbe3d9811a7957018ec23ebaf08951c51110204eea237de
+  data.tar.gz: c04b221f9c37fdc78f78e07143afe33bc1d346695ef8c910dc986533dd460a38
 SHA512:
-  metadata.gz: 8fe05aebd5d0279edb79654b8cd432efc78232d5f998b661d8026b23dcfb7ab73de74c407ce2594a15d01809a377711fb7bb8ffb060823619341ac0020564973
-  data.tar.gz: 78995f9165d9f0c3da70bfe8499d89cf4fefb17cd7a5c8d0971815e21688ff71303b9da040a301aed7cf6bac46d6a6245c32657d170e4b1631278327715d110f
+  metadata.gz: 725fa1c931e54f8aa743aa8311fd05f44fe200904ede83bcb1207377f54926c330abe887a2dfb04c956f703f8e673b38f8af219a31e04c2f1d653cdbe0b980db
+  data.tar.gz: 6d793397978b7d1e1797ed4b97726dc25c1e053a8a8dc2aa9b39669bbb79c3a9d7b9d0d676e43bea4f1a401ae7528a1aee34c5985899e96e092b86c1be4c2f0a

data/README.md

@@ -8,13 +8,42 @@ 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`
-3. `bin/rails db:migrate`
 
-This will configure Solid Queue as the production cache store, create `config/solid_cache.yml`, and alter `config/database.yml` to include the new cache database.
+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:
+
+```yaml
+production:
+  primary:
+    <<: *default
+    database: storage/production.sqlite3
+  cache:
+    <<: *default
+    database: storage/production_cache.sqlite3
+    migrations_paths: db/cache_migrate
+```
+
+...or if you're using MySQL/PostgreSQL/Trilogy:
+
+```yaml
+production:
+  primary: &primary_production
+    <<: *default
+    database: app_production
+    username: app
+    password: <%= ENV["APP_DATABASE_PASSWORD"] %>
+  cache:
+    <<: *primary_production
+    database: app_production_cache
+    migrations_paths: db/cache_migrate
+```
+
+Then run `db:prepare` in production to ensure the database is created and the schema is loaded.
 
 ## 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:
 
@@ -62,7 +91,7 @@ If none of these are set, Solid Cache will use the `ActiveRecord::Base` connecti
 
 ### Engine configuration
 
-There are three options that can be set on the engine:
+There are five options that can be set on the engine:
 
 - `executor` - the [Rails executor](https://guides.rubyonrails.org/threading_and_code_execution.html#executor) used to wrap asynchronous operations, defaults to the app executor
 - `connects_to` - a custom connects to value for the abstract `SolidCache::Record` active record model. Required for sharding and/or using a separate cache database to the main app. This will overwrite any value set in `config/solid_cache.yml`
@@ -140,17 +169,17 @@ production:
 ```
 
 ```yaml
-# config/solid_cache.yml
+# config/cache.yml
 production:
   databases: [cache_shard1, cache_shard2, cache_shard3]
 ```
 
 ## Enabling encryption
 
-To encrypt the cache values, you can add set the encrypt property.
+To encrypt the cache values, you can add the encrypt property.
 
 ```yaml
-# config/solid_cache.yml
+# config/cache.yml
 production:
   encrypt: true
 ```
@@ -178,11 +207,6 @@ config.solid_cache.encryption_context_properties = {
 }
 ```
 
-**Note**
-
-Encryption currently does not work for PostgreSQL, as Rails does not yet support encrypting binary columns for it.
-See https://github.com/rails/rails/pull/52650.
-
 ## Index size limits
 The Solid Cache migrations try to create an index with 1024 byte entries. If that is too big for your database, you should:
 

data/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

data/app/models/solid_cache/entry/expiration.rb

@@ -40,6 +40,8 @@ module SolidCache
                 candidates.pluck(:id)
               else
                 min_created_at = max_age.seconds.ago
+                # We don't have an index on created_at, but we can select
+                # the records by id and they'll be in created_at order.
                 candidates.pluck(:id, :created_at)
                           .filter_map { |id, created_at| id if created_at < min_created_at }
               end

data/lib/generators/solid_cache/install/install_generator.rb

@@ -3,70 +3,13 @@
 class SolidCache::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
-  def add_rails_cache
-    gsub_file app_root.join("config/environments/production.rb"),
-      /(# )?config\.cache_store = (:.*)/, "config.cache_store = :solid_cache_store"
-  end
-
-  def create_config_solid_cache_yml
-    template "config/solid_cache.yml"
-  end
-
-  def add_cache_db_to_database_yml
-    if app_is_using_sqlite?
-      gsub_file database_yml, /production:\s*<<: \*default.*/m, sqlite_database_config_with_cache
-    else
-      gsub_file database_yml, /production:\s*<<: \*default.*/m, generic_database_config_with_cache
-    end
-  end
-
-  def add_solid_cache_db_schema
+  def copy_files
+    template "config/cache.yml"
     template "db/cache_schema.rb"
   end
 
-  private
-    def app_root
-      Pathname.new(destination_root)
-    end
-
-    def database_yml
-      app_root.join("config/database.yml")
-    end
-
-    def app_is_using_sqlite?
-      database_yml.read.match?(/production:.*sqlite3/m)
-    end
-
-    def sqlite_database_config_with_cache
-      <<~YAML
-        production:
-          primary:
-            <<: *default
-            database: storage/production.sqlite3
-          cache:
-            <<: *default
-            database: storage/production_cache.sqlite3
-            migrations_paths: db/cache_migrate
-      YAML
-    end
-
-    def app_name_from_production_database_name
-      database_yml.read.scan(/database: (\w+)_production/).flatten.first
-    end
-
-    def generic_database_config_with_cache
-      app_name = app_name_from_production_database_name
-
-      <<~YAML
-production:
-  primary: &production_primary
-    <<: *default
-    database: #{app_name}_production
-    username: #{app_name}
-    password: <%= ENV["#{app_name.upcase}_DATABASE_PASSWORD"] %>
-  cache:
-    <<: *production_primary
-    database: #{app_name}_production_cache
-      YAML
-    end
+  def configure_cache_store_adapter
+    gsub_file Pathname.new(destination_root).join("config/environments/production.rb"),
+      /(# )?config\.cache_store = (:.*)/, "config.cache_store = :solid_cache_store"
+  end
 end

data/lib/generators/solid_cache/install/templates/db/cache_schema.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ActiveRecord::Schema[8.0].define(version: 1) do
+ActiveRecord::Schema[7.2].define(version: 1) do
   create_table "solid_cache_entries", force: :cascade do |t|
     t.binary "key", limit: 1024, null: false
     t.binary "value", limit: 536870912, null: false

data/lib/solid_cache/configuration.rb

@@ -35,7 +35,7 @@ module SolidCache
         @connects_to =
           case
           when database
-            { database: { writing: database.to_sym } }
+            { shards: { database.to_sym => { writing: database.to_sym } } }
           when databases
             { shards: databases.map(&:to_sym).index_with { |database| { writing: database } } }
           when connects_to

data/lib/solid_cache/engine.rb

@@ -10,13 +10,16 @@ module SolidCache
     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

data/lib/solid_cache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidCache
-  VERSION = "1.0.4"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Donal McBreen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,7 +115,7 @@ files:
 - lib/active_support/cache/solid_cache_store.rb
 - lib/generators/solid_cache/install/USAGE
 - lib/generators/solid_cache/install/install_generator.rb
-- lib/generators/solid_cache/install/templates/config/solid_cache.yml.tt
+- lib/generators/solid_cache/install/templates/config/cache.yml.tt
 - lib/generators/solid_cache/install/templates/db/cache_schema.rb
 - lib/solid_cache.rb
 - lib/solid_cache/configuration.rb

data/lib/generators/solid_cache/install/templates/config/{solid_cache.yml.tt → cache.yml.tt}

@@ -1,5 +1,4 @@
 default: &default
-  database: <%= ENV.fetch("DATABASE", "cache") %>
   store_options:
     # Cap age of oldest cache entry to fulfill retention policies
     # max_age: <%%= 60.days.to_i %>
@@ -13,4 +12,5 @@ test:
   <<: *default
 
 production:
+  database: <%= ENV.fetch("DATABASE", "cache") %>
   <<: *default