wipe_out 1.0.0

data/lib/wipe_out/plans/plan.rb

@@ -0,0 +1,63 @@
+module WipeOut
+  module Plans
+    class Plan
+      def initialize(config)
+        @attributes = {}
+        @ignored = []
+        @callbacks = []
+        @relations = {}
+        @on_execute = nil
+        @config = config
+      end
+
+      attr_reader :attributes, :ignored, :relations, :callbacks, :config
+
+      def add_attribute(name, strategy:)
+        @attributes[name.to_sym] = strategy
+      end
+
+      def add_relation(name, plan)
+        @relations[name.to_sym] = plan
+      end
+
+      def add_relation_union(name, plans, &block)
+        @relations[name.to_sym] = Union.new(plans, block)
+      end
+
+      def on_execute(arg = nil, &block)
+        @on_execute = arg || block || @on_execute
+      end
+
+      def ignore(name)
+        @ignored << name.to_sym
+      end
+
+      def include_plan(other)
+        @attributes.merge! other.attributes
+        @ignored += other.ignored
+        @relations.merge! other.relations
+        @on_execute = other.on_execute
+        other.callbacks.each do |callback|
+          @callbacks << callback
+        end
+      end
+
+      # Duck typing for plans union
+      def plans
+        [self]
+      end
+
+      def establish_execution_plan(_record)
+        self
+      end
+
+      def add_callback(callback)
+        @callbacks << callback
+      end
+
+      def inspect
+        "Plan(attributes=#{attributes.keys})"
+      end
+    end
+  end
+end

data/lib/wipe_out/plans/union.rb

@@ -0,0 +1,19 @@
+module WipeOut
+  module Plans
+    class Union
+      attr_reader :plans
+
+      def initialize(plans, selector)
+        @plans = plans
+        @selector = selector
+      end
+
+      def establish_execution_plan(record)
+        plan = @selector.call(record).plan
+        raise "Plan #{plan} is not listed in #{@plans}" unless @plans.include?(plan)
+
+        plan
+      end
+    end
+  end
+end

data/lib/wipe_out/plugin.rb

@@ -0,0 +1,31 @@
+module WipeOut
+  module Plugin
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def before(*names, &block)
+        callback(*names.map { |name| "before_#{name}" }, &block)
+      end
+
+      def after(*names, &block)
+        callback(*names.map { |name| "after_#{name}" }, &block)
+      end
+
+      def callback(*names, &block)
+        names.each do |name|
+          add_callback(Callback.new(name, block))
+        end
+      end
+
+      def callbacks
+        @callbacks ||= []
+      end
+
+      def add_callback(callback)
+        callbacks << callback
+      end
+    end
+  end
+end

data/lib/wipe_out/plugins/logger.rb

@@ -0,0 +1,42 @@
+module WipeOut
+  module Plugins
+    # Logger plugin module to be used by including it in the plan.
+    # When it runs, it prints out debug logs using `WipeOut::Config.logger`
+    #
+    # @example
+    #     WipeOut.build_plan do
+    #       plugin WipeOut::Plugins::Logger
+    #       wipe_out :name
+    #     end
+    #
+    # @example
+    #     [WipeOut] start plan=Plan(User, attributes=[:name])
+    #     [WipeOut] executing plan=Plan(User, attributes=[:name]) record_class=User id=#{user.id}
+    #     [WipeOut] wiped out plan=Plan(User, attributes=[:name]) record_class=User id=#{user.id}
+    #     [WipeOut] completed plan=Plan(User, attributes=[:name])
+    #
+    module Logger
+      include WipeOut::Plugin
+
+      before(:plan) do |execution|
+        execution.config.logger.debug("[WipeOut] start plan=#{execution.plan.inspect}")
+      end
+
+      after(:plan) do |execution|
+        execution.config.logger.debug("[WipeOut] completed plan=#{execution.plan.inspect}")
+      end
+
+      before(:execution) do |execution|
+        execution.config.logger.debug(
+          "[WipeOut] executing plan=#{execution.plan.inspect} " \
+          "record_class=#{execution.record.class} id=#{execution.record.id}"
+        )
+      end
+
+      after(:execution) do |execution|
+        execution.config.logger.debug("[WipeOut] wiped out plan=#{execution.plan.inspect} " \
+          "record_class=#{execution.record.class} id=#{execution.record.id}")
+      end
+    end
+  end
+end

