Class: ActiveSupport::SafeBuffer

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

Defined Under Namespace

Classes: SafeConcatError

Constant Summary collapse

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

Constants inherited from String

String::BLANK_RE, String::ENCODED_BLANKS

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, #truncate_bytes, #truncate_words, #underscore, #upcase_first

Constructor Details

#initialize(str = "") ⇒ SafeBuffer

Returns a new instance of SafeBuffer.



172
173
174
175
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 172

def initialize(str = "")
  @html_safe = true
  super
end

Instance Method Details

#%(args) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 225

def %(args)
  case args
  when Hash
    escaped_args = args.transform_values { |arg| explicit_html_escape_interpolated_argument(arg) }
  else
    escaped_args = Array(args).map { |arg| explicit_html_escape_interpolated_argument(arg) }
  end

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

#* ⇒ Object 



218
219
220
221
222
223
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 218

def *(*)
  new_string = super
  new_safe_buffer = new_string.is_a?(SafeBuffer) ? new_string : SafeBuffer.new(new_string)
  new_safe_buffer.instance_variable_set(:@html_safe, @html_safe)
  new_safe_buffer
end

#+(other) ⇒ Object 



214
215
216
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 214

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

#[](*args) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 153

def [](*args)
  if html_safe?
    new_string = super

    return unless new_string

    new_safe_buffer = new_string.is_a?(SafeBuffer) ? new_string : SafeBuffer.new(new_string)
    new_safe_buffer.instance_variable_set :@html_safe, true
    new_safe_buffer
  else
    to_str[*args]
  end
end

#[]=(*args) ⇒ Object 



206
207
208
209
210
211
212
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 206

def []=(*args)
  if args.length == 3
    super(args[0], args[1], implicit_html_escape_interpolated_argument(args[2]))
  else
    super(args[0], implicit_html_escape_interpolated_argument(args[1]))
  end
end

#clone_empty ⇒ Object 



182
183
184
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 182

def clone_empty
  self[0, 0]
end

#concat(value) ⇒ Object Also known as: << 



186
187
188
189
190
191
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 186

def concat(value)
  unless value.nil?
    super(implicit_html_escape_interpolated_argument(value))
  end
  self
end

#encode_with(coder) ⇒ Object 



248
249
250
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 248

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

#html_safe? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 236

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

#initialize_copy(other) ⇒ Object 



177
178
179
180
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 177

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

#insert(index, value) ⇒ Object 



194
195
196
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 194

def insert(index, value)
  super(index, implicit_html_escape_interpolated_argument(value))
end

#prepend(value) ⇒ Object 



198
199
200
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 198

def prepend(value)
  super(implicit_html_escape_interpolated_argument(value))
end

#replace(value) ⇒ Object 



202
203
204
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 202

def replace(value)
  super(implicit_html_escape_interpolated_argument(value))
end

#safe_concat(value) ⇒ Object

Raises:



167
168
169
170
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 167

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

#to_param ⇒ Object 



244
245
246
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 244

def to_param
  to_str
end

#to_s ⇒ Object 



240
241
242
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 240

def to_s
  self
end