dynamic-active-model 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df4da0b0a5a5026754e0624dd508604ac4796ac3f60f37fa82018691fa596f3f
-  data.tar.gz: d42ea5435c3ad98e7bb6e9c4489df62db14b7b6199df3e0247989ad7b8a6a725
+  metadata.gz: a9f8e2e549471211eb31b49e3e20b8a72e1c47eb2e9c857bcb4a85c11e470558
+  data.tar.gz: 70b7edd5ecf3dbe9c164593f1866eb2bd12a9cb89b5c609898052b8ad3f5eee2
 SHA512:
-  metadata.gz: 986938faee17bc087e8260f468bf6c346244e291527c0f827b0ce0e227d079b22c082848eadb202a93d51798124787e496f343c9c4221eec0db652b3d3cb8218
-  data.tar.gz: f0d2af7a8da7d120dc82b3600ed8b3daef0a5d0eb7c581a2fc60dbc205b0440cb27cf01d792ffb0aeaa481756db5d63e603e2548ea3e5153b007c6ebffdce4b8
+  metadata.gz: 90b12783def828937bef5898a020c6e8639fbf72c83a8649f5227077fce087d1fc619bd25f472b70b83dcf6a551bc97386f57c86b76f4fdc401fbe8c92336c11
+  data.tar.gz: c3316c0eb2a01b52e3b2628c913ce1d1d53c6ba7f67a34cbfb879caa820509d5ab676e3a2f78c771ca40a3405f960e65bea4ca9674540fca3192808d32053926

data/lib/dynamic-active-model/associations.rb

@@ -45,8 +45,11 @@ module DynamicActiveModel
     # @param table_name [String] Name of the table with the foreign key
     # @param foreign_key [String] Name of the foreign key column
     # @param relationship_name [String, nil] Custom name for the relationship
+    # @raise [ModelNotFound] If no model exists for the table
     def add_foreign_key(table_name, foreign_key, relationship_name = nil)
-      @foreign_keys[table_name].add(foreign_key, relationship_name)
+      @foreign_keys
+        .fetch(table_name.to_s) { raise ModelNotFound, "no model found for table #{table_name}" }
+        .add(foreign_key, relationship_name)
     end
 
     # Builds all relationships between models based on foreign keys and constraints
@@ -122,29 +125,29 @@ module DynamicActiveModel
 
     # Adds a has_many relationship to a model
     # @param relationship_name [String] Name of the relationship
-    # @param model [Class] The model with the foreign key
-    # @param has_many_model [Class] The model being referenced
+    # @param model [Class] The referenced (parent) model that gets the association
+    # @param has_many_model [Class] The model with the foreign key
     # @param foreign_key [String] The foreign key column name
     def add_has_many(relationship_name, model, has_many_model, foreign_key)
       model.has_many(
         generate_has_many_association_name(relationship_name, model, has_many_model),
         class_name: has_many_model.name,
         foreign_key: foreign_key,
-        primary_key: has_many_model.primary_key
+        primary_key: model.primary_key
       )
     end
 
     # Adds a has_one relationship to a model
     # @param relationship_name [String] Name of the relationship
-    # @param model [Class] The model with the foreign key
-    # @param has_one_model [Class] The model being referenced
+    # @param model [Class] The referenced (parent) model that gets the association
+    # @param has_one_model [Class] The model with the foreign key
     # @param foreign_key [String] The foreign key column name
     def add_has_one(relationship_name, model, has_one_model, foreign_key)
       model.has_one(
         generate_has_one_association_name(relationship_name, model, has_one_model),
         class_name: has_one_model.name,
         foreign_key: foreign_key,
-        primary_key: has_one_model.primary_key
+        primary_key: model.primary_key
       )
     end
 
@@ -161,8 +164,8 @@ module DynamicActiveModel
 
     # Generates an appropriate name for a has_many association
     # @param relationship_name [String] Original relationship name
-    # @param model [Class] The model with the foreign key
-    # @param has_many_model [Class] The model being referenced
+    # @param model [Class] The referenced (parent) model that gets the association
+    # @param has_many_model [Class] The model with the foreign key
     # @return [Symbol] The generated association name
     def generate_has_many_association_name(relationship_name, model, has_many_model)
       name =
