active_record_anonymizer 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c73430fdcaf6abc9be48923e1470d563ee313d2c2347539df53951a38d1f80f
-  data.tar.gz: 8cd49317b132d36486bb8a1d627413783dcb84caecee5b726b8e516ea6434dfd
+  metadata.gz: a644f35a1b766f9ff29cbc1c8d02f4b8dd521da9af8cb54e3e1ab2056d103af1
+  data.tar.gz: ef0ac08ee8dea107e714ddb22b1c7271f558272421e810556a161d0bb7bb954e
 SHA512:
-  metadata.gz: 8b59a6dacc1a10953cd6a4aa63bea0a938113b0f443964dabdf4560d384c9e1073728d16d8977aca4eb9abd8e70e46fca2e3dfc9e0b36d17160471c91d749dda
-  data.tar.gz: 3f29ec54f264b9950e0783d8ba616e05910c64a79e408516c6dd63bed248f3fe04a4664c159db8c6cceb9c009250a429de29e994be6f7113112fa71be895ba43
+  metadata.gz: 04f40e398b68ba3c74765d550294d6a29f060cc408fec1f7c9e48b22eca5e7fdc3501b7b288f70255ce7b36f1838a368974aa318e1ddd189cac713dc954e9e34
+  data.tar.gz: 3f7430c8b91d50476fd0e52592990814da6827ee13185bb8ce5ee3bf51bd970e96f13f1cae7b98752dde2a92ca899ad7a0b110ccfbb257fe033f1a81fd4d3533

data/CHANGELOG.md

@@ -5,3 +5,40 @@
 #### Fixed migration_version not getting generated in Rails v5+
 
 * [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/6)
+
+## Version 0.2.0
+
+### New Fixes
+
+#### Removed index from migration
+
+* [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/7)
+
+#### Fixed incorrect generator name in README.md
+
+## Version 0.2.1
+
+### New Fixes
+
+#### Fixed validations breaking the anonymization process
+
+* [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/8)
+
+#### Renamed Anonymizer to Initiater
+
+* [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/8)
+
+#### Fixed populate:all task not loading models
+
+* [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/9)
+
+### Fixed configuration not reloading when changed
+
+* [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/10)
+
+### New Features
+
+#### Added support for development environment
+
+* [GitHub PR](https://github.com/keshavbiswa/active_record_anonymizer/pull/11)
+

data/README.md

@@ -34,7 +34,7 @@ Install the gem using the following command:
 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
+    $ bin/rails generate active_record_anonymizer:anonymize User first_name last_name
 This will generate a migration file similar to the following:
 
 ```ruby
@@ -82,14 +82,14 @@ end
 
 You can configure the gem using the following options:
 
-- `:environments` - The environments in which the anonymized data should be used. (Defaults to `[:staging]`)
+- `:environments` - The environments in which the anonymized data should be used. (Defaults to `[:development]`)
 - `: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.environments = [:development, :staging] # 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}

data/lib/active_record_anonymizer/attributes_anonymizer.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ActiveRecordAnonymizer
+  class AttributesAnonymizer
+    attr_reader :model
+
+    def initialize(model, skip_update: false)
+      @model = model
+      @skip_update = skip_update
+    end
+
+    def anonymize_columns
+      if model.new_record?
+        anonymize_all_attributes
+      else
+        # Skip updating the record if skip_update is true
+        return if @skip_update
+
+        anonymize_changed_columns
+      end
+    end
+
+    def populate
+      anonymize_all_attributes
+      model.save!
+    end
+
+    private
+
+    def anonymize_all_attributes
+      model.class.anonymized_attributes.each_value do |settings|
+        generate_and_write_fake_value(settings[:column], settings[:with])
+      end
+    end
+
+    def anonymize_changed_columns
+      changes = model.changes.keys.map(&:to_sym)
+      changed_columns = changes & model.class.anonymized_attributes.keys
+
+      changed_columns.each do |column|
+        settings = model.class.anonymized_attributes[column]
+        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(model)
+                   when Symbol
+                     model.send(with_strategy)
+                   else
+                     FakeValue.new(anonymized_attr, model.class.columns_hash[anonymized_attr.to_s]).generate_fake_value
+                   end
+      model.write_attribute(anonymized_attr, fake_value)
+    end
+  end
+end

data/lib/active_record_anonymizer/configuration.rb

@@ -5,7 +5,7 @@ module ActiveRecordAnonymizer
     attr_accessor :environments, :skip_update, :alias_original_columns, :alias_column_name
 
     def initialize
-      @environments = %i[staging]
+      @environments = %i[development]
       @skip_update = false
       @alias_original_columns = false
       @alias_column_name = "original"

data/lib/active_record_anonymizer/extensions.rb

@@ -24,63 +24,29 @@ module ActiveRecordAnonymizer
         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
+        initiator = Initiator.new(self, attributes, with: with, column_name: column_name)
+        initiator.validate
+        initiator.configure_anonymization
 
         # 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?
+            before_validation :anonymizer_anonymize_columns, if: :anonymizer_anonymization_enabled?
             @anonymizer_setup_done = true
           end
         end
       end
     end
 
-    def anonymization_enabled?
+    # Deliberately using anonymizer_ prefix to avoid conflicts
+    def anonymizer_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)
+    # Deliberately using anonymizer_ prefix to avoid conflicts
+    def anonymizer_anonymize_columns
+      AttributesAnonymizer.new(self, skip_update: ActiveRecordAnonymizer.configuration.skip_update).anonymize_columns
     end
   end
 end

