rack-jquery 1.5.1 → 2.0.0

data/CHANGES.md

@@ -1,5 +1,12 @@
 # CH CH CH CHANGES #
 
+## Saturday the 7th of September 2013, v2.0.0 ##
+
+* Added ability to pass `use` a default organisation.
+* Added a failure message for those who don't notice the API changes.
+
+----
+
 ## Friday the 6th of September 2013, v1.5.1 ##
 
 * Added the source map and fallback routes for it.

data/README.md

@@ -18,11 +18,11 @@ Have a look in the examples directory, but here's a snippet.
 * Install it (see below)
 * `require 'rack/jquery'`.
 * If you want fallback then add this to your middleware stack: `use Rack::JQuery`
-* Put this in the head of your layout (the example is Haml but you can use whatever you like)
+* Put this in the head of your layout (the example is Haml but you can use whatever you like) and pass it the Rack env:
 
     <pre><code>
     %head
-      = Rack::JQuery.cdn
+      = Rack::JQuery.cdn( env )
     </code></pre>
 
 Now you have the script tags to Media Temple's CDN in the head (you can also use Google or Microsoft, or Cloudflare, see the docs).

data/examples/config.rb

@@ -47,36 +47,82 @@ STR
   end
 end
 
+
+class AppWithDefaults < Sinatra::Base
+
+  enable :inline_templates
+  use Rack::JQuery, :organisation => :cloudflare
+
+  get "/" do
+    output = <<STR
+!!!
+%body
+  %ul
+    %li
+      %a{ href: "/google-cdn"} google-cdn
+    %li
+      %a{ href: "/media-temple-cdn"} media-temple-cdn
+    %li
+      %a{ href: "/microsoft-cdn"} microsoft-cdn
+    %li
+      %a{ href: "/cloudflare-cdn"} cloudflare-cdn
+    %li
+      %a{ href: "/unspecified-cdn"} unspecified-cdn
+STR
+    haml output
+  end
+
+  get "/google-cdn" do
+    haml :index, :layout => :google
+  end
+
+  get "/media-temple-cdn" do
+    haml :index, :layout => :mediatemple
+  end
+
+  get "/microsoft-cdn" do
+    haml :index, :layout => :microsoft
+  end
+
+  get "/cloudflare-cdn" do
+    haml :index, :layout => :cloudflare
+  end
+
+  get "/unspecified-cdn" do
+    haml :index, :layout => :unspecified
+  end
+end
+
 __END__
 
 @@google
 %html
   %head
-    = Rack::JQuery.cdn( :google )
+    = Rack::JQuery.cdn(env, :organisation => :google )
   = yield
 
 @@microsoft
 %html
   %head
-    = Rack::JQuery.cdn( :microsoft )
+    = Rack::JQuery.cdn( env, :organisation => :microsoft )
   = yield
 
 @@mediatemple
 %html
   %head
-    = Rack::JQuery.cdn( :media_temple )
+    = Rack::JQuery.cdn( env, :organisation => :media_temple )
   = yield
 
 @@cloudflare
 %html
   %head
-    = Rack::JQuery.cdn( :cloudflare )
+    = Rack::JQuery.cdn( env, :organisation => :cloudflare )
   = yield
 
 @@unspecified
 %html
   %head
-    = Rack::JQuery.cdn()
+    = Rack::JQuery.cdn(env)
   = yield
 
 @@index

data/examples/config.ru

@@ -3,4 +3,9 @@ require "bundler"
 Bundler.setup(:examples)
 require File.expand_path( '../config.rb', __FILE__)
 
-run App
+
+map "/defaults" do
+  run AppWithDefaults
+end
+
+run App

data/lib/rack/jquery.rb

@@ -1,13 +1,17 @@
 require "rack/jquery/version"
 require "rack/jquery/helpers"
 
+# @see http://rack.github.io/
 module Rack
 
   # jQuery CDN script tags and fallback in one neat package.
   class JQuery
     include Helpers
 
