active_record_anonymizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2595896543324c7c02e7876dc7094a6cef95453a782183426ce433e846e1e395
+  data.tar.gz: 01ddfc4df3b6a1458cb692e256951f96e3bd8995d098b5b263bc6671ac465ad7
+SHA512:
+  metadata.gz: 99e3e06eeac716238b5690011905e5b9633b7bd88eb82693bed0c27c142f4614b6b8daeef4030719a6e79126a54ed26672e4a8741a01c0f5c18f22a3c5c11b60
+  data.tar.gz: '09b7bc01508b9c320cfa15f2857707bfc5556df6dd2af696143eeeb29790a11b7235a6137a58d34dff76151bb4b1b9feb606a8d8029119c9b449149641ec6776'

data/.rubocop.yml

@@ -0,0 +1,76 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: disable
+  SuggestExtensions: false
+  Exclude:
+    - "test/dummy/db/**/*"
+    - "test/dummy/bin/*"
+    - "test/dummy/config/**/*"
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: never
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "test/**/*"
+
+# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: both, prefix, postfix
+Style/NegatedIf:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 30
+
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  CountComments: false
+  Max: 30
+
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 30
+
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 15

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_record_anonymizer.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14.2"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+
+gem "mocha", "~> 2.1"
+gem "mysql2", "~> 0.5"
+gem "pg", "~> 1.2"
+gem "rails", ">= 6.0.0"
+gem "sqlite3", "~> 1.4"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Keshav Biswa
+
+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,144 @@
+# ActiveRecordAnonymizer
+
+Anonymize your ActiveRecord models with ease :sunglasses:
+
+`ActiveRecordAnonymizer` uses `faker` to anonymize your ActiveRecord model's attributes without the need to write custom anonymization logic for each model.
+
+Using `ActiveRecordAnonymizer`, you can:
+- Anonymize specific attributes of your model (uses `faker` under the hood)
+- Provide custom anonymization logic for specific attributes
+- Provide custom anonymized columns for each attributes
+- Encrypt anonymized data using `ActiveRecord::Encryption` (Requires Rails 7+)
+- Environment dependent, so you can decide whether you want to view original data in development and anonymized data in production
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_anonymizer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+    
+    $ gem install active_record_anonymizer
+
+Install the gem using the following command:
+
+    $ bin/rails generate active_record_anonymizer:install
+
+You must have anonymized columns in your Model to store the anonymized data.
+You can use the following migration generator to add anonymized columns to your existing table:
+
+    $ bin/rails generate anonymize User first_name last_name
+This will generate a migration file similar to the following:
+
+```ruby
+class AddAnonymizedColumnsToUser < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :anonymized_first_name, :string
+    add_column :users, :anonymized_last_name, :string
+  end
+end
+```
+
+Add the following line to your model to enable anonymization:
+
+```ruby
+class User < ApplicationRecord
+  # There are other options available, please refer to the Usage section
+  anonymize :first_name, :last_name
+end
+```
+To populate the anonymized columns, run the following command:
+
+    $ bin/rails anonymize:populate CLASS=User
+
+The `CLASS` argument is optional, if not provided, it will anonymize all the models with anonymized columns.
+
+## Usage
+
+Attributes can be anonymized using the `anonymize` method. The `anonymize` method takes the following options:
+
+- `:column_name` - The name of the column to store the anonymized data. ("anonymized_#{column_name}" by default)
+- `:with` - The custom logic to anonymize the attribute. (Optional, uses `faker` by default)
+- `:encrypt` - Encrypt the anonymized data using `ActiveRecord::Encryption` (Requires Rails 7+)
+
+```ruby
+class User < ApplicationRecord
+  anonymize :first_name, :last_name
+  anonymize :email, with: ->(email) { Faker::Internet.email }
+  anonymize :age, with: ->(age) { age + 5 }
+  anonymize :phone, column_name: :fake_phone_number, with: ->(phone) { phone.gsub(/\d/, 'X') }
+  anonymize :address, encrypt: true
+end
+```
+
+## Configuration
+
+You can configure the gem using the following options:
+
+- `:environments` - The environments in which the anonymized data should be used. (Defaults to `[:staging]`)
+- `:skip_update` - Skip updating the anonymized data when the record is updated. This ensures your anonymized data remains the same even if it's updated. (Defaults to `false`)
+- `:alias_original_columns` - Alias the original columns to the anonymized columns. You can still access the original value of the attribute using the alias `original_#{attribute_name}`(Defaults to `false`)
+- `:alias_column_name` - The name of the alias column. (Defaults to `original_#{column_name}`)
+
+```ruby
+ActiveRecordAnonymizer.configure do |config|
+  config.environments = [:staging, :production] # The environments in which the anonymized data should be used
+  config.skip_update = true # Skip updating the anonymized data when the record is updated
+  config.alias_original_columns = true # Alias the original columns to the anonymized columns
+  config.alias_column_name = "original" # The original column will be aliased to "original_#{column_name}
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+ Then, run `rake test` to run the tests.
+ You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports are welcome on GitHub at https://github.com/keshavbiswa/active_record_anonymizer/issues.
+
+- Fork the Repository: Start by forking this [repo](https://github.com/keshavbiswa/active_record_anonymizer.git) on GitHub.
+
+- Set Up Your Local Environment: Navigate into the project directory and run the setup script to install dependencies:
+
+```shell
+    $ cd active_record_anonymizer
+    $ bin/setup
+```
+- Create a New Branch: Before making any changes, create a new branch to keep your work organized:
+
+```shell
+    $ git checkout -b my-new-feature
+```
+
+- Make Your Changes: 
+  - Implement your changes or fixes in your local repository.
+  - Be sure to keep your changes as focused as possible. 
+  - If you're working on multiple unrelated improvements, consider making separate branches and pull requests for each.
+
+- Write Tests: If you're adding a new feature or fixing a bug, please add or update the corresponding tests. 
+
+- Run Tests: Before submitting your changes, run the test suite to ensure everything is working correctly:
+```shell
+    $ bin/rake test
+```
+
+- Update Documentation: If your changes involve user-facing features or APIs, update the README or other relevant documentation accordingly.
+
+- Submit a Pull Request: Go to the original `ActiveRecordAnonymizer` repository on GitHub, and you'll see a prompt to submit a pull request from your new branch.
+
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/keshavbiswa/active_record_anonymizer.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/active_record_anonymizer/anonymizer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  class Anonymizer
+    attr_reader :model, :attributes, :with, :column_name
+
+    def initialize(model, attributes, with: nil, column_name: nil)
+      @model = model
+      @attributes = attributes
+      @with = with
+      @column_name = column_name
+    end
+
+    # TODO: Extract this logic in a seperate Validation module/class
+    def validate
+      check_for_invalid_arguments(attributes, with, column_name)
+      check_for_missing_anonymized_columns(attributes)
+    end
+
+    def anonymize_attributes
+      attributes.each do |attribute|
+        anonymized_column = anonymized_column_name(attribute)
+
+        # I don't like that we're manipulating the class attribute here
+        # This breaks the SRP for this method
+        # TODO:- Will need to revisit how we set the class attribute later
+        model.anonymized_attributes[attribute.to_sym] = { column: anonymized_column.to_sym, with: with }
+
+        define_alias_method(attribute, ActiveRecordAnonymizer.configuration.alias_column_name) if ActiveRecordAnonymizer.alias_enabled?
+        define_anonymize_method(attribute, anonymized_column)
+      end
+    end
+
+    private
+
+    def check_for_missing_anonymized_columns(attributes)
+      missing_columns = attributes.reject do |attribute|
+        model.columns_hash[anonymized_column_name(attribute)]
+      end
+
+      if missing_columns.any?
+        raise ColumnNotFoundError, <<~ERROR_MESSAGE.strip
+          Following columns do not have anonymized_columns: #{missing_columns.join(', ')}.
+          You can generate them by running
+          `rails g active_record_anonymizer:anonymize #{model.name} #{missing_columns.join(' ')}`
+        ERROR_MESSAGE
+      end
+    end
+
+    def check_for_invalid_arguments(attributes, with, column_name)
+      if attributes.size > 1 && (with || column_name)
+        raise InvalidArgumentsError, "with and column_names are not supported for multiple attributes. Try adding them seperately"
+      end
+    end
+
+    def anonymized_column_name(attribute)
+      column_name || generated_column_name(attribute)
+    end
+
+    def generated_column_name(attribute)
+      "anonymized_#{attribute}"
+    end
+
+    # This defines a method that returns the anonymized value of the attribute.
+    # It also creates an alias "original_#{attribute}" that returns the original value. (TODO)
+    # If column_name is provided, it will be used instead of "anonymized_#{attribute}"
+    def define_anonymize_method(attribute, anonymized_attr)
+      model.define_method(attribute) do
+        ActiveRecordAnonymizer.anonymization_enabled? ? self[anonymized_attr] : self[attribute]
+      end
+    end
+
+    def define_alias_method(attribute, alias_column_name)
+      model.define_method("#{alias_column_name}_#{attribute}") do
+        self[attribute]
+      end
+    end
+  end
+end

