rack-jquery_ui-themes 0.0.2

data/examples/views/themes_list.haml

@@ -0,0 +1,3 @@
+- Rack::JQueryUI::Themes::STANDARD_THEMES.each do |theme|
+  %p
+    %a{ href: "/themes/#{theme}" }= theme

data/examples/views/unspecified.haml

@@ -0,0 +1,6 @@
+%html
+  %head
+    = Rack::JQuery.cdn()
+    = Rack::JQueryUI.cdn()
+    = Rack::JQueryUI::Themes.cdn()
+  = yield

data/lib/rack/jquery_ui/themes.rb

@@ -0,0 +1,152 @@
+require "rack/jquery_ui/themes/version"
+require "rack/jquery/helpers"
+
+module Rack
+
+  class JQueryUI
+  
+    # jQuery-UI themes' CDN script tags and fallback in one neat package.
+    class Themes
+      include JQuery::Helpers
+  
+      JQUERY_UI_THEME_FILE = "jquery-ui.min.css"
+  
+      # Script tags for the Media Temple CDN
+      MEDIA_TEMPLE = "<link rel='stylesheet' href='http://code.jquery.com/ui/#{JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/jquery-ui.css' type='text/css' />"
+  
+      # Script tags for the Google CDN
+      GOOGLE = "<link rel='stylesheet' href='//ajax.googleapis.com/ajax/libs/jqueryui/#{JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/jquery-ui.css' type='text/css' />"
+  
+      # Script tags for the Microsoft CDN
+      MICROSOFT = "<link rel='stylesheet' href='//ajax.microsoft.com/ajax/jquery.ui/#{JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/jquery-ui.css' type='text/css' />"
+  
+      # 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 jQuery-UI theme.
+      FALLBACK = <<STR
+<script type="text/javascript">
+$.each(document.styleSheets, function(i,sheet){
+  if(sheet.href=='http://code.jquery.com/mobile/1.0b3/jquery.mobile-1.0b3.min.css') {
+    var rules = sheet.rules ? sheet.rules : sheet.cssRules;
+    if (rules.length == 0) {
+      $('<link rel="stylesheet" type="text/css" href="/js/jquery-ui/#{JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/#{JQUERY_UI_THEME_FILE}" />').appendTo('head');
+    }
+ }
+})
+</script>
+STR
+  
+  
+      STANDARD_THEMES = %w{base 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}
+  
+  
+      def self.theme
+        @theme ||= "base"
+      end
+  
+  
+      def self.theme=( name )
+        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
+  
+  
+      # @param [Symbol] :organisation Choose which CDN to use, either :google, :microsoft or :media_temple
+      # @param [Hash] opts
+      # @option opts [#to_s] :theme
+      # @return [String] The HTML script tags to get the CDN.
+      # @example
+      #   Rack::JQueryUI::Themes.cdn :google, theme: "dot-luv"
+      def self.cdn( organisation=:google, opts={} )
+        theme = opts.fetch :theme, self.theme
+        fail ArgumentError, "That theme (#{theme}) is unknown for this version of the rack-jquery_ui-themes library." unless STANDARD_THEMES.include? theme
+        script = case organisation
+          when :media_temple then MEDIA_TEMPLE
+          when :microsoft then MICROSOFT
+          else GOOGLE
+        end
+        [script,FALLBACK].map{|x| x.sub(/\:THEME/, theme) }.join("\n")
+      end
+  
+  
+      # Default options hash for the middleware.
+      DEFAULT_APP_OPTIONS = {
+        :http_path => "/js/jquery-ui/#{JQueryUI::JQUERY_UI_VERSION}/themes/"
+      }
+  
+  
+      # @param [#call] app
+      # @param [Hash] options
+      # @option options [String] theme The theme to use. The default is "base".
+      # @option options [String] :http_path If you wish the jQuery CSS fallback route to be "/js/jquery-ui/1.10.1/base/jquery-ui.min.css" (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/base…" 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!
+      # @example
+      #   # The default:
+      #   use Rack::JQueryUI::Themes
+      def initialize( app, options={} )
+        @app, @options  = app, DEFAULT_APP_OPTIONS.merge(options)
+        self.class.theme = options[:theme] unless options[:theme].nil?
+        @http_path_to_jquery_css = ::File.join(
+          @options[:http_path],        
+          self.class.theme,
+          JQUERY_UI_THEME_FILE
+        )
+        @http_path_to_jquery_images = ::File.join(
+          @options[:http_path],        
+          self.class.theme,
+          "images"
+        )
+  
+        # set the path to all the assets
+        rel_path_to_vendor = "../../../../"
+        path_to_themes = "vendor/assets/javascripts/jquery-ui"
+        version_and_theme = "#{JQueryUI::JQUERY_UI_VERSION}/themes/#{self.class.theme}"
+        @path_to_theme = ::File.expand_path( ::File.join( rel_path_to_vendor, path_to_themes, version_and_theme ), __FILE__)
+        @path_to_images = ::File.join @path_to_theme, "images"
+        d = Dir.new(@path_to_images)
+        @images = d.entries.delete_if{|f| f =~ /^\./ }.select{|f| 
+          Rack::Mime.mime_type(::File.extname(f), "text/css" ).start_with? "image" 
+        }
+      end
+  
+  
+      # @param [Hash] env Rack request environment hash.
+      def call( env )
+        request = Rack::Request.new(env.dup)
+  
+        # TODO path for images
+  
+        # path for CSS
+        if request.path_info.start_with? @options[:http_path]
+          response = Rack::Response.new
+          if request.path_info.end_with? ::File.join(self.class.theme,JQUERY_UI_THEME_FILE)
+            # serve CSS
+            # for caching
+            response.headers.merge! caching_headers("#{JQUERY_UI_THEME_FILE}-#{self.class.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(::File.join(@path_to_theme, JQUERY_UI_THEME_FILE ), "r")
+          elsif request.path_info =~ /images/ && 
+                (fin = request.path_info.split("/").last)
+                (img = @images.find{|img| img == fin })
+            # serve images
+            requested_file = open ::File.join( @path_to_images, img), "rb"
+          else # bad route
+            response.status = 404
+            return response.finish # finish early, 404
+          end
+          if request.env['HTTP_IF_MODIFIED_SINCE']
+            response.status = 304
+          else
+            response.status = 200
+            mime = Mime.mime_type(::File.extname(requested_file.path), 'text/css')
+            response.headers.merge!( "Content-Type" => mime ) if mime
+            response.write ::File.read( requested_file )
+          end
+          response.finish
+        else
+          @app.call(env)
+        end
+      end # call
+  
+  
+    end # Themes
+  end
+end

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

@@ -0,0 +1,23 @@
+module Rack
+  class JQueryUI
+
+    # This is here in case another rack-jquery_ui library has already been loaded.
+    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
+        warn "The JQUERY_UI_VERSION defined is #{JQUERY_UI_VERSION} but the version this library wants to use is #{jquery_ui_version}. You have been warned!"
+      end
+    else
+      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, 15 Feb 2013 00:00:00 GMT"
+    end
+
+    class Themes
+      VERSION = "0.0.2"
+    end
+  end
+end

data/rack-jquery_ui-themes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/jquery_ui/themes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-jquery_ui-themes"
+  spec.version       = Rack::JQueryUI::Themes::VERSION
+  spec.authors       = ["Iain Barnett"]
+  spec.email         = ["iainspeed@gmail.com"]
+  spec.description   = %q{jQuery-UI themes CDN script tags and fallback in one neat package. Current version is for jQuery-UI v#{Rack::JQueryUI::Themes::JQUERY_UI_VERSION}}
+  spec.summary       = %q{The description says it all.}
+  spec.homepage      = "https://github.com/yb66/rack-jquery_ui-themes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.2"
+  spec.add_development_dependency "rake"
+  spec.add_dependency("rack")
+  spec.add_dependency("rack-jquery-helpers")
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require 'rspec'
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+  add_filter "/spec/"
+end
+
+require "rack/test"
+ENV['RACK_ENV'] ||= 'test'
+ENV["EXPECT_WITH"] ||= "racktest"
+
+
+Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/support/shared/all_pages.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+config_path = File.expand_path '../../../examples/config.rb', File.dirname(__FILE__)
+require_relative config_path
+
+shared_context "All routes" do
+  include Rack::Test::Methods
+  let(:app){ App }
+end
+
+shared_examples_for "Any route" do
+  subject { last_response }
+  it { should be_ok }
+end

data/spec/themes_spec.rb

@@ -0,0 +1,159 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require_relative "../lib/rack/jquery_ui/themes.rb"
+
+def subber( s, replacement={} )
+  replacement[:theme] ||= "base"
+  s.sub(/:THEME/,replacement[:theme])
+end
+
+shared_examples "Given an organisation and a theme" do
+  it { should == "#{subber cdn, theme}\n#{subber Rack::JQueryUI::Themes::FALLBACK, theme}" }
+end
+
+shared_context "Calling the CDN" do
+  subject { Rack::JQueryUI::Themes.cdn organisation, theme }
+end
+
+
+describe "The class methods" do
+  let(:opts) { theme.delete_if{|k,v| v.nil?} }  
+  let(:theme) { {:theme => nil} }
+  subject { Rack::JQueryUI::Themes.cdn organisation, opts }
+  context "Given an organisation" do
+    context "of nil (the default)" do
+      let(:organisation) { nil }
+      let(:theme) { {:theme => nil} }
+      let(:cdn) { Rack::JQueryUI::Themes::GOOGLE }
+      include_examples "Given an organisation and a theme"
+      context "Given a theme" do
+        let(:theme) { { :theme => Rack::JQueryUI::Themes::STANDARD_THEMES.sample } }
+        include_context "Calling the CDN"
+        include_examples "Given an organisation and a theme"
+      end
+    end
+    context "of :google" do
+      let(:organisation) { :google }
+      let(:cdn) { Rack::JQueryUI::Themes::GOOGLE }
+      include_examples "Given an organisation and a theme"
+    end
+    context "of :microsoft" do
+      let(:organisation) { :microsoft }
+      let(:cdn) { Rack::JQueryUI::Themes::MICROSOFT }
+      include_examples "Given an organisation and a theme"
+    end
+    context "of :media_temple" do
+      let(:organisation) { :media_temple }
+      let(:cdn) { Rack::JQueryUI::Themes::MEDIA_TEMPLE }
+      include_examples "Given an organisation and a theme"
+    end
+  end
+end
+
+describe "Inserting the CDN" do
+  let(:theme) { {:theme => "vader"} }
+  let(:expected) { subber cdn, theme  }
+  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(:cdn) { Rack::JQueryUI::Themes::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(:cdn) { Rack::JQueryUI::Themes::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(:cdn) { Rack::JQueryUI::Themes::MEDIA_TEMPLE }
+    it { should include expected }
+  end
+  context "Unspecified CDN" do
+    before do
+      get "/"
+    end
+    it_should_behave_like "Any route"
+    subject { last_response.body }
+    let(:cdn) { Rack::JQueryUI::Themes::GOOGLE }
+    it { should include expected }
+  end
+end
+
+
+require 'timecop'
+require 'time'
+
+describe "Serving the fallback jquery" do
+  include_context "All routes"
+  let(:theme) { {:theme => "vader"} }
+  context "Single request" do
+    context "for route that doesn't exist" do
+      let(:url) { "/js/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/blah/#{Rack::JQueryUI::Themes::JQUERY_UI_THEME_FILE}"}
+      before do
+        get url
+      end
+      subject { last_response.status }
+      it { should == 404 }
+    end
+    context "for CSS" do
+      let(:url) { subber "/js/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/#{Rack::JQueryUI::Themes::JQUERY_UI_THEME_FILE}", theme }
+      before do
+        get url
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      it { should start_with "/*! jQuery UI - v#{Rack::JQueryUI::JQUERY_UI_VERSION}" }
+    end
+    context "for an image" do
+      ex_path = File.expand_path "../../vendor/assets/javascripts/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/images", __FILE__
+      img = Dir.new( ex_path ).entries.find{|f| f =~ /\.png$/ }
+      let(:url) {  "/js/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/images/#{img}" }
+      before do
+        get url
+      end
+      it_should_behave_like "Any route"
+      subject { last_response.body }
+      it { should_not be_nil }
+    end
+  end
+  context "Re requests" do
+    before do
+      at_start = Time.parse(Rack::JQueryUI::JQUERY_UI_VERSION_DATE) + 60 * 60 * 24 * 180
+      Timecop.freeze at_start
+      get url
+      Timecop.travel Time.now + 86400 # add a day
+      get url, {}, {"HTTP_IF_MODIFIED_SINCE" => Rack::Utils.rfc2109(at_start) }
+    end
+    subject { last_response }
+    context "for CSS" do
+      let(:url) { subber "/js/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/:THEME/#{Rack::JQueryUI::Themes::JQUERY_UI_THEME_FILE}", theme }
+      its(:status) { should == 304 }
+    end
+    context "for an image" do
+      ex_path = File.expand_path "../../vendor/assets/javascripts/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/images", __FILE__
+      img = Dir.new( ex_path ).entries.find{|f| f =~ /\.png$/ }
+      let(:url) {  "/js/jquery-ui/#{Rack::JQueryUI::JQUERY_UI_VERSION}/themes/base/images/#{img}" }
+      its(:status) { should == 304 }
+    end
+  end
+end