local_cdn 0.3.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-10 Alex Reisner
+
+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,64 @@
+= Local CDN
+
+Local CDN simplifies the inclusion of external stylesheets and JavaScript from various content delivery networks (CDNs), and uses local alternatives for local requests in development mode so your site loads faster, and looks right even when you don't have an Internet connection (eg, on an airplane). 
+
+<b>Local CDN is compatible with Rails 2.x and Rails 3.</b>
+
+
+== 1. Install
+
+=== As a Gem (on Rails 3)
+
+Add this to your Gemfile:
+
+  gem "local_cdn"
+
+and run this at the command prompt:
+
+  bundle install
+
+=== Or As a Plugin
+
+At the command prompt:
+
+  rails plugin install git://github.com/alexreisner/local_cdn.git
+
+
+== 2. Configure
+
+You have to tell LocalCDN the URLs of the CDNs you're using: the remote (normal) URLs and the local (mirror) URLs. You do this in two separate config files:
+
+  config/cdn.remote.yml
+  config/cdn.local.yml
+
+These files might look something like this:
+
+  # cdn.remote.yml
+  google: "http://ajax.googleapis.com/ajax/libs/"
+  yahoo:  "http://yui.yahooapis.com/"
+
+  # cdn.local.yml
+  google: "http://localhost/cdn_mirror/google/"
+  yahoo:  "http://localhost/cdn_mirror/yahoo/"
+
+<b>Be sure to include the trailing slashes!</b>
+
+Having two separate config files might seem tedious, but there is a good reason for it: developers may keep their local CDN mirrors in different places on their computers. Hence <b>you should check <tt>cdn.remote.yml</tt> into your source code repository, but not <tt>cdn.local.yml</tt></b>. Your application will run just fine without <tt>cdn.local.yml</tt>: remote URLs will be used. If a developer wishes, they can set up a local mirror and create <tt>cdn.local.yml</tt>.
+
+To set up a local CDN mirror, see: http://github.com/alexreisner/cdn_mirror
+
+
+== 3. Use
+
+To use LocalCDN you must change your stylesheet and javascript inclusion tags slightly. Prepend +cdn_+ to the method name and add a new first argument which is the name of the desired CDN (as a symbol), as specified in <tt>cdn.remote.yml</tt>. For example, if you're currently loading jQuery from Google's CDN you probably have something like this:
+
+  <%= javascript_include_tag "http://ajax.googleapis.com/ajax/libs/jquery/1.4.3/jquery.min.js" %>
+
+To ensure that jQuery still gets served when you don't have a network connection, you would change the above tag to the following (assuming you have the above entry for <tt>google</tt> in your <tt>cdn.remote.yml</tt>:
+
+  <%= cdn_javascript_include_tag :google, "jquery/1.4.3/jquery.min.js" %>
+
+Needless to say, you must also make sure the file is available locally at <tt>http://localhost/local_cdn/jquery/1.4.3/jquery.min.js</tt>. Again, to set up a local CDN mirror, see: http://github.com/alexreisner/cdn_mirror
+
+
+Copyright (c) 2009-10 Alex Reisner, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the local_cdn plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the local_cdn plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LocalCdn'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/config.rb

@@ -0,0 +1,17 @@
+module LocalCDN
+  class Config
+    attr_reader :urls
+
+    def initialize
+      @urls = {}
+      @urls[:remote] = YAML.load_file(file_path(:remote))
+      if File.exist?(f = file_path(:local))
+        @urls[:local] = YAML.load_file(f)
+      end
+    end
+
+    def file_path(local_or_remote)
+      File.join Rails.root, "config", "cdn.#{local_or_remote}.yml"
+    end
+  end
+end

data/lib/local_cdn.rb

@@ -0,0 +1,86 @@
+require 'config'
+
+module LocalCDN
+
+  ##
+  # Render a stylesheet link tag.
+  # Uses local copy in development mode, CDN otherwise.
+  #
+  def cdn_stylesheet_link_tag(cdn, file)
+    cdn_include_tag(:stylesheet, cdn, file)
+  end
+
+  ##
+  # Render a JavaScript include tag.
+  # Uses local copy in development mode, CDN otherwise.
+  #
+  def cdn_javascript_include_tag(cdn, file)
+    cdn_include_tag(:javascript, cdn, file)
+  end
+
+
+  private # -----------------------------------------------------------------
+
+  ##
+  # The CDN configuration object (based on user config files).
+  #
+  def cdn_config
+    if defined?(@config)
+      @config
+    else
+      @config = LocalCDN::Config.new
+    end
+  end
+
+  ##
+  # Get the URL of the named CDN.
+  # URLs are specified in the local_cdn config files.
+  #
+  def cdn_url(name)
+    urls = cdn_config.urls
+    if local_request? and locals = urls[:local] and url = locals[name.to_s]
+      url
+    else
+      if remotes = urls[:remote][name.to_s]
+        remotes
+      else
+        raise MissingCDN, name
+      end
+    end
+  end
+
+  ##
+  # Render a stylesheet or JavaScript include tag.
+  #
+  def cdn_include_tag(type, cdn, file)
+    method = type == :javascript ? :javascript_include_tag : :stylesheet_link_tag
+    send(method, cdn_url(cdn) + file)
+  end
+
+  ##
+  # Are we in the development environment and on localhost?
+  #
+  def local_request?
+    Rails.env == "development" and (
+      request.server_name =~ /local/ or request.server_name == '127.0.0.1'
+    )
+  end
+
+  ##
+  # Are we on Rails 3 or using the rails_xss plugin?
+  #
+  def rails_3?
+    String.instance_methods.include?("html_safe?")
+  end
+
+  ##
+  # Exception class, for when the specified CDN has not been defined.
+  #
+  class MissingCDN < NameError
+    def initialize(cdn)
+      super "Expected the CDN '#{cdn}' to be defined in the cdn.remote.yml config file"
+    end
+  end
+end
+
+ActionView::Base.send(:include, LocalCDN)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: local_cdn
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Alex Reisner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-11 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Allows you to use a CDN for static content in production and still load assets in development when lacking an Internet connection (like when you're on a plane).
+email: 
+- alex@alexreisner.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/local_cdn.rb
+- lib/config.rb
+- Rakefile
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/alexreisner/local_cdn
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Load your Rails app's CDN content locally when not connected to the Internet.
+test_files: []
+