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 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 Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from String

#acts_like_string?, #as_json, #at, #blank?, #camelize, #classify, #constantize, #dasherize, #deconstantize, #demodulize, #downcase_first, #exclude?, #first, #foreign_key, #from, #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.



70
71
72
73
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 70

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

Instance Attribute Details

#html_safe ⇒ Object (readonly) Also known as: html_safe?

Returns the value of attribute html_safe.



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

def html_safe
  @html_safe
end

Instance Method Details

#%(args) ⇒ Object 



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

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 



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

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 



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

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

#[](*args) ⇒ Object Also known as: slice 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 38

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

    return unless new_string

    string_into_safe_buffer(new_string, true)
  else
    to_str[*args]
  end
end

#[]=(arg1, arg2, arg3 = nil) ⇒ Object 



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

def []=(arg1, arg2, arg3 = nil)
  if arg3
    super(arg1, arg2, implicit_html_escape_interpolated_argument(arg3))
  else
    super(arg1, implicit_html_escape_interpolated_argument(arg2))
  end
end

#bytesplice(*args, value) ⇒ Object 



95
96
97
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 95

def bytesplice(*args, value)
  super(*args, implicit_html_escape_interpolated_argument(value))
end

#chr ⇒ Object 



59
60
61
62
63
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 59

def chr
  return super unless html_safe?

  string_into_safe_buffer(super, true)
end

#clone_empty ⇒ Object

:nodoc:



80
81
82
83
84
85
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 80

def clone_empty # :nodoc:
  ActiveSupport.deprecator.warn <<~EOM
    ActiveSupport::SafeBuffer#clone_empty is deprecated and will be removed in Rails 7.2.
  EOM
  self[0, 0]
end

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



87
88
89
90
91
92
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 87

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

#encode_with(coder) ⇒ Object 



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

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

#initialize_copy(other) ⇒ Object 



75
76
77
78
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 75

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

#insert(index, value) ⇒ Object 



99
100
101
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 99

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

#prepend(value) ⇒ Object 



103
104
105
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 103

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

#replace(value) ⇒ Object 



107
108
109
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 107

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

#safe_concat(value) ⇒ Object

Raises:



65
66
67
68
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 65

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

#slice!(*args) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/active_support/core_ext/string/output_safety.rb', line 51

def slice!(*args)
  new_string = super

  return new_string if !html_safe? || new_string.nil?

  string_into_safe_buffer(new_string, true)
end

#to_param ⇒ Object 



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

def to_param
  to_str
end

#to_s ⇒ Object 



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

def to_s
  self
end