Merge branch '1.1.0'

CollectionJson/Collection.php

@@ -55,11 +55,6 @@ class Collection implements ArrayConvertible
  */
  public function __construct($href)
  {
- // extension validation
- if (!extension_loaded('json')) {
- throw new \RuntimeException('the json extension is required for this library');
- }
-
  $this->setHref($href);
  }
 
@@ -184,15 +179,15 @@ public function addQuery(Property\Query $query)
  /** @return string */
  public function __toString()
  {
- return json_encode($this->__toArray());
+ return json_encode($this->toArray());
  }
 
  /**
  * Converts the whole object to an array
  *
  * @return array
  */
- public function __toArray()
+ public function toArray()
  {
  // defaults
  $collection = array(
@@ -202,19 +197,19 @@ public function __toArray()
 
  // we have an error object
  if ($this->error) {
- $collection['error'] = $this->error->__toArray();
+ $collection['error'] = $this->error->toArray();
  }
 
  // we have a template object
  if ($this->template) {
- $collection = array_merge($collection, $this->template->__toArray());
+ $collection = array_merge($collection, $this->template->toArray());
  }
 
  // we have some other objects
  foreach (array('items', 'queries', 'links') as $type) {
  if (count($this->{$type})) {
  foreach ($this->{$type} as $item) {
- $collection[$type][] = $item->__toArray();
+ $collection[$type][] = $item->toArray();
  }
  }
  }

CollectionJson/Collection/Error.php

@@ -90,7 +90,7 @@ public function getTitle()
  }
 
  /** @return array */
- public function __toArray()
+ public function toArray()
  {
  return array_filter(
  array(

CollectionJson/Collection/Item.php

@@ -125,19 +125,19 @@ public function getLinks()
  }
 
  /** @return array */
- public function __toArray()
+ public function toArray()
  {
  $return = array('href' => $this->getHref());
 
  if (count($this->data)) {
  foreach ($this->getData() as $data) {
- $return['data'][] = $data->__toArray();
+ $return['data'][] = $data->toArray();
  }
  }
 
  if (count($this->links)) {
  foreach ($this->getLinks() as $link) {
- $return['links'][] = $link->__toArray();
+ $return['links'][] = $link->toArray();
  }
  }
 

CollectionJson/Collection/Template.php

@@ -24,7 +24,7 @@ class Template implements ArrayConvertible
 
  /**
  * Constructor
- * 
+ *
  * @param array $setWithData
  */
  public function __construct(array $setWithData = array())
@@ -65,11 +65,11 @@ public function getData()
  }
 
  /** @return array */
- public function __toArray()
+ public function toArray()
  {
  $return = array('template' => array('data' => array()));
  foreach ($this->getData() as $data) {
- $return['template']['data'][] = $data->__toArray();
+ $return['template']['data'][] = $data->toArray();
  }
  return $return;
  }

CollectionJson/Interfaces/ArrayConvertible.php

@@ -11,5 +11,5 @@
 
 interface ArrayConvertible
 {
- public function __toArray();
+ public function toArray();
 }

CollectionJson/Property/Data.php

@@ -90,7 +90,7 @@ public function getValue()
  }
 
  /** @return array */
- public function __toArray()
+ public function toArray()
  {
  $required = array('name' => $this->getName());
  return $required + array_filter(

CollectionJson/Property/Link.php

@@ -139,7 +139,7 @@ public function getRender()
  }
 
  /** @return array */
- public function __toArray()
+ public function toArray()
  {
  $required = array('href' => $this->getHref(), 'rel' => $this->getRel());
  return $required + array_filter(

CollectionJson/Property/Query.php

@@ -144,14 +144,14 @@ public function getData()
  }
 
  /** @return array */
- public function __toArray()
+ public function toArray()
  {
  $required = array('href' => $this->getHref(), 'rel' => $this->getRel());
 
  if (count($this->data)) {
  $required['data'] = array();
  foreach ($this->data as $data) {
- $required['data'][] = $data->__toArray();
+ $required['data'][] = $data->toArray();
  }
  }
 

Dockerfile

@@ -0,0 +1,17 @@
+FROM php:cli
+
+RUN mkdir /opt/collection-json.php
+
+VOLUME ["/opt/collection-json.php"]
+
+WORKDIR /opt/collection-json.php
+
+ENV PATH $PATH:/opt/vendor/bin
+
+RUN cd .. \
+ && php -r "readfile('https://getcomposer.org/installer');" | php \
+ && apt-get update && apt-get install -y zlib1g-dev git \
+ && docker-php-ext-install zip \
+ && pecl install xdebug \
+ && echo "zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20131226/xdebug.so" > /usr/local/etc/php/conf.d/xdebug.ini \
+ && php composer.phar require --prefer-source phpunit/phpunit zerkalica/phpcs:dev-master

README.md

@@ -8,7 +8,7 @@ PHP implementation of the Collection+JSON [specification](http://amundsen.com/me
 Examples of media type in use [can be found here](http://amundsen.com/media-types/collection/examples/).
 
 ## Example
-More examples are located in the ```CollectioTest.php``` test file
+More examples are located in the ```CollectionTest.php``` test file
 
 ```php
 use \CollectionJson\Collection;
@@ -26,17 +26,36 @@ $collection->addItem($item);
 echo $collection;
 ```
 
+## Signatures
+```php
+\CollectionJson\Collection($href);
+
+\CollectionJson\Collection\Item($href, array $setWithData = array(), array $setWithLinks = array());
+\CollectionJson\Collection\Template(array $setWithData = array());
+\CollectionJson\Collection\Error($title = null, $code = null, $message = null);
+
+\CollectionJson\Property\Data($name, $value = null, $prompt = null);
+\CollectionJson\Property\Link($href, $rel, $name = null, $render = null, $prompt = null);
+\CollectionJson\Property\Query($href, $rel, $name = null, $prompt = null, array $data = array());
+```
+
+## Docker
+```sh
+[sudo] docker build .
+[sudo] docker run -v "`pwd`":/opt/collection-json.php IMAGE_ID phpcs --standard=psr2 CollectionJson
+[sudo] docker run -v "`pwd`":/opt/collection-json.php IMAGE_ID phpunit -c tests/phpunit.xml tests
+```
+
 ## Tests
 ```sh
 phpcs --standard=psr2 CollectionJson
-cd tests
-phpunit ./
+phpunit -c tests/phpunit.xml tests
 ```
 
 ## License
 The MIT License (MIT)
 
-Copyright (c) 2013 Kanstantsin Kamkou
+Copyright (c) 2013-2015 Kanstantsin Kamkou
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

composer.json

@@ -1,6 +1,6 @@
 {
  "name": "kkamkou/collection-json.php",
- "version": "1.0.0",
+ "version": "1.1.0",
  "description": "PHP implementation of the Collection+JSON",
  "type": "library",
  "homepage": "http://github.com/kkamkou/collection-json.php",
@@ -18,7 +18,8 @@
  }
  ],
  "require": {
- "php": ">=5.3"
+ "php": ">=5.3",
+ "ext-json": "*"
  },
  "autoload": {
  "psr-0": {

tests/Collection/ErrorTest.php

@@ -15,7 +15,7 @@ public function testConstructor()
  public function testToArrayWithoutNulls()
  {
  $obj = new CollectionJson\Collection\Error('not found', 404, 'Example message');
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('code', 'message', 'title') as $key) {
  $this->assertArrayHasKey($key, $result);
  $this->assertTrue(is_string($result[$key]));
@@ -25,7 +25,7 @@ public function testToArrayWithoutNulls()
  public function testToArrayWithNulls()
  {
  $obj = new CollectionJson\Property\Data('fieldName');
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('code', 'message') as $key) {
  $this->assertFalse(array_key_exists($key, $result));
  }

tests/CollectioTest.php → tests/CollectionTest.php

@@ -5,6 +5,34 @@
 
 class CollectionTest extends PHPUnit_Framework_TestCase
 {
+ public function testChangeVersion()
+ {
+ $collection = new Collection('http://example.org/friends/');
+ $collection->setVersion('2.0');
+
+ $this->assertSame(
+ '{"collection":{"version":"2.0","href":"http:\/\/example.org\/friends\/"}}',
+ (string)$collection
+ );
+ }
+
+ public function testAddMultipleQueries()
+ {
+ $query = new Property\Query('http://example.org/friends/search', 'search', null, 'Search');
+ $query->addData(new Property\Data('search'));
+
+ $query2 = clone $query;
+
+ $collection = new Collection('http://example.org/friends/');
+ $collection->addQuerySet([$query, $query2]);
+
+ $result = json_decode($collection, true);
+ $this->assertEquals(
+ $result['collection']['queries'],
+ [$query->toArray(), $query2->toArray()]
+ );
+ }
+
  public function testFixtureMinimal()
  {
  $collection = new Collection('http://example.org/friends/');
@@ -149,7 +177,7 @@ public function testError()
  $collection = new Collection('http://example.com');
  $collection->setError($error);
  $output = json_decode($collection, true);
- $this->assertEquals($output['collection']['error'], $error->__toArray());
+ $this->assertEquals($output['collection']['error'], $error->toArray());
 
  $collection->setError(new Collection\Error('An error'));
  $output = json_decode($collection, true);
@@ -160,6 +188,6 @@ protected function compareWithFixture($mixed, $name)
  {
  $json = file_get_contents(__DIR__ . "/_fixtures/{$name}.json");
  $json = json_decode($json, true);
- $this->assertEquals($json, $mixed->__toArray());
+ $this->assertEquals($json, $mixed->toArray());
  }
 }

tests/Property/DataTest.php

@@ -21,7 +21,7 @@ public function testConstructor()
  public function testToArrayWithoutNulls()
  {
  $obj = new CollectionJson\Property\Data('fieldName', 'value', 'Test value');
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('name', 'value', 'prompt') as $key) {
  $this->assertArrayHasKey($key, $result);
  }
@@ -30,7 +30,7 @@ public function testToArrayWithoutNulls()
  public function testToArrayWithNulls()
  {
  $obj = new CollectionJson\Property\Data('fieldName');
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('prompt') as $key) {
  $this->assertFalse(array_key_exists($key, $result));
  }

tests/Property/LinkTest.php

@@ -42,7 +42,7 @@ public function testToArrayWithoutNulls()
  $obj = new CollectionJson\Property\Link(
  'http://example.com', 'homepage', 'My Homepage', 'link', 'Link to the homepage'
  );
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('href', 'rel', 'name', 'render', 'prompt') as $key) {
  $this->assertArrayHasKey($key, $result);
  }
@@ -51,7 +51,7 @@ public function testToArrayWithoutNulls()
  public function testToArrayWithNulls()
  {
  $obj = new CollectionJson\Property\Link('http://example.com', 'homepage');
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('name', 'render', 'prompt') as $key) {
  $this->assertFalse(array_key_exists($key, $result));
  }

tests/Property/QueryTest.php

@@ -30,7 +30,7 @@ public function testToArrayWithoutNulls()
  'http://example.com/search', 'search', 'Search', 'Search page', array($data)
  );
 
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('href', 'rel', 'name', 'data', 'prompt') as $key) {
  $this->assertArrayHasKey($key, $result);
  }
@@ -39,7 +39,7 @@ public function testToArrayWithoutNulls()
  public function testToArrayWithNulls()
  {
  $obj = new CollectionJson\Property\Query('http://example.com', 'homepage');
- $result = $obj->__toArray();
+ $result = $obj->toArray();
  foreach (array('name', 'data', 'prompt') as $key) {
  $this->assertFalse(array_key_exists($key, $result));
  }