Randomize ActiveRecord IDs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
app/models/concerns
lib
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DEPRECATIONS.md
Gemfile
LICENSE
README.md
Rakefile
randomize_id.gemspec

README.md

RandomizeId

Gem Version

Randomize the id attribute of ActiveRecord objects.


Table of Contents


Installation

RandomizeId works with Rails 5 onwards. You can add it to your Gemfile with:

gem 'randomize_id'

And then execute:

$ bundle

Or install it yourself as:

$ gem install randomize_id

If you always want to be up to date fetch the latest from GitHub in your Gemfile:

gem 'randomize_id', github: 'jonhue/randomize_id'

Now run the generator:

$ rails g randomize_id

Usage

Unless you configured RandomizeId to automatically randomize IDs for all ActiveRecord objects, you have to add the following to every model whose records should have random Ids:

include RandomizeId

That's it!


Configuration

You can configure RandomizeId by passing a block to configure. This can be done in config/initializers/randomize_id.rb:

RandomizeId.configure do |config|
    config.auto = false
end
  • auto Automaitcally randomize IDs of all ActiveRecord objects. Takes a boolean. Defaults to false.

To Do

Here is the full list of current projects.

To propose your ideas, initiate the discussion by adding a new issue.


Contributing

We hope that you will consider contributing to RandomizeId. Please read this short overview for some information about how to get started:

Learn more about contributing to this repository, Code of Conduct

Contributors

Give the people some ❤️ who are working on this project. See them all at:

https://github.com/jonhue/randomize_id/graphs/contributors

Semantic Versioning

RandomizeId follows Semantic Versioning 2.0 as defined at http://semver.org.

License

MIT License

Copyright (c) 2018 Jonas Hübotter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.