active_record-log_deleted 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bffe9549ed5ab620b57a5a098fa369263c52236749b186671c30c1afd9a1ac1e
+  data.tar.gz: 7dcefc7b5d7d93148882267ec67a7ca276856743da9a5b4b0ebd519d6730b3f2
+SHA512:
+  metadata.gz: 52ae0e41b2752475b49b64b8cd4b8c2748ce45638204a4f35faeeb70ed8be7c405999f75987683d007f929d376902afca1dae866e00d1b2de9dd492a5b7cdd55
+  data.tar.gz: 51b5e460988b8dedbb553e484cf55c3056f220e28320e8a223b9846e71c4fdbd31ab5aa0bebcb21511855d5c33d32fd80e73deea1b177d2ab6485abd6c24b874

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_record-log_deleted.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    active_record-log_deleted (0.1.0)
+      activerecord (>= 5.2, < 7.0)
+      pg
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    combustion (1.3.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pg (1.2.3)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (4.0.1)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.9)
+      rspec-expectations (~> 3.9)
+      rspec-mocks (~> 3.9)
+      rspec-support (~> 3.9)
+    rspec-support (3.9.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record-log_deleted!
+  combustion
+  rake
+  rspec
+  rspec-rails
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 matthew fong
+
+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,77 @@
+# ActiveRecord::LogDeleted
+
+Our data team needs to have logs of deleted rows. To do this, we historically have copy pasted some raw SQL from migration to migration. This gem exposes methods in ActiveRecord migrations to create the deleted row triggers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-log_deleted'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_record-log_deleted
+
+## Usage
+
+### Configuration
+
+To override defaults, add an initializer:
+
+```ruby
+# config/initializers/active_record-log_deleted.rb
+ActiveRecord::LogDeleted.configure do |config|
+  config.deleted_rows_table_name = :deleted_rows
+  config.log_deleted_row_function_name = :log_deleted_row
+  config.log_deleted_row_trigger_name = :log_deleted_row_trigger
+end
+```
+
+### Create the deleted rows table
+```ruby
+class CreateDeletedRowsTable < ActiveRecord::Migration[6.0]
+  def change
+    create_deleted_rows_table
+  end
+end
+```
+
+### Create the log deleted row function
+```ruby
+class CreateLogDeletedRowFunction < ActiveRecord::Migration[6.0]
+  def change
+    create_log_deleted_row_function
+  end
+end
+```
+
+### Create a deleted row trigger
+```ruby
+class CreateDeletedRowTrigger < ActiveRecord::Migration[6.0]
+  def change
+    create_deleted_row_trigger(:table_name)
+  end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record-log_deleted.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_record-log_deleted.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/active_record/log_deleted/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record-log_deleted"
+  spec.version       = ActiveRecord::LogDeleted::VERSION
+  spec.authors       = ["matthew fong"]
+  spec.email         = ["matthew@hover.to"]
+
+  spec.summary       = %q{ActiveRecord migration methods for logging deleted records}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/hoverinc/active_record-log_deleted"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "rspec-rails"
+
+  spec.add_runtime_dependency "activerecord", ">= 5.2", "< 7.0"
+  spec.add_runtime_dependency "pg"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/log_deleted"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/active_record/log_deleted.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_record/schema_dumper"
+require "active_record/connection_adapters/postgresql/schema_statements"
+require "active_record/connection_adapters/postgresql_adapter"
+require "active_support/lazy_load_hooks"
+
+require 'active_record/log_deleted/version'
+require 'active_record/log_deleted/configuration'
+require 'active_record/log_deleted/postgresql_adapter'
+require 'active_record/log_deleted/command_recorder'
+
+module ActiveRecord
+  module LogDeleted
+    def self.configuration
+      @configuration ||= ::ActiveRecord::LogDeleted::Configuration.new
+    end
+
+    def self.configure
+      yield(@configuration)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend ActiveRecord::LogDeleted::PostgreSQLAdapter
+  ActiveRecord::Migration::CommandRecorder.prepend ActiveRecord::LogDeleted::CommandRecorder
+end

data/lib/active_record/log_deleted/command_recorder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module LogDeleted
+    module CommandRecorder
+      def create_deleted_rows_table
+        record(:create_deleted_rows_table, [])
+      end
+
+      def invert_create_deleted_rows_table(*args)
+        [:drop_table, :deleted_rows]
+      end
+
+      def create_log_deleted_row_function
+        record(:create_log_deleted_row_function, [])
+      end
+
+      def invert_create_log_deleted_row_function(*args)
+        [:drop_log_deleted_row_function]
+      end
+
+      def create_deleted_row_trigger(name)
+        record(:create_deleted_row_trigger, name)
+      end
+
+      def invert_create_deleted_row_trigger(name)
+        [:drop_deleted_row_trigger, name]
+      end
+    end
+  end
+end

data/lib/active_record/log_deleted/configuration.rb

@@ -0,0 +1,31 @@
+module ActiveRecord
+  module LogDeleted
+    class Configuration
+      attr_reader :deleted_rows_table_name, :log_deleted_row_function_name, :log_deleted_row_trigger_name
+
+      def initialize
+        @deleted_rows_table_name = :deleted_rows
+        @log_deleted_row_function_name = :log_deleted_row
+        @log_deleted_row_trigger_name = :log_deleted_row_trigger
+      end
+
+      def deleted_rows_table_name=(name)
+        @deleted_rows_table_name = sanitize(name)
+      end
+
+      def log_deleted_row_function_name=(name)
+        @log_deleted_row_function_name = sanitize(name)
+      end
+
+      def log_deleted_row_trigger_name=(name)
+        @log_deleted_row_trigger_name = sanitize(name)
+      end
+
+      private
+
+      def sanitize(value)
+        ::ActiveRecord::Base.sanitize_sql(value)
+      end
+    end
+  end
+end

data/lib/active_record/log_deleted/postgresql_adapter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module LogDeleted
+    module PostgreSQLAdapter
+      def create_deleted_rows_table
+        create_table deleted_rows_table_name do |t|
+          t.datetime :created_at, comment: 'The datetime at which the record was created.'
+          t.text :old_row_json, comment: 'JSON with the entire row that was hard deleted.'
+          t.string :primary_key, comment: 'The primary key of the row which was hard deleted.'
+          t.string :table_name, limit: 255, comment: 'The table name from which the row was hard deleted.'
+        end
+      end
+
+      def drop_deleted_rows_table
+        drop_table deleted_rows_table_name
+      end
+
+      def create_log_deleted_row_function
+        execute <<-SQL
+          CREATE OR REPLACE FUNCTION #{log_deleted_row_function_name}() RETURNS trigger AS $$
+            BEGIN
+              INSERT INTO
+                deleted_rows(table_name, primary_key, old_row_json, created_at)
+                  VALUES (TG_TABLE_NAME, OLD.id::varchar, ROW_TO_JSON(OLD), now());
+              RETURN OLD;
+            END;
+          $$ LANGUAGE plpgsql;
+        SQL
+      end
+
+      def drop_log_deleted_row_function
+        execute "DROP FUNCTION #{log_deleted_row_function_name};"
+      end
+
+      def create_deleted_row_trigger(table_name)
+        execute <<~SQL
+          create trigger #{log_deleted_row_trigger_name} after delete on #{ActiveRecord::Base.sanitize_sql(table_name)} for each row execute procedure #{log_deleted_row_function_name}();
+        SQL
+      end
+
+      def drop_deleted_row_trigger(table_name)
+        execute <<~SQL
+          drop trigger if exists #{log_deleted_row_trigger_name} on #{ActiveRecord::Base.sanitize_sql(table_name)};
+        SQL
+      end
+
+      private
+
+      def log_deleted_row_trigger_name
+        configuration.log_deleted_row_trigger_name
+      end
+
+      def log_deleted_row_function_name
+        configuration.log_deleted_row_function_name
+      end
+
+      def deleted_rows_table_name
+        configuration.deleted_rows_table_name
+      end
+
+      def configuration
+        ::ActiveRecord::LogDeleted.configuration
+      end
+    end
+  end
+end

data/lib/active_record/log_deleted/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module LogDeleted
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: active_record-log_deleted
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- matthew fong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: combustion
+  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: rspec-rails
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord migration methods for logging deleted records
+email:
+- matthew@hover.to
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record-log_deleted.gemspec
+- bin/console
+- bin/setup
+- config.ru
+- lib/active_record/log_deleted.rb
+- lib/active_record/log_deleted/command_recorder.rb
+- lib/active_record/log_deleted/configuration.rb
+- lib/active_record/log_deleted/postgresql_adapter.rb
+- lib/active_record/log_deleted/version.rb
+homepage: https://github.com/hoverinc/active_record-log_deleted
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hoverinc/active_record-log_deleted
+  source_code_uri: https://github.com/hoverinc/active_record-log_deleted
+  changelog_uri: https://github.com/hoverinc/active_record-log_deleted/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord migration methods for logging deleted records
+test_files: []