ajaxlibs 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,5 +1,14 @@
 = Ajaxlibs
 
+== Synopsis
+
+Simplify standard javascript library includes :
+* specify your library name and if necessary version number
+* provides most common javascript libraries, no need to download them
+* easy CDN for javascript libraries : relies on Google CDN to distribute javascript files on production environment
+
+All that using a simple helper ruby method.
+
 == Description
 
 Ajaxlibs provides helpers to load various javascript libraries, specifying version number, locally served or using google CDN.
@@ -20,12 +29,7 @@ will produce, under the development environment :
 
 and in production :
 
- <script type="text/javascript" src="http://www.google.com/jsapi"></script> 
- <script type="text/javascript"> 
-   //<![CDATA[
-     google.load('jquery', '1.4.2');
-   //]]>
- </script>
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js" type="text/javascript"></script>
 
 === multiple libraries load
 
@@ -34,17 +38,12 @@ and in production :
 in development environment :
 
  <script src="/javascripts/ajaxlibs/jquery/1.4.2/jquery.js?1267013480" type="text/javascript"></script> 
- <script src="/javascripts/ajaxlibs/jqueryui/1.7.2/jqueryui.js" type="text/javascript"></script>
+ <script src="/javascripts/ajaxlibs/jqueryui/1.7.2/jqueryui.js?1267013480" type="text/javascript"></script>
 
 this time in production :
 
- <script type="text/javascript" src="http://www.google.com/jsapi"></script> 
- <script type="text/javascript"> 
-   //<![CDATA[
-     google.load('jquery', '1.4.2');
-     google.load('jqueryui', '1.7.2');
-   //]]>
- </script>
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js" type="text/javascript"></script>
+ <script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.2/jquery-ui.js" type="text/javascript"></script>
 
 === forcing a version
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/ajaxlibs/includes_helper.rb

@@ -19,20 +19,15 @@ module Ajaxlibs::IncludesHelper
   #
   #  ajaxlibs_include :jquery, :jqueryui
   #    <script src="/javascripts/ajaxlibs/jquery/1.4.2/jquery.js?1267013480" type="text/javascript"></script> 
-  #    <script src="/javascripts/ajaxlibs/jqueryui/1.7.2/jqueryui.js" type="text/javascript"></script>
+  #    <script src="/javascripts/ajaxlibs/jqueryui/1.7.2/jqueryui.js?1267013480" type="text/javascript"></script>
   #
   # * Same examples as above, this time in production
   #  ajaxlibs_include :jquery
-  #    <script src="/javascripts/ajaxlibs/jquery/1.4.2/jquery.js?1267013480" type="text/javascript"></script>
+  #    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js" type="text/javascript"></script>
   #
   #  ajaxlibs_include :jquery, :jqueryui
-  #    <script type="text/javascript" src="http://www.google.com/jsapi"></script> 
-  #    <script type="text/javascript"> 
-  #    //<![CDATA[
-  #    google.load('jquery', '1.4.2');
-  #    google.load('jqueryui', '1.7.2');
-  #    //]]>
-  #    </script>
+  #    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js" type="text/javascript"></script>
+  #    <script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.2/jquery-ui.js" type="text/javascript"></script>
   #
   # * Specifying version
   #  ajaxlibs_include :prototype, :version => '1.6.0.3'
@@ -45,46 +40,32 @@ module Ajaxlibs::IncludesHelper
   #
   def ajaxlibs_include(*args)
     options = (Hash === args.last) ? args.pop : {}
-
-    includes = args.collect {|library| javascript_include_library library, options}.compact.join("\n")
     
-    if options[:local] === false or RAILS_ENV == 'production'
-      <<-EOB
-        <script type="text/javascript" src="#{Ajaxlibs::GoogleJSAPI}"></script>
-        #{javascript_tag includes}
-      EOB
-    else
-      includes
-    end
+    includes = args.collect {|library| javascript_include_library library, options}.flatten.compact
+    
+    includes.collect {|ajaxlib| javascript_include_tag ajaxlib.include_path}.join("\n")
   end
   
   private
   def javascript_include_library(library, options)
     library = library.to_sym
+    version = options.delete(:version)
+    source  = (options[:local] === true or RAILS_ENV != 'production') ? :local : :remote
+    ajaxlib = Ajaxlibs::Library.by_name(library, :version => version, :source => source)
 
     @included_javascript_libraries ||= []
     
-    return if @included_javascript_libraries.include?(library)
-
-    version = options.delete(:version)
-    ajaxlib = Ajaxlibs::Library.by_name(library)
+    return if @included_javascript_libraries.include?(ajaxlib)
+    @included_javascript_libraries << ajaxlib
     
     result = []
     
-    # Handle dependencies between libraries
-    if ajaxlib.requires and !@included_javascript_libraries.include?(ajaxlib.requires.to_sym)
-      result << javascript_include_library(ajaxlib.requires, options)
-    end
-          
-    @included_javascript_libraries << library
-    
-    # Javascript load code
-    if options[:local] === true or RAILS_ENV != 'production'
-      result << javascript_include_tag(ajaxlib.local_path(version))
-    else
-      result << ajaxlib.google_cdn_load_code(version)
+    if ajaxlib.requires
+      ajaxlib.requires.each do |required_library, required_version|
+        result << javascript_include_library(required_library, :version => required_version)
+      end
     end
     
