ff1 1.2.6 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08a90d97f68acff2dc2a91b37b171d0f9df02cf57d4c754cf9cafd0f4bc0ac99'
-  data.tar.gz: a36f31971be3e026ed3b593958c70cbfced3e3075c25a905798bba08a93b709e
+  metadata.gz: dbd66784cc326ed2e53b409756fe1dcf64e7925c3053454dee46f13a48fe5ec5
+  data.tar.gz: 38a4f59abd2e32073f539b5a4f1c289655caf058adf3b49476389ff64d557e94
 SHA512:
-  metadata.gz: c091310e5b8cb9f79fa1067f1a597f9f6c8b0cb19379e72d9349287ec76644228aabb9f5b7de0c4f943e8aacee584c66070374d58e758c0d8fefe52acabb2e84
-  data.tar.gz: c2483bc35f1d6bbb38cf79ab8b9813a1e2d0ef827655c19da1a77604fa1a2c4478d7af6cc79a1b479bc42a8b333f0a2ba101ffe0fb097d123691d52602a018d3
+  metadata.gz: 24ee99f7b50375729a26e8b895c034f9d60f3595e18586d1029911eee866280f48085b1f83d4f05e53df90055925aea65698e4cac3a00de24383b37f81b3c4fd
+  data.tar.gz: af3e1aedf71412bc8b899f76d8172c1496bc09ad46e0b40d332047a3f0ddd8b3c7d9c361885d4ccbde3cb400967fa20440ae1a8de1fdab4e41f066ab12ef185e

data/lib/ff1/version.rb

@@ -2,5 +2,5 @@
 
 module FF1
   # Current version of the FF1 gem
-  VERSION = '1.2.6'
+  VERSION = '1.2.8'
 end

data/lib/generators/ff1/install_generator.rb

@@ -16,25 +16,23 @@ module Ff1
       include Rails::Generators::Actions
       source_root File.expand_path('templates', __dir__)
 
-      argument :models, type: :array, default: [], banner: 'model1 model2'
-
+      argument :models, type: :array, default: [], banner: "model1 model2"
+      
       class_option :deleted_at_column, type: :string, default: 'deleted_at',
-                                       desc: 'Name of the deleted_at timestamp column'
-
-      class_option :ff1_deleted_column, type: :string, default: 'ff1_deleted',
-                                        desc: 'Name of the FF1 deleted boolean column'
-
+                   desc: 'Name of the deleted_at timestamp column'
+      
+      
       class_option :add_indexes, type: :boolean, default: true,
-                                 desc: 'Add database indexes for performance'
+                   desc: 'Add database indexes for performance'
 
       # Required for Rails::Generators::Migration
-      def self.next_migration_number(_path)
-        Time.now.strftime('%Y%m%d%H%M%S')
+      def self.next_migration_number(path)
+        Time.now.strftime("%Y%m%d%H%M%S")
       end
 
       def generate_migration
         if models.empty?
-          say 'Generating FF1 configuration initializer...'
+          say "Generating FF1 configuration initializer..."
           generate_initializer
         else
           models.each do |model_name|
@@ -47,19 +45,21 @@ module Ff1
 
       def generate_initializer
         template 'initializer.rb', 'config/initializers/ff1.rb'
-        say 'FF1 initializer created at config/initializers/ff1.rb', :green
-        say ''
-        say 'Next steps:', :blue
-        say '1. Set your encryption key in the initializer'
-        say '2. Run: rails generate ff1:install ModelName for each model you want to enable'
-        say '3. Run: rails db:migrate'
+        say "FF1 initializer created at config/initializers/ff1.rb", :green
+        say ""
+        say "Next steps:", :blue
+        say "1. Set your encryption key in the initializer"
+        say "2. Run: rails generate ff1:install ModelName for each model you want to enable"
+        say "3. Run: rails db:migrate"
       end
 
       def generate_model_migration(model_name)
         model_class_name = model_name.camelize
-        table_name = model_name.underscore.pluralize
-        migration_name = "add_ff1_columns_to_#{table_name}"
-        migration_class_name = "AddFf1ColumnsTo#{model_class_name.pluralize}"
+        @table_name = model_name.underscore.pluralize
+        @migration_number = self.class.next_migration_number(nil)
+        migration_name = "add_ff1_columns_to_#{@table_name}"
+        @migration_file_name = "#{@migration_number}_#{migration_name}"
+        @migration_class_name = @migration_file_name.camelize
 
         # Check if model exists
         begin
