Shortcut method for creating response from a string #52

franzliedke · 2015-06-08T22:37:38Z

Creating a response object from a string of HTML (etc.) seems to be a very common use-case, so we might as well make it very easy (without having to handle streams).

$voila = Response::fromString($html)

mtymek · 2015-06-08T22:51:23Z

I always wonder, should convenience method like proposed one be a part of main object, or is it better to create factory class?

franzliedke · 2015-06-08T23:09:46Z

I don't think there's a need for a factory class here - this is a factory method and the whole point is to make instantiation easier. I don't think a factory class would serve that purpose. ;)

weierophinney · 2015-06-08T23:37:03Z

@franzliedke I do not want this on the response object, as it's ambiguous: does the method expect an entire response string (including status line and headers), or just the body? From the name, it's unclear.

Additionally, it violates SRP; the message is a value object; what you're proposing is a builder.
(This is also the reason why the methods that can de/serialize entire message are in separate classes.) Create a factory, or an extension class:

namespace Zend\Diactoros\Response;

use Zend\Diactoros\Response;

class HtmlResponse extends Response
{
    public function __construct($html)
    {
        $this->body = new Stream();
        $this->body->write($html);
    }
}

Or similar. (This may require that we make a property or two protected instead of private, however.)

Alternately, a factory, as you suggested, would also be reasonable. But not a static factory method on the message itself.

franzliedke · 2015-06-08T23:41:46Z

It's just an alternate constructor for the one use case that I encountered most often when using this library. A factory class would destroy any ease of use that this PR aims to introduce.

franzliedke · 2015-06-08T23:46:39Z

I agree that the naming could be improved (any suggestions?), but I'd argue, or rather let Mathias Verraes argue, that named constructor methods are totally sensible when used in a use-case-driven way.

weierophinney · 2015-06-08T23:49:08Z

No, it wouldn't.

use Zend\Diactoros\Response\HtmlResponse;

// constructor version:
$response = new HtmlResponse($html);

// factory approach:
$response = HtmlResponse:: fromHtml($html);

For the consumer, it replaces the import statement they'd otherwise use for importing the response class, and remains a single call.

It's also semantically more clear, as the class name and/or factory indicates that html is expected.

In both cases, you have a PSR -7 response instance in the end.

Choose which syntax you prefer, update the PR, and I'll review.

franzliedke · 2015-06-08T23:59:28Z

Oh, you want the extension class as part of this package? In that case, I'm all in. ;)

Sorry, I thought you were suggesting I should add my own subclass whenever consuming this package.

This allows easy creation of responses with string content. No need to mess with streams.

franzliedke · 2015-06-09T00:34:34Z

Okay, I created a subclass now. Please check it out. :)

trowski · 2015-06-09T05:11:30Z

Creating another response class to create a stream from a string makes little sense. There's nothing different about the behavior of the HtmlResponse. Also why HTML? There's a lot of other content types that you might want to send, such as JSON.

I think what you're really looking for is a StreamInterface object that can be constructed from directly from a string.

class MemoryStream extends Stream
{
    public function __construct($contents)
    {
        parent::__construct('php://memory', 'w+');
        $this->write($contents);
    }
}

This stream could be used when creating a Response object:

$response = new Response(new MemoryStream($contents));

gianarb · 2015-06-09T07:19:56Z

    HTTP/1.1 200 OK
    Date: Mon, 19 Jul 2004 16:18:20 GMT
    Server: Apache
    Last-Modified: Sat, 10 Jul 2004 17:29:19 GMT
    ETag: "1d0325-2470-40f0276f"
    Accept-Ranges: bytes
    Content-Length: 9328
    Connection: close
    Content-Type: text/html

    <HTML>
    <HEAD>
    ... the rest of the home page...

This is an example of string response.. IMO..
Maybe we can find to write a factory to creare response from this draft.. But I don't know if it's a good approach.

franzliedke · 2015-06-09T10:11:22Z

@trowski No, I don't want to create a stream to instantiate a response from a simple string.
I personally agree that there's no need for a subclass, since as you mention there's no different behaviour. But that's what @weierophinney wanted, so I'm going with it. :)

I agree that HtmlResponse is not perfect - any suggestions? What about StringResponse?

mtymek · 2015-06-09T10:27:52Z

What about separate factory class then? I think that using inheritance to provide different way of creating object is not good OOP practice, as after instantiation process you end up with the very same class.

Separate factory class can also be used to create different convenience methods, for different use cases.

sasezaki · 2015-06-09T13:31:41Z

here other solution ;D
new Zend\Diactoros\Response("data://text/html,Hello world")

weierophinney · 2015-06-09T13:42:34Z

src/HtmlResponse.php

