rack-backbone 0.0.4 → 0.0.5

data/CHANGES.md

@@ -1,5 +1,16 @@
 # CH CH CH CHANGES #
 
+
+## Thursday the 10th of October 2013 ##
+
+### v0.0.5 ###
+
+* Can pass `false` to the `cdn` method to just get the fallback with no CDN, useful for working locally.
+* Fixed problem with the :http_path option for the fallback route.
+
+----
+
+
 ## Thursday the 19th of September 2013 ##
 
 ### v0.0.4 ###
@@ -8,6 +19,7 @@
 
 ----
 
+
 ### v0.0.3 ###
 
 * The vendored scripts weren't in the gem because of a cheeky line in the .gitignore file. Maybe DHH got hold of it ;) Fixed now.

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
 

data/lib/rack/backbone.rb

@@ -31,43 +31,60 @@ module Rack
 
     end
 
+
+    # Default options hash for the middleware.
+    DEFAULT_OPTIONS = {
+      :http_path => "/js"
+    }
+
+
     # This javascript checks if the Backbone object has loaded. If not, that most likely means the CDN is unreachable, so it uses the local minified Backbone.
-    FALLBACK = <<STR
+    # It's the top half, it gets pieced together elsewhere.
+    FALLBACK_TOP = <<STR
 <script type="text/javascript">
   if (typeof Backbone == 'undefined') {
-    document.write(unescape("%3Cscript src='/js/#{BACKBONE_FILE_NAME}' type='text/javascript'%3E%3C/script%3E"))
+    document.write(unescape("%3Cscript src='
+STR
+
+    # Bottom half of the fallback script.
+    FALLBACK_BOTTOM = <<STR
+' type='text/javascript'%3E%3C/script%3E"))
   };
 </script>
 STR
 
     # @param [Hash] env The rack env hash.
-    # @param [Symbol] organisation Choose which CDN to use, either :jsdelivr, or :cloudflare (the default). This will override anything set via the `use` statement.
+    # @option options [Symbol] organisation Choose which CDN to use, either :jsdelivr, or :cloudflare (the default). This will override anything set via the `use` statement. Pass in `false` to force use of the local Backbonejs script. `nil` will force choosing the default CDN.
     # @return [String] The HTML script tags to get the CDN.
     def self.cdn( env, options={}  )
       if env.nil? || env.has_key?(:organisation)
         fail ArgumentError, "The Rack::Backbone.cdn method needs the Rack environment passed to it, or at the very least, an empty hash."
       end
 
-      organisation =  options[:organisation] ||
-                        env["rack.backbone.organisation"] ||
-                        :media_temple
+      organisation =  options[:organisation]
+      if organisation.nil?
+        organisation = 
+          env["rack.backbone.organisation"] ||
+          :media_temple
+      end
 
-      script = case organisation
-        when :cloudflare
-          CDN::CLOUDFLARE
-        when :jsdelivr
-          CDN::JSDELIVR
-        else
-          CDN::CLOUDFLARE
+      warn "organisation = #{organisation.inspect}"
+      unless organisation == false
+        script_src = case organisation
+          when :cloudflare
+            CDN::CLOUDFLARE
+          when :jsdelivr
+            CDN::JSDELIVR
+          else
+            CDN::CLOUDFLARE
+        end
+          %Q!<script src='#{script_src}'></script>\n#{FALLBACK_TOP}#{env["rack.backbone.http_path"]}#{FALLBACK_BOTTOM}!
+      else
+        "<script src='#{env["rack.backbone.http_path"]}'></script>"
       end
-      "<script src='#{script}'></script>\n#{FALLBACK}"
-    end
 
+    end
 
-    # Default options hash for the middleware.
-    DEFAULT_OPTIONS = {
-      :http_path => "/js"
-    }
 
 
     # @param [#call] app
@@ -78,9 +95,6 @@ STR
     #   # The default:
     #   use Rack::Backbone
     #
-    #   # With a different route to the fallback:
-    #   use Rack::Backbone, :http_path => "/assets/js"
-    #
     #   # With a default organisation:
     #   use Rack::Backbone, :organisation => :cloudflare
     def initialize( app, options={} )
@@ -102,6 +116,7 @@ STR
     def _call( env )
       request = Rack::Request.new(env.dup)
       env.merge! "rack.backbone.organisation" => @organisation
+      env.merge! "rack.backbone.http_path" => @http_path_to_backbone
       if request.path_info == @http_path_to_backbone
         response = Rack::Response.new
         # for caching

data/lib/rack/backbone/version.rb

@@ -2,7 +2,7 @@ module Rack
   class Backbone
     
     # the version of this library
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
 
     # the version of Backbone it supports.
     BACKBONE_VERSION = "1.0.0" 

data/spec/rack_jquery_spec.rb

@@ -3,22 +3,30 @@
 require 'spec_helper'
 require_relative "../lib/rack/backbone.rb"
 
+class Rack::Backbone # for clarity!
+
 describe "The class methods" do
-  let(:env) { {} }
-  subject { Rack::Backbone.cdn env, :organisation => organisation }
+  let(:path) {::File.join(DEFAULT_OPTIONS[:http_path],BACKBONE_FILE_NAME)}
+  let(:env) { {"rack.backbone.http_path" => path} }
+  let(:default_options) { {} }
+  subject(:cdn) { Rack::Backbone.cdn env, default_options.merge(options) }
 
   context "Given the organisation option" do
     context "of nil (the default)" do
-      let(:organisation) { nil }
-      it { should == "<script src='#{Rack::Backbone::CDN::CLOUDFLARE}'></script>\n#{Rack::Backbone::FALLBACK}" }
+      let(:options) { {:organisation => nil } }
+      it { should == "<script src='#{CDN::CLOUDFLARE}'></script>\n#{FALLBACK_TOP}#{path}#{FALLBACK_BOTTOM}" }
     end
     context "of :jsdelivr" do
-      let(:organisation) { :jsdelivr }
-      it { should == "<script src='#{Rack::Backbone::CDN::JSDELIVR}'></script>\n#{Rack::Backbone::FALLBACK}" }
+      let(:options) { {:organisation => :jsdelivr } }
+      it { should == "<script src='#{CDN::JSDELIVR}'></script>\n#{FALLBACK_TOP}#{path}#{FALLBACK_BOTTOM}" }
     end
     context "of :cloudflare" do
-      let(:organisation) { :cloudflare }
-      it { should == "<script src='#{Rack::Backbone::CDN::CLOUDFLARE}'></script>\n#{Rack::Backbone::FALLBACK}" }
+      let(:options) { {:organisation => :cloudflare } }
+      it { should == "<script src='#{CDN::CLOUDFLARE}'></script>\n#{FALLBACK_TOP}#{path}#{FALLBACK_BOTTOM}" }
+    end
+    context "of false, to get the fallback script only" do
+      let(:options) { {:organisation => false } }
+      it { should == "<script src='#{path}'></script>" }    
     end
   end
 
@@ -56,7 +64,7 @@ describe "Inserting the CDN" do
       end
       it_should_behave_like "Any route"
       subject { last_response.body }
-      let(:expected) { Rack::Backbone::CDN::JSDELIVR }
+      let(:expected) { CDN::JSDELIVR }
       it { should include expected }
     end
     context "Unspecified CDN" do
@@ -65,7 +73,7 @@ describe "Inserting the CDN" do
       end
       it_should_behave_like "Any route"
       subject { last_response.body }
-      let(:expected) { Rack::Backbone::CDN::CLOUDFLARE }
+      let(:expected) { CDN::CLOUDFLARE }
       it { should include expected }
     end
     context "Cloudflare CDN" do
@@ -74,7 +82,7 @@ describe "Inserting the CDN" do
       end
       it_should_behave_like "Any route"
       subject { last_response.body }
-      let(:expected) { Rack::Backbone::CDN::CLOUDFLARE }
+      let(:expected) { CDN::CLOUDFLARE }
       it { should include expected }
     end
   end
@@ -92,7 +100,7 @@ describe "Inserting the CDN" do
       end
       it_should_behave_like "Any route"
       subject { last_response.body }
-      let(:expected) { Rack::Backbone::CDN::JSDELIVR }
+      let(:expected) { CDN::JSDELIVR }
       it { should include expected }
     end
     context "Unspecified CDN" do
@@ -101,7 +109,7 @@ describe "Inserting the CDN" do
       end
       it_should_behave_like "Any route"
       subject { last_response.body }
-      let(:expected) { Rack::Backbone::CDN::CLOUDFLARE }
+      let(:expected) { CDN::CLOUDFLARE }
       it { should include expected }
     end
     context "Cloudflare CDN" do
@@ -110,7 +118,7 @@ describe "Inserting the CDN" do
       end
       it_should_behave_like "Any route"
       subject { last_response.body }
-      let(:expected) { Rack::Backbone::CDN::CLOUDFLARE }
+      let(:expected) { CDN::CLOUDFLARE }
       it { should include expected }
     end
   end
@@ -121,24 +129,53 @@ require 'timecop'
 require 'time'
 
 describe "Serving the fallback backbone" do
-  include_context "All routes"
   before do
-    get "/js/backbone-#{Rack::Backbone::BACKBONE_VERSION}-min.js"
+    get path
   end
-  it_should_behave_like "Any route"
   subject { last_response.body }
-  it { should start_with "(function(){var t=this;var e=t.Backbone;" }
+  let(:path){ ::File.join(http_path, BACKBONE_FILE_NAME) }
 
-  context "Re requests" do
-    before do
-      at_start = Time.parse(Rack::Backbone::BACKBONE_VERSION_DATE) + 60 * 60 * 24 * 180
-      Timecop.freeze at_start
-      get "/js/backbone-#{Rack::Backbone::BACKBONE_VERSION}-min.js"
-      Timecop.travel Time.now + 86400 # add a day
-      get "/js/backbone-#{Rack::Backbone::BACKBONE_VERSION}-min.js", {}, {"HTTP_IF_MODIFIED_SINCE" => Rack::Utils.rfc2109(at_start) }
-    end
-    subject { last_response }
-    its(:status) { should == 304 }
-    
+  context "With the default :http_path (none given)" do
+    include_context "All routes"
+    let(:http_path) { DEFAULT_OPTIONS[:http_path] }
+
+    it_should_behave_like "Any route"
+    it { should start_with "(function(){var t=this;var e=t.Backbone;" }
+
+    context "Re requests" do
+      before do
+        at_start = Time.parse(BACKBONE_VERSION_DATE) + 60 * 60 * 24 * 180
+        Timecop.freeze at_start
+        get path
+        Timecop.travel Time.now + 86400 # add a day
+        get path, {}, {"HTTP_IF_MODIFIED_SINCE" => Rack::Utils.rfc2109(at_start) }
+      end
+      subject { last_response }
+      its(:status) { should == 304 }
+    end
   end
+  context "Given a different http_path via the options" do
+    include_context "All routes" do
+      let(:app) {
+        Sinatra.new do
+          use Rack::JQuery
+          use Rack::Lodash
+          use Rack::Backbone, :http_path => "/assets/javascripts"
+        end
+      }
+    end
+    context "That is valid" do
+      let(:http_path) { "/assets/javascripts" }
+
+      it_should_behave_like "Any route"
+      it { should start_with "(function(){var t=this;var e=t.Backbone;" }
+    end
+    context "That is not valid" do
+      let(:http_path) { "/this/is/not/the/path/it/was/setup/with" }
+      subject { last_response }
+      it { should_not be_ok }
+    end
+  end
+end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-backbone
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler