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 = 
["capitalize", "chomp", "chop", "delete", "downcase", "gsub", "lstrip", "next", "reverse", "rstrip", "slice", "squeeze", "strip", "sub", "succ", "swapcase", "tr", "tr_s", "upcase", "prepend"].freeze

Instance Method Summary collapse

Methods inherited from String

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

Constructor Details

#initialize ⇒ SafeBuffer

Returns a new instance of SafeBuffer.



117
118
119
120
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 117

def initialize(*)
  @html_safe = true
  super
end

Instance Method Details

#+(other) ⇒ Object 



140
141
142
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 140

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

#[](*args) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 100

def [](*args)
  return super if args.size < 2

  if html_safe?
    new_safe_buffer = super
    new_safe_buffer.instance_eval { @html_safe = true }
    new_safe_buffer
  else
    to_str[*args]
  end
end

#clone_empty ⇒ Object 



127
128
129
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 127

def clone_empty
  self[0, 0]
end

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



131
132
133
134
135
136
137
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 131

def concat(value)
  if !html_safe? || value.html_safe?
    super(value)
  else
    super(ERB::Util.h(value))
  end
end

#encode_with(coder) ⇒ Object 



156
157
158
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 156

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

#html_safe? ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 144

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

#initialize_copy(other) ⇒ Object 



122
123
124
125
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 122

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

#safe_concat(value) ⇒ Object

Raises:



112
113
114
115
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 112

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

#to_param ⇒ Object 



152
153
154
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 152

def to_param
  to_str
end

#to_s ⇒ Object 



148
149
150
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 148

def to_s
  self
end

#to_yaml(*args) ⇒ Object 



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

def to_yaml(*args)
  return super() if defined?(YAML::ENGINE) && !YAML::ENGINE.syck?
  to_str.to_yaml(*args)
end