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 prepend
)

Instance Method Summary collapse

Methods inherited from String

#acts_like_string?, #as_json, #at, #blank?, #camelize, #classify, #constantize, #dasherize, #deconstantize, #demodulize, #encode_json, #encoding_aware?, #exclude?, #first, #foreign_key, #from, #html_safe, #humanize, #in_time_zone, #indent, #indent!, #inquiry, #is_utf8?, #last, #mb_chars, #parameterize, #pluralize, #safe_constantize, #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.



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

def initialize(*)
  @html_safe = true
  super
end

Instance Method Details

#%(args) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 145

def %(args)
  args = Array(args).map do |arg|
    if !html_safe? || arg.html_safe?
      arg
    else
      ERB::Util.h(arg)
    end
  end

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

#+(other) ⇒ Object 



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

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

#[](*args) ⇒ Object 



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

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

#clone_empty ⇒ Object 



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

def clone_empty
  self[0, 0]
end

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



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

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

#encode_with(coder) ⇒ Object 



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

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

#html_safe? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#initialize_copy(other) ⇒ Object 



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

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

#safe_concat(value) ⇒ Object

Raises:



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

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

#to_param ⇒ Object 



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

def to_param
  to_str
end

#to_s ⇒ Object 



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

def to_s
  self
end