sinatra-js 0.1.5

data/sinatra-js.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-js}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kematzy"]
+  s.date = %q{2010-08-10}
+  s.description = %q{A Sinatra Extension that makes working with JS easy.}
+  s.email = %q{kematzy@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGES",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sinatra/js.rb",
+     "sinatra-js.gemspec",
+     "spec/fixtures/app/views/js/app.rjs",
+     "spec/fixtures/public/insert.js",
+     "spec/fixtures/public/inserted-from-path.js",
+     "spec/sinatra/js_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kematzy/sinatra-js}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Sinatra Extension that makes working with JS easy.}
+  s.test_files = [
+    "spec/sinatra/js_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 1.0"])
+      s.add_runtime_dependency(%q<sinatra-tags>, [">= 0"])
+      s.add_runtime_dependency(%q<sinatra-assets>, [">= 0"])
+      s.add_development_dependency(%q<sinatra-tests>, [">= 0.1.6"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 1.0"])
+      s.add_dependency(%q<sinatra-tags>, [">= 0"])
+      s.add_dependency(%q<sinatra-assets>, [">= 0"])
+      s.add_dependency(%q<sinatra-tests>, [">= 0.1.6"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 1.0"])
+    s.add_dependency(%q<sinatra-tags>, [">= 0"])
+    s.add_dependency(%q<sinatra-assets>, [">= 0"])
+    s.add_dependency(%q<sinatra-tests>, [">= 0.1.6"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

data/spec/fixtures/app/views/js/app.rjs

@@ -0,0 +1 @@
+// hi from <%= __FILE__.sub(fixtures_path, '') %>

data/spec/fixtures/public/insert.js

@@ -0,0 +1 @@
+document.write("insert into HTML output works");

data/spec/fixtures/public/inserted-from-path.js

@@ -0,0 +1 @@
+document.write("insert from path into HTML output also works");

data/spec/sinatra/js_spec.rb

@@ -0,0 +1,315 @@
+
+require "#{File.dirname(File.dirname(File.expand_path(__FILE__)))}/spec_helper"
+
+describe "Sinatra" do 
+  
+  class MyTestApp 
+    register(Sinatra::JS)
+    register(Sinatra::Cache)
+    
+    set :cache_enabled, true
+    set :cache_environment, :test
+    set :cache_output_dir, "#{public_fixtures_path}/system/cache"
+    
+    set :views, "#{fixtures_path}/app/views"
+    
+    get_all_js_requests
+    get_all_js_requests('/javascripts')
+    get_all_js_requests('/custom', :cache => true)  # loads from /custom
+  end
+  
+  class MyCustomTestApp < Sinatra::Base 
+    register(Sinatra::JS)
+    
+    
+  end
+  
+  it_should_behave_like "MyTestApp"
+  
+  describe "JS" do 
+    
+    describe "VERSION" do 
+      
+      it "should return the VERSION string" do 
+        Sinatra::JS::VERSION.should be_a_kind_of(String)
+        Sinatra::JS::VERSION.should match(/\d\.\d+\.\d+(\.\d)?/)
+      end
+      
+    end #/ VERSION
+    
+    describe "#self.version" do 
+      
+      it "should return a version of the Sinatra::JS VERSION string" do 
+        Sinatra::JS.version.should be_a_kind_of(String)
+        Sinatra::JS.version.should match(/Sinatra::JS v\d\.\d+\.\d+(\.\d)?/)
+      end
+      
+    end #/ #self.version
+    
+    
+    describe "Configuration" do 
+      
+      describe "with Default settings" do 
+        
+        # it "should set the :pagetitle_default_options[:admin] to 'false'" do 
+        #   MyTestApp.pagetitle_default_options[:admin].should == false
+        # end
+        
+      end #/ with Default settings
+      
+      describe "with Custom Settings" do 
+        
+        # it "should set the :pagetitle_default_options[:admin] to 'true'" do 
+        #   MyCustomTestApp.pagetitle_default_options[:admin].should == true
+        # end
+        
+        
+      end #/ with Custom Settings
+      
+    end #/ Configuration
+    
+    
+    describe "Helpers" do 
+      
+      describe "#js" do 
+        
+        describe "when a block is passed" do 
+          
+          it "should return inline javascript tag " do 
+            markup = app.javascript do
+              "document.write('this works');"
+            end
+            markup.should have_tag('script[@type=text/javascript]', /document\.write\('this works'\);/ )
+            markup.should have_tag('script[@charset=utf-8]')
+          end
+          
+        end #/ when a block is passed
+        
+        it "should assign type attribute" do 
+          erb_app "<%= javascript('jquery.js') %>"
+          
+          body.should have_tag('script[@src=/jquery.js]')
+          body.should have_tag('script[@type=text/javascript]')
+          body.should have_tag('script[@charset=utf-8]')
+        end
+        
+        it "should assign charset UTF-8 attribute" do 
+          erb_app "<%= javascript('jquery.js') %>"
+          body.should have_tag('script[@charset=utf-8]')
+        end
+        
+        it "should assign src attribute" do 
+          erb_app "<%= javascript('/js/jquery.js') %>"
+          body.should have_tag('script[@src=/js/jquery.js]')
+        end
+        
+        it "should accept an array of files" do 
+          erb_app "<%= js(['/js/jquery.js','/js/jquery.ui']) %>"
+          # body.should have_tag(:debug)
+          body.should have_tag('script[@src=/js/jquery.js]')
+          body.should have_tag('script[@src=/js/jquery.ui.js]')
+        end
+        
+      end #/ #js
+      
+      describe "#js_custom_add" do 
+        
+        it "should add the custom JS to the buffer" do 
+          @app.js_custom_add("does this work?")
+          @app.sinatra_js_custom_code.should == ["does this work?"]
+        end
+        
+        it "should handle multiple additions of JS to the buffer" do
+          @app.js_custom_add("does this work?")
+          @app.js_custom_add("yes it does")
+          @app.sinatra_js_custom_code.should == ["does this work?", "yes it does"]
+        end
+        
+      end #/ #js_custom_add
+      
+      describe "#js_custom_add_file" do 
+        before(:each) do 
+          @used_layout = "<%= js_custom_files %>" 
+        end
+        
+        it "should add custom JS files to the buffer" do 
+          @app.js_custom_add_file('dummy.js')
+          @app.sinatra_js_custom_files.should == ["dummy.js"]
+        end
+        
+        it "should handle multiple additions of files to the buffer" do 
+          @app.js_custom_add_file('jquery.js')
+          @app.js_custom_add_file(['print', 'jquery'])
+          @app.sinatra_js_custom_files.should == ["jquery.js", "print", "jquery"]
+        end
+        
+        it "should handle adding remote custom JS files to the buffer" do 
+          erb_app "<% js_custom_add_file('http://jquery.com/jquery.js') %>", :layout => @used_layout
+          body.should have_tag('script[@src=http://jquery.com/jquery.js]')
+          # @app.js_custom_add_file('http://jquery.com/jquery.js')
+          # @app.sinatra_js_custom_files.should == ["http://jquery.com/jquery.js"]
+        end
+        
+        it "should embed JS when adding :insert_into_html to the tag" do
+          @app.js_custom_add_file('insert.js', :insert_into_html)
+          @app.sinatra_js_custom_files.should == nil
+          markup = @app.js_custom
+          markup.should match(/<script type="text\/javascript" charset="utf-8">\n/)
+          markup.should match(/\s*document\.write\("insert into HTML output works"\);\n/)
+          markup.should match(/\s*<\/script>\n/)
+        end
+        
+        it "should embed JS when adding :insert_into_html and :path to the tag" do
+          @app.js_custom_add_file('inserted-from-path.js', :insert_into_html, "#{public_fixtures_path}/")
+          @app.sinatra_js_custom_files.should == nil
+          markup = @app.js_custom
+          markup.should match(/<script type="text\/javascript" charset="utf-8">\n/)
+          markup.should match(/\s*document\.write\("insert from path into HTML output also works"\);\n/)
+          markup.should match(/\s*<\/script>\n/)
+        end
+        
+        it "should NOT embed JS when adding :insert_into_html to the tag and the file is NOT found" do
+          @app.js_custom_add_file('js/does-not-exist.js', :insert_into_html)
+          @app.sinatra_js_custom_files.should == nil
+          @app.js_custom.should == ''
+        end
+        
+      end #/ #js_custom_add_file
+      
+      describe "#js_custom" do 
+        
+        it "should return a <script> tag with the custom JS" do 
+          @app.js_custom_add("window.alert('this works');")
+          @app.js_custom_add("var doc = document;")
+          expected = @app.js_custom
+          
+          expected.should match(/<script type="text\/javascript" charset="utf-8">\n/)
+          # expected.should match(/\s*\$\(document\)\.ready\(\s*function\s*\(\)\s*\{/)
+          expected.should match(/\s*window\.alert\('this works'\);\n/)
+          # expected.should match(/\s*\}\s*\);\n/)
+          expected.should match(/\s*<\/script>\n/)
+        end
+        
+        it "should return nothing when no custom JS has been added" do 
+          @app.js_custom.should == ''
+        end
+        
+        it "should return nothing when no custom JS has been added together with :add_jquery_block" do 
+          @app.js_custom('',:add_jquery_block).should == ''
+        end
+        
+        it "should reach the HTML output" do 
+          erb_app %Q{ <% js_custom_add("window.alert('this works');") %> <% js_custom_add("var doc = document;") %> },
+          :layout => %Q{ <%= js_custom(:jquery_block) %>  } 
+          # body.should have_tag(:debug)
+          body.should have_tag('script[@type=text/javascript]')
+          body.should match(/\n\s*\$\(document\)\.ready\( function \(\) \{\n\s*window\.alert\('this works'\);\n\s*var doc = document;\n  \} \);\n/)
+        end
+        
+      end #/ #js_custom
+      
+      describe "#js_custom_files" do 
+        
+        it "should work with a single symbol passed to :js_custom_add_file" do 
+          block = %Q[<% js_custom_add_file(:jquery) %>]
+          erb_app block, :layout => %Q{ <%= js_custom_files %>  } 
+          
+          # body.should have_tag(:debug)
+          body.should match(/<!-- custom js files -->\n/)
+          body.should have_tag('script[@src=/jquery.js]') do |link|
+            link.attributes['charset'].should == 'utf-8'
+            link.attributes['type'].should == 'text/javascript'
+          end
+          body.should match(/\s*<!-- \/custom js files -->\n/)
+        end
+        
+        it "should work with an absolute path passed to :js_custom_add_file" do 
+          block = %Q[<% js_custom_add_file('/js/jquery') %>]
+          block << %Q[<% js_custom_add_file('/js/jquery.ui.js') %>]
+          erb_app block, :layout => %Q{ <%= js_custom_files %>  } 
+          
+          # body.should have_tag(:debug)
+          body.should match(/<!-- custom js files -->\n/)
+          body.should have_tag('script[@src=/js/jquery.js]')
+          body.should have_tag('script[@src=/js/jquery.ui.js]')
+          body.should match(/\s*<!-- \/custom js files -->\n/)
+        end
+        
+        it "should work with an array passed to :js_custom_add_file" do 
+          block = %Q[<% js_custom_add_file(['jquery.js', 'jquery.ui']) %>]
+          block << %Q[<% js_custom_add_file(['app']) %>]
+          block << %Q[<% js_custom_add_file(['http://remote.com/remote.js']) %>]
+          
+          erb_app block, :layout => %Q{ <%= js_custom_files %>  } 
+          
+          # body.should have_tag(:debug)
+          body.should have_tag('script[@src=/jquery.js]')
+          body.should have_tag('script[@src=/app.js]')
+          body.should have_tag('script[@src=http://remote.com/remote.js]')
+        end
+        
+        it "should return nothing when no custom JS files have been added" do 
+          erb_app %Q[<%= js_custom_files %>]
+          
+          # body.should have_tag(:debug)
+          body.should == ''
+        end
+        
+      end #/ #js_custom_add_files
+      
+      describe "#js_insert_file" do 
+        
+        it "should have some tests"
+        
+      end #/ #js_insert_file
+      
+    end #/ Helpers
+    
+    
+    describe "DSL methods" do 
+      
+      describe "#get_all_js_requests" do 
+        
+        it "should get a .rjs javascript using defaults and return it" do 
+          get('/js/app.js')
+          
+          status.should == 200
+          response.headers['Content-type'].should match(/text\/javascript/)
+          body.should == "// hi from /app/views/js/app.rjs"
+        end
+        
+        it "should get a .rjs javascript using a custom path and return it" do 
+          get('/javascripts/app.js')
+          
+          status.should == 200
+          response.headers['Content-type'].should match(/text\/javascript/)
+          body.should == "// hi from /app/views/js/app.rjs"
+        end
+        
+        it "should return a 404 when the javascript is NOT found" do 
+          get('/js/does-not-exist.js')
+          
+          status.should == 404
+          response.headers['Content-type'].should == "text/html"
+          # NOTE: dependent upon the error handling of Sinatra::Basic, but that's NOT really a core feature 
+          # of the Sinatra::Sass extension
+          # body.should have_tag('h1', 'Not Found') #match(/<h1>Not Found<\/h1>\n/)
+          # body.should have_tag('p',/The requested URL \[ \/css\/does-not-exist\.css \] was not found on this server/ )
+        end
+        
+        it "should function when given ':cache => Boolean'" do 
+          get('/custom/app.js')
+          
+          status.should == 200
+          response.headers['Content-type'].should match(/text\/javascript/)
+          body.should == "// hi from /app/views/js/app.rjs"
+        end
+        
+      end #/ #get_all_js_requests
+      
+    end #/ DSL methods
+    
+    
+  end #/ JS
+  
+end #/ Sinatra

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+
+::APP_ROOT = "#{File.dirname(File.expand_path(__FILE__))}/fixtures" 
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+ENV['RACK_ENV'] = 'test'
+
+#--
+# DEPENDENCIES
+#++
+%w( 
+sinatra/base 
+).each {|lib| require lib }
+
+#--
+## SINATRA EXTENSIONS
+#++
+%w(
+sinatra/tests
+sinatra/js
+sinatra/cache
+).each {|ext| require ext }
+
+
+Spec::Runner.configure do |config|
+  config.include RspecHpricotMatchers
+  config.include Sinatra::Tests::TestCase
+  config.include Sinatra::Tests::RSpec::SharedSpecs
+end
+
+
+# quick convenience methods..
+
+def fixtures_path 
+  "#{File.dirname(File.expand_path(__FILE__))}/fixtures"
+end
+
+def public_fixtures_path 
+  "#{fixtures_path}/public"
+end
+
+class MyTestApp < Sinatra::Base 
+  # need to set the root of the app for the default :cache_fragments_output_dir to work
+  set :root, ::APP_ROOT
+  set :app_dir, "#{APP_ROOT}/apps/base"
+  set :public, "#{fixtures_path}/public"
+  set :views, "#{app_dir}/views"
+  
+  register(Sinatra::Tests)
+  
+  enable :raise_errors
+  
+end #/class MyTestApp
+
+
+class Test::Unit::TestCase
+  Sinatra::Base.set :environment, :test
+end