wipe_out 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eafa15a844d625664e5cd81d01e921514a84f34a2d488efedd950a5fadc77adb
+  data.tar.gz: 92ebfff20053d46b9e2629e1c00dc3097073874083bc0d46bb077e43d1418346
+SHA512:
+  metadata.gz: 2177346bc816df8cd6a270abd66e8c660db21297e4fead9500c912792f2bb4f76fd12666ae7029091b4a3c71a430974087992d9615c155d6811f6165e03b3b27
+  data.tar.gz: dc02b071110c0c5963f44a132de42def2ee24e317b4623eb0106eee64739160c93e1350065083b023e5e5ab3a7812819febc864ca07474eb00206de0fbc36448

data/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI Suite
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - run: bin/standardrb --format progress --no-fix
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: NODE SETUP ACTION
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16.x'
+    - run: yarn global add markdownlint-cli@0.27.1
+    - run: export PATH="${PATH}:$(yarn global bin)"
+    - run: markdownlint --config .markdownlint.json -i .yarn -i vendor .
+    - run: bin/yard
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - gemfile: Gemfile
+            ruby: 3.0
+    runs-on: ubuntu-latest
+    steps:
+    - run: echo BUNDLE_GEMFILE=${{ matrix.gemfile }} > $GITHUB_ENV
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+        bundler: ${{ matrix.bundler || 'default' }}
+    - run: bin/rspec

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+Gemfile.lock
+.rubocop-xunit.xml
+spec/internal/log/*
+coverage
+doc
+.yardoc/

data/.markdownlint.json

@@ -0,0 +1,7 @@
+{
+    "MD006": false,
+    "MD013": {
+        "line_length": 120
+    },
+    "default": true
+}

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--markup=markdown
+--readme=README.md
+--title='WipeOut Documentation'
+--load ./docs/yard_plugin.rb
+'lib/**/*.rb' - '*.md' 'docs/*.md' LICENSE

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+Initial release, see docs:

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Spa Worldwide Ltd
+
+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.

data/README.md

@@ -0,0 +1,58 @@
+# WipeOut
+
+Library for removing and clearing data in Rails ActiveRecord models.
+
+## Installation
+
+1. Add WipeOut to your application's Gemfile:
+
+```ruby
+gem "wipe_out", "~> 1.0"
+```
+
+Check newest release at [here](https://rubygems.org/gems/wipe_out).
+
+## Usage
+
+Quick example:
+
+Given the following model:
+
+```ruby
+# == Schema Info
+#
+# Table name: users
+#
+#  id                  :integer(11)    not null, primary key
+#  name                :varchar(11)    not null
+#  orders_count        :integer(11)    not null
+class User < ActiveRecord::Base
+end
+
+```
+
+We can define custom wipe out plan:
+
+```ruby
+UserWipeOutPlan = WipeOut.build_plan do
+  wipe_out :name
+  ignore :orders_count
+end
+```
+
+and execute it:
+
+```ruby
+User.last.then { |user| UserWipeOutPlan.execute(user) }
+```
+
+It will overwrite data inside `name` but leave, `orders_count` untouched.
+
+There is also support for relations and making sure that policies are defined
+for any added columns.
+
+Read more in [getting started](./docs/getting_started.md) doc.
+
+## Contributing && Development
+
+See [development.md](./docs/development.md)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/standardrb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/bin/yard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yri")

data/docs/development.md

@@ -0,0 +1,57 @@
+# Development
+
+So, you want to hack on GraphQL Ruby! Here are some tips for getting started.
+
+* [Setup](#setup) your development environment
+* [Run tests](#run-tests)
+* [Debug](#debug)
+* [Coding guidelines](#coding-guidelines)
+* [Releasing](#releasing)
+
+## Setup
+
+Follow the steps below to setup wipe_out locally:
+
+* Make sure you're running on Ruby 3.0.0 or newer
+* sqlite is installed (required for tests)
+
+```bash
+git clone https://github.com/GlobalAppTesting/wipe_out
+cd wipe_out
+bundle install
+```
+
+## Run tests
+
+```bash
+./bin/rspec
+```
+
+## Debug
+
+By default `pry` is included so feel free to run tests and put `binding.pry`
+wherever you like.
+
+## Coding guidelines
+
+* Please make sure to run `./bin/standardrb --fix`
+* Markdown files are linted too via [markdownlint](https://github.com/DavidAnson/markdownlint)
+* Each change should be covered by tests and add CHANGELOG info
+
+## Releasing
+
+Releasing will be done manually for now.
+
+1. Bump version in `lib/wipe_out/version.rb`
+1. Ensure CHANGELOG.md is matching new version and has details about published changes.
+   Make sure that breaking changes contain update instructions.
+1. Commit all changes `git commit -m "Release: vX.Y.Z"`
+1. Tag commit `git tag vX.Y.Z`
+1. Push changes and tag
+
+   ```bash
+   git push origin master
+   git push origin vX.Y.Z
+   ```
+
+1. (TODO) Publish release on [Rubygems](https://rubygems.org/)

data/docs/getting_started.md

@@ -0,0 +1,350 @@
+# Getting started
+
+## Usage
+
+Removal strategy definition is called _Plan_. _Plan_ is created using DSL.
+Plan can be validated and executed.
+
+_Plan_ defines a list of attributes and relations to clear.
+Relations work as nested _Plans_ and can be nested infinitely.
+
+Given schema:
+
+```ruby
+create_table "users" do |t|
+  t.string "first_name"
+  t.string "last_name"
+  t.string "reset_password_token"
+  t.string "access_tokens"
+  t.datetime "confirmed_at"
+  t.integer "sign_in_count"
+end
+
+create_table "comments" do |t|
+  t.integer "user_id"
+  t.string "value"
+end
+
+create_table "resource_files" do |t|
+  t.integer "comment_id"
+end
+
+create_table "dashboards" do |t|
+  t.integer "user_id"
+  t.string "order"
+end
+```
+
+and models
+
+```ruby
+class User < ActiveRecord::Base
+ has_many :comments
+ has_one :dashboard
+end
+
+class Comment < ActiveRecord::Base
+  has_many :resource_files
+end
+
+class ResourceFile < ActiveRecord::Base; end
+class Dashboard < ActiveRecord::Base; end
+```
+
+Example Plan:
+
+```ruby
+UserWipeOutPlan = WipeOut.build_plan do
+   # Set nil value by default
+   wipe_out :first_name, :last_name
+   # Custom strategy
+   wipe_out :sign_in_count, strategy: WipeOut::AttributeStrategies::ConstValue.new(0)
+   # Inline custom strategy
+   wipe_out :reset_password_token do
+     "random-value-#{SecureRandom.hex}"
+   end
+
+   # has_many relation
+   relation :comments do
+     # Behaves like nested Plan.
+     wipe_out :value, strategy: WipeOut::AttributeStrategies::Randomize.new
+
+     relation :resource_files do
+      on_execute ->(execution) { execution.record.destroy! }
+      ignore_all
+     end
+   end
+
+   # has_one relation
+   relation :dashboard do
+     wipe_out :order
+     ignore :name
+   end
+
+   # Ignore is used to mark both ignored relations
+   # and ignored attributes
+   ignore :access_tokens, :confirmed_at
+end
+```
+
+After executing on a record
+
+```ruby
+record = User.last
+UserWipeOutPlan.execute(record)
+```
+
+User's:
+
+* `first_name` and `last_name` attributes are set to `nil` value
+* `sign_in_count` is set to `0`
+* `reset_password_token` is randomized
+* `access_tokens` and `confirmed_at` attributes are not changed
+
+User's Comments:
+
+* `value` is randomized
+* Comment's resource_files are all destroyed
+
+User's dashboard:
+
+* `order` attribute is set to `nil`
+* `name` attribute is ignored
+
+## Validation
+
+_Plans_ can be validated against DB schema:
+
+```ruby
+UserWipeOutPlan.validate(User)
+UserWipeOutPlan.validate(User).errors
+UserWipeOutPlan.validate(User).valid?
+```
+
+Method performs validation. It will contain errors if plan is invalid.
+
+When new attribute is added to schema or a new relation is added to a model
+that is used in _Plan_ then validation will fail.
+
+### Ignoring
+
+Every relation or attribute which is not part of removal plan
+has to be marked as ignored with `ignore`.
+
+`through` and `belongs_to` relations are ignored automatically and they don't have to be ignored manually.
+
+By default these attributes are ignored:
+
+* `id`
+* `created_at`
+* `updated_at`
+* `archived_at`
+
+Given schema:
+
+```ruby
+create_table "users" do |t|
+  t.string "first_name"
+  t.string "last_name"
+  t.integer "company_id"
+  t.datetime "created_at"
+  t.datetime "updated_at"
+end
+```
+
+and class:
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :company
+  has_many :comments
+  has_one :dashboard
+  has_many :resource_files, through: :comments
+end
+```
+
+a _Plan_ to handle removing of this object has to provide strategy or ignore:
+
+* attributes:
+
+  * `first_name`
+  * `last_name`
+  * `company_id`
+
+* relations:
+
+  * `comments`
+  * `dashboard`
+
+_Plan_ can skip providing strategy for:
+
+* attributes `id`, `created_at`, `updated_at` - ignored by default
+* relation `company` - `belongs_to` relation
+* relation `resource_files` - through relation
+
+### Reusing _Plans_
+
+#### Extracting
+
+Nested plans can be extracted as independent object. An exemplary plan can be rewritten to:
+
+```ruby
+CommentsWipeOutPlan = WipeOut.build_plan do
+  wipe_out :value, strategy: WipeOut::AttributeStrategies::Randomize.new
+
+  relation :resource_files do
+    on_execute ->(execution) { execution.record.destroy! }
+    ignore_all
+  end
+end
+
+DashboardWipeOutPlan = WipeOut.build_plan do
+  relation :dashboard do
+    wipe_out :order
+    ignore :name
+  end
+end
+
+UserWipeOutPlan = WipeOut.build_plan do
+  # …
+  relation :comments, CommentsWipeOutPlan
+  relation :dashboard, DashboardWipeOutPlan
+  # …
+end
+```
+
+#### Including
+
+_Plan_ can be included to other existing _Plan_. When _Plan_ is included then
+its strategy is copied and extends current definition.
+
+E.g.
+
+```ruby
+HasAttachmentsPlan = WipeOut.build_plan do
+  relation(:images) do
+    on_execute ->(execution) { execution.record.destroy! }
+    ignore_all
+  end
+  relation(:videos) do
+    on_execute ->(execution) { execution.record.destroy! }
+    ignore_all
+  end
+  wipe_out :attachments_count
+end
+
+WipeOut.build_plan do
+  include_plan HasAttachmentsPlan
+  relation(:comments) do
+    wipe_out :content
+    include_plan HasAttachmentsPlan
+  end
+end
+```
+
+is exactly the same as:
+
+```ruby
+WipeOut.build_plan do
+  wipe_out :attachments_count
+
+  relation(:images) do
+    on_execute ->(execution) { execution.record.destroy! }
+    ignore_all
+  end
+  relation(:videos) do
+    on_execute ->(execution) { execution.record.destroy! }
+    ignore_all
+  end
+
+  relation(:comments) do
+    wipe_out :content, :attachments_count
+
+    relation(:images) do
+      on_execute ->(execution) { execution.record.destroy! }
+      ignore_all
+    end
+    relation(:videos) do
+      on_execute ->(execution) { execution.record.destroy! }
+      ignore_all
+    end
+  end
+end
+```
+
+### Dynamic plan selection
+
+In some cases relation needs to have multiple _Plan_ depending on the record's state.
+The list of _Plans_ have to be known upfront to provide static validation.
+During _Plan_ execution callback is called determine which _Plan_ from the defined list
+to use for a given record.
+
+```ruby
+UserPlan = WipeOut.build_plan do
+  normal_plan = WipeOut.build_plan do
+    on_execute ->(execution) { execution.record.destroy! }
+  end
+  vip_plan = WipeOut.build_plan do
+    ignore … # do not remove all data yet
+  end
+
+  relation(:resource_files, plans: [vip_plan, normal_plan] do |resource_file|
+    resource_file.user.vip? ? vip_plan : normal_plan
+  end
+end
+```
+
+### Plugins
+
+Plugins are used to define behaviours which are not supported by the
+core library.
+
+Plugins usage can be defined by including them in a plan block.
+
+Currently the only hooks available are:
+
+* `before(:plan) { |execution| ... }` - called before plan execution, already in transaction
+* `after(:plan) { |execution| ... }` - called after plan execution, still in transaction, last place to rollback
+* `before(:execution) { |execution| ... }` - called before record is wiped out
+* `after(:execution) { |execution| ... }` - called after record is wiped out
+
+When _Plan_ with plugins is nested inside other _Plan_ (see "Reusing plans")
+ then its plugins are ignored.
+
+E.g. in scenario:
+
+ ```ruby
+XPlan = WipeOut.build_plan do
+  plugin PluginX
+  wipe_out …
+end
+
+YPlan = WipeOut.build_plan do
+  relation :x, XPlan
+end
+```
+
+plugin defined in `XPlan` is completely ignored and not used.
+
+## Configuration
+
+WipeOut global settings can can be configured:
+
+```ruby
+WipeOut.config do |config|
+  config.ignored_attributes << :user_id # defaults: [:id, :updated_at, :created_at, :archived_at]
+end
+```
+
+_Plans_ can override global config:
+
+```ruby
+WipeOut.build_plan do
+  configure do |config|
+    config.ignored_attributes += [:some, :attributes]
+  end
+end
+```
+
+Similarly to Plugins, when _Plan_ with config override is nested inside other _Plan_
+(see "Reusing plans") then its custom configuration is ignored.