wbzyl-rack-static-assets 0.0.2

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,91 @@
+# *StaticAssets* Middleware
+
+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 'static-assets-middleware'
+    require 'rack/static_assets'
+
+## When you will need this gem?
+
+In short, whenever two or more applications are deployed to sub-URI
+with Phussion Passenger.
+
+This means, that we want these applications to be mounted
+under one host, `http://example.org` in the example below:
+
+    http://example.org/app1
+    http://example.org/app2
+    ...
+    http://example.org/tests/app3
+    http://example.org/secret/app3
+    ...
+
+See Phusion Passenger users guide, [Deploying a Rack-based Ruby 
+application](http://www.modrails.com/documentation/Users guide Apache.html#_deploying_a_rack_based_ruby_application),
+Deploying to a sub URI.
+
+
+*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.
+
+## 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>
+
+Now, goto to `http://sinatra.local/app1` or `http://sinatra.local/app2`.
+
+
+## TODO
+
+1. Append a timestamp to the URI to better facilitate HTTP
+   caching. For more information, see the Rails API docs.
+

data/examples/apache-virtualhost.conf

@@ -0,0 +1,18 @@
+<VirtualHost *:80>
+  ServerName sinatra.local
+  DocumentRoot /srv/www/sinatra
+
+  RackBaseURI /app1
+  RackBaseURI /app2
+
+  #<Location /app1>
+  #  PassengerAppRoot /path-to-app1-root
+  #</Location> 
+  #
+  #    or
+  #
+  #<Directory /app1>
+  #  PassengerAppRoot /path-to-app1-root
+  #</Directory> 
+
+</VirtualHost>

data/examples/app1/app1.rb

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

data/examples/app1/config.ru

@@ -0,0 +1,22 @@
+# run with:  thin --rackup config.ru -p 4567 start
+
+#use Rack::Static, :urls => ["/stylesheets", "/javascripts", "/images"], :root => "public"
+
+require 'app1'
+
+use Rack::ShowExceptions
+use Rack::Lint
+use Rack::ContentLength
+use Rack::StaticAssets, :logging => true
+
+App = Rack::Builder.new do 
+  map '/tatry' do
+    run Sinatra::Application
+  end
+  
+  map '/gallery' do
+    run Sinatra::Application
+  end
+end  
+
+run App

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><img src="/images/tatry1.jpg"></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 charset="utf-8" href="/stylesheets/app1.css" media="screen" rel="stylesheet" type="text/css">
+    <script charset="utf-8" src="/javascripts/app1.js" type="text/javascript"></script>
+
+    <title><%= @title %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/examples/app2/app2.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,7 @@
+# run with:  thin --rackup config.ru -p 4567 start
+
+require 'app2'
+
+use Rack::ShowExceptions
+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/public/stylesheets/app2.css

@@ -0,0 +1,18 @@
+/*
+    Theme for app2: http://www.colourlovers.com/palette/81363/rainy
+*/
+
+html {
+  margin: 0;
+  padding: 0;
+  background: #659DF1 url(src/skating.png);
+}
+
+body {
+  width: 600px;
+  margin: 1em auto;
+  padding: 1em 2em;
+  border: black solid 1px;
+  background-color: #D8E8FF;
+  font: normal 14px/1.6 Arial, Helvetica, sans-serif;
+}

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 charset="utf-8" href="/stylesheets/app2.css" media="screen" rel="stylesheet" type="text/css">
+    <script charset="utf-8" src="/javascripts/app2.js" type="text/javascript"></script>
+
+    <title><%= @title %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/examples/mapp1/config.ru

@@ -0,0 +1,14 @@
+require 'mapp'
+
+Mapp1 = Rack::Builder.new do
+  use Rack::ShowExceptions
+  use Rack::Lint
+  
+  use Rack::Static, :urls => ["/stylesheets", "/images"], :root => "public"
+
+  map '/' do
+    run Sinatra::Mapp1.new
+  end
+end
+
+run Mapp1

data/examples/mapp1/mapp.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+require 'sinatra/base'
+
+gem 'sinatra-static-assets'
+require 'sinatra/static_assets'
+
+module Sinatra
+  class Mapp1 < Sinatra::Base
+    helpers Sinatra::UrlForHelper
+    helpers Sinatra::StaticAssets
+    
+    set :app_file,  __FILE__
+    set :static, true  
+    
+    #set :root, File.dirname(__FILE__)
+    #set :views, Proc.new { File.join(root, "views") }
+    
+    get '/' do
+      @title = "Tatra Mountains, Błyszcz (2159 m)"
+      erb :app
+    end
+  end
+end

data/examples/mapp1/public/javascripts/mapp.js

@@ -0,0 +1 @@
+/* mapp1 */

data/examples/mapp1/public/stylesheets/mapp.css

@@ -0,0 +1,14 @@
+html {
+  margin: 0;
+  padding: 0;
+  background: #ABA418 url(src/background.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/mapp1/views/app.erb

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

data/examples/mapp1/views/layout.erb

@@ -0,0 +1,23 @@
+<!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">
+
+<!-- does not work
+
+    <link charset="utf-8" href="/stylesheets/mapp.css" media="screen" rel="stylesheet" type="text/css">
+
+-->
+
+    <%= stylesheet_link_tag "/stylesheets/mapp.css" %>
+    <%= javascript_script_tag "/javascripts/mapp.js" %>
+
+    <title><%= @title %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/examples/mapp2/config.ru

@@ -0,0 +1,14 @@
+require 'mapp'
+
+Mapp2 = Rack::Builder.new do
+  use Rack::ShowExceptions
+  use Rack::Lint
+  
+  use Rack::Static, :urls => ["/stylesheets", "/images"], :root => "public"
+  
+  map '/' do
+    run Sinatra::Mapp2.new
+  end
+end
+
+run Mapp2

data/examples/mapp2/mapp.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+require 'sinatra/base'
+
+gem 'sinatra-static-assets'
+require 'sinatra/static_assets'
+
+module Sinatra
+  class Mapp2 < Sinatra::Base
+    helpers Sinatra::UrlForHelper
+    helpers Sinatra::StaticAssets
+    
+    set :app_file,  __FILE__
+    set :static, true  
+    
+    get '/' do
+      @title = "Tatra Mountains, Dolina Gąsienicowa (1500 m)"
+      erb :mapp
+    end
+  end
+end

data/examples/mapp2/public/javascripts/mapp.js

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

data/examples/mapp2/public/stylesheets/mapp.css

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

data/examples/mapp2/views/layout.erb

@@ -0,0 +1,16 @@
+<!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">
+    <%= stylesheet_link_tag "/stylesheets/mapp.css" %>
+    <%= javascript_script_tag "/javascripts/mapp.js" %>
+
+    <title><%= @title %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/examples/mapp2/views/mapp.erb

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

data/examples/mconfig.ru

@@ -0,0 +1,19 @@
+require 'mapp1/mapp'
+require 'mapp2/mapp'
+
+Mapp = Rack::Builder.new do
+  use Rack::ShowExceptions
+  use Rack::Lint
+  
+  #use Rack::Static, :urls => ["/stylesheets", "/images"], :root => "public"
+
+  map '/mapp1' do
+    run Sinatra::Mapp1.new
+  end
+  
+  map '/mapp2' do
+    run Sinatra::Mapp2.new
+  end
+end
+
+run Mapp

data/lib/rack/static-assets.rb

@@ -0,0 +1,76 @@
+require 'rack/utils'
+
+gem 'hpricot', '>=0.8.1'
+require 'hpricot'
+
+module Rack
+  class StaticAssets
+    include Rack::Utils
+    
+    FORMAT = %{%s - [%s] [%s] "%s %s%s %s" (%s) %d %d %0.4f\n}
+    
+    def initialize(app, opts = {})
+      @app = app
+      
+      @opts = { :assets => "http://www.google.com/jsapi" }
+      @opts.merge! opts
+    end
+
+    def call(env)
+      began_at = Time.now
+      status, headers, response = @app.call(env)
+      headers = HeaderHash.new(headers)
+
+      if !STATUS_WITH_NO_ENTITY_BODY.include?(status) &&
+         !headers['transfer-encoding'] &&
+          headers['content-type'] &&
+          headers['content-type'].include?("text/html")
+
+        content = ""
+        response.each { |part| content += part }
+        doc = Hpricot(content)
+        
+#         nodes = doc.search(@opts[:element])
+#         nodes.each do |node|
+#           s = node.inner_html || "[++where is the code?++]"
+#           node.parent.swap(send(@highlighter, s))
+#         end
+
+        body = doc.to_html
+        
+        # headers['content-length'] = body.bytesize.to_s
+        headers.delete('content-length') # will be set by Rack::ContentLength
+
+        log(env, status, headers, began_at) if @opts[:logging]
+        [status, headers, [body]]
+      else
+        [status, headers, response]  
+      end
+    end
+    
+    private
+
+    def log(env, status, headers, began_at)
+      # lilith.local [coderay] text/html [26/may/2009 12:00:00] "GET / HTTP/1.1" 200 ? ?\n
+      now = Time.now
+       logger = env['rack.errors']
+      logger.write FORMAT % [
+        env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
+        "static assets",
+        now.strftime("%d/%b/%Y %H:%M:%S"),
+        env["REQUEST_METHOD"],
+        env["PATH_INFO"],
+        env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
+        env["HTTP_VERSION"],
+        headers["content-type"] || "unknown",
+        status.to_s[0..3],
+        headers['content-length'],
+        now - began_at
+      ]
+    end
+    
+    def rewrite_asset_tag(element)
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: wbzyl-rack-static-assets
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Wlodek Bzyl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+description: Static Assets Middleware is useful.
+email: matwb@univ.gda.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- examples/apache-virtualhost.conf
+- examples/app1/app1.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/app2.rb
+- examples/app2/config.ru
+- examples/app2/public/images/tatry2.jpg
+- examples/app2/public/javascripts/app2.js
+- examples/app2/public/stylesheets/app2.css
+- examples/app2/public/stylesheets/src/skating.png
+- examples/app2/tmp/always_restart.txt
+- examples/app2/views/index.erb
+- examples/app2/views/layout.erb
+- examples/mapp1/config.ru
+- examples/mapp1/mapp.rb
+- examples/mapp1/public/images/tatry1.jpg
+- examples/mapp1/public/javascripts/mapp.js
+- examples/mapp1/public/stylesheets/mapp.css
+- examples/mapp1/public/stylesheets/src/background.png
+- examples/mapp1/tmp/always_restart.txt
+- examples/mapp1/views/app.erb
+- examples/mapp1/views/layout.erb
+- examples/mapp2/config.ru
+- examples/mapp2/mapp.rb
+- examples/mapp2/public/images/tatry2.jpg
+- examples/mapp2/public/javascripts/mapp.js
+- examples/mapp2/public/stylesheets/mapp.css
+- examples/mapp2/public/stylesheets/src/background.png
+- examples/mapp2/tmp/always_restart.txt
+- examples/mapp2/views/layout.erb
+- examples/mapp2/views/mapp.erb
+- examples/mconfig.ru
+- lib/rack/static-assets.rb
+- LICENSE
+- README.markdown
+has_rdoc: false
+homepage: http://github.com/wbzyl/rack-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: Rack Static Assets Middleware
+test_files: 
+- examples/app2/app2.rb
+- examples/mapp2/mapp.rb
+- examples/mapp1/mapp.rb
+- examples/app1/app1.rb