data/lib/active_record_anonymizer/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  class Configuration
+    attr_accessor :environments, :skip_update, :alias_original_columns, :alias_column_name
+
+    def initialize
+      @environments = %i[staging]
+      @skip_update = false
+      @alias_original_columns = false
+      @alias_column_name = "original"
+    end
+
+    # Reset all configuration options to defaults.
+    # Required for tests to maintain isolation between test cases.
+    def reset
+      initialize
+    end
+  end
+end

data/lib/active_record_anonymizer/encryptor.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  class Encryptor
+    attr_reader :attributes
+
+    def initialize(model, attributes)
+      @model = model
+      @attributes = attributes
+    end
+
+    def encrypt
+      if !rails_version_supported?
+        raise ActiveRecordAnonymizer::UnsupportedVersionError,
+              "ActiveRecordAnonymizer relies on Rails 7+ for encrypted columns."
+      end
+
+      @model.encrypts(*@attributes)
+    end
+
+    private
+
+    def rails_version_supported?
+      ActiveRecord::VERSION::MAJOR >= 7 && ActiveRecord::VERSION::MINOR >= 0
+    end
+  end
+end

data/lib/active_record_anonymizer/extensions.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveRecordAnonymizer
+  module Extensions
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def ensure_mutex_initialized
+        unless defined?(@setup_mutex)
+          @setup_mutex = Mutex.new
+        end
+      end
+
+      def anonymize(*attributes, with: nil, column_name: nil, encrypted: false)
+        ensure_mutex_initialized
+        Encryptor.new(self, attributes).encrypt if encrypted
+
+        ActiveRecordAnonymizer.register_model(self)
+
+        # These class variables required to generate anonymized values
+        # These are not thread safe!
+        cattr_accessor :anonymized_attributes, instance_accessor: false unless respond_to?(:anonymized_attributes)
+        self.anonymized_attributes ||= {}
+
+        anonymizer = Anonymizer.new(self, attributes, with: with, column_name: column_name)
+        anonymizer.validate
+        anonymizer.anonymize_attributes
+
+        # I'm ensuring that the before_save callback is only added once
+        # Models can call anonymize method multiple times per column
+        @setup_mutex.synchronize do
+          unless @anonymizer_setup_done
+            before_save :anonymize_columns, if: :anonymization_enabled?
+            @anonymizer_setup_done = true
+          end
+        end
+      end
+    end
+
+    def anonymization_enabled?
+      ActiveRecordAnonymizer.anonymization_enabled?
+    end
+
+    def anonymize_columns
+      if new_record?
+        # For new records, apply anonymization to all attributes
+        anonymize_all_attributes
+      else
+        # For existing records, only apply to attributes that have changed
+        return if ActiveRecordAnonymizer.configuration.skip_update
+
+        anonymize_changed_attributes
+      end
+    end
+
+    def anonymize_all_attributes
+      self.class.anonymized_attributes.each_value do |settings|
+        generate_and_write_fake_value(settings[:column], settings[:with])
+      end
+    end
+
+    def anonymize_changed_attributes
+      changes = self.changes.keys.map(&:to_sym)
+      changed_attributes = changes & self.class.anonymized_attributes.keys
+
+      changed_attributes.each do |attribute|
+        settings = self.class.anonymized_attributes[attribute]
+        generate_and_write_fake_value(settings[:column], settings[:with])
+      end
+    end
+
+    def generate_and_write_fake_value(anonymized_attr, with_strategy = nil)
+      fake_value = case with_strategy
+                   when Proc
+                     with_strategy.call(self)
+                   when Symbol
+                     send(with_strategy)
+                   else
+                     FakeValue.new(anonymized_attr, self.class.columns_hash[anonymized_attr.to_s]).generate_fake_value
+                   end
+      write_attribute(anonymized_attr, fake_value)
+    end
+  end
+end

