Add documentation to ActionDispatch::Request

[garethrees]

I've added some documentation to the following:

• ActionDispatch::Request#fullpath
• ActionDispatch::Request#original_url
• ActionDispatch::Request#media_type

Could someone check that I've explained them correctly?

I also have a question about Request#media_type referring to it's documentation.

I created a simple blog and used respond_with so that the articles index responds to XML and JSON.

Here's what I get in the console:

app.get '/articles.xml'
app.request.media_type
 => "application/x-www-form-urlencoded" 

app.get '/articles.json'
app.request.media_type
 => "application/x-www-form-urlencoded"

Should I be seeing application/xml and application/json respectively?

[steveklabnik]

The docs look good, thank you.

[steveklabnik]

Should I be seeing application/xml and application/json respectively?

Hmm, I am not sure, but yes, that looks funny to me.

[carlosantoniodasilva]

.response? Shouldn't this be .request?

[steveklabnik]

Ugh, I think so, yes. Brains are a funny thing. I'll fix that now.

[garethrees]

Argh! Sorry! Obviously hadn't had enough coffee this morning. Just noticed another one…

[steveklabnik]

Fixed in 5bf6d8e

[carlosantoniodasilva]

I'm afraid people will look at the docs and ask themselves: "wtf is app?". I don't think the app should be mentioned in the docs.

[garethrees]

Should be:

 #    app.get "/articles"
 #    app.request.media_type
 #    # => "application/x-www-form-urlencoded"

[carlosantoniodasilva]

👍.

[steveklabnik]

Fixed in a3c8e4a

[steveklabnik]

@carlosantoniodasilva What instead? Rails.application? I've seen app elsewhere, so it made sense to me, though I am admittedly outside of the norm. ;)

[carlosantoniodasilva]

@steveklabnik I believe @garethrees has tested this in the console, where app is an instance of Rails' integration test class. I think it's not related with the request docs, so we should probably not mention it.

How about:

#    # assume a GET to "/articles"
#    request.fullpath # => "/articles"

Or just removing it seems ok:

#    get "/articles"
#    request.fullpath # => "/articles"

Wdyt?

[steveklabnik]

I'm happy if you're happy. You can go ahead and make that change, I'm done screwing up this simple commit. :)

[garethrees]

@garethrees has tested this in the console

Yup. Thought that was a common trick, but I agree it makes less sense when accessing request from a controller.

The main reason I was documenting it is because I kept having to check which would give me base_url / params etc.

While we're at it, what does original_fullpath do? Could also be worth clarifying original_url?

[carlosantoniodasilva]

@steveklabnik hehe alright :)

@garethrees I think it is a common trick, it's just that might not be worth mentioning it in the docs regarding the request methods.

original_fullpath was added by @drogus to fix an engine issue iirc, but I don't remember the details, maybe @drogus does. This is the commit that added it: 482ec2a.