A Ruby gem for creating Github like identicons
A Ruby gem for creating Github like identicons
A Ruby implementation of go-identicon by Damian Gryski
RubyIdenticon creates an identicon, similar to those created by Github.
A title and key are used by siphash to calculate a hash value that is then used to create a visual identicon representation. The identicon is made by creating a left hand side pixel representation of each bit in the hash value - this is then mirrored onto the right hand side to create an image that we see as a shape. The grid and square sizes can be varied to create identicons of differing size.
Add this line to your application's Gemfile:
gem 'ruby_identicon'And then execute:
$ bundleOr install it yourself as:
$ gem install ruby_identiconCreating an identicon and saving to png
RubyIdenticon.create_and_save("RubyIdenticon", "ruby_identicon.png")Creating an identicon and returning a binary string
blob = RubyIdenticon.create("RubyIdenticon")
# optional, save to a file
File.open("ruby_identicon.png", "wb") do |f| f.write(blob) endCreating an identicon and returns in base64 format
base64_identicon = RubyIdenticon.create_base64("RubyIdenticon")nb// to render this in html pass the base64 code into your view
raw ""The identicon can be customised by passing additional options
background_color: (Integer, default 0) the background color of the identicon in rgba notation (e.g. 0xffffffff for white)
border_size: (Integer, default 35) the size in pixels to leave as an empty border around the identicon image
grid_size: (Integer, default 7) the number of rows and columns in the identicon, minimum 4, maximum 9
square_size: (Integer, default 50) the size in pixels of each square that makes up the identicon
key: (String) a 16 byte key used by siphash when calculating the hash value (see note below)
Varying the key ensures uniqueness of an identicon for a given title, it is assumed desirable for different applications
to use a different key.Example
blob = RubyIdenticon.create("identicons are great!", grid_size: 5, square_size: 70, background_color: 0xf0f0f0ff, key: "1234567890123456")
File.open("tmp/test_identicon.png", "wb") do |f| f.write(blob) endgit checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)No open issues yet, or sync has not completed.