data/lib/active_record_anonymizer/fake_value.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  class FakeValue
+    def initialize(name, column)
+      @name = name
+      @column = column
+    end
+
+    def generate_fake_value
+      case @column.type
+      when :string, :text, :citext then Faker::Lorem.word
+      when :uuid then SecureRandom.uuid
+      when :integer, :bigint, :smallint then Faker::Number.number(digits: 5)
+      when :decimal, :float, :real then Faker::Number.decimal(l_digits: 2, r_digits: 2)
+      when :datetime, :timestamp, :timestamptz then Faker::Time.between(from: DateTime.now - 1, to: DateTime.now)
+      when :date then Faker::Date.between(from: Date.today - 2, to: Date.today)
+      when :time, :timetz then Faker::Time.forward(days: 23, period: :morning)
+      when :boolean then Faker::Boolean.boolean
+      when :json, :jsonb then generate_json
+      when :inet then Faker::Internet.ip_v4_address
+      when :cidr, :macaddr then Faker::Internet.mac_address
+      when :bytea then Faker::Internet.password
+      when :bit, :bit_varying then %w[0 1].sample
+      when :money then generate_money
+      when :hstore then generate_json
+      when :year then rand(1901..2155)
+      else raise UnknownColumnTypeError, "Unknown column type: #{@column.type}"
+      end
+    end
+
+    private
+
+    def generate_json
+      { "value" => { "key1" => Faker::Lorem.word, "key2" => Faker::Number.number(digits: 2) } }
+    end
+
+    def generate_money
+      Faker::Commerce.price.to_s
+    end
+  end
+end

