md5_to_random_name 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb8942ce57152f06a6342dda73c6f7ce38b4bdba94c290fc081059f91d2e7b81
+  data.tar.gz: 8cf658730f2ccaab6ee6a101651813231fb7db2dbc189ebded9704661c606c1b
+SHA512:
+  metadata.gz: 57efd2fe5f4cf2abc3a3cee845c016cb49389ea9a1a91249149c43d40601fe4a4ce003520b208a9b8f4a9d38d035d1a25e5db9e3402d67312ad7907c9d34f541
+  data.tar.gz: 6803ba6374844c6ef76a668a26e338ecbc9a58348f97da381c08e5c507ecc4dabdb3ac07559cf1f6cf7c1e4c182c066f85ab5716249d9ef1699d702023a5e5a3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-16
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 William Tio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Md5ToRandomName
+
+Convert MD5 hashes to human-readable names in the format of `adjective-animal-suffix`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'md5_to_random_name'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install md5_to_random_name
+```
+
+## Usage
+
+### Basic Usage
+
+```ruby
+require 'md5_to_random_name'
+require 'digest/md5'
+
+# Generate a name from an MD5 hash
+md5 = Digest::MD5.hexdigest("hello world")
+name = Md5ToRandomName.generate(md5)
+puts name
+# => "amazing-dolphin-5a0f00"
+```
+
+### Using the Generator Class
+
+```ruby
+require 'md5_to_random_name'
+
+generator = Md5ToRandomName::Generator.new
+md5 = Digest::MD5.hexdigest("hello world")
+name = generator.generate(md5)
+```
+
+### Custom Word Lists
+
+You can provide your own adjectives and animals:
+
+```ruby
+# Custom word lists
+custom_adjectives = ["red", "blue", "green"]
+custom_animals = ["cat", "dog", "fish"]
+
+# Using the module method
+name = Md5ToRandomName.generate(md5, custom_adjectives, custom_animals)
+
+# Or using the Generator class
+generator = Md5ToRandomName::Generator.new(custom_adjectives, custom_animals)
+name = generator.generate(md5)
+```
+
+## Features
+
+- Converts any valid MD5 hash to a human-readable name
+- Generates consistent names for the same hash
+- Uses the format: `adjective-animal-suffix`
+- The suffix is the last 6 characters of the MD5 hash
+- Customizable word lists
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WToa/md5_to_random_name.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/md5_to_random_name/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Md5ToRandomName
+  VERSION = "0.1.0"
+end

data/lib/md5_to_random_name.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "md5_to_random_name/version"
+require_relative "word_lists"
+
+module Md5ToRandomName
+  class Error < StandardError; end
+  class InvalidMd5Hash < Error; end
+
+  class Generator
+    def initialize(adjectives = WordLists::ADJECTIVES, animals = WordLists::ANIMALS)
+      @adjectives = adjectives
+      @animals = animals
+    end
+
+    def generate(md5)
+      validate_md5!(md5)
+
+      adjective = select_adjective(md5)
+      animal = select_animal(md5)
+      hash_suffix = extract_suffix(md5)
+
+      format_name(adjective, animal, hash_suffix)
+    end
+
+    private
+
+    def validate_md5!(md5)
+      unless md5.is_a?(String) && md5.match?(/\A[a-f0-9]{32}\z/i)
+        raise InvalidMd5Hash, "Invalid MD5 hash: #{md5.inspect}"
+      end
+    end
+
+    def select_adjective(md5)
+      index = md5[0...8].to_i(16) % @adjectives.size
+      @adjectives[index]
+    end
+
+    def select_animal(md5)
+      index = md5[8...16].to_i(16) % @animals.size
+      @animals[index]
+    end
+
+    def extract_suffix(md5)
+      md5[-6..-1]
+    end
+
+    def format_name(adjective, animal, suffix)
+      "#{adjective}-#{animal}-#{suffix}"
+    end
+  end
+
+  def self.generate(md5, adjectives = WordLists::ADJECTIVES, animals = WordLists::ANIMALS)
+    Generator.new(adjectives, animals).generate(md5)
+  end
+end

data/lib/word_lists.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+module Md5ToRandomName
+  module WordLists
+    ANIMALS = %w[
+    abyssinian
+    albatross
+    alligator
+    angelfish
+    ant
+    anteater
+    antelope
+    armadillo
+    baboon
+    badger
+    bandicoot
+    bat
+    beagle
+    bear
+    beaver
+    bee
+    beetle
+    bird
+    bison
+    boar
+    bobcat
+    bombay
+    bongo
+    bonobo
+    booby
+    buffalo
+    bulldog
+    bullfrog
+    butterfly
+    camel
+    capybara
+    cat
+    caterpillar
+    catfish
+    centipede
+    chameleon
+    cheetah
+    chicken
+    chihuahua
+    chimpanzee
+    chinchilla
+    chipmunk
+    civet
+    cockroach
+    cougar
+    cow
+    coyote
+    crab
+    crane
+    cuttlefish
+    deer
+    dingo
+    dodo
+    dog
+    dolphin
+    donkey
+    dragon
+    dragonfly
+    drever
+    duck
+    eagle
+    earwig
+    eel
+    elephant
+    emu
+    falcon
+    ferret
+    fish
+    flamingo
+    flounder
+    fox
+    frog
+    gecko
+    gerbil
+    gibbon
+    giraffe
+    goat
+    goose
+    gopher
+    gorilla
+    grasshopper
+    grey seal
+    greyhound
+    grizzly bear
+    grouse
+    guinea fowl
+    guppy
+    hamster
+    harrier
+    hedgehog
+    heron
+    hippopotamus
+    horse
+    hound
+    howler monkey
+    hummingbird
+    hyena
+    i
+    ibis
+    iguana
+    jackal
+    jaguar
+    jellyfish
+    kangaroo
+    king crab
+    kingfisher
+    kiwi
+    koala
+    lemming
+    lemur
+    leopard
+    lion
+    lionfish
+    lizard
+    llama
+    lobster
+    lynx
+    m
+    macaque
+    macaw
+    mammoth
+    manatee
+    mandrill
+    markhor
+    marmoset
+    meerkat
+    millipede
+    mole
+    mongoose
+    mongrel
+    monkey
+    moose
+    moth
+    mouse
+    mule
+    newt
+    nightingale
+    ocelot
+    octopus
+    opossum
+    orangutan
+    oriole
+    ostrich
+    otter
+    owl
+    oyster
+    panther
+    parrot
+    peacock
+    pelican
+    penguin
+    pheasant
+    pig
+    pike
+    piranha
+    platypus
+    porcupine
+    possum
+    prawn
+    puffin
+    puma
+    quail
+    rabbit
+    raccoon
+    rat
+    rattlesnake
+    reindeer
+    rhinoceros
+    robin
+    salamander
+    scorpion
+    seahorse
+    seal
+    shark
+    sheep
+    shrimp
+    skunk
+    sloth
+    snail
+    snake
+    sparrow
+    sponge
+    squid
+    squirrel
+    stingray
+    stoat
+    swan
+    tamarin
+    tapir
+    tarantula
+    termite
+    tiger
+    toad
+    tortoise
+    toucan
+    turkey
+    turtle
+    vole
+    vulture
+    wallaby
+    walrus
+    warthog
+    wasp
+    weasel
+    whale
+    wildebeest
+    wolf
+    wolfhound
+    wolverine
+    wombat
+    woodpecker
+    yak
+    zebra
+  ].freeze
+
+    ADJECTIVES = %w[
+  abandoned abashed aberrant abhorrent abiding ablaze able abnormal aboard abortive abounding abrasive abrupt absent absorbed absorbing abstracted absurd abundant abusive acceptable accessible accidental acclaimed accomplished accurate acid acidic acoustic acrid action active actual adept adhesive admirable admired adorable advanced adventurous affectionate afraid aged aggravating aggressive agile agitated agonizing agreeable ajar alarmed alarming alert alienated alive all allergic allowable aloof amazing ambitious ample amused amusing ancient angelic angry animated annual another antique anxious appalling appetizing apprehensive aquatic aromatic arrogant artistic ashamed aspiring assorted astonishing athletic attached attentive attractive audacious austere authentic authorized automatic available average aware awesome awful awkward
+  babyish back bad baggy bald balmy bandaged barbaric barren bashful basic battered beautiful beefy befitting belated beloved beneficial benign best better bewitched big billowy biodegradable bitter bizarre bland blazing blessed blithe bloated bloody blue blunt blurry blushing bogus boiling bold bony boorish bored boring boundless brainy brash brave brawny breakable breezy brief bright brilliant brisk broken bronze brown bruised bubbly bulky bumpy buoyant burdensome burly bustling busy buttery buzzing
+  cagey calculating callous calm candid canine capable capital capricious careful careless caring cautious cavernous celebrated celestial charming cheap cheerful cheery chief childlike chilly chivalrous choice chubby chunky circular civic civilized clammy classy clean clear clever close cloudy clumsy cluttered coarse cold colossal comfortable common compassionate competent complete complex complicated composed concerned concrete condemned confident confused conscious considerate constant content conventional cooked cool cooperative coordinated corny costly courageous courteous crafty cranky craven crazy creamy creative creepy crooked crowded cruel cuddly cultured cumbersome curious curly curved curvy cut cute cynical
+  daffy daily damaged damaging damp dangerous dapper daring dark dashing dazzling dead deadpan deafening dear debonair decisive decorous deep defeated defective defiant delicate delicious delightful demonic deranged deserted detailed determined devout diligent direful dirty disagreeable disastrous discreet disguised disgusting disillusioned dispensable distant distant distraught distressed disturbed divergent dizzy domineering doubtful drab draconian dramatic dreary drowsy drunk dry dull dusty dynamic dysfunctional
+  eager early earnest earsplitting earthy easy eatable economic educated efficacious efficient eight elastic elated elderly electric elegant elfin elite embarrassed eminent empty enchanted enchanting encouraging endurable energetic enormous entertaining enthusiastic envious equable equal erect erratic essential esteemed ethereal ethical euphoric evanescent evasive even evergreen everlasting excellent excited exciting exclusive exotic expensive experienced expert extensive extra-large extra-small exuberant exultant
+  fabulous faded faint fair faithful fallacious false familiar famous fanatical fancy fantastic far fascinated fast fat faulty fearful fearless feeble feigned fertile festive few fierce filthy fine finicky first fit five fixed flagrant flaky flashy flat flawless flimsy flippant flowery fluffy fluttering foamy foolish foregoing forgetful forgotten formal forsaken forthright fortunate four fragile frail frank frantic free freezing frequent fresh fretful friendly frightened frightening full fumbling functional funny furry furtive future futuristic fuzzy
+  gabby gainful gamy gaping garrulous gaudy general gentle genuine giant giddy gifted gigantic glamorous gleaming glib glistening glorious glossy godly good goofy gorgeous graceful gracious grandiose grateful gratis gray greasy great greedy green gregarious grieving groovy grotesque grouchy grubby gruesome grumpy guarded guiltless gullible gusty guttural
+  habitual half hallowed handsome handsomely hapless happy hard harmonious harsh hateful heady healthy heartbreaking heavenly heavy hellish helpful helpless hesitant hideous high highfalutin hilarious hissing historical holistic hollow homeless homely honorable horrible hospitable hot huge hulking humdrum humorous hungry hurried hurt hushed husky hypnotic hysterical
+  icky icy ideal idiotic ignorant ill illegal illustrious immaculate immense imminent impartial imperfect impolite important imported impossible incandescent incompetent inconclusive industrious incredible inexpensive infamous innate innocent inquisitive insidious instinctive intelligent interesting internal invincible irate irritating itchy
+  jaded jagged jazzy jealous jittery jobless jolly joyous judicious juicy jumbled jumpy juvenile
+  kaput keen kind kindhearted kindly knotty knowing knowledgeable known
+  labored lacking lame lamentable languid large last late laughable lavish lazy lean learned left legal lethal level lewd light like likeable limping literate little lively living lonely long longing loose lopsided loud loutish lovely loving low lowly lucky ludicrous luminous lumpy lush luxuriant lying lyrical
+  macabre macho maddening madly magenta magical magnificent majestic makeshift male malicious mammoth maniacal many marked married marvelous massive material materialistic mature mean measly meaty meek mellow melodic melted merciful mere mighty military mindless miniature minor miscreant misty mixed moaning modern moldy momentous motionless mountainous muddled muddy mundane murky mushy mute mysterious
+  naive narrow nasty natural naughty nauseating near neat nebulous necessary needless needy neighborly nervous new next nice nifty nimble nine nippy noiseless noisy nonchalant nondescript nonstop normal nostalgic nosy noxious null numberless numerous nutritious nutty
+  oafish obedient obeisant obese obnoxious obscene obsequious observant obsolete obtainable oceanic odd offbeat official old omniscient one onerous open opposite optimal orange ordinary organic ossified outgoing outrageous outstanding oval overconfident overjoyed overrated overt overwrought
+  pacific painful painstaking pale paltry panicky panoramic parallel parched parsimonious past pastoral pathetic peaceful penitent perfect periodic permissible perpetual petite phobic physical picayune pink piquant placid plain plant plastic plausible pleasant plucky pointless poised polite political poor possessive powerful practical precious premium present pretty previous pricey prickly private probable productive profuse protective proud psychedelic psychotic public puffy pumped puny pure purple pushy puzzled puzzling
+  quack quaint quarrelsome quarterly queasily queasy querulous questionable quick quickest quiet quirky quixotic quizzical quotable
+  rabid racial radiant ragged rainy rambunctious rampant rapid rare raspy ratty ready real rebel receptive recondite red redundant reflective regal regular relieved remarkable reminiscent repulsive resolute resonant responsible rhetorical rich right righteous rightful rigid ripe ritzy roasted robust romantic roomy rotten rough round royal ruddy rude rural rustic ruthless
+  sable sad safe salty same sassy satisfying savory savvy scandalous scarce scared scary scattered scientific scintillating scrawny screeching second secret secretive sedate seemly selective selfish separate serious shaggy shaky shallow sharp shiny shocked shocking short shrill shy sick silent silky silly simple simplistic sincere six skillful skinny sleepy slim slimy slippery sloppy slow small smelly smiling smoggy smooth sneaky snobbish snotty soft soggy solid somber sophisticated sordid sore sound sour spacious sparkling special spectacular spicy spiffy spiritual spiteful splendid spooky spotless spotted spotty spurious squalid square squealing squeamish stable staking stale standing statuesque steadfast steady steep stereotyped sticky stiff stimulating stingy stormy straight strange striped strong stunning stupendous sturdy subdued subsequent substantial successful succinct sudden sulky super superb superficial supreme surprised suspicious swanky sweet sweltering swift sympathetic symptomatic synonymous taboo tacit tacky talented tall tame tan tangible tangy tart tasteful tasteless tasty tawdry tearful tedious teeny teeny-tiny telling temporary tender tense tenuous terrible terrific tested thankful therapeutic thick thin thinkable third thirsty thoughtful thoughtless threatening three thundering tidy tight tightfisted tiny tired tiresome toothsome torpid tough towering tranquil trashy tremendous tricky troubled truculent true truthful two typical ubiquitous ugliest ugly ultra unaccountable unarmed unbecoming unbiased uncovered understood undesirable unequal unequaled uneven unfair uninterested unique unkempt unknown unnatural unruly unsightly unsuitable untidy unused unusual unwieldy unwritten upbeat uppity upset uptight used useful useless utopian utter uttermost
+  vacuous vagabond vague valuable various vast vengeful venomous verdant versed victorious vigorous violent violet vivacious voiceless volatile voracious vulgar
+  wacky waggish waiting wakeful wandering wanting warlike warm wary wasteful watery weak wealthy weary well wet whimsical whispering white whole wholesale wicked wide wide-eyed wiggly wild willing windy wiry wise wistful witty woebegone womanly wonderful wooden woozy workable worried worthless wrathful wretched wrong wry
+  xenophobic yellow yielding young youthful yummy zany zealous zesty zippy zonked
+].freeze
+  end
+end

data/sig/md5_to_random_name.rbs

@@ -0,0 +1,30 @@
+# sig/md5_to_random_name.rbs
+module Md5ToRandomName
+  VERSION: String
+
+  # Exception classes
+  class Error < StandardError
+  end
+
+  class InvalidMd5Hash < Error
+  end
+
+  # Generator class
+  class Generator
+    @adjectives: Array[String]
+    @animals: Array[String]
+
+    def initialize: (?Array[String] adjectives, ?Array[String] animals) -> void
+    def generate: (String md5) -> String
+
+    private
+
+    def validate_md5!: (String md5) -> void
+    def select_adjective: (String md5) -> String
+    def select_animal: (String md5) -> String
+    def extract_suffix: (String md5) -> String
+    def format_name: (String adjective, String animal, String suffix) -> String
+  end
+
+  def self.generate: (String md5, ?Array[String] adjectives, ?Array[String] animals) -> String
+end

data/sig/word_lists.rbs

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Md5ToRandomName
+  module WordLists
+    ADJECTIVES: Array[String]
+    ANIMALS: Array[String]
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: md5_to_random_name
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Tio
+bindir: exe
+cert_chain: []
+date: 2025-03-16 00:00:00.000000000 Z
+dependencies: []
+description: Convert MD5 hashes to human-readable names in the format of adjective-animal-suffix
+email:
+- 6956294+WToa@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/md5_to_random_name.rb
+- lib/md5_to_random_name/version.rb
+- lib/word_lists.rb
+- sig/md5_to_random_name.rbs
+- sig/word_lists.rbs
+homepage: https://github.com/WToa/md5_to_random_name
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/WToa/md5_to_random_name
+  source_code_uri: https://github.com/WToa/md5_to_random_name
+  changelog_uri: https://github.com/WToa/md5_to_random_name/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Convert MD5 hashes to human-readable names
+test_files: []