IntegerHash

A small Ruby gem that implements Knuth's multiplication hashing algorithm with the following properties: fast, reversable and zero collisions.

This is a port from PHP of the jenssegers/optimus package.

Installation

Add this line to your application's Gemfile:

gem 'integer_hash'

And then execute:

$ bundle

Or install it yourself as:

$ gem install integer_hash

Configure

Write the defaults taken from IntegerHash::Generator.generate_configuration in config/initializers/integer_hash.rb:

IntegerHash.configure do |config|
  config.prime =
  config.inverse_integer =
  config.random_integer =
end

Usage

$ IntegerHash.encode(42)
=> 1591777047
$ IntegerHash.decode(1591777047)
=> 42

Alternatives

There are only two alternatives to this gem written in Ruby. 'hashids' gem and 'obfuscate_id' gem which both offer the same main feature: encoding integers so that you don't expose database ids to the user.

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/icehero/integer_hash.

License

The gem is available as open source under the terms of the MIT License.