data/lib/wipe_out/validate.rb

@@ -0,0 +1,48 @@
+module WipeOut
+  # Validates plan has proper configuration and that all ActiveRecord class attributes
+  # are explicily defined in the plan.
+  # Validation is a seperate step, after plan is defined. We don't assume
+  # plan is valid stadalone, this allows for plans composition.
+  class Validate
+    method_object :plan, :ar_class, :config, [:result]
+
+    VALIDATORS = [
+      Validators::Attributes,
+      Validators::DefinedRelations,
+      Validators::RelationsPlans
+    ].freeze
+
+    # See {Plans::BuiltPlan#validate}
+    #
+    # @return [Array<String>]
+    def call
+      VALIDATORS.map do |validator|
+        validator.call(plan, ar_class, config, result)
+      end
+
+      result
+    end
+
+    private
+
+    def result
+      @result ||= ValidationResult.new
+    end
+  end
+
+  class ValidationResult
+    attr_reader :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def valid?
+      !errors.any?
+    end
+
+    def add_error(message)
+      @errors << message
+    end
+  end
+end

data/lib/wipe_out/validators/attributes.rb

@@ -0,0 +1,49 @@
+module WipeOut
+  module Validators
+    class Attributes < Base
+      def call
+        return if ignored?
+
+        if missing_attributes.any?
+          names = missing_attributes.map { |name| ":#{name}" }.join(", ")
+
+          result.add_error("#{ar_class.name} plan is missing attributes: #{names}")
+        end
+
+        if non_existing_attributes.any?
+          names = non_existing_attributes.map { |name| ":#{name}" }.join(", ")
+
+          result.add_error("#{ar_class.name} plan has extra attributes: #{names}")
+        end
+      end
+
+      private
+
+      def missing_attributes
+        columns - attributes - ignored_attributes - foreign_keys
+      end
+
+      def non_existing_attributes
+        attributes - columns
+      end
+
+      def columns
+        ar_class.columns.map(&:name).map(&:to_sym)
+      end
+
+      def attributes
+        plan.attributes.keys
+      end
+
+      def ignored_attributes
+        plan.ignored + config.ignored_attributes
+      end
+
+      def foreign_keys
+        ar_class.reflect_on_all_associations.find_all do |relation|
+          relation.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+        end.map(&:foreign_key).map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/wipe_out/validators/base.rb

@@ -0,0 +1,13 @@
+module WipeOut
+  module Validators
+    class Base
+      method_object :plan, :ar_class, :config, :result
+
+      private
+
+      def ignored?
+        plan.ignored == [WipeOut::IGNORE_ALL]
+      end
+    end
+  end
+end

data/lib/wipe_out/validators/defined_relations.rb

@@ -0,0 +1,26 @@
+module WipeOut
+  module Validators
+    class DefinedRelations < Base
+      def call
+        return if ignored?
+
+        ar_class.reflect_on_all_associations.each do |relation|
+          unless indirect_relation?(relation) || ignore_relation?(relation) || plan.relations[relation.name].present?
+            result.add_error("#{ar_class.name} relation is missing: :#{relation.name}")
+          end
+        end
+      end
+
+      private
+
+      def indirect_relation?(relation)
+        [ActiveRecord::Reflection::ThroughReflection, ActiveRecord::Reflection::BelongsToReflection]
+          .include?(relation.class)
+      end
+
+      def ignore_relation?(relation)
+        plan.ignored.include?(relation.name) || config.ignored_attributes.include?(relation.name)
+      end
+    end
+  end
+end

data/lib/wipe_out/validators/relations_plans.rb

@@ -0,0 +1,26 @@
+module WipeOut
+  module Validators
+    class RelationsPlans < Base
+      def call
+        return if ignored?
+
+        plan.relations.each do |name, plan|
+          relation = relation_reflection(name)
+          if relation
+            plan.plans.each do |potential_plan|
+              WipeOut::Validate.call(potential_plan, relation.klass, config, result: result)
+            end
+          else
+            result.add_error("#{ar_class.name} has invalid relation: :#{name}")
+          end
+        end
+      end
+
+      private
+
+      def relation_reflection(name)
+        ar_class.reflect_on_association(name)
+      end
+    end
+  end
+end

data/lib/wipe_out/version.rb

