Module: Sinatra::RespondTo

Defined in:
lib/sinatra/respond_to.rb

Defined Under Namespace

Modules: Helpers Classes: MissingTemplate, UnhandledFormat

Constant Summary collapse

TEXT_MIME_TYPES = 
[:txt, :html, :js, :json, :xml, :rss, :atom, :css, :asm, :c, :cc, :conf,
:csv, :cxx, :diff, :dtd, :f, :f77, :f90, :for, :gemspec, :h, :hh, :htm,
:log, :mathml, :mml, :p, :pas, :pl, :pm, :py, :rake, :rb, :rdf, :rtf, :ru,
:s, :sgm, :sgml, :sh, :svg, :svgz, :text, :wsdl, :xhtml, :xsl, :xslt, :yaml,
:yml, :ics]

Class Method Summary collapse

Class Method Details

.registered(app) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/sinatra/respond_to.rb', line 25

def self.registered(app)
  app.helpers RespondTo::Helpers

  app.set :default_charset, 'utf-8' unless app.respond_to?(:default_charset)
  app.set :default_content, :html unless app.respond_to?(:default_content)
  app.set :assume_xhr_is_js, true unless app.respond_to?(:assume_xhr_is_js)

  # We remove the trailing extension so routes
  # don't have to be of the style
  #
  #   get '/resouce.:format'
  #
  # They can instead be of the style
  #
  #   get '/resource'
  #
  # and the format will automatically be available in as <tt>format</tt>
  app.before do
    unless options.static? && options.public? && ["GET", "HEAD"].include?(request.request_method) && static_file?(request.path_info)
      request.path_info.gsub! %r{\.([^\./]+)$}, ''
      format $1 || options.default_content

      # For the oh so common case of actually wanting Javascript from an XmlHttpRequest
      format :js if request.xhr? && options.assume_xhr_is_js?

      charset options.default_charset if TEXT_MIME_TYPES.include? format
    end
  end

  # Replace all routes that have an ending extension with one that doesn't
  # Most generally a fix for the __sinatra__ routes in development
  # app.routes.each_pair do |verb, subroutes|
  #   subroutes.each do |subroute|
  #     subroute[0] = Regexp.new(subroute[0].source.gsub(/\\\.[^\.\/]+\$$/, '$'))
  #   end
  # end

 app.configure :development do
    # Very, very, very hackish but only for development at least
    # Modifies the regex matching /__sinatra__/:image.png to not have the extension
    ["GET", "HEAD"].each do |verb|
      app.routes[verb][1][0] = Regexp.new(app.routes[verb][1][0].source.gsub(/\\\.[^\.\/]+\$$/, '$'))
    end

    app.error UnhandledFormat do
      content_type :html, :charset => 'utf-8'

      (<<-HTML).gsub(/^ {10}/, '')
      <!DOCTYPE html>
      <html>
      <head>
        <style type="text/css">
        body { text-align:center;font-family:helvetica,arial;font-size:22px;
          color:#888;margin:20px}
        #c {margin:0 auto;width:500px;text-align:left}
        </style>
      </head>
      <body>
        <h2>Sinatra doesn't know this ditty.</h2>
        <img src='/__sinatra__/404.png'>
        <div id="c">
          Try this:
          <pre>#{request.request_method.downcase} '#{request.path_info}' do\n  respond_to do |wants|\n    wants.#{format} { "Hello World" }\n  end\nend</pre>
        </div>
      </body>
      </html>
      HTML
    end

    app.error MissingTemplate do
      content_type :html, :charset => 'utf-8'
      response.status = 500 # If I can find out how to reference the error code from the exception, I would

      engine = request.env['sinatra.error'].message[/\.([^\.]+)$/, 1]
      engine = 'haml' unless ['haml', 'builder', 'erb'].include? engine
      
      path = request.path_info[/([^\/]+)$/, 1]
      path = "root" if path.nil? || path.empty?
      
      format = engine == 'builder' ? 'xml' : 'html'
      
      layout = case engine
               when 'haml' then "!!!\n%html\n  %body= yield"
               when 'erb' then "<html>\n  <body>\n    <%= yield %>\n  </body>\n</html>"
               when 'builder' then "builder do |xml|\n  xml << yield\nend"
               end

      layout = "<small>app.#{format}.#{engine}</small>\n<pre>#{escape_html(layout)}</pre>"

      (<<-HTML).gsub(/^ {10}/, '')
      <!DOCTYPE html>
      <html>
      <head>
        <style type="text/css">
        body { text-align:center;font-family:helvetica,arial;font-size:22px;
          color:#888;margin:20px}
        #c {margin:0 auto;width:500px;text-align:left;}
        small {float:right;clear:both;}
        pre {clear:both;}
        </style>
      </head>
      <body>
        <h2>Sinatra can't find #{request.env['sinatra.error'].message}</h2>
        <img src='/__sinatra__/500.png'>
        <div id="c">
          Try this:<br />
          #{layout if layout}
          <small>#{path}.#{format}.#{engine}</small>
          <pre>Hello World!</pre>
          <small>application.rb</small>
          <pre>#{request.request_method.downcase} '#{request.path_info}' do\n  respond_to do |wants|\n    wants.#{engine == 'builder' ? 'xml' : 'html'} { #{engine} :#{path}#{",\n#{' '*32}layout => :app" if layout} }\n  end\nend</pre>
        </div>
      </body>
      </html>
      HTML
    end

  end

  app.class_eval do
    private
      def render_with_format(*args)
        args[1] = "#{args[1]}.#{format}".to_sym if args[1].is_a?(::Symbol)
        render_without_format *args
      rescue Errno::ENOENT
        raise MissingTemplate, "#{args[1]}.#{args[0]}"
      end
      alias_method :render_without_format, :render
      alias_method :render, :render_with_format

      def lookup_layout_with_format(*args)
        args[1] = "#{args[1]}.#{format}".to_sym if args
        lookup_layout_without_format *args
      end
      alias_method :lookup_layout_without_format, :lookup_layout
      alias_method :lookup_layout, :lookup_layout_with_format
  end
end