padrino-helpers-cj 0.12.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.document +5 -0
- data/.gitignore +21 -0
- data/.yardopts +1 -0
- data/LICENSE.txt +20 -0
- data/README.rdoc +239 -0
- data/Rakefile +5 -0
- data/lib/padrino-helpers.rb +62 -0
- data/lib/padrino-helpers/asset_tag_helpers.rb +390 -0
- data/lib/padrino-helpers/form_builder/abstract_form_builder.rb +283 -0
- data/lib/padrino-helpers/form_builder/deprecated_builder_methods.rb +92 -0
- data/lib/padrino-helpers/form_builder/standard_form_builder.rb +40 -0
- data/lib/padrino-helpers/form_helpers.rb +633 -0
- data/lib/padrino-helpers/form_helpers/errors.rb +138 -0
- data/lib/padrino-helpers/form_helpers/options.rb +97 -0
- data/lib/padrino-helpers/form_helpers/security.rb +70 -0
- data/lib/padrino-helpers/format_helpers.rb +372 -0
- data/lib/padrino-helpers/locale/cs.yml +103 -0
- data/lib/padrino-helpers/locale/da.yml +91 -0
- data/lib/padrino-helpers/locale/de.yml +81 -0
- data/lib/padrino-helpers/locale/en.yml +103 -0
- data/lib/padrino-helpers/locale/es.yml +103 -0
- data/lib/padrino-helpers/locale/fr.yml +79 -0
- data/lib/padrino-helpers/locale/hu.yml +103 -0
- data/lib/padrino-helpers/locale/it.yml +89 -0
- data/lib/padrino-helpers/locale/ja.yml +103 -0
- data/lib/padrino-helpers/locale/lv.yml +103 -0
- data/lib/padrino-helpers/locale/nl.yml +82 -0
- data/lib/padrino-helpers/locale/no.yml +91 -0
- data/lib/padrino-helpers/locale/pl.yml +95 -0
- data/lib/padrino-helpers/locale/pt_br.yml +103 -0
- data/lib/padrino-helpers/locale/ro.yml +103 -0
- data/lib/padrino-helpers/locale/ru.yml +103 -0
- data/lib/padrino-helpers/locale/sv.yml +103 -0
- data/lib/padrino-helpers/locale/tr.yml +103 -0
- data/lib/padrino-helpers/locale/uk.yml +103 -0
- data/lib/padrino-helpers/locale/zh_cn.yml +103 -0
- data/lib/padrino-helpers/locale/zh_tw.yml +103 -0
- data/lib/padrino-helpers/number_helpers.rb +283 -0
- data/lib/padrino-helpers/output_helpers.rb +226 -0
- data/lib/padrino-helpers/output_helpers/abstract_handler.rb +61 -0
- data/lib/padrino-helpers/output_helpers/erb_handler.rb +27 -0
- data/lib/padrino-helpers/output_helpers/haml_handler.rb +25 -0
- data/lib/padrino-helpers/output_helpers/slim_handler.rb +18 -0
- data/lib/padrino-helpers/render_helpers.rb +63 -0
- data/lib/padrino-helpers/tag_helpers.rb +294 -0
- data/lib/padrino-helpers/translation_helpers.rb +36 -0
- data/lib/padrino/rendering.rb +397 -0
- data/lib/padrino/rendering/erubis_template.rb +66 -0
- data/lib/padrino/rendering/haml_template.rb +26 -0
- data/lib/padrino/rendering/slim_template.rb +20 -0
- data/padrino-helpers.gemspec +29 -0
- data/test/fixtures/apps/.components +6 -0
- data/test/fixtures/apps/.gitignore +7 -0
- data/test/fixtures/apps/render.rb +25 -0
- data/test/fixtures/apps/views/article/comment/show.slim +1 -0
- data/test/fixtures/apps/views/blog/post.erb +1 -0
- data/test/fixtures/apps/views/layouts/specific.erb +1 -0
- data/test/fixtures/apps/views/test/post.erb +1 -0
- data/test/fixtures/layouts/layout.erb +1 -0
- data/test/fixtures/markup_app/app.rb +87 -0
- data/test/fixtures/markup_app/views/button_to.erb +8 -0
- data/test/fixtures/markup_app/views/button_to.haml +5 -0
- data/test/fixtures/markup_app/views/button_to.slim +6 -0
- data/test/fixtures/markup_app/views/capture_concat.erb +14 -0
- data/test/fixtures/markup_app/views/capture_concat.haml +12 -0
- data/test/fixtures/markup_app/views/capture_concat.slim +12 -0
- data/test/fixtures/markup_app/views/content_for.erb +23 -0
- data/test/fixtures/markup_app/views/content_for.haml +19 -0
- data/test/fixtures/markup_app/views/content_for.slim +19 -0
- data/test/fixtures/markup_app/views/content_tag.erb +13 -0
- data/test/fixtures/markup_app/views/content_tag.haml +11 -0
- data/test/fixtures/markup_app/views/content_tag.slim +11 -0
- data/test/fixtures/markup_app/views/current_engine.erb +5 -0
- data/test/fixtures/markup_app/views/current_engine.haml +5 -0
- data/test/fixtures/markup_app/views/current_engine.slim +5 -0
- data/test/fixtures/markup_app/views/fields_for.erb +20 -0
- data/test/fixtures/markup_app/views/fields_for.haml +15 -0
- data/test/fixtures/markup_app/views/fields_for.slim +15 -0
- data/test/fixtures/markup_app/views/form_for.erb +72 -0
- data/test/fixtures/markup_app/views/form_for.haml +59 -0
- data/test/fixtures/markup_app/views/form_for.slim +59 -0
- data/test/fixtures/markup_app/views/form_tag.erb +95 -0
- data/test/fixtures/markup_app/views/form_tag.haml +78 -0
- data/test/fixtures/markup_app/views/form_tag.slim +79 -0
- data/test/fixtures/markup_app/views/link_to.erb +5 -0
- data/test/fixtures/markup_app/views/link_to.haml +4 -0
- data/test/fixtures/markup_app/views/link_to.slim +4 -0
- data/test/fixtures/markup_app/views/mail_to.erb +3 -0
- data/test/fixtures/markup_app/views/mail_to.haml +3 -0
- data/test/fixtures/markup_app/views/mail_to.slim +3 -0
- data/test/fixtures/markup_app/views/meta_tag.erb +3 -0
- data/test/fixtures/markup_app/views/meta_tag.haml +3 -0
- data/test/fixtures/markup_app/views/meta_tag.slim +3 -0
- data/test/fixtures/markup_app/views/partials/_erb.erb +1 -0
- data/test/fixtures/markup_app/views/partials/_haml.haml +1 -0
- data/test/fixtures/markup_app/views/partials/_slim.slim +1 -0
- data/test/fixtures/markup_app/views/simple_partial.erb +1 -0
- data/test/fixtures/markup_app/views/simple_partial.haml +1 -0
- data/test/fixtures/markup_app/views/simple_partial.slim +1 -0
- data/test/fixtures/render_app/app.rb +94 -0
- data/test/fixtures/render_app/views/_deep.erb +3 -0
- data/test/fixtures/render_app/views/_deep.haml +2 -0
- data/test/fixtures/render_app/views/_deep.slim +2 -0
- data/test/fixtures/render_app/views/_partial_block_erb.erb +10 -0
- data/test/fixtures/render_app/views/_partial_block_haml.haml +7 -0
- data/test/fixtures/render_app/views/_partial_block_slim.slim +7 -0
- data/test/fixtures/render_app/views/_unsafe.html.builder +2 -0
- data/test/fixtures/render_app/views/_unsafe_object.html.builder +2 -0
- data/test/fixtures/render_app/views/current_engine.haml +5 -0
- data/test/fixtures/render_app/views/current_engines/_erb.erb +1 -0
- data/test/fixtures/render_app/views/current_engines/_haml.haml +1 -0
- data/test/fixtures/render_app/views/current_engines/_slim.slim +1 -0
- data/test/fixtures/render_app/views/double_capture_erb.erb +3 -0
- data/test/fixtures/render_app/views/double_capture_haml.haml +2 -0
- data/test/fixtures/render_app/views/double_capture_slim.slim +2 -0
- data/test/fixtures/render_app/views/erb/test.erb +1 -0
- data/test/fixtures/render_app/views/explicit_engine.haml +5 -0
- data/test/fixtures/render_app/views/haml/test.haml +1 -0
- data/test/fixtures/render_app/views/render_block_erb.erb +5 -0
- data/test/fixtures/render_app/views/render_block_haml.haml +4 -0
- data/test/fixtures/render_app/views/render_block_slim.slim +4 -0
- data/test/fixtures/render_app/views/ruby_block_capture_erb.erb +1 -0
- data/test/fixtures/render_app/views/ruby_block_capture_haml.haml +1 -0
- data/test/fixtures/render_app/views/ruby_block_capture_slim.slim +1 -0
- data/test/fixtures/render_app/views/template/_user.haml +7 -0
- data/test/fixtures/render_app/views/template/haml_template.haml +1 -0
- data/test/fixtures/render_app/views/template/some_template.haml +2 -0
- data/test/fixtures/render_app/views/wrong_capture_erb.erb +3 -0
- data/test/fixtures/render_app/views/wrong_capture_haml.haml +2 -0
- data/test/fixtures/render_app/views/wrong_capture_slim.slim +2 -0
- data/test/helper.rb +131 -0
- data/test/test_asset_tag_helpers.rb +406 -0
- data/test/test_form_builder.rb +1216 -0
- data/test/test_form_helpers.rb +1056 -0
- data/test/test_format_helpers.rb +251 -0
- data/test/test_helpers.rb +10 -0
- data/test/test_locale.rb +20 -0
- data/test/test_number_helpers.rb +142 -0
- data/test/test_output_helpers.rb +157 -0
- data/test/test_render_helpers.rb +215 -0
- data/test/test_rendering.rb +694 -0
- data/test/test_rendering_extensions.rb +14 -0
- data/test/test_tag_helpers.rb +131 -0
- metadata +241 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c272144514662fe77e32a36636ea340b10b6d594
|
4
|
+
data.tar.gz: d1f146706d2d133691bd25ae5235d19b5fd7af35
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ca8dabc98b66177db736141721cea329ab8abb22750e5ca73318877c1796502a07069e7cc0ef12d4f07da5b3857528c86b12bde7ca77047055fd6922e09f1f02
|
7
|
+
data.tar.gz: e57afd0dd0cd5c3fb9b75cd2c4e4cdcb4557730fb95c27d7466bda14f62db7f67f7284b4e3edf82bff77204ac9a368002cd54a84d0c641a45c2d7d15f27fe581
|
data/.document
ADDED
data/.gitignore
ADDED
data/.yardopts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--title 'Padrino Helpers Documentation' --protected
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2011 Padrino
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,239 @@
|
|
1
|
+
= Application Extensions and Helpers (padrino-helpers)
|
2
|
+
|
3
|
+
=== Overview
|
4
|
+
|
5
|
+
This component provides a great deal of view helpers related to html markup generation.
|
6
|
+
There are helpers for generating tags, forms, links, images, and more. Most of the basic
|
7
|
+
methods should be very familiar to anyone who has used rails view helpers.
|
8
|
+
|
9
|
+
=== Output Helpers
|
10
|
+
|
11
|
+
Output helpers are a collection of important methods for managing, capturing and displaying output
|
12
|
+
in various ways and is used frequently to support higher-level helper functions. There are
|
13
|
+
three output helpers worth mentioning: <tt>content_for</tt>, <tt>capture_html</tt>, and <tt>concat_content</tt>
|
14
|
+
|
15
|
+
The content_for functionality supports capturing content and then rendering this into a different place
|
16
|
+
such as within a layout. One such popular example is including assets onto the layout from a template:
|
17
|
+
|
18
|
+
# app/views/site/index.erb
|
19
|
+
...
|
20
|
+
<% content_for :assets do %>
|
21
|
+
<%= stylesheet_link_tag 'index', 'custom' %>
|
22
|
+
<% end %>
|
23
|
+
...
|
24
|
+
|
25
|
+
Added to a template, this will capture the includes from the block and allow them to be yielded into the layout:
|
26
|
+
|
27
|
+
# app/views/layout.erb
|
28
|
+
...
|
29
|
+
<head>
|
30
|
+
<title>Example</title>
|
31
|
+
<%= stylesheet_link_tag 'style' %>
|
32
|
+
<%= yield_content :assets %>
|
33
|
+
</head>
|
34
|
+
...
|
35
|
+
|
36
|
+
This will automatically insert the contents of the block (in this case a stylesheet include) into the
|
37
|
+
location the content is yielded within the layout. You can also check if content exists for a block using
|
38
|
+
<tt>content_for?(true)</tt> which returns true if content exists.
|
39
|
+
|
40
|
+
The capture_html and the concat_content methods allow content to be manipulated and stored for use in building
|
41
|
+
additional helpers accepting blocks or displaying information in a template. One example is the use of
|
42
|
+
these in constructing a simplified 'form_tag' helper which accepts a block.
|
43
|
+
|
44
|
+
# form_tag '/register' do ... end
|
45
|
+
def form_tag(url, options={}, &block)
|
46
|
+
# ... truncated ...
|
47
|
+
inner_form_html = capture_html(&block)
|
48
|
+
concat_content '<form>' + inner_form_html + '</form>'
|
49
|
+
end
|
50
|
+
|
51
|
+
This will capture the template body passed into the form_tag block and then append the content
|
52
|
+
to the template through the use of <tt>concat_content</tt>. Note have been built to work for both haml and erb
|
53
|
+
templates using the same syntax.
|
54
|
+
|
55
|
+
For more information on using output helpers, check out the guide for
|
56
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
57
|
+
|
58
|
+
=== Tag Helpers
|
59
|
+
|
60
|
+
Tag helpers are the basic building blocks used to construct html 'tags' within a view template. There
|
61
|
+
are three major functions for this category: <tt>tag</tt>, <tt>content_tag</tt> and <tt>input_tag</tt>.
|
62
|
+
|
63
|
+
The tag and content_tag are for building arbitrary html tags with a name and specified options. If
|
64
|
+
the tag contains 'content' within then <tt>content_tag</tt> is used. For example:
|
65
|
+
|
66
|
+
tag(:br, :style => 'clear:both') => <br style="clear:both" />
|
67
|
+
content_tag(:p, "demo", :class => 'light') => <p class="light">demo</p>
|
68
|
+
|
69
|
+
The input_tag is used to build tags that are related to accepting input from the user:
|
70
|
+
|
71
|
+
input_tag :text, :class => "demo" => <input type='text' class='demo' />
|
72
|
+
input_tag :password, :value => "secret", :class => "demo"
|
73
|
+
|
74
|
+
Note that all of these accept html options and result in returning a string containing html tags.
|
75
|
+
|
76
|
+
For more information on using tag helpers, check out the guide for
|
77
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
78
|
+
|
79
|
+
=== Asset Helpers
|
80
|
+
|
81
|
+
Asset helpers are intended to help insert useful html onto a view template such as 'flash' notices,
|
82
|
+
hyperlinks, mail_to links, images, stylesheets and javascript. An example of their uses would be on a
|
83
|
+
simple view template:
|
84
|
+
|
85
|
+
# app/views/example.haml
|
86
|
+
...
|
87
|
+
%head
|
88
|
+
= stylesheet_link_tag 'layout'
|
89
|
+
= javascript_include_tag 'application'
|
90
|
+
%body
|
91
|
+
...
|
92
|
+
= flash_tag :notice
|
93
|
+
%p= link_to 'Blog', '/blog', :class => 'example'
|
94
|
+
%p Mail me at #{mail_to 'fake@faker.com', "Fake Email Link", :cc => "test@demo.com"}
|
95
|
+
%p= image_tag 'padrino.png', :width => '35', :class => 'logo'
|
96
|
+
|
97
|
+
For more information on using asset helpers, check out the guide for
|
98
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
99
|
+
|
100
|
+
=== Form Helpers
|
101
|
+
|
102
|
+
Form helpers are the 'standard' form tag helpers you would come to expect when building forms. A simple
|
103
|
+
example of constructing a non-object form would be:
|
104
|
+
|
105
|
+
= form_tag '/destroy', :class => 'destroy-form', :method => 'delete' do
|
106
|
+
= flash_tag(:notice)
|
107
|
+
= field_set_tag do
|
108
|
+
%p
|
109
|
+
= label_tag :username, :class => 'first'
|
110
|
+
= text_field_tag :username, :value => params[:username]
|
111
|
+
%p
|
112
|
+
= label_tag :password, :class => 'first'
|
113
|
+
= password_field_tag :password, :value => params[:password]
|
114
|
+
%p
|
115
|
+
= label_tag :strategy
|
116
|
+
= select_tag :strategy, :options => ['delete', 'destroy'], :selected => 'delete'
|
117
|
+
%p
|
118
|
+
= check_box_tag :confirm_delete
|
119
|
+
= field_set_tag(:class => 'buttons') do
|
120
|
+
= submit_tag "Remove"
|
121
|
+
|
122
|
+
For more information on using form helpers, check out the guide for
|
123
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
124
|
+
|
125
|
+
=== FormBuilders
|
126
|
+
|
127
|
+
Form builders are full-featured objects allowing the construction of complex object-based forms
|
128
|
+
using a simple, intuitive syntax.
|
129
|
+
|
130
|
+
A form_for using these basic fields might look like:
|
131
|
+
|
132
|
+
= form_for @user, '/register', :id => 'register' do |f|
|
133
|
+
= f.error_messages
|
134
|
+
%p
|
135
|
+
= f.label :username, :caption => "Nickname"
|
136
|
+
= f.text_field :username
|
137
|
+
%p
|
138
|
+
= f.label :email
|
139
|
+
= f.text_field :email
|
140
|
+
%p
|
141
|
+
= f.label :password
|
142
|
+
= f.password_field :password
|
143
|
+
%p
|
144
|
+
= f.label :is_admin, :caption => "Admin User?"
|
145
|
+
= f.check_box :is_admin
|
146
|
+
%p
|
147
|
+
= f.label :color, :caption => "Favorite Color?"
|
148
|
+
= f.select :color, :options => ['red', 'black']
|
149
|
+
%p
|
150
|
+
= fields_for @user.location do |location|
|
151
|
+
= location.text_field :street
|
152
|
+
= location.text_field :city
|
153
|
+
%p
|
154
|
+
= f.submit "Create", :class => 'button'
|
155
|
+
|
156
|
+
Forms can also accept nested attributes using `fields_for` within the form builder in recent releases. Check out the guide for {Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers] to learn more about nested forms.
|
157
|
+
|
158
|
+
There is also an additional StandardFormBuilder which builds on the abstract fields that can be used within a form_for.
|
159
|
+
|
160
|
+
A form_for using these standard fields might be:
|
161
|
+
|
162
|
+
= form_for @user, '/register', :id => 'register' do |f|
|
163
|
+
= f.error_messages
|
164
|
+
= f.text_field_block :name, :caption => "Full name"
|
165
|
+
= f.text_field_block :email
|
166
|
+
= f.check_box_block :remember_me
|
167
|
+
= f.select_block :fav_color, :options => ['red', 'blue']
|
168
|
+
= f.password_field_block :password
|
169
|
+
= f.submit_block "Create", :class => 'button'
|
170
|
+
|
171
|
+
and would generate this html (with each input contained in a paragraph and containing a label):
|
172
|
+
|
173
|
+
<form id="register" action="/register" method="post">
|
174
|
+
<p><label for="user_name">Full name: </label><input type="text" id="user_name" name="user[name]"></p>
|
175
|
+
...omitted...
|
176
|
+
<p><input type="submit" value="Create" class="button"></p>
|
177
|
+
</form>
|
178
|
+
|
179
|
+
You can also easily build your own FormBuilder which allows for customized fields and behavior.
|
180
|
+
|
181
|
+
For more information on using the Padrino form builders, check out the guide for
|
182
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
183
|
+
|
184
|
+
=== Format Helpers
|
185
|
+
|
186
|
+
Format helpers are several useful utilities for manipulating the format of text to achieve a goal.
|
187
|
+
The four format helpers are <tt>escape_html</tt>, <tt>time_ago_in_words</tt>, and <tt>js_escape_html</tt>.
|
188
|
+
|
189
|
+
The escape_html and js_escape_html function are for taking an html string and escaping certain characters.
|
190
|
+
<tt>escape_html</tt> will escape ampersands, brackets and quotes to their HTML/XML entities. This is useful
|
191
|
+
to sanitize user content before displaying this on a template. <tt>js_escape_html</tt> is used for
|
192
|
+
passing javascript information from a js template to a javascript function.
|
193
|
+
|
194
|
+
escape_html('<hello>&<goodbye>') # => <hello>&<goodbye>
|
195
|
+
|
196
|
+
There is also an alias for escape_html called <tt>h</tt> for even easier usage within templates.
|
197
|
+
|
198
|
+
Format helpers also includes a number of useful text manipulation functions such as <tt>simple_format</tt>,
|
199
|
+
<tt>pluralize</tt>, <tt>word_wrap</tt>, <tt>truncate</tt> and <tt>truncate_words</tt>.
|
200
|
+
|
201
|
+
simple_format("hello\nworld") # => "<p>hello<br/>world</p>"
|
202
|
+
pluralize(2, 'person') => '2 people'
|
203
|
+
word_wrap('Once upon a time', :line_width => 8) => "Once upon\na time"
|
204
|
+
truncate("Once upon a time in a world far far away", :length => 8) => "Once upon..."
|
205
|
+
truncate_words("Once upon a time in a world far far away", :length => 4) => "Once upon a time..."
|
206
|
+
|
207
|
+
These helpers can be invoked from any route or view within your application.
|
208
|
+
|
209
|
+
For more information on using the format helpers, check out the guide for
|
210
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
211
|
+
|
212
|
+
=== Render Helpers
|
213
|
+
|
214
|
+
This component provides a number of rendering helpers making the process of displaying templates a bit easier.
|
215
|
+
This plugin also has support for useful additions such as partials (with support for :collection) for the templating system.
|
216
|
+
|
217
|
+
Using render plugin helpers is extremely simple. If you want to render an erb template in your view path:
|
218
|
+
|
219
|
+
render :erb, 'path/to/erb/template'
|
220
|
+
|
221
|
+
or using haml templates works just as well:
|
222
|
+
|
223
|
+
render :haml, 'path/to/haml/template'
|
224
|
+
|
225
|
+
There is also a method which renders the first view matching the path and removes the need to define an engine:
|
226
|
+
|
227
|
+
render 'path/to/any/template'
|
228
|
+
|
229
|
+
Finally, we have the all-important partials support for rendering mini-templates onto a page:
|
230
|
+
|
231
|
+
partial 'photo/_item', :object => @photo, :locals => { :foo => 'bar' }
|
232
|
+
partial 'photo/_item', :collection => @photos
|
233
|
+
|
234
|
+
For more information on using the render and partial helpers, check out the guide for
|
235
|
+
{Padrino Helpers}[http://www.padrinorb.com/guides/application-helpers].
|
236
|
+
|
237
|
+
== Copyright
|
238
|
+
|
239
|
+
Copyright (c) 2011-2013 Padrino. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
require 'padrino-support'
|
2
|
+
require 'i18n'
|
3
|
+
require 'enumerator'
|
4
|
+
require 'active_support/time_with_zone' # next extension depends on this
|
5
|
+
require 'active_support/core_ext/string/conversions' # to_date
|
6
|
+
require 'active_support/option_merger' # with_options
|
7
|
+
require 'active_support/core_ext/object/with_options' # with_options
|
8
|
+
require 'active_support/inflector' # humanize
|
9
|
+
require 'active_support/core_ext/hash/except' # Hash#except
|
10
|
+
require 'padrino/rendering'
|
11
|
+
|
12
|
+
FileSet.glob_require('padrino-helpers/**/*.rb', __FILE__)
|
13
|
+
I18n.load_path += Dir["#{File.dirname(__FILE__)}/padrino-helpers/locale/*.yml"]
|
14
|
+
I18n.enforce_available_locales = true
|
15
|
+
|
16
|
+
module Padrino
|
17
|
+
##
|
18
|
+
# This component provides a variety of view helpers related to html markup generation.
|
19
|
+
# There are helpers for generating tags, forms, links, images, and more.
|
20
|
+
# Most of the basic methods should be very familiar to anyone who has used rails view helpers.
|
21
|
+
#
|
22
|
+
module Helpers
|
23
|
+
class << self
|
24
|
+
##
|
25
|
+
# Registers these helpers into your application:
|
26
|
+
#
|
27
|
+
# Padrino::Helpers::OutputHelpers
|
28
|
+
# Padrino::Helpers::TagHelpers
|
29
|
+
# Padrino::Helpers::AssetTagHelpers
|
30
|
+
# Padrino::Helpers::FormHelpers
|
31
|
+
# Padrino::Helpers::FormatHelpers
|
32
|
+
# Padrino::Helpers::RenderHelpers
|
33
|
+
# Padrino::Helpers::NumberHelpers
|
34
|
+
#
|
35
|
+
# @param [Sinatra::Application] app
|
36
|
+
# The specified Padrino application.
|
37
|
+
#
|
38
|
+
# @example Register the helper module
|
39
|
+
# require 'padrino-helpers'
|
40
|
+
# class Padrino::Application
|
41
|
+
# register Padrino::Helpers
|
42
|
+
# end
|
43
|
+
#
|
44
|
+
def registered(app)
|
45
|
+
app.register Padrino::Rendering
|
46
|
+
app.set :default_builder, 'StandardFormBuilder'
|
47
|
+
included(app)
|
48
|
+
end
|
49
|
+
|
50
|
+
def included(base)
|
51
|
+
base.send :include, Padrino::Helpers::OutputHelpers
|
52
|
+
base.send :include, Padrino::Helpers::TagHelpers
|
53
|
+
base.send :include, Padrino::Helpers::AssetTagHelpers
|
54
|
+
base.send :include, Padrino::Helpers::FormHelpers
|
55
|
+
base.send :include, Padrino::Helpers::FormatHelpers
|
56
|
+
base.send :include, Padrino::Helpers::RenderHelpers
|
57
|
+
base.send :include, Padrino::Helpers::NumberHelpers
|
58
|
+
base.send :include, Padrino::Helpers::TranslationHelpers
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,390 @@
|
|
1
|
+
module Padrino
|
2
|
+
module Helpers
|
3
|
+
###
|
4
|
+
# Helpers related to producing assets (images, stylesheets, js, etc) within templates.
|
5
|
+
#
|
6
|
+
module AssetTagHelpers
|
7
|
+
APPEND_ASSET_EXTENSIONS = ["js", "css"]
|
8
|
+
ABSOLUTE_URL_PATTERN = %r{^(https?://)}
|
9
|
+
ASSET_FOLDERS = {
|
10
|
+
:js => 'javascripts',
|
11
|
+
:css => 'stylesheets',
|
12
|
+
}
|
13
|
+
|
14
|
+
##
|
15
|
+
# Creates a div to display the flash of given type if it exists.
|
16
|
+
#
|
17
|
+
# @param [Symbol] kind
|
18
|
+
# The type of flash to display in the tag.
|
19
|
+
# @param [Hash] options
|
20
|
+
# The html options for this section.
|
21
|
+
# use :bootstrap => true to support Twitter's bootstrap dismiss alert button.
|
22
|
+
#
|
23
|
+
# @return [String] Flash tag html with specified +options+.
|
24
|
+
#
|
25
|
+
# @example
|
26
|
+
# flash_tag(:notice, :id => 'flash-notice')
|
27
|
+
# # Generates: <div class="notice">flash-notice</div>
|
28
|
+
# flash_tag(:error, :success)
|
29
|
+
# # Generates: <div class="error">flash-error</div>
|
30
|
+
# # <div class="success">flash-success</div>
|
31
|
+
#
|
32
|
+
def flash_tag(*args)
|
33
|
+
options = args.extract_options!
|
34
|
+
bootstrap = options.delete(:bootstrap) if options[:bootstrap]
|
35
|
+
args.inject(ActiveSupport::SafeBuffer.new) do |html,kind|
|
36
|
+
flash_text = ActiveSupport::SafeBuffer.new << flash[kind]
|
37
|
+
next html if flash_text.blank?
|
38
|
+
flash_text << content_tag(:button, '×'.html_safe, {:type => :button, :class => :close, :'data-dismiss' => :alert}) if bootstrap
|
39
|
+
html << content_tag(:div, flash_text, { :class => kind }.update(options))
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
##
|
44
|
+
# Creates a link element with given name, url and options.
|
45
|
+
#
|
46
|
+
# @overload link_to(caption, url, options={})
|
47
|
+
# @param [String] caption The text caption.
|
48
|
+
# @param [String] url The url href.
|
49
|
+
# @param [Hash] options The html options.
|
50
|
+
# @overload link_to(url, options={}, &block)
|
51
|
+
# @param [String] url The url href.
|
52
|
+
# @param [Hash] options The html options.
|
53
|
+
# @param [Proc] block The link content.
|
54
|
+
#
|
55
|
+
# @option options [Boolean] :if
|
56
|
+
# If true, the link will appear, otherwise not.
|
57
|
+
# @option options [Boolean] :unless
|
58
|
+
# If false, the link will appear, otherwise not.
|
59
|
+
# @option options [Boolean] :remote
|
60
|
+
# If true, this link should be handled by an ajax ujs handler.
|
61
|
+
# @option options [String] :confirm
|
62
|
+
# Instructs ujs handler to alert confirm message.
|
63
|
+
# @option options [Symbol] :method
|
64
|
+
# Instructs ujs handler to use different http method (i.e :post, :delete).
|
65
|
+
#
|
66
|
+
# @return [String] Link tag html with specified +options+.
|
67
|
+
#
|
68
|
+
# @example
|
69
|
+
# link_to('click me', '/dashboard', :class => 'linky')
|
70
|
+
# link_to('click me', '/dashboard', :remote => true)
|
71
|
+
# link_to('click me', '/dashboard', :method => :delete)
|
72
|
+
# link_to('click me', :class => 'blocky') do; end
|
73
|
+
#
|
74
|
+
# Note that you can pass :+if+ or :+unless+ conditions, but if you provide :current as
|
75
|
+
# condition padrino return true/false if the request.path_info match the given url.
|
76
|
+
#
|
77
|
+
def link_to(*args, &block)
|
78
|
+
options = args.extract_options!
|
79
|
+
name = block_given? ? '' : args.shift
|
80
|
+
href = args.first
|
81
|
+
if fragment = options[:fragment] || options[:anchor]
|
82
|
+
warn 'Options :anchor and :fragment are deprecated for #link_to. Please use :fragment for #url'
|
83
|
+
href << '#' << fragment.to_s
|
84
|
+
end
|
85
|
+
options.reverse_merge!(:href => href || '#')
|
86
|
+
return name unless parse_conditions(href, options)
|
87
|
+
block_given? ? content_tag(:a, options, &block) : content_tag(:a, name, options)
|
88
|
+
end
|
89
|
+
|
90
|
+
##
|
91
|
+
# Creates a link tag that browsers and news readers can use to auto-detect an RSS or ATOM feed.
|
92
|
+
#
|
93
|
+
# @param [Symbol] mime
|
94
|
+
# The mime type of the feed (i.e :atom or :rss).
|
95
|
+
# @param [String] url
|
96
|
+
# The url for the feed tag to reference.
|
97
|
+
# @param[Hash] options
|
98
|
+
# The options for the feed tag.
|
99
|
+
# @option options [String] :rel ("alternate")
|
100
|
+
# Specify the relation of this link.
|
101
|
+
# @option options [String] :type
|
102
|
+
# Override the auto-generated mime type.
|
103
|
+
# @option options [String] :title
|
104
|
+
# Specify the title of the link, defaults to the type.
|
105
|
+
#
|
106
|
+
# @return [String] Feed link html tag with specified +options+.
|
107
|
+
#
|
108
|
+
# @example
|
109
|
+
# feed_tag :atom, url(:blog, :posts, :format => :atom), :title => "ATOM"
|
110
|
+
# # Generates: <link type="application/atom+xml" rel="alternate" href="/blog/posts.atom" title="ATOM" />
|
111
|
+
# feed_tag :rss, url(:blog, :posts, :format => :rss)
|
112
|
+
# # Generates: <link type="application/rss+xml" rel="alternate" href="/blog/posts.rss" title="rss" />
|
113
|
+
#
|
114
|
+
def feed_tag(mime, url, options={})
|
115
|
+
full_mime = (mime == :atom) ? 'application/atom+xml' : 'application/rss+xml'
|
116
|
+
tag(:link, options.reverse_merge(:rel => 'alternate', :type => full_mime, :title => mime, :href => url))
|
117
|
+
end
|
118
|
+
|
119
|
+
##
|
120
|
+
# Creates a mail link element with given name and caption.
|
121
|
+
#
|
122
|
+
# @param [String] email
|
123
|
+
# The email address for the link.
|
124
|
+
# @param [String] caption
|
125
|
+
# The caption for the link.
|
126
|
+
# @param [Hash] mail_options
|
127
|
+
# The options for the mail link. Accepts html options.
|
128
|
+
# @option mail_options [String] cc The cc recipients.
|
129
|
+
# @option mail_options [String] bcc The bcc recipients.
|
130
|
+
# @option mail_options [String] subject The subject line.
|
131
|
+
# @option mail_options [String] body The email body.
|
132
|
+
#
|
133
|
+
# @return [String] Mail link html tag with specified +options+.
|
134
|
+
#
|
135
|
+
# @example
|
136
|
+
# # Generates: <a href="mailto:me@demo.com">me@demo.com</a>
|
137
|
+
# mail_to "me@demo.com"
|
138
|
+
# # Generates: <a href="mailto:me@demo.com">My Email</a>
|
139
|
+
# mail_to "me@demo.com", "My Email"
|
140
|
+
#
|
141
|
+
def mail_to(email, caption=nil, mail_options={})
|
142
|
+
html_options = mail_options.slice!(:cc, :bcc, :subject, :body)
|
143
|
+
mail_query = Rack::Utils.build_query(mail_options).gsub(/\+/, '%20').gsub('%40', '@')
|
144
|
+
mail_href = "mailto:#{email}"; mail_href << "?#{mail_query}" if mail_query.present?
|
145
|
+
link_to((caption || email), mail_href, html_options)
|
146
|
+
end
|
147
|
+
|
148
|
+
##
|
149
|
+
# Creates a meta element with the content and given options.
|
150
|
+
#
|
151
|
+
# @param [String] content
|
152
|
+
# The content for the meta tag.
|
153
|
+
# @param [Hash] options
|
154
|
+
# The html options for the meta tag.
|
155
|
+
#
|
156
|
+
# @return [String] Meta html tag with specified +options+.
|
157
|
+
#
|
158
|
+
# @example
|
159
|
+
# # Generates: <meta name="keywords" content="weblog,news" />
|
160
|
+
# meta_tag "weblog,news", :name => "keywords"
|
161
|
+
#
|
162
|
+
# # Generates: <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
163
|
+
# meta_tag "text/html; charset=UTF-8", 'http-equiv' => "Content-Type"
|
164
|
+
#
|
165
|
+
def meta_tag(content, options={})
|
166
|
+
options.reverse_merge!("content" => content)
|
167
|
+
tag(:meta, options)
|
168
|
+
end
|
169
|
+
|
170
|
+
##
|
171
|
+
# Generates a favicon link. Looks inside images folder
|
172
|
+
#
|
173
|
+
# @param [String] source
|
174
|
+
# The source image path for the favicon link tag.
|
175
|
+
# @param [Hash] options
|
176
|
+
# The html options for the favicon link tag.
|
177
|
+
#
|
178
|
+
# @return [String] The favicon link html tag with specified +options+.
|
179
|
+
#
|
180
|
+
# @example
|
181
|
+
# favicon_tag 'favicon.png'
|
182
|
+
# favicon_tag 'icons/favicon.png'
|
183
|
+
# # or override some options
|
184
|
+
# favicon_tag 'favicon.png', :type => 'image/ico'
|
185
|
+
#
|
186
|
+
def favicon_tag(source, options={})
|
187
|
+
type = File.extname(source).gsub('.','')
|
188
|
+
options = options.dup.reverse_merge!(:href => image_path(source), :rel => 'icon', :type => "image/#{type}")
|
189
|
+
tag(:link, options)
|
190
|
+
end
|
191
|
+
|
192
|
+
##
|
193
|
+
# Creates an image element with given url and options.
|
194
|
+
#
|
195
|
+
# @param [String] url
|
196
|
+
# The source path for the image tag.
|
197
|
+
# @param [Hash] options
|
198
|
+
# The html options for the image tag.
|
199
|
+
#
|
200
|
+
# @return [String] Image html tag with +url+ and specified +options+.
|
201
|
+
#
|
202
|
+
# @example
|
203
|
+
# image_tag('icons/avatar.png')
|
204
|
+
#
|
205
|
+
def image_tag(url, options={})
|
206
|
+
options.reverse_merge!(:src => image_path(url))
|
207
|
+
tag(:img, options)
|
208
|
+
end
|
209
|
+
|
210
|
+
##
|
211
|
+
# Returns an html script tag for each of the sources provided.
|
212
|
+
# You can pass in the filename without extension or a symbol and we search it in your +appname.public_folder+
|
213
|
+
# like app/public/stylesheets for inclusion. You can provide also a full path.
|
214
|
+
#
|
215
|
+
# @overload stylesheet_link_tag(*sources, options={})
|
216
|
+
# @param [Array<String>] sources Splat of css source paths
|
217
|
+
# @param [Hash] options The html options for the link tag
|
218
|
+
#
|
219
|
+
# @return [String] Stylesheet link html tag for +sources+ with specified +options+.
|
220
|
+
#
|
221
|
+
# @example
|
222
|
+
# stylesheet_link_tag 'style', 'application', 'layout'
|
223
|
+
#
|
224
|
+
# @api public.
|
225
|
+
def stylesheet_link_tag(*sources)
|
226
|
+
options = {
|
227
|
+
:rel => 'stylesheet',
|
228
|
+
:type => 'text/css'
|
229
|
+
}.update(sources.extract_options!.symbolize_keys)
|
230
|
+
sources.flatten.inject(ActiveSupport::SafeBuffer.new) do |all,source|
|
231
|
+
all << tag(:link, { :href => asset_path(:css, source) }.update(options))
|
232
|
+
end
|
233
|
+
end
|
234
|
+
|
235
|
+
##
|
236
|
+
# Returns an html script tag for each of the sources provided.
|
237
|
+
# You can pass in the filename without extension or a symbol and we search it in your +appname.public_folder+
|
238
|
+
# like app/public/javascript for inclusion. You can provide also a full path.
|
239
|
+
#
|
240
|
+
# @overload javascript_include_tag(*sources, options={})
|
241
|
+
# @param [Array<String>] sources Splat of js source paths
|
242
|
+
# @param [Hash] options The html options for the script tag
|
243
|
+
#
|
244
|
+
# @return [String] Script tag for +sources+ with specified +options+.
|
245
|
+
#
|
246
|
+
# @example
|
247
|
+
# javascript_include_tag 'application', :extjs
|
248
|
+
#
|
249
|
+
def javascript_include_tag(*sources)
|
250
|
+
options = {
|
251
|
+
:type => 'text/javascript'
|
252
|
+
}.update(sources.extract_options!.symbolize_keys)
|
253
|
+
sources.flatten.inject(ActiveSupport::SafeBuffer.new) do |all,source|
|
254
|
+
all << content_tag(:script, nil, { :src => asset_path(:js, source) }.update(options))
|
255
|
+
end
|
256
|
+
end
|
257
|
+
|
258
|
+
##
|
259
|
+
# Returns the path to the image, either relative or absolute. We search it in your +appname.public_folder+
|
260
|
+
# like app/public/images for inclusion. You can provide also a full path.
|
261
|
+
#
|
262
|
+
# @param [String] src
|
263
|
+
# The path to the image file (relative or absolute).
|
264
|
+
#
|
265
|
+
# @return [String] Path to an image given the +kind+ and +source+.
|
266
|
+
#
|
267
|
+
# @example
|
268
|
+
# # Generates: /images/foo.jpg?1269008689
|
269
|
+
# image_path("foo.jpg")
|
270
|
+
#
|
271
|
+
# @api public
|
272
|
+
def image_path(src)
|
273
|
+
asset_path(:images, src)
|
274
|
+
end
|
275
|
+
|
276
|
+
##
|
277
|
+
# Returns the path to the specified asset (css or javascript).
|
278
|
+
#
|
279
|
+
# @param [String] kind
|
280
|
+
# The kind of asset (i.e :images, :js, :css).
|
281
|
+
# @param [String] source
|
282
|
+
# The path to the asset (relative or absolute).
|
283
|
+
#
|
284
|
+
# @return [String] Path for the asset given the +kind+ and +source+.
|
285
|
+
#
|
286
|
+
# @example
|
287
|
+
# # Generates: /javascripts/application.js?1269008689
|
288
|
+
# asset_path :js, :application
|
289
|
+
#
|
290
|
+
# # Generates: /stylesheets/application.css?1269008689
|
291
|
+
# asset_path :css, :application
|
292
|
+
#
|
293
|
+
# # Generates: /images/example.jpg?1269008689
|
294
|
+
# asset_path :images, 'example.jpg'
|
295
|
+
#
|
296
|
+
# # Generates: /uploads/file.ext?1269008689
|
297
|
+
# asset_path 'uploads/file.ext'
|
298
|
+
#
|
299
|
+
def asset_path(kind, source = nil)
|
300
|
+
kind, source = source, kind if source.nil?
|
301
|
+
source = asset_normalize_extension(kind, URI.escape(source.to_s))
|
302
|
+
return source if source =~ ABSOLUTE_URL_PATTERN || source =~ /^\//
|
303
|
+
source = File.join(asset_folder_name(kind), source)
|
304
|
+
timestamp = asset_timestamp(source)
|
305
|
+
result_path = uri_root_path(source)
|
306
|
+
"#{result_path}#{timestamp}"
|
307
|
+
end
|
308
|
+
|
309
|
+
private
|
310
|
+
|
311
|
+
##
|
312
|
+
# Returns the URI root of the application with optional paths appended.
|
313
|
+
#
|
314
|
+
# @example
|
315
|
+
# uri_root_path("/some/path") => "/root/some/path"
|
316
|
+
# uri_root_path("javascripts", "test.js") => "/uri/root/javascripts/test.js"
|
317
|
+
#
|
318
|
+
def uri_root_path(*paths)
|
319
|
+
root_uri = self.class.uri_root if self.class.respond_to?(:uri_root)
|
320
|
+
File.join(ENV['RACK_BASE_URI'].to_s, root_uri || '/', *paths)
|
321
|
+
end
|
322
|
+
|
323
|
+
##
|
324
|
+
# Returns the timestamp mtime for an asset.
|
325
|
+
#
|
326
|
+
# @example
|
327
|
+
# asset_timestamp("some/path/to/file.png") => "?154543678"
|
328
|
+
#
|
329
|
+
def asset_timestamp(file_path)
|
330
|
+
return nil if file_path =~ /\?/ || (self.class.respond_to?(:asset_stamp) && !self.class.asset_stamp)
|
331
|
+
public_path = self.class.public_folder if self.class.respond_to?(:public_folder)
|
332
|
+
public_path ||= Padrino.root("public") if Padrino.respond_to?(:root)
|
333
|
+
public_file_path = File.join(public_path, file_path) if public_path
|
334
|
+
stamp = File.mtime(public_file_path).to_i if public_file_path && File.exist?(public_file_path)
|
335
|
+
stamp ||= Time.now.to_i
|
336
|
+
"?#{stamp}"
|
337
|
+
end
|
338
|
+
|
339
|
+
###
|
340
|
+
# Returns the asset folder given a kind.
|
341
|
+
#
|
342
|
+
# Configureable by setting kind_asset_folder.
|
343
|
+
#
|
344
|
+
# @example
|
345
|
+
# asset_folder_name(:css) => 'stylesheets'
|
346
|
+
# asset_folder_name(:js) => 'javascripts'
|
347
|
+
# asset_folder_name(:images) => 'images'
|
348
|
+
# asset_folder_name(:abrakadabrah) => 'abrakadabrah'
|
349
|
+
#
|
350
|
+
def asset_folder_name(kind)
|
351
|
+
if self.class.respond_to? "#{kind}_asset_folder"
|
352
|
+
self.class.send "#{kind}_asset_folder"
|
353
|
+
else
|
354
|
+
(ASSET_FOLDERS[kind] || kind).to_s
|
355
|
+
end
|
356
|
+
end
|
357
|
+
|
358
|
+
##
|
359
|
+
# Normalizes the extension for a given asset.
|
360
|
+
#
|
361
|
+
# @example
|
362
|
+
#
|
363
|
+
# asset_normalize_extension(:images, "/foo/bar/baz.png") => "/foo/bar/baz.png"
|
364
|
+
# asset_normalize_extension(:js, "/foo/bar/baz") => "/foo/bar/baz.js"
|
365
|
+
#
|
366
|
+
def asset_normalize_extension(kind, source)
|
367
|
+
ignore_extension = !APPEND_ASSET_EXTENSIONS.include?(kind.to_s)
|
368
|
+
source << ".#{kind}" unless ignore_extension || source =~ /\.#{kind}/ || source =~ ABSOLUTE_URL_PATTERN
|
369
|
+
source
|
370
|
+
end
|
371
|
+
|
372
|
+
##
|
373
|
+
# Parses link_to options for given correct conditions.
|
374
|
+
#
|
375
|
+
# @example
|
376
|
+
# parse_conditions("/some/url", :if => false) => true
|
377
|
+
#
|
378
|
+
def parse_conditions(url, options)
|
379
|
+
if options.has_key?(:if)
|
380
|
+
condition = options.delete(:if)
|
381
|
+
condition == :current ? url == request.path_info : condition
|
382
|
+
elsif condition = options.delete(:unless)
|
383
|
+
condition == :current ? url != request.path_info : !condition
|
384
|
+
else
|
385
|
+
true
|
386
|
+
end
|
387
|
+
end
|
388
|
+
end
|
389
|
+
end
|
390
|
+
end
|