sinatra_more 0.1.4 → 0.1.5
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +26 -23
- data/VERSION +1 -1
- data/sinatra_more.gemspec +1 -1
- metadata +1 -1
data/README.rdoc
CHANGED
@@ -2,44 +2,47 @@
|
|
2
2
|
|
3
3
|
== Introduction
|
4
4
|
|
5
|
-
Note: This library is experimental and may not
|
5
|
+
Note: This library is still experimental and may not be ready for production just yet.
|
6
|
+
That being said, work is being put into reaching solid test coverage and the gem is being actively used
|
7
|
+
on a number of sinatra projects. This notice will be removed once sufficient testing has been done.
|
6
8
|
|
7
|
-
This will be a plugin which
|
8
|
-
Note that
|
9
|
+
This will be a plugin which expands sinatra's capabilities in a variety of ways.
|
10
|
+
Note that as much as possible, all helpers have been created to work with haml, erb, and erubis.
|
11
|
+
This gem is intended to be template-agnostic in providing helpers as much as possible.
|
9
12
|
|
10
13
|
Let me expand briefly on what I want to accomplish with this gem. I love sinatra but if I want to use it
|
11
14
|
for any non-trivial application I very quickly miss a lot of the extra tools provided by rails.
|
12
15
|
|
13
|
-
Now the obvious question is
|
14
|
-
version 3 comes along, Rails is quite a large framework
|
15
|
-
|
16
|
-
only as
|
16
|
+
Now the obvious question is "Why not just use rails then?" Well, in many cases that might be the right decision.
|
17
|
+
Still, at least until version 3 comes along, Rails is quite a large framework with a 'take it or leave it' attitude.
|
18
|
+
Personally, I have come to love the spirit of sinatra which acts as a thin wrapper on top of rack
|
19
|
+
often allowing middleware to do most of the work and pulling in additional complexity only as required.
|
17
20
|
|
18
|
-
My goal with this extension is to
|
19
|
-
of tools, helpers and components that will make Sinatra
|
21
|
+
My goal with this extension is to match the spirit of Sinatra and at the same time create a standard library
|
22
|
+
of tools, helpers and components that will make Sinatra suitable for more complex applications.
|
20
23
|
|
21
|
-
Here is a small list of what sinatra_more
|
24
|
+
Here is a small list of what sinatra_more contains:
|
22
25
|
|
23
|
-
*
|
26
|
+
* Generic view and tag helpers (tag, content_tag, input_tag, ...)
|
24
27
|
* Asset helpers (link_to, image_tag, javascript_include_tag, ...)
|
25
|
-
* Form helpers and
|
26
|
-
* Plug and play
|
28
|
+
* Form helpers and builder support (form_tag, form_for, field_set_tag, text_field, ...)
|
29
|
+
* Plug and play setup for the excellent Warden authentication system
|
30
|
+
* Code generators for creating a new sinatra application
|
27
31
|
|
28
|
-
Keep in mind, the user will be able to pull in components
|
32
|
+
Keep in mind, the user will be able to pull in these components seperately and leave out those that are not required.
|
29
33
|
|
30
|
-
|
31
|
-
fork the project if you have any ideas that will help flesh out this project!
|
34
|
+
Please help me brainstorm and fork the project if you have any ideas to contribute.
|
32
35
|
|
33
36
|
== Installation
|
34
37
|
|
35
|
-
This gem has very few runtime dependencies.
|
36
|
-
|
38
|
+
This gem has very few runtime dependencies. The 'sinatra' gem needs to be installed and also 'activesupport'.
|
39
|
+
If you want to use the WardenPlugin component, then the 'warden' gem is also required.
|
37
40
|
|
38
41
|
To install sinatra_more, simply grab the latest version from gemcutter:
|
39
42
|
|
40
43
|
$ sudo gem install sinatra_more --source http://gemcutter.org
|
41
44
|
|
42
|
-
Now you are ready to use
|
45
|
+
Now you are ready to use this gem in your sinatra project.
|
43
46
|
|
44
47
|
== Usage
|
45
48
|
|
@@ -56,7 +59,7 @@ different components based on which pieces are useful for your particular applic
|
|
56
59
|
register SinatraMore::WardenPlugin
|
57
60
|
end
|
58
61
|
|
59
|
-
This will then allow you to use
|
62
|
+
This will then allow you to use the components that have been registered. A breakdown of components is below:
|
60
63
|
|
61
64
|
=== MarkupPlugin
|
62
65
|
|
@@ -277,8 +280,8 @@ provided to make interacting with warden dead simple.
|
|
277
280
|
|
278
281
|
== Acknowledgements
|
279
282
|
|
280
|
-
Thanks to keldredd for the sinatra_helpers code that helped me to create erb capture and concat methods.
|
281
|
-
Thanks to sbfaulkner for the sinatra-helpers code that I looked
|
283
|
+
* Thanks to keldredd for the sinatra_helpers code that helped me to create erb capture and concat methods.
|
284
|
+
* Thanks to sbfaulkner for the sinatra-helpers code that I looked while starting this library.
|
282
285
|
|
283
286
|
== Contributers
|
284
287
|
|
@@ -287,7 +290,7 @@ Thanks to sbfaulkner for the sinatra-helpers code that I looked over while build
|
|
287
290
|
|
288
291
|
== Known Issues
|
289
292
|
|
290
|
-
*
|
293
|
+
* Tag helper methods that accept blocks work unreliably in ERB.
|
291
294
|
|
292
295
|
== Note on Patches/Pull Requests
|
293
296
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.1.
|
1
|
+
0.1.5
|
data/sinatra_more.gemspec
CHANGED