support_table_data 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7ebdaec82fe24f35650ee6906331233abaf106ec8627e92c003ad4c08692a1
-  data.tar.gz: 95ec232e9ecb03ae9300b0f799c0424beaa7d7c564591ddc54e9dec0b45479b4
+  metadata.gz: 23cac76e97a2a99d97d7c5fba3c79c43d1a3391e1b035eea2e52cb223f211c5b
+  data.tar.gz: d73302038185694e8dd55f55c291f71fbd20f792e02d2a8eff6f1c2bee92f37f
 SHA512:
-  metadata.gz: 6688998b029d42da0e82d5046386c033e8472ba49f869d3a573ca339c169bae3b5801c23d9018a9e4472427035e2a61883207919935f822c2115f98d4efd45b1
-  data.tar.gz: '02398f8ed62df1a2c035aeab8b00ed453a1185c9e03717eb98af60aee429bc7d523343b1f5ea346bfa072a85ac6b5e29839137713e6f096def8d01f093547d76'
+  metadata.gz: c4c317e39dd17d1bba310af7067e534a9c8fb63b85625d6d6eef36dc06d8de4d2427cdc08b450721ee99fb027cf4b76f5e7a51fdf0ef488a90bf6a29b0b15b36
+  data.tar.gz: 7510b5ec898006085aa9686d179ff0a50c6a87d74c26db63c82fbc284e46357111169cfe60aecacf27b8db4c3881ce2c3024acf890ead31d959eaa5a860ff0a8

data/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.3.0
+
+### Added
+
+- Added `support_table_dependency` method to explicitly define support table dependencies that cannot be inferred from model associations.
+
+## 1.2.4
+
+### Fixed
+
+- Fixed issue with `sync_all!` finding obsolete classes that are no longer defined as support tables in development or test environments.
+
 ## 1.2.3
 
 ### Fixed

data/README.md

@@ -57,6 +57,8 @@ You cannot update the value of the key attribute in a record in the data file. I
 
 You can specify data files as relative paths. This can be done by setting the `SupportTableData.data_directory` value. You can override this value for a model by setting the `support_table_data_directory` attribute on its class. In a Rails application, `SupportTableData.data_directory` will be automatically set to `db/support_tables/`. Otherwise, relative file paths will be resolved from the current working directory. You must define the directory to load relative files from before loading your model classes.
 
+**Note**: If you're using CSV files and Ruby 3.4 or higher, you'll need to include the `csv` gem in your Gemfile since it was removed from the standard library in Ruby 3.4.
+
 ### Named Instances
 
 You can also automatically define helper methods to load instances and determine if they match specific values. This allows you to add more natural ways of referencing specific records.
@@ -212,7 +214,35 @@ Loading data is done inside a database transaction. No changes will be persisted
 
 You can synchronize the data in all models by calling `SupportTableData.sync_all!`. This method will discover all ActiveRecord models that include `SupportTableData` and synchronize each of them. (Note that there can be issues discovering all support table models in a Rails application if eager loading is turned off.) The discovery mechanism will try to detect unloaded classes by looking at the file names in the support table data directory so it's best to stick to standard Rails naming conventions for your data files.
 
-The load order for models will resolve any dependencies between models. So if one model has a `belongs_to` association with another model, then the belongs to model will be loaded first.
+The load order for models will resolve any dependencies between models. So if one model has a `belongs_to` association with another model, then the belongs to model will be loaded first. You can also explicitly define dependencies with the `support_table_dependency` method. If you have a join table between support tables that creates a circular dependency, then you will need to define which model to load first.
+
+```ruby
+class Widget < ApplicationRecord
+  include SupportTableData
+
+  add_support_table_data "widgets.yml"
+
+  has_many :thing_widgets
+  has_many :things, through: :thing_widgets
+end
+
+class Thing < ApplicationRecord
+  include SupportTableData
+
+  add_support_table_data "things.yml"
+
+  has_many :thing_widgets
+  has_many :widgets, through: :thing_widgets
+
+  # The Thing model is responsible for loading the thing_widgets join table by means of the widget_names=
+  # setter method. We need to define the depdenency to ensure widgets are loaded first.
+  support_table_dependency "Widget"
+
+  def widget_names=(widget_names)
+    self.widgets = Widget.where(name: widget_names)
+  end
+end
+```
 
 You need to call `SupportTableData.sync_all!` when deploying your application. This gem includes a rake task `support_table_data:sync` that is suitable for hooking into deploy scripts. An easy way to hook it into a Rails application is by enhancing the `db:migrate` task so that the sync task runs immediately after database migrations are run. You can do this by adding code to a Rakefile in your application's `lib/tasks` directory:
 

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.3.0

data/lib/support_table_data.rb

@@ -15,6 +15,7 @@ module SupportTableData
     @support_table_attribute_helpers = {}
     @support_table_instance_names = {}
     @support_table_instance_keys = nil
+    @support_table_dependencies = []
 
     # Define the attribute used as the key of the hash in the data files.
     # This should be a value that never changes. By default the key attribute will be the id.
@@ -205,6 +206,20 @@ module SupportTableData
       @protected_keys.include?(instance[key_attribute].to_s)
     end
 
+    # Explicitly define other support tables that this model depends on. A support table depends
+    # on another support table it needs to reference data on that table when loading its own data.
+    # Normally this is handled automatically by looking at the belongs_to associations on the model.
+    # In some cases, though, you may need to explicitly define the relationship. For instance, if
+    # there's a join table between two associations with the data poplulated from one support table's
+    # data file by referencing values maintained by the other support table. In this case,
+    # you need to define the dependency so that the tables are loaded in the correct order.
+    #
+    # @param class_names [String] List of class names that this support table depends on.
+    # @return [void]
+    def support_table_dependency(*class_names)
+      @support_table_dependencies += class_names.flatten.collect(&:to_s)
+    end
+
     private
 
     def define_support_table_named_instances
@@ -380,6 +395,7 @@ module SupportTableData
       active_record_classes = ActiveRecord::Base.descendants.reject { |klass| klass.name.nil? }
       active_record_classes.sort_by(&:name).each do |klass|
         next unless klass.include?(SupportTableData)
+        next unless klass.instance_variable_defined?(:@support_table_data_files) && klass.instance_variable_get(:@support_table_data_files).is_a?(Array)
         next if klass.abstract_class?
         next if classes.include?(klass)
         classes << klass
@@ -404,13 +420,17 @@ module SupportTableData
     #
     # @return [Array<Class>]
     def support_table_dependencies(klass)
-      dependencies = []
+      dependencies = klass.instance_variable_get(:@support_table_dependencies).collect(&:constantize)
 
       klass.reflections.values.each do |reflection|
         next if reflection.polymorphic?
         next unless reflection.klass.include?(SupportTableData)
         next if reflection.klass <= klass
         next unless reflection.belongs_to? || reflection.through_reflection?
+        next if dependencies.include?(reflection.klass)
+
+        explicit_dependencies = reflection.klass.instance_variable_get(:@support_table_dependencies)
+        next if explicit_dependencies&.include?(klass.name)
 
         dependencies << reflection.klass
       rescue => e

data/support_table_data.gemspec

@@ -9,6 +9,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/support_table_data"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: support_table_data
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -56,7 +56,10 @@ files:
 homepage: https://github.com/bdurand/support_table_data
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/bdurand/support_table_data
+  source_code_uri: https://github.com/bdurand/support_table_data
+  changelog_uri: https://github.com/bdurand/support_table_data/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: