rack-jquery_ui-themes 2.1.1 → 3.0.0

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CH CH CH CHANGES #
 
+## Tuesday the 6th of August 2013, v3.0.0 ##
+
+* Removed class methods for theme and themes, they just don't work with the Rack architecture, at least not the way I'm using them.
+* Found a way to check if the external CDN has loaded, by adding a meta tag and then one of the jQuery UI classes to it, and seeing if it changes.
+* Added some extra keys the internal paths hash to help ascertain which theme is being called.
+* Added a fallback option to the cdn method, mainly to help with testing but also because it might be wanted.
+
+----
+
+
 ## Friday the 19th of July 2013, v2.1.1 ##
 
 * Removed rogue console logging statement in the fallback javascript.

data/Gemfile

@@ -14,7 +14,8 @@ group :examples do
   gem "sinatra"
   gem "haml"
   gem "rack-jquery"
-  gem "rack-jquery_ui", "2.0.0" # for jQuery UI 1.10.1
+  gem "rack-jquery_ui", "2.2.0" # for jQuery UI 1.10.3
+  gem "thin"
 end
 
 group :development do

data/README.md

@@ -36,9 +36,9 @@ Have a look in the examples directory, but here's a snippet.
       = Rack::JQueryUI::Themes.cdn env, :organisation => :microsoft
     </code></pre>
 
-Now you have the script tags to Google's CDN in the head (you can also use Media Temple or Microsoft, see the docs).
+Now you have the script tags to Microsoft's CDN in the head (you can also use Media Temple or Microsoft, see the docs).
 
-It also adds in a bit of javascript that will load in a locally kept version of jQuery, just incase the CDN is unreachable. The script will use the "/js/jquery-ui/1.10.1/themes/:THEME/jquery-ui.min.css" path (or, instead of 1.10.1, whatever is in {Rack::JQueryUI::JQUERY_UI_VERSION}), where `:THEME` is the name of the theme you specified, the default being `base`.
+It also adds in a bit of javascript that will load in a locally kept version of jQuery, just incase the CDN is unreachable. The script will use the "/js/jquery-ui/1.10.3/themes/:THEME/jquery-ui.min.css" path (or, instead of 1.10.3, whatever is in {Rack::JQueryUI::JQUERY_UI_VERSION}), where `:THEME` is the name of the theme you specified, the default being `smoothness`.
 
 That was easy.
 

data/Rakefile

@@ -38,6 +38,15 @@ namespace :spec do
 
 end
 
+namespace :examples do
+
+  desc "Run the examples."
+  task :run do
+    exec "bundle exec rackup examples/config.ru"
+  end
+
+end
+
 namespace :cdn do
   require 'open3'
   desc "An availability check, for sanity"

data/examples/config.rb

@@ -9,7 +9,7 @@ class App < Sinatra::Base
   enable :inline_templates
   use Rack::JQuery
   use Rack::JQueryUI
-  use Rack::JQueryUI::Themes, :theme => "vader"
+  use Rack::JQueryUI::Themes, :theme => "vader", :themes => Rack::JQueryUI::Themes::STANDARD_THEMES
 
   get "/" do
     haml :index, :layout => :unspecified
@@ -30,10 +30,28 @@ class App < Sinatra::Base
   get "/themes/?" do
     haml :themes_list, :layout => :unspecified
   end
-end
 
-class ThemeApp < Sinatra::Base
-  get "/" do
+  get "/fallback/?" do
+    haml :themes_list, :layout => :unspecified
+  end
+
+  
+  get "/themes/" do
+    haml :theme, :layout => :layout_theme
+  end
+  
+  get "/themes/:theme" do |theme|
+    @theme = theme
     haml :theme, :layout => :layout_theme
   end
+
+  
+  get "/fallback/" do
+    haml :theme, :layout => :layout_fallback
+  end
+
+  get "/fallback/:theme" do |theme|
+    @theme = theme
+    haml :theme, :layout => :layout_fallback
+  end
 end

data/examples/config.ru

@@ -8,12 +8,4 @@ require File.expand_path( '../config.rb', __FILE__)
 
 map "/" do
   run App
-end
-
-# this is me cheating a bit
-Rack::JQueryUI::Themes::STANDARD_THEMES.each do |theme|
-  map "/themes/#{theme}" do
-    use Rack::JQueryUI::Themes, :theme => theme
-    run ThemeApp
-  end
 end

data/examples/views/layout_fallback.haml

@@ -0,0 +1,15 @@
+!!!
+%html{:lang => "us"}
+  %head
+    %meta{:charset => "utf-8"}
+      %title jQuery UI Example Page
+    // load jQuery
+    = Rack::JQuery.cdn()
+    // load UI
+    = Rack::JQueryUI.cdn()
+    // load themes
+    = Rack::JQueryUI::Themes.cdn(env, :theme => @theme, :fallback => :only)
+    // load js for widgets
+    = haml :js_and_css_header
+  %body
+    = yield

data/examples/views/layout_theme.haml

@@ -8,7 +8,7 @@
     // load UI
     = Rack::JQueryUI.cdn()
     // load themes
-    = Rack::JQueryUI::Themes.cdn(env)
+    = Rack::JQueryUI::Themes.cdn(env, :theme => @theme)
     // load js for widgets
     = haml :js_and_css_header
   %body

data/lib/rack/jquery_ui/themes.rb

@@ -33,67 +33,28 @@ module Rack
 
       # This javascript checks if the jQuery-UI object has loaded by issuing a head request to the CDN. If it doesn't get a successful status, that most likely means the CDN is unreachable, so it uses the local jQuery-UI theme.
       FALLBACK = <<STR
+<meta id='rack-jquery-ui-themes-fallback-beacon' />
+
 <script type="text/javascript">
-  $.ajax({
-    type: "HEAD",
-    url: ':CDNURL',
-    success: function(css,status) {
-      // do nothing
-    },
-    error: function(xhr,status,error) {
-      var link = document.createElement("link");
-      link.rel = "stylesheet";     
-      link.href = ':FALLBACK_URL';
-      document.getElementsByTagName("head")[0].appendChild(link); 
-    }
-  });
+  var meta = $("#rack-jquery-ui-themes-fallback-beacon");
+  meta.addClass("ui-icon");
+  if ( meta.css('width') != "16px" ) {
+    $('<link rel="stylesheet" type="text/css" href="/js/jquery-ui/#{JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/#{JQUERY_UI_THEME_FILE}" />').appendTo('head');
+  }
+  meta.remove();
 </script>
 STR
 
   
       # List of the standard themes provided by jQuery UI.
       STANDARD_THEMES = %w{black-tie blitzer cupertino dark-hive dot-luv eggplant excite-bike flick hot-sneaks humanity le-frog mint-choc overcast pepper-grinder redmond smoothness south-street start sunny swanky-purse trontastic ui-darkness ui-lightness vader}
-  
-
-      # The chosen theme name.
-      # @return [String]
-      # @see http://blog.jqueryui.com/2013/03/jquery-ui-1-10-2/ for why the default theme was changed to 'smoothness'.
-      def self.theme
-        @theme ||= "smoothness"
-      end
-  
-
-      # Set the theme.
-      # @param [String] name Name of the theme.
-      # @return [String]
-      def self.theme=( name )
-        name = name.to_s
-        fail ArgumentError, "That theme (#{name}) is unknown for this version of the rack-jquery_ui-themes library." unless STANDARD_THEMES.include? name
-        @theme = name
-      end
-
-
-      # Set the themes to use.
-      # @param [Array<String>] themes
-      # @return [Array<String>]
-      # @example
-      #   self.class.themes = ["smoothness", "swanky-purse"]
-      def self.themes=( themes )
-        themes = themes.pop if themes.first.respond_to? :each
-        @themes = themes.map! &:to_s
-      end
-
-      # Get the selected themes
-      # @return [Array<String>]
-      def self.themes
-        @themes ||= Array(self.theme)
-      end
 
 
       # @param [Hash] env The rack env hash.
       # @param [Hash] opts
-      # @option opts [#to_sym] organisation Choose which CDN to use, either :media_temple, :microsoft, or :media_temple.
+      # @option opts [#to_sym] :organisation Choose which CDN to use, either :media_temple, :microsoft, or :media_temple.
       # @option opts [#to_s] :theme Theme to use. Won't set any routes or permanent settings, see note.
+      # @option opts [TrueClass, Symbol] :fallback `true` if you want a fallback script, `false` if you don't, and `:only` if you don't want the CDN link but you do want just the fallback script. `true` is the default.
       # @return [String] The HTML script tags to get the CDN, with a JQuery function that will be called if the CDN fails and sets the fallback path.
       # @example
       #   # The easiest, use the defaults:
