RubyGems - brochure - Versions diffs - 0.1.0 → 0.2.0 - Mend

brochure 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

data/LICENSE +1 -0
data/README.md +5 -3
data/lib/brochure.rb +18 -103
data/lib/brochure/application.rb +102 -0
data/lib/brochure/context.rb +30 -0
data/lib/brochure/errors.rb +3 -0
data/lib/brochure/failsafe.rb +26 -0
metadata +49 -9

data/LICENSE CHANGED Viewed

@@ -1,4 +1,5 @@
 Copyright (c) 2010 Sam Stephenson
+Copyright (c) 2010 Josh Peek
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md CHANGED Viewed

@@ -24,7 +24,7 @@ Sample application structure:
 Sample `config.ru`:
     require "brochure"
-    run Brochure::Application.new(File.dirname(__FILE__))
+    run Brochure.app(File.dirname(__FILE__))
 URLs are automatically mapped to template names. So `/` will render
 `app/templates/index.html.erb`, `/signup` will render
@@ -43,10 +43,12 @@ render `app/templates/shared/_header.html.erb` inline.
     $ gem install brochure
-Requires [Tilt](http://github.com/rtomayko/tilt).
+Requires [Hike](http://github.com/sstephenson/hike),
+[Rack](http://rack.rubyforge.org/), and
+[Tilt](http://github.com/rtomayko/tilt).
 # License
-Copyright (c) 2010 Sam Stephenson.
+Copyright (c) 2010 Sam Stephenson and Josh Peek.
 Released under the MIT license. See `LICENSE` for details.

data/lib/brochure.rb CHANGED Viewed

@@ -1,115 +1,30 @@
+require "hike"
+require "rack"
 require "tilt"
 module Brochure
-  class Application
-    def initialize(root)
-      @app_root      = File.expand_path(root)
-      @helper_root   = File.join(@app_root, "app", "helpers")
-      @template_root = File.join(@app_root, "app", "templates")
-      @context_class = Context.for(helpers)
-      @templates     = {}
-    end
-    def helpers
-      @helpers ||= Dir[File.join(@helper_root, "**", "*.rb")].map do |helper_path|
-        base_name    = helper_path[(@helper_root.length + 1)..-1][/(.*?)\.rb$/, 1]
-        module_names = base_name.split("/").map { |n| Brochure.camelize(n) }
-        load helper_path
-        module_names.inject(Kernel) { |mod, name| mod.const_get(name) }
-      end
-    end
-    def call(env)
-      logical_path = env["PATH_INFO"][/[^.]+/]
-      success render(logical_path)
-    rescue TemplateNotFound => e
-      not_found
-    rescue StandardError => e
-      error e
-    end
-    def find_template_path(logical_path, options = {})
-      if options[:partial]
-        path_parts   = logical_path.split("/")
-        logical_path = (path_parts[0..-2] + ["_" + path_parts[-1]]).join("/")
-      else
-        return false if File.basename(logical_path)[/^_/]
-      end
+  VERSION = "0.2.0"
-      template_path = if File.directory?(File.join(@template_root, logical_path))
-        File.join(@template_root, logical_path, "index.html.erb")
-      else
-        File.join(@template_root, logical_path + ".html.erb")
-      end
-      File.exists?(template_path) && template_path
-    end
+  autoload :Application,      "brochure/application"
+  autoload :Context,          "brochure/context"
+  autoload :Failsafe,         "brochure/failsafe"
+  autoload :TemplateNotFound, "brochure/errors"
-    def render(logical_path, options = {})
-      if template_path = find_template_path(logical_path, options)
-        context = @context_class.new(self)
-        locals  = options[:locals] || {}
-        template_for(template_path).render(context, locals)
-      else
-        raise TemplateNotFound, "no such template '#{logical_path}'"
-      end
-    end
-    def template_for(template_path)
-      @templates[template_path] ||= Tilt.new(template_path)
-    end
-    def respond_with(status, body, content_type = "text/html, charset=utf-8")
-      headers = {
-        "Content-Type"   => content_type,
-        "Content-Length" => body.length.to_s
-      }
-      [status, headers, body]
-    end
-    def success(body)
-      respond_with 200, body
-    end
-    def not_found
-      respond_with 404, <<-HTML
-        <!DOCTYPE html>
-        <html><head><title>Not Found</title></head>
-        <body><h1>404 Not Found</h1></body></html>
-      HTML
-    end
-    def error(exception)
-      warn ["#{exception.class.name}: #{exception}", *exception.backtrace].join("\n  ")
-      respond_with 500, <<-HTML
-        <!DOCTYPE html>
-        <html><head><title>Internal Server Error</title></head>
-        <body><h1>500 Internal Server Error</h1></body></html>
-      HTML
-    end
-  end
-  class Context
-    include Tilt::CompileSite
-    def self.for(helpers)
-      context = Class.new(self)
-      context.send(:include, *helpers) if helpers.any?
-      context
-    end
-    def initialize(application)
-      @application = application
-    end
-    def render(logical_path, locals = {})
-      @application.render(logical_path, :partial => true, :locals => locals)
+  def self.app(root)
+    app = Application.new(root)
+    if development?
+      app = Rack::ShowExceptions.new(app)
+    else
+      app = Failsafe.new(app)
     end
+    app
   end
-  class TemplateNotFound < StandardError; end
   def self.camelize(string)
     string.gsub(/(^|_)(\w)/) { $2.upcase }
   end
+  def self.development?
+    ENV["RACK_ENV"] == "development"
+  end
 end

data/lib/brochure/application.rb ADDED Viewed

@@ -0,0 +1,102 @@
+module Brochure
+  class Application
+    attr_reader :app_root, :helper_root, :template_root, :asset_root
+    def initialize(root)
+      @app_root       = File.expand_path(root)
+      @helper_root    = File.join(@app_root, "app", "helpers")
+      @template_root  = File.join(@app_root, "app", "templates")
+      @asset_root     = File.join(@app_root, "public")
+      @template_trail = Hike::Trail.new(@app_root)
+      @template_trail.extensions.replace(Tilt.mappings.keys.sort)
+      @template_trail.paths.push(@template_root)
+      @context_class  = Context.for(helpers)
+      @templates      = {}
+    end
+    def helpers
+      @helpers ||= Dir[File.join(@helper_root, "**", "*.rb")].map do |helper_path|
+        base_name    = helper_path[(@helper_root.length + 1)..-1][/(.*?)\.rb$/, 1]
+        module_names = base_name.split("/").map { |n| Brochure.camelize(n) }
+        load helper_path
+        module_names.inject(Kernel) { |mod, name| mod.const_get(name) }
+      end
+    end
+    def call(env)
+      if forbidden?(env["PATH_INFO"])
+        forbidden
+      elsif template = find_template(env["PATH_INFO"][/[^.]+/])
+        success render_template(template, env)
+      else
+        not_found
+      end
+    end
+    def forbidden?(path)
+      path[".."] || File.basename(path)[/^_/]
+    end
+    def find_template(logical_path)
+      if template_path = find_template_path(logical_path)
+        template_for(template_path)
+      end
+    end
+    def find_partial(logical_path)
+      if template_path = find_partial_path(logical_path)
+        template_for(template_path)
+      end
+    end
+    def find_template_path(logical_path)
+      candidates = [logical_path + ".html", logical_path + "/index.html"]
+      @template_trail.find(*candidates)
+    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")
+    end
+    def template_for(template_path)
+      if Brochure.development?
+        Tilt.new(template_path)
+      else
+        @templates[template_path] ||= Tilt.new(template_path)
+      end
+    end
+    def render_template(template, env, locals = {})
+      context = @context_class.new(self, env)
+      template.render(context, locals)
+    end
+    def respond_with(status, body, content_type = "text/html, charset=utf-8")
+      headers = {
+        "Content-Type"   => content_type,
+        "Content-Length" => body.length.to_s
+      }
+      [status, headers, [body]]
+    end
+    def success(body)
+      respond_with 200, body
+    end
+    def not_found
+      respond_with 404, <<-HTML
+        <!DOCTYPE html>
+        <html><head><title>Not Found</title></head>
+        <body><h1>404 Not Found</h1></body></html>
+      HTML
+    end
+    def forbidden
+      respond_with 403, "Forbidden"
+    end
+  end
+end

data/lib/brochure/context.rb ADDED Viewed

@@ -0,0 +1,30 @@
+module Brochure
+  class Context
+    include Tilt::CompileSite
+    def self.for(helpers)
+      context = Class.new(self)
+      context.send(:include, *helpers) if helpers.any?
+      context
+    end
+    attr_accessor :application, :env
+    def initialize(application, env)
+      self.application = application
+      self.env = env
+    end
+    def request
+      @_request ||= Rack::Request.new(env)
+    end
+    def render(logical_path, locals = {})
+      if template = @application.find_partial(logical_path)
+        @application.render_template(template, env, locals)
+      else
+        raise TemplateNotFound, "no such template '#{logical_path}'"
+      end
+    end
+  end
+end

data/lib/brochure/errors.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Brochure
+  class TemplateNotFound < StandardError; end
+end

data/lib/brochure/failsafe.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module Brochure
+  class Failsafe
+    def initialize(app)
+      @app = app
+    end
+    def call(env)
+      @app.call(env)
+    rescue Exception => exception
+      backtrace = ["#{exception.class.name}: #{exception}", *exception.backtrace].join("\n  ")
+      env["rack.errors"].puts(backtrace)
+      env["rack.errors"].flush
+      body = <<-HTML
+        <!DOCTYPE html>
+        <html><head><title>Internal Server Error</title></head>
+        <body><h1>500 Internal Server Error</h1></body></html>
+      HTML
+      [500,
+       { "Content-Type"   => "text/html, charset=utf-8",
+         "Content-Length" => Rack::Utils.bytesize(body).to_s },
+       [body]]
+    end
+  end
+end

metadata CHANGED Viewed

@@ -1,41 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: brochure
 version: !ruby/object:Gem::Version
-  hash: 27
+  hash: 23
   prerelease: false
   segments:
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Stephenson
+- Josh Peek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-10-12 00:00:00 -05:00
+date: 2010-10-16 00:00:00 -05:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: hike
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 3
+        hash: 25
         segments:
         - 0
-        version: "0"
+        - 1
+        - 1
+        version: 0.1.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rack
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 23
+        segments:
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: tilt
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 19
+        segments:
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
@@ -45,10 +80,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id004
 description: A Rack application for serving static sites with ERB templates.
 email:
 - sstephenson@gmail.com
+- josh@joshpeek.com
 executables: []
 extensions: []
@@ -56,6 +92,10 @@ extensions: []
 extra_rdoc_files: []
 files:
+- lib/brochure/application.rb
+- lib/brochure/context.rb
+- lib/brochure/errors.rb
+- lib/brochure/failsafe.rb
 - lib/brochure.rb
 - README.md
 - LICENSE