1. TEQUILA
Язык для продвинутой генерации JSON
Иван Немытченко
г. Омск, компания JazzCloud

2. JSON
{
“id” : 205633,
“name” : “jQuery in Action”,
“authors” : [“Yehuda Katz”, “Bear Bibeault”]
}

3. Когда нужен JSON?

4. Когда нужен JSON?
• Rich client

5. Когда нужен JSON?
• Rich client
• ExtJS, Flash, AIR

6. Когда нужен JSON?
• Rich client
• ExtJS, Flash, AIR
• External API

7. Как обычно отдается JSON?

8. to_json
render :json => @products.to_json(...)

9. to_json
@products.to_json(
:methods =>
[:label, :confirmed?, :formatted_description, :comment_text,
:tag_list, ...],
:include => {
:comments => {
:only => [:comment, :id, :commenter_id],
:methods => [:commenter_name, :date]
},
:taggings => {
:methods => [:date],
:include => {
:tag => {
:only => [:name, :background, :foreground]
},
:tagger => {
:only => [:login]
}}}})

10. as_json
render :json => @products

11. переопределение as_json в модели
class Product
def as_json(options)
super(
:methods => [:label, :confirmed?,
:formatted_description, :comment_text, :tag_list, ...],
:include => {
:comments => {
:only => [:comment, :id, :commenter_id],
:methods => [:commenter_name, :date]},
:taggings => {
:methods => [:date],
:include => {
:tag => { :only =>[:name, :background, :foreground]},
:tagger => { :only => [:login] }}}}
)
end
end

12. переопределение as_json в моделях
class Product < AR::Base class Tagging
def label; end def as_json # ...
def confirmed?; end end
#...
def as_json class Tag
super( def as_json # ...
:methods => [:label, :confirmed?, end
:formatted_description, :comment_text,
:tag_list, ...], class User
:include => { :comments, :taggings } def as_json # ...
) end
end
end
class Comment < AR::Base
def as_json
super(
:only => [:comment, :id, :commenter_id],
:methods => [:commenter_name, :date]
)
end
end

13. Гладкий и шелковистый контроллер
class ProductsController < ApplicationController
def index
render :json => @products
end
end

14. А что, если ...

15. нужно более чем одно представление модели
class ProductsController < ApplicationController
def index
render :json => @products.as_json(...)
end
end

16. хочется передать параметр в метод
render :json => @product.to_json(
:methods => :favorited_by_user?(current_user)
)

17. хочется передать параметр в метод
render :json => @product.to_json(
я
Так нельз :methods => :favorited_by_user?(current_user)
)

18. хочется передать параметр в метод
render :json => @product.to_json(
я
Так нельз :methods => :favorited_by_user?(current_user)
)
class Product < AR::Base
attr_accessor :current_user
def favorited_by_user?(user=nil)
user ||= current_user
# ... Если си
ль
end то можн но хочется,
end о конеч
но
@product.current_user = current_user
render :json => @product.to_json(:methods => :favorited_by_user?)

19. Неприятности:
• Каша из :include и :methods в сложных случаях

20. Неприятности:
• Каша из :include и :methods в сложных случаях
• Структура базы меняется → Меняется JSON

21. Неприятности:
• Каша из :include и :methods в сложных случаях
• Структура базы меняется → Меняется JSON
• Модель засоряется мелкими методами, только
чтобы “причесать” JSON output

22. Неприятности:
• Каша из :include и :methods в сложных случаях
• Структура базы меняется → Меняется JSON
• Модель засоряется мелкими методами, только
чтобы “причесать” JSON output
• Нельзя вызвать метод с параметрами

23. Неприятности:
• Каша из :include и :methods в сложных случаях
• Структура базы меняется → Меняется JSON
• Модель засоряется мелкими методами, только
чтобы “причесать” JSON output
• Нельзя вызвать метод с параметрами
• Модель может иметь одно представление в
JSON при использовании as_json

