happy_slugs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1ac5958a40f6b82ef5a800d2c8254db0ca51e0d7d366175fd8acab9a321fb8e
+  data.tar.gz: a54fe1b412133a631f06d747cb8945a60be397f7bba55464fecb3842696e9a0e
+SHA512:
+  metadata.gz: e20e9a4ae93bdeed91a611299a0b2fd11215c745a6c1ea5899000ed7013558b5eca71f099b3e735c0119cd8c4c5bdd2c7ef99df9cc4dd1195dd8f3af60bfb1d0
+  data.tar.gz: 12b1219f5b002108ba2e2a3269c79d3b7b2ff22008fd51d7b2c4586a3395c39a5a1a9dbe9caef7707f149bc00adbef6a665e1f6e8c44fd23ff5a3a85f715e662

data/lib/happy_slugs/version.rb

@@ -0,0 +1,3 @@
+module HappySlugs
+  VERSION = "0.1.0"
+end

data/lib/happy_slugs/words.rb

@@ -0,0 +1,88 @@
+module HappySlugs
+  module Words
+    ADJECTIVES = %w[
+      afraid all beige better big blue bold brave breezy bright brown bumpy
+      busy calm chatty chilly chubby clean clear clever cold common cool cozy
+      crisp cuddly curly curvy cute cyan dark deep dirty dry dull eager early
+      easy eight eighty eleven empty every fair famous fancy fast few fiery
+      fifty fine five flat floppy fluffy forty four frank free fresh fruity
+      full funky funny fuzzy gentle giant gold good goofy great green grumpy
+      happy heavy hip honest hot huge humble hungry icy itchy jolly khaki kind
+      large late lazy legal lemon light little long loose loud lovely lucky
+      major many metal mighty modern moody neat new nice nine ninety odd old
+      olive open orange perky petite pink plain plenty polite pretty proud
+      public puny purple quick quiet rare ready real red rich ripe salty seven
+      shaggy shaky sharp shiny short shy silent silly silver six sixty slick
+      slimy slow small smart smooth social soft solid some sour sparkly spicy
+      spotty stale strict strong sunny sweet swift tall tame tangy tasty ten
+      tender thick thin thirty three tidy tiny tired tough tricky true twelve
+      twenty two upset vast violet wacky warm wet whole wicked wide wild wise
+      witty yellow young yummy
+    ].freeze
+
+    NOUNS = %w[
+      actors ads adults aliens animals ants apes apples areas baboons badgers
+      bags balloons bananas banks bars baths bats beans bears beds beers bees
+      berries bikes birds boats bobcats books bottles boxes breads brooms
+      buckets bugs buses bushes buttons camels cameras candies candles canyons
+      carpets carrots cars cases cats chairs chefs chicken cities clocks cloths
+      clouds clowns clubs coats cobras coins colts comics cooks corners cougars
+      cows crabs crews cups cycles dancers days deer deserts dingos dodos dogs
+      dolls donkeys donuts doodles doors dots dragons drinks dryers ducks eagles
+      ears eels eggs emus ends experts eyes facts falcons fans feet files flies
+      flowers forks foxes friends frogs games garlics geckos geese ghosts gifts
+      glasses goats grapes groups guests hairs hands hats heads hoops hornets
+      horses hotels hounds houses humans icons ideas impalas insects islands
+      items jars jeans jobs jokes keys kids kings kiwis knives lamps lands laws
+      lemons lies lights lilies lines lions lizards llamas loops mails mammals
+      mangos maps masks meals melons memes meteors mice mirrors moles moments
+      monkeys months moons moose mugs nails needles news nights numbers olives
+      onions oranges otters owls pandas pans pants papayas papers parents parks
+      parrots parts paths paws peaches pears peas pens pets phones pianos pigs
+      pillows places planes planets plants plums poems poets points pots pugs
+      pumas queens rabbits radios rats ravens readers regions results rice rings
+      rivers rockets rocks rooms roses rules sails schools seals seas sheep
+      shirts shoes showers shrimps sides signs singers sites sloths snails
+      snakes socks spiders spies spoons squids stamps stars states steaks
+      streets suits suns swans symbols tables taxes taxis teams teeth terms
+      things ties tigers times tips tires toes tools towns toys trains trams
+      trees turkeys turtles vans views walls wasps waves ways webs weeks
+      windows wings wolves wombats words worlds worms yaks years zebras zoos
+    ].freeze
+
+    VERBS = %w[
+      accept act add admire agree allow appear argue arrive ask attack attend
+      bake bathe battle beam beg begin behave bet boil bow brake brush build
+      burn buy call camp care carry change cheat check cheer chew clap clean
+      cough count cover crash create cross cry cut dance decide deny design dig
+      divide do double doubt draw dream dress drive drop drum eat end enjoy
+      enter exist fail fall feel fetch film find fix flash float flow fly fold
+      follow fry give glow go grab greet grin grow guess hammer hang happen
+      heal hear help hide hope hug hunt invent invite itch jam jog join joke
+      judge juggle jump kick kiss kneel knock know laugh lay lead learn leave
+      lick lie like listen live look lose love make march marry mate matter
+      melt mix move nail notice obey occur open own pay peel pick play poke
+      post press prove pull pump punch push raise read refuse relate relax
+      remain repair repeat reply report rescue rest retire return rhyme ring
+      roll rule run rush say scream search see sell send serve shake share
+      shave shine shop shout show sin sing sink sip sit sleep slide smash smell
+      smile smoke sneeze sniff sort speak spend stand stare start stay stick
+      stop strive study swim switch take talk tan tap taste teach tease tell
+      thank think throw tickle tie trade train travel try turn type unite
+      vanish visit wait walk warn wash watch wave wear win wink wish wonder
+      work worry write yawn yell
+    ].freeze
+
+    ADVERBS = %w[
+      bravely brightly busily daily freely hungrily joyously knowingly lazily
+      noisily oddly politely quickly quietly rapidly safely sleepily slowly
+      truly yearly
+    ].freeze
+
+    LISTS = { adjective: ADJECTIVES, noun: NOUNS, verb: VERBS, adverb: ADVERBS }.freeze
+
+    def self.sample(type)
+      LISTS.fetch(type).sample
+    end
+  end
+end