+    # Current file name of fallback.
     JQUERY_FILE_NAME = "jquery-#{JQUERY_VERSION}.min.js"
+
+    # Fallback source map file name.
     JQUERY_SOURCE_MAP = "jquery-#{JQUERY_VERSION}.min.map"
 
 
@@ -37,9 +41,18 @@ module Rack
 </script>
 STR
 
-    # @param [Symbol] organisation Choose which CDN to use, either :google, :microsoft or :media_temple, or :cloudflare
+    # @param [Hash] env The rack env hash.
+    # @param [Symbol] organisation Choose which CDN to use, either :google, :microsoft or :media_temple, or :cloudflare. This will override anything set via the `use` statement.
     # @return [String] The HTML script tags to get the CDN.
-    def self.cdn( organisation=:media_temple  )
+    def self.cdn( env, options={}  )
+      if env.nil? || env.has_key?(:organisation)
+        fail ArgumentError, "The Rack::JQuery.cdn method needs the Rack environment passed to it, or at the very least, an empty hash."
+      end
+
+      organisation =  options[:organisation] ||
+                        env["rack.jquery.organisation"] ||
+                        :media_temple
+
       script = case organisation
         when :media_temple
           CDN::MEDIA_TEMPLE
@@ -65,15 +78,21 @@ STR
     # @param [#call] app
     # @param [Hash] options
     # @option options [String] :http_path If you wish the jQuery fallback route to be "/js/jquery-1.9.1.min.js" (or whichever version this is at) then do nothing, that's the default. If you want the path to be "/assets/javascripts/jquery-1.9.1.min.js" then pass in `:http_path => "/assets/javascripts".
+    # @option options [Symbol] :organisation see {Rack::JQuery.cdn}
     # @example
     #   # The default:
     #   use Rack::JQuery
+    #
     #   # With a different route to the fallback:
     #   use Rack::JQuery, :http_path => "/assets/js"
+    #
+    #   # With a default organisation:
+    #   use Rack::JQuery, :organisation => :cloudflare
     def initialize( app, options={} )
       @app, @options  = app, DEFAULT_OPTIONS.merge(options)
       @http_path_to_jquery = ::File.join @options[:http_path], JQUERY_FILE_NAME
       @http_path_to_source_map = ::File.join @options[:http_path], JQUERY_SOURCE_MAP
+      @organisation = options.fetch :organisation, :media_temple
     end
 
 
@@ -87,6 +106,7 @@ STR
     # @param (see #call)
     def _call( env )
       request = Rack::Request.new(env.dup)
+      env.merge! "rack.jquery.organisation" => @organisation
       if request.path_info == @http_path_to_jquery
         response = Rack::Response.new
         # for caching

data/lib/rack/jquery/version.rb

@@ -2,7 +2,7 @@ module Rack
   class JQuery
     
     # the version of this library
-    VERSION = "1.5.1"
+    VERSION = "2.0.0"
 
     # the version of jQuery it supports.
     JQUERY_VERSION = "2.0.3" 

data/spec/rack_jquery_spec.rb

@@ -4,8 +4,10 @@ require 'spec_helper'
 require_relative "../lib/rack/jquery.rb"
 
 describe "The class methods" do
-  subject { Rack::JQuery.cdn organisation }
-  context "Given an argument" do
+  let(:env) { {} }
+  subject { Rack::JQuery.cdn env, :organisation => organisation }
+
+  context "Given the organisation option" do
     context "of nil (the default)" do
       let(:organisation) { nil }
       it { should == "<script src='#{Rack::JQuery::CDN::MEDIA_TEMPLE}'></script>\n#{Rack::JQuery::FALLBACK}" }
@@ -27,60 +29,134 @@ describe "The class methods" do
       it { should == "<script src='#{Rack::JQuery::CDN::CLOUDFLARE}'></script>\n#{Rack::JQuery::FALLBACK}" }
     end
   end
