yono/typable_map

# TypableMap 

[![Code Climate](https://codeclimate.com/github/yono/typable_map.png)](https://codeclimate.com/github/yono/typable_map) 
[![gemnasium](https://gemnasium.com/yono/typable_map.png)](https://gemnasium.com/yono/typable_map.png) 
[![Build Status](https://travis-ci.org/yono/typable_map.png?branch=master)](https://travis-ci.org/yono/typable_map)
[![Coverage Status](https://coveralls.io/repos/yono/typable_map/badge.png)](https://coveralls.io/r/yono/typable_map)

TypableMap assigns a uniq string to an object and fetches the object by the string.

It's inspired by TweetIrcGateway and FacebookIrcGateway.

## Installation

Add this line to your application's Gemfile:

    gem 'typable_map'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install typable_map

## Usage

    require 'typable_map'

    typable_map = TypableMap::TypableMap.new(max_size: 1000, shuffle: true)

    # assign a uniq string to an object

    obj1 = Object.new
    uniq_string1 = typable_map.push(obj1)
    puts uniq_string1 # => 'vowi'

    obj2 = Object.new
    uniq_string2 = typable_map.push(obj2)
    puts uniq_string2 # => 'lizo'

    # fetch an object

    obj1 = typable_map[uniq_string1]

    obj2 = typable_map[uniq_string2]

## Development

    $ bundle install --path vendor/bundle
    ... add tests and add features.
    $ bundle exec rake test

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request