Class: String

Inherits:
Object
  • Object
show all
Defined in:
lib/lucky_case/string.rb

Overview

LuckyCase version to add methods directly to string by monkey patching

can be included this way by
require 'lucky_case/string'

Instance Method Summary collapse

Instance Method Details

#camel_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into camel case

Examples:

conversion

'this-isAnExample_string' => 'thisIsAnExampleString'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



210
211
212
# File 'lib/lucky_case/string.rb', line 210

def camel_case(preserve_prefixed_underscores: true)
  LuckyCase.camel_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#camel_case!(preserve_prefixed_underscores: true) ⇒ Object



214
215
216
# File 'lib/lucky_case/string.rb', line 214

def camel_case!(preserve_prefixed_underscores: true)
  set_self_value self.camel_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#camel_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is camel case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


222
223
224
# File 'lib/lucky_case/string.rb', line 222

def camel_case?(allow_prefixed_underscores: true)
  LuckyCase.camel_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#capital(skip_prefixed_underscores: false) ⇒ String

Convert the first character to capital

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:



418
419
420
# File 'lib/lucky_case/string.rb', line 418

def capital(skip_prefixed_underscores: false)
  LuckyCase.capitalize self, skip_prefixed_underscores: skip_prefixed_underscores
end

#capital!(skip_prefixed_underscores: false) ⇒ Object



430
431
432
# File 'lib/lucky_case/string.rb', line 430

def capital!(skip_prefixed_underscores: false)
  set_self_value self.capitalize skip_prefixed_underscores: skip_prefixed_underscores
end

#capital?(skip_prefixed_underscores: false) ⇒ Boolean

Check if the strings first character is a capital letter

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:

  • (Boolean)


442
443
444
# File 'lib/lucky_case/string.rb', line 442

def capital?(skip_prefixed_underscores: false)
  LuckyCase.capital? self, skip_prefixed_underscores: skip_prefixed_underscores
end

#capital_word_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into capital word case

Examples:

conversion

'this-isAnExample_string' => 'This Is An Example String'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



366
367
368
# File 'lib/lucky_case/string.rb', line 366

def capital_word_case(preserve_prefixed_underscores: true)
  LuckyCase.capital_word_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#capital_word_case!(preserve_prefixed_underscores: true) ⇒ Object



370
371
372
# File 'lib/lucky_case/string.rb', line 370

def capital_word_case!(preserve_prefixed_underscores: true)
  set_self_value self.capital_word_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#capital_word_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is capital word case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


378
379
380
# File 'lib/lucky_case/string.rb', line 378

def capital_word_case?(allow_prefixed_underscores: true)
  LuckyCase.capital_word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#capitalize(skip_prefixed_underscores: false) ⇒ String

Convert the first character to capital

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:



426
427
428
# File 'lib/lucky_case/string.rb', line 426

def capitalize(skip_prefixed_underscores: false)
  self.capital skip_prefixed_underscores: skip_prefixed_underscores
end

#capitalize!(skip_prefixed_underscores: false) ⇒ Object



434
435
436
# File 'lib/lucky_case/string.rb', line 434

def capitalize!(skip_prefixed_underscores: false)
  self.capital! skip_prefixed_underscores: skip_prefixed_underscores
end

#capitalized?(skip_prefixed_underscores: false) ⇒ Boolean

Check if the strings first character is a capital letter

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:

  • (Boolean)


450
451
452
# File 'lib/lucky_case/string.rb', line 450

def capitalized?(skip_prefixed_underscores: false)
  self.capital? skip_prefixed_underscores: skip_prefixed_underscores
end

#constantizeConstant

Convert the string from any case into pascal case and casts it into a constant

Examples:

conversion

'this-isAnExample_string' => ThisIsAnExampleString
'this/is_an/example_path' => This::IsAn::ExamplePath

Parameters:

  • preserve_prefixed_underscores (Boolean)

Returns:

  • (Constant)


548
549
550
# File 'lib/lucky_case/string.rb', line 548

def constantize()
  LuckyCase.constantize self
end

#convert_case(case_type, preserve_prefixed_underscores: true) ⇒ String

Convert a string into the given case type

Parameters:

  • case_type (Symbol, String)
  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



51
52
53
# File 'lib/lucky_case/string.rb', line 51

def convert_case(case_type, preserve_prefixed_underscores: true)
  LuckyCase.convert_case self, case_type, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#convert_case!(case_type, preserve_prefixed_underscores: true) ⇒ Object



