module SubCipher

Constants

ALPHABETS: The alphabet seed
DEFAULT_OPTS: The default options
SUPPORTED_OPTS: The supported options
VERSION

Public Class Methods

gen(options = {}) click to toggle source

The major method to generate a sub cipher. @param options [Hash]

The options to tell sub cipher how to encode/decode.
Three options :seed, :map and :keep_case are supported.
Please see {file:README} to get more examples

@return [SubCipherObject]

The generated sub cipher.

@raise [SubCipherError]

Please see {SubCipher::SubCipherError}

# File lib/sub_cipher.rb, line 37
def SubCipher.gen(options = {})
  SubCipherObject.new(options)
end