ajaxlibs 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Fabien Jakimowicz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,97 @@
+= Ajaxlibs
+
+== Description
+
+Ajaxlibs provides helpers to load various javascript libraries, specifying version number, locally served or using google CDN.
+
+In development environment, it provides local javascript files for the development server. In production environment, it will automatically use google CDN to serve your standard javascript libraries.
+
+You can specify a specific version of each library to use, or the latest available.
+
+== Examples
+
+=== simple library load, under the development environment
+
+ <%= ajaxlibs_include :jquery %>
+
+will produce, under the development environment :
+
+ <script src="/javascripts/ajaxlibs/jquery/1.4.2/jquery.js?1267013480" type="text/javascript"></script>
+
+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>
+
+=== multiple libraries load
+
+ <%= ajaxlibs_include :jquery, :jqueryui %>
+
+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>
+
+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>
+
+=== forcing a version
+
+ <%= ajaxlibs_include :prototype, :version => '1.6.0.3' %>
+
+will produce :
+
+ <script src="/javascripts/ajaxlibs/prototype/1.6.0.3/prototype.js?1267013480" type="text/javascript"></script>
+
+=== automatic dependencies
+
+ <%= ajaxlibs_include :scriptaculous %>
+
+will produce :
+
+ <script src="/javascripts/ajaxlibs/prototype/1.6.1.0/prototype.js?1267013480" type="text/javascript"></script> 
+ <script src="/javascripts/ajaxlibs/scriptaculous/1.8.3/scriptaculous.js?1267013481" type="text/javascript"></script>
+
+== Installation
+
+First, install gem on your system and servers. You can also specify it as a dependency on your rails enviroment :
+
+ config.gem 'ajaxlibs'
+
+Then, just restart your rails server to copy files from gem the public directory of your rails application.
+
+Finally, include some javascript libraries to your views or layouts :
+
+ <%= ajaxlibs_include :scriptaculous %>
+
+== TODO
+
+* support more javascript libraries : available though Google CDN (mootools, ...), not available through Google CDN (jrails, ...), available only from google (google maps, ...).
+* support plain/minified versions.
+* provide a rake task to copy only required javascript libraries.
+* automatic support for jrails.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Fabien Jakimowicz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ajaxlibs"
+    gem.summary = %Q{helper to load various javascript libraries, locally or through google CDN}
+    gem.description = %Q{ajaxlibs provides helpers to load various javascript libraries, specifying version number, locally served or using google CDN}
+    gem.email = "fabien@jakimowicz.com"
+    gem.homepage = "http://github.com/jakimowicz/ajaxlibs"
+    gem.authors = ["Fabien Jakimowicz"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ajaxlibs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ajaxlibs/constants.rb

@@ -0,0 +1,3 @@
+module Ajaxlibs
+  GoogleJSAPI = "http://www.google.com/jsapi"
+end

data/lib/ajaxlibs/exceptions.rb

@@ -0,0 +1,8 @@
+class Ajaxlibs::Exception < StandardError
+end
+
+class Ajaxlibs::Exception::LibraryNotFound < Ajaxlibs::Exception
+end
+
+class Ajaxlibs::Exception::VersionNotFound < Ajaxlibs::Exception
+end

data/lib/ajaxlibs/includes_helper.rb

@@ -0,0 +1,90 @@
+module Ajaxlibs::IncludesHelper
+  # Returns an html script tag for each javascript library name provided.
+  # By default, javascript files are loaded locally for development and test environment,
+  # and through Google CDN on production environment. Basic dependencies are automatically handled.
+  #
+  # == Options
+  # * <tt>version</tt> : specify the version to use for each library
+  # * <tt>local</tt> : if true, always serve file locally, if false, use Google CDN
+  # * <tt>remote</tt> : if false, always serve file locally, if true, use Google CDN
+  #
+  # == Exceptions
+  # * <tt>Ajaxlibs::Exception::LibraryNotFound</tt> : raised if one or more of the given library is not available
+  # * <tt>Ajaxlibs::Exception::VersionNotFound</tt> : raised if given version is not available for this/these library/libraries
+  #
+  # == Examples
+  # * Simple library load, under the development environment
+  #  ajaxlibs_include :jquery
+  #    <script src="/javascripts/ajaxlibs/jquery/1.4.2/jquery.js?1267013480" type="text/javascript"></script>
+  #
+  #  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>
+  #
+  # * 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>
+  #
+  #  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>
+  #
+  # * Specifying version
+  #  ajaxlibs_include :prototype, :version => '1.6.0.3'
+  #    <script src="/javascripts/ajaxlibs/prototype/1.6.0.3/prototype.js?1267013480" type="text/javascript"></script>
+  #
+  # * Automatic dependencies
+  #  ajaxlibs_include :scriptaculous
+  #    <script src="/javascripts/ajaxlibs/prototype/1.6.1.0/prototype.js?1267013480" type="text/javascript"></script> 
+  #    <script src="/javascripts/ajaxlibs/scriptaculous/1.8.3/scriptaculous.js?1267013481" type="text/javascript"></script>
+  #
+  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
+  end
+  
+  private
+  def javascript_include_library(library, options)
+    library = library.to_sym
+
+    @included_javascript_libraries ||= []
+    
+    return if @included_javascript_libraries.include?(library)
+
+    version = options.delete(:version)
+    ajaxlib = Ajaxlibs::Library.by_name(library)
+    
+    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)
+    end
+    
+    result.join("\n")
+  end
+end

data/lib/ajaxlibs/libraries/jquery.rb

