HTML5 Data Attributes

And a patch.

Aditya, the example should be right but the syntax is Ruby 1.9. The 1.8.x equivalent:

div_for user, :data => { :name => user.name, :location => { :city => user.city, :state => user.state } } do
# ...

Thanks for taking a look!

Happy to add documentation if the interest is there :)

Stephen, excellent the idea is good. Let's work a bit on the patch.

It would definitely need documentation. On one hand in the very method API of course. I think also that this idiom should be preferred, so existing examples would be rewritten as well. Would you please ack the tree for them?

The call to h() could double-escape stuff, perhaps html_safe? could be checked?

Also, assert_dom_equal would probably be better for the test.

Would you like to work on these remarks?

Xavier,

Are you talking about moving all examples to the 1.9 supported format (the one similar to json)? Wouldnt that cause a bit of an uproar? I'll be happy to make the change to the documentation if its okay with Stephen.

I mean, ack for

ack '^\s*#.*data-'

and see whether the new idiom is better in some example (perhaps the answer is there are none worth changing, don't know). The idea is that examples should implicitly communicate the preferred way of doing things.

BTW, h() checks html_safe? it could be the case that the check is not needed.

Ah, Aditya, regarding docs contribution.

Any patch should have proper code, tests, and docs. Remember, the source of documentation is master. Doing a separate patch for docs would be like doing a separate patch for tests. I think it is better that there's a single patch, complete and round.

Xavier, i misunderstood your earlier comment as moving all (even unrelated to this particular change) examples to the 1.9 format.
Yes I understand that a patch should include all relevant bits (code, docs, test) as one commit as far as possible.

Having said that (and feel free to PM on github if the conversation is digressing), what is the policy per ruby 1.9 way of doing things in Rails examples and documentation. Are we actively updating documentation to show the 1.9 way or still making sure the documentation is backward compatible with 1.8?

Not really, policy is not to use 1.9 by now. Examples should run in the officially supported versions.

When we drop 1.8 then example code should be updated to use what is considered to be best in 1.9.

I'll clean up the patch and add 1.8-formatted docs.

Here's an update to the patch with documentation and a couple changes:

• Symbols will not be JSON-escaped (to avoid JavaScript ""strings"").
• Data sub-keys will be dasherized.

For the second change, I realized that the HTML5 JavaScript API automatically converts dashed-words to camelCase, so it makes sense to go by best practices.

// E.g., #id[data-foo-bar="baz"]
document.getElementById("id").dataset.fooBar // => "baz"

If a person prefers more control over this, they can of course declare the entire "data-with_underscores" keys.

omega watch