@@ -113,8 +74,9 @@ STR
       #   theme is favoured *from the already given set*.
       def self.cdn( env, opts={} )
         organisation = opts[:organisation] || :media_temple
-        themes = env.fetch "rack.jquery_ui-themes", themes()
+        themes = env["rack.jquery_ui-themes"]
         theme, themes = sort_out_options opts.merge :themes => themes
+        fallback = opts[:fallback] || true
 
         # Get the CDN URL for the given organisation.
         url = case organisation.to_sym
@@ -131,11 +93,18 @@ STR
         fallback_script = FALLBACK.gsub(/\:CDNURL/, url)
                                   .sub /\:FALLBACK_URL/, fallback_url
 
-        script    = "<link rel='stylesheet' href='#{url}' type='text/css' />"
-        [script,fallback_script].map{|x|
-          x.gsub(/\:THEME/, theme)
-        }.join("\n")
-        #fallback_script.gsub(/\:THEME/, theme)
+        if fallback == :only
+          fallback_script.gsub(/\:THEME/, theme)
+        else
+          script = "<link rel='stylesheet' href='#{url}' type='text/css' />"
+          if fallback == false
+            script.gsub(/\:THEME/, theme)
+          else
+            [script,fallback_script].map{|x|
+              x.gsub(/\:THEME/, theme)
+            }.join("\n")
+          end
+        end
       end
   
   
@@ -163,7 +132,7 @@ STR
             (t + themes).uniq :
             t
         else
-          themes = self.themes if themes.nil? || themes.empty?
+          themes = ["smoothness"] if themes.nil? || themes.empty?
           theme = themes.first
         end
         
@@ -212,7 +181,10 @@ STR
           # with the file path to the CSS file as the value
           paths.store(
             ::File.join( theme_url, JQUERY_UI_THEME_FILE ),
-            ::File.join( theme_dir, JQUERY_UI_THEME_FILE)
+            {
+              :file => ::File.join( theme_dir, JQUERY_UI_THEME_FILE),
+              :theme => theme
+            }
           )
 
           images_dir = ::File.join theme_dir, "images"
@@ -227,7 +199,10 @@ STR
               }.each do |img|
                 paths.store(
                   ::File.join( theme_url, "images", img ), # url
-                  ::File.join( images_dir, img )           # file
+                  {
+                    :file   =>  ::File.join( images_dir, img ),
+                    :theme  =>  theme
+                  }
                 )
               end
         end
@@ -253,12 +228,12 @@ STR
           response = Rack::Response.new
           if request.path_info.end_with? JQUERY_UI_THEME_FILE # CSS.
             # For caching:
-            response.headers.merge! caching_headers("#{JQUERY_UI_THEME_FILE}-#{self.class.theme}-#{JQueryUI::JQUERY_UI_VERSION}", JQueryUI::JQUERY_UI_VERSION_DATE)
+            response.headers.merge! caching_headers("#{JQUERY_UI_THEME_FILE}-#{@paths[request.path_info][:theme]}-#{JQueryUI::JQUERY_UI_VERSION}", JQueryUI::JQUERY_UI_VERSION_DATE)
             # There's no need to test if the IF_MODIFIED_SINCE against the release date because the header will only be passed if the file was previously accessed by the requester, and the file is never updated. If it is updated then it is accessed by a different path.
-            requested_file = open @paths[request.path_info], "r"
+            requested_file = open @paths[request.path_info][:file], "r"
           elsif request.path_info =~ /images/
             # serve images
-            requested_file = open @paths[request.path_info], "rb"
+            requested_file = open @paths[request.path_info][:file], "rb"
           else # bad route
             response.status = 404
             return response.finish # finish early, 404

data/lib/rack/jquery_ui/themes/version.rb

@@ -19,7 +19,7 @@ module Rack
 
     class Themes
       # version of this library
-      VERSION = "2.1.1"
+      VERSION = "3.0.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-jquery_ui-themes
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,7 @@ files:
 - examples/views/google.haml
 - examples/views/index.haml
 - examples/views/js_and_css_header.haml
+- examples/views/layout_fallback.haml
 - examples/views/layout_theme.haml
 - examples/views/mediatemple.haml
 - examples/views/microsoft.haml