55
56
57
# File 'lib/lucky_case/string.rb', line 55

def convert_case!(case_type, preserve_prefixed_underscores: true)
  set_self_value self.convert_case(case_type, preserve_prefixed_underscores: preserve_prefixed_underscores)
end

#dash_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into dash case

Examples:

conversion

'this-isAnExample_string' => 'this-is-an-example-string'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



238
239
240
# File 'lib/lucky_case/string.rb', line 238

def dash_case(preserve_prefixed_underscores: true)
  LuckyCase.dash_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#dash_case!(preserve_prefixed_underscores: true) ⇒ Object



242
243
244
# File 'lib/lucky_case/string.rb', line 242

def dash_case!(preserve_prefixed_underscores: true)
  set_self_value self.dash_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#dash_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is dash case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


250
251
252
# File 'lib/lucky_case/string.rb', line 250

def dash_case?(allow_prefixed_underscores: true)
  LuckyCase.dash_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#decapitalize(skip_prefixed_underscores: false) ⇒ String

Convert the first character to lower case

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:



458
459
460
# File 'lib/lucky_case/string.rb', line 458

def decapitalize(skip_prefixed_underscores: false)
  LuckyCase.decapitalize self, skip_prefixed_underscores: skip_prefixed_underscores
end

#decapitalize!(skip_prefixed_underscores: false) ⇒ Object



462
463
464
# File 'lib/lucky_case/string.rb', line 462

def decapitalize!(skip_prefixed_underscores: false)
  set_self_value self.decapitalize skip_prefixed_underscores: skip_prefixed_underscores
end

#decapitalized?(skip_prefixed_underscores: false) ⇒ Boolean

Check if the strings first character is a lower letter

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:

  • (Boolean)


470
471
472
# File 'lib/lucky_case/string.rb', line 470

def decapitalized?(skip_prefixed_underscores: false)
  LuckyCase.decapitalized? self, skip_prefixed_underscores: skip_prefixed_underscores
end

#letter_case(allow_prefixed_underscores: true) ⇒ Symbol?

Get type of case of string (one key of LuckyCase.CASES)

If more than one case matches, the first match wins. Match prio is the order of the regex in LuckyCase.CASES

If you want or need to know all cases, use plural version of this method

If you want to check explicitly for one case, use its check method, e.g. snake_case? for snake_case, etc…

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Symbol, nil)

    symbol of type, nil if no match



24
25
26
# File 'lib/lucky_case/string.rb', line 24

def letter_case(allow_prefixed_underscores: true)
  LuckyCase.case self, allow_prefixed_underscores: allow_prefixed_underscores
end

#letter_cases(allow_prefixed_underscores: true) ⇒ Array<Symbol>?

Get types of cases of string (keys of LuckyCase.CASES)

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Array<Symbol>, nil)

    symbols of types, nil if no one matches



37
38
39
# File 'lib/lucky_case/string.rb', line 37

def letter_cases(allow_prefixed_underscores: true)
  LuckyCase.cases self, allow_prefixed_underscores: allow_prefixed_underscores
end

#lower_caseString

Convert all characters inside the string into lower case

Examples:

conversion

'this-isAnExample_string' => 'this-isanexample_string'

Returns:



103
104
105
# File 'lib/lucky_case/string.rb', line 103

def lower_case()
  LuckyCase.lower_case self
end

#lower_case!Object



107
108
109
# File 'lib/lucky_case/string.rb', line 107

def lower_case!()
  set_self_value self.lower_case
end

#lower_case?Boolean

Check if all characters inside the string are lower case

Returns:

  • (Boolean)


114
115
116
# File 'lib/lucky_case/string.rb', line 114

def lower_case?()
  LuckyCase.lower_case? self
end

#lucky_case(allow_prefixed_underscores: true) ⇒ Object

easter egg version of #letter_case



29
30
31
# File 'lib/lucky_case/string.rb', line 29

def lucky_case(allow_prefixed_underscores: true)
  LuckyCase.case self, allow_prefixed_underscores: allow_prefixed_underscores
end

#lucky_cases(allow_prefixed_underscores: true) ⇒ Object

easter egg version of #letter_cases



42
43
44
# File 'lib/lucky_case/string.rb', line 42

def lucky_cases(allow_prefixed_underscores: true)
  LuckyCase.cases self, allow_prefixed_underscores: allow_prefixed_underscores
end

#mixed_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into mixed case

Examples:

conversion

'this-isAnExample_string' => 'This-Is_anExample-string'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



