Module: StoryKey

Extended by:

ClassMethods

Defined in:

lib/story_key.rb,
lib/story_key/version.rb,
lib/story_key/class_methods.rb

Defined Under Namespace

Modules: ClassMethods, Data Classes: Base, Coercer, Console, Decoder, Encoder, Entry, Error, ImageGenerator, InvalidChecksum, InvalidFormat, InvalidVersion, InvalidWord, KeyGenerator, KeyTooLarge, Lexicon, Story, Tokenizer

Constant Summary

BITS_PER_ENTRY =

10

DEFAULT_BITSIZE =

256

FOOTER_BITSIZE =

StoryKey::BITS_PER_ENTRY must be lte 2^StoryKey::FOOTER_BITSIZE

4

FORMATS =

i[base58 hex bin dec].freeze

GRAMMAR =

{
  4 => i[adjective noun verb noun],
  3 => i[noun verb noun],
  2 => i[adjective noun],
  1 => i[noun]
}.freeze

LEXICON_SHA_SIZE =

7

MAX_BITSIZE =

512

PREPOSITIONS =

%w[in i saw and a an].freeze

GITHUB_URL =

"https://github.com/jcraigk/storykey"

VERSION =

"0.5.0"

VERSION_SLUG =

Name of a well-known city, no spaces

"Miami"

LEXICON_SHA =

"3bfbbf9"

Method Summary

Methods included from ClassMethods

decode, encode, generate, recover