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

Constructor Details

#initialize ⇒ SafeBuffer

Returns a new instance of SafeBuffer.



170
171
172
173
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 170

def initialize(*)
  @html_safe = true
  super
end

Instance Method Details

#%(args) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 202

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

#+(other) ⇒ Object 



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

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

#[](*args) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 147

def [](*args)
  if args.size < 2
    super
  else
    if html_safe?
      new_safe_buffer = super

      if new_safe_buffer
        new_safe_buffer.instance_variable_set :@html_safe, true
      end

      new_safe_buffer
    else
      to_str[*args]
    end
  end
end

#clone_empty ⇒ Object 



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

def clone_empty
  self[0, 0]
end

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



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

def concat(value)
  super(html_escape_interpolated_argument(value))
end

#encode_with(coder) ⇒ Object 



225
226
227
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 225

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

#html_safe? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#initialize_copy(other) ⇒ Object 



175
176
177
178
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 175

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

#prepend(value) ⇒ Object 



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

def prepend(value)
  super(html_escape_interpolated_argument(value))
end

#prepend!(value) ⇒ Object 



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

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

#safe_concat(value) ⇒ Object

Raises:



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

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

#to_param ⇒ Object 



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

def to_param
  to_str
end

#to_s ⇒ Object 



217
218
219
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 217

def to_s
  self
end