piratepoet/tests/unit/Models/CustomFieldTest.php

<?php

use MailPoet\Models\CustomField;
use MailPoet\Models\Subscriber;
use MailPoet\Models\SubscriberCustomField;

class CustomFieldTest extends MailPoetTest {
  function _before() {
    $this->data = array(
      'name' => 'City',
      'type' => CustomField::TYPE_TEXT,
      'params' => array(
        'label' => 'What is your city?'
      )
    );
    $this->custom_field = CustomField::createOrUpdate($this->data);

    $this->subscribers = array(
      array(
        'first_name' => 'John',
        'last_name' => 'Mailer',
        'email' => 'john@mailpoet.com'
      ),
      array(
        'first_name' => 'Mike',
        'last_name' => 'Smith',
        'email' => 'mike@maipoet.com'
      )
    );
  }

  function testItCanBeCreated() {
    expect($this->custom_field->id() > 0)->true();
    expect($this->custom_field->getErrors())->false();
  }

  function testItCanBeUpdated() {
    expect($this->custom_field->name)->equals($this->data['name']);

    $updated_custom_field = CustomField::createOrUpdate(array(
      'id' => $this->custom_field->id,
      'name' => 'Country'
    ));

    expect($updated_custom_field->getErrors())->false();
    expect($updated_custom_field->name)->equals('Country');
    expect($updated_custom_field->id)->equals($this->custom_field->id);
  }

  function testItHasAName() {
    expect($this->custom_field->name)->equals($this->data['name']);
  }

  function testItHasAType() {
    expect($this->custom_field->type)->equals($this->data['type']);
  }

  function testItHasSerializedParams() {
    $params = unserialize($this->custom_field->params);
    expect($params)->equals($this->data['params']);
  }

  function testItCanDecodeParams() {
    $custom_field = $this->custom_field->asArray();
    expect($custom_field['params'])->equals($this->data['params']);
  }

  function testItHasToBeValid() {
    $invalid_custom_field = CustomField::create();

    $result = $invalid_custom_field->save();
    $errors = $result->getErrors();

    expect(is_array($errors))->true();
    expect($errors[0])->equals('Please specify a name.');
    expect($errors[1])->equals('Please specify a type.');
  }

  function testItHasACreatedAtOnCreation() {
    $custom_field = CustomField::findOne($this->custom_field->id);
    expect($custom_field->created_at)->notNull();
  }

  function testItHasAnUpdatedAtOnCreation() {
    $custom_field = CustomField::findOne($this->custom_field->id);
    expect($custom_field->updated_at)
      ->equals($custom_field->created_at);
  }

  function testItUpdatesTheUpdatedAtOnUpdate() {
    $custom_field = CustomField::findOne($this->custom_field->id);
    $created_at = $custom_field->created_at;

    sleep(1);

    $custom_field->name = 'Country';
    $custom_field->save();

    $updated_custom_field = CustomField::findOne($custom_field->id);
    expect($updated_custom_field->created_at)->equals($created_at);
    $is_time_updated = (
      $updated_custom_field->updated_at > $updated_custom_field->created_at
    );
    expect($is_time_updated)->true();
  }

  function testItCanHaveManySubscribers() {
    foreach($this->subscribers as $subscriber) {
      $subscriber = Subscriber::createOrUpdate($subscriber);

      $association = SubscriberCustomField::create();
      $association->subscriber_id = $subscriber->id;
      $association->custom_field_id = $this->custom_field->id;
      $association->save();
    }
    $custom_field = CustomField::findOne($this->custom_field->id);
    $subscribers = $custom_field->subscribers()->findArray();
    expect(count($subscribers))->equals(2);
  }

  function testItCanHaveAValue() {
    $subscriber = Subscriber::createOrUpdate($this->subscribers[0]);

    $association = SubscriberCustomField::create();
    $association->subscriber_id = $subscriber->id;
    $association->custom_field_id = $this->custom_field->id;
    $association->value = '12/12/2012';
    $association->save();
    $custom_field = CustomField::findOne($this->custom_field->id);
    $subscriber = $custom_field->subscribers()->findOne();
    expect($subscriber->value)->equals($association->value);
  }

  function testItExtractsCustomFieldsFromObject() {
    $data = array(
      'email' => 'test@example.com',
      'cf_1' => 'Paris',
      'first_name' => 'John',
      'cf_2' => 'France',
      'last_name' => 'Doe'
    );
    list($data, $custom_values) = CustomField::extractCustomFieldsFromFromObject($data);
    expect($data)->equals(
      array(
        'email' => 'test@example.com',
        'first_name' => 'John',
        'last_name' => 'Doe'
      )
    );
    expect($custom_values)->equals(
      array(
        '1' => 'Paris',
        '2' => 'France'
      )
    );
  }

  function _after() {
    CustomField::deleteMany();
    Subscriber::deleteMany();
    SubscriberCustomField::deleteMany();
  }
}