Bumping version to 1.62
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Schema / Object.pm
index bff5fb3..f546fc4 100644 (file)
 package SQL::Translator::Schema::Object;
 
-# ----------------------------------------------------------------------
-# $Id: Object.pm,v 1.2 2004-11-05 13:19:31 grommit Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2002-4 SQLFairy Authors
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307  USA
-# -------------------------------------------------------------------
-
-=pod
-
 =head1 NAME
 
-SQL::Translator::Schema::Object - Base class SQL::Translator Schema objects.
+SQL::Translator::Schema::Object - Base class for SQL::Translator schema objects
 
 =head1 SYNOPSIS
 
-=head1 DESCSIPTION
-
-Base class for Schema objects. Sub classes L<Class::Base> and adds the following
-extra functionality. 
-
-=cut
-
-use strict;
-use Class::Base;
-use base 'Class::Data::Inheritable';
-use base 'Class::Base';
+    package SQL::Translator::Schema::Foo;
+    use Moo;
+    extends 'SQL::Translator::Schema::Object';
 
-use vars qw[ $VERSION ];
+=head1 DESCRIPTION
 
-$VERSION = sprintf "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/;
+Base class for Schema objects. A Moo class consuming the following
+roles.
 
+=over
 
-=head1 Construction
+=item L<SQL::Translator::Role::Error>
 
-Derived classes should decalare their attributes using the C<_attributes>
-method. They can then inherit the C<init> method from here which will call
-accessors of the same name for any values given in the hash passed to C<new>.
-Note that you will have to impliment the accessors your self and we expect perl
-style methods; call with no args to get and with arg to set.
+Provides C<< $obj->error >>, similar to L<Class::Base>.
 
-e.g. If we setup our class as follows;
+=item L<SQL::Translator::Role::BuildArgs>
 
- package SQL::Translator::Schema::Table;
- use base qw/SQL::Translator::Schema::Object/;
- __PACKAGE__->_attributes( qw/schema name/ );
+Removes undefined constructor arguments, for backwards compatibility.
 
- sub name   { ... }
- sub schema { ... }
+=item L<SQL::Translator::Schema::Role::Extra>
 
-Then we can construct it with
+Provides an C<extra> attribute storing a hashref of arbitrary data.
 
- my $table  =  SQL::Translator::Schema::Table->new( 
-     schema => $schema,
-     name   => 'foo',
- );
+=item L<SQL::Translator::Schema::Role::Compare>
 
-and init will call C<< $table->name("foo") >> and C<< $table->schema($schema) >>
-to set it up. Any undefined args will be ignored.
+Provides an C<< $obj->equals($other) >> method for testing object
+equality.
 
-Multiple calls to C<_attributes> are cumulative and sub classes will inherit
-their parents attribute names.
-
-This is currently experimental, but will hopefull go on to form an introspection
-API for the Schema objects.
+=back
 
 =cut
 
+use Moo 1.000003;
 
-__PACKAGE__->mk_classdata("__attributes");
-__PACKAGE__->__attributes([]); 
-
-# Set the classes attribute names. Multiple calls are cumulative.
-# We need to be careful to create a new ref so that all classes don't end up
-# with the same ref and hence the same attributes!
-sub _attributes {
-    my $class = shift;
-    if (@_) { $class->__attributes( [ @{$class->__attributes}, @_ ] ); }
-    return @{$class->__attributes};
-}
-
-# Call accessors for any args in hashref passed
-sub init {
-    my ( $self, $config ) = @_;
-    
-    for my $arg ( $self->_attributes ) {
-        next unless defined $config->{$arg};
-        defined $self->$arg( $config->{$arg} ) or return; 
-    }
-
-    return $self;
-}
+# screw you PAUSE
+our $VERSION = '1.62';
 
-
-#=============================================================================
+with qw(
+  SQL::Translator::Role::Error
+  SQL::Translator::Role::BuildArgs
+  SQL::Translator::Schema::Role::Extra
+  SQL::Translator::Schema::Role::Compare
+);
 
 1;
-
-=pod
-
-=head1 SEE ALSO
-
-=head1 TODO
-
-=head1 BUGS
-
-=head1 AUTHOR
-
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>, Mark Addison E<lt>mark.addison@itn.co.ukE<gt> 
-
-=cut