chars 0.1.1 → 0.2.3

data/lib/chars/chars.rb

@@ -2,64 +2,79 @@ require 'chars/char_set'
 
 module Chars
   # The numeric decimal character set
-  NUMERIC = CharSet.new('0'..'9')
+  NUMERIC = CharSet['0'..'9']
 
   # The octal character set
-  OCTAL = CharSet.new('0'..'7')
+  OCTAL = CharSet['0'..'7']
 
   # The upper-case hexadecimal character set
-  UPPERCASE_HEXADECIMAL = NUMERIC + ('A'..'F')
+  UPPERCASE_HEXADECIMAL = NUMERIC | CharSet['A'..'F']
 
   # The lower-case hexadecimal character set
-  LOWERCASE_HEXADECIMAL = NUMERIC + ('a'..'f')
+  LOWERCASE_HEXADECIMAL = NUMERIC | CharSet['a'..'f']
 
   # The hexadecimal character set
-  HEXADECIMAL = UPPERCASE_HEXADECIMAL + LOWERCASE_HEXADECIMAL
+  HEXADECIMAL = UPPERCASE_HEXADECIMAL | LOWERCASE_HEXADECIMAL
 
   # The upper-case alpha character set
-  UPPERCASE_ALPHA = CharSet.new('A'..'Z')
+  UPPERCASE_ALPHA = CharSet['A'..'Z']
 
   # The lower-case alpha character set
-  LOWERCASE_ALPHA = CharSet.new('a'..'z')
+  LOWERCASE_ALPHA = CharSet['a'..'z']
 
   # The alpha character set
-  ALPHA = UPPERCASE_ALPHA + LOWERCASE_ALPHA
+  ALPHA = UPPERCASE_ALPHA | LOWERCASE_ALPHA
 
   # The alpha-numeric character set
-  ALPHA_NUMERIC = ALPHA + NUMERIC
+  ALPHA_NUMERIC = ALPHA | NUMERIC
 
   # The punctuation character set
-  PUNCTUATION = CharSet.new(' ', '\'', '"', '`', ',', ';', ':', '~', '-',
-                            '(', ')', '[', ']', '{', '}', '.', '?', '!')
+  PUNCTUATION = CharSet[' ', '\'', '"', '`', ',', ';', ':', '~', '-',
+                        '(', ')', '[', ']', '{', '}', '.', '?', '!']
 
   # The symbolic character set
-  SYMBOLS = PUNCTUATION + ['@', '#', '$', '%', '^', '&', '*', '_', '+',
-    '=', '|', '\\', '<', '>', '/']
+  SYMBOLS = PUNCTUATION | CharSet[
+    '@', '#', '$', '%', '^', '&', '*', '_', '+',
+    '=', '|', '\\', '<', '>', '/'
+  ]
 
   # The space character set
   SPACE = CharSet.new(' ', "\f", "\n", "\r", "\t", "\v")
 
+  # The set of printable characters (not including spaces)
+  VISIBLE = ALPHA_NUMERIC | CharSet[
+    '\'', '"', '`', ',', ';', ':', '~', '-',
+    '(', ')', '[', ']', '{', '}', '.', '?', '!', '@', '#', '$',
+    '%', '^', '&', '*', '_', '+', '=', '|', '\\', '<', '>', '/'
+  ]
+  
   # The set of printable characters (including spaces)
-  PRINTABLE = ALPHA_NUMERIC + PUNCTUATION + SYMBOLS + SPACE
+  PRINTABLE = ALPHA_NUMERIC | PUNCTUATION | SYMBOLS | SPACE
 
   # The control-char character set
-  CONTROL = CharSet.new(0..0x1f, 0x7f)
+  CONTROL = CharSet[0..0x1f, 0x7f]
 
-  # The ASCII character set
-  ASCII = CharSet.new(0..0x7f)
+  # The signed ASCII character set
+  SIGNED_ASCII = CharSet[0..0x7f]
 
   # The full 8-bit character set
-  ALL = CharSet.new(0..0xff)
+  ASCII = CharSet[0..0xff]
 
   #
