Contents

# DigestGenerator

A simple digest generator which uses xxhash for digest generation.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'digest_generator', :branch => 'master' 
```

And then run `bundle install` in application root directory.


## Usage

Supported Algorithm at present is xxHash.

This gem can be used in two ways:

### To generate Hash 64 and mask bit 63 (0-63) (to remove signedness to be compatible with postgress bigints) call: <br/>

```ruby
DigestGenerator.digest_63bit(payload)
```

### To generate Hash 64 bit digest
```ruby
DigestGenerator.digest_64bit(payload)
```

### To generate Hash 32 bit digest
```ruby
DigestGenerator.digest_32bit(payload)
```

### To use digest as a primary key for a model you need to include DigestGenerator module and define DIGEST_VALID_KEYS as:

```ruby
include DigestGenerator
self.primary_key = 'digest'
DIGEST_VALID_KEYS = %w[
    name
  ].freeze

```

Call refresh_digest on an instance of your model to set its digest value. <br/>
```ruby
person = Person.new(name: 'something')
# (Set the supported algorithm. As xxHash is the default algorithm you can skip this step if you want to use xxHash algorithm.)
person.algorithm = 'xxHash'
# (now your digest key is set to 64 bit and mask bit 63 (0-63) value)
person.refresh_digest 

```

You can also set algorithm by creating a file digest_generator.rb in config/initializers folder
 with: <br/>
```ruby
DigestGenerator.algorithm = 'xxHash' 
```

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the DigestGenerator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/digest_generator/blob/master/CODE_OF_CONDUCT.md).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
digest_generator-0.1.2	README.md
digest_generator-0.1.1	README.md