1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
# encoding: utf-8
# frozen_string_literal: true
module Mail
module Utilities
LF = "\n"
CRLF = "\r\n"
include Constants
# Returns true if the string supplied is free from characters not allowed as an ATOM
def atom_safe?( str )
not ATOM_UNSAFE === str
end
# If the string supplied has ATOM unsafe characters in it, will return the string quoted
# in double quotes, otherwise returns the string unmodified
def quote_atom( str )
atom_safe?( str ) ? str : dquote(str)
end
# If the string supplied has PHRASE unsafe characters in it, will return the string quoted
# in double quotes, otherwise returns the string unmodified
def quote_phrase( str )
if RUBY_VERSION >= '1.9'
original_encoding = str.encoding
ascii_str = str.dup.force_encoding('ASCII-8BIT')
if (PHRASE_UNSAFE === ascii_str)
dquote(ascii_str).force_encoding(original_encoding)
else
str
end
else
(PHRASE_UNSAFE === str) ? dquote(str) : str
end
end
# Returns true if the string supplied is free from characters not allowed as a TOKEN
def token_safe?( str )
not TOKEN_UNSAFE === str
end
# If the string supplied has TOKEN unsafe characters in it, will return the string quoted
# in double quotes, otherwise returns the string unmodified
def quote_token( str )
token_safe?( str ) ? str : dquote(str)
end
# Wraps supplied string in double quotes and applies \-escaping as necessary,
# unless it is already wrapped.
#
# Example:
#
# string = 'This is a string'
# dquote(string) #=> '"This is a string"'
#
# string = 'This is "a string"'
# dquote(string #=> '"This is \"a string\"'
def dquote( str )
'"' + unquote(str).gsub(/[\\"]/n) {|s| '\\' + s } + '"'
end
# Unwraps supplied string from inside double quotes and
# removes any \-escaping.
#
# Example:
#
# string = '"This is a string"'
# unquote(string) #=> 'This is a string'
#
# string = '"This is \"a string\""'
# unqoute(string) #=> 'This is "a string"'
def unquote( str )
if str =~ /^"(.*?)"$/
$1.gsub(/\\(.)/, '\1')
else
str
end
end
# Wraps a string in parenthesis and escapes any that are in the string itself.
#
# Example:
#
# paren( 'This is a string' ) #=> '(This is a string)'
def paren( str )
RubyVer.paren( str )
end
# Unwraps a string from being wrapped in parenthesis
#
# Example:
#
# str = '(This is a string)'
# unparen( str ) #=> 'This is a string'
def unparen( str )
match = str.match(/^\((.*?)\)$/)
match ? match[1] : str
end
# Wraps a string in angle brackets and escapes any that are in the string itself
#
# Example:
#
# bracket( 'This is a string' ) #=> '<This is a string>'
def bracket( str )
RubyVer.bracket( str )
end
# Unwraps a string from being wrapped in parenthesis
#
# Example:
#
# str = '<This is a string>'
# unbracket( str ) #=> 'This is a string'
def unbracket( str )
match = str.match(/^\<(.*?)\>$/)
match ? match[1] : str
end
# Escape parenthesies in a string
#
# Example:
#
# str = 'This is (a) string'
# escape_paren( str ) #=> 'This is \(a\) string'
def escape_paren( str )
RubyVer.escape_paren( str )
end
def uri_escape( str )
uri_parser.escape(str)
end
def uri_unescape( str )
uri_parser.unescape(str)
end
def uri_parser
@uri_parser ||= URI.const_defined?(:Parser) ? URI::Parser.new : URI
end
# Matches two objects with their to_s values case insensitively
#
# Example:
#
# obj2 = "This_is_An_object"
# obj1 = :this_IS_an_object
# match_to_s( obj1, obj2 ) #=> true
def match_to_s( obj1, obj2 )
obj1.to_s.casecmp(obj2.to_s) == 0
end
# Capitalizes a string that is joined by hyphens correctly.
#
# Example:
#
# string = 'resent-from-field'
# capitalize_field( string ) #=> 'Resent-From-Field'
def capitalize_field( str )
str.to_s.split("-").map { |v| v.capitalize }.join("-")
end
# Takes an underscored word and turns it into a class name
#
# Example:
#
# constantize("hello") #=> "Hello"
# constantize("hello-there") #=> "HelloThere"
# constantize("hello-there-mate") #=> "HelloThereMate"
def constantize( str )
str.to_s.split(/[-_]/).map { |v| v.capitalize }.to_s
end
# Swaps out all underscores (_) for hyphens (-) good for stringing from symbols
# a field name.
#
# Example:
#
# string = :resent_from_field
# dasherize ( string ) #=> 'resent_from_field'
def dasherize( str )
str.to_s.tr(UNDERSCORE, HYPHEN)
end
# Swaps out all hyphens (-) for underscores (_) good for stringing to symbols
# a field name.
#
# Example:
#
# string = :resent_from_field
# underscoreize ( string ) #=> 'resent_from_field'
def underscoreize( str )
str.to_s.downcase.tr(HYPHEN, UNDERSCORE)
end
if RUBY_VERSION <= '1.8.6'
def map_lines( str, &block )
results = []
str.each_line do |line|
results << yield(line)
end
results
end
def map_with_index( enum, &block )
results = []
enum.each_with_index do |token, i|
results[i] = yield(token, i)
end
results
end
else
def map_lines( str, &block )
str.each_line.map(&block)
end
def map_with_index( enum, &block )
enum.each_with_index.map(&block)
end
end
# Test String#encode works correctly with line endings.
# Some versions of Ruby (e.g. MRI <1.9, JRuby, Rubinius) line ending
# normalization does not work correctly or did not have #encode.
if ("\r".encode(:universal_newline => true) rescue nil) == LF &&
(LF.encode(:crlf_newline => true) rescue nil) == CRLF
# Using String#encode is better performing than Regexp
def self.to_lf(input)
input.kind_of?(String) ? input.to_str.encode(input.encoding, :universal_newline => true) : ''
end
def self.to_crlf(input)
input.kind_of?(String) ? input.to_str.encode(input.encoding, :universal_newline => true).encode!(input.encoding, :crlf_newline => true) : ''
end
else
def self.to_lf(input)
input.kind_of?(String) ? input.to_str.gsub(/\r\n|\r/, LF) : ''
end
if RUBY_VERSION >= '1.9'
# This 1.9 only regex can save a reasonable amount of time (~20%)
# by not matching "\r\n" so the string is returned unchanged in
# the common case.
CRLF_REGEX = Regexp.new("(?<!\r)\n|\r(?!\n)")
else
CRLF_REGEX = /\n|\r\n|\r/
end
def self.to_crlf(input)
input.kind_of?(String) ? input.to_str.gsub(CRLF_REGEX, CRLF) : ''
end
end
# Returns true if the object is considered blank.
# A blank includes things like '', ' ', nil,
# and arrays and hashes that have nothing in them.
#
# This logic is mostly shared with ActiveSupport's blank?
def self.blank?(value)
if value.kind_of?(NilClass)
true
elsif value.kind_of?(String)
value !~ /\S/
else
value.respond_to?(:empty?) ? value.empty? : !value
end
end
end
end
|