-    result.join("\n")
+    result << ajaxlib
   end
 end

data/lib/ajaxlibs/libraries/dojo.rb

@@ -0,0 +1,14 @@
+class Ajaxlibs::Library::Dojo < Ajaxlibs::Library
+  Versions = ["1.1.1",
+              "1.2.0",
+              "1.2.3",
+              "1.3.0",
+              "1.3.1",
+              "1.3.2",
+              "1.4.0",
+              "1.4.1"]
+  
+  def file_name #:nodoc:
+    "dojo.xd.js.uncompressed"
+  end
+end

data/lib/ajaxlibs/libraries/jqueryui.rb

@@ -6,11 +6,9 @@ class Ajaxlibs::Library::Jqueryui < Ajaxlibs::Library
               '1.7.1',
               '1.7.2']
 
-  def requires #:nodoc:
-    'jquery'
-  end
-  
-  def filename #:nodoc:
+  Requirements = {:all => {:jquery => nil}}
+
+  def file_name #:nodoc:
     "jquery-ui"
   end
 end

data/lib/ajaxlibs/libraries/mootools.rb

@@ -0,0 +1,8 @@
+class Ajaxlibs::Library::Mootools < Ajaxlibs::Library
+  Versions = ["1.1.1",
+              "1.1.2",
+              "1.2.1",
+              "1.2.2",
+              "1.2.3",
+              "1.2.4"]
+end

data/lib/ajaxlibs/libraries/scriptaculous.rb

@@ -2,8 +2,6 @@ class Ajaxlibs::Library::Scriptaculous < Ajaxlibs::Library
   Versions = ['1.8.1',
               '1.8.2',
               '1.8.3']
-  
-  def requires #:nodoc:
-    'prototype'
-  end
+              
+  Requirements = {:all => {:prototype => nil}}
 end

data/lib/ajaxlibs/library.rb

@@ -7,6 +7,9 @@ require 'ajaxlibs/versions_tools'
 class Ajaxlibs::Library
   # Available versions for this library.
   Versions = []
+  Requirements = {}
+  
+  attr_reader :version, :source
   
   @@subclasses = {}
 
@@ -19,9 +22,9 @@ class Ajaxlibs::Library
     @@subclasses.values
   end
   
-  # Search a specific library by its name, could by either a string or a symbol.
-  def self.by_name(name)
-    @@subclasses[name.to_sym].new
+  # Search a specific library by its name (could be either a string or a symbol) and initialized it with given version and source.
+  def self.by_name(name, options = {})
+    @@subclasses[name.to_sym].new options
   rescue NoMethodError
     raise Ajaxlibs::Exception::LibraryNotFound
   end
@@ -31,9 +34,14 @@ class Ajaxlibs::Library
     name.match(/::(\w+)$/)[1].downcase
   end
   
+  def initialize(options = {})
+    @version  = check_version_or_latest_version(options[:version])
+    @source   = options[:source] || :local
+  end
+  
   # Returns requirements for a library (for example, prototype for scriptaculous)
   def requires
-    nil
+    self.class::Requirements[@version] || self.class::Requirements[:all]
   end
   
   # Library name based on class name
@@ -52,13 +60,26 @@ class Ajaxlibs::Library
   end
   
   # Local path for a particular version, or the latest if given version is nil.
-  def local_path(version = nil)
-    File.join('ajaxlibs', library_name, check_version_or_latest_version(version), file_name)
+  def local_path
+    File.join('ajaxlibs', library_name, version, file_name)
+  end
+  
+  # Include path using google CDN
+  def google_cdn_include_path
+    "http://ajax.googleapis.com/ajax/libs/#{library_name}/#{version}/#{file_name}.js"
+  end
+  
+  # Javascript include path regarding source (call either local_path or google_cdn_include_path)
+  def include_path
+    source == :local ? local_path : google_cdn_include_path
+  end
+  
+  def local_only?
+    false
   end
   
-  # Javascript load code through google jsapi for a particular version, or the latest if given version is nil.
-  def google_cdn_load_code(version = nil)
-    "google.load('#{library_name}', '#{check_version_or_latest_version(version)}');"
+  def ==(other)
+    self.class == other.class and self.version == other.version and self.source == other.source
   end
   
   private

data/lib/ajaxlibs.rb

@@ -2,8 +2,10 @@ require 'ajaxlibs/constants'
 require 'ajaxlibs/exceptions'
 require 'ajaxlibs/versions_tools'
 require 'ajaxlibs/library'
+require 'ajaxlibs/libraries/dojo'
 require 'ajaxlibs/libraries/jquery'
 require 'ajaxlibs/libraries/jqueryui'
+require 'ajaxlibs/libraries/mootools'
 require 'ajaxlibs/libraries/prototype'
 require 'ajaxlibs/libraries/scriptaculous'
 require 'ajaxlibs/includes_helper'