chars 0.2.1 → 0.3.0

data/lib/chars/chars.rb

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 require 'chars/char_set'
 
 module Chars
   # The numeric decimal character set
   NUMERIC = CharSet['0'..'9']
 
+  # @see NUMERIC
+  #
+  # @since 0.3.0
+  DIGITS = NUMERIC
+
   # The octal character set
   OCTAL = CharSet['0'..'7']
 
@@ -39,7 +46,11 @@ module Chars
   ]
 
   # The space character set
-  SPACE = CharSet.new(' ', "\f", "\n", "\r", "\t", "\v")
+  #
+  # @since 0.3.0
+  WHITESPACE = CharSet[' ', "\f", "\n", "\r", "\t", "\v"]
+
+  SPACE = WHITESPACE
 
   # The set of printable characters (not including spaces)
   VISIBLE = ALPHA_NUMERIC | CharSet[
@@ -66,17 +77,30 @@ module Chars
   # @return [CharSet]
   #   The decimal-digit character set.
   #
-  def Chars.numeric
+  # @see NUMERIC
+  #
+  def self.numeric
     NUMERIC
   end
 
+  #
+  # @see numeric
+  #
+  # @since 0.3.0
+  #
+  def self.digits
+    numeric
+  end
+
   #
   # The octal-digit character set.
   #
   # @return [CharSet]
   #   The octal-digit character set.
   #
-  def Chars.octal
+  # @see OCTAL
+  #
+  def self.octal
     OCTAL
   end
 
@@ -86,7 +110,9 @@ module Chars
   # @return [CharSet]
   #   The upper-case hexadecimal character set.
   #
-  def Chars.uppercase_hexadecimal
+  # @see UPPERCASE_HEXADECIMAL
+  #
+  def self.uppercase_hexadecimal
     UPPERCASE_HEXADECIMAL
   end
 
@@ -96,7 +122,9 @@ module Chars
   # @return [CharSet]
   #   The lower-case hexadecimal character set.
   #
-  def Chars.lowercase_hexadecimal
+  # @see LOWERCASE_HEXADECIMAL
+  #
+  def self.lowercase_hexadecimal
     LOWERCASE_HEXADECIMAL
   end
 
@@ -106,7 +134,9 @@ module Chars
   # @return [CharSet]
   #   The hexadecimal character set.
   #
-  def Chars.hexadecimal
+  # @see HEXADECIMAL
+  #
+  def self.hexadecimal
     HEXADECIMAL
   end
 
@@ -116,7 +146,9 @@ module Chars
   # @return [CharSet]
   #   The upper-case alphabetic character set.
   #
-  def Chars.uppercase_alpha
+  # @see UPPERCASE_ALPHA
+  #
+  def self.uppercase_alpha
     UPPERCASE_ALPHA
   end
 
@@ -126,7 +158,9 @@ module Chars
   # @return [CharSet]
   #   The lower-case alphabetic character set.
   #
-  def Chars.lowercase_alpha
+  # @see LOWERCASE_ALPHA
+  #
+  def self.lowercase_alpha
     LOWERCASE_ALPHA
   end
 
@@ -136,7 +170,9 @@ module Chars
   # @return [CharSet]
   #   The alphabetic character set.
   #
-  def Chars.alpha
+  # @see ALPHA
+  #
+  def self.alpha
     ALPHA
   end
 
@@ -146,7 +182,9 @@ module Chars
   # @return [CharSet]
   #   The alpha-numeric character set.
   #
-  def Chars.alpha_numeric
+  # @see ALPHA_NUMERIC
+  #
+  def self.alpha_numeric
     ALPHA_NUMERIC
   end
 
@@ -156,7 +194,9 @@ module Chars
   # @return [CharSet]
   #   The punctuation character set.
   #
-  def Chars.punctuation
+  # @see PUNCTUATION
+  #
+  def self.punctuation
     PUNCTUATION
   end
 
@@ -166,18 +206,33 @@ module Chars
   # @return [CharSet]
   #   The symbolic character set.
   #
-  def Chars.symbols
+  # @see SYMBOLS
+  #
+  def self.symbols
     SYMBOLS
   end
 
   #
-  # The white-space character set.
+  # The whitespace character set.
   #
   # @return [CharSet]
-  #   The white-space character set.
+  #   The whitespace character set.
+  #
+  # @see SPACE
+  #
+  # @since 0.3.0
+  #
+  def self.whitespace
+    WHITESPACE
+  end
+
+  #
+  # The whitespace character set.
   #
-  def Chars.space
-    SPACE
+  # @see #whitespace
+  #
+  def self.space
+    whitespace
   end
 
   #
@@ -186,7 +241,9 @@ module Chars
   # @return [CharSet]
   #   The visible character set.
   #
-  def Chars.visible
+  # @see VISIBLE
+  #
+  def self.visible
     VISIBLE
   end
 
@@ -196,7 +253,9 @@ module Chars
   # @return [CharSet]
   #   The printable character set.
   #
-  def Chars.printable
+  # @see PRINTABLE
+  #
+  def self.printable
     PRINTABLE
   end
 
@@ -206,7 +265,9 @@ module Chars
   # @return [CharSet]
   #   The control-character character set.
   #
-  def Chars.control
+  # @see CONTROL
+  #
+  def self.control
     CONTROL
   end
 
@@ -216,7 +277,9 @@ module Chars
   # @return [CharSet]
   #   The signed ASCII character set.
   #
-  def Chars.signed_ascii
+  # @see SIGNED_ASCII
+  #
+  def self.signed_ascii
     SIGNED_ASCII
   end
 
@@ -226,7 +289,9 @@ module Chars
   # @return [CharSet]
   #   The ASCII character set.
   #
-  def Chars.ascii
+  # @see ASCII
+  #
+  def self.ascii
     ASCII
   end
 end

data/lib/chars/extensions/integer.rb

@@ -8,7 +8,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the decimal-digit character set.
   #
-  # @see Chars.numeric
+  # @see Chars::NUMERIC
+  # @see Chars::CharSet#include_byte?
   #
   def numeric?
     Chars::NUMERIC.include_byte?(self)
@@ -20,7 +21,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the octal-digit character set.
   #
-  # @see Chars.octal
+  # @see Chars::OCTAL
+  # @see Chars::CharSet#include_byte?
   #
   def octal?
     Chars::OCTAL.include_byte?(self)
@@ -34,7 +36,8 @@ class Integer
   #   Specifies whether the byte belongs to the upper-case hexadecimal
   #   character set.
   #
-  # @see Chars.uppercase_hexadecimal
+  # @see Chars::UPPERCASE_HEXADECIMAL
+  # @see Chars::CharSet#include_byte?
   #
   def uppercase_hex?
     Chars::UPPERCASE_HEXADECIMAL.include_byte?(self)
@@ -48,7 +51,8 @@ class Integer
   #   Specifies whether the byte belongs to the lower-case hexadecimal
   #   character set.
   #
-  # @see Chars.lowercase_hexadecimal
+  # @see Chars::LOWERCASE_HEXADECIMAL
+  # @see Chars::CharSet#include_byte?
   #
   def lowercase_hex?
     Chars::LOWERCASE_HEXADECIMAL.include_byte?(self)
@@ -60,7 +64,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the hexadecimal character set.
   #
-  # @see Chars.hexadecimal
+  # @see Chars::HEXADECIMAL
+  # @see Chars::CharSet#include_byte?
   #
   def hex?
     Chars::HEXADECIMAL.include_byte?(self)
@@ -74,7 +79,8 @@ class Integer
   #   Specifies whether the byte belongs to the upper-case alphabetic
   #   character set.
   #
-  # @see Chars.uppercase_alpha
+  # @see Chars::UPPERCASE_ALPHA
+  # @see Chars::CharSet#include_byte?
   #
   def uppercase_alpha?
     Chars::UPPERCASE_ALPHA.include_byte?(self)
@@ -88,7 +94,8 @@ class Integer
   #   Specifies whether the byte belongs to the lower-case alphabetic
   #   character set.
   #
-  # @see Chars.lowercase_alpha
+  # @see Chars::LOWERCASE_ALPHA
+  # @see Chars::CharSet#include_byte?
   #
   def lowercase_alpha?
     Chars::LOWERCASE_ALPHA.include_byte?(self)
@@ -100,7 +107,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the alphabetic character set.
   #
-  # @see Chars.alpha
+  # @see Chars::ALPHA
+  # @see Chars::CharSet#include_byte?
   #
   def alpha?
     Chars::ALPHA.include_byte?(self)
@@ -112,7 +120,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the alpha-numeric character set.
   #
-  # @see Chars.alpha_numeric
+  # @see Chars::ALPHA_NUMERIC
+  # @see Chars::CharSet#include_byte?
   #
   def alpha_numeric?
     Chars::ALPHA_NUMERIC.include_byte?(self)
@@ -124,7 +133,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the punctuation character set.
   #
-  # @see Chars.punctuation
+  # @see Chars::PUNCTUATION
+  # @see Chars::CharSet#include_byte?
   #
   def punctuation?
     Chars::PUNCTUATION.include_byte?(self)
@@ -136,7 +146,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the symbolic character set.
   #
-  # @see Chars.symbols
+  # @see Chars::SYMBOLS
+  # @see Chars::CharSet#include_byte?
   #
   def symbolic?
     Chars::SYMBOLS.include_byte?(self)
@@ -148,7 +159,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the white-space character set.
   #
-  # @see Chars.space
+  # @see Chars::SPACE
+  # @see Chars::CharSet#include_byte?
   #
   def space?
     Chars::SPACE.include_byte?(self)
@@ -160,7 +172,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the visible character set.
   #
-  # @see Chars.visible
+  # @see Chars::VISIBLE
+  # @see Chars::CharSet#include_byte?
   #
   def visible?
     Chars::VISIBLE.include_byte?(self)
@@ -172,7 +185,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the printable character set.
   #
-  # @see Chars.printable
+  # @see Chars::PRINTABLE
+  # @see Chars::CharSet#include_byte?
   #
   def printable?
     Chars::PRINTABLE.include_byte?(self)
@@ -185,7 +199,8 @@ class Integer
   #   Specifies whether the byte belongs to the control-character character
   #   set.
   #
-  # @see Chars.control
+  # @see Chars::CONTROL
+  # @see Chars::CharSet#include_byte?
   #
   def control?
     Chars::CONTROL.include_byte?(self)
@@ -197,7 +212,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the signed-ASCII character set.
   #
-  # @see Chars.signed_ascii
+  # @see Chars::SIGNED_ASCII
+  # @see Chars::CharSet#include_byte?
   #
   def signed_ascii?
     Chars::SIGNED_ASCII.include_byte?(self)
@@ -209,7 +225,8 @@ class Integer
   # @return [Boolean]
   #   Specifies whether the byte belongs to the ASCII character set.
   #
-  # @see Chars.ascii
+  # @see Chars::ASCII
+  # @see Chars::CharSet#include_byte?
   #
   def ascii?
     Chars::ASCII.include_byte?(self)

data/lib/chars/extensions/string.rb

@@ -9,7 +9,8 @@ class String
   #   Specifies whether the String belongs to the decimal-digit character
   #   set.
   #
-  # @see Chars.numeric
+  # @see Chars::NUMERIC
+  # @see Chars::CharSet#===
   #
   def numeric?
     Chars::NUMERIC === self
@@ -22,7 +23,8 @@ class String
   #   Specifies whether the String belongs to the octal-digit character
   #   set.
   #
-  # @see Chars.octal
+  # @see Chars::OCTAL
+  # @see Chars::CharSet#===
   #
   def octal?
     Chars::OCTAL === self
@@ -36,7 +38,8 @@ class String
   #   Specifies whether the String belongs to the upper-case hexadecimal
   #   character set.
   #
-  # @see Chars.uppercase_hexadecimal
+  # @see Chars::UPPERCASE_HEXADECIMAL
+  # @see Chars::CharSet#===
   #
   def uppercase_hex?
     Chars::UPPERCASE_HEXADECIMAL === self
@@ -50,7 +53,8 @@ class String
   #   Specifies whether the String belongs to the lower-case hexadecimal
   #   character set.
   #
-  # @see Chars.lowercase_hexadecimal
+  # @see Chars::LOWERCASE_HEXADECIMAL
+  # @see Chars::CharSet#===
   #
   def lowercase_hex?
     Chars::LOWERCASE_HEXADECIMAL === self
@@ -62,7 +66,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the hexadecimal character set.
   #
-  # @see Chars.hexadecimal
+  # @see Chars::HEXADECIMAL
+  # @see Chars::CharSet#===
   #
   def hex?
     Chars::HEXADECIMAL === self
@@ -76,7 +81,8 @@ class String
   #   Specifies whether the String belongs to the upper-case alphabetic
   #   character set.
   #
-  # @see Chars.uppercase_alpha
+  # @see Chars::UPPERCASE_ALPHA
+  # @see Chars::CharSet#===
   #
   def uppercase_alpha?
     Chars::UPPERCASE_ALPHA === self
@@ -90,7 +96,8 @@ class String
   #   Specifies whether the String belongs to the lower-case alphabetic
   #   character set.
   #
-  # @see Chars.lowercase_alpha
+  # @see Chars::LOWERCASE_ALPHA
+  # @see Chars::CharSet#===
   #
   def lowercase_alpha?
     Chars::LOWERCASE_ALPHA === self
@@ -102,7 +109,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the alphabetic character set.
   #
-  # @see Chars.alpha
+  # @see Chars::ALPHA
+  # @see Chars::CharSet#===
   #
   def alpha?
     Chars::ALPHA === self
@@ -116,7 +124,8 @@ class String
   #   Specifies whether the String belongs to the alpha-numeric character
   #   set.
   #
-  # @see Chars.alpha_numeric
+  # @see Chars::ALPHA_NUMERIC
+  # @see Chars::CharSet#===
   #
   def alpha_numeric?
     Chars::ALPHA_NUMERIC === self
@@ -128,7 +137,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the punctuation character set.
   #
-  # @see Chars.punctuation
+  # @see Chars::PUNCTUATION
+  # @see Chars::CharSet#===
   #
   def punctuation?
     Chars::PUNCTUATION === self
@@ -140,7 +150,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the symbolic character set.
   #
-  # @see Chars.symbols
+  # @see Chars::SYMBOLS
+  # @see Chars::CharSet#===
   #
   def symbolic?
     Chars::SYMBOLS === self
@@ -152,7 +163,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the white-space character set.
   #
-  # @see Chars.space
+  # @see Chars::SPACE
+  # @see Chars::CharSet#===
   #
   def space?
     Chars::SPACE === self
@@ -164,7 +176,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the visible character set.
   #
-  # @see Chars.visible
+  # @see Chars::VISIBLE
+  # @see Chars::CharSet#===
   #
   def visible?
     Chars::VISIBLE === self
@@ -176,7 +189,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the printable character set.
   #
-  # @see Chars.printable
+  # @see Chars::PRINTABLE
+  # @see Chars::CharSet#===
   #
   def printable?
     Chars::PRINTABLE === self
@@ -190,7 +204,8 @@ class String
   #   Specifies whether the String belongs to the control-character
   #   character set.
   #
-  # @see Chars.control
+  # @see Chars::CONTROL
+  # @see Chars::CharSet#===
   #
   def control?
     Chars::CONTROL === self
@@ -203,7 +218,8 @@ class String
   #   Specifies whether the String belongs to the signed-ASCII character
   #   set.
   #
-  # @see Chars.signed_ascii
+  # @see Chars::SIGNED_ASCII
+  # @see Chars::CharSet#===
   #
   def signed_ascii?
     Chars::SIGNED_ASCII === self
@@ -215,7 +231,8 @@ class String
   # @return [Boolean]
   #   Specifies whether the String belongs to the ASCII character set.
   #
-  # @see Chars.ascii
+  # @see Chars::ASCII
+  # @see Chars::CharSet#===
   #
   def ascii?
     Chars::ASCII === self

data/lib/chars/string_enumerator.rb

@@ -0,0 +1,98 @@
+module Chars
+  #
+  # Enumerates through every possible string belonging to a character set and
+  # of a given length.
+  #
+  # @api private
+  #
+  # @since 0.3.0
+  #
+  class StringEnumerator
+
+    include Enumerable
+
+    # The character set to generate the strings from.
+    #
+    # @return [CharSet]
+    attr_reader :char_set
+
+    # The desired length of each string.
+    #
+    # @return [Integer]
+    attr_reader :length
+
+    #
+    # Initializes the string enumerator.
+    #
+    # @param [Chars::CharSet] char_set
+    #   The character set to generate the strings from.
+    #
+    # @param [Integer] length
+    #   The desired length of each string.
+    #
+    def initialize(char_set,length)
+      @char_set = char_set
+      @length   = length
+    end
+
+    #
+    # Enumerates through every possible string belonging to {#char_set} and 
+    # {#length} long.
+    #
+    # @yield [string]
+    #   The given block will be passed each sequential string.
+    #
+    # @yieldparam [String] string
+    #   A string belonging to {#char_set} and {#length} long.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator will be returned.
+    #
+    def each
+      return enum_for(__method__) unless block_given?
+
+      if @char_set.empty?
+        return
+      elsif @length == 0
+        yield ""
+        return
+      end
+
+      chars      = char_set.chars
+      first_char = chars.first
+      last_char  = chars.last
+
+      next_char = {}
+
+      chars.each_cons(2) do |c1,c2|
+        next_char[c1] = c2
+      end
+
+      string = String.new(first_char * @length)
+
+      last_index = @length - 1
+
+      loop do
+        chars.each do |c|
+          string[last_index] = c
+
+          yield string.dup
+        end
+
+        last_index.downto(0) do |i|
+          if string[i] == last_char
+            string[i] = first_char
+
+            if i == 0
+              return
+            end
+          else
+            string[i] = next_char[string[i]]
+            break
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/chars/version.rb

@@ -1,4 +1,4 @@
 module Chars
-  # Chars version
-  VERSION = '0.2.1'
+  # chars version
+  VERSION = '0.3.0'
 end