Where can I find good AREL documentation?

Question

I'm trying to learn as much as I can about AREL. But I'm not sure what to look at.

I found some documentation on rubydoc, but it doesn't seem very good in terms of showing what are the "public API"/accessible things I can do. For example, I could not find any information on the "includes" method.

So, how exactly to learn most of what AREL has to offer? (i.e. without delving into the source code)

maybe consider choosing the most up voted answer? :p – Philip C Nov 21 '12 at 20:35 — Philip C, Nov 21 '12 at 20:35

Philip C · Answer 1 · 2013-06-14T14:32:46.113

18

I got tired of reading tests and code, in the arel tree, so I put some slides together. They cover v2.x, I haven't even looked at v3 yet.

edited Jun 14 '13 at 14:32

answered Feb 27 '12 at 06:37

Philip C

691
7
18

That's an excellent set of slides, thanks for putting them together! – Purplejacket Mar 12 '12 at 19:26
i'm glad someone found them useful – Philip C Mar 19 '12 at 18:45
@PhilipC as I go through your slides, I get redirected to Facebook. Bizarre. – David J. Feb 08 '13 at 00:20
@DavidJames, can you be more specific? I just clicked through and wasn't redirected – Philip C Feb 14 '13 at 21:33
@PhilipC The problem was temporary -- probably on my end. – David J. Feb 28 '13 at 06:16
The post is asking for a password. – graywh May 14 '13 at 20:37
mmm, someone defaced the blog ... when we migrated it, we apparently didn't deign to bring our content with us... sigh :/ – Philip C Jun 14 '13 at 14:33

score 8 · Answer 2 · answered Aug 20 '14 at 11:11

8

I wrote an article about Arel a few weeks ago (The definitive guide to Arel, the SQL manager for Ruby). It walks through the whole library and explains how things work internally and how you can use it from your own application.

answered Aug 20 '14 at 11:11

Jiří Pospíšil

14,296
2
41
52

This was really helpful, thank you! – dzajic Mar 09 '20 at 22:55

Spyros · Accepted Answer · 2011-04-16T21:19:02.870

5

I think that this will be useful :

https://github.com/brynary/arel

And an interesting asciicast :

http://asciicasts.com/episodes/215-advanced-queries-in-rails-3

edited Apr 16 '11 at 21:19

answered Apr 16 '11 at 20:47

Spyros

46,820
25
86
129

13

Unfortunately, that's hardly any documentation. I can't even find the word "includes" on that page. I was looking for something more thorough.. – Zabba Apr 16 '11 at 21:09
includes is an active record method, so it won't probably be there, or just may be as an example. – Spyros Apr 16 '11 at 21:15
There is an asciicast that also has some nice info, i'm adding it to the post. – Spyros Apr 16 '11 at 21:18
Other than those resources, i don't think there is something more detailed to tell you the truth. – Spyros Apr 16 '11 at 21:19

score 4 · Answer 4 · answered Sep 16 '11 at 22:27

4

Yeah, I'm having a real hard time finding doc too. The Arel test suite might be of some use:

https://github.com/rails/arel/blob/master/test/test_select_manager.rb

answered Sep 16 '11 at 22:27

Purplejacket

1,808
2
25
43

score 2 · Answer 5 · answered Apr 10 '13 at 04:41

2

Complete documentation is here: http://rubydoc.info/github/rails/arel/master/Arel Look in the modules for specific methods.

answered Apr 10 '13 at 04:41

Christian

37
3

Where can I find good AREL documentation?

5 Answers5

Linked