0.01
No commit activity in last 3 years
No release in over 3 years
An easy uuid wrapper for ruby applications
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.6
>= 0
>= 0

Runtime

 Project Readme

HashIdentable

Why expose your public ID's if you don't need to? Hang hash_identable on your rails models and use the #uuid method to get a unique id of any item.

Credits

This gem wraps the hashids.org ruby gem: http://hashids.org/ruby/

Installation

Add this line to your application's Gemfile:

gem 'hash_identable', :git => 'https://github.com/octaviuslabs/hash_identable.git'

And then execute:

$ bundle

Usage

Assuming your model

  class MyModel
    attr_reader :id #HashIdentable depends on the presence of an ID
    # Other code
  end

Configure the gem

  HashIdentable.config do |c|
    c.set_salt "My Salt"  #THIS VALUE SHOULD NEVER CHANGE FOR THE APPLICATION
    c.set_length 36
    c.add_object MyModel, 3
  end

When you want the hashid:

  obj = MyModel.new(id: 12)
  obj.uuid

Or:

  obj = MyModel.new(id: 12)
  obj.identity.to_s

When you want to find an object based on the hashid:

  obj = HashIdentable::Locator.find([<find_method>], id) # Non ActiveRecord
  obj = HashIdentable::Locator::ActiveRecord.find(id) #ActiveRecord

Contributing

  1. Fork it ( https://github.com/[my-github-username]/hash_identable/fork )
  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 a new Pull Request