brochure 0.3.1 → 0.4.0

data/README.md

@@ -1,9 +1,12 @@
 Brochure
 ========
 
-A Rack application for serving static sites with ERB templates (or any
-of the many [template languages supported by
+Brochure is a Rack application for serving static sites with ERB
+templates (or any of the many [template languages supported by
 Tilt](http://github.com/rtomayko/tilt/blob/master/TEMPLATES.md#readme)).
+It's the good parts of PHP wrapped up in a little Ruby package —
+perfect for serving the marketing site for your Rails app.
+
 
 Sample application structure:
 
@@ -22,11 +25,11 @@ Sample application structure:
 Sample `config.ru`:
 
     require "brochure"
-    ROOT = File.dirname(__FILE__)
-    run Brochure.app(ROOT)
+    root = File.dirname(__FILE__)
+    run Brochure.app(root)
 
 
-## Templates and URL mapping
+## URL mapping and template rendering
 
 URLs are automatically mapped to template names:
 
@@ -39,10 +42,15 @@ underscore in its filename. So `<%= render "shared/header" %>` will
 render `templates/shared/_header.html.erb` inline.
 
 Templates have access to the Rack environment via the `env` method and
-to the Brochure application via the `application` method.
+to the Brochure application via the `application`
+method. Additionally, a `Rack::Request` wrapper around the Rack
+environment is available via the `request` method.
+
+You can print HTML-escaped strings in your templates with the `h`
+helper.
 
 
-## Helper methods and instance variables
+## Custom helper methods and instance variables
 
 You can make additional helper methods and instance variables
 available to your templates. Helper methods live in Ruby modules and
@@ -51,21 +59,17 @@ can be included with the `:helpers` option to `Brochure.app`:
     module AssetHelper
       def asset_path(filename)
         local_path = File.join(application.asset_root, filename)
-        if File.file?(local_path)
-          cache_buster = "?#{Digest::MD5.hexdigest(IO.read(local_path))}"
-        else
-          cache_buster = ""
-        end
-        "#{filename}#{cache_buster}"
+        digest = Digest::MD5.hexdigest(IO.read(local_path))
+        "/#{filename}?#{digest}"
       end
     end
 
-    run Brochure.app(ROOT, :helpers => [AssetHelper])
+    run Brochure.app(root, :helpers => [AssetHelper])
 
 Similarly, instance variables can be defined with the `:assigns`
 option:
 
-    run Brochure.app(ROOT, :assigns => { :domain => "37signals.com" })
+    run Brochure.app(root, :assigns => { :domain => "37signals.com" })
 
 
 # Installation

data/lib/brochure.rb

@@ -3,20 +3,25 @@ require "rack"
 require "tilt"
 
 module Brochure
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 
   autoload :Application,      "brochure/application"
   autoload :Context,          "brochure/context"
   autoload :Failsafe,         "brochure/failsafe"
+  autoload :Static,           "brochure/static"
+  autoload :Template,         "brochure/template"
   autoload :TemplateNotFound, "brochure/errors"
 
   def self.app(root, options = {})
     app = Application.new(root, options)
+    app = Static.new(app, app.asset_root)
+
     if development?
       app = Rack::ShowExceptions.new(app)
     else
       app = Failsafe.new(app)
     end
+
     app
   end
 

data/lib/brochure/application.rb

@@ -47,8 +47,8 @@ module Brochure
     def call(env)
       if forbidden?(env["PATH_INFO"])
         forbidden
-      elsif template = find_template(env["PATH_INFO"][/[^.]+/])
-        success render_template(template, env)
+      elsif template = find_template(env["PATH_INFO"])
+        success template.render(env), template.content_type
       else
         not_found(env)
       end
@@ -58,40 +58,38 @@ module Brochure
       path[".."] || File.basename(path)[/^_/]
     end
 
-    def find_template(logical_path)
-      if template_path = find_template_path(logical_path)
+    def find_template(logical_path, format_extension = ".html")
+      if template_path = find_template_path(logical_path, format_extension)
         template_for(template_path)
       end
     end
 
-    def find_partial(logical_path)
-      if template_path = find_partial_path(logical_path)
+    def find_partial(logical_path, format_extension = ".html")
+      if template_path = find_partial_path(logical_path, format_extension)
         template_for(template_path)
       end
     end
 
-    def find_template_path(logical_path)
-      candidates = [logical_path + ".html", logical_path + "/index.html"]
-      template_trail.find(*candidates)
+    def find_template_path(logical_path, format_extension)
+      template_trail.find(logical_path, logical_path + format_extension, logical_path + "/index" + format_extension)
     end
 
-    def find_partial_path(logical_path)
-      path_parts   = logical_path.split("/")
-      partial_path = (path_parts[0..-2] + ["_" + path_parts[-1]]).join("/")
-      template_trail.find(partial_path + ".html")
+    def find_partial_path(logical_path, format_extension)
+      dirname, basename = File.split(logical_path)
+      partial_path = File.join(dirname, "_" + basename)
+      template_trail.find(partial_path, partial_path + format_extension)
     end
 
     def template_for(template_path)
       if Brochure.development?
-        Tilt.new(template_path)
+        Template.new(self, template_path)
       else
-        templates[template_path] ||= Tilt.new(template_path)
+        templates[template_path] ||= Template.new(self, template_path)
       end
     end
 
-    def render_template(template, env, locals = {})
-      context = context_class.new(self, env, assigns)
-      template.render(context, locals)
+    def context_for(template, env)
+      context_class.new(self, template, env, assigns)
     end
 
     def respond_with(status, body, content_type = "text/html; charset=utf-8")
@@ -102,13 +100,13 @@ module Brochure
       [status, headers, [body]]
     end
 
-    def success(body)
-      respond_with 200, body
+    def success(body, content_type)
+      respond_with 200, body, content_type
     end
 
     def not_found(env)
       if template = find_template("404")
-        respond_with 404, render_template(template, env)
+        respond_with 404, template.render(env)
       else
         default_not_found
       end

data/lib/brochure/context.rb

@@ -8,11 +8,13 @@ module Brochure
       context
     end
 
-    attr_accessor :application, :env
+    attr_reader :application, :template, :env
+
+    def initialize(application, template, env, assigns = {})
+      @application = application
+      @template = template
+      @env = env
 
-    def initialize(application, env, assigns = {})
-      self.application = application
-      self.env = env
       load_assigns(assigns)
     end
 
@@ -23,7 +25,7 @@ module Brochure
     end
 
     def request
-      @_request ||= Rack::Request.new(env)
+      @request ||= Rack::Request.new(env)
     end
 
     def h(html)
@@ -31,8 +33,8 @@ module Brochure
     end
 
     def render(logical_path, locals = {})
-      if template = @application.find_partial(logical_path)
-        @application.render_template(template, env, locals)
+      if partial = application.find_partial(logical_path, template.format_extension)
+        partial.render(env, locals)
       else
         raise TemplateNotFound, "no such template '#{logical_path}'"
       end

data/lib/brochure/static.rb

@@ -0,0 +1,19 @@
+require 'rack/file'
+
+module Brochure
+  class Static
+    def initialize(app, dir)
+      @file = Rack::File.new(dir)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @file.call(env)
+      if status > 400
+        @app.call(env)
+      else
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/brochure/template.rb

@@ -0,0 +1,36 @@
+module Brochure
+  class Template
+    attr_reader :app, :path
+
+    def initialize(app, path)
+      @app  = app
+      @path = path
+    end
+
+    def template
+      @template ||= Tilt.new(path)
+    end
+
+    def engine_extension
+      @engine_extension ||= File.extname(path)
+    end
+
+    def format_extension
+      @format_extension ||= begin
+        ext = File.extname(File.basename(path, engine_extension))
+        ext.empty? ? ".html" : ext
+      end
+    end
+
+    def content_type
+      @content_type ||= begin
+        type = Rack::Mime.mime_type(format_extension)
+        type[/^text/] ? "#{type}; charset=utf-8" : type
+      end
+    end
+
+    def render(env, locals = {})
+      template.render(app.context_for(self, env), locals)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brochure
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Sam Stephenson
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 -05:00
+date: 2010-10-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,6 +96,8 @@ files:
 - lib/brochure/context.rb
 - lib/brochure/errors.rb
 - lib/brochure/failsafe.rb
+- lib/brochure/static.rb
+- lib/brochure/template.rb
 - lib/brochure.rb
 - README.md
 - LICENSE