Rakefile init.rb install.rb lib/javascript_helper.rb test/javascript_helper_test.rb @@ -0,0 +1,49 @@ +Javascript Dependency Manager +==== +This plugin is a basic javascript dependency manager. It makes it simple to +specify the dependencies for specific javascript files/libraries and implicitly +include them. + +Example Usage: +1. Add "include JavascriptHelper" in your ApplicationHelper. + + # app/helpers/application_helper.rb + module ApplicationHelper + include JavascriptHelper + end + +2. Specify any dependencies in a method named "js_dependencies" (optional) +Note: All the default dependencies are defined already (prototype/scriptaculous) + # app/helpers/application_helper.rb + module ApplicationHelper + include JavascriptHelper + + def js_dependencies + { + # dialog_box.js requires effects.js and behaviour.js + :dialog_box => [:effects, :behaviour] + } + end + end + +3. In your layout, add "javascript_tags" in the head of your HTML doc. + + # app/views/layouts/default.html.erb + ... + <head> + <%= javascript_tags -%> + </head> + ... + +4. In your views, when you need to use the dialog_box.js library, + just include it using the "js" method or + "add_javascript_requirement" + + # app/views/users/new.html.erb + <% js :dialog_box %> # you can use a string or symbol for the name. + + +5. That's it. It's a work in progress, feel free to contribute to it: + http://github.com/arya/js_dependency_manager + + \ No newline at end of file README ed41bf961edbe666b345eaf99915695579d65517 Arya Asemanfar arya.asemanfar@gmail.com http://github.com/arya/js_dependency_manager/commit/48874215443058831a4a6c9d313cbd25b68bec56 48874215443058831a4a6c9d313cbd25b68bec56

2008-04-26T23:11:03-07:00

* README updated with example usage * JavascriptHelper added * basic unit tests 678bd7cfdb58f4b1b2737c9880aad100feda410e Arya Asemanfar arya.asemanfar@gmail.com