Class: Sinatra::Base

Inherits:
Object
  • Object
show all
Includes:
Rack::Utils, Helpers, Templates
Defined in:
lib/sinatra/base.rb

Overview

Base class for all Sinatra applications and middleware.

Direct Known Subclasses

Application

Constant Summary collapse

CALLERS_TO_IGNORE =

:nodoc:

[ # :nodoc:
  /\/sinatra(\/(base|main|showexceptions))?\.rb$/, # all sinatra code
  /lib\/tilt.*\.rb$/,                              # all tilt code
  /^\(.*\)$/,                                      # generated code
  /rubygems\/custom_require\.rb$/,                 # rubygems require hacks
  /active_support/,                                # active_support require hacks
  /bundler(\/runtime)?\.rb/,                       # bundler require hacks
  /<internal:/,                                    # internal in ruby >= 1.9.2
  /src\/kernel\/bootstrap\/[A-Z]/                  # maglev kernel files
]

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Templates

#builder, #coffee, #creole, #erb, #erubis, #find_template, #haml, #less, #liquid, #markaby, #markdown, #nokogiri, #radius, #rdoc, #sass, #scss, #slim, #textile

Methods included from Helpers

#attachment, #back, #body, #cache_control, #client_error?, #content_type, #error, #etag, #expires, #headers, #informational?, #last_modified, #logger, #mime_type, #not_found, #not_found?, #redirect, #redirect?, #send_file, #server_error?, #session, #status, #stream, #success?, #time_for, #uri

Constructor Details

#initialize(app = nil) {|_self| ... } ⇒ Base

Returns a new instance of Base.

Yields:

  • (_self)

Yield Parameters:

  • _self (Sinatra::Base) —

    the object that the method was called on



683
684
685
686
687
688
 
# File 'lib/sinatra/base.rb', line 683

def initialize(app=nil)
  super()
  @app = app
  @template_cache = Tilt::Cache.new
  yield self if block_given?
end

Class Attribute Details

.errors ⇒ Object (readonly)

Returns the value of attribute errors.



932
933
934
 
# File 'lib/sinatra/base.rb', line 932

def errors
  @errors
end

.filters ⇒ Object (readonly)

Returns the value of attribute filters.



932
933
934
 
# File 'lib/sinatra/base.rb', line 932

def filters
  @filters
end

.routes ⇒ Object (readonly)

Returns the value of attribute routes.



932
933
934
 
# File 'lib/sinatra/base.rb', line 932

def routes
  @routes
end

.templates ⇒ Object (readonly)

Returns the value of attribute templates.



932
933
934
 
# File 'lib/sinatra/base.rb', line 932

def templates
  @templates
end

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



680
681
682
 
# File 'lib/sinatra/base.rb', line 680

def app
  @app
end

#env ⇒ Object

Returns the value of attribute env.



695
696
697
 
# File 'lib/sinatra/base.rb', line 695

def env
  @env
end

#params ⇒ Object

Returns the value of attribute params.



695
696
697
 
# File 'lib/sinatra/base.rb', line 695

def params
  @params
end

#request ⇒ Object

Returns the value of attribute request.



695
696
697
 
# File 'lib/sinatra/base.rb', line 695

def request
  @request
end

#response ⇒ Object

Returns the value of attribute response.



695
696
697
 
# File 'lib/sinatra/base.rb', line 695

def response
  @response
end

#template_cache ⇒ Object (readonly)

Returns the value of attribute template_cache.



681
682
683
 
# File 'lib/sinatra/base.rb', line 681

def template_cache
  @template_cache
end

Class Method Details

.add_filter(type, path = nil, options = {}, &block) ⇒ Object

add a filter



1113
1114
1115
1116
 
# File 'lib/sinatra/base.rb', line 1113