@@ -0,0 +1,10 @@
+class Ajaxlibs::Library::Jquery < Ajaxlibs::Library
+  Versions = ['1.2.3',
+              '1.2.6',
+              '1.3.0',
+              '1.3.1',
+              '1.3.2',
+              '1.4.0',
+              '1.4.1',
+              '1.4.2']
+end

data/lib/ajaxlibs/libraries/jqueryui.rb

@@ -0,0 +1,16 @@
+class Ajaxlibs::Library::Jqueryui < Ajaxlibs::Library
+  Versions = ['1.5.2',
+              '1.5.3',
+              '1.6'  ,
+              '1.7.0',
+              '1.7.1',
+              '1.7.2']
+
+  def requires #:nodoc:
+    'jquery'
+  end
+  
+  def filename #:nodoc:
+    "jquery-ui"
+  end
+end

data/lib/ajaxlibs/libraries/prototype.rb

@@ -0,0 +1,5 @@
+class Ajaxlibs::Library::Prototype < Ajaxlibs::Library
+  Versions = ['1.6.0.2',
+              '1.6.0.3',
+              '1.6.1.0']
+end

data/lib/ajaxlibs/libraries/scriptaculous.rb

@@ -0,0 +1,9 @@
+class Ajaxlibs::Library::Scriptaculous < Ajaxlibs::Library
+  Versions = ['1.8.1',
+              '1.8.2',
+              '1.8.3']
+  
+  def requires #:nodoc:
+    'prototype'
+  end
+end

data/lib/ajaxlibs/library.rb

@@ -0,0 +1,73 @@
+require 'ajaxlibs/exceptions'
+require 'ajaxlibs/versions_tools'
+
+# Represents an ajaxlib library, regroups available version of a particular library
+# and a few functions to generate either a filepath to local library or javascript loading code
+# for Google CDN.
+class Ajaxlibs::Library
+  # Available versions for this library.
+  Versions = []
+  
+  @@subclasses = {}
+
+  def self.inherited(child) #:nodoc:
+    @@subclasses[child.library_name.to_sym] = child
+  end
+  
+  # Returns all available libraries (instance of Ajaxlibs::Library).
+  def self.all
+    @@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
+  rescue NoMethodError
+    raise Ajaxlibs::Exception::LibraryNotFound
+  end
+
+  # Library name based on class name
+  def self.library_name
+    name.match(/::(\w+)$/)[1].downcase
+  end
+  
+  # Returns requirements for a library (for example, prototype for scriptaculous)
+  def requires
+    nil
+  end
+  
+  # Library name based on class name
+  def library_name
+    self.class.library_name
+  end
+
+  # Javascript library filename, can be different from library_name (jqueryui / jquery-ui for example)
+  def file_name
+    library_name
+  end
+  
+  # Search for the latest version available using given Versions
+  def latest_version
+    self.class::Versions.max {|a, b| Ajaxlibs::VersionsTools.compare a, b}
+  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)
+  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)}');"
+  end
+  
+  private
+  # Checks if given version is available for this library,
+  # raises Ajaxlibs::Exception::VersionNotFound if not and returns it.
+  # Passing a nil value will returns the latest available version
+  def check_version_or_latest_version(version = nil)
+    version ||= latest_version
+    raise Ajaxlibs::Exception::VersionNotFound unless self.class::Versions.include?(version)
+    version
+  end
+end

data/lib/ajaxlibs/versions_tools.rb

@@ -0,0 +1,16 @@
+# Tools to manipulate versions strings (for example 1.2.3)
+module Ajaxlibs::VersionsTools
+  # Compare two versions and returns either :
+  # * 1 if a > b
+  # * 0 if a == b
+  # * -1 if a < b
+  def self.compare(a, b)
+    return 0 if a == b
+    splitted_a, splitted_b = a.split('.'), b.split('.')
+    splitted_a.each_with_index do |node, i|
+      break if node < splitted_b[i]
+      return 1 if node > splitted_b[i]
+    end
+    return -1
+  end
+end

data/lib/ajaxlibs.rb

@@ -0,0 +1,34 @@
+require 'ajaxlibs/constants'
+require 'ajaxlibs/exceptions'
+require 'ajaxlibs/versions_tools'
+require 'ajaxlibs/library'
+require 'ajaxlibs/libraries/jquery'
+require 'ajaxlibs/libraries/jqueryui'
+require 'ajaxlibs/libraries/prototype'
+require 'ajaxlibs/libraries/scriptaculous'
+require 'ajaxlibs/includes_helper'
+
+if Object.const_defined?(:ActionView)
+  # Make Ajaxlibs helpers available in views
+  ActionView::Base.send(:include, Ajaxlibs::IncludesHelper)
+
+  # Copy all available js libraries to rails public folder
+  if Object.const_defined?(:Rails) and File.directory?(File.join(Rails.root, 'public'))
+    ajaxlibs_js_path = File.join(Rails.root, 'public', 'javascripts', 'ajaxlibs')
+  
+    # We do not have already copied local javascript files, copying them right away
+    # OPTIMIZE : we should copy only necessary libraries
+    unless File.directory?(ajaxlibs_js_path)
+      FileUtils.mkdir_p(ajaxlibs_js_path)
+      Ajaxlibs::Library.all.each do |library|
+        library::Versions.each do |version|
+          source      = File.join(File.dirname(__FILE__), '..', 'public', library.library_name, version, '*.*')
+          destination = File.join(ajaxlibs_js_path, library.library_name, version)
+          FileUtils.mkdir_p(destination)
+          FileUtils.cp(Dir.glob(source), destination)
+        end
+      end
+    end
+  end
+  
+end