data/lib/active_record_anonymizer/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/active_record_anonymizer.rake"
+    end
+  end
+end

data/lib/active_record_anonymizer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  VERSION = "0.1.0"
+end

data/lib/active_record_anonymizer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "zeitwerk"
+require "faker"
+
+module ActiveRecordAnonymizer
+  @mutex = Mutex.new
+
+  @loader = Zeitwerk::Loader.for_gem
+  @loader.ignore("#{__dir__}/generators")
+  @loader.setup
+
+  class Error < StandardError; end
+  class ColumnNotFoundError < StandardError; end
+  class InvalidArgumentsError < StandardError; end
+  class UnknownColumnTypeError < StandardError; end
+  class UnsupportedVersionError < StandardError; end
+
+  class << self
+    attr_reader :loader
+
+    def register_model(model)
+      @mutex.synchronize do
+        @models ||= []
+        @models << model unless @models.include?(model)
+      end
+    end
+
+    def models
+      @mutex.synchronize do
+        @models ||= []
+      end
+    end
+
+    def configure
+      @mutex.synchronize do
+        yield configuration if block_given?
+      end
+    end
+
+    def configuration
+      Thread.current[:active_record_anonymizer_configuration] ||= Configuration.new
+    end
+
+    def eager_load!
+      loader.eager_load
+    end
+
+    def anonymization_enabled?
+      @mutex.synchronize do
+        configuration.environments.include?(Rails.env.to_sym)
+      end
+    end
+
+    def alias_enabled?
+      @mutex.synchronize do
+        configuration.alias_original_columns
+      end
+    end
+
+    def load_model(klass_name)
+      model = klass_name.safe_constantize
+      raise Error, "Could not find class: #{klass_name}" unless model
+
+      unless models.include?(model)
+        raise Error, "#{klass_name} is not an anonymized model"
+      end
+
+      model
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActiveRecordAnonymizer::Extensions
+end
+
+ActiveRecordAnonymizer.eager_load!

data/lib/generators/active_record_anonymizer/USAGE

@@ -0,0 +1,10 @@
+Description:
+    This generator creates a migration to anonymize a model's fields.
+    If the generator is used to generate migration for a model with field "name",
+    it will create a migration to create a new field "anonymized_name"
+
+Example:
+    bin/rails generate anonymize Model field1 field2
+
+    This will create:
+        db/migrate/20160101000000_anonymize_model.rb

data/lib/generators/active_record_anonymizer/anonymize_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module ActiveRecordAnonymizer
+  class AnonymizeGenerator < ActiveRecord::Generators::Base
+    include Rails::Generators::Migration
+
+    class InvalidArguments < Thor::Error; end
+
+    source_root File.expand_path("templates", __dir__)
+
+    argument :attributes, type: :array, default: [], banner: "attribute attribute"
+
+    def generate_migration
+      validate_arguments
+      migration_template "migration.rb.erb", "db/migrate/anonymize_#{table_name}.rb"
+      output_instructions
+    end
+
+    private
+
+    def output_instructions
+      log "\n\n"
+      log "Add the following to your model file:"
+      log "\n"
+      log anonymize_method_string
+      log "\n"
+    end
+
+    def anonymize_method_string
+      "  anonymize :#{attributes.map(&:name).join(', :')}\n"
+    end
+
+    def validate_arguments
+      raise InvalidArguments, "Attributes are needed for the migration" if attributes.empty?
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if Rails.version.start_with? "5"
+    end
+  end
+end

