rack-jquery 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbx/
+.rspec

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+
+# whitelist
+branches:
+  only:
+    - master
+    - develop

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-jquery.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'rack-test'
+  gem "timecop"
+end
+
+group :examples do
+  gem "sinatra"
+  gem "haml"
+end
+
+group :development do
+  gem "wirble"
+  gem "pry"
+  gem "pry-nav"
+end

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Iain Barnett
+
+MIT Licence
+
+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.md

@@ -0,0 +1,57 @@
+# Rack::JQuery
+
+[jQuery](http://jquery.com/download/) CDN script tags and fallback in one neat package.
+
+### Build status ###
+
+Master branch:
+[![Build Status](https://secure.travis-ci.org/yb66/rack-jquery.png?branch=master)](http://travis-ci.org/yb66/rack-jquery)
+
+## Why? ##
+
+I get tired of copy and pasting and downloading and moving… jQuery files and script tags etc. This does it for me, and keeps version management nice 'n' easy.
+
+## Usage ##
+
+Have a look in the examples directory, but here's a snippet.
+
+* Install it (see below)
+* Require `'rack/jquery`.
+* Put this in the head of your layout (the example is Haml but you can use whatever you like)
+
+    <pre><code>
+    %head
+      = Rack::JQuery.cdn
+    </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).
+
+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-#{VERSION}.min.js" path. You can change the "/js" bit if you like (see the docs).
+
+That was easy.
+
+## 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 can be found in the lib/rack/jquery/version.rb file, or via the Rack::JQuery::JQUERY_VERSION constant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-jquery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-jquery
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/config.rb

@@ -0,0 +1,59 @@
+require 'sinatra/base'
+require 'haml'
+require 'rack/jquery'
+
+class App < Sinatra::Base
+
+  enable :inline_templates
+  use Rack::JQuery
+
+  get "/" do
+    "RUNNING"
+  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 "/unspecified-cdn" do
+    haml :index, :layout => :unspecified
+  end
+end
+
+__END__
+
+@@google
+%html
+  %head
+    = Rack::JQuery.cdn( :google )
+  = yield
+
+@@microsoft
+%html
+  %head
+    = Rack::JQuery.cdn( :microsoft )
+  = yield
+
+@@mediatemple
+%html
+  %head
+    = Rack::JQuery.cdn( :media_temple )
+  = yield
+
+@@unspecified
+%html
+  %head
+    = Rack::JQuery.cdn()
+  = yield
+
+@@index
+%p
+  "NOTHING TO SEE HERE, MOVE ALONG, MOVE ALONG"

data/examples/config.ru

@@ -0,0 +1,6 @@
+require "rubygems"
+require "bundler"
+Bundler.setup(:examples)
+require File.expand_path( '../config.rb', __FILE__)
+
+run App

data/lib/rack/jquery.rb

@@ -0,0 +1,98 @@
+require "rack/jquery/version"
+
+module Rack
+
+  # jQuery CDN script tags and fallback in one neat package.
+  class JQuery
+
+    JQUERY_FILE_NAME = "jquery-#{JQUERY_VERSION}.min.js"
+
+    # Script tags for the Media Temple CDN
+    MEDIA_TEMPLE = "<script src='http://code.jquery.com/#{JQUERY_FILE_NAME}'></script>"
+
+    # Script tags for the Google CDN
+    GOOGLE = "<script src='//ajax.googleapis.com/ajax/libs/jquery/#{JQUERY_VERSION}/jquery.min.js'></script>"
+
+    # Script tags for the Microsoft CDN
+    MICROSOFT = "<script src='http://ajax.aspnetcdn.com/ajax/jQuery/#{JQUERY_FILE_NAME}'></script>"
+
+    # This javascript checks if the jQuery object has loaded. If not, that most likely means the CDN is unreachable, so it uses the local minified jQuery.
+    FALLBACK = <<STR
+<script type="text/javascript">
+  if (typeof jQuery == 'undefined') {
+      document.write(unescape("%3Cscript src='/js/#{JQUERY_FILE_NAME}' type='text/javascript'%3E))
+  };
+</script>
+STR
+
+    # HTTP date format.
+    # @see http://www.ietf.org/rfc/rfc1123.txt
+    HTTP_DATE = "%a, %d %b %Y %T GMT"
+
+    # Ten years in seconds.
+    TEN_YEARS  = 60 * 60 * 24 * 365 * 10
+
+    # @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
+          MEDIA_TEMPLE
+        when :microsoft
+          MICROSOFT
+        else
+          GOOGLE
+      end
+      "#{script}\n#{FALLBACK}"
+    end
+
+
+    # Default options hash for the middleware.
+    DEFAULT_OPTIONS = {
+      :http_path => "/js"
+    }
+
+
+    # @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".
+    # @example
+    #   # The default:
+    #   use Rack::JQuery
+    #   # With a different route to the fallback:
+    #   use Rack::JQuery, :http_path => "/assets/js"
+    def initialize( app, options={} )
+      @app, @options  = app, DEFAULT_OPTIONS.merge(options)
+      @http_path_to_jquery = ::File.join @options[:http_path], JQUERY_FILE_NAME
+    end
+
+
+    # @param [Hash] env Rack request environment hash.
+    def call( env )
+      request = Rack::Request.new(env.dup)
+      if request.path_info == @http_path_to_jquery
+        response = Rack::Response.new
+        # for caching
+        response.headers.merge!( {
+          "Last-Modified" => JQUERY_VERSION_DATE,
+          "Expires"    => (Time.now + TEN_YEARS).strftime(HTTP_DATE),
+          "Cache-Control" => "max-age=#{TEN_YEARS},public",
+          "Etag"          => "#{JQUERY_FILE_NAME}",
+          'Content-Type' =>'application/javascript; charset=utf-8'
+        })
+
+        # 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.
+        if request.env['HTTP_IF_MODIFIED_SINCE']
+          response.status = 304
+        else
+          response.status = 200
+          response.write ::File.read( ::File.expand_path "../../../vendor/assets/javascripts/#{JQUERY_FILE_NAME}", __FILE__)
+        end
+        response.finish
+      else
+        @app.call(env)
+      end
+    end # call
+
+  end
+end

data/lib/rack/jquery/version.rb

@@ -0,0 +1,9 @@
+module Rack
+  class JQuery
+    VERSION = "0.0.1"
+    JQUERY_VERSION = "1.9.1"
+
+    # TODO remember to change Last-Modified with each release!
+    JQUERY_VERSION_DATE = "Mon, 04 Feb 2013 00:00:00 GMT"
+  end
+end

data/rack-jquery.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/jquery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-jquery"
+  spec.version       = Rack::JQuery::VERSION
+  spec.authors       = ["Iain Barnett"]
+  spec.email         = ["iainspeed@gmail.com"]
+  spec.description   = %q{jQuery CDN script tags and fallback in one neat package.}
+  spec.summary       = %q{The description says it all.}
+  spec.homepage      = "https://github.com/yb66/rack-jquery"
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency("rack")
+end

data/spec/rack_jquery_spec.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require_relative "../lib/rack/jquery.rb"
+
+describe "The class methods" do
+  subject { Rack::JQuery.cdn organisation }
+  context "Given an argument" do
+    context "of nil (the default)" do
+      let(:organisation) { nil }
+      it { should == "#{Rack::JQuery::GOOGLE}\n#{Rack::JQuery::FALLBACK}" }
+    end
+    context "of :google" do
+      let(:organisation) { :google }
+      it { should == "#{Rack::JQuery::GOOGLE}\n#{Rack::JQuery::FALLBACK}" }
+    end
+    context "of :microsoft" do
+      let(:organisation) { :microsoft }
+      it { should == "#{Rack::JQuery::MICROSOFT}\n#{Rack::JQuery::FALLBACK}" }
+    end
+    context "of :media_temple" do
+      let(:organisation) { :media_temple }
+      it { should == "#{Rack::JQuery::MEDIA_TEMPLE}\n#{Rack::JQuery::FALLBACK}" }
+    end
+  end
+end
+
+describe "Inserting the CDN" do
+  include_context "All routes"
+  context "Google CDN" do
+    before do
+      get "/google-cdn"
+    end
+    it_should_behave_like "Any route"
+    subject { last_response.body }
+    let(:expected) { Rack::JQuery::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::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::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::GOOGLE }
+    it { should include expected }
+  end
+end
+
+
+require 'timecop'
+require 'time'
+
+describe "Serving the fallback jquery" do
+  include_context "All routes"
+  before do
+    get "/js/jquery-#{Rack::JQuery::JQUERY_VERSION}.min.js"
+  end
+  it_should_behave_like "Any route"
+  subject { last_response.body }
+  it { should start_with "/*! jQuery v1.9.1" }
+
+  context "Re requests" do
+    before do
+      at_start = Time.parse(Rack::JQuery::JQUERY_VERSION_DATE) + 60 * 60 * 24 * 180
+      Timecop.freeze at_start
+      get "/js/jquery-#{Rack::JQuery::JQUERY_VERSION}.min.js"
+      Timecop.travel Time.now + 86400 # add a day
+      get "/js/jquery-#{Rack::JQuery::JQUERY_VERSION}.min.js", {}, {"HTTP_IF_MODIFIED_SINCE" => at_start.strftime(Rack::JQuery::HTTP_DATE) }
+    end
+    subject { last_response }
+    its(:status) { should == 304 }
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+require 'rspec'
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rack-jquery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Iain Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: jQuery CDN script tags and fallback in one neat package.
+email:
+- iainspeed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- examples/config.rb
+- examples/config.ru
+- lib/rack/jquery.rb
+- lib/rack/jquery/version.rb
+- rack-jquery.gemspec
+- spec/rack_jquery_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/all_pages.rb
+homepage: https://github.com/yb66/rack-jquery
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: The description says it all.
+test_files:
+- spec/rack_jquery_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/all_pages.rb