Sha256: 588c05220c8b6e2a41f714b1f873457d4c751b232ebc143c6921c7d06afb9284

Contents?: true

Size: 1.48 KB

Versions: 3

Compression:

Stored size: 1.48 KB

Contents

# ActsAsScrubbable

Scrubbing made easy

Acts as scrubbable give you model level access to scrub your data per object.

It runs using the parallel gem for faster processing which is dependent on the
amount of cores available on the box.  *More cores == faster scrubbing*


## Installation

```ruby
gem 'acts_as_scrubbable'
```

## Usage

Simple add the configuration for your fields that map directly to your columns


```ruby
class User < ActiveRecord::Base
  ...

  acts_as_scrubbable :first_name, :last_name


  # optionally you can add a scope to limit the rows to update
  scope :scrubbable_scope, -> { where(some_value: true) }

  ...
end
```


Incase the mapping is not straight forward

```ruby
class Address
  acts_as_scrubbable :lng => :longitude, :lat => :latitude
end
```


### To run
```
rake scrub

....
Type SCRUB to continue.
SCRUB
W, [2015-11-05T14:09:20.900771 #64194]  WARN -- : Scrubbing classes
I, [2015-11-05T14:09:24.228012 #64194]  INFO -- : Scrubbing ClassToScrub
...
I, [2015-11-05T14:09:25.615155 #64194]  INFO -- : Scrub Complete!

```

In the case you are automating the rake task and want to skip the confirmation

```
rake scrub SKIP_CONFIRM=true
```



### Extending

You may find the need to extend or add additional generators or an after_hook

```ruby
ActsAsScrubbable.configure do |c|
  c.add :email_with_prefix, -> { "prefix-#{Faker::Internet.email}" }

  c.after_hook do
    puts "Running after commit"
    ActiveRecord::Base.connection.execute("TRUNCATE some_table")
  end
end
```

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
acts_as_scrubbable-0.0.9 README.md
acts_as_scrubbable-0.0.8 README.md
acts_as_scrubbable-0.0.7 README.md