data/lib/active_record_anonymizer/{anonymizer.rb → initiator.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveRecordAnonymizer
-  class Anonymizer
+  class Initiator
     attr_reader :model, :attributes, :with, :column_name
 
     def initialize(model, attributes, with: nil, column_name: nil)
@@ -17,7 +17,7 @@ module ActiveRecordAnonymizer
       check_for_missing_anonymized_columns(attributes)
     end
 
-    def anonymize_attributes
+    def configure_anonymization
       attributes.each do |attribute|
         anonymized_column = anonymized_column_name(attribute)
 

data/lib/active_record_anonymizer/version.rb

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

data/lib/active_record_anonymizer.rb

@@ -40,7 +40,7 @@ module ActiveRecordAnonymizer
     end
 
     def configuration
-      Thread.current[:active_record_anonymizer_configuration] ||= Configuration.new
+      @configuration ||= Configuration.new
     end
 
     def eager_load!

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

@@ -2,7 +2,7 @@
 
 ActiveRecordAnonymizer.configure do |config|
   # Configure the environments in which anonymization is allowed.
-  config.environments = %i[staging]
+  config.environments = %i[development]
 
   # Uncomment the following line to skip updating anonymized_columns when updating the original columns.
   # config.skip_update = true

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

@@ -3,7 +3,7 @@
 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? %>
+    add_column :<%= table_name %>, :<%= "anonymized_#{column.name}" %>, :<%= column.type %>
 <% end -%>
   end
 

data/lib/tasks/active_record_anonymizer.rake

@@ -16,16 +16,22 @@ namespace :anonymizer do
       end
 
     puts "Anonymize columns for #{klass_name}..."
-    model.each(&:save!)
+    model.find_each do |record|
+      ActiveRecordAnonymizer::AttributesAnonymizer.new(record).populate
+    end
     puts "Anonymize columns for #{klass_name} done!"
   end
 
   namespace :populate do
     desc "populate anonymize columns for all models"
     task all: :environment do
+      Rails.application.eager_load!
+
       ActiveRecordAnonymizer.models.each do |model|
         puts "Anonymizing #{model.name}..."
-        model.find_each(&:save!)
+        model.find_each do |record|
+          ActiveRecordAnonymizer::AttributesAnonymizer.new(record).populate
+        end
       end
       puts "Anonymize columns for all models done!"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_anonymizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Keshav Biswa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,11 +81,12 @@ files:
 - README.md
 - Rakefile
 - lib/active_record_anonymizer.rb
-- lib/active_record_anonymizer/anonymizer.rb
+- lib/active_record_anonymizer/attributes_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/initiator.rb
 - lib/active_record_anonymizer/railtie.rb
 - lib/active_record_anonymizer/version.rb
 - lib/generators/active_record_anonymizer/USAGE