Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • abbrev.rb


Class/Module Index [+]



Calculate the set of unique abbreviations for a given set of strings.

require 'abbrev'
require 'pp'

pp Abbrev::abbrev(['ruby', 'rules']).sort


[["rub", "ruby"],
 ["ruby", "ruby"],
 ["rul", "rules"],
 ["rule", "rules"],
 ["rules", "rules"]]

Also adds an abbrev method to class Array.

Public Class Methods

abbrev(words, pattern = nil) click to toggle source

Given a set of strings, calculate the set of unambiguous abbreviations for those strings, and return a hash where the keys are all the possible abbreviations and the values are the full strings. Thus, given input of “car” and “cone”, the keys pointing to “car” would be “ca” and “car”, while those pointing to “cone” would be “co”, “con”, and “cone”.

The optional pattern parameter is a pattern or a string. Only those input strings matching the pattern, or begging the string, are considered for inclusion in the output hash

               # File abbrev.rb, line 43
def abbrev(words, pattern = nil)
  table = {}
  seen = Hash.new(0)

  if pattern.is_a?(String)
    pattern = /^#{Regexp.quote(pattern)}/  # regard as a prefix

  words.each do |word|
    next if (abbrev = word).empty?
    while (len = abbrev.rindex(/[\w\W]\z/)) > 0
      abbrev = word[0,len]

      next if pattern && pattern !~ abbrev

      case seen[abbrev] += 1
      when 1
        table[abbrev] = word
      when 2

  words.each do |word|
    next if pattern && pattern !~ word

    table[word] = word


Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.