24. Неприятности:
• Каша из :include и :methods в сложных случаях
• Структура базы меняется → Меняется JSON
• Модель засоряется мелкими методами, только
чтобы “причесать” JSON output
• Нельзя вызвать метод с параметрами
• Модель может иметь одно представление в
JSON при использовании as_json
• Некоторые модели вынесены в плагины

25. Tequila

26. Задачи:
• Вынести логику представления в отдельный
слой (presenter)

27. Задачи:
• Вынести логику представления в отдельный
слой (presenter)
• Очистить модели от методов-хелперов

28. Задачи:
• Вынести логику представления в отдельный
слой (presenter)
• Очистить модели от методов-хелперов
• Вызов методов с параметрами

29. Задачи:
• Вынести логику представления в отдельный
слой (presenter)
• Очистить модели от методов-хелперов
• Вызов методов с параметрами
• Получить больший контроль над
представлением данных

30. Задачи:
• Вынести логику представления в отдельный
слой (presenter)
• Очистить модели от методов-хелперов
• Вызов методов с параметрами
• Получить больший контроль над
представлением данных
• Чтобы красиво!

31. Задачи:
• Вынести логику представления в отдельный
слой (presenter)
• Очистить модели от методов-хелперов
• Вызов методов с параметрами
• Получить больший контроль над
представлением данных
• Чтобы красиво!
• Успеть за 2 дня!!!

32. Отступы
-@humans => people
:only
.name => login
:code => enhanced_name
name + "!!!"
:code => hello_world
"Hello world!"
+pets
:except
.human_id
.pet_type_id
+toys
:methods
.railsize("$", price.to_s)

33. Associations
:include => { :association => {...}}

34. Associations
:include => { :association => {...}}
+association

35. Вызов методов
:methods => [:calculate]

36. Вызов методов
:methods => [:calculate]
:methods
.calculate
.favorited_by_user?(current_user)

37. Переименование нод
+favourites => faves

38. Переименование нод
:only
.tag_id => id
:methods
.calculate => calculated

39. Блоки кода
:code => number_of_guests
pluralize(number_of_guests,‘guest’)

40. Блоки кода
:code => formatted_price
“$#{price}”

41. Блоки кода
:code => last_comment
comments.last.comment if comments.any?

42. Опциональный ключ
-users [{
:only "user": {
.username "username": "heather"
}},{
"user": {
"username": "george"
}},{
"user": {
"username": "frank"
}},{
"user": {
"username": "aaron"
}}]

43. Опциональный ключ
-users~ [{
:only "username": "heather"},{
.username "username": "george"},{
"username": "frank"},{
"username": "elizabeth"}
]

44. Подклеивание ассоциаций
+tag {'tag' :
:only {'label' : 'Happy Christmas!',
'tagger' : {'name' : 'Mr Lawrence"}}
.label
+tagger
:only
.name

45. Подклеивание ассоциаций
+tag {'tag' :
:only {'label' : 'Happy Christmas!',
'tagger' : {'name' : 'Mr Lawrence"}}
.label
+tagger
:only
.name
+tag {'tag' :
:only {'label' : 'Happy Christmas!',
'tagger_name' : 'Mr Lawrence"}}
.label
<tagger
:only
.name => tagger_name

46. Partials
-users
:only
.name
&shared/pets
render :partial => ‘shared/pets’

47. Комментарии
+tag
:only
.label
//temporarily disabled
//<tagger
// :only
// .name => tagger_name

48. Познавательная страничка

56. Как использовать
gem install tequila
config.gem ‘tequila’
/app/views/users/index.json.jazz

57. tequila-demo.heroku.com

58. Планы по развитию
Синтаксис
ActiveRecord
Error handling
Syntax highlight support

59. Спасибо, вопросы!
github.com/inem/tequila
inem.github.com/tequila
twitter.com/inem
twitter.com/0ex0
jazzcloud.net
http://www.flickr.com/photos/tequilaphotos/