solid_cache 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0649423e526a66fa9554f73d215e7e49c6ff093c004c1641d72a670a33688468'
-  data.tar.gz: ad56d9f53b6b0c6f9dcc049771a187e95c5e2cceeabeaa07286f96212f5b0fb7
+  metadata.gz: 98f4ca743bf44353244b4e1bb870df48b426fcb8b082941ad0f07e150f05cffb
+  data.tar.gz: 85a3660e7c8b63b8f838039228b887f6a4ecde5d17401707f243804efb7f98d6
 SHA512:
-  metadata.gz: 900011771476bff6c3b3ec5abe087a0dcf00596f6e200dec961aa7e13f3ad4d978d9ac8858d3912b8bc0bc63a8742de4e925bd04b120d15badb890448946f4c2
-  data.tar.gz: c9fd66e658ec1e38f628c592053f330179571a7299a1d4e6bae88a959996c10c4d7df158c30c9827464e0c3af526a4b5c0100f55f51c5b3e563e73b5af93226a
+  metadata.gz: 2251bc348573da1c8492f299cd7fadbd87450ad22252ae388b25c842b71bf6cf6525d40243587d3c2951c8af1a71fb0ac42af6eedde767465ab08a7cfcfbe9b6
+  data.tar.gz: 1e69812734160e29b7ae9430303243f23f09f24a75440da61e7dd5d0efd0ac6e4934e0d7a6566791c60f3cf1d88e8d45364f9904bd60b742f16aa8241e0c1fbb

data/README.md

@@ -1,6 +1,6 @@
 # Solid Cache
 
-Solid Cache is a database-backed Active Support cache store implementation. 
+Solid Cache is a database-backed Active Support cache store implementation.
 
 Using SQL databases backed by SSDs we can have caches that are much larger and cheaper than traditional memory only Redis or Memcached backed caches.
 
@@ -58,7 +58,7 @@ $ bin/rails db:migrate
 There are two 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. Requires for sharding and/or using a separate cache database to the main app.
+- `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.
 
 These can be set in your Rails configuration:
 
@@ -81,7 +81,7 @@ Solid Cache supports these options in addition to the standard `ActiveSupport::C
 - `expiry_batch_size` - the batch size to use when deleting old records (default: `100`)
 - `expiry_method` - what expiry method to use `thread` or `job` (default: `thread`)
 - `max_age` - the maximum age of entries in the cache (default: `2.weeks.to_i`)
-- `max_entries` - the maximum number of entries allowed in the cache (default: `2.weeks.to_i`)
+- `max_entries` - the maximum number of entries allowed in the cache (default: `nil`, meaning no limit)
 - `cluster` - a Hash of options for the cache database cluster, e.g `{ shards: [:database1, :database2, :database3] }`
 - `clusters` - and Array of Hashes for multiple cache clusters (ignored if `:cluster` is set)
 - `active_record_instrumentation` - whether to instrument the cache's queries (default: `true`)
@@ -92,7 +92,7 @@ For more information on cache clusters see [Sharding the cache](#sharding-the-ca
 
 ### Cache expiry
 
-Solid Cache tracks writes to the cache. For every write it increments a counter by 1. Once the counter reaches 80% of the `expiry_batch_size` it add a task to run on a background thread. That task will:
+Solid Cache tracks writes to the cache. For every write it increments a counter by 1. Once the counter reaches 80% of the `expiry_batch_size` it adds a task to run on a background thread. That task will:
 
 1. Check if we have exceeded the `max_entries` value (if set) by subtracting the max and min IDs from the `SolidCache::Entry` table (this is an estimate that ignores any gaps).
 2. If we have it will delete `expiry_batch_size` entries
@@ -109,7 +109,7 @@ If you want the cache expiry to be run in a background job instead of a thread,
 Add database configuration to database.yml, e.g.:
 
 ```
-development
+development:
   cache:
     database: cache_development
     host: 127.0.0.1
@@ -135,7 +135,7 @@ $ mv db/migrate/*.solid_cache.rb db/cache/migrate
 Set the engine configuration to point to the new database:
 ```
 Rails.application.configure do
-  config.solid_cache.connects_to = { default: { writing: :cache } }
+  config.solid_cache.connects_to = { database: { writing: :cache } }
 end
 ```
 
@@ -250,19 +250,48 @@ The Solid Cache migrations try to create an index with 1024 byte entries. If tha
 
 ## Development
 
-Run the tests with `bin/rails test`. These will run against SQLite.
+Run the tests with `bin/rails test`. By default, these will run against SQLite.
 
-You can also run the tests against MySQL and Postgres. First start up the databases:
+You can also run the tests against MySQL and PostgreSQL. First start up the databases:
 
 ```shell
 $ docker compose up -d
 ```
 
-Then run the tests for the target database
+Next, setup the database schema:
+
+```shell
+$ TARGET_DB=mysql bin/rails db:setup
+$ TARGET_DB=postgres bin/rails db:setup
 ```
+
+
+Then run the tests for the target database:
+
+```shell
 $ TARGET_DB=mysql bin/rails test
 $ TARGET_DB=postgres bin/rails test
 ```
 
+### Testing with multiple Rails version
+
+Solid Cache relies on [appraisal](https://github.com/thoughtbot/appraisal/tree/main) to test
+multiple Rails version.
+
+To run a test for a specific version run:
+
+```shell
+bundle exec appraisal rails-7-1 bin/rails test
+```
+
+After updating the dependencies in then `Gemfile` please run:
+
+```shell
+$ bundle
+$ appraisal update
+```
+
+This ensures that all the Rails versions dependencies are updated.
+
 ## License
 Solid Cache is licensed under MIT.

data/app/models/solid_cache/entry.rb

@@ -21,10 +21,6 @@ module SolidCache
         select_all_no_query_cache(get_all_sql(serialized_keys), serialized_keys).to_h
       end
 
-      def expire(ids)
-        delete_no_query_cache(:id, ids) if ids.any?
-      end
-
       def delete_by_key(key)
         delete_no_query_cache(:key, to_binary(key))
       end
@@ -78,8 +74,12 @@ module SolidCache
           message = +"#{self} "
           message << "Bulk " if attributes.many?
           message << "Upsert"
-          # exec_query does not clear the query cache, exec_insert_all does
-          connection.exec_query sql, message
+          # exec_query_method does not clear the query cache, exec_insert_all does
+          connection.send exec_query_method, sql, message
+        end
+
+        def exec_query_method
+          connection.respond_to?(:internal_exec_query) ? :internal_exec_query : :exec_query
         end
 
         def upsert_unique_by

data/lib/solid_cache/maglev_hash.rb

@@ -4,7 +4,7 @@ module SolidCache
   class MaglevHash
     attr_reader :nodes
 
-    #  Must be prime
+    # Must be prime
     TABLE_SIZE = 2053
 
     def initialize(nodes)

data/lib/solid_cache/store/api.rb

@@ -88,7 +88,14 @@ module SolidCache
             if entry.expired?
               delete_entry(key, **options)
             elsif !entry.mismatched?(version)
-              results[name] = entry.value
+              if defined? ActiveSupport::Cache::DeserializationError
+                begin
+                  results[name] = entry.value
+                rescue ActiveSupport::Cache::DeserializationError
+                end
+              else
+                results[name] = entry.value
+              end
             end
           end
         end

data/lib/solid_cache/version.rb

@@ -1,3 +1,3 @@
 module SolidCache
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Donal McBreen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: A database backed ActiveSupport::Cache::Store