494
495
496
# File 'lib/lucky_case/string.rb', line 494

def mixed_case(preserve_prefixed_underscores: true)
  LuckyCase.mixed_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#mixed_case!(preserve_prefixed_underscores: true) ⇒ Object



498
499
500
# File 'lib/lucky_case/string.rb', line 498

def mixed_case!(preserve_prefixed_underscores: true)
  set_self_value self.mixed_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#mixed_case?Boolean

Check if the string is a valid mixed case (without special characters!)

Returns:

  • (Boolean)


505
506
507
# File 'lib/lucky_case/string.rb', line 505

def mixed_case?()
  LuckyCase.mixed_case? self
end

#not_capital?(skip_prefixed_underscores: false) ⇒ Boolean

Check if the strings first character is a lower letter

Parameters:

  • skip_prefixed_underscores (Boolean) (defaults to: false)

Returns:

  • (Boolean)


478
479
480
# File 'lib/lucky_case/string.rb', line 478

def not_capital?(skip_prefixed_underscores: false)
  self.decapitalized? skip_prefixed_underscores: skip_prefixed_underscores
end

#pascal_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into pascal case

Examples:

conversion

'this-isAnExample_string' => 'ThisIsAnExampleString'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



182
183
184
# File 'lib/lucky_case/string.rb', line 182

def pascal_case(preserve_prefixed_underscores: true)
  LuckyCase.pascal_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#pascal_case!(preserve_prefixed_underscores: true) ⇒ Object



186
187
188
# File 'lib/lucky_case/string.rb', line 186

def pascal_case!(preserve_prefixed_underscores: true)
  set_self_value self.pascal_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#pascal_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is upper pascal case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


194
195
196
# File 'lib/lucky_case/string.rb', line 194

def pascal_case?(allow_prefixed_underscores: true)
  LuckyCase.pascal_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#sentence_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into sentence case

Examples:

conversion

'this-isAnExample_string' => 'This is an example string'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



394
395
396
# File 'lib/lucky_case/string.rb', line 394

def sentence_case(preserve_prefixed_underscores: true)
  LuckyCase.sentence_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#sentence_case!(preserve_prefixed_underscores: true) ⇒ Object



398
399
400
# File 'lib/lucky_case/string.rb', line 398

def sentence_case!(preserve_prefixed_underscores: true)
  set_self_value self.sentence_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#sentence_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is sentence case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


406
407
408
# File 'lib/lucky_case/string.rb', line 406

def sentence_case?(allow_prefixed_underscores: true)
  LuckyCase.sentence_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#snake_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into snake case

Examples:

conversion

'this-isAnExample_string' => 'this_is_an_example_string'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



130
131
132
# File 'lib/lucky_case/string.rb', line 130

def snake_case(preserve_prefixed_underscores: true)
  LuckyCase.snake_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#snake_case!(preserve_prefixed_underscores: true) ⇒ Object



134
135
136
# File 'lib/lucky_case/string.rb', line 134

def snake_case!(preserve_prefixed_underscores: true)
  set_self_value self.snake_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#snake_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is snake case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


142
143
144
# File 'lib/lucky_case/string.rb', line 142

def snake_case?(allow_prefixed_underscores: true)
  LuckyCase.snake_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#swap_case(preserve_prefixed_underscores: false) ⇒ String

Swaps character cases in string

lower case to upper case upper case to lower case dash to underscore underscore to dash

Examples:

conversion

'this-isAnExample_string' => 'THIS_ISaNeXAMPLE-STRING'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: false)

Returns:



525
526
527
# File 'lib/lucky_case/string.rb', line 525

def swap_case(preserve_prefixed_underscores: false)
  LuckyCase.swap_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#swap_case!(preserve_prefixed_underscores: false) ⇒ Object




531
532
533
# File 'lib/lucky_case/string.rb', line 531

def swap_case!(preserve_prefixed_underscores: false)
  set_self_value self.swap_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#train_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into train case

Examples:

conversion

'this-isAnExample_string' => 'This-Is-An-Example-String'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



290
291
292
# File 'lib/lucky_case/string.rb', line 290

def train_case(preserve_prefixed_underscores: true)
  LuckyCase.train_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#train_case!(preserve_prefixed_underscores: true) ⇒ Object



294
295
296
# File 'lib/lucky_case/string.rb', line 294

def train_case!(preserve_prefixed_underscores: true)
  set_self_value self.train_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#train_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is train case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


302
303
304
# File 'lib/lucky_case/string.rb', line 302