@@ -176,8 +179,8 @@ module DynamicActiveModel
 
     # Generates an appropriate name for a has_one association
     # @param relationship_name [String] Original relationship name
-    # @param model [Class] The model with the foreign key
-    # @param has_one_model [Class] The model being referenced
+    # @param model [Class] The referenced (parent) model that gets the association
+    # @param has_one_model [Class] The model with the foreign key
     # @return [Symbol] The generated association name
     def generate_has_one_association_name(relationship_name, model, has_one_model)
       name =
@@ -208,7 +211,7 @@ module DynamicActiveModel
     def join_table?(model)
       model.primary_key.nil? &&
         model.columns.size == 2 &&
-        model.columns.all? { |column| column.name =~ /#{ForeignKey.id_suffix}$/ }
+        model.columns.all? { |column| column.name.end_with?(ForeignKey.id_suffix) }
     end
   end
 end

data/lib/dynamic-active-model/database.rb

@@ -94,15 +94,16 @@ module DynamicActiveModel
       @table_class_names[table_name.to_s] = class_name
     end
 
-    # Creates ActiveRecord models for all included tables
-    # @return [Array] List of created model classes
+    # Creates ActiveRecord models for all included tables that don't have one yet
+    # @return [Array] List of model classes
+    # @raise [ClassNameConflict] If two tables map to the same class name
     def create_models!
       @factory.base_class.connection.tables.each do |table_name|
-        next if skip_table?(table_name)
-        next unless include_table?(table_name)
+        next unless create_model?(table_name)
 
         @models << @factory.create(table_name, @table_class_names[table_name])
       end
+      @models
     end
 
     # @return [Array] List of all skipped tables and patterns
@@ -174,6 +175,13 @@ module DynamicActiveModel
 
     private
 
+    # Checks if a model should be created for a table
+    # @param table_name [String] Name of the table
+    # @return [Boolean] Whether the table is included and has no model yet
+    def create_model?(table_name)
+      !skip_table?(table_name) && include_table?(table_name) && get_model(table_name).nil?
+    end
+
     # Checks if a table should be skipped
     # @param table_name [String] Name of the table
     # @return [Boolean] Whether the table should be skipped

data/lib/dynamic-active-model/explorer.rb

@@ -28,9 +28,11 @@ module DynamicActiveModel
     # @param connection_options [Hash] Database connection options
     # @param skip_tables [Array<String, Regexp>] Tables to exclude from model creation
     # @param relationships [Hash] Custom foreign key relationships to add
+    # @param table_class_names [Hash] Custom class names by table name
     # @return [Database] The configured database instance
-    def self.explore(base_module, connection_options, skip_tables = [], relationships = {})
-      database = create_models!(base_module, connection_options, skip_tables)
+    # @raise [ClassNameConflict] If two tables map to the same class name
+    def self.explore(base_module, connection_options, skip_tables = [], relationships = {}, table_class_names = {})
+      database = create_models!(base_module, connection_options, skip_tables, table_class_names)
       build_relationships!(database, relationships)
       database
     end
@@ -39,17 +41,25 @@ module DynamicActiveModel
     # @param base_module [Module] The namespace for created models
     # @param connection_options [Hash] Database connection options
     # @param skip_tables [Array<String, Regexp>] Tables to exclude from model creation
+    # @param table_class_names [Hash] Custom class names by table name
     # @return [Database] The configured database instance
-    def self.create_models!(base_module, connection_options, skip_tables)
+    def self.create_models!(base_module, connection_options, skip_tables, table_class_names = {})
       database = Database.new(base_module, connection_options)
-      skip_tables.each do |table_name|
-        table_name = Regexp.new("^#{table_name}") if table_name.include?('*')
-        database.skip_table(table_name)
-      end
+      skip_tables.each { |table| database.skip_table(skip_table_matcher(table)) }
+      table_class_names.each { |table_name, class_name| database.table_class_name(table_name, class_name) }
       database.create_models!
       database
     end
 
+    # Converts a table name containing * wildcards into an anchored Regexp
+    # @param table [String, Regexp] Table name, wildcard pattern, or Regexp
+    # @return [String, Regexp] The table name or matching Regexp
+    def self.skip_table_matcher(table)
+      return table unless table.is_a?(String) && table.include?('*')
+
+      Regexp.new("\\A#{Regexp.escape(table).gsub('\\*', '.*')}\\z")
+    end
+
     # Sets up relationships between created models
     # @param database [Database] The database instance containing the models
     # @param relationships [Hash] Custom foreign key relationships to add

data/lib/dynamic-active-model/factory.rb

@@ -33,10 +33,12 @@ module DynamicActiveModel
     # @param table_name [String] Name of the database table
     # @param class_name [String, nil] Optional custom class name
     # @return [Class] The model class
+    # @raise [ClassNameConflict] If the class name is already used by a different table
     def create(table_name, class_name = nil)
       class_name ||= generate_class_name(table_name)
-      create!(table_name, class_name) unless @base_module.const_defined?(class_name)
-      @base_module.const_get(class_name)
+      return create!(table_name, class_name) unless @base_module.const_defined?(class_name, false)
+
+      existing_model!(table_name, class_name)
     end
 
     # Creates a new model class for a table, overwriting if it exists
@@ -49,7 +51,7 @@ module DynamicActiveModel
         include DynamicActiveModel::DangerousAttributesPatch
       end
       @base_module.const_set(class_name, kls)
-      @base_module.const_get(class_name)
+      @base_module.const_get(class_name, false)
     end
 
     # Gets or creates the base class for all models
@@ -85,5 +87,22 @@ module DynamicActiveModel
 
       class_name
     end
+
+    private
+
+    # Returns the existing model for a class name if it belongs to the table
+    # @param table_name [String] Name of the database table
+    # @param class_name [String] Name of the existing class
+    # @return [Class] The existing model class
+    # @raise [ClassNameConflict] If the class belongs to a different table
+    def existing_model!(table_name, class_name)
+      model = @base_module.const_get(class_name, false)
+      return model if model.respond_to?(:table_name) && model.table_name == table_name.to_s
+
+      raise ClassNameConflict,
+            "table #{table_name} maps to class #{model.name}, which is already used by " \
+            "#{model.respond_to?(:table_name) ? "table #{model.table_name}" : 'another constant'}; " \
+            'set a different class name with table_class_name'
+    end
   end
 end

data/lib/dynamic-active-model/setup.rb

@@ -47,6 +47,7 @@ module DynamicActiveModel
           connection_options: nil,
           skip_tables: [],
           relationships: {},
+          table_class_names: {},
           extensions_path: nil,
           extensions_suffix: '.ext.rb'
         }
