support_table_data 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93d64b82d63c76b8a0d51232bc39dacb319d5c5304aea0f97899d843fb32b21a
-  data.tar.gz: 8d07ea94b74ea7daf8dd5a863527cdd57c55a0bd301e347dfeb25ec5915208c9
+  metadata.gz: db981a2e7549dc34a3e7f3f7d02f1f441776064619b1b6390bbdd866a62f1872
+  data.tar.gz: 7022a030e3007f37408e2596b813268455e786dc8b92c4c8c7d75b00c06947b0
 SHA512:
-  metadata.gz: 2032fa102c26ffd779b01a75d7cd7c1079b51b33e6afb3677a0b34f879864a60c6895fa6e4795c74f300b4cdd4786e2bb195a43f03c75749f88dec74fdf8b245
-  data.tar.gz: d3877f8a0d8abe36a293ad726471db5336ac0f555b3aa13f41ef1ffb06f457692674f726c4056aae300d97b236b8715bb5a79a19a5c55a601eb7088e4fb1d6be
+  metadata.gz: 14610fa5a3e91cec068aa0ed041d1763e28e75b3446237018ca7c11fd536744800f348fb2a9c89d1ef5c7b0933b182792aebe458032675716388f9ba3ca0bfdd
+  data.tar.gz: d28172a9344033c946aca044af36398be5232a0ad893c9bc2b19d863eff671df8773c5d99f4601dce0c0d5c64def0771bae364b0df28a1aba1b7a747cdafa45c

data/CHANGELOG.md

@@ -4,7 +4,14 @@ 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.1.0
+
+### Added
+
+- Helper methods can defined on the class to expose attributes for named instances without requiring a database connection.
+
 ## 1.0.0
 
 ### Added
+
 - Add SupportTableData concern to enable automatic syncing of data on support tables.

data/README.md

@@ -68,17 +68,17 @@ Here is an example data file using named instances:
 pending:
   id: 1
   name: Pending
-  icon: :clock:
+  icon: clock
 
 in_progress:
   id: 2
   name: In Progress
-  icon: :construction:
+  icon: construction
 
 completed:
   id: 3
   name: Completed
-  icon: :heavy_check_mark:
+  icon: heavy_check_mark
 
 _others:
   - id: 4
@@ -104,6 +104,21 @@ status.completed?   # status.id == 3
 
 Helper methods will not override already defined methods on a model class. If a method is already defined, an `ArgumentError` will be raised.
 
+You can also define helper methods for named instance attributes. These helper methods will return the hard coded values from the data file. Calling these methods does not require a database connection.
+
+
+```ruby
+class Status < ApplicationRecord
+  include SupportTableData
+
+  named_instance_attribute_helpers :id
+end
+
+Status.pending_id     # => 1
+Status.in_progress_id # => 2
+Status.completed_id   # => 3
+```
+
 ### 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.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/support_table_data.rb

@@ -64,6 +64,30 @@ module SupportTableData
       define_support_table_named_instances
     end
 
+    # Add class methods to get attributes for named instances. The methods will be named
+    # like `#{instance_name}_#{attribute_name}`. For example, if the name is "active" and the
+    # attribute is "id", then the method will be "active_id" and you can call
+    # `Model.active_id` to get the value.
+    #
+    # @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
+      define_support_table_named_instances
+    end
+
+    # Get the names of any named instance attribute helpers that have been defined
+    # with `named_instance_attribute_helpers`.
+    #
+    # @return [Array<String>] List of attribute names.
+    def support_table_attribute_helpers
+      @support_table_attribute_helpers ||= {}
+      @support_table_attribute_helpers.keys
+    end
+
     # Get the data for the support table from the data files.
     #
     # @return [Array<Hash>] List of attributes for all records in the data files.
@@ -135,35 +159,52 @@ module SupportTableData
     def define_support_table_named_instances
       @support_table_data_files ||= []
       @support_table_instance_names ||= Set.new
-      key_attribute = (support_table_key_attribute || primary_key).to_s
 
       @support_table_data_files.each do |file_path|
         data = support_table_parse_data_file(file_path)
-        if data.is_a?(Hash)
-          data.each do |key, attributes|
-            method_name = key.to_s.freeze
-            next if method_name.start_with?("_")
+        next unless data.is_a?(Hash)
 
-            unless attributes.is_a?(Hash)
-              raise ArgumentError.new("Cannot define named instance #{method_name} on #{name}; value must be a Hash")
-            end
+        data.each do |name, attributes|
+          define_support_table_named_instance_methods(name, attributes)
+        end
+      end
+    end
 
-            unless method_name.match?(/\A[a-z][a-z0-9_]+\z/)
-              raise ArgumentError.new("Cannot define named instance #{method_name} on #{name}; name contains illegal characters")
-            end
+    def define_support_table_named_instance_methods(name, attributes)
+      method_name = name.to_s.freeze
+      return if method_name.start_with?("_")
 
-            unless @support_table_instance_names.include?(method_name)
-              @support_table_instance_names << method_name
-              key_value = attributes[key_attribute]
-              define_support_table_instance_helper(method_name, key_attribute, key_value)
-              define_support_table_predicates_helper("#{method_name}?", key_attribute, key_value)
-            end
-          end
+      unless attributes.is_a?(Hash)
+        raise ArgumentError.new("Cannot define named instance #{method_name} on #{name}; value must be a Hash")
+      end
+
+      unless method_name.match?(/\A[a-z][a-z0-9_]+\z/)
+        raise ArgumentError.new("Cannot define named instance #{method_name} on #{name}; name contains illegal characters")
+      end
+
+      key_attribute = (support_table_key_attribute || primary_key).to_s
+      key_value = attributes[key_attribute]
+
+      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
+      end
+
+      if defined?(@support_table_attribute_helpers)
+        @support_table_attribute_helpers.each do |attribute_name, defined_methods|
+          attribute_method_name = "#{method_name}_#{attribute_name}"
+          next if defined_methods.include?(attribute_method_name)
+
+          define_support_table_instance_attribute_helper(attribute_method_name, attributes[attribute_name])
+          defined_methods << attribute_method_name
         end
       end
     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
@@ -175,7 +216,23 @@ module SupportTableData
       RUBY
     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
+
+      class_eval <<~RUBY, __FILE__, __LINE__ + 1
+        def self.#{method_name}
+          #{attribute_value.inspect}
+        end
+      RUBY
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: support_table_data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -57,7 +57,7 @@ homepage: https://github.com/bdurand/support_table_data
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: Extension for ActiveRecord models to manage synchronizing data in support/lookup
   tables across environments. Also provides the ability to directly reference and