Build ka scrub types #1

kaungst · 2018-08-13T16:59:10Z

No description provided.

Will not include .idea files.

Adds default scrub_types - scrub - anonymize field value - skip - keep field's value the same - wipe - set field's value to nil - sterilize - destroy all records

jakeonfire · 2018-08-13T18:16:49Z

README.md

-  acts_as_scrubbable :first_name, :last_name
+  acts_as_scrubbable :scrub, :first_name # first_name will be random after `scrub!`
+  acts_as_scrubbable :skip, :middle_name # middle_name will be original value after `scrub!`
+  acts_as_scrubbable :wipe, :last_name # last_name will be `nil` after `scrub!`


i don't love the DSL calling the same method 3 times, but otherwise the concept is sound. is there an easy way to come up with a way to create one dataset for the complete class configuration? maybe something like:

acts_as_scrubbable scrub: [:first_name, lat: :latitude], skip: [:middle_name], wipe: [:last_name]

also, this technique would need to be paired with some validation that when any fields are configured to be scrubbed, skipped or wiped, that all fields are configured, right? otherwise 'skip' and literally skipping are the same... or is that something AnonCat would do?

ahh, anonymizer_check!

on further thought, it'd be really cool to be able to define scrub procs here, too. e.g.:

acts_as_scrubbable scrub: [gender: -> { %w(M F).sample }]

:wipe scrub type could as easily be a :nullify scrub strategy

fan of the array update and would push for going more in that direction.

also agree that defining scrub procs would be neat (maybe a well placed is_a?(Proc)?)

went with wipe for the theme :D, also thought it left room for fancier wiping (empty string?). Fine with nullify

jakeonfire · 2018-08-13T18:19:09Z

README.md


+class SterilizeExample < ActiveRecord::Base
+  acts_as_scrubbable :sterilize # table will contain no records after `scrub!`
+end


jakeonfire · 2018-08-13T18:20:19Z

lib/acts_as_scrubbable.rb

-      :school            => -> { Faker::University.name }
+      :school            => -> { Faker::University.name },
+      :bs                => -> { Faker::Company.bs },
+      :phone_number      => -> { Faker::PhoneNumber.phone_number }


i personally found using these built-ins just some of the time seemed confusing, so didn't use them at all.

after looking at the other PR i see you used :bs a bunch, so makes sense to put it either here or in the initializer config in that case.

jakeonfire · 2018-08-13T18:21:47Z

lib/acts_as_scrubbable/scrub.rb

    def scrub!
      return unless self.class.scrubbable?

      run_callbacks(:scrub) do
+        if self.class.sterilizable?
+          self.destroy!


think delete is safer, since the other updates also don't run callbacks, but now that i think about it maybe we do want them in case of dependent: :destroys? dunno...

also worried that calling destroy! on every row in a table will be pretty slow. can you think of a way to truncate it instead via SQL a-la the after-hook example in the README?

in the tasks.rb:69 there's an initial check for sterilizable models that will call delete_all. you are both correct that it avoids the destroy calls and that there are dependent destroy issues. had realized it running the migration, brought it up in the story. feel like we kind of need the destroy_all b/c of the dependent destroy. side note this also creates an issue for large tables (thinking weight table of 70M records :( )

jakeonfire · 2018-08-13T18:24:50Z

lib/acts_as_scrubbable/scrub.rb

          else
-            puts "Undefined scrub: #{value} for #{self.class}#{_field}"
-           end
+            puts "Undefined scrub: #{value} for #{self.class}.#{_field}"


#{self.class}##{_field}" is a bit more ruby-doc

jakeonfire · 2018-08-13T18:25:49Z

lib/acts_as_scrubbable/scrubbable.rb

    def scrubbable?
      false
    end

+    def acts_as_scrubbable(scrub_type=:scrub, *scrubbable_fields, **mapped_fields)


i don't think you can have default values to the left of var-args?

You can! it just isn't respected. Was having trouble finding a good way to fit in the scrub_type while not creating too breaking of a change. I think the approach you listed at the top is better (kwargs all the way, arrays of symbols or kwargs as values

jakeonfire · 2018-08-13T18:31:25Z

README.md

  ...

-  acts_as_scrubbable :first_name, :last_name
+  acts_as_scrubbable :scrub, :first_name # first_name will be random after `scrub!`


i feel like "faker-generated" is clearer than "random". i had to look at the source code to figure that out.

jakeonfire · 2018-08-13T18:31:54Z

README.md

  ...

-  acts_as_scrubbable :first_name, :last_name
+  acts_as_scrubbable :scrub, :first_name # first_name will be random after `scrub!`
+  acts_as_scrubbable :skip, :middle_name # middle_name will be original value after `scrub!`


"will be unchanged"?

jakeonfire · 2018-08-13T21:15:40Z

README.md


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

+  c.before_hook do
+    puts "Running before scrub"
+    raise "Don't run in production" if Rails.env.production?


will the env ever be production? the other PR assumes it is always development in the anonymizer_check task...
is there a way to instead look at something that is not configurable, like database name, or server, or?

on further thought, this suggestion makes no sense. it's good as-is.

jakeonfire · 2018-08-14T07:15:38Z

i'm going to push for getting a simple version out to populate staging, then work on a more unified approach via this branch after.

kaungst added 4 commits August 11, 2018 21:47

Update .gitignore

74a3c60

Will not include .idea files.

Creates support for scrub_type

d66f5a4

Adds default scrub_types - scrub - anonymize field value - skip - keep field's value the same - wipe - set field's value to nil - sterilize - destroy all records

Add support for before_hook

df0d0e5

Add bs, phone_number, and full_address scrub types.

108525e

jakeonfire reviewed Aug 13, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build ka scrub types #1

Build ka scrub types #1

kaungst commented Aug 13, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

kaungst Aug 14, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018 •

edited

Loading

jakeonfire Aug 13, 2018 •

edited

Loading

kaungst Aug 14, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018

kaungst Aug 14, 2018

jakeonfire Aug 13, 2018

jakeonfire Aug 13, 2018 •

edited

Loading

jakeonfire Aug 13, 2018

jakeonfire Aug 14, 2018

jakeonfire commented Aug 14, 2018

Build ka scrub types #1

Are you sure you want to change the base?

Build ka scrub types #1

Conversation

kaungst commented Aug 13, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakeonfire Aug 13, 2018 • edited Loading

Choose a reason for hiding this comment

jakeonfire Aug 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakeonfire Aug 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakeonfire commented Aug 14, 2018

jakeonfire Aug 13, 2018 •

edited

Loading

jakeonfire Aug 13, 2018 •

edited

Loading

jakeonfire Aug 13, 2018 •

edited

Loading