wbzyl-sinatra-static-assets 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*~
+\#*
+.\#*
+

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Wlodek Bzyl
+
+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.markdown

@@ -0,0 +1,81 @@
+# Static Assets Sinatra Extension 
+
+To install it, run:
+
+    sudo gem install wbzyl-sinatra-static-assets -s http://gems.github.com
+
+To use, include it in a Sinatra application:
+
+    require 'rubygems'
+    gem 'wbzyl-sinatra-static-assets'
+    require 'sinatra/static_assets'
+
+If you're subclassing *Sinatra::Base*, then you need to call helpers manually:
+
+  class MyApp < Sinatra::Base
+    helpers Sinatra::StaticAssets
+    # ...
+  end
+
+
+## Passenger: 8.7. How to fix broken images/CSS/JavaScript URIs in sub-URI deployments
+
+Some people experience broken images and other broken static assets
+when they deploy their application to a sub-URI
+(i.e. http://mysite.com/railsapp/). The reason for this usually is
+that you used a static URI for your image in the views. This means
+your img source probably refers to something like /images/foo.jpg. The
+leading slash means that it's an absolute URI: you're telling the
+browser to always load http://mysite.com/images/foo.jpg no matter
+what. The problem is that the image is actually at
+http://mysite.com/railsapp/images/foo.jpg. There are two ways to fix
+this.
+
+The second and highly recommended way is to always use Rails helper
+methods to output tags for static assets. These helper methods
+automatically take care of prepending the base URI that you've
+deployed the application to. For images there is `image_tag`, for
+JavaScript there is `javascript_include_tag` and for CSS there is
+`stylesheet_link_tag`. In the above example you would simply remove the
+`<img>` HTML tag and replace it with inline Ruby like this:
+
+    <%= image_tag("foo.jpg") %>
+
+This will generate the proper image tag to
+
+    $RAILS_ROOT/public/images/foo.jpg 
+
+so that your images will always work
+no matter what sub-URI you've deployed to.
+
+These helper methods are more valuable than you may think. For example
+they also append a timestamp to the URI to better facilitate HTTP
+caching. For more information, please refer to the Rails API docs.
+
+
+## Deploying to a sub URI
+
+Add to */etc/hosts*:
+
+    127.0.0.1       localhost.localdomain localhost sinatra.local
+
+Sym link the application:
+
+    ln -s ~/public_git/forks/sinatra-static-assets/examples/app1/public /srv/www/sinatra/app1
+    ln -s ~/public_git/forks/sinatra-static-assets/examples/app2/public /srv/www/sinatra/app2
+
+Add to */etc/httpd/conf.d/sinatra.conf*
+
+    <VirtualHost *:80>
+      ServerName sinatra.local
+      DocumentRoot /srv/www/sinatra
+    
+      RackBaseURI /app1
+      RackBaseURI /app2
+    </VirtualHost>
+
+Goto:
+
+    http://sinatra.rails/app1/
+
+Note the terminating slash.

data/Rakefile

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+require 'rake'
+require 'rake/testtask'
+require "rake/clean"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "sinatra-static-assets"
+    s.summary = "Sinatra extension providing helper methods to output tags for static assets."
+    s.email = "matwb@univ.gda.pl"
+    s.homepage = "http://github.com/wbzyl/sinatra-static-assets"
+    s.description = s.summary
+    s.authors = ["Włodek Bzyl"]
+
+    s.add_dependency 'emk-sinatra-url-for', '>=0.2.1'      
+  end
+rescue LoadError
+  puts "Jeweler not available."
+  puts "Install it with:"
+  puts "  sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc 'Install the package as a gem.'
+task :install => [:clean, :build] do
+  gem = Dir['pkg/*.gem'].last
+  sh "sudo gem install --no-rdoc --no-ri --local #{gem}"
+end
+
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 0

data/examples/app1/app.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'sinatra'
+
+gem 'sinatra-static-assets'
+require 'sinatra/static_assets'
+
+get "/" do
+  @title = "Tatra Mountains, Błyszcz (2159 m)"
+  erb :index
+end

data/examples/app1/config.ru

@@ -0,0 +1,9 @@
+# run with:  thin --rackup config.ru -p 4567 start
+
+require 'app'
+
+# default with passenger
+
+use Rack::Static, :urls => ["/stylesheets", "/javascripts", "/images"], :root => "public"
+
+run Sinatra::Application

data/examples/app1/public/javascripts/app1.js

@@ -0,0 +1 @@
+/* app1.js */

data/examples/app1/public/stylesheets/app1.css

@@ -0,0 +1,14 @@
+html {
+  margin: 0;
+  padding: 0;
+  background: #ABA418 url(src/bronzed_olive.png);
+}
+
+body {
+  width: 600px;
+  margin: 1em auto;
+  padding: 1em 2em;
+  border: black solid 1px;
+  background-color: #D1C704;
+  font: normal 14px/1.6 Arial, Helvetica, sans-serif;
+}

data/examples/app1/views/index.erb

@@ -0,0 +1,3 @@
+<h2><%= @title %></h2>
+
+<p><%= image_tag "/images/tatry1.jpg", :alt => @title, :title => @title %></p>

data/examples/app1/views/layout.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8">
+
+    <link rel="stylesheet" href="/stylesheets/app1.css" type="text/css" media="screen" charset="utf-8">
+    <script src="/javascripts/app1.js" type="text/javascript"></script>
+
+    <title><%= @title %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/examples/app2/app.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'sinatra'
+
+gem 'sinatra-static-assets'
+require 'sinatra/static_assets'
+
+get "/" do
+  @title = "Tatra Mountains, Dolina Gąsienicowa (1500 m)"
+  erb :index
+end

data/examples/app2/config.ru

@@ -0,0 +1,9 @@
+# run with:  thin --rackup config.ru -p 4567 start
+
+require 'app'
+
+# default with passenger
+
+use Rack::Static, :urls => ["/stylesheets", "/javascripts", "/images"], :root => "public"
+
+run Sinatra::Application

data/examples/app2/public/javascripts/app2.js

@@ -0,0 +1 @@
+/* app1.js */

data/examples/app2/views/index.erb

@@ -0,0 +1,3 @@
+<h2><%= @title %></h2>
+
+<p><%= image_tag "/images/tatry2.jpg", :alt => @title, :title => @title %></p>

data/examples/app2/views/layout.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8">
+
+    <link rel="stylesheet" href="/stylesheets/app2.css" type="text/css" media="screen" charset="utf-8">
+    <script src="/javascripts/app2.js" type="text/javascript"></script>
+
+    <title><%= @title %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/lib/sinatra/static_assets.rb

@@ -0,0 +1,50 @@
+require 'sinatra/base'
+
+gem 'emk-sinatra-url-for'
+require 'sinatra/url_for'
+
+module Sinatra
+  module StaticAssets
+
+    def image_tag(source, options = {})
+      options[:src] = url_for(source)
+      tag("img", options)  
+    end
+    
+    def stylesheet_link_tag(*sources)
+      # TODO  
+    end
+    
+    def javascript_include_tag(*sources)
+      # TODO
+    end
+
+    private
+    
+    def tag(name, options = nil, open = false)
+      "<#{name}#{tag_options(options) if options}#{open ? ">" : " />"}"
+    end
+    
+    def tag_options(options)
+      unless options.empty?
+        attrs = []
+        attrs = options.map { |key, value| %(#{key}="#{value}") }
+        " #{attrs.sort * ' '}" unless attrs.empty?
+      end
+    end
+    
+    # html_.. -> url_for..
+    # <link .. /?> ?
+    def stylesheet_tag(source, options)
+      tag("link", { "rel" => "stylesheet", "type" => Mime::CSS, "media" => "screen",
+          "href" => html_escape(path_to_stylesheet(source)) }.merge(options), false)
+    end
+    
+    def javascript_src_tag(source, options)
+      # append onto tag </script>
+    end
+    
+  end
+
+  helpers StaticAssets
+end

data/sinatra-static-assets.gemspec

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-static-assets}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["W\305\202odek Bzyl"]
+  s.date = %q{2009-05-22}
+  s.description = %q{Sinatra extension providing helper methods to output tags for static assets.}
+  s.email = %q{matwb@univ.gda.pl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "examples/app1/app.rb",
+     "examples/app1/config.ru",
+     "examples/app1/public/images/tatry1.jpg",
+     "examples/app1/public/javascripts/app1.js",
+     "examples/app1/public/stylesheets/app1.css",
+     "examples/app1/public/stylesheets/src/bronzed_olive.png",
+     "examples/app1/tmp/always_restart.txt",
+     "examples/app1/views/index.erb",
+     "examples/app1/views/layout.erb",
+     "examples/app2/app.rb",
+     "examples/app2/config.ru",
+     "examples/app2/public/images/tatry2.jpg",
+     "examples/app2/public/javascripts/app2.js",
+     "examples/app2/public/stylesheets/src/bronzed_olive.png",
+     "examples/app2/tmp/always_restart.txt",
+     "examples/app2/views/index.erb",
+     "examples/app2/views/layout.erb",
+     "lib/sinatra/static_assets.rb",
+     "sinatra-static-assets.gemspec",
+     "test/sinatra_static_assets_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/wbzyl/sinatra-static-assets}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Sinatra extension providing helper methods to output tags for static assets.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/sinatra_static_assets_test.rb",
+     "examples/app2/app.rb",
+     "examples/app1/app.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<emk-sinatra-url-for>, [">= 0.2.1"])
+    else
+      s.add_dependency(%q<emk-sinatra-url-for>, [">= 0.2.1"])
+    end
+  else
+    s.add_dependency(%q<emk-sinatra-url-for>, [">= 0.2.1"])
+  end
+end

data/test/sinatra_static_assets_test.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SinatraRDiscountTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  def rdiscount_app(&block)
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'      
+      helpers Sinatra::RDiscount
+      set :show_exceptions, false
+      get '/', &block
+    }
+    get '/'
+  end
+  
+  def test_renders_inline_strings
+    rdiscount_app { rdiscount 'hello world' }
+    assert last_response.ok?
+    assert_equal "<p>hello world</p>\n", last_response.body
+  end
+  
+  def test_renders_inline_erb_string
+    rdiscount_app { rdiscount '{%= 1 + 1 %}' }
+    assert last_response.ok?
+    assert_equal "<p>2</p>\n", last_response.body
+  end
+
+  def test_renders_files_in_views_path
+    rdiscount_app { rdiscount :hello }
+    assert last_response.ok?
+    assert_equal "<h1>hello world</h1>\n", last_response.body
+  end
+  
+  def test_takes_locals_option
+    rdiscount_app {
+      locals = {:foo => 'Bar'}
+      rdiscount "{%= foo %}", :locals => locals
+    }
+    assert last_response.ok?
+    assert_equal "<p>Bar</p>\n", last_response.body
+  end
+
+  def test_renders_with_inline_layouts
+    rdiscount_app {
+      rdiscount 'Sparta', :layout => 'THIS. IS. <%= yield.upcase %>' 
+    }
+    assert last_response.ok?
+    assert_equal "THIS. IS. <P>SPARTA</P>\n", last_response.body
+  end
+
+  def test_renders_with_file_layouts
+    rdiscount_app {
+      rdiscount 'hello world', :layout => :layout2
+    }
+    assert last_response.ok?
+    assert_equal "erb layout\n<p>hello world</p>\n\n", last_response.body
+  end
+
+  def test_renders_erb_with_blocks
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'      
+      helpers Sinatra::RDiscount
+      
+      def container
+        yield
+      end
+      def is;
+        "THIS. IS. SPARTA!"
+      end
+      
+      get '/' do
+        rdiscount '{% container do %} {%= is %} {% end %}'
+      end
+    }
+    
+    get '/'
+    assert last_response.ok?
+    assert_equal "<p> THIS. IS. SPARTA! </p>\n", last_response.body
+  end
+  
+  def test_raises_error_if_template_not_found
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'      
+      helpers Sinatra::RDiscount
+      set :show_exceptions, false
+      
+      get('/') { rdiscount :no_such_template }
+    }
+    assert_raise(Errno::ENOENT) { get('/') }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sinatra/rdiscount'
+
+require 'rdiscount'
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  attr_reader :app
+
+  # Sets up a Sinatra::Base subclass defined with the block
+  # given. Used in setup or individual spec methods to establish
+  # the application.
+  def mock_app(base=Sinatra::Base, &block)
+    @app = Sinatra.new(base, &block)
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: wbzyl-sinatra-static-assets
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- "W\xC5\x82odek Bzyl"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: emk-sinatra-url-for
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+description: Sinatra extension providing helper methods to output tags for static assets.
+email: matwb@univ.gda.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- examples/app1/app.rb
+- examples/app1/config.ru
+- examples/app1/public/images/tatry1.jpg
+- examples/app1/public/javascripts/app1.js
+- examples/app1/public/stylesheets/app1.css
+- examples/app1/public/stylesheets/src/bronzed_olive.png
+- examples/app1/tmp/always_restart.txt
+- examples/app1/views/index.erb
+- examples/app1/views/layout.erb
+- examples/app2/app.rb
+- examples/app2/config.ru
+- examples/app2/public/images/tatry2.jpg
+- examples/app2/public/javascripts/app2.js
+- examples/app2/public/stylesheets/src/bronzed_olive.png
+- examples/app2/tmp/always_restart.txt
+- examples/app2/views/index.erb
+- examples/app2/views/layout.erb
+- lib/sinatra/static_assets.rb
+- sinatra-static-assets.gemspec
+- test/sinatra_static_assets_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/wbzyl/sinatra-static-assets
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Sinatra extension providing helper methods to output tags for static assets.
+test_files: 
+- test/test_helper.rb
+- test/sinatra_static_assets_test.rb
+- examples/app2/app.rb
+- examples/app1/app.rb