Whisk::Rails

Build Status Ruby Ruby Rails Rails

Welcome to whisk.

A gem we use @Hoppinger in order to scramble our data. whisk-rails uses the faker gem in order to generate random data to be used whilst scrambling.

Installation

Add this line to your application's Gemfile:

gem 'whisk-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install whisk-rails

Usage

Create a .whisk.yml in the root of your project. Use this file to configure Whisk.

models:
  user: # The model you want to scramble in.
    email: 'internet/email' # The field and fakerclass/method you want to scramble with
  admin:
    email: 'internet/user_name'

You're set. Run [bundle exec] whisk scramble rails to scramble your rails application.

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

TODO

  • Drupal supported
  • Wordpress support

Testing

First prepare appraisal

$ appraisal install

Then you can run the tests

$ appraisal rspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hoppinger/whisk-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Hoppinger

This gem was created by Hoppinger

forthebadge

License

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