@@ -70,32 +70,24 @@ module Ff1
 
         # Generate migration file
         migration_template 'migration.rb.erb',
-                           "db/migrate/#{timestamp}_#{migration_name}.rb",
-                           migration_class_name: migration_class_name,
-                           table_name: table_name,
-                           deleted_at_column: deleted_at_column,
-                           ff1_deleted_column: ff1_deleted_column,
-                           add_indexes: add_indexes?
+                          "db/migrate/#{@migration_file_name}.rb"
 
         say "Migration created for #{model_class_name}", :green
         say "Run 'rails db:migrate' to apply the changes", :blue
       end
 
       def timestamp
-        Time.now.strftime('%Y%m%d%H%M%S')
+        Time.now.strftime("%Y%m%d%H%M%S")
       end
 
       def deleted_at_column
         options['deleted_at_column']
       end
 
-      def ff1_deleted_column
-        options['ff1_deleted_column']
-      end
 
       def add_indexes?
         options['add_indexes']
       end
     end
   end
-end
+end

data/lib/generators/ff1/templates/initializer.rb

@@ -5,13 +5,13 @@ FF1::ActiveRecord.configure do |config|
   # Global encryption key - REQUIRED
   # Should be 16, 24, or 32 bytes for AES-128/192/256
   # Store securely using Rails credentials or environment variables
-  #
+  # 
   # Example using Rails credentials:
   # config.global_key = Rails.application.credentials.ff1_encryption_key
-  #
+  # 
   # Example using environment variable:
   # config.global_key = ENV['FF1_ENCRYPTION_KEY']&.b
-  #
+  # 
   # For development/testing only (DO NOT use in production):
   config.global_key = SecureRandom.bytes(32) if Rails.env.development? || Rails.env.test?
 
@@ -23,16 +23,20 @@ FF1::ActiveRecord.configure do |config|
   # Column names for soft delete functionality
   config.deleted_at_column = :deleted_at
   config.ff1_deleted_column = :ff1_deleted
+
+  # Hide soft-deleted records from default queries (default: true)
+  # Set to false to include soft-deleted records in queries by default
+  config.hide_deleted_by_default = true
 end
 
 # Example model integration:
 #
 # class User < ApplicationRecord
 #   include FF1::ActiveRecord
-#
+#   
 #   # Encrypt email and phone with reversible encryption
 #   ff1_encrypt :email, :phone, mode: :reversible
-#
+#   
 #   # Encrypt SSN with irreversible encryption
 #   ff1_encrypt :ssn, mode: :irreversible
 # end
@@ -41,11 +45,11 @@ end
 #   user = User.create(email: 'user@example.com', ssn: '123-45-6789')
 #   puts user.email  # Automatically decrypted for reversible columns
 #   puts user.ssn    # Shows "[ENCRYPTED]" for irreversible columns
-#
+#   
 #   # GDPR compliant deletion
 #   user.destroy     # Soft deletes with irreversible encryption
-#
+#   
 #   # Query scopes
 #   User.ff1_active    # Non-deleted users
 #   User.ff1_deleted   # Soft-deleted users
-#   User.ff1_all       # All users (active + deleted)
+#   User.ff1_all       # All users (active + deleted)

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

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
-    add_column :<%= table_name %>, :<%= deleted_at_column %>, :datetime, null: true
-    add_column :<%= table_name %>, :<%= ff1_deleted_column %>, :boolean, null: false, default: false
+    add_column :<%= @table_name %>, :<%= deleted_at_column %>, :datetime, null: true
 
     <% if add_indexes? %>
-    add_index :<%= table_name %>, :<%= deleted_at_column %>
-    add_index :<%= table_name %>, :<%= ff1_deleted_column %>
-    add_index :<%= table_name %>, [:<%= ff1_deleted_column %>, :<%= deleted_at_column %>], 
-              name: 'index_<%= table_name %>_on_ff1_deletion'
+    add_index :<%= @table_name %>, :<%= deleted_at_column %>
     <% end %>
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ff1
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.8
 platform: ruby
 authors:
 - Ahmed Abdellatif