data/lib/happy_slugs.rb

@@ -0,0 +1,89 @@
+require "active_record"
+require "securerandom"
+require_relative "happy_slugs/version"
+require_relative "happy_slugs/words"
+
+module HappySlugs
+  class ExhaustedError < StandardError; end
+
+  DEFAULT_PATTERN = %i[adjective noun verb].freeze
+  BATCH_SIZE = 10
+
+  module SlugGenerator
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :generate_happy_slug
+      scope :with_happy_slug_in, ->(slugs) { where(happy_slug_attribute => slugs) }
+    end
+
+    def happy_slug
+      self[happy_slug_attribute]
+    end
+
+    private
+
+    def generate_happy_slug
+      if happy_slug.nil?
+        happy_slug_patterns.each do |pattern|
+          candidates = BATCH_SIZE.times.map { build_happy_slug(pattern) }
+          existing = self.class.with_happy_slug_in(candidates).pluck(happy_slug_attribute)
+
+          available = candidates - existing
+
+          if available.any?
+            self[happy_slug_attribute] = available.sample
+            break
+          end
+        end
+      end
+
+      if happy_slug.nil?
+        raise ExhaustedError, "could not generate a unique slug for #{self.class.name}"
+      end
+    end
+
+    def happy_slug_patterns
+      [happy_slug_pattern, happy_slug_pattern + [:suffix]].uniq
+    end
+
+    def build_happy_slug(pattern)
+      pattern.map { |segment|
+        if segment == :suffix
+          SecureRandom.alphanumeric(happy_slug_suffix_length).downcase
+        else
+          Words.sample(segment)
+        end
+      }.join(happy_slug_separator)
+    end
+
+    class_methods do
+      def backfill_happy_slugs
+        count = 0
+        where(happy_slug_attribute => nil).find_each do |record|
+          record.send(:generate_happy_slug)
+          record.update_column(happy_slug_attribute, record[happy_slug_attribute])
+          count += 1
+        rescue ActiveRecord::RecordNotUnique => e
+          raise unless e.message.include?(happy_slug_attribute.to_s)
+          record[happy_slug_attribute] = nil
+          retry
+        end
+        count
+      end
+    end
+  end
+
+  def has_happy_slugs(attribute = :slug, pattern: DEFAULT_PATTERN, separator: "-", suffix_length: 4)
+    class_attribute :happy_slug_attribute, default: attribute
+    class_attribute :happy_slug_pattern, default: pattern
+    class_attribute :happy_slug_separator, default: separator
+    class_attribute :happy_slug_suffix_length, default: suffix_length
+
+    include SlugGenerator
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend HappySlugs
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: happy_slugs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Dawson
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/happy_slugs.rb
+- lib/happy_slugs/version.rb
+- lib/happy_slugs/words.rb
+homepage: https://github.com/carldaws/happy_slugs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/carldaws/happy_slugs
+  source_code_uri: https://github.com/carldaws/happy_slugs
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Pleasant, random, human-readable slugs for ActiveRecord models
+test_files: []