def add_filter(type, path = nil, options = {}, &block)
  path, options = //, path if path.respond_to?(:each_pair)
  filters[type] << compile!(type, path || //, block, options)
end

.after(path = nil, options = {}, &block) ⇒ Object

Define an after filter; runs after all requests within the same context as route handlers and may access/modify the request and response.



1108
1109
1110
 
# File 'lib/sinatra/base.rb', line 1108

def after(path = nil, options = {}, &block)
  add_filter(:after, path, options, &block)
end

.before(path = nil, options = {}, &block) ⇒ Object

Define a before filter; runs before all requests within the same context as route handlers and may access/modify the request and response.



1101
1102
1103
 
# File 'lib/sinatra/base.rb', line 1101

def before(path = nil, options = {}, &block)
  add_filter(:before, path, options, &block)
end

.build(builder, *args, &bk) ⇒ Object

Creates a Rack::Builder instance with all the middleware set up and an instance of this class as end point.



1326
1327
1328
1329
1330
1331
 
# File 'lib/sinatra/base.rb', line 1326

def build(builder, *args, &bk)
  setup_default_middleware builder
  setup_middleware builder
  builder.run new!(*args, &bk)
  builder
end

.call(env) ⇒ Object 



1333
1334
1335
 
# File 'lib/sinatra/base.rb', line 1333

def call(env)
  synchronize { prototype.call(env) }
end

.caller_files ⇒ Object

Like Kernel#caller but excluding certain magic entries and without line / method information; the resulting array contains filenames only.



1424
1425
1426
 
# File 'lib/sinatra/base.rb', line 1424

def caller_files
  cleaned_caller(1).flatten
end

.caller_locations ⇒ Object

Like caller_files, but containing Arrays rather than strings with the first element being the file, and the second being the line.



1430
1431
1432
 
# File 'lib/sinatra/base.rb', line 1430

def caller_locations
  cleaned_caller 2
end

.condition(name = "#{caller.first[/`.*'/]} condition", &block) ⇒ Object

Add a route condition. The route is considered non-matching when the block returns false.



1120
1121
1122
 
# File 'lib/sinatra/base.rb', line 1120

def condition(name = "#{caller.first[/`.*'/]} condition", &block)
  @conditions << generate_method(name, &block)
end

.configure(*envs) {|_self| ... } ⇒ Object

Set configuration options for Sinatra and/or the app. Allows scoping of settings for certain environments.

Yields:

  • (_self)

Yield Parameters:

  • _self (Sinatra::Base) —

    the object that the method was called on



1272
1273
1274
 
# File 'lib/sinatra/base.rb', line 1272

def configure(*envs, &block)
  yield self if envs.empty? || envs.include?(environment.to_sym)
end

.delete(path, opts = {}, &bk) ⇒ Object 



1176
 
# File 'lib/sinatra/base.rb', line 1176

def delete(path, opts={}, &bk)  route 'DELETE',  path, opts, &bk end

.development? ⇒ Boolean

Returns:

  • (Boolean) 


1266
 
# File 'lib/sinatra/base.rb', line 1266

def development?; environment == :development end

.disable(*opts) ⇒ Object

Same as calling ‘set :option, false` for each of the given options.



1019
1020
1021
 
# File 'lib/sinatra/base.rb', line 1019

def disable(*opts)
  opts.each { |key| set(key, false) }
end

.enable(*opts) ⇒ Object

Same as calling ‘set :option, true` for each of the given options.



1014
1015
1016
 
# File 'lib/sinatra/base.rb', line 1014

def enable(*opts)
  opts.each { |key| set(key, true) }
end

.error(*codes, &block) ⇒ Object

Define a custom error handler. Optionally takes either an Exception class, or an HTTP status code to specify which errors should be handled.



1026
1027
1028
1029
1030
1031
 
# File 'lib/sinatra/base.rb', line 1026

def error(*codes, &block)
  args  = compile! "ERROR", //, block
  codes = codes.map { |c| Array(c) }.flatten
  codes << Exception if codes.empty?
  codes.each { |c| @errors[c] = args }
end

.extensions ⇒ Object

Extension modules registered on this class and all superclasses.



953
954
955
956
957
958
959
 
# File 'lib/sinatra/base.rb', line 953

def extensions
  if superclass.respond_to?(:extensions)
    (@extensions + superclass.extensions).uniq
  else
    @extensions
  end
end

.get(path, opts = {}, &block) ⇒ Object

Defining a ‘GET` handler also automatically defines a `HEAD` handler.



1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/sinatra/base.rb', line 1166

def get(path, opts={}, &block)
  conditions = @conditions.dup
  route('GET', path, opts, &block)

  @conditions = conditions
  route('HEAD', path, opts, &block)
end

.head(path, opts = {}, &bk) ⇒ Object 



1177
 
# File 'lib/sinatra/base.rb', line 1177

def head(path, opts={}, &bk)    route 'HEAD',    path, opts, &bk end

.helpers(*extensions, &block) ⇒ Object

Makes the methods defined in the block and in the Modules given in ‘extensions` available to the handlers and templates



1250
1251
1252
1253
 
# File 'lib/sinatra/base.rb', line 1250

def helpers(*extensions, &block)
  class_eval(&block)   if block_given?
  include(*extensions) if extensions.any?
end

.inline_templates=(file = nil) ⇒ Object

Load embeded templates from the file; uses the caller’s __FILE__ when no file is specified.



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/sinatra/base.rb', line 1051

def inline_templates=(file=nil)
  file = (file.nil? || file == true) ? (caller_files.first || File.expand_path($0)) : file

  begin
    io = ::IO.respond_to?(:binread) ? ::IO.binread(file) : ::IO.read(file)
    app, data = io.gsub("\r\n", "\n").split(/^__END__$/, 2)
  rescue Errno::ENOENT
    app, data = nil
  end

  if data
    if app and app =~ /([^\n]*\n)?#[^\n]*coding: *(\S+)/m
      encoding = $2
    else
      encoding = settings.default_encoding
    end
    lines = app.count("\n") + 1
    template = nil
    force_encoding data, encoding
    data.each_line do |line|
      lines += 1
      if line =~ /^@@\s*(.*\S)\s*$/
        template = force_encoding('', encoding)
        templates[$1.to_sym] = [template, file, lines]
      elsif template
        template << line
      end
    end
  end
end

.layout(name = :layout, &block) ⇒ Object

Define the layout template. The block must return the template source.



1045
1046
1047
 
# File 'lib/sinatra/base.rb', line 1045

def layout(name=:layout, &block)
  template name, &block
end

.middleware ⇒ Object

Middleware used in this class and all superclasses.



962
963
964
965
966
967
968
 
# File 'lib/sinatra/base.rb', line 962

def middleware
  if superclass.respond_to?(:middleware)
    superclass.middleware + @middleware
  else
    @middleware
  end
end

.mime_type(type, value = nil) ⇒ Object

Lookup or register a mime type in Rack’s mime registry.



1083
1084
1085
1086
1087
1088
 
# File 'lib/sinatra/base.rb', line 1083

def mime_type(type, value=nil)
  return type if type.nil? || type.to_s.include?('/')
  type = ".#{type}" unless type.to_s[0] == ?.
  return Rack::Mime.mime_type(type, nil) unless value
  Rack::Mime::MIME_TYPES[type] = value
end

.mime_types(type) ⇒ Object

provides all mime types matching type, including deprecated types:

mime_types :html # => ['text/html']
mime_types :js   # => ['application/javascript', 'text/javascript']



1093
1094
1095
1096
 
# File 'lib/sinatra/base.rb', line 1093

def mime_types(type)
  type = mime_type type
  type =~ /^application\/(xml|javascript)$/ ? [type, "text/#$1"] : [type]
end

.new(*args, &bk) ⇒ Object

Create a new instance of the class fronted by its middleware pipeline. The object is guaranteed to respond to #call but may not be an instance of the class new was called on.



1320
1321
1322
 
# File 'lib/sinatra/base.rb', line 1320

def new(*args, &bk)
  build(Rack::Builder.new, *args, &bk).to_app
end

.not_found(&block) ⇒ Object

Sugar for ‘error(404) { … }`



1034
1035
1036
 
# File 'lib/sinatra/base.rb', line 1034

def not_found(&block)
  error 404, &block
end

.options(path, opts = {}, &bk) ⇒ Object 



1178
 
# File 'lib/sinatra/base.rb', line 1178

def options(path, opts={}, &bk) route 'OPTIONS', path, opts, &bk end

.patch(path, opts = {}, &bk) ⇒ Object 



1179
 
# File 'lib/sinatra/base.rb', line 1179

def patch(path, opts={}, &bk)   route 'PATCH',   path, opts, &bk end

.post(path, opts = {}, &bk) ⇒ Object 



1175
 
# File 'lib/sinatra/base.rb', line 1175

def post(path, opts={}, &bk)    route 'POST',    path, opts, &bk end

.production? ⇒ Boolean

Returns:

  • (Boolean) 


1267
 
# File 'lib/sinatra/base.rb', line 1267

def production?;  environment == :production  end

.prototype ⇒ Object

The prototype instance used to process requests.



1310
1311
1312
 
# File 'lib/sinatra/base.rb', line 1310

def prototype
  @prototype ||= new
end

.public=(value) ⇒ Object 



1124
1125
1126
1127
 
# File 'lib/sinatra/base.rb', line 1124

def public=(value)
  warn ":public is no longer used to avoid overloading Module#public, use :public_folder instead"
  set(:public_folder, value)
end

.put(path, opts = {}, &bk) ⇒ Object 



1174
 
# File 'lib/sinatra/base.rb', line 1174

def put(path, opts={}, &bk)     route 'PUT',     path, opts, &bk end

.quit!(server, handler_name) ⇒ Object 



1282
1283
1284
1285
1286
 
# File 'lib/sinatra/base.rb', line 1282

def quit!(server, handler_name)
  # Use Thin's hard #stop! if available, otherwise just #stop.
  server.respond_to?(:stop!) ? server.stop! : server.stop
  $stderr.puts "\n== Sinatra has ended his set (crowd applauds)" unless handler_name =~/cgi/i
end

.register(*extensions, &block) ⇒ Object

Register an extension. Alternatively take a block from which an extension will be created and registered on the fly.



1257
1258
1259
1260
1261
1262
1263
1264
 
# File 'lib/sinatra/base.rb', line 1257

def register(*extensions, &block)
  extensions << Module.new(&block) if block_given?
  @extensions += extensions
  extensions.each do |extension|
    extend extension
    extension.registered(self) if extension.respond_to?(:registered)
  end
end

.reset! ⇒ Object

Removes all routes, filters, middleware and extension hooks from the current class (not routes/filters/… defined by its superclass).



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/sinatra/base.rb', line 936

def reset!
  @conditions     = []
  @routes         = {}
  @filters        = {:before => [], :after => []}
  @errors         = {}
  @middleware     = []
  @prototype      = nil
  @extensions     = []

  if superclass.respond_to?(:templates)
    @templates = Hash.new { |hash,key| superclass.templates[key] }
  else
    @templates = {}
  end
end

.run!(options = {}) ⇒ Object

Run the Sinatra app as a self-hosted server using Thin, Mongrel or WEBrick (in that order). If given a block, will call with the constructed handler once we have taken the stage.



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/sinatra/base.rb', line 1291

def run!(options={})
  set options
  handler      = detect_rack_handler
  handler_name = handler.name.gsub(/.*::/, '')
  handler.run self, :Host => bind, :Port => port do |server|
    unless handler_name =~ /cgi/i
      $stderr.puts "== Sinatra/#{Sinatra::VERSION} has taken the stage " +
      "on #{port} for #{environment} with backup from #{handler_name}"
    end
    [:INT, :TERM].each { |sig| trap(sig) { quit!(server, handler_name) } }
    server.threaded = settings.threaded if server.respond_to? :threaded=
    set :running, true
    yield server if block_given?
  end
rescue Errno::EADDRINUSE => e
  $stderr.puts "== Someone is already performing on port #{port}!"
end

.set(option, value = (not_set = true), ignore_setter = false, &block) ⇒ Object

Sets an option to the given value. If the value is a proc, the proc will be called every time the option is accessed.

Raises:

  • (ArgumentError) 


972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'lib/sinatra/base.rb', line 972

def set(option, value = (not_set = true), ignore_setter = false, &block)
  raise ArgumentError if block and !not_set
  value, not_set = block, false if block

  if not_set
    raise ArgumentError unless option.respond_to?(:each)
    option.each { |k,v| set(k, v) }
    return self
  end

  if respond_to?("#{option}=") and not ignore_setter
    return __send__("#{option}=", value)
  end

  setter = proc { |val| set option, val, true }
  getter = proc { value }

  case value
  when Proc
    getter = value
  when Symbol, Fixnum, FalseClass, TrueClass, NilClass
    # we have a lot of enable and disable calls, let's optimize those
    class_eval "def self.#{option}() #{value.inspect} end"
    getter = nil
  when Hash
    setter = proc do |val|
      val = value.merge val if Hash === val
      set option, val, true
    end
  end

  (class << self; self; end).class_eval do
    define_method("#{option}=", &setter) if setter
    define_method(option,       &getter) if getter
    unless method_defined? "#{option}?"
      class_eval "def #{option}?() !!#{option} end"
    end
  end
  self
end

.settings ⇒ Object

Access settings defined with Base.set.



721
722
723
 
# File 'lib/sinatra/base.rb', line 721

def self.settings
  self
end

.template(name, &block) ⇒ Object

Define a named template. The block must return the template source.



1039
1040
1041
1042
 
# File 'lib/sinatra/base.rb', line 1039

def template(name, &block)
  filename, line = caller_locations.first
  templates[name] = [block, filename, line.to_i]
end

.test? ⇒ Boolean

Returns:

  • (Boolean) 


1268
 
# File 'lib/sinatra/base.rb', line 1268

def test?;        environment == :test        end

.use(middleware, *args, &block) ⇒ Object

Use the specified Rack middleware



1277
1278
1279
1280
 
# File 'lib/sinatra/base.rb', line 1277

def use(middleware, *args, &block)
  @prototype = nil
  @middleware << [middleware, args, block]
end

Instance Method Details

#call(env) ⇒ Object

Rack call interface.



691
692
693
 
# File 'lib/sinatra/base.rb', line 691

def call(env)
  dup.call!(env)
end

#call!(env) ⇒ Object

:nodoc:



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/sinatra/base.rb', line 697

def call!(env) # :nodoc:
  @env      = env
  @request  = Request.new(env)
  @response = Response.new
  @params   = indifferent_params(@request.params)
  template_cache.clear if settings.reload_templates
  force_encoding(@params)

  @response['Content-Type'] = nil
  invoke { dispatch! }
  invoke { error_block!(response.status) }

  unless @response['Content-Type']
    if Array === body and body[0].respond_to? :content_type
      content_type body[0].content_type
    else
      content_type :html
    end
  end

  @response.finish
end

#forward ⇒ Object

Forward the request to the downstream app – middleware only.



751
752
753
754
755
756
757
758
 
# File 'lib/sinatra/base.rb', line 751

def forward
  fail "downstream app not set" unless @app.respond_to? :call
  status, headers, body = @app.call env
  @response.status = status
  @response.body = body
  @response.headers.merge! headers
  nil
end

#halt(*response) ⇒ Object

Exit the current block, halts any further processing of the request, and returns the specified response.



738
739
740
741
 
# File 'lib/sinatra/base.rb', line 738

def halt(*response)
  response = response.first if response.length == 1
  throw :halt, response
end

#new! ⇒ Object

Create a new instance without middleware in front of it.



1315
 
# File 'lib/sinatra/base.rb', line 1315

alias new! new

#options ⇒ Object 



730
731
732
733
734
 
# File 'lib/sinatra/base.rb', line 730

def options
  warn "Sinatra::Base#options is deprecated and will be removed, " \
    "use #settings instead."
  settings
end

#pass(&block) ⇒ Object

Pass control to the next matching route. If there are no more matching routes, Sinatra will return a 404 response.



746
747
748
 
# File 'lib/sinatra/base.rb', line 746

def pass(&block)
  throw :pass, block
end

#settings ⇒ Object

Access settings defined with Base.set.



726
727
728
 
# File 'lib/sinatra/base.rb', line 726

def settings
  self.class.settings
end