X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FUUIDColumns.pm;h=8a58527752036b9f5b9b567f32d2c5ddb4f970cf;hb=9b465d002d544e25ae5756304c4ea59577aca363;hp=efbe3d4912b504ac2516a720d9f75802f27f55a8;hpb=e821dce9bc8a298173d04210bd7be5f43c91f540;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/UUIDColumns.pm b/lib/DBIx/Class/UUIDColumns.pm index efbe3d4..8a58527 100644 --- a/lib/DBIx/Class/UUIDColumns.pm +++ b/lib/DBIx/Class/UUIDColumns.pm @@ -1,9 +1,73 @@ package DBIx::Class::UUIDColumns; use base qw/DBIx::Class/; -use Data::UUID; - __PACKAGE__->mk_classdata( 'uuid_auto_columns' => [] ); +__PACKAGE__->mk_classdata( 'uuid_maker' ); +__PACKAGE__->uuid_class( __PACKAGE__->_find_uuid_module ); + +# be compatible with Class::DBI::UUID +sub uuid_columns { + my $self = shift; + for (@_) { + $self->throw_exception("column $_ doesn't exist") unless $self->has_column($_); + } + $self->uuid_auto_columns(\@_); +} + +sub uuid_class { + my ($self, $class) = @_; + + if ($class) { + $class = "DBIx::Class::UUIDMaker$class" if $class =~ /^::/; + + if (!eval "require $class") { + $self->throw_exception("$class could not be loaded: $@"); + } elsif (!$class->isa('DBIx::Class::UUIDMaker')) { + $self->throw_exception("$class is not a UUIDMaker subclass"); + } else { + $self->uuid_maker($class->new); + }; + }; + + return ref $self->uuid_maker; +}; + +sub insert { + my $self = shift; + for my $column (@{$self->uuid_auto_columns}) { + $self->store_column( $column, $self->get_uuid ) + unless defined $self->get_column( $column ); + } + $self->next::method(@_); +} + +sub get_uuid { + return shift->uuid_maker->as_string; +} + +sub _find_uuid_module { + if (eval{require Data::UUID}) { + return '::Data::UUID'; + } elsif ($^O ne 'openbsd' && eval{require APR::UUID}) { + # APR::UUID on openbsd causes some as yet unfound nastyness for XS + return '::APR::UUID'; + } elsif (eval{require UUID}) { + return '::UUID'; + } elsif (eval{ + # squelch the 'too late for INIT' warning in Win32::API::Type + local $^W = 0; + require Win32::Guidgen; + }) { + return '::Win32::Guidgen'; + } elsif (eval{require Win32API::GUID}) { + return '::Win32API::GUID'; + } else { + shift->throw_exception('no suitable uuid module could be found') + }; +}; + +1; +__END__ =head1 NAME @@ -11,7 +75,7 @@ DBIx::Class::UUIDColumns - Implicit uuid columns =head1 SYNOPSIS - pacakge Artist; + package Artist; __PACKAGE__->load_components(qw/UUIDColumns Core DB/); __PACKAGE__->uuid_columns( 'artist_id' ); @@ -20,44 +84,65 @@ DBIx::Class::UUIDColumns - Implicit uuid columns This L component resembles the behaviour of L, to make some columns implicitly created as uuid. +When loaded, C will search for a suitable uuid generation module +from the following list of supported modules: + + Data::UUID + APR::UUID* + UUID + Win32::Guidgen + Win32API::GUID + +If no supporting module can be found, an exception will be thrown. + +*APR::UUID will not be loaded under OpenBSD due to an as yet unidentified XS +issue. + +If you would like to use a specific module, you can set C: + + __PACKAGE__->uuid_class('::Data::UUID'); + __PACKAGE__->uuid_class('MyUUIDGenerator'); + Note that the component needs to be loaded before Core. =head1 METHODS -=head2 uuid_columns +=head2 uuid_columns(@columns) -=cut +Takes a list of columns to be filled with uuids during insert. -# be compatible with Class::DBI::UUID -sub uuid_columns { - my $self = shift; - for (@_) { - $self->throw_exception("column $_ doesn't exist") unless $self->has_column($_); - } - $self->uuid_auto_columns(\@_); -} + __PACKAGE__->uuid_columns('id'); -sub insert { - my $self = shift; - for my $column (@{$self->uuid_auto_columns}) { - $self->store_column( $column, $self->get_uuid ) - unless defined $self->get_column( $column ); - } - $self->next::method(@_); -} +=head2 uuid_class($classname) -sub get_uuid { - return Data::UUID->new->to_string(Data::UUID->new->create), -} +Takes the name of a UUIDMaker subclass to be used for uuid value generation. +This can be a fully qualified class name, or a shortcut name starting with :: +that matches one of the available DBIx::Class::UUIDMaker subclasses: + + __PACKAGE__->uuid_class('CustomUUIDGenerator'); + # loads CustomeUUIDGenerator + + __PACKAGE->uuid_class('::Data::UUID'); + # loads DBIx::Class::UUIDMaker::Data::UUID; + +Note that C chacks to see that the specified class isa +DBIx::Class::UUIDMaker subbclass and throws and exception if it isn't. + +=head2 uuid_maker + +Returns the current UUIDMaker instance for the given module. + + my $uuid = __PACKAGE__->uuid_maker->as_string; + +=head1 SEE ALSO + +L =head1 AUTHORS Chia-liang Kao +Chris Laco =head1 LICENSE You may distribute this code under the same terms as Perl itself. - -=cut - -1;