Class: Utopia::Controller::Base
- Inherits:
-
Object
- Object
- Utopia::Controller::Base
- Defined in:
- lib/utopia/controller/base.rb
Overview
The base implementation of a controller class.
Constant Summary collapse
- URI_PATH =
nil
- BASE_PATH =
nil
- CONTROLLER =
nil
Class Method Summary collapse
-
.base_path ⇒ Object
A string which is the full path to the directory which contains the controller.
-
.controller ⇒ Object
The controller middleware itself.
- .direct?(path) ⇒ Boolean
- .freeze ⇒ Object
- .inspect ⇒ Object
- .to_s ⇒ Object
-
.uri_path ⇒ Object
A relative path to the controller directory relative to the controller root directory.
Instance Method Summary collapse
-
#body_for(status, headers, options) ⇒ Object
Generate the body for the given status, headers and options.
-
#call(env) ⇒ Object
Call into the next app as defined by rack.
- #catch_response ⇒ Object
-
#copy_instance_variables(from) ⇒ Object
Copy the instance variables from the previous controller to the next controller (usually only a few).
-
#fail!(error = 400, message = nil) ⇒ Object
Respond with an error which indiciates some kind of failure.
-
#goto!(target, status = 302) ⇒ Object
Controller relative redirect.
-
#ignore! ⇒ Object
This will cause the controller middleware to pass on the request.
- #inspect ⇒ Object
-
#process!(request, relative_path) ⇒ Object
Return nil if this controller didn’t do anything.
-
#redirect!(target, status = 302) ⇒ Object
Request relative redirect.
-
#respond!(response) ⇒ Object
This will cause the middleware to generate a response.
-
#respond?(response) ⇒ Boolean
Respond with the response, but only if it’s not nil.
-
#succeed!(status: 200, headers: {}, type: nil, **options) ⇒ Object
Succeed the request and immediately respond.
- #to_s ⇒ Object
Class Method Details
.base_path ⇒ Object
A string which is the full path to the directory which contains the controller.
36 37 38 |
# File 'lib/utopia/controller/base.rb', line 36 def self.base_path self.const_get(:BASE_PATH) end |
.controller ⇒ Object
The controller middleware itself.
46 47 48 |
# File 'lib/utopia/controller/base.rb', line 46 def self.controller self.const_get(:CONTROLLER) end |
.direct?(path) ⇒ Boolean
78 79 80 |
# File 'lib/utopia/controller/base.rb', line 78 def direct?(path) path.dirname == uri_path end |
.freeze ⇒ Object
69 70 71 72 73 74 75 76 |
# File 'lib/utopia/controller/base.rb', line 69 def freeze # This ensures that all class variables are frozen. self.instance_variables.each do |name| self.instance_variable_get(name).freeze end super end |
.inspect ⇒ Object
50 51 52 |
# File 'lib/utopia/controller/base.rb', line 50 def self.inspect "#{super}#{self.uri_path}" end |
.to_s ⇒ Object
54 55 56 |
# File 'lib/utopia/controller/base.rb', line 54 def self.to_s self.inspect end |
.uri_path ⇒ Object
A relative path to the controller directory relative to the controller root directory.
41 42 43 |
# File 'lib/utopia/controller/base.rb', line 41 def self.uri_path self.const_get(:URI_PATH) end |
Instance Method Details
#body_for(status, headers, options) ⇒ Object
Generate the body for the given status, headers and options.
155 156 157 158 159 160 161 |
# File 'lib/utopia/controller/base.rb', line 155 def body_for(status, headers, ) if body = [:body] return body elsif content = [:content] return [content] end end |
#call(env) ⇒ Object
Call into the next app as defined by rack.
102 103 104 |
# File 'lib/utopia/controller/base.rb', line 102 def call(env) self.class.controller.app.call(env) end |
#catch_response ⇒ Object
83 84 85 86 87 |
# File 'lib/utopia/controller/base.rb', line 83 def catch_response catch(:response) do yield and nil end end |
#copy_instance_variables(from) ⇒ Object
Copy the instance variables from the previous controller to the next controller (usually only a few). This allows controllers to share effectively the same instance variables while still being separate classes/instances.
95 96 97 98 99 |
# File 'lib/utopia/controller/base.rb', line 95 def copy_instance_variables(from) from.instance_variables.each do |name| self.instance_variable_set(name, from.instance_variable_get(name)) end end |
#fail!(error = 400, message = nil) ⇒ Object
Respond with an error which indiciates some kind of failure.
135 136 137 138 139 140 |
# File 'lib/utopia/controller/base.rb', line 135 def fail!(error = 400, = nil) status = HTTP::Status.new(error, 400...600) ||= status.to_s respond! [status.to_i, {}, []] end |
#goto!(target, status = 302) ⇒ Object
Controller relative redirect.
130 131 132 |
# File 'lib/utopia/controller/base.rb', line 130 def goto!(target, status = 302) redirect! self.class.uri_path + target end |
#ignore! ⇒ Object
This will cause the controller middleware to pass on the request.
117 118 119 |
# File 'lib/utopia/controller/base.rb', line 117 def ignore! throw :response, nil end |
#inspect ⇒ Object
62 63 64 65 66 |
# File 'lib/utopia/controller/base.rb', line 62 def inspect details = self.instance_variables.map{|name| " #{name}=#{self.instance_variable_get(name)}"} "\#<#{self.class}#{details.join}>" end |
#process!(request, relative_path) ⇒ Object
Return nil if this controller didn’t do anything. Request will keep on processing. Return a valid rack response if the controller can do so.
90 91 92 |
# File 'lib/utopia/controller/base.rb', line 90 def process!(request, relative_path) return nil end |
#redirect!(target, status = 302) ⇒ Object
Request relative redirect. Respond with a redirect to the given target.
122 123 124 125 126 127 |
# File 'lib/utopia/controller/base.rb', line 122 def redirect!(target, status = 302) status = HTTP::Status.new(status, 300...400) location = target.to_s respond! [status.to_i, {HTTP::LOCATION => location}, [status.to_s]] end |
#respond!(response) ⇒ Object
This will cause the middleware to generate a response.
107 108 109 |
# File 'lib/utopia/controller/base.rb', line 107 def respond!(response) throw :response, response end |
#respond?(response) ⇒ Boolean
Respond with the response, but only if it’s not nil.
112 113 114 |
# File 'lib/utopia/controller/base.rb', line 112 def respond?(response) respond!(response) if response end |
#succeed!(status: 200, headers: {}, type: nil, **options) ⇒ Object
Succeed the request and immediately respond.
143 144 145 146 147 148 149 150 151 152 |
# File 'lib/utopia/controller/base.rb', line 143 def succeed!(status: 200, headers: {}, type: nil, **) status = HTTP::Status.new(status, 200...300) if type headers[CONTENT_TYPE] = type.to_s end body = body_for(status, headers, ) respond! [status.to_i, headers, body || []] end |
#to_s ⇒ Object
58 59 60 |
# File 'lib/utopia/controller/base.rb', line 58 def to_s "\#<#{self.class}>" end |