Add browserkit component documentation #4312

yamiko-ninja · 2014-10-10T17:35:16Z

Working on documentation for the browser kit. Fixes #954
Pull request #4310 was to the wrong branch so making a new one

cordoval · 2014-10-10T17:36:02Z

components/browser_kit/introduction.rst

+   single: Components; BrowserKit
+
+The BrowserKit Component
+=========================


yamiko-ninja · 2014-10-11T23:05:15Z

This month is pretty busy so progress will be a little slow. What topics in particular do you think I should include in the documentation?

wouterj · 2014-10-12T10:02:28Z

The most important part is explaining how the component works (by using a Client to simulate the HTTP layer). This means you have to explain that you need to create a new client by extending Client and implementing the doRequest() method:

    /**
     * Makes a request.
     *
     * @param object $request An origin request instance
     *
     * @return object An origin response instance
     */
    abstract protected function doRequest($request);

Then you need to tell something about the Request and Response objects (since that's important for the doRequest method).

After that, you can talk about some more advanced topics like using Cookie and CookieJar, History and insulated requests (by implementing Client#getScript()).

One tip: Look at how Symfony, Laravel and Goutte implemented the Client for examples and look at the tests on how these classes work.

stof · 2014-10-13T15:32:13Z

Btw, I think it is worth linking to the 2 existing implementations of the BrowserKit client:

the HttpKernel one which simulates requests by calling the HttpKernel directly for testing purposes
Goutte, which performs real HTTP requests.

stof · 2014-10-13T15:32:59Z

components/browser_kit/introduction.rst

+
+For an implementation based on HttpKernelInterface, have a look at the Client provided by the :doc:`/components/http_kernel/introduction`.
+
+.. _Packagist: https://packagist.org/packages/symfony/event-dispatcher


wouterj · 2015-02-19T22:59:16Z

ping @yamiko-ninja do you have time in the future to bring this PR to the next level? If not, please say so, then someone else can take it over.

yamiko-ninja · 2015-03-02T20:24:21Z

@wouterj ahh forgot about it!

If someone wants to take over they can. otherwise I will put this on my todo list to do by the end of April. About to move in a few weeks.

wouterj · 2015-05-15T16:10:53Z

Hi @yamiko-ninja! Just wanted to let you know that there will be a doc sprint day on May 23rd. You can join in then to get quick feedback & other help. If you no longer have the motivation/time to finish this PR, we can also put it on the list for other people to take over.

Thanks for the bootstrapping!

yamiko-ninja · 2015-05-15T16:47:23Z

I will put that day on my calendar and will do some more work on it in the meantime. I have time to work on this again now.

javiereguiluz · 2015-06-22T14:04:48Z

@wouterj I have some concerns about this PR. @yamiko-ninja has done a great work bootstraping the documentation of the component. However, if we expect him to complete all the documentation, maybe that's too much for a single person (hence my concerns).

What do you think if we lower the expectations of this PR to consider it just the bootstraping of the component documentation. That way we can polish @yamiko-ninja's current work a bit and merge it. Then, we outline all the contents we want to add to this section and complete that task in further pull requests.

xabbuh · 2015-06-22T15:58:08Z

I agree with you @javiereguiluz for two reasons:

Only bootstrapping a rough skeleton would make it easier to get something started.
We can then create a list of smaller TODOs which would make it easier for other contributors to pick a single simple task.

yamiko-ninja · 2015-07-07T23:02:15Z

I agree. I have only made a few contributions here and there I would be fine with someone else taking over.

I am also not very knowledgeable about this component so I have been adding docs whenever I learn something about it.

OskarStark · 2015-10-18T08:41:00Z

components/browser_kit/introduction.rst

+
+.. code-block:: php
+
+    namespace ACME;


should be AppBundle

No, we are in the components section here. It should not use framework things like bundles

yamiko-ninja · 2015-11-10T01:30:24Z

I added in some docs on cookies. I think this is a good start and other can add more to it if they like. With that in mind I removed the [WIP] from the title.

xabbuh · 2015-11-12T21:19:49Z

components/browser_kit/introduction.rst

+
+    The BrowserKit component simulates the behavior of a web browser.
+
+The BrowserKit component allows you to make web request, click on links and submit forms. 


xabbuh · 2015-11-12T21:20:26Z

components/browser_kit/introduction.rst

+Installation
+------------
+
+You can install the component in 2 different ways:


"two" instead of "2"

xabbuh · 2015-11-12T21:25:44Z

This looks pretty good so far. Thanks for your work @yamiko-ninja! I have left you a few comments (I wasn't able to look into this too deeply yet). And could you please also update this so that each lines is wrapped after the first word that crosses the 72nd character?

yamiko-ninja · 2015-11-12T21:29:25Z

@xabbuh thanks for all the corrections. I will make the changes over the weekend.

javiereguiluz · 2015-12-23T15:13:15Z

@yamiko-ninja you did a great work in this pull request. We just need a final push to finish it. That's what I'm trying to do in #6072. I've reused your original commits, so you'll get full credit for your work once the other pull request is merged. Thanks!

@yamiko-ninja

…ninja, robert Parker, javiereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- Add browserkit component documentation | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | - This PR tries to finish the fantastic work made by @yamiko-ninja in #4312. Please review it so I can improve/finish it and we can merge it before year's end. Thanks! Commits ------- 3f0858f Fixed a syntax issue c9093a8 Implemented changes suggested by Wouter e7056a8 Fixed a reference 5aec7c4 Minor fixes fd35c93 Fixed a syntax issue 883c062 Finished the first version of the BrowserKit doc 03ea5a5 fix title underline a1df783 spelling and formating ea3fd71 Adding documentation for cookies 6b6e23a added docs on histroy a3d158e added form submissions and moved creating a client to top 74cfecd more outlines, fixed link, added more about creating a client dda78ba added a link snippit 94bb3bf fixed spelling 6997c4f make a basic request b3d9eb3 added links to index and map files f0f8a50 added links with info about clients and packagist link 1e5ca13 added in sections that I apln to fill out 9c007e9 syntax fix 645d50d fixed a few mistakes 93d7258 added introduction

yamiko added 2 commits October 9, 2014 11:17

added introduction

f4732a9

fixed a few mistakes

9cda982

cordoval reviewed Oct 10, 2014
View reviewed changes

yamiko added 7 commits October 10, 2014 11:31

syntax fix

33a3a64

added in sections that I apln to fill out

9ae95dc

added links with info about clients and packagist link

4d9e48d

added links to index and map files

59a9dbf

make a basic request

f956182

fixed spelling

51f320a

added a link snippit

d4c24e4

wouterj added the Status: Needs Work label Oct 11, 2014

stof reviewed Oct 13, 2014
View reviewed changes

more outlines, fixed link, added more about creating a client

cd4f6ec

yamiko-ninja added 2 commits May 23, 2015 10:55

added form submissions and moved creating a client to top

05c89d5

added docs on histroy

982476e

OskarStark reviewed Oct 18, 2015
View reviewed changes

Adding documentation for cookies

0923ac4

yamiko-ninja changed the title ~~[WIP]Add browserkit component documentation~~ Add browserkit component documentation Nov 10, 2015

xabbuh reviewed Nov 12, 2015
View reviewed changes

yamiko-ninja added 2 commits November 19, 2015 01:34

spelling and formating

2731858

fix title underline

f119848

javiereguiluz mentioned this pull request Dec 23, 2015

Add browserkit component documentation #6072

Merged

wouterj closed this Dec 23, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add browserkit component documentation #4312

Add browserkit component documentation #4312

yamiko-ninja commented Oct 10, 2014

cordoval Oct 10, 2014

yamiko-ninja commented Oct 11, 2014

wouterj commented Oct 12, 2014

stof commented Oct 13, 2014

stof Oct 13, 2014

wouterj commented Feb 19, 2015

yamiko-ninja commented Mar 2, 2015

wouterj commented May 15, 2015

yamiko-ninja commented May 15, 2015

javiereguiluz commented Jun 22, 2015

xabbuh commented Jun 22, 2015

yamiko-ninja commented Jul 7, 2015

OskarStark Oct 18, 2015

wouterj Oct 18, 2015

yamiko-ninja commented Nov 10, 2015

xabbuh Nov 12, 2015

xabbuh Nov 12, 2015

xabbuh commented Nov 12, 2015

yamiko-ninja commented Nov 12, 2015

javiereguiluz commented Dec 23, 2015


		For an implementation based on HttpKernelInterface, have a look at the Client provided by the :doc:`/components/http_kernel/introduction`.

		.. _Packagist: https://packagist.org/packages/symfony/event-dispatcher


		The BrowserKit component simulates the behavior of a web browser.

		The BrowserKit component allows you to make web request, click on links and submit forms.

Add browserkit component documentation #4312

Add browserkit component documentation #4312

Conversation

yamiko-ninja commented Oct 10, 2014

cordoval Oct 10, 2014

Choose a reason for hiding this comment

yamiko-ninja commented Oct 11, 2014

wouterj commented Oct 12, 2014

stof commented Oct 13, 2014

stof Oct 13, 2014

Choose a reason for hiding this comment

wouterj commented Feb 19, 2015

yamiko-ninja commented Mar 2, 2015

wouterj commented May 15, 2015

yamiko-ninja commented May 15, 2015

javiereguiluz commented Jun 22, 2015

xabbuh commented Jun 22, 2015

yamiko-ninja commented Jul 7, 2015

OskarStark Oct 18, 2015

Choose a reason for hiding this comment

wouterj Oct 18, 2015

Choose a reason for hiding this comment

yamiko-ninja commented Nov 10, 2015

xabbuh Nov 12, 2015

Choose a reason for hiding this comment

xabbuh Nov 12, 2015

Choose a reason for hiding this comment

xabbuh commented Nov 12, 2015

yamiko-ninja commented Nov 12, 2015

javiereguiluz commented Dec 23, 2015