Class: ActiveSupport::SafeBuffer

Inherits:
String show all
Defined in:
activesupport/lib/active_support/core_ext/string/output_safety.rb

Direct Known Subclasses

ActionView::OutputBuffer

Defined Under Namespace

Classes: SafeConcatError

Constant Summary

UNSAFE_STRING_METHODS =
%w(
capitalize chomp chop delete downcase gsub lstrip next reverse rstrip
slice squeeze strip sub succ swapcase tr tr_s upcase

Constants inherited from String

String::BLANK_RE

Instance Method Summary (collapse)

Methods inherited from String

#acts_like_string?, #as_json, #at, #blank?, #camelize, #classify, #constantize, #dasherize, #deconstantize, #demodulize, #exclude?, #first, #foreign_key, #from, #html_safe, #humanize, #in_time_zone, #indent, #indent!, #inquiry, #is_utf8?, #last, #mb_chars, #parameterize, #pluralize, #remove, #remove!, #safe_constantize, #singularize, #squish, #squish!, #strip_heredoc, #tableize, #titleize, #to, #to_date, #to_datetime, #to_time, #truncate, #underscore

Constructor Details

- (SafeBuffer) initialize

Returns a new instance of SafeBuffer



159
160
161
162
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 159

def initialize(*)
  @html_safe = true
  super
end

Instance Method Details

- (Object) %(args)



189
190
191
192
193
194
195
196
197
198
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 189

def %(args)
  case args
  when Hash
    escaped_args = Hash[args.map { |k,arg| [k, html_escape_interpolated_argument(arg)] }]
  else
    escaped_args = Array(args).map { |arg| html_escape_interpolated_argument(arg) }
  end

  self.class.new(super(escaped_args))
end

- (Object) +(other)



185
186
187
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 185

def +(other)
  dup.concat(other)
end

- (Object) [](*args)



140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 140

def [](*args)
  if args.size < 2
    super
  else
    if html_safe?
      new_safe_buffer = super
      new_safe_buffer.instance_eval { @html_safe = true }
      new_safe_buffer
    else
      to_str[*args]
    end
  end
end

- (Object) clone_empty



169
170
171
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 169

def clone_empty
  self[0, 0]
end

- (Object) encode_with(coder)



212
213
214
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 212

def encode_with(coder)
  coder.represent_scalar nil, to_str
end

- (Boolean) html_safe?

Returns:

  • (Boolean)


200
201
202
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 200

def html_safe?
  defined?(@html_safe) && @html_safe
end

- (Object) initialize_copy(other)



164
165
166
167
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 164

def initialize_copy(other)
  super
  @html_safe = other.html_safe?
end

- (Object) prepend!(value)



180
181
182
183
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 180

def prepend!(value)
  ActiveSupport::Deprecation.deprecation_warning "ActiveSupport::SafeBuffer#prepend!", :prepend
  prepend value
end

- (Object) safe_concat(value)

Raises:



154
155
156
157
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 154

def safe_concat(value)
  raise SafeConcatError unless html_safe?
  original_concat(value)
end

- (Object) to_param



208
209
210
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 208

def to_param
  to_str
end

- (Object) to_s



204
205
206
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 204

def to_s
  self
end