-  # The numeric decimal character set.
+  # The decimal-digit character set.
+  #
+  # @return [CharSet]
+  #   The decimal-digit character set.
   #
   def Chars.numeric
     NUMERIC
   end
 
   #
-  # The octal character set.
+  # The octal-digit character set.
+  #
+  # @return [CharSet]
+  #   The octal-digit character set.
   #
   def Chars.octal
     OCTAL
@@ -68,6 +83,9 @@ module Chars
   #
   # The upper-case hexadecimal character set.
   #
+  # @return [CharSet]
+  #   The upper-case hexadecimal character set.
+  #
   def Chars.uppercase_hexadecimal
     UPPERCASE_HEXADECIMAL
   end
@@ -75,6 +93,9 @@ module Chars
   #
   # The lower-case hexadecimal character set.
   #
+  # @return [CharSet]
+  #   The lower-case hexadecimal character set.
+  #
   def Chars.lowercase_hexadecimal
     LOWERCASE_HEXADECIMAL
   end
@@ -82,26 +103,38 @@ module Chars
   #
   # The hexadecimal character set.
   #
+  # @return [CharSet]
+  #   The hexadecimal character set.
+  #
   def Chars.hexadecimal
     HEXADECIMAL
   end
 
   #
-  # The upper-case alpha character set.
+  # The upper-case alphabetic character set.
+  #
+  # @return [CharSet]
+  #   The upper-case alphabetic character set.
   #
   def Chars.uppercase_alpha
     UPPERCASE_ALPHA
   end
 
   #
-  # The lower-case alpha character set.
+  # The lower-case alphabetic character set.
+  #
+  # @return [CharSet]
+  #   The lower-case alphabetic character set.
   #
   def Chars.lowercase_alpha
     LOWERCASE_ALPHA
   end
 
   #
-  # The alpha character set.
+  # The alphabetic character set.
+  #
+  # @return [CharSet]
+  #   The alphabetic character set.
   #
   def Chars.alpha
     ALPHA
@@ -110,6 +143,9 @@ module Chars
   #
   # The alpha-numeric character set.
   #
+  # @return [CharSet]
+  #   The alpha-numeric character set.
+  #
   def Chars.alpha_numeric
     ALPHA_NUMERIC
   end
@@ -117,6 +153,9 @@ module Chars
   #
   # The punctuation character set.
   #
+  # @return [CharSet]
+  #   The punctuation character set.
+  #
   def Chars.punctuation
     PUNCTUATION
   end
@@ -124,42 +163,70 @@ module Chars
   #
   # The symbolic character set.
   #
+  # @return [CharSet]
+  #   The symbolic character set.
+  #
   def Chars.symbols
     SYMBOLS
   end
 
   #
-  # The space character set.
+  # The white-space character set.
+  #
+  # @return [CharSet]
+  #   The white-space character set.
   #
   def Chars.space
     SPACE
   end
 
+  #
+  # The set of printable characters, not including spaces.
+  #
+  # @return [CharSet]
+  #   The visible character set.
+  #
+  def Chars.visible
+    VISIBLE
+  end
+
   #
   # The set of printable characters, including spaces.
   #
+  # @return [CharSet]
+  #   The printable character set.
+  #
   def Chars.printable
     PRINTABLE
   end
 
   #
-  # The control-char character set.
+  # The control-character character set.
+  #
+  # @return [CharSet]
+  #   The control-character character set.
   #
   def Chars.control
     CONTROL
   end
 
   #
-  # The ASCII character set.
+  # The signed ASCII character set.
   #
-  def Chars.ascii
-    ASCII
+  # @return [CharSet]
+  #   The signed ASCII character set.
+  #
+  def Chars.signed_ascii
+    SIGNED_ASCII
   end
 
   #
-  # The full 8-bit character set.
+  # The ASCII character set.
+  #
+  # @return [CharSet]
+  #   The ASCII character set.
   #
-  def Chars.all
-    ALL
+  def Chars.ascii
+    ASCII
   end
 end

data/lib/chars/extensions/integer.rb

@@ -2,64 +2,217 @@ require 'chars/chars'
 
 class Integer
 
