support_table 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6446caaf1ed0561e4fc98214a72e30fae6fc70aa7ef868aa6e6a17f4dc4f621
-  data.tar.gz: 9f7739af82443b3279bf74cb1262370284fc0c3554f42a3dc1d5d254c176d4a5
+  metadata.gz: ec98ef0a0766ba05d7b2e7549e4bf334ed0a897ef33b9dc4dad9b4dc22d09be3
+  data.tar.gz: d9ccf2f45ba8e081d9628bd582adca1bd2b35962a566898e5324d907f1d34677
 SHA512:
-  metadata.gz: ddb606d4d8674bb335dad19888ee531aafe2d8790396bbfde7ab6ea574fb20b3b01aa0d599ac2f43720d6ecca1709f0318c2ab42f4f9749c259f1b75462ae451
-  data.tar.gz: 22cfa034d8062e57d5e7eff49a532f97d293bb2a7847392f57388ebc7e40530df91dfd452be58131e45c3fd6798a39bcb3215a5d8775307e878e0fd19327ac05
+  metadata.gz: 046af81a21a3295ecfe9154a2eeed550fadf8fb46c291477dd0db88e29249f3ab6c94854dede0f44b0b59f0a3c7bc83436b59b13c7b3dec9c208ad555a448ee8
+  data.tar.gz: 8683d3986451d309a952bea1a105e6c054b7cfe715647fc09db5b83ec464e3ca55118014e8f740a19478cfa67f637ed721892853b6b6d888d3ac5227d434ede9

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.1
+
+### Fixed
+
+- Passing `cache: nil` to the `support_table` method now disables caching as documented. Previously it fell back to using the global cache.
+
 ## 1.0.0
 
 ### Added

data/README.md

@@ -104,10 +104,10 @@ Data will be automatically synced to the database whenever you run any of the fo
 
 You can also manually trigger synchronization with the `support_table_data:sync` rake task.
 
-You **must** popululate the support table data in your test database during your deploy process or test suite setup to ensure that the data is present when your application code runs.
+You **must** populate the support table data in your test database during your deploy process or test suite setup to ensure that the data is present when your application code runs.
 
 > [!TIP]
-> You can also call `SupportTable.sync_all!` in from your application code to synchronize the data.
+> You can also call `SupportTable.sync_all!` from your application code to synchronize the data.
 
 #### Advanced Data Settings
 
@@ -115,7 +115,7 @@ You can customize the behavior of the support table data syncing by passing opti
 
 ##### Key Attribute
 
-One of the attributes on the table will be used as the unique identifier for each row in the YAML file. By default, this is will be the primary key on the table. You can set a different attribute by passing the `key_attribute` option.
+One of the attributes on the table will be used as the unique identifier for each row in the YAML file. By default, this will be the `id` attribute. You can set a different attribute by passing the `key_attribute` option.
 
 ```ruby
 class Status < ApplicationRecord
@@ -140,6 +140,8 @@ class Status < ApplicationRecord
 end
 ```
 
+You can pass `data_file: false` if you don't want to load data from the default data file.
+
 You can also change the base directory for all support table data files by setting `SupportTable.data_directory` in your application configuration (e.g., in an initializer).
 
 ```ruby
@@ -186,7 +188,10 @@ You can use any of the DSL methods defined in that gem to further customize how
 
 ### Caching
 
-Support table data is often read frequently but changes rarely. To improve performance, lookups from support tables by the key attribute are cached by default. Any query that queries a record by the key attribute (i.e. `find_by(name: "Draft")` if `name` is the key attribute) will use the cache. The `id` column is also always cacheable so `find(1)` or `find_by(id: 1)` will also use the cache.
+Support table data is often read frequently but changes rarely. To improve performance, lookups from support tables by the key attribute are cached by default. Any `find_by` query that looks up a record by the key attribute (i.e. `find_by(name: "Draft")` if `name` is the key attribute) will use the cache. The `id` column is also always cacheable so `find_by(id: 1)` will also use the cache.
+
+> [!NOTE]
+> Only `find_by`, `find_by!`, and `fetch_by` lookups use the cache. Calling `find(1)` will always query the database.
 
 You can use the `fetch_by` method to better express in your code that the lookup is using a cache. This method is an alias for `find_by` except that it will raise an error if the lookup is not using a cache on that attribute.
 
@@ -242,6 +247,9 @@ class Status < ApplicationRecord
 end
 ```
 