@@ -120,6 +121,21 @@ module DynamicActiveModel
         redefine_class_method(:dynamic_active_model_config, config)
       end
 
+      # Sets a custom class name for a table
+      # @param table_name [String] Name of the table
+      # @param class_name [String] Class name to use for the table's model
+      def table_class_name(table_name, class_name)
+        config = dynamic_active_model_config
+        config[:table_class_names][table_name.to_s] = class_name
+        redefine_class_method(:dynamic_active_model_config, config)
+      end
+
+      # Gets the custom class names by table name
+      # @return [Hash] The current table class names
+      def table_class_names
+        dynamic_active_model_config[:table_class_names]
+      end
+
       # Sets or gets the path for model extensions
       # @param path [String, nil] Path to extension files
       # @return [String, nil] The current extensions path
@@ -156,7 +172,8 @@ module DynamicActiveModel
             self,
             connection_options,
             skip_tables,
-            relationships
+            relationships,
+            table_class_names
           )
         )
         database.update_all_models(extensions_path, extensions_suffix) if extensions_path

data/lib/dynamic-active-model/version.rb

@@ -2,5 +2,5 @@
 
 module DynamicActiveModel
   # Gem version, bumped by release-please
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/dynamic-active-model.rb

@@ -46,6 +46,12 @@ module DynamicActiveModel
   # Manages the setup process and configuration
   autoload :Setup, 'dynamic-active-model/setup'
 
+  # Base class for errors raised by DynamicActiveModel
+  class Error < StandardError; end
+
   # Raised when a requested model cannot be found
-  class ModelNotFound < StandardError; end
+  class ModelNotFound < Error; end
+
+  # Raised when two tables map to the same model class name
+  class ClassNameConflict < Error; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic-active-model
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Doug Youch