refactor relationship building code for runtime table adds as well
Brandon Black [Fri, 30 Mar 2007 21:44:30 +0000 (21:44 +0000)]
lib/DBIx/Class/Schema/Loader/Base.pm
lib/DBIx/Class/Schema/Loader/RelBuilder.pm

index 6de7d2f..05bad6a 100644 (file)
@@ -226,6 +226,10 @@ sub new {
     $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
     $self->{schema} ||= $self->{schema_class};
 
+    $self->{relbuilder} = DBIx::Class::Schema::Loader::RelBuilder->new(
+        $self->schema_class, $self->inflect_plural, $self->inflect_singular
+    ) if !$self->{skip_relationships};
+
     $self;
 }
 
@@ -338,7 +342,10 @@ sub load {
 
     $self->_setup_src_meta($_) for @tables;
 
-    $self->_load_relationships if ! $self->skip_relationships;
+    if(!$self->skip_relationships) {
+        $self->_load_relationships($_) for @tables;
+    }
+
     $self->_load_external($_)
         for ($self->schema_class, values %{$self->classes});
 
@@ -607,27 +614,17 @@ sub _table2moniker {
 }
 
 sub _load_relationships {
-    my $self = shift;
+    my ($self, $table) = @_;
 
-    # Construct the fk_info RelBuilder wants to see, by
-    # translating table names to monikers in the _fk_info output
-    my %fk_info;
-    foreach my $table ($self->tables) {
-        my $tbl_fk_info = $self->_table_fk_info($table);
-        foreach my $fkdef (@$tbl_fk_info) {
-            $fkdef->{remote_source} =
-                $self->monikers->{delete $fkdef->{remote_table}};
-        }
-        my $moniker = $self->monikers->{$table};
-        $fk_info{$moniker} = $tbl_fk_info;
+    my $tbl_fk_info = $self->_table_fk_info($table);
+    foreach my $fkdef (@$tbl_fk_info) {
+        $fkdef->{remote_source} =
+            $self->monikers->{delete $fkdef->{remote_table}};
     }
 
-    my $relbuilder = DBIx::Class::Schema::Loader::RelBuilder->new(
-        $self->schema_class, \%fk_info, $self->inflect_plural,
-        $self->inflect_singular
-    );
+    my $local_moniker = $self->monikers->{$table};
+    my $rel_stmts = $self->{relbuilder}->generate_code($local_moniker, $tbl_fk_info);
 
-    my $rel_stmts = $relbuilder->generate_code;
     foreach my $src_class (sort keys %$rel_stmts) {
         my $src_stmts = $rel_stmts->{$src_class};
         foreach my $stmt (@$src_stmts) {
index 5ccb769..1ffb244 100644 (file)
@@ -24,43 +24,47 @@ is module is not (yet) for external use.
 
 =head2 new
 
-Arguments: schema_class (scalar), fk_info (hashref), inflect_plural, inflect_singular
+Arguments: schema_class (scalar), inflect_plural, inflect_singular
 
 C<$schema_class> should be a schema class name, where the source
 classes have already been set up and registered.  Column info, primary
 key, and unique constraints will be drawn from this schema for all
 of the existing source monikers.
 
-The fk_info hashref's contents should take the form:
-
-  {
-      TableMoniker => [
-          {
-              local_columns => [ 'col2', 'col3' ],
-              remote_columns => [ 'col5', 'col7' ],
-              remote_moniker => 'AnotherTableMoniker',
-          },
-          # ...
-      ],
-      AnotherTableMoniker => [
-          # ...
-      ],
-      # ...
-  }
-
 Options inflect_plural and inflect_singular are optional, and are better documented
 in L<DBIx::Class::Schema::Loader::Base>.
 
 =head2 generate_code
 
-This method will return the generated relationships as a hashref per table moniker,
-containing an arrayref of code strings which can be "eval"-ed in the context of
-the source class, like:
+Arguments: local_moniker (scalar), fk_info (arrayref)
+
+This generates the code for the relationships of a given table.
+
+C<local_moniker> is the moniker name of the table which had the REFERENCES
+statements.  The fk_info arrayref's contents should take the form:
+
+    [
+        {
+            local_columns => [ 'col2', 'col3' ],
+            remote_columns => [ 'col5', 'col7' ],
+            remote_moniker => 'AnotherTableMoniker',
+        },
+        {
+            local_columns => [ 'col1', 'col4' ],
+            remote_columns => [ 'col1', 'col2' ],
+            remote_moniker => 'YetAnotherTableMoniker',
+        },
+        # ...
+    ],
+
+This method will return the generated relationships as a hashref keyed on the
+class names.  The values are arrayrefs of hashes containing method name and
+arguments, like so:
 
   {
       'Some::Source::Class' => [
-          "belongs_to( col1 => 'AnotherTableMoniker' )",
-          "has_many( anothers => 'AnotherTableMoniker', 'col15' )",
+          { method => 'belongs_to', arguments => [ 'col1', 'AnotherTableMoniker' ],
+          { method => 'has_many', arguments => [ 'anothers', 'AnotherTableMoniker', 'col15' ],
       ],
       'Another::Source::Class' => [
           # ...
@@ -68,18 +72,13 @@ the source class, like:
       # ...
   }
 
-You might want to use this in building an on-disk source class file, by
-adding each string to the appropriate source class file,
-prefixed by C<__PACKAGE__-E<gt>>.
-
 =cut
 
 sub new {
-    my ( $class, $schema, $fk_info, $inflect_pl, $inflect_singular ) = @_;
+    my ( $class, $schema, $inflect_pl, $inflect_singular ) = @_;
 
     my $self = {
         schema => $schema,
-        fk_info => $fk_info,
         inflect_plural => $inflect_pl,
         inflect_singular => $inflect_singular,
     };
@@ -123,89 +122,86 @@ sub _inflect_singular {
 }
 
 sub generate_code {
-    my $self = shift;
+    my ($self, $local_moniker, $rels) = @_;
 
     my $all_code = {};
 
-    foreach my $local_moniker (keys %{$self->{fk_info}}) {
-        my $local_table = $self->{schema}->source($local_moniker)->from;
-        my $local_class = $self->{schema}->class($local_moniker);
-        my $rels = $self->{fk_info}->{$local_moniker};
+    my $local_table = $self->{schema}->source($local_moniker)->from;
+    my $local_class = $self->{schema}->class($local_moniker);
         
-        my %counters;
-        foreach my $rel (@$rels) {
-            next if !$rel->{remote_source};
-            $counters{$rel->{remote_source}}++;
+    my %counters;
+    foreach my $rel (@$rels) {
+        next if !$rel->{remote_source};
+        $counters{$rel->{remote_source}}++;
+    }
+
+    foreach my $rel (@$rels) {
+        next if !$rel->{remote_source};
+        my $local_cols = $rel->{local_columns};
+        my $remote_cols = $rel->{remote_columns};
+        my $remote_moniker = $rel->{remote_source};
+        my $remote_obj = $self->{schema}->source($remote_moniker);
+        my $remote_class = $self->{schema}->class($remote_moniker);
+        my $remote_table = $remote_obj->from;
+        $remote_cols ||= [ $remote_obj->primary_columns ];
+
+        if($#$local_cols != $#$remote_cols) {
+            croak "Column count mismatch: $local_moniker (@$local_cols) "
+                . "$remote_moniker (@$remote_cols)";
         }
 
-        foreach my $rel (@$rels) {
-            next if !$rel->{remote_source};
-            my $local_cols = $rel->{local_columns};
-            my $remote_cols = $rel->{remote_columns};
-            my $remote_moniker = $rel->{remote_source};
-            my $remote_obj = $self->{schema}->source($remote_moniker);
-            my $remote_class = $self->{schema}->class($remote_moniker);
-            my $remote_table = $remote_obj->from;
-            $remote_cols ||= [ $remote_obj->primary_columns ];
-
-            if($#$local_cols != $#$remote_cols) {
-                croak "Column count mismatch: $local_moniker (@$local_cols) "
-                    . "$remote_moniker (@$remote_cols)";
-            }
+        my %cond;
+        foreach my $i (0 .. $#$local_cols) {
+            $cond{$remote_cols->[$i]} = $local_cols->[$i];
+        }
 
-            my %cond;
-            foreach my $i (0 .. $#$local_cols) {
-                $cond{$remote_cols->[$i]} = $local_cols->[$i];
-            }
+        # If more than one rel between this pair of tables, use the
+        #  local col name(s) as the relname in the foreign source, instead
+        #  of the local table name.
+        my $local_relname;
+        if($counters{$remote_moniker} > 1) {
+            $local_relname = $self->_inflect_plural(
+                lc($local_table) . q{_} . join(q{_}, @$local_cols)
+            );
+        } else {
+            $local_relname = $self->_inflect_plural(lc $local_table);
+        }
 
-            # If more than one rel between this pair of tables, use the
-            #  local col name(s) as the relname in the foreign source, instead
-            #  of the local table name.
-            my $local_relname;
-            if($counters{$remote_moniker} > 1) {
-                $local_relname = $self->_inflect_plural(
-                    lc($local_table) . q{_} . join(q{_}, @$local_cols)
-                );
-            } else {
-                $local_relname = $self->_inflect_plural(lc $local_table);
-            }
+        # for single-column case, set the relname to the column name,
+        # to make filter accessors work
+        my $remote_relname;
+        if(scalar keys %cond == 1) {
+            my ($col) = keys %cond;
+            $remote_relname = $self->_inflect_singular($cond{$col});
+        }
+        else {
+            $remote_relname = $self->_inflect_singular(lc $remote_table);
+        }
 
-            # for single-column case, set the relname to the column name,
-            # to make filter accessors work
-            my $remote_relname;
-            if(scalar keys %cond == 1) {
-                my ($col) = keys %cond;
-                $remote_relname = $self->_inflect_singular($cond{$col});
-            }
-            else {
-                $remote_relname = $self->_inflect_singular(lc $remote_table);
-            }
+        my %rev_cond = reverse %cond;
 
-            my %rev_cond = reverse %cond;
+        for (keys %rev_cond) {
+            $rev_cond{"foreign.$_"} = "self.".$rev_cond{$_};
+            delete $rev_cond{$_};
+        }
 
-            for (keys %rev_cond) {
-                $rev_cond{"foreign.$_"} = "self.".$rev_cond{$_};
-                delete $rev_cond{$_};
+        push(@{$all_code->{$local_class}},
+            { method => 'belongs_to',
+              args => [ $remote_relname,
+                        $remote_class,
+                        \%cond,
+              ],
             }
-
-            push(@{$all_code->{$local_class}},
-                { method => 'belongs_to',
-                  args => [ $remote_relname,
-                            $remote_class,
-                            \%cond,
-                  ],
-                }
-            );
-
-            push(@{$all_code->{$remote_class}},
-                { method => 'has_many',
-                  args => [ $local_relname,
-                            $local_class,
-                            \%rev_cond,
-                  ],
-                }
-            );
-        }
+        );
+
+        push(@{$all_code->{$remote_class}},
+            { method => 'has_many',
+              args => [ $local_relname,
+                        $local_class,
+                        \%rev_cond,
+              ],
+            }
+        );
     }
 
     return $all_code;