support_table_data 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 524d00657682e8716a8be2ee07d00579d6e9171718e3c48fdd63dff74cca956b
-  data.tar.gz: 0db9f298a33524f6d31872047302d7e08a2c0d321bec3bfd8543be319dc4e5b8
+  metadata.gz: edd9a57acfcdadac9ce60c8520b4fa2d3cccda8bebc2bfe1eeea54981bcf5488
+  data.tar.gz: 31f38443c7edd8af91d3f4de125dbb4a32b8b38612c84ce321633971063fd29b
 SHA512:
-  metadata.gz: 11a0d537e71ecfbfdec261ef4bb4d2d8b1625897ee33263c728c75456e6882de50da9b964e5a5d69213b37041b0c02c315a9ddb0a9bb92e2f9ac8bcd05efafa4
-  data.tar.gz: 1bb84bbd5750d16f9c58736ed2fd70164dfbbc2d3f4cbb9c02b935e774049829081c5982d9322a719a1115fcaf10cbabb7e547765f9dc456ed05b72149da2ab9
+  metadata.gz: d425621345850d9bd2ec8f878eefcbeb667fb6981d2d74b3b2174e3943463bf95470727f3925f83ba966766fe6817ab8e11b5ba9ed30ff9a6c1bb0826229c261
+  data.tar.gz: 152ccc8196e8eb7fd68e5e94cc6dcea5307e98d3e1ef23a1ed9e5e320d0d511beac19494c0242eb1a858ceebc9eba27b29e68023c69476ea5046273e6f9b1445

data/CHANGELOG.md

@@ -4,6 +4,20 @@ 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.2.0
+
+### Added
+
+- Added `named_instance` method to load a named instance from the database.
+- Added class method `named_instance_data` to return attributes from the data files for a named instance.
+- Added handling for `has_many through` associations to load the dependent through associations first.
+
+## 1.1.2
+
+### Fixed
+
+- Ignore anonymous ActiveRecord classes when calling `sync_all!`.
+
 ## 1.1.1
 
 - Freeze values returned from helper methods.

data/README.md

