abbreviations.rb

# mod for doing stuff w/ abbrevs
module Abbrev
  # a list of abbreviations culled, at least in part, from the USPS
  # official list https://www.usps.com/send/official-abbreviations.htm#2
  # this might be too country-specific, but it's a start.
  ABBREVIATIONS = {
    "alley" => ["aly"],
    "annex" => ["anx"],
    "arcade" => ["arc"],
    "avenue" => ["ave"],
    "beach" => ["bch"],
    "burg" => ["bg"],
    "bluff" => ["blf"],
    "boulevard" => ["blvd"],
    "bend" => ["bnd"],
    "branch" => ["br"],
    "bridge" => ["brg"],
    "brook" => ["brk"],
    "bottom" => ["btm"],
    "bayoo" => ["byu"],
    "circle" => ["cir"],
    "club" => ["clb"],
    "cliff" => ["clf"],
    "common" => ["cmn"],
    "corner" => ["cor"],
    "camp" => ["cp"],
    "cape" => ["cpe"],
    "crescent" => ["cr","cres"],
    "creek" => ["crk"],
    "course" => ["crse"],
    "crest" => ["crst"],
    "causeway" => ["cswy"],
    "court" => ["ct"],
    "center" => ["ctr"],
    "curve" => ["curv"],
    "cove" => ["cv"],
    "canyon" => ["cyn"],
    "dale" => ["dl"],
    "dam" => ["dm"],
    "drive" => ["dr"],
    "divide" => ["dv"],
    "east" => ["e"],
    "estate" => ["est"],
    "expressway" => ["expy"],
    "extension" => ["ext"],
    "field" => ["fld"],
    "flat" => ["flt"],
    "ford" => ["frd"],
    "forge" => ["frg"],
    "fork" => ["frk"],
    "forest" => ["frst"],
    "ferry" => ["fry"],
    "fort" => ["ft"],
    "freeway" => ["fwy"],
    "garden" => ["gdn"],
    "glen" => ["gln"],
    "green" => ["grn"],
    "grove" => ["grv"],
    "gateway" => ["gtwy"],
    "harbor" => ["hbr"],
    "hill" => ["hl"],
    "hollow" => ["holw"],
    "haven" => ["hvn"],
    "highway" => ["hwy"],
    "inlet" => ["inlt"],
    "island" => ["is"],
    "junction" => ["jct"],
    "knoll" => ["knl"],
    "key" => ["ky"],
    "lock" => ["lck"],
    "lodge" => ["ldg"],
    "loaf" => ["lf"],
    "light" => ["lgt"],
    "lake" => ["lk"],
    "lane" => ["ln"],
    "landing" => ["lndg"],
    "meadow" => ["mdw"],
    "mill" => ["ml"],
    "manor" => ["mnr"],
    "mission" => ["msn"],
    "mount" => ["mt"],
    "mountain" => ["mtn"],
    "motorway" => ["mtwy"],
    "neck" => ["nck"],
    "north" => ["n"],
    "orchard" => ["orch"],
    "parkway" => ["pkwy"],
    "place" => ["pl"],
    "plain" => ["pln"],
    "plaza" => ["plz"],
    "pine" => ["pne"],
    "prairie" => ["pr"],
    "port" => ["prt"],
    "passage" => ["psge"],
    "point" => ["pt"],
    "radial" => ["radl"],
    "road" => ["rd"],
    "ridge" => ["rdg"],
    "river" => ["riv"],
    "ranch" => ["rnch"],
    "row" => ["row"],
    "rapid" => ["rpd"],
    "rest" => ["rst"],
    "route" => ["rte"],
    "shoal" => ["shl"],
    "shore" => ["shr"],
    "skyway" => ["skwy"],
    "south" => ["s"],
    "summit" => ["smt"],
    "spring" => ["spg"],
    "square" => ["sq"],
    "street" => ["st"],
    "station" => ["sta"],
    "stravenue" => ["stra"],
    "stream" => ["strm"],
    "terrace" => ["ter"],
    "turnpike" => ["tpke"],
    "track" => ["trak"],
    "trace" => ["trce"],
    "trafficway" => ["trfy"],
    "trail" => ["trl"],
    "throughway" => ["trwy"],
    "tunnel" => ["tunl"],
    "union" => ["un"],
    "viaduct" => ["via"],
    "vista" => ["vis"],
    "ville" => ["vl"],
    "village" => ["vlg"],
    "valley" => ["vly"],
    "view" => ["vw"],
    "way" => ["wy"],
    "well" => ["wl"],
    "west" => ["w"],
    "crossing" => ["xing"],
    "crossroad" => ["xrd"]
  }

  # of course, this is horribly english-specific...
  # but how would one expand this in a sensible fashion to
  # cover other languages?
  COMPASS = {
    "n"   => ["north"],
    "nne" => ["north","north","east"],
    "ne"  => ["north","east"],
    "ene" => ["east","north","east"],
    "e"   => ["east"],
    "ese" => ["east","south","east"],
    "se"  => ["south","east"],
    "sse" => ["south","south","east"],
    "s"   => ["south"],
    "ssw" => ["south","south","west"],
    "sw"  => ["south","west"],
    "wsw" => ["west","south","west"],
    "w"   => ["west"],
    "wnw" => ["west","north","west"],
    "nw"  => ["north","west"],
    "nnw" => ["north","north","west"]
  }

  # function for expanding a string into a list of strings
  # TODO: may need some work for internationalisation
  def self.equal_expansions(a, b)
    a = a.downcase.split(/[[:punct:][:space:]]+/)
    b = b.downcase.split(/[[:punct:][:space:]]+/)

    # expand compass directions in each - SPECIAL CASE... this is kinda
    # nasty, but i really can't think of a better way to do it at the
    # moment...
    a = a.inject(Array.new) do |ary,el| 
      if COMPASS.has_key? el
        ary + COMPASS[el]
      else
        ary + [el]
      end
    end
    b = b.inject(Array.new) do |ary,el| 
      if COMPASS.has_key? el
        ary + COMPASS[el]
      else
        ary + [el]
      end
    end

    # no expansions which alter the number of words. (really? - check this)
    return false if a.length != b.length
    
    # check whether each is equal], or can be reached by expansion
    # or abbreviation.
    a.zip(b) do |a_el, b_el|
      if a_el != b_el
        match = ((ABBREVIATIONS.has_key?(a_el) && ABBREVIATIONS[a_el].any? {|a_ab| a_ab == b_el}) or
                 (ABBREVIATIONS.has_key?(b_el) && ABBREVIATIONS[b_el].any? {|b_ab| b_ab == a_el}))
        return false if not match
      end
    end

    return true
  end
end