+     */
+    public function __construct($html, $status = 200, array $headers = [])
+    {
+        parent::__construct('php://memory', $status, $headers);


Use php://temp here. php://temp will use memory, but, more importantly, if the memory limit is reached, it will dump to a temp file, freeing up memory, which is useful with large payloads.

Done, thanks.

Considering that this is an HTML response, perhaps the Content-Type header should also be set?

$hasContentType = array_reduce(array_keys($headers), function ($carry, $item) { return $carry ?: (strtolower($item) === 'content-type'); }, false); if (! $hasContentType) { $headers['content-type'] = ['text/html']; // or application/xhtml+xml, one of the two } parent::__construct('php://temp', $status, $headers);

(The array_reduce is in there because we can't guarantee the casing of the header keys.)

I don't want this to be a HTML response, though, just a StringResponse. We could, of course, add helpers for the most commonly used ones. Something like Response::html() and Response::json() would come to mind.

weierophinney · 2015-06-09T14:02:50Z

I posted a comment on a line that then became outdated, and now we're losing some comments in the UI, so..

I commented that since this was listed as an HtmlResponse, perhaps the Content-Type header should have a default:

$hasContentType = array_reduce(array_keys($headers), function ($carry, $item) {
    return $carry ?: (strtolower($item) === 'content-type');
}, false);

if (! $hasContentType) {
    $headers['content-type'] = ['text/html']; // or application/xhtml+xml
}

parent::__construct('php://temp', $status, $headers);

To which @franzliedke replied:

I don't want this to be a HTML response, though, just a StringResponse. We could, of course, add helpers for the most commonly used ones. Something like Response::html() and Response::json() would come to mind.

This sounds to me like we likely want a factory, that has some common logic. Here's a take on that:

namespace Zend\Diactoros\Response;

use Zend\Diactoros\Response;
use Zend\Diactoros\Stream;

final class StringResponse
{
    /**
     * Do not allow instantiation
     */
    private function __construct()
    {
    }

    public static function html($html, $status = 200, array $headers = [])
    {
        return self::createResponse($html, 'text/html', $status, $headers);
    }

    public static function json($jsonOrData, $status = 200, array $headers = [])
    {
        if (! is_string($jsonOrData)) {
            $jsonOrData = json_encode($jsonOrData, JSON_UNESCAPED_SLASHES);
        }
        return self::createResponse($jsonOrData, 'application/json', $status, $headers);
    }

    private static function createResponse($text, $type, $status, $headers)
    {
        $hasContentType = array_reduce(array_keys($headers), function ($carry, $item) {
            return $carry ?: (strtolower($item) === 'content-type');
        }, false);

        if (! $hasContentType) {
            $headers['content-type'] = [$type];
        }

        $body = new Stream();
        $body->write($text);

        return new Response($body, $status, $headers);
    }
}

Usage would be:

use Zend\Diactoros\Response\StringResponse;

// HTML
$response = StringResponse::html($html);
$response = StringResponse::html($html, 200, ['content-type' => ['application/xhtml+xml']]);

// JSON
$response = StringResponse::json($json);
$response = StringResponse::json($objectToRepresentAsJson);

Thoughts?

franzliedke · 2015-06-09T14:07:21Z

I like where this is going. I'll have a go at this later tonight.

franzliedke · 2015-06-12T00:19:16Z

@weierophinney Okay, I integrated your proposal. We have a StringResponse factory now, with helpers for HTML and JSON.

samsonasik · 2015-06-12T04:26:31Z

src/Response/StringResponse.php

+    public static function json($data, $status = 200, array $headers = [])
+    {
+        if ($data === null) {
+            $data = new \ArrayObject();


ArrayObject can be moved to use statement

I wonder why do you want to encode an empty ArrayObject instead of null?

@samsonasik Will fix in a second.
@slavcodev Because there's no null in JSON.

@franzliedke what do you mean?

JSON Schema primitive types: boolean, string, number, null, array, object

anyway, perhaps you may write

json_encode([], JSON_FORCE_OBJECT)

and not to create a temporary instance.

From http://php.net/json_encode:

RFC 4627 only supports these values when they are nested inside an array or an object.

@franzliedke Good to known. Thanks. 👍

samsonasik · 2015-06-12T11:40:47Z

src/Response/StringResponse.php

+
+    private function __construct()
+    {
+    }


this is for what ?

It ensures that the factory class can not be instantiated directly.

To enforce that the factory class is non-instatiable.
On Jun 12, 2015 6:40 AM, "Abdul Malik Ikhsan" notifications@github.com
wrote:

In src/Response/StringResponse.php
#52 (comment)
:

\* @return Response

*/

public static function json($data, $status = 200, array $headers = [])

{

if ($data === null) {

$data = new ArrayObject();

}

$json = json_encode($data, JSON_UNESCAPED_SLASHES);

return static::createResponse($json, $status, $headers, 'application/json');

}

private function __construct()

{

}

this is for what ?

—
Reply to this email directly or view it on GitHub
https://github.com/zendframework/zend-diactoros/pull/52/files#r32308786.

so, needs doc comment ?

I think we can add comment then like :

/** * This class is non-instantiable, * You can use Zend\Diactoros\Response\StringResponse::staticMethod() directly */

franzliedke · 2015-06-12T11:59:46Z

@weierophinney

franzliedke · 2015-06-12T11:59:57Z

Whoops, sorry.

Shortcut method for creating response from a string

- Added method docblocks where missing. - Added behavior to `json()` method: cast scalars to array prior to attempts to serialize.

Close #52

weierophinney · 2015-06-12T17:11:59Z

Merged to develop for release with 1.1. Thanks, @franzliedke !

Combined entries from #52, #58, #59, and #61 into one single narrative entry.

Create shortcut method for creating response from a string

9e25817

Add a HtmlResponse subclass.

5e0677e

This allows easy creation of responses with string content. No need to mess with streams.

weierophinney reviewed Jun 9, 2015
View reviewed changes

Use php://temp stream

84d823c

franzliedke added 2 commits June 12, 2015 02:17

Adapt tests to proposed new factory class

ead339f

Create StringResponse factory

f27279c

samsonasik reviewed Jun 12, 2015
View reviewed changes

Import ArrayObject class

74370f9

samsonasik reviewed Jun 12, 2015
View reviewed changes

franzliedke closed this Jun 12, 2015

franzliedke reopened this Jun 12, 2015

weierophinney added the enhancement label Jun 12, 2015

weierophinney added this to the 1.1.0 milestone Jun 12, 2015

weierophinney self-assigned this Jun 12, 2015

weierophinney mentioned this pull request Jun 12, 2015

Why init stream property in the constructor? #54

Closed

weierophinney merged commit 74370f9 into zendframework:develop Jun 12, 2015

weierophinney added a commit that referenced this pull request Jun 12, 2015

Merge pull request #52 from franzliedke/shortcut-create

61aa834

Shortcut method for creating response from a string

weierophinney added a commit that referenced this pull request Jun 12, 2015

[#52] Review prior to merge

654e57b

- Added method docblocks where missing. - Added behavior to `json()` method: cast scalars to array prior to attempts to serialize.

weierophinney added a commit that referenced this pull request Jun 12, 2015

Added CHANGELOG for #52

5c65ddc

weierophinney added a commit that referenced this pull request Jun 12, 2015

Documented #52

d953d48

weierophinney added a commit that referenced this pull request Jun 12, 2015

Merge branch 'feature/52' into develop

a6b66c7

Close #52

weierophinney added a commit that referenced this pull request Jun 23, 2015

Documented #58 and #52

7af500a

weierophinney mentioned this pull request Jun 23, 2015

Implement RedirectResponse #59

Merged

weierophinney added a commit that referenced this pull request Jun 24, 2015

Updated CHANGELOG for #61

57c9caa

Combined entries from #52, #58, #59, and #61 into one single narrative entry.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Shortcut method for creating response from a string #52

Shortcut method for creating response from a string #52

franzliedke commented Jun 8, 2015

mtymek commented Jun 8, 2015

franzliedke commented Jun 8, 2015

weierophinney commented Jun 8, 2015

franzliedke commented Jun 8, 2015

franzliedke commented Jun 8, 2015

weierophinney commented Jun 8, 2015

franzliedke commented Jun 8, 2015

franzliedke commented Jun 9, 2015

trowski commented Jun 9, 2015

gianarb commented Jun 9, 2015

franzliedke commented Jun 9, 2015

mtymek commented Jun 9, 2015

sasezaki commented Jun 9, 2015

weierophinney Jun 9, 2015

franzliedke Jun 9, 2015

weierophinney Jun 9, 2015

franzliedke Jun 9, 2015

weierophinney commented Jun 9, 2015

franzliedke commented Jun 9, 2015

franzliedke commented Jun 12, 2015

samsonasik Jun 12, 2015

slavcodev Jun 12, 2015

franzliedke Jun 12, 2015

slavcodev Jun 12, 2015

franzliedke Jun 12, 2015

slavcodev Jun 12, 2015

samsonasik Jun 12, 2015

franzliedke Jun 12, 2015

weierophinney Jun 12, 2015

sasezaki Jun 12, 2015

samsonasik Jun 12, 2015

franzliedke commented Jun 12, 2015

franzliedke commented Jun 12, 2015

weierophinney commented Jun 12, 2015

Shortcut method for creating response from a string #52

Shortcut method for creating response from a string #52

Conversation

franzliedke commented Jun 8, 2015

mtymek commented Jun 8, 2015

franzliedke commented Jun 8, 2015

weierophinney commented Jun 8, 2015

franzliedke commented Jun 8, 2015

franzliedke commented Jun 8, 2015

weierophinney commented Jun 8, 2015

franzliedke commented Jun 8, 2015

franzliedke commented Jun 9, 2015

trowski commented Jun 9, 2015

gianarb commented Jun 9, 2015

franzliedke commented Jun 9, 2015

mtymek commented Jun 9, 2015

sasezaki commented Jun 9, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weierophinney commented Jun 9, 2015

franzliedke commented Jun 9, 2015

franzliedke commented Jun 12, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franzliedke commented Jun 12, 2015

franzliedke commented Jun 12, 2015

weierophinney commented Jun 12, 2015