reusable domain object test fixtures

Author: xabbuh

Test/Fixture/ActivityFixtures.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+use Xabbuh\XApi\Common\Model\Activity;
+use Xabbuh\XApi\Common\Model\Definition;
+
+/**
+ * Activity fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class ActivityFixtures
+{
+    /**
+     * Loads an activity.
+     *
+     * @return \Xabbuh\XApi\Common\Model\ActivityInterface
+     */
+    public static function getActivity()
+    {
+        $definition = new Definition();
+        $definition->setName(array(
+            'en-GB' => 'example activity',
+            'en-US' => 'example activity',
+        ));
+        $definition->setDescription(array(
+            'en-GB' => 'An example of an activity',
+            'en-US' => 'An example of an activity',
+        ));
+        $definition->setType('http://www.example.co.uk/types/exampleactivitytype');
+        $activity = new Activity();
+        $activity->setId('http://www.example.co.uk/exampleactivity');
+        $activity->setDefinition($definition);
+
+        return $activity;
+    }
+}

Test/Fixture/ActivityJsonFixtures.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+/**
+ * JSON encoded activity fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class ActivityJsonFixtures extends JsonFixtures
+{
+    /**
+     * Loads an activity.
+     *
+     * @return \Xabbuh\XApi\Common\Model\ActivityInterface
+     */
+    public static function getActivity()
+    {
+        return static::load('activity');
+    }
+}

Test/Fixture/ActorFixtures.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+use Xabbuh\XApi\Common\Model\Account;
+use Xabbuh\XApi\Common\Model\Agent;
+use Xabbuh\XApi\Common\Model\Group;
+
+/**
+ * Actor fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class ActorFixtures
+{
+    /**
+     * Loads an agent.
+     *
+     * @return \Xabbuh\XApi\Common\Model\AgentInterface
+     */
+    public static function getAgent()
+    {
+        $agent = new Agent();
+        $agent->setName('Christian');
+        $agent->setMbox('mailto:[email protected]');
+
+        return $agent;
+    }
+
+    /**
+     * Loads a group.
+     *
+     * @return \Xabbuh\XApi\Common\Model\GroupInterface
+     */
+    public static function getGroup()
+    {
+        $group = static::getAnonymousGroup();
+        $group->setName('Example Group');
+        $account = new Account();
+        $account->setHomePage('http://example.com/homePage');
+        $account->setName('GroupAccount');
+        $group->setAccount($account);
+
+        return $group;
+    }
+
+    /**
+     * Loads an anonymous group.
+     *
+     * @return \Xabbuh\XApi\Common\Model\GroupInterface
+     */
+    public static function getAnonymousGroup()
+    {
+        $group = new Group();
+        $group->setName('Anonymous Group');
+
+        $agent1 = new Agent();
+        $agent1->setName('Andrew Downes');
+        $agent1->setMbox('mailto:[email protected]');
+        $agent2 = new Agent();
+        $agent2->setName('Aaron Silvers');
+        $agent2->setOpenId('aaron.openid.example.org');
+        $group->setMembers(array($agent1, $agent2));
+
+        return $group;
+    }
+}

Test/Fixture/ActorJsonFixtures.php

@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+/**
+ * JSON encoded actor fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class ActorJsonFixtures extends JsonFixtures
+{
+    /**
+     * Loads an agent.
+     *
+     * @return string
+     */
+    public static function getAgent()
+    {
+        return static::load('agent');
+    }
+
+    /**
+     * Loads an agent without an object type reference included.
+     *
+     * @return string
+     */
+    public static function getAgentWithoutObjectType()
+    {
+        return static::load('agent_without_object_type');
+    }
+
+    /**
+     * Loads a group.
+     *
+     * @return string
+     */
+    public static function getGroup()
+    {
+        return static::load('group');
+    }
+
+    /**
+     * Loads an anonymous group.
+     *
+     * @return string
+     */
+    public static function getAnonymousGroup()
+    {
+        return static::load('anonymous_group');
+    }
+}

Test/Fixture/DocumentFixtures.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+use Xabbuh\XApi\Common\Model\ActivityProfileDocument;
+use Xabbuh\XApi\Common\Model\AgentProfileDocument;
+use Xabbuh\XApi\Common\Model\Document;
+use Xabbuh\XApi\Common\Model\StateDocument;
+
+/**
+ * Document fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class DocumentFixtures
+{
+    /**
+     * Loads a document.
+     *
+     * @return \Xabbuh\XApi\Common\Model\DocumentInterface
+     */
+    public static function getDocument()
+    {
+        $document = new Document();
+        $document['x'] = 'foo';
+        $document['y'] = 'bar';
+
+        return $document;
+    }
+
+    /**
+     * Loads an activity profile document.
+     *
+     * @return \Xabbuh\XApi\Common\Model\ActivityProfileDocumentInterface
+     */
+    public static function getActivityProfileDocument()
+    {
+        $document = new ActivityProfileDocument();
+        $document['x'] = 'foo';
+        $document['y'] = 'bar';
+
+        return $document;
+    }
+
+    /**
+     * Loads an agent profile document.
+     *
+     * @return \Xabbuh\XApi\Common\Model\AgentProfileDocumentInterface
+     */
+    public static function getAgentProfileDocument()
+    {
+        $document = new AgentProfileDocument();
+        $document['x'] = 'foo';
+        $document['y'] = 'bar';
+
+        return $document;
+    }
+
+    /**
+     * Loads a state document.
+     *
+     * @return \Xabbuh\XApi\Common\Model\StateDocumentInterface
+     */
+    public static function getStateDocument()
+    {
+        $document = new StateDocument();
+        $document['x'] = 'foo';
+        $document['y'] = 'bar';
+
+        return $document;
+    }
+}

Test/Fixture/DocumentJsonFixtures.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+/**
+ * JSON encoded document fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+class DocumentJsonFixtures extends JsonFixtures
+{
+    /**
+     * Loads a document.
+     *
+     * @return string
+     */
+    public static function getDocument()
+    {
+        return static::load('document');
+    }
+}

Test/Fixture/JsonFixtures.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the xAPI package.
+ *
+ * (c) Christian Flothmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Xabbuh\XApi\Common\Test\Fixture;
+
+/**
+ * JSON encoded fixtures.
+ *
+ * @author Christian Flothmann <[email protected]>
+ */
+abstract class JsonFixtures
+{
+    /**
+     * Loads a JSON encoded fixture from the file system
+     *
+     * @param string $file The fixture to load
+     *
+     * @return string The JSON encoded fixture
+     */
+    protected static function load($file)
+    {
+        return file_get_contents(__DIR__.'/fixtures/'.$file.'.json');
+    }
+}