data/lib/generators/active_record_anonymizer/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module ActiveRecordAnonymizer
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Creates an anonymizer initializer file"
+    def copy_initializer
+      template "anonymizer.rb", "config/initializers/anonymizer.rb"
+    end
+  end
+end

data/lib/generators/active_record_anonymizer/templates/anonymizer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+ActiveRecordAnonymizer.configure do |config|
+  # Configure the environments in which anonymization is allowed.
+  config.environments = %i[staging]
+
+  # Uncomment the following line to skip updating anonymized_columns when updating the original columns.
+  # config.skip_update = true
+
+  # Uncomment the following line to alias the original columns.
+  # config.alias_original_columns = true
+
+  # This will only work if config.alias_original_columns is set to true.
+  # Change the alias column name. (original by default)
+  # Model.original_column_name will provide the original value of the column.
+  config.alias_column_name = "original"
+end

data/lib/generators/active_record_anonymizer/templates/migration.rb.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+<% attributes.each do |column| -%>
+    add_column :<%= table_name %>, :<%= "anonymized_#{column.name}" %>, :<%= column.type %>, index: <%= column.has_index? %>, unique: <%= column.has_uniq_index? %>
+<% end -%>
+  end
+
+  def self.down
+<%- attributes.each do |column| -%>
+    remove_column :<%= table_name %>, :<%= "anonymized_#{column.name}" %>
+<% end -%>
+  end
+end

data/lib/tasks/active_record_anonymizer.rake

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_record_anonymizer"
+
+namespace :anonymizer do
+  desc "populate anonymize columns (specify CLASS)"
+  task populate: :environment do
+    klass_name = ENV["CLASS"]
+    abort "USAGE: rake anonymize:populate CLASS=User" unless klass_name
+
+    model =
+      begin
+        ActiveRecordAnonymizer.load_model(klass_name)
+      rescue ActiveRecordAnonymizer::Error => e
+        abort e.message
+      end
+
+    puts "Anonymize columns for #{klass_name}..."
+    model.each(&:save!)
+    puts "Anonymize columns for #{klass_name} done!"
+  end
+
+  namespace :populate do
+    desc "populate anonymize columns for all models"
+    task all: :environment do
+      ActiveRecordAnonymizer.models.each do |model|
+        puts "Anonymizing #{model.name}..."
+        model.find_each(&:save!)
+      end
+      puts "Anonymize columns for all models done!"
+    end
+  end
+end

data/sig/active_record_anonymizer.rbs

@@ -0,0 +1,4 @@
+module ActiveRecordAnonymizer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: active_record_anonymizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keshav Biswa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: "    A Rails gem to anonymize ActiveRecord attributes using Faker and
+  other strategies.\n"
+email:
+- keshavbiswa21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record_anonymizer.rb
+- lib/active_record_anonymizer/anonymizer.rb
+- lib/active_record_anonymizer/configuration.rb
+- lib/active_record_anonymizer/encryptor.rb
+- lib/active_record_anonymizer/extensions.rb
+- lib/active_record_anonymizer/fake_value.rb
+- lib/active_record_anonymizer/railtie.rb
+- lib/active_record_anonymizer/version.rb
+- lib/generators/active_record_anonymizer/USAGE
+- lib/generators/active_record_anonymizer/anonymize_generator.rb
+- lib/generators/active_record_anonymizer/install_generator.rb
+- lib/generators/active_record_anonymizer/templates/anonymizer.rb
+- lib/generators/active_record_anonymizer/templates/migration.rb.erb
+- lib/tasks/active_record_anonymizer.rake
+- sig/active_record_anonymizer.rbs
+homepage: https://github.com/keshavbiswa/active_record_anonymizer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/keshavbiswa/active_record_anonymizer
+  source_code_uri: https://github.com/keshavbiswa/active_record_anonymizer
+  changelog_uri: https://github.com/keshavbiswa/active_record_anonymizer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Anonymize your ActiveRecord attributes with ease.
+test_files: []