@@ -1,5 +1,5 @@ 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. @@ -46,4 +46,49 @@ Note: All the default dependencies are defined already (prototype/scriptaculous) 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 + +Using Google AJAX Libraries +=========================== +Google provides hosting for popular javascript libraries +http://code.google.com/apis/ajaxlibs/documentation/index.html + +Using this plugin, you can opt to use libraries from their server rather than yours. + +By default, only local (/public/javascripts/) javascripts are used +but if you want to use Google's server, simply add this to an initializer: + + JavascriptHelper::JavascriptHelperConfig.use_google_ajax_libs = true + +You can put it in your environment files (development/production) to differentiate +settings for development mode and production. + +You can technically also put it in your application helper after "include JavascriptHelper", +but that's kind of ugly and not recommended. + +If you set use_google_ajax_libs to true, when you do + + js :prototype + +it will yield + + <script src="http://ajax.googleapis.com/ajax/libs/prototype/1.6.0.2/prototype.js" type="text/javascript"></script> + + +Here is a list of the libraries provided by Google: + * jQuery + * prototype + * scriptaculous (builder, effects, dragdrop, controls, slider, sound) + * mootools + * dojo + +If you wish to use the compressed version of the library, you can specify that like this: + + JavascriptHelper::JavascriptHelperConfig.google_ajax_libs[:jQuery][:prefer_compressed] = true + + +Note: compressed versions are not provided for prototype or scriptaculous libraries. + +By default, the latest versions of the libraries as of the updating of this plugin are used, +but you can specify the version you want yourself like so: + + JavascriptHelper::JavascriptHelperConfig.google_ajax_libs[:effects][:version] = "1.8.2" \ No newline at end of file README @@ -14,6 +14,9 @@ module JavascriptHelper :effects => [:prototype], :dragdrop => [:prototype, :effects], :controls => [:prototype, :effects], + :builder => [:prototype], + :slider => [:prototype, :effects], + :sound => [:prototype], :behaviour => [:prototype], :lowpro => [:prototype] }.merge(respond_to?(:js_dependencies) ? js_dependencies : {})[js.to_sym] || [] @@ -21,7 +24,55 @@ module JavascriptHelper def javascript_tags (@required_javascripts || []).collect do |js| - javascript_include_tag("#{js}.js") + path = JavascriptHelperConfig.use_google_ajax_libs && google_ajax_libs_url(js) || "#{js}.js" + javascript_include_tag(path) end.join("\n") end + + def google_ajax_libs_url(lib) + if cfg = JavascriptHelperConfig.google_ajax_libs[lib.to_sym] + url = cfg[:prefer_compressed] && cfg[:compressed_url] || cfg[:uncompressed_url] + url.sub("{version}", cfg[:version]) + end + end + + # used this class to name to avoid collisions since this is included in ApplicationHelper + class JavascriptHelperConfig + cattr_accessor :use_google_ajax_libs + cattr_accessor :google_ajax_libs + self.use_google_ajax_libs = false + + self.google_ajax_libs = { + :jQuery => { + :version => "1.2.6", + :compressed_url => "http://ajax.googleapis.com/ajax/libs/jquery/{version}/jquery.min.js", + :uncompressed_url => "http://ajax.googleapis.com/ajax/libs/jquery/{version}/jquery.js", + :prefer_compressed => false + }, + :prototype => { + :version => "1.6.0.2", + :uncompressed_url => "http://ajax.googleapis.com/ajax/libs/prototype/{version}/prototype.js" + }, + :mootools => { + :version => "1.11", + :compressed_url => "http://ajax.googleapis.com/ajax/libs/mootools/{version}/mootools-yui-compressed.js", + :uncompressed_url => "http://ajax.googleapis.com/ajax/libs/mootools/{version}/mootools.js", + :prefer_compressed => false + }, + :dojo => { + :version => "1.1.1", + :compressed_url => "http://ajax.googleapis.com/ajax/libs/dojo/{version}/dojo/dojo.xd.js", + :uncompressed_url => "http://ajax.googleapis.com/ajax/libs/dojo/{version}/dojo/dojo.xd.js.uncompressed.js", + :prefer_compressed => false + } + } + + # scriptaculous libraries + %w{builder effects dragdrop controls slider sound}.each do |lib| + self.google_ajax_libs[lib.to_sym] = { + :version => "1.8.1", + :uncompressed_url => "http://ajax.googleapis.com/ajax/libs/scriptaculous/{version}/#{lib}.js" + } + end + end end \ No newline at end of file lib/javascript_helper.rb @@ -1,6 +1,9 @@ require 'test/unit' +require 'rubygems' +require 'activesupport' require 'javascript_helper.rb' + class JavascriptHelperTest < Test::Unit::TestCase include JavascriptHelper @@ -19,6 +22,18 @@ class JavascriptHelperTest < Test::Unit::TestCase assert (javascript_tags =~ /taggies\.js/) end + def test_google_libs_when_true + JavascriptHelper::JavascriptHelperConfig.use_google_ajax_libs = true + js(:prototype) + assert (javascript_tags =~ /googleapis/) + end + + def test_no_google_libs_when_false + JavascriptHelper::JavascriptHelperConfig.use_google_ajax_libs = false + js(:prototype) + assert (javascript_tags !~ /googleapis/) + end + def js_dependencies { :needsmorefoobar => [:morefoobar] test/javascript_helper_test.rb 3b53c4477a87d60ce32d0bb8d2fe86209cea8f23 Arya Asemanfar arya.asemanfar@gmail.com http://github.com/arya/js_dependency_manager/commit/9181261fec296b0eee8433db687b6004a3258af6 9181261fec296b0eee8433db687b6004a3258af6 2008-05-29T14:56:15-07:00 2008-05-29T14:12:47-07:00 * support google ajax libraries * added builder, sound, and slider to default list 6c9377f79e5f073a832c4835b56ca65b52493258 Arya Asemanfar arya.asemanfar@gmail.com