+
+  context "Given no Rack env argument" do
+    it "should fail and give a message" do
+      expect{ Rack::JQuery.cdn nil }.to raise_error(ArgumentError)
+    end
+    
+    context "and an organisation option" do
+      it "should fail and give a message" do
+        expect{ Rack::JQuery.cdn nil, {:organisation => :microsoft} }.to raise_error(ArgumentError)
+      end
+    end
+  end
 end
 
 describe "Inserting the CDN" do
-  include_context "All routes"
-  context "Check the examples run at all" do
-    before do
-      get "/"
+
+  # These check the default is overriden
+  # when `cdn` is given a value
+  # but when not, the default is used.
+  context "When given a default" do
+    include_context "All routes" do
+      let(:app){ AppWithDefaults }
     end
-    it_should_behave_like "Any route"
-  end
-  context "Google CDN" do
-    before do
-      get "/google-cdn"
+    context "Check the examples run at all" do
+      before do
+        get "/"
+      end
+      it_should_behave_like "Any route"
     end
-    it_should_behave_like "Any route"
-    subject { last_response.body }
-    let(:expected) { Rack::JQuery::CDN::GOOGLE }
-    it { should include expected }
-  end
-  context "Microsoft CDN" do
-    before do
-      get "/microsoft-cdn"
+    context "Google CDN" do
+      before do
+        get "/google-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::GOOGLE }
+      it { should include expected }
     end
-    it_should_behave_like "Any route"
-    subject { last_response.body }
-    let(:expected) { Rack::JQuery::CDN::MICROSOFT }
-    it { should include expected }
-  end
-  context "Media_temple CDN" do
-    before do
-      get "/media-temple-cdn"
+    context "Microsoft CDN" do
+      before do
+        get "/microsoft-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::MICROSOFT }
+      it { should include expected }
     end
-    it_should_behave_like "Any route"
-    subject { last_response.body }
-    let(:expected) { Rack::JQuery::CDN::MEDIA_TEMPLE }
-    it { should include expected }
-  end
-  context "Unspecified CDN" do
-    before do
-      get "/unspecified-cdn"
+    context "Media_temple CDN" do
+      before do
+        get "/media-temple-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::MEDIA_TEMPLE }
+      it { should include expected }
+    end
+    context "Unspecified CDN" do
+      before do
+        get "/unspecified-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::CLOUDFLARE }
+      it { should include expected }
+    end
+    context "Cloudflare CDN" do
+      before do
+        get "/cloudflare-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::CLOUDFLARE }
+      it { should include expected }
     end
-    it_should_behave_like "Any route"
-    subject { last_response.body }
-    let(:expected) { Rack::JQuery::CDN::MEDIA_TEMPLE }
-    it { should include expected }
   end
-  context "Cloudflare CDN" do
-    before do
-      get "/cloudflare-cdn"
+  context "When not given a default" do
+    include_context "All routes"
+    context "Check the examples run at all" do
+      before do
+        get "/"
+      end
+      it_should_behave_like "Any route"
+    end
+    context "Google CDN" do
+      before do
+        get "/google-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::GOOGLE }
+      it { should include expected }
+    end
+    context "Microsoft CDN" do
+      before do
+        get "/microsoft-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::MICROSOFT }
+      it { should include expected }
+    end
+    context "Media_temple CDN" do
+      before do
+        get "/media-temple-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::MEDIA_TEMPLE }
+      it { should include expected }
+    end
+    context "Unspecified CDN" do
+      before do
+        get "/unspecified-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::MEDIA_TEMPLE }
+      it { should include expected }
+    end
+    context "Cloudflare CDN" do
+      before do
+        get "/cloudflare-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQuery::CDN::CLOUDFLARE }
+      it { should include expected }
     end
-    it_should_behave_like "Any route"
-    subject { last_response.body }
-    let(:expected) { Rack::JQuery::CDN::CLOUDFLARE }
-    it { should include expected }
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-jquery
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2013-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler