rack-jquery_ui 1.1.0 → 2.0.0

data/.travis.yml

@@ -3,7 +3,6 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ruby-head
 
 # whitelist
 branches:

data/CHANGES.md

@@ -1,8 +1,17 @@
 # CH CH CHANGES #
 
-## v1.1.0 ##
+## Thursday the 4th of July 2013, v2.0.0 ##
 
-Thursday the 23rd of May 2013  
+OK, I made a bit of mistake with the last release. Not all the CDN's support 1.10.3, but I didn't check that properly. I've rolled this release back to 1.10.1 and I'll push out a release for 1.10.3, but going forward this has prompted some changes:
+
+* There is now a :raise option (that can be used in several places, see the API docs). If a CDN isn't supported and :raise is set to false then the default will be used. If :raise is set to true then an exception is raised.
+* There is a command in the Rakefile that can be run to check each CDN to see if it responds ok.
+* Updated docs.
+
+----
+
+
+##  Thursday the 23rd of May 2013, v1.1.0 ##
 
 * Updated to jQuery-UI version 1.10.3.
 * Added note about version numbers.
@@ -13,18 +22,14 @@ Thursday the 23rd of May 2013
 ----
 
 
-## v1.0.2 ##
-
-Thursday the 23rd of May 2013  
+## Thursday the 23rd of May 2013, v1.0.2 ##
 
 * Was missing a little bit of instruction.
 
 ----
 
 
-## v1.0.1 ##
-
-Wednesday the 24th of April 2013
+## Wednesday the 24th of April 2013, v1.0.1 ##
 
 * Fixed clobbering of `call` method.
 
@@ -40,32 +45,30 @@ Friday the 22nd of March 2013
 
 ____
 
-## v0.0.5 ##
 
-Friday the 7th of March 2013
+## Friday the 7th of March 2013, v0.0.5 ##
 
 * Added some code that checks whether the constants holding the version numbers have already been defined, and warns. It give a stronger warning if the version numbers differ. It won't _always_ cause a problem that they differ, but if I CDN goes down it's likely, so caveat emptor is the phrase of the day.
 
 ---- 
 
-## v0.0.4 ##
 
-Thursday the 6th of March 2013
+## Thursday the 6th of March 2013, v0.0.4 ##
 
 * Using the rack-jquery-helpers library now, to help cut down on duplicated code.
 * Cleaned up the examples a bit.
 
-## v0.0.3 ##
+----
+
 
-Wednesday the 5th of March 2013
+## Wednesday the 5th of March 2013, v0.0.3 ##
 
 * Updated gemspec so it automatically shows the current version of jQuery-UI that it supports.
 
 ____
 
-## v0.0.2 ##
 
-Wednesday the 5th of March 2013
+## Wednesday the 5th of March 2013, v0.0.2 ##
 
 * Simplified, as moving themes to a separate library.
 

data/README.md

@@ -20,10 +20,9 @@ Have a look in the examples directory, but here's a snippet.
 * Add `use Rack::JQueryUI` to your middleware stack.
 * Put this in the head of your layout (the example is Haml but you can use whatever you like)
 
-    <pre><code>
-    %head
-      = Rack::JQueryUI.cdn
-    </code></pre>
+
+      %head
+        = Rack::JQueryUI.cdn
 
 Now you have the script tags to Google's CDN in the head (you can also use Media Temple or Microsoft, or Cloudflare, see the docs).
 
@@ -35,6 +34,29 @@ That was easy.
 
 You have to have loaded jQuery _before_ using the CDN helper, as jQuery-UI relies on it. I've already mentioned [Rack::JQuery](https://github.com/yb66/rack-jquery) which you can use to do this, or load the script however you like. Just remember that it needs to be there.
 