def train_case?(allow_prefixed_underscores: true)
  LuckyCase.train_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#upper_caseString

Convert all characters inside the string into upper case

Examples:

conversion

'this-isAnExample_string' => 'THIS-ISANEXAMPLE_STRING'

Returns:



77
78
79
# File 'lib/lucky_case/string.rb', line 77

def upper_case()
  LuckyCase.upper_case self
end

#upper_case!Object



81
82
83
# File 'lib/lucky_case/string.rb', line 81

def upper_case!()
  set_self_value self.upper_case
end

#upper_case?Boolean

Check if all characters inside the string are upper case

Returns:

  • (Boolean)


88
89
90
# File 'lib/lucky_case/string.rb', line 88

def upper_case?()
  LuckyCase.upper_case? self
end

#upper_dash_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into upper dash case

Examples:

conversion

'this-isAnExample_string' => 'THIS-IS-AN-EXAMPLE-STRING'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



262
263
264
# File 'lib/lucky_case/string.rb', line 262

def upper_dash_case(preserve_prefixed_underscores: true)
  LuckyCase.upper_dash_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#upper_dash_case!(preserve_prefixed_underscores: true) ⇒ Object



266
267
268
# File 'lib/lucky_case/string.rb', line 266

def upper_dash_case!(preserve_prefixed_underscores: true)
  set_self_value self.upper_dash_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#upper_dash_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is upper dash case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


274
275
276
# File 'lib/lucky_case/string.rb', line 274

def upper_dash_case?(allow_prefixed_underscores: true)
  LuckyCase.upper_dash_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#upper_snake_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into upper snake case

Examples:

conversion

'this-isAnExample_string' => 'THIS_IS_AN_EXAMPLE_STRING'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



154
155
156
# File 'lib/lucky_case/string.rb', line 154

def upper_snake_case(preserve_prefixed_underscores: true)
  LuckyCase.upper_snake_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#upper_snake_case!(preserve_prefixed_underscores: true) ⇒ Object



158
159
160
# File 'lib/lucky_case/string.rb', line 158

def upper_snake_case!(preserve_prefixed_underscores: true)
  set_self_value self.upper_snake_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#upper_snake_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is upper snake case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


166
167
168
# File 'lib/lucky_case/string.rb', line 166

def upper_snake_case?(allow_prefixed_underscores: true)
  LuckyCase.upper_snake_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#upper_word_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into upper word case

Examples:

conversion

'this-isAnExample_string' => 'THIS IS AN EXAMPLE STRING'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



342
343
344
# File 'lib/lucky_case/string.rb', line 342

def upper_word_case(preserve_prefixed_underscores: true)
  LuckyCase.upper_word_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#upper_word_case!(preserve_prefixed_underscores: true) ⇒ Object



346
347
348
# File 'lib/lucky_case/string.rb', line 346

def upper_word_case!(preserve_prefixed_underscores: true)
  set_self_value self.upper_word_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#upper_word_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is upper word case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


354
355
356
# File 'lib/lucky_case/string.rb', line 354

def upper_word_case?(allow_prefixed_underscores: true)
  LuckyCase.upper_word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end

#valid_case_string?Boolean

Check if the string matches any of the available cases

Returns:

  • (Boolean)


62
63
64
# File 'lib/lucky_case/string.rb', line 62

def valid_case_string?()
  LuckyCase.case(self) != nil
end

#word_case(preserve_prefixed_underscores: true) ⇒ String

Convert the given string from any case into word case

Examples:

conversion

'this-isAnExample_string' => 'this is an example string'

Parameters:

  • preserve_prefixed_underscores (Boolean) (defaults to: true)

Returns:



318
319
320
# File 'lib/lucky_case/string.rb', line 318

def word_case(preserve_prefixed_underscores: true)
  LuckyCase.word_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
end

#word_case!(preserve_prefixed_underscores: true) ⇒ Object



322
323
324
# File 'lib/lucky_case/string.rb', line 322

def word_case!(preserve_prefixed_underscores: true)
  set_self_value self.word_case preserve_prefixed_underscores: preserve_prefixed_underscores
end

#word_case?(allow_prefixed_underscores: true) ⇒ Boolean

Check if the string is word case

Parameters:

  • allow_prefixed_underscores (Boolean) (defaults to: true)

Returns:

  • (Boolean)


330
331
332
# File 'lib/lucky_case/string.rb', line 330

def word_case?(allow_prefixed_underscores: true)
  LuckyCase.word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
end