@@ -2,6 +2,7 @@
 
 [![Continuous Integration](https://github.com/bdurand/support_table_data/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/support_table_data/actions/workflows/continuous_integration.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/support_table_data.svg)](https://badge.fury.io/rb/support_table_data)
 
 This gem provides a mixin for ActiveRecord support table models that allows you to load data from YAML, JSON, or CSV files and reference specific records more easily. It is intended to solve issues with support tables (also known as lookup tables) that contain a small set of canonical data that must exist for your application to work.
 
@@ -119,6 +120,55 @@ Status.in_progress_id # => 2
 Status.completed_id   # => 3
 ```
 
+You can also use named instances to maintain associations between you models. In order to do this you'll need to implement a custom setter method.
+
+```ruby
+class Group < ApplicationRecord
+  include SupportTableData
+
+  has_many :statuses
+end
+
+class Status < ApplicationRecord
+  include SupportTableData
+
+  belongs_to :group
+
+  def group_name=(instance_name)
+    self.group = Group.named_instance(instance_name)
+  end
+end
+```
+
+This then allows you to reference groups by instance name in the statuses.yml file:
+
+```yaml
+# groups.yml
+not_done:
+  id: 1
+  name: Not Done
+
+done:
+  id: 2
+  name: Done
+
+# statuses.yml
+pending:
+  id: 1
+  name: Pending
+  group_name: not_done
+
+in_progress:
+  id: 2
+  name: In Progress
+  group_name: not_done
+
+completed:
+  id: 3
+  name: Completed
+  group_name: done
+```
+
 ### Caching
 
 You can use the companion [support_table_cache gem](https://github.com/bdurand/support_table_cache) to add caching support to your models. That way your application won't need to constantly query the database for records that will never change.
@@ -162,6 +212,8 @@ 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.
+
 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:
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/lib/support_table_data.rb

@@ -8,7 +8,24 @@
 module SupportTableData
   extend ActiveSupport::Concern
 
-  module ClassMethods
+  included do
+    # Internal variables used for memoization.
+    @support_table_data_files = []
+    @support_table_attribute_helpers = {}
+    @support_table_instance_names = {}
+    @support_table_instance_keys = nil
+
+    # 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.
+    class_attribute :support_table_key_attribute, instance_accessor: false
+
+    # Define the directory where data files should be loaded from. This value will override the global
+    # value set by SupportTableData.data_directory. This is only used if relative paths are passed
+    # in to add_support_table_data.
+    class_attribute :support_table_data_directory, instance_accessor: false
+  end
+
+  class_methods do
     # Synchronize the rows in the table with the values defined in the data files added with
     # `add_support_table_data`. Note that rows will not be deleted if they are no longer in
     # the data files.
@@ -28,7 +45,7 @@ module SupportTableData
             key = record[key_attribute].to_s
             attributes = canonical_data.delete(key)
             attributes&.each do |name, value|
-              record.send("#{name}=", value) if record.respond_to?("#{name}=", true)
+              record.send(:"#{name}=", value) if record.respond_to?(:"#{name}=", true)
             end
             if record.changed?
               changes << record.changes
@@ -39,7 +56,7 @@ module SupportTableData
           canonical_data.each_value do |attributes|
             record = new
             attributes.each do |name, value|
-              record.send("#{name}=", value) if record.respond_to?("#{name}=", true)
+              record.send(:"#{name}=", value) if record.respond_to?(:"#{name}=", true)
             end
             changes << record.changes
             record.save!
@@ -58,7 +75,6 @@ module SupportTableData
     #   this model or the global directory set with SupportTableData.data_directory.
     # @return [void]
     def add_support_table_data(data_file_path)
-      @support_table_data_files ||= []
       root_dir = (support_table_data_directory || SupportTableData.data_directory || Dir.pwd)
       @support_table_data_files << File.expand_path(data_file_path, root_dir)
       define_support_table_named_instances
@@ -72,7 +88,6 @@ module SupportTableData
     # @param attributes [String, Symbol] The names of the attributes to add helper methods for.
     # @return [void]
     def named_instance_attribute_helpers(*attributes)
-      @support_table_attribute_helpers ||= {}
       attributes.flatten.collect(&:to_s).each do |attribute|
         @support_table_attribute_helpers[attribute] = []
       end
@@ -84,7 +99,6 @@ module SupportTableData
     #
     # @return [Array<String>] List of attribute names.
     def support_table_attribute_helpers
-      @support_table_attribute_helpers ||= {}
       @support_table_attribute_helpers.keys
     end
 
@@ -92,7 +106,6 @@ module SupportTableData
     #
     # @return [Array<Hash>] List of attributes for all records in the data files.
     def support_table_data
-      @support_table_data_files ||= []
       data = {}
       key_attribute = (support_table_key_attribute || primary_key).to_s
 
@@ -114,25 +127,57 @@ module SupportTableData
       data.values
     end
 
+    # Get the data for a named instances from the data files.
+    #
+    # @return [Hasn] Hash of named instance attributes.
+    def named_instance_data(name)
+      data = {}
+      name = name.to_s
+
+      @support_table_data_files.each do |data_file_path|
+        file_data = support_table_parse_data_file(data_file_path)
+        next unless file_data.is_a?(Hash)
+
+        file_data.each do |instance_name, attributes|
+          next unless name == instance_name.to_s
+          next unless attributes.is_a?(Hash)
+
+          data.merge!(attributes)
+        end
+      end
+
+      data
+    end
+
     # Get the names of all named instances.
     #
     # @return [Array<String>] List of all instance names.
     def instance_names
-      @support_table_instance_names ||= Set.new
-      @support_table_instance_names.to_a
+      @support_table_instance_names.keys
+    end
+
+    # Load a named instance from the database.
+    #
+    # @param instance_name [String, Symbol] The name of the instance to load as defined in the data files.
+    # @return [ActiveRecord::Base] The instance loaded from the database.
+    # @raise [ActiveRecord::RecordNotFound] If the instance does not exist.
+    def named_instance(instance_name)
+      key_attribute = (support_table_key_attribute || primary_key).to_s
+      instance_name = instance_name.to_s
+      find_by!(key_attribute => @support_table_instance_names[instance_name])
     end
 
     # Get the key values for all instances loaded from the data files.
     #
     # @return [Array] List of all the key attribute values.
     def instance_keys
-      unless defined?(@support_table_instance_keys)
+      if @support_table_instance_keys.nil?
         key_attribute = (support_table_key_attribute || primary_key).to_s
         values = []
         support_table_data.each do |attributes|
           key_value = attributes[key_attribute]
           instance = new
-          instance.send("#{key_attribute}=", key_value)
+          instance.send(:"#{key_attribute}=", key_value)
           values << instance.send(key_attribute)
         end
         @support_table_instance_keys = values.uniq
@@ -157,9 +202,6 @@ module SupportTableData
     private
 
     def define_support_table_named_instances
-      @support_table_data_files ||= []
-      @support_table_instance_names ||= Set.new
-
       @support_table_data_files.each do |file_path|
         data = support_table_parse_data_file(file_path)
         next unless data.is_a?(Hash)
@@ -188,7 +230,7 @@ module SupportTableData
       unless @support_table_instance_names.include?(method_name)
         define_support_table_instance_helper(method_name, key_attribute, key_value)
         define_support_table_predicates_helper("#{method_name}?", key_attribute, key_value)
-        @support_table_instance_names << method_name
+        @support_table_instance_names[method_name] = key_value
       end
 
       if defined?(@support_table_attribute_helpers)
@@ -203,8 +245,6 @@ module SupportTableData
     end
 
     def define_support_table_instance_helper(method_name, attribute_name, attribute_value)
-      return if @support_table_instance_names.include?("self.#{method_name}")
-
       if respond_to?(method_name, true)
         raise ArgumentError.new("Could not define support table helper method #{name}.#{method_name} because it is already a defined method")
       end
@@ -217,8 +257,6 @@ module SupportTableData
     end
 
     def define_support_table_instance_attribute_helper(method_name, attribute_value)
-      return if @support_table_instance_names.include?("self.#{method_name}")
-
       if respond_to?(method_name, true)
         raise ArgumentError.new("Could not define support table helper method #{name}.#{method_name} because it is already a defined method")
       end
@@ -231,8 +269,6 @@ module SupportTableData
     end
 
     def define_support_table_predicates_helper(method_name, attribute_name, attribute_value)
-      return if @support_table_instance_names.include?(method_name)
-
       if method_defined?(method_name) || private_method_defined?(method_name)
         raise ArgumentError.new("Could not define support table helper method #{name}##{method_name} because it is already a defined method")
       end
@@ -268,17 +304,6 @@ module SupportTableData
     end
   end
 
-  included do
-    # 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.
-    class_attribute :support_table_key_attribute, instance_accessor: false
-
-    # Define the directory where data files should be loaded from. This value will override the global
-    # value set by SupportTableData.data_directory. This is only used if relative paths are passed
-    # in to add_support_table_data.
-    class_attribute :support_table_data_directory, instance_accessor: false
-  end
-
   class << self
     # Specify the default directory for data files.
     attr_writer :data_directory
@@ -345,7 +370,8 @@ module SupportTableData
         end
       end
 
-      ActiveRecord::Base.descendants.sort_by(&:name).each do |klass|
+      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 if klass.abstract_class?
         next if classes.include?(klass)
@@ -372,11 +398,16 @@ module SupportTableData
     # @return [Array<Class>]
     def support_table_dependencies(klass)
       dependencies = []
-      klass.reflections.values.select(&:belongs_to?).each do |reflection|
-        if reflection.klass.include?(SupportTableData) && !(reflection.klass <= klass)
-          dependencies << reflection.klass
-        end
+
+      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?
+
+        dependencies << reflection.klass
       end
+
       dependencies
     end
   end

data/support_table_data.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.5"
+
   spec.add_dependency "activerecord"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: support_table_data
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2024-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -46,7 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- MIT-LICENSE
+- MIT-LICENSE.txt
 - README.md
 - VERSION
 - lib/support_table_data.rb
@@ -65,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="