+### When the CDN doesn't support the jQuery UI version of the library ###
+
+I made a mistake and pushed out a version of the library where not all the CDNs supported the version of jQuery UI it was using. Embarrassing.
+
+To stop this happening again I've added more checks, but there's also a choice for the library user. If you've picked a CDN to use, something like this:
+
+    %head
+      = Rack::JQueryUI.cdn :microsoft
+
+and it doesn't support the jQuery UI version, then it will silently use the default CDN (usually Google's, but it will change depending on who supports what).
+
+If you'd prefer an exception to be raised you can either do this:
+
+    use Rack::JQueryUI, :raise => true
+
+or
+
+    %head
+      = Rack::JQueryUI.cdn :microsoft, :raise => true
+
+the second way will always override the first.
+
+
 ### Version numbers ###
 
 This library uses [semver](http://semver.org/) to version the **library**. That means the library version is ***not*** an indicator of quality but a way to manage changes. The version of jQuery UI can be found in the lib/rack/jquery_ui/version.rb file, or via the {Rack::JQueryUI::JQUERY_UI_VERSION} constant.

data/Rakefile

@@ -12,7 +12,7 @@ namespace :docs do
   require 'yard'
 
   YARD::Rake::YardocTask.new :yard do |t|
-    t.files   = ['lib/**/*.rb', 'app/*.rb', 'spec/**/*.rb']
+    t.files   = ['lib/**/*.rb', 'app/*.rb']
     t.options = ['-odocs/'] # optional
   end
 
@@ -46,3 +46,27 @@ namespace :examples do
   end
 
 end
+
+namespace :cdn do
+  require 'open3'
+  desc "An availability check, for sanity"
+  task :check do
+    require_relative './lib/rack/jquery_ui.rb'
+    Rack::JQueryUI::CDNs.constants.each do |const|
+      url = "#{Rack::JQueryUI::CDNs.const_get(const)}"
+      url = "http:#{url}" unless url.start_with? "http"
+      cmd = "curl -I #{url}"
+      puts cmd
+      puts catch(:status) {
+        Open3.popen3(cmd) do |_,stdout,_|
+          line = stdout.gets
+          throw :status, "Nothing for #{const}" if line.nil?
+          puts line.match("HTTP/1.1 404 Not Found") ?
+              "FAILED: #{const}" :
+              "PASSED: #{const}"
+        end
+      }
+    end
+  end
+
+end

data/examples/config.rb

@@ -45,7 +45,7 @@ __END__
   %head
     = Rack::JQuery.cdn( :google )
     = Rack::JQueryUI.cdn( :google )
-    %link{ href: "http://code.jquery.com/ui/1.10.1/themes/base/jquery-ui.css", rel: "stylesheet"}
+    %link{ href: "http://code.jquery.com/ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/jquery-ui.css", rel: "stylesheet"}
     :css
       body {
         font-family: "Trebuchet MS", "Helvetica", "Arial",  "Verdana", "sans-serif";
@@ -58,7 +58,7 @@ __END__
   %head
     = Rack::JQuery.cdn( :microsoft )
     = Rack::JQueryUI.cdn( :microsoft )
-    %link{ href: "http://code.jquery.com/ui/1.10.1/themes/base/jquery-ui.css", rel: "stylesheet"}
+    %link{ href: "http://code.jquery.com/ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/jquery-ui.css", rel: "stylesheet"}
     :css
       body {
         font-family: "Trebuchet MS", "Helvetica", "Arial",  "Verdana", "sans-serif";
@@ -71,7 +71,7 @@ __END__
   %head
     = Rack::JQuery.cdn( :cloudflare )
     = Rack::JQueryUI.cdn( :cloudflare )
-    %link{ href: "http://code.jquery.com/ui/1.10.1/themes/base/jquery-ui.css", rel: "stylesheet"}
+    %link{ href: "http://code.jquery.com/ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/jquery-ui.css", rel: "stylesheet"}
     :css
       body {
         font-family: "Trebuchet MS", "Helvetica", "Arial",  "Verdana", "sans-serif";
@@ -84,7 +84,7 @@ __END__
   %head
     = Rack::JQuery.cdn( :media_temple )
     = Rack::JQueryUI.cdn( :media_temple )
-    %link{ href: "http://code.jquery.com/ui/1.10.1/themes/base/jquery-ui.css", rel: "stylesheet"}
+    %link{ href: "http://code.jquery.com/ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/jquery-ui.css", rel: "stylesheet"}
     :css
       body {
         font-family: "Trebuchet MS", "Helvetica", "Arial",  "Verdana", "sans-serif";
@@ -97,7 +97,7 @@ __END__
   %head
     = Rack::JQuery.cdn()
     = Rack::JQueryUI.cdn()
-    %link{ href: "http://code.jquery.com/ui/1.10.1/themes/base/jquery-ui.css", rel: "stylesheet"}
+    %link{ href: "http://code.jquery.com/ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/jquery-ui.css", rel: "stylesheet"}
     :css
       body {
         font-family: "Trebuchet MS", "Helvetica", "Arial",  "Verdana", "sans-serif";
@@ -111,7 +111,7 @@ __END__
   %head
     = Rack::JQuery.cdn()
     = Rack::JQueryUI.cdn()
-    %link{ href: "http://code.jquery.com/ui/1.10.1/themes/base/jquery-ui.css", rel: "stylesheet"}
+    %link{ href: "http://code.jquery.com/ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/jquery-ui.css", rel: "stylesheet"}
     :css
       body {
         font-family: "Trebuchet MS", "Helvetica", "Arial",  "Verdana", "sans-serif";

data/lib/rack/jquery_ui.rb

@@ -11,19 +11,24 @@ module Rack
     # The usual file name.
     JQUERY_UI_FILE_NAME = "jquery-ui.min.js"
 
-    # Script tags for the Media Temple CDN
-    MEDIA_TEMPLE = "<script src='http://code.jquery.com/ui/#{JQUERY_UI_VERSION}/jquery-ui.js'></script>"
-
-    # Script tags for the Google CDN
-    GOOGLE = "<script src='//ajax.googleapis.com/ajax/libs/jqueryui/#{JQUERY_UI_VERSION}/jquery-ui.min.js'></script>"
-
-    # Script tags for the Microsoft CDN
-    MICROSOFT = "<script src='//ajax.aspnetcdn.com/ajax/jquery.ui/#{JQUERY_UI_VERSION}/jquery-ui.min.js'></script>"
-
-
-    # Script tags for the Cloudflare CDN
-    CLOUDFLARE = "<script src='//cdnjs.cloudflare.com/ajax/libs/jqueryui/#{JQUERY_UI_VERSION}/jquery-ui.min.js'></script>"
 
+    # Namespaced for convenience, to help with checking
+    # which CDN supports what.
+    module CDNs
+
+      # Script tags for the Media Temple CDN
+      MEDIA_TEMPLE = "http://code.jquery.com/ui/#{JQUERY_UI_VERSION}/jquery-ui.js"
+  
+      # Script tags for the Google CDN
+      GOOGLE = "//ajax.googleapis.com/ajax/libs/jqueryui/#{JQUERY_UI_VERSION}/jquery-ui.min.js"
+  
+      # Script tags for the Microsoft CDN
+      MICROSOFT = "//ajax.aspnetcdn.com/ajax/jquery.ui/#{JQUERY_UI_VERSION}/jquery-ui.min.js"
+  
+  
+      # Script tags for the Cloudflare CDN
+      CLOUDFLARE = "//cdnjs.cloudflare.com/ajax/libs/jqueryui/#{JQUERY_UI_VERSION}/jquery-ui.min.js"
+    end
 
     # This javascript checks if the jQuery-UI object has loaded. If not, that most likely means the CDN is unreachable, so it uses the local minified jQuery.
     FALLBACK = <<STR
@@ -35,27 +40,51 @@ STR
 
     # @param [Symbol] organisation Choose which CDN to use, either :google, :microsoft or :media_temple
     # @return [String] The HTML script tags to get the CDN.
-    def self.cdn( organisation=:google )
-      script = case organisation
-        when :media_temple then MEDIA_TEMPLE
-        when :microsoft then MICROSOFT
-        when :cloudflare then CLOUDFLARE
-        else GOOGLE
+    def self.cdn( organisation=:google, options={} )
+      raise = (opt = options[:raise]).nil? ?
+                raise? :
+                opt
+      script = if organisation === :media_temple         
+          CDNs::MEDIA_TEMPLE
+        elsif organisation === :microsoft
+          CDNs::MICROSOFT
+        elsif (organisation === :cloudflare) && raise
+          fail "The Cloudflare CDN does not support version jQuery UI version #{JQUERY_UI_VERSION}."
+        else
+          CDNs::GOOGLE
       end
-      "#{script}\n#{FALLBACK}"
+      "<script src='#{script}'></script>\n#{FALLBACK}"
     end
 
 
     # Default options hash for the middleware.
     DEFAULT_OPTIONS = {
-      :http_path => "/js/jquery-ui/#{JQUERY_UI_VERSION}"
+      :http_path  => "/js/jquery-ui/#{JQUERY_UI_VERSION}",
+      :raise      =>  false
     }
 
 
+    # Whether to raise an exception if the chosen CDN
+    # does not support the jQuery UI version this library is using
+    # @param [TrueClass] bool
+    def self.raise=( bool )
+      @raise = bool
+    end
+
+
+    # @see raise=
+    # @return [TrueClass]
+    def self.raise?
+      @raise = false if @raise.nil?
+      @raise
+    end
+
+
     # @param [#call] app
     # @param [Hash] options
     # @option options [String] :http_path If you wish the jQuery fallback route to be "/js/jquery-ui/1.10.1/jquery-ui.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-ui/1.10.1/jquery-ui.min.js" then pass in `:http_path => "/assets/javascripts/#{Rack::JQueryUI::JQUERY_UI_VERSION}".
     # @note ***Don't leave out the version number!***. The scripts provided by jQuery don't contain the version in the filename like the jQuery scripts do, which means that organising them and sending the right headers back is bound to go wrong unless you put the version number somewhere in the route. You have been warned!
+    # @option options [TrueClass] :raise If one of the CDNs does not support then raise an error if it is chosen. Defaults to false.
     # @example
     #   # The default:
     #   use Rack::JQueryUI
@@ -64,6 +93,7 @@ STR
     def initialize( app, options={} )
       @app, @options  = app, DEFAULT_OPTIONS.merge(options)
       @http_path_to_jquery = ::File.join @options[:http_path], JQUERY_UI_FILE_NAME
+      self.class.raise = @options[:raise]
     end
 
 

data/lib/rack/jquery_ui/version.rb

@@ -1,10 +1,10 @@
 module Rack
   class JQueryUI
     # library version
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
 
     # This is here in case another rack-jquery_ui library has already been loaded.
-    jquery_ui_version = "1.10.3"
+    jquery_ui_version = "1.10.1"
     if defined? JQUERY_UI_VERSION
       warn "JQUERY_UI_VERSION was already defined."
       unless JQUERY_UI_VERSION == jquery_ui_version
@@ -15,8 +15,8 @@ module Rack
       JQUERY_UI_VERSION = jquery_ui_version
 
       # This is the release date of the jQuery file, it makes an easy "Last-Modified" date for setting the headers around caching.
-      # @todo remember to change Last-Modified with each release!
-      JQUERY_UI_VERSION_DATE = "Fri, 03 May 2013 00:00:00 GMT"
+      # TODO remember to change Last-Modified with each release!
+      JQUERY_UI_VERSION_DATE = "Fri, 15 Feb 2013 00:00:00 GMT"
     end
   end
 end

data/spec/rack_jquery_ui_spec.rb

@@ -8,23 +8,28 @@ describe "The class methods" do
   context "Given an argument" do
     context "of nil (the default)" do
       let(:organisation) { nil }
-      it { should == "#{Rack::JQueryUI::GOOGLE}\n#{Rack::JQueryUI::FALLBACK}" }
+      it { should == "<script src='#{Rack::JQueryUI::CDNs::GOOGLE}'></script>\n#{Rack::JQueryUI::FALLBACK}" }
     end
     context "of :google" do
       let(:organisation) { :google }
-      it { should == "#{Rack::JQueryUI::GOOGLE}\n#{Rack::JQueryUI::FALLBACK}" }
+      it { should == "<script src='#{Rack::JQueryUI::CDNs::GOOGLE}'></script>\n#{Rack::JQueryUI::FALLBACK}" }
     end
     context "of :microsoft" do
       let(:organisation) { :microsoft }
-      it { should == "#{Rack::JQueryUI::MICROSOFT}\n#{Rack::JQueryUI::FALLBACK}" }
+      it { should == "<script src='#{Rack::JQueryUI::CDNs::MICROSOFT}'></script>\n#{Rack::JQueryUI::FALLBACK}" }
     end
     context "of :media_temple" do
       let(:organisation) { :media_temple }
-      it { should == "#{Rack::JQueryUI::MEDIA_TEMPLE}\n#{Rack::JQueryUI::FALLBACK}" }
+      it { should == "<script src='#{Rack::JQueryUI::CDNs::MEDIA_TEMPLE}'></script>\n#{Rack::JQueryUI::FALLBACK}" }
     end
     context "of :cloudflare" do
       let(:organisation) { :cloudflare }
-      it { should == "#{Rack::JQueryUI::CLOUDFLARE}\n#{Rack::JQueryUI::FALLBACK}" }
+      context "When raise is true" do
+        subject { Rack::JQueryUI.cdn organisation, {raise: true} }
+        it "should raise error as it's not supported for this version" do
+          expect { subject }.to raise_error
+        end
+      end
     end
   end
 end
@@ -43,17 +48,51 @@ describe "Inserting the CDN" do
     end
     it_should_behave_like "Any route"
     subject { last_response.body }
-    let(:expected) { Rack::JQueryUI::GOOGLE }
+    let(:expected) { Rack::JQueryUI::CDNs::GOOGLE }
     it { should include expected }
   end
   context "Cloudflare CDN" do
-    before do
-      get "/cloudflare-cdn"
+    context "With :raise set to false" do
+      before do
+        get "/cloudflare-cdn"
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      let(:expected) { Rack::JQueryUI::CDNs::GOOGLE }
+      it { should include expected }
+    end
+    context "With :raise set to true" do
+      context "via `use`" do
+        let(:app) {
+          Sinatra.new do
+            use Rack::JQuery
+            use Rack::JQueryUI, :raise => true
+            get "/cloudflare-cdn" do
+              Rack::JQueryUI.cdn( :cloudflare )
+            end
+          end
+        }
+        subject { get "/cloudflare-cdn" }
+        it "should raise error as it's not supported for this version" do
+          expect { subject }.to raise_error
+        end
+      end
+      context "via the method options" do
+        let(:app) {
+          Sinatra.new do
+            use Rack::JQuery
+            use Rack::JQueryUI, :raise => false
+            get "/cloudflare-cdn" do
+              Rack::JQueryUI.cdn( :cloudflare, :raise => true )
+            end
+          end
+        }
+        subject { get "/cloudflare-cdn" }
+        it "should raise error as it's not supported for this version" do
+          expect { subject }.to raise_error
+        end
+      end
     end
-    it_should_behave_like "Any route"
-    subject { last_response.body }
-    let(:expected) { Rack::JQueryUI::CLOUDFLARE }
-    it { should include expected }
   end
   context "Media_temple CDN" do
     before do
@@ -61,7 +100,7 @@ describe "Inserting the CDN" do
     end
     it_should_behave_like "Any route"
     subject { last_response.body }
-    let(:expected) { Rack::JQueryUI::MEDIA_TEMPLE }
+    let(:expected) { Rack::JQueryUI::CDNs::MEDIA_TEMPLE }
     it { should include expected }
   end
   context "Unspecified CDN" do
@@ -70,7 +109,7 @@ describe "Inserting the CDN" do
     end
     it_should_behave_like "Any route"
     subject { last_response.body }
-    let(:expected) { Rack::JQueryUI::GOOGLE }
+    let(:expected) { Rack::JQueryUI::CDNs::GOOGLE }
     it { should include expected }
   end
 end