github-migration/rabl-rails
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Correct indent in README

Browse Source
This commit is contained in:
ccocchi 2012-07-15 23:22:51 +02:00
parent 07a18c9f1d
commit 3224a33489
1 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -69,12 +69,12 @@ The fact of compiling the template outside of any rendering context prevent us t
The only places where you can actually used instance variables are into Proc (or lambda) or into custom node (because they are treated as Proc). The only places where you can actually used instance variables are into Proc (or lambda) or into custom node (because they are treated as Proc).
```ruby ```ruby
# We reference the @posts varibles that will be used at rendering time # We reference the @posts varibles that will be used at rendering time
collection :@posts collection :@posts
# Here you can use directly the instance variable because it # Here you can use directly the instance variable because it
# will be evaluated when rendering the object # will be evaluated when rendering the object
node(:read) { |post| post.read_by?(@user) } node(:read) { |post| post.read_by?(@user) }
``` ```
The same rule applies for view helpers such as `current_user` The same rule applies for view helpers such as `current_user`
@ -98,19 +98,19 @@ collection :@users
You can specify root label for the collection using hash or `:root` option You can specify root label for the collection using hash or `:root` option
```ruby ```ruby
collection :@posts, root: :articles collection :@posts, root: :articles
#is equivalent to #is equivalent to
collection :@posts => :articles collection :@posts => :articles
# => { "articles" : [{...}, {...}] } # => { "articles" : [{...}, {...}] }
``` ```
There are rares cases when the template doesn't map directly to any object. In these cases, you can set data to false or skip data declaration altogether. There are rares cases when the template doesn't map directly to any object. In these cases, you can set data to false or skip data declaration altogether.
```ruby ```ruby
object false object false
node(:some_count) { |_| @user.posts.count } node(:some_count) { |_| @user.posts.count }
child(:@user) { attribute :name } child(:@user) { attribute :name }
``` ```
### Attributes / Methods ### Attributes / Methods
@ -118,14 +118,14 @@ There are rares cases when the template doesn't map directly to any object. In t
Basic usage is to declared attributes to include in the response. These can be database attributes or any instance method. Basic usage is to declared attributes to include in the response. These can be database attributes or any instance method.
```ruby ```ruby
attributes :id, :title, :to_s attributes :id, :title, :to_s
``` ```
You can aliases these attributes in your response You can aliases these attributes in your response
```ruby ```ruby
attributes title: :foo, to_s: :bar attributes title: :foo, to_s: :bar
# => { "foo" : <title value>, "bar" : <to_s value> } # => { "foo" : <title value>, "bar" : <to_s value> }
``` ```
### Child nodes ### Child nodes
@ -134,18 +134,18 @@ You can include nested information from data associated with the parent model. Y
For example if you have a `Post` model that belongs to a `User` For example if you have a `Post` model that belongs to a `User`
```ruby ```ruby
object :@post object :@post
child(user: :author) do child(user: :author) do
attributes :name attributes :name
end end
# => { "post" : { "author" : { "name" : "John D." } } } # => { "post" : { "author" : { "name" : "John D." } } }
``` ```
You can also use arbitrary data source with child nodes You can also use arbitrary data source with child nodes
```ruby ```ruby
child(:@users) do child(:@users) do
attributes :id, :name attributes :id, :name
end end
``` ```
### Custom nodes ### Custom nodes
@ -153,23 +153,23 @@ You can also use arbitrary data source with child nodes
You can create custom node in your response, based on the result of the given block You can create custom node in your response, based on the result of the given block
```ruby ```ruby
object :@user object :@user
node(:full_name) { |u| u.first_name + " " + u.last_name } node(:full_name) { |u| u.first_name + " " + u.last_name }
# => { "user" : { "full_name" : "John Doe" } } # => { "user" : { "full_name" : "John Doe" } }
``` ```
You can add the node only if a condition is true You can add the node only if a condition is true
```ruby ```ruby
node(:email, if: -> { |u| u.valid_email? }) do |u| node(:email, if: -> { |u| u.valid_email? }) do |u|
u.email u.email
end end
``` ```
Nodes are evaluated at the rendering time, so you can use any instance variables or view helpers inside them Nodes are evaluated at the rendering time, so you can use any instance variables or view helpers inside them
```ruby ```ruby
node(:url) { |post| post_url(post) } node(:url) { |post| post_url(post) }
``` ```
Custom nodes are really usefull to create flexible representations of your resources. Custom nodes are really usefull to create flexible representations of your resources.
@ -208,14 +208,14 @@ end
Rabl allow you to define easily your templates, even with hierarchy of 2 or 3 levels. Let's suppose your have a `thread` model that has many `posts` and that each post has many `comments`. We can display a full thread in a few lines Rabl allow you to define easily your templates, even with hierarchy of 2 or 3 levels. Let's suppose your have a `thread` model that has many `posts` and that each post has many `comments`. We can display a full thread in a few lines
```ruby ```ruby
object :@thread object :@thread
attribute :caption attribute :caption
child :posts do child :posts do
attribute :title attribute :title
child :comments do child :comments do
extends 'comments/base' extends 'comments/base'
end end
end end
``` ```
## Performance ## Performance