+> [!NOTE]
+> Disabling the cache only affects `find_by` lookups on the model itself. Other models with a `belongs_to_support_table` association to the model may still cache the association reads in the global cache.
+
 You can specify the value `:memory` to use an in memory cache. This is the default behavior.
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/support_table/definition.rb

@@ -1,4 +1,4 @@
-# frozen_string_leteral: true
+# frozen_string_literal: true
 
 module SupportTable
   # Class to define support table behavior on an ActiveRecord class.
@@ -61,7 +61,7 @@ module SupportTable
     end
 
     def setup_caching(cache_by, cache, ttl)
-      if cache == false
+      if cache == false || cache.nil?
         klass.send(:cache_by, false)
         return
       end

data/lib/support_table.rb

@@ -43,16 +43,16 @@ module SupportTable
     # you need to override any of the defaults. See SupportTableData and SupportTableCache
     # for more details.
     #
-    # @param data_file [String, Array<String>, nil] Path to the data file to use to load the table. This
+    # @param data_file [String, Array<String>, false, nil] Path to the data file to use to load the table. This
     #   should be a YAML, JSON, or CSV file that defines the records that should always exist in
     #   the table. If no value is specified, then a YAML file in the data directory with the
     #   same name as the underscored, pluralized name of the class will be used. For example,
     #   if the class name is `Task::Status`, then it will look for the file `task/statuses.yml`
-    #   in the `db/support_tables` directory.
+    #   in the `db/support_tables` directory. You can pass `false` to disable loading the
+    #   default data file.
     #
     # @param key_attribute [String, Symbol, nil] The name of the attribute in the data file that
-    #   uniquely identifies each row in the data. By default this will be the primary key
-    #   attribute of the table (usually `id`).
+    #   uniquely identifies each row in the data. By default this will be the `id` attribute.
     #
     # @param attribute_helpers [String, Symbol, Array<String, Symbol>, nil] List of attributes
     #   which should have helper methods created for them. This generates methods for each named instance
@@ -65,10 +65,11 @@ module SupportTable
     #
     # @param cache [ActiveSupport::Cache::Store, Symbol, Boolean, nil] The caching mechanism to use.
     #   This can be either an instance of `ActiveSupport::Cache::Store` like `Rails.cache`, or
-    #   the value `:memory` to use an in-memory cache, or `false` to disable caching.
+    #   the value `:memory` to use an in-memory cache, or `false` or `nil` to disable caching.
     #
+    # @param ttl [Numeric, ActiveSupport::Duration, nil] The time-to-live (in seconds) for cached
+    #   records. If not specified, cached records never expire.
     #
-    # @param ttl [Numeric, ActiveSupport::Duration, nil] The time-to-live (in seconds) for cached records. If not specified,
     # @return [void]
     def support_table(data_file: nil, key_attribute: nil, attribute_helpers: nil, cache_by: nil, cache: :memory, ttl: nil)
       SupportTable::Definition.new(self).support_table(

data/support_table.gemspec

@@ -35,8 +35,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_dependency "support_table_cache", "~> 1.1", ">= 1.1.5"
   spec.add_dependency "support_table_data", "~> 1.5", ">= 1.5.0"
-
-  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: support_table
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
@@ -49,20 +49,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 email:
 - bbdurand@gmail.com
 executables: []
@@ -91,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="