@@ -0,0 +1,3 @@
+module WipeOut
+  VERSION = "1.0.0".freeze
+end

data/wipe_out.gemspec

@@ -0,0 +1,47 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Maintain your gem's version:
+require "wipe_out/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name = "wipe_out"
+  s.version = WipeOut::VERSION
+
+  s.authors = ["Michał Foryś", "Piotr Król"]
+  s.email = %w[developers@globalapptesting.com michal@globalapptesting.com]
+
+  s.required_ruby_version = ">= 3.0.0"
+  s.summary = "Library for removing and clearing data in Rails ActiveRecord models."
+  s.description = "Library for removing and clearing data in Rails ActiveRecord models." \
+    " Allows to define data removal policy with its own, easy to understand, DSL."
+  s.license = "MIT"
+  s.homepage = "https://github.com/GlobalAppTesting/wipe_out"
+  s.metadata = {
+    "homepage_uri" => "https://github.com/GlobalAppTesting/wipe_out",
+    "changelog_uri" => "https://github.com/GlobalAppTesting/wipe_out/blob/main/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/GlobalAppTesting/wipe_out",
+    "bug_tracker_uri" => "https://github.com/GlobalAppTesting/wipe_out/issues"
+  }
+
+  s.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+
+  s.add_dependency("attr_extras", "~> 6.2")
+  s.add_dependency("zeitwerk", "~> 2.4.2")
+
+  s.add_development_dependency("combustion", "~> 1.3")
+  s.add_development_dependency("factory_bot", "~> 6.2")
+  s.add_development_dependency("pry", "~> 0.14.1")
+  s.add_development_dependency("rails", "~> 6.1")
+  s.add_development_dependency("rspec", "~> 3.10")
+  s.add_development_dependency("simplecov", "~> 0.21.1")
+  s.add_development_dependency("sqlite3", "~> 1.4.2")
+  s.add_development_dependency("standard", "~> 1.1.4")
+  s.add_development_dependency("super_diff", "~> 0.6.2")
+  s.add_development_dependency("webrick")
+  s.add_development_dependency("yard", "~> 0.9")
+end

metadata

@@ -0,0 +1,274 @@
+--- !ruby/object:Gem::Specification
+name: wipe_out
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michał Foryś
+- Piotr Król
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Library for removing and clearing data in Rails ActiveRecord models.
+  Allows to define data removal policy with its own, easy to understand, DSL.
+email:
+- developers@globalapptesting.com
+- michal@globalapptesting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".markdownlint.json"
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- bin/rake
+- bin/rspec
+- bin/standardrb
+- bin/yard
+- bin/yardoc
+- bin/yri
+- docs/development.md
+- docs/getting_started.md
+- docs/releasing.md
+- docs/yard_plugin.rb
+- lib/wipe_out.rb
+- lib/wipe_out/attribute_strategies/const_value.rb
+- lib/wipe_out/attribute_strategies/nullify.rb
+- lib/wipe_out/attribute_strategies/randomize.rb
+- lib/wipe_out/callback.rb
+- lib/wipe_out/callbacks_observer.rb
+- lib/wipe_out/config.rb
+- lib/wipe_out/execute.rb
+- lib/wipe_out/execution/context.rb
+- lib/wipe_out/execution/execute_plan.rb
+- lib/wipe_out/plans/built_plan.rb
+- lib/wipe_out/plans/dsl.rb
+- lib/wipe_out/plans/plan.rb
+- lib/wipe_out/plans/union.rb
+- lib/wipe_out/plugin.rb
+- lib/wipe_out/plugins/logger.rb
+- lib/wipe_out/validate.rb
+- lib/wipe_out/validators/attributes.rb
+- lib/wipe_out/validators/base.rb
+- lib/wipe_out/validators/defined_relations.rb
+- lib/wipe_out/validators/relations_plans.rb
+- lib/wipe_out/version.rb
+- wipe_out.gemspec
+homepage: https://github.com/GlobalAppTesting/wipe_out
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/GlobalAppTesting/wipe_out
+  changelog_uri: https://github.com/GlobalAppTesting/wipe_out/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/GlobalAppTesting/wipe_out
+  bug_tracker_uri: https://github.com/GlobalAppTesting/wipe_out/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Library for removing and clearing data in Rails ActiveRecord models.
+test_files: []