Module: Cyberweb::Encoding

Included in:
Cyberweb
Defined in:
lib/cyberweb/encoding/encoding.rb

Overview

Cyberweb::Encoding

Constant Summary collapse

ENCODING_UTF8 =
#

ENCODING_UTF8

#
'utf-8'
ENCODING_ISO =
#

ENCODING_ISO

This is mostly a legacy encoding, but in the event a user may need it, it is defined here in this .rb file as well.

#
'ISO-8859-1'
ISO_ENCODING =
ENCODING_ISO
MAIN_ENCODING =
#

MAIN_ENCODING

This is the main “pointer” to the default encoding.

The current main encoding will be UTF-8 for the cyberweb project.

#
ENCODING_UTF8
MAIN_ENCODING_TO_USE =

MAIN_ENCODING_TO_USE

MAIN_ENCODING
ENCODING_US_ASCII =
#

ENCODING_US_ASCII

#
'US-ASCII'
US_ASCII =

US_ASCII

ENCODING_US_ASCII

Class Method Summary collapse

Class Method Details

.ensure_main_encoding(of_this_input) ⇒ Object

#

Cyberweb::Encoding.ensure_main_encoding

#


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/cyberweb/encoding/encoding.rb', line 57

def self.ensure_main_encoding(
    of_this_input
  )
  if of_this_input.is_a? Array
    of_this_input.map! {|entry|
      entry.force_encoding(MAIN_ENCODING_TO_USE)
      entry
    }
    return of_this_input
  else
    if of_this_input.frozen?
      of_this_input = of_this_input.to_s.dup
    end
    return of_this_input.force_encoding(MAIN_ENCODING_TO_USE)
  end
end

.main_encoding?Boolean

#

Cyberweb::Encoding.main_encoding?

Prefer to use this toplevel-method if you wish to find out which encoding is the default.

#

Returns:

  • (Boolean)


44
45
46
# File 'lib/cyberweb/encoding/encoding.rb', line 44

def self.main_encoding?
  MAIN_ENCODING_TO_USE
end