+  #
+  # Determines if the byte belongs to the decimal-digit character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the decimal-digit character set.
+  #
+  # @see Chars.numeric
+  #
   def numeric?
-    Chars::NUMERIC.include?(self)
+    Chars::NUMERIC.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the octal-digit character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the octal-digit character set.
+  #
+  # @see Chars.octal
+  #
   def octal?
-    Chars::OCTAL.include?(self)
+    Chars::OCTAL.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the upper-case hexadecimal character
+  # set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the upper-case hexadecimal
+  #   character set.
+  #
+  # @see Chars.uppercase_hexadecimal
+  #
   def uppercase_hex?
-    Chars::UPPERCASE_HEXADECIMAL.include?(self)
+    Chars::UPPERCASE_HEXADECIMAL.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the lower-case hexadecimal character
+  # set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the lower-case hexadecimal
+  #   character set.
+  #
+  # @see Chars.lowercase_hexadecimal
+  #
   def lowercase_hex?
-    Chars::LOWERCASE_HEXADECIMAL.include?(self)
+    Chars::LOWERCASE_HEXADECIMAL.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the hexadecimal character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the hexadecimal character set.
+  #
+  # @see Chars.hexadecimal
+  #
   def hex?
-    Chars::HEXADECIMAL.include?(self)
+    Chars::HEXADECIMAL.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the upper-case alphabetic character
+  # set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the upper-case alphabetic
+  #   character set.
+  #
+  # @see Chars.uppercase_alpha
+  #
   def uppercase_alpha?
-    Chars::UPPERCASE_ALPHA.include?(self)
+    Chars::UPPERCASE_ALPHA.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the lower-case alphabetic character
+  # set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the lower-case alphabetic
+  #   character set.
+  #
+  # @see Chars.lowercase_alpha
+  #
   def lowercase_alpha?
-    Chars::LOWERCASE_ALPHA.include?(self)
+    Chars::LOWERCASE_ALPHA.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the alphabetic character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the alphabetic character set.
+  #
+  # @see Chars.alpha
+  #
   def alpha?
-    Chars::ALPHA.include?(self)
+    Chars::ALPHA.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the alpha-numeric character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the alpha-numeric character set.
+  #
+  # @see Chars.alpha_numeric
+  #
   def alpha_numeric?
-    Chars::ALPHA_NUMERIC.include?(self)
+    Chars::ALPHA_NUMERIC.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the punctuation character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the punctuation character set.
+  #
+  # @see Chars.punctuation
+  #
   def punctuation?
-    Chars::PUNCTUATION.include?(self)
+    Chars::PUNCTUATION.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the symbolic character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the symbolic character set.
+  #
+  # @see Chars.symbols
+  #
   def symbolic?
-    Chars::SYMBOLS.include?(self)
+    Chars::SYMBOLS.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the white-space character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the white-space character set.
+  #
+  # @see Chars.space
+  #
   def space?
-    Chars::SPACE.include?(self)
+    Chars::SPACE.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the visible character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the visible character set.
+  #
+  # @see Chars.visible
+  #
+  def visible?
+    Chars::VISIBLE.include_byte?(self)
+  end
+
+  #
+  # Determines if the byte belongs to the printable character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the printable character set.
+  #
+  # @see Chars.printable
+  #
   def printable?
-    Chars::PRINTABLE.include?(self)
+    Chars::PRINTABLE.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the control-character character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the control-character character
+  #   set.
+  #
+  # @see Chars.control
+  #
   def control?
-    Chars::CONTROL.include?(self)
+    Chars::CONTROL.include_byte?(self)
+  end
+
+  #
+  # Determines if the byte belongs to the signed-ASCII character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the signed-ASCII character set.
+  #
+  # @see Chars.signed_ascii
+  #
+  def signed_ascii?
+    Chars::SIGNED_ASCII.include_byte?(self)
   end
 
+  #
+  # Determines if the byte belongs to the ASCII character set.
+  #
+  # @return [Boolean]
+  #   Specifies whether the byte belongs to the ASCII character set.
+  #
+  # @see Chars.ascii
+  #
   def ascii?
-    Chars::ASCII.include?(self)
+    Chars::ASCII.include_byte?(self)
   end
 
 end