wbzyl-sinatra-static-assets 0.0.9 → 0.0.10

data/README.markdown

@@ -2,17 +2,17 @@
 
 Gem *sinatra-static-assets* implements the following helpers methods:
 
+* `image_tag`
 * `stylesheet_link_tag`
 * `javascript_script_tag`
-* `image_tag`
 * `link_tag`
 
-To install it, run from the command line:
+To install it, run:
 
     sudo gem install wbzyl-sinatra-static-assets -s http://gems.github.com
 
-All methods are simple wrappers around the `url_for` method
-from the [sinatra-url-for](http://github.com/emk/sinatra-url-for/).
+All these methods are simple wrappers around the `url_for` method 
+from the [sinatra-url-for](http://github.com/emk/sinatra-url-for/) gem.
 
 ## When will you need it?
 
@@ -21,15 +21,21 @@ Whenever you use the
 or use `Rack::URLMap` to dispatch an application to
 sub URI.
 
-Suppose that we already have a virtual host `hitch.local`
-and two Sinatra application which live in 
+Example: Suppose that we already have a virtual host `hitch.local`
+and two Sinatra applications that live in
 `/home/me/www/summer` and `/home/me/www/winter` 
 directories, respectively.
-We want our Sinatra applications to be accessible from the URLs: 
-`http://hitch.local/summer` and `http://hitch.local/winter`.
+We want our Sinatra applications to be accessible from 
+the following sub URI: 
+
+    http://hitch.local/summer 
+
+and
+
+    http://hitch.local/winter
 
 To configure Apache2 and Passenger to serve our applications
-we create a new configuration file with the content:
+we need to create a new configuration file with the following content:
 
     <VirtualHost *:80>
       ServerName hitch.local
@@ -39,52 +45,55 @@ we create a new configuration file with the content:
       RackBaseURI /winter
     </VirtualHost>
 
-and link the applications directories in `/srv/www/hitch.local`:
+and a link to the applications directories in `/srv/www/hitch.local`:
 
     ln -s /home/me/www/summer/public /srv/www/hitch.local/summer
     ln -s /home/me/www/winter/public /srv/www/hitch.local/winter
 
-After restarting the Apache2 server and visiting, for example the
-first application at `http://hitch.local/summer` we see that links to
+After restarting an Apache2 server and visiting, for example, the first 
+application at `http://hitch.local/summer` we see that links to
 images, stylesheets and javascripts are broken.
 
-The hitch here is that in Sinatra apps we usually refer to
+The hitch here is that in Sinatra applications we usually refer to
 images/stylesheets/javascripts with absolute URI:
 
     /images/tatry1.jpg    /stylesheets/app.css    /javascripts/app.js
 
 That setup **works** whenever we are running applications locally.
-The absolute URI above tells browser to load images 
+The absolute URI above tells a browser to request images 
 (stylesheets and javascripts) from:
 
     http://localhost:4567/images/tatry1.jpg
 
-which in turn refer to:
+which in turn, tells a server to send a file:
 
     /home/me/www/summer/public/images/tatry1.jpg
 
-And this is the **correct** directory with the default setup of Sinatra
-application.
+The `public` directory is the default directory where static files
+should be served from.
+So, the `/images/tatry1.jpg` picture will be there and will be served
+unless we had changed that default directory.
 
-But these absolute URIs do not work whenever, for example,
-the *summer* application is dispatched to sub URI.
-Now, images are at:
+But these absolute URIs do not work when, for example,
+the *summer* application is dispatched to `/summer` sub URI.
+As a result the images are at:
 
     http://hitch.local/summer/images/tatry1.jpg
 
-but we request images from:
+but we request them from: 
 
     http://hitch.local/images/tatry1.jpg
 
-And this **does not work** beacause there is no application 
+And this **does not work** because there is no application 
 dispatched to *images* sub URI.
 
-The recommended way to cope with broken links is to use helper
-methods which automatically take of *prepending* 
-the *RackBaseURI* that we have dispatched application to.
+The recommended way to deal with an absolute URI 
+is to use a helper method that automatically converts
+`/images/tatry1.jpg` to `/summer/images/tatry1.jpg`
+for application dispatched to `/summer` sub URI. 
 
-In the above example you would simply remove the `<img>` HTML tag 
-and replace it with inline Ruby like this:
+In the above example you can simply remove the `<img>` 
+HTML tag and replace it with a Ruby inline code like this: 
 
     <%= image_tag("/images/tatry1.jpg", :alt => "Błyszcz, 2159 m") %>
 
@@ -93,15 +102,41 @@ deployments](http://www.modrails.com/documentation/Users%20guide%20Apache.html#s
 
 ## Usage examples
 
-To use, include it in a Sinatra application:
+In HTML `<link>` and `<img>` tags have no end tag.
+In XHTML, on the contrary, these tags must be properly closed.
+
+We can choose the appropriate behaviour with *closed* option:
+
+    image_tag "/images/tatry1.jpg", :alt => "Błyszcz, 2159 m", :closed => true
+
+The default value of *closed* option is `false`.
+
+    stylesheet_link_tag "/stylesheets/screen.css", "/stylesheets/summer.css", :media => "projection"
+    javascript_script_tag "/javascripts/jquery.js", "/javascripts/summer.js", :charset => "iso-8859-2"
+    link_to "Tatry Mountains Rescue Team", "/topr"
+
+In order to use include the following in a Sinatra application: 
+
+    gem 'wbzyl-sinatra-static-assets'
+    require 'sinatra/static_assets'
+
+Or, if subclassing `Sinatra::Base`, include helpers manually:
 
-    require 'rubygems'
     gem 'wbzyl-sinatra-static-assets'
     require 'sinatra/static_assets'
+      
+    class Summer < Sinatra::Base
+      helpers Sinatra::StaticAssets
+      # ...
+    end
 
 
 ## Miscellaneous stuff
 
-[UNIX] To create virual host, add to */etc/hosts*:
+1. The `examples` directory contains *summer* and *winter* applications.
+
+2. In order to create a virual host add the following to */etc/hosts/*: 
 
     127.0.0.1       localhost.localdomain localhost hitch.local
+
+3. TODO: write tests

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 0
-:patch: 9
+:patch: 10

data/examples/summer/summer.rb

@@ -9,3 +9,8 @@ get "/?" do
   @title = "Tatra Mountains, Błyszcz (2159 m)"
   erb :index
 end
+
+get "/:page" do
+  @title = "#{params[:page]}"
+  erb :"#{params[:page]}"
+end

data/examples/summer/views/index.erb

@@ -1,3 +1,6 @@
 <h2><%= @title %></h2>
 
 <p><%= image_tag "/images/tatry1.jpg", :closed => true, :alt => @title, :title => @title %></p>
+
+<p><a href="/winter">Tatra Mountain in Winter</a></p>
+<p><%= link_to "Tatry Mountains Rescue Team", "/topr" %></p>

data/examples/summer/views/topr.erb

@@ -0,0 +1,5 @@
+<h3>Tatry Mountains Rescue Team</h3>
+
+<p>The home page: <a href="http://www.topr.pl/">TOPR</a></a>
+
+<p>The emergency telephone: +48 601 100 300</p>

data/lib/sinatra/static_assets.rb

@@ -6,34 +6,21 @@ require 'sinatra/url_for'
 
 module Sinatra
   module StaticAssets
+    # In HTML <link> and <img> tags have no end tag.
+    # In XHTML, on the contrary, these tags must be properly closed.
     #
-    # TODO
-    #
-    # option: doctype => html  -> closed == false
-    # option: doctype => xhtml -> closed == true
-    #
-    # In HTML the <img> tag has no end tag:
-    #
-    #   image_tag "/images/foo.png", :alt => "Foo itself"
-    #
-    # In XHTML the <img /> tag must be properly closed:
+    # We can choose the appropriate behaviour with +closed+ option:
     #
     #   image_tag "/images/foo.png", :alt => "Foo itself", :closed => true
     #
+    # The default value of +closed+ option is +false+.
+    #
     def image_tag(source, options = {})
       closed = options.delete(:closed)
       options[:src] = url_for(source)
       tag("img", options, closed)
     end
 
-    # In HTML the <link> tag has no end tag:
-    #
-    #   stylesheet_link_tag "/stylesheets/screen.css", "/stylesheets/print.css"
-    #
-    # In XHTML the <link> tag must be properly closed:
-    #
-    #   stylesheet_link_tag "/stylesheets/screen.css", :closed => true
-    #
     def stylesheet_link_tag(*sources)
       list, options = extract_options(sources)
       closed = options.delete(:closed)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wbzyl-sinatra-static-assets
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors: 
 - Wlodek Bzyl
@@ -92,6 +92,7 @@ files:
 - examples/summer/tmp/always_restart.txt
 - examples/summer/views/index.erb
 - examples/summer/views/layout.erb
+- examples/summer/views/topr.erb
 - examples/winter/app2.rb
 - examples/winter/config.ru
 - examples/winter/public/images/tatry2.jpg