Implement strict constructors, which will warn unkown constructor arguments
[gitmo/Mouse.git] / lib / Mouse / Meta / Method / Constructor.pm
index 8b3f3a1..0c929a7 100644 (file)
 package Mouse::Meta::Method::Constructor;
-use strict;
-use warnings;
-
-sub generate_constructor_method_inline {
-    my ($class, $meta) = @_;
-
-    my @attrs = $meta->compute_all_applicable_attributes;
-    my $buildall = $class->_generate_BUILDALL($meta);
-    my $buildargs = $class->_generate_BUILDARGS($meta);
-    my $processattrs = $class->_generate_processattrs($meta, \@attrs);
-
-    my $code = <<"...";
-    sub {
-        my \$class = shift;
-        my \$args = $buildargs;
-        my \$instance = bless {}, \$class;
-        $processattrs;
-        $buildall;
-        return \$instance;
-    }
-...
+use Mouse::Util qw(:meta); # enables strict and warnings
+
+sub _inline_slot{
+    my(undef, $self_var, $attr_name) = @_;
+    return sprintf '%s->{q{%s}}', $self_var, $attr_name;
+}
 
-    local $@;
-    my $res = eval $code;
-    die $@ if $@;
-    $res;
+sub _generate_constructor {
+    my ($class, $metaclass, $args) = @_;
+
+    my $associated_metaclass_name = $metaclass->name;
+
+    my @attrs         = $metaclass->get_all_attributes;
+
+    my $buildall      = $class->_generate_BUILDALL($metaclass);
+    my $buildargs     = $class->_generate_BUILDARGS($metaclass);
+    my $processattrs  = $class->_generate_processattrs($metaclass, \@attrs);
+
+    my @checks = map { $_ && $_->_compiled_type_constraint }
+                 map { $_->type_constraint } @attrs;
+
+    my $source = sprintf("#line %d %s\n", __LINE__, __FILE__).<<"...";
+        sub \{
+            my \$class = shift;
+            return \$class->Mouse::Object::new(\@_)
+                if \$class ne q{$associated_metaclass_name};
+            # BUILDARGS
+            $buildargs;
+            my \$instance = bless {}, \$class;
+            # process attributes
+            $processattrs;
+            # BUILDALL
+            $buildall;
+            return \$instance;
+        }
+...
+    #warn $source;
+    my $code;
+    my $e = do{
+        local $@;
+        $code = eval $source;
+        $@;
+    };
+    die $e if $e;
+    return $code;
 }
 
 sub _generate_processattrs {
-    my ($class, $meta, $attrs) = @_;
+    my ($method_class, $metaclass, $attrs) = @_;
     my @res;
 
+    my $has_triggers;
+    my $strict_constructor = $metaclass->__strict_constructor;
+
+
+    if($strict_constructor){
+        push @res, 'my $used = 0;';
+    }
+
     for my $index (0 .. @$attrs - 1) {
+        my $code = '';
+
         my $attr = $attrs->[$index];
         my $key  = $attr->name;
-        my $code = '';
 
-        if (defined $attr->init_arg) {
-            my $from = $attr->init_arg;
+        my $init_arg        = $attr->init_arg;
+        my $type_constraint = $attr->type_constraint;
+        my $is_weak_ref     = $attr->is_weak_ref;
+        my $need_coercion;
 
-            $code .= "if (exists \$args->{'$from'}) {\n";
+        my $instance_slot  = $method_class->_inline_slot('$instance', $key);
+        my $attr_var       = "\$attrs[$index]";
+        my $constraint_var;
 
-            if ($attr->should_coerce && $attr->type_constraint) {
-                $code .= "my \$value = Mouse::Util::TypeConstraints->typecast_constraints('".$attr->associated_class->name."', \$attrs[$index]->{find_type_constraint}, \$attrs[$index]->{type_constraint}, \$args->{'$from'});\n";
-            }
-            else {
-                $code .= "my \$value = \$args->{'$from'};\n";
-            }
+        if(defined $type_constraint){
+             $constraint_var = "$attr_var\->{type_constraint}";
+             $need_coercion  = ($attr->should_coerce && $type_constraint->has_coercion);
+        }
 
-            if ($attr->has_type_constraint) {
-                $code .= "{
-                    local \$_ = \$value;
-                    unless (\$attrs[$index]->{find_type_constraint}->(\$_)) {
-                        \$attrs[$index]->verify_type_constraint_error('$key', \$_, \$attrs[$index]->type_constraint)
-                    }
-                }";
-            }
+        $code .= "# initialize $key\n";
+
+        my $post_process = '';
+        if(defined $type_constraint){
+            $post_process .= "\$checks[$index]->($instance_slot)";
+            $post_process .= "  or $attr_var->_throw_type_constraint_error($instance_slot, $constraint_var);\n";
+        }
+        if($is_weak_ref){
+            $post_process .= "Scalar::Util::weaken($instance_slot) if ref $instance_slot;\n";
+        }
 
-            $code .= "\$instance->{'$key'} = \$value;\n";
+        if (defined $init_arg) {
+            my $value = "\$args->{q{$init_arg}}";
 
-            if ($attr->is_weak_ref) {
-                $code .= "Scalar::Util::weaken( \$instance->{'$key'} ) if ref( \$value );\n";
+            $code .= "if (exists $value) {\n";
+
+            if($need_coercion){
+                $value = "$constraint_var->coerce($value)";
             }
 
+            $code .= "$instance_slot = $value;\n";
+            $code .= $post_process;
+
             if ($attr->has_trigger) {
-                $code .= "\$attrs[$index]->{trigger}->( \$instance, \$value );\n";
+                $has_triggers++;
+                $code .= "push \@triggers, [$attr_var\->{trigger}, $instance_slot];\n";
+            }
+
+            if ($strict_constructor){
+                $code .= '$used++;' . "\n";
             }
 
-            $code .= "\n} else {\n";
+            $code .= "\n} else {\n"; # $value exists
         }
 
         if ($attr->has_default || $attr->has_builder) {
@@ -75,48 +118,27 @@ sub _generate_processattrs {
                 my $default = $attr->default;
                 my $builder = $attr->builder;
 
-                $code .= "my \$value = ";
-
-                if ($attr->should_coerce && $attr->type_constraint) {
-                    $code .= "Mouse::Util::TypeConstraints->typecast_constraints('".$attr->associated_class->name."', \$attrs[$index]->{find_type_constraint}, \$attrs[$index]->{type_constraint}, ";
+                my $value;
+                if (defined($builder)) {
+                    $value = "\$instance->$builder()";
                 }
-
-                    if ($attr->has_builder) {
-                        $code .= "\$instance->$builder";
-                    }
-                    elsif (ref($default) eq 'CODE') {
-                        $code .= "\$attrs[$index]->{default}->(\$instance)";
-                    }
-                    elsif (!defined($default)) {
-                        $code .= 'undef';
-                    }
-                    elsif ($default =~ /^\-?[0-9]+(?:\.[0-9]+)$/) {
-                        $code .= $default;
-                    }
-                    else {
-                        $code .= "'$default'";
-                    }
-
-                if ($attr->should_coerce) {
-                    $code .= ");\n";
+                elsif (ref($default) eq 'CODE') {
+                    $value = "$attr_var\->{default}->(\$instance)";
+                }
+                elsif (defined($default)) {
+                    $value = "$attr_var\->{default}";
                 }
                 else {
-                    $code .= ";\n";
+                    $value = 'undef';
                 }
 
-                if ($attr->has_type_constraint) {
-                    $code .= "{
-                        local \$_ = \$value;
-                        unless (\$attrs[$index]->{find_type_constraint}->(\$_)) {
-                            \$attrs[$index]->verify_type_constraint_error('$key', \$_, \$attrs[$index]->type_constraint)
-                        }
-                    }";
+                if($need_coercion){
+                    $value = "$constraint_var->coerce($value)";
                 }
 
-                $code .= "\$instance->{'$key'} = \$value;\n";
-
-                if ($attr->is_weak_ref) {
-                    $code .= "Scalar::Util::weaken( \$instance->{'$key'} ) if ref( \$value );\n";
+                $code .= "$instance_slot = $value;\n";
+                if($is_weak_ref){
+                    $code .= "Scalar::Util::weaken($instance_slot);\n";
                 }
             }
         }
@@ -124,56 +146,100 @@ sub _generate_processattrs {
             $code .= "Carp::confess('Attribute ($key) is required');";
         }
 
-        $code .= "}\n" if defined $attr->init_arg;
+        $code .= "}\n" if defined $init_arg;
 
         push @res, $code;
     }
 
+    if($strict_constructor){
+        push @res, q{if($used < keys %{$args})}
+            . q{{ Mouse::Meta::Method::Constructor::_report_unknown_args($metaclass, \@attrs, $instance, $args) }};
+    }
+
+    if($metaclass->is_anon_class){
+        push @res, q{$instance->{__METACLASS__} = $metaclass;};
+    }
+
+    if($has_triggers){
+        unshift @res, q{my @triggers;};
+        push    @res, q{$_->[0]->($instance, $_->[1]) for @triggers;};
+    }
+
     return join "\n", @res;
 }
 
 sub _generate_BUILDARGS {
-    my $self = shift;
-    my $meta = shift;
+    my(undef, $metaclass) = @_;
 
-    if ($meta->name->can('BUILDARGS') && $meta->name->can('BUILDARGS') != Mouse::Object->can('BUILDARGS')) {
-        return '$class->BUILDARGS(@_)';
+    my $class = $metaclass->name;
+    if ( $class->can('BUILDARGS') && $class->can('BUILDARGS') != \&Mouse::Object::BUILDARGS ) {
+        return 'my $args = $class->BUILDARGS(@_)';
     }
 
     return <<'...';
-    do {
+        my $args;
         if ( scalar @_ == 1 ) {
-            if ( defined $_[0] ) {
-                ( ref( $_[0] ) eq 'HASH' )
+            ( ref( $_[0] ) eq 'HASH' )
                 || Carp::confess "Single parameters to new() must be a HASH ref";
-                +{ %{ $_[0] } };
-            }
-            else {
-                +{};
-            }
+            $args = +{ %{ $_[0] } };
         }
         else {
-            +{@_};
+            $args = +{@_};
         }
-    };
 ...
 }
 
 sub _generate_BUILDALL {
-    my ($class, $meta) = @_;
-    return '' unless $meta->name->can('BUILD');
-
-    my @code = ();
-    push @code, q{no strict 'refs';};
-    push @code, q{no warnings 'once';};
-    no strict 'refs';
-    no warnings 'once';
-    for my $klass ($meta->linearized_isa) {
-        if (*{ $klass . '::BUILD' }{CODE}) {
-            push  @code, qq{${klass}::BUILD(\$instance, \$args);};
+    my (undef, $metaclass) = @_;
+
+    return '' unless $metaclass->name->can('BUILD');
+
+    my @code;
+    for my $class ($metaclass->linearized_isa) {
+        if (Mouse::Util::get_code_ref($class, 'BUILD')) {
+            unshift  @code, qq{${class}::BUILD(\$instance, \$args);};
         }
     }
     return join "\n", @code;
 }
 
+sub _report_unknown_args {
+    my($metaclass, $attrs, $instance, $args) = @_;
+
+    my @unknowns;
+    my %init_args;
+    foreach my $attr(@{$attrs}){
+        my $init_arg = $attr->init_arg;
+        if(defined $init_arg){
+            $init_args{$init_arg}++;
+        }
+    }
+
+    while(my $key = each %{$args}){
+        if(!exists $init_args{$key}){
+            push @unknowns, $key;
+        }
+    }
+
+    $metaclass->throw_error( sprintf
+        "Unknown attribute passed to the constructor of %s: %s",
+        ref($instance), join ', ', @unknowns
+    );
+}
+
 1;
+__END__
+
+=head1 NAME
+
+Mouse::Meta::Method::Constructor - A Mouse method generator for constructors
+
+=head1 VERSION
+
+This document describes Mouse version 0.50_01
+
+=head1 SEE ALSO
+
+L<Moose::Meta::Method::Constructor>
+
+=cut