iron_trail 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4743b8660d0a3f59c82131213a4e9b85396c0efa83f2a00c2678dcb2a2d57a7
-  data.tar.gz: 6d53fef0dbb300ce504c8065616142ba012cb697647a5f588d4f2bea3935e293
+  metadata.gz: fbae2be821b8553a0ddf746fd9d30b3b7420b27e80e293b0716d78bf60c2c4dd
+  data.tar.gz: 9525cad670a20bc43414a56a0ea87734e82c908f175a82545cbe0c386f7fec86
 SHA512:
-  metadata.gz: 7bc826ad0ff24c91b6e7d9bac08fb7c5a0f893142a91315804aafe68a95bc96e3be5b9b98ed83de9f4d293daab9b1bbce3432579116db79fa3c47ca8b184b0a7
-  data.tar.gz: b43255cfbe9833075c44335eaaeb5e2067e942d99f4ff3b8e35aee42c9960cdfe6e1e96cfe5c75fd2b4ae53c8dbef580dae2768cf308f92b2bb2d5a5e06ec667
+  metadata.gz: b6a32637f82a839336850df3f5b8a090a367b87eb519db903c41681de33578ea3b4d13f9ed15301985a29ce0b82c2bfacd98651da1e266373a639741453e2925
+  data.tar.gz: 8bb96a201f38d6923d864f65d92b3bec8cab90df9ad30144716d8ea0943d8fad25f46b4433a6e868177454cef3c6f8e7c738d22e7c83354162f897c3e7882795

data/lib/generators/iron_trail/migration_generator.rb

@@ -7,23 +7,25 @@ module IronTrail
   class MigrationGenerator < Rails::Generators::Base
     include ::Rails::Generators::Migration
 
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path("templates", __dir__)
 
-    desc 'Generates a migration adding the iron trail changes table'
+    desc "Generates a migration adding the iron trail changes table"
     def create_changes_migration_file
+      migration_dir = File.expand_path("db/migrate")
+
       migration_template(
-        'create_irontrail_changes.rb.erb',
-        'db/migrate/create_irontrail_changes.rb'
+        "create_irontrail_changes.rb.erb",
+        "db/migrate/create_irontrail_changes.rb"
       )
 
       migration_template(
-        'create_irontrail_support_tables.rb.erb',
-        'db/migrate/create_irontrail_support_tables.rb'
+        "create_irontrail_support_tables.rb.erb",
+        "db/migrate/create_irontrail_support_tables.rb"
       )
 
       migration_template(
-        'create_irontrail_trigger_function.rb.erb',
-        'db/migrate/create_irontrail_trigger_function.rb'
+        "create_irontrail_trigger_function.rb.erb",
+        "db/migrate/create_irontrail_trigger_function.rb"
       )
     end
 

data/lib/iron_trail/association.rb

@@ -3,7 +3,12 @@
 module IronTrail
   class Association < ::ActiveRecord::Associations::HasManyAssociation
     def association_scope
+      klass = self.klass
+      reflection = self.reflection
       scope = klass.unscoped
+      owner = self.owner
+
+      chain = [::ActiveRecord::Reflection::RuntimeReflection.new(reflection, self)]
 
       foreign_key = reflection.join_foreign_key
       pk_value = owner._read_attribute(foreign_key)

data/lib/iron_trail/change_model_concern.rb

@@ -20,7 +20,7 @@ module IronTrail
 
         args.each do |col_name, value|
           scope.where!(
-            ::Arel::Nodes::SqlLiteral.new("rec_delta->#{connection.quote(col_name)}->>#{Integer(ary_index)}").eq(
+            ::Arel::Nodes::SqlLiteral.new("rec_delta->#{connection.quote col_name}->>#{Integer(ary_index)}").eq(
               ::Arel::Nodes::BindParam.new(value)
             )
           )

data/lib/iron_trail/config.rb

@@ -28,7 +28,7 @@ module IronTrail
     # directly.
     # It is possible to call Array#clear to empty the array and remove default
     # should that be desired.
-    def ignored_tables=(_v)
+    def ignored_tables=(v)
       raise 'Overwriting ignored_tables is not allow. Instead, add or remove to it explicitly.'
     end
   end

data/lib/iron_trail/db_functions.rb

@@ -46,12 +46,12 @@ module IronTrail
         LIMIT 1;
       SQL
 
-      connection.execute(stmt).to_a.count.positive?
+      connection.execute(stmt).to_a.count > 0
     end
 
     def remove_functions(cascade:)
-      query = +'DROP FUNCTION irontrail_log_row'
-      query << ' CASCADE' if cascade
+      query = +"DROP FUNCTION irontrail_log_row"
+      query << " CASCADE" if cascade
 
       connection.execute(query)
     end
@@ -83,6 +83,18 @@ module IronTrail
       end
     end
 
+    def disable_for_all_ignored_tables
+      affected_tables = collect_tracked_table_names & (
+        OWN_TABLES + (IronTrail.config.ignored_tables || [])
+      )
+
+      affected_tables.each do |table_name|
+        disable_tracking_for_table(table_name)
+      end
+
+      affected_tables
+    end
+
     def collect_tables_tracking_status
       ignored_tables = OWN_TABLES + (IronTrail.config.ignored_tables || [])
 
@@ -96,7 +108,7 @@ module IronTrail
     end
 
     def disable_tracking_for_table(table_name)
-      # NOTE: will disable even if table is ignored as this allows
+      # Note: will disable even if table is ignored as this allows
       # one to fix ignored tables mnore easily. Since the table is already
       # ignored, it is an expected destructive operation.
 

data/lib/iron_trail/migration.rb

@@ -2,7 +2,7 @@
 
 module IronTrail
   module Migration
-    def method_missing(method, *args) # rubocop:disable Style/MissingRespondToMissing
+    def method_missing(method, *args)
       running_from_schema = is_a?(ActiveRecord::Schema) ||
         (defined?(ActiveRecord::Schema::Definition) && is_a?(ActiveRecord::Schema::Definition))
 
@@ -11,7 +11,9 @@ module IronTrail
       return result unless IronTrail.enabled? && method == :create_table
 
       start_at_version = IronTrail.config.track_migrations_starting_at_version
-      return result if !running_from_schema && start_at_version && version < (Integer(start_at_version))
+      if !running_from_schema && start_at_version
+        return result if self.version < Integer(start_at_version)
+      end
 
       table_name = args.first.to_s
       return result if IronTrail.ignore_table?(table_name)
@@ -27,10 +29,7 @@ module IronTrail
       if db_fun.function_present?
         db_fun.enable_tracking_for_table(table_name)
       else
-        Rails.logger.warn(
-          "IronTrail will not create trigger for table #{table_name} " \
-          'because the trigger function does not exist in the database.'
-        )
+        Rails.logger.warn("IronTrail will not create trigger for table #{table_name} because the trigger function does not exist in the database.")
       end
 
       result

data/lib/iron_trail/model.rb

@@ -8,7 +8,7 @@ module IronTrail
   # own AR reflection and association classes.
   module Model
     def self.included(mod)
-      mod.include(ClassMethods)
+      mod.include ClassMethods
 
       ::ActiveRecord::Reflection.add_reflection(
         mod,

data/lib/iron_trail/query_transformer.rb

@@ -2,7 +2,7 @@
 
 module IronTrail
   class QueryTransformer
-    METADATA_MAX_LENGTH = 1_048_576 # 1 MiB
+    METADATA_MAX_LENGTH = 1048576 # 1 MiB
 
     attr_reader :transformer_proc
 
@@ -24,10 +24,7 @@ module IronTrail
         metadata = JSON.dump(current_metadata)
 
         if metadata.length > METADATA_MAX_LENGTH
-          Rails.logger.warn(
-            "IronTrail metadata is longer than maximum length! #{metadata.length} > #{METADATA_MAX_LENGTH}"
-          )
-
+          Rails.logger.warn("IronTrail metadata is longer than maximum length! #{metadata.length} > #{METADATA_MAX_LENGTH}")
           next query
         end
 

data/lib/iron_trail/reflection.rb

@@ -2,13 +2,13 @@
 
 module IronTrail
   class Reflection < ::ActiveRecord::Reflection::AssociationReflection
-    def collection? = true
+    def collection?; true; end
 
     def association_class
       ::IronTrail::Association
     end
 
-    def join_scope(table, foreign_table, _foreign_klass)
+    def join_scope(table, foreign_table, foreign_klass)
       scope = klass_join_scope(table, nil)
 
       foreign_key_column_names = Array(join_foreign_key)
@@ -26,7 +26,7 @@ module IronTrail
           ::Arel::Nodes::As.new(
             foreign_table[foreign_key_column_name],
             ::Arel::Nodes::SqlLiteral.new('text')
-          )
+          ),
         ]
       )
 

data/lib/iron_trail/testing/rspec.rb

@@ -1,3 +1,66 @@
 # frozen_string_literal: true
 
+if ENV['RAILS_ENV'] == 'production'
+  raise 'This file should not be required in production. ' \
+    'Change the RAILS_ENV env var temporarily to override this.'
+end
+
 require 'iron_trail'
+
+module IronTrail
+  module Testing
+    class << self
+      attr_accessor :enabled
+
+      def enable!
+        DbFunctions.new(ActiveRecord::Base.connection).install_functions
+        @enabled = true
+      end
+
+      def disable!
+        # We "disable" it by replacing the trigger function by a no-op one.
+        # This should be faster than adding/removing triggers from several
+        # tables every time.
+        sql = <<~SQL
+          CREATE OR REPLACE FUNCTION irontrail_log_row()
+          RETURNS TRIGGER AS $$
+          BEGIN
+            RETURN NULL;
+          END;
+          $$ LANGUAGE plpgsql;
+        SQL
+
+        ActiveRecord::Base.connection.execute(sql)
+        @enabled = false
+      end
+
+      def with_iron_trail(want_enabled:, &block)
+        was_enabled = IronTrail::Testing.enabled
+
+        if want_enabled
+          ::IronTrail::Testing.enable! unless was_enabled
+        else
+          ::IronTrail::Testing.disable! if was_enabled
+        end
+
+        block.call
+      ensure
+        if want_enabled && !was_enabled
+          ::IronTrail::Testing.disable!
+        elsif !want_enabled && was_enabled
+          ::IronTrail::Testing.enable!
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.around(:each, iron_trail: true) do |example|
+    IronTrail::Testing.with_iron_trail(want_enabled: true) { example.run }
+  end
+  config.around(:each, iron_trail: false) do |example|
+    raise "Using iron_trail: false does not do what you might think it does. To disable iron_trail, " \
+      "use IronTrail::Testing.with_iron_trail(want_enabled: false) { ... } instead."
+  end
+end

data/lib/iron_trail/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
+# frozen_literal_string: true
 
 module IronTrail
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/iron_trail.rb

@@ -29,9 +29,9 @@ module IronTrail
 
   module SchemaDumper
     def trailer(stream)
-      stream.print("\n  IronTrail.post_schema_load(self, missing_tracking: @irontrail_missing_track)\n")
+      stream.print "\n  IronTrail.post_schema_load(self, missing_tracking: @irontrail_missing_track)\n"
 
-      super
+      super(stream)
     end
   end
 
@@ -87,9 +87,11 @@ module IronTrail
     end
 
     def_delegators :store_instance,
-      :store_metadata,
-      :merge_metadata,
-      :current_metadata
+                   :store_metadata,
+                   :merge_metadata,
+                   :current_metadata
+
+
   end
 end
 

data/lib/tasks/tracking.rake

@@ -1,45 +1,76 @@
 # frozen_string_literal: true
 
+module IronTrail::RakeHelper
+  class << self
+    def db_functions
+      IronTrail::DbFunctions.new(ActiveRecord::Base.connection)
+    end
+
+    def abort_when_unsafe!
+      run_unsafe = %w[true 1 yes].include?(ENV['IRONTRAIL_RUN_UNSAFE'])
+      return unless Rails.env.production? && !run_unsafe
+
+      puts "Aborting: operation is dangerous in a production environment. " + \
+            "Override this behavior by setting the IRONTRAIL_RUN_UNSAFE=1 env var."
+
+      exit(1)
+    end
+  end
+end
+
 namespace :iron_trail do
   namespace :tracking do
     desc 'Enables tracking for all missing tables.'
     task enable: :environment do
-      tables = db_functions.collect_tables_tracking_status[:missing]
-      unless tables.length.positive?
-        puts 'All tables are being tracked already (no missing tables found).'
-        puts 'If you think this is wrong, check your ignored_tables list.'
+      tables = IronTrail::RakeHelper.db_functions.collect_tables_tracking_status[:missing]
+      unless tables.length > 0
+        puts "All tables are being tracked already (no missing tables found)."
+        puts "If you think this is wrong, check your ignored_tables list."
         return
       end
 
       puts "Will start tracking #{tables.length} tables."
       tables.each do |table_name|
-        db_functions.enable_tracking_for_table(table_name)
+        IronTrail::RakeHelper.db_functions.enable_tracking_for_table(table_name)
+      end
+    end
+
+    desc 'Disabled tracking for any ignored table that might still have the trigger enabled.'
+    task disable_on_ignored: :environment do
+      affected_tables = IronTrail::RakeHelper.db_functions.disable_for_all_ignored_tables
+
+      unless affected_tables.empty?
+        puts "Removed tracking from #{affected_tables.length} tables:"
+
+        affected_tables.each do |table_name|
+          puts "\t#{table_name}"
+        end
       end
     end
 
     desc 'Disables tracking all tables. Dangerous!'
     task disable: :environment do
-      abort_when_unsafe!
+      IronTrail::RakeHelper.abort_when_unsafe!
 
-      tables = db_functions.collect_tables_tracking_status[:tracked]
+      tables = IronTrail::RakeHelper.db_functions.collect_tables_tracking_status[:tracked]
       puts "Will stop tracking #{tables.length} tables."
       tables.each do |table_name|
-        db_functions.disable_tracking_for_table(table_name)
+        IronTrail::RakeHelper.db_functions.disable_tracking_for_table(table_name)
       end
 
-      tables = db_functions.collect_tables_tracking_status[:tracked]
-      if tables.length.positive?
-        puts "WARNING: Something went wrong. There are still #{tables.length} " \
-             'tables being tracked.'
+      tables = IronTrail::RakeHelper.db_functions.collect_tables_tracking_status[:tracked]
+      if tables.length > 0
+        puts "WARNING: Something went wrong. There are still #{tables.length}" + \
+             " tables being tracked."
       else
-        puts 'Done!'
+        puts "Done!"
       end
     end
 
     desc 'Shows which tables are tracking, missing and ignored.'
     task status: :environment do
-      status = db_functions.collect_tables_tracking_status
-      ignored = IronTrail.config.ignored_tables || []
+      status = IronTrail::RakeHelper.db_functions.collect_tables_tracking_status
+      ignored = (IronTrail.config.ignored_tables || [])
 
       # We likely want to keep this structure of text untouched as someone
       # could use it to perform automation (e.g. monitoring).
@@ -47,36 +78,20 @@ namespace :iron_trail do
       puts "Missing #{status[:missing].length} tables."
       puts "There are #{ignored.length} ignored tables."
 
-      puts 'Tracked tables:'
+      puts "Tracked tables:"
       status[:tracked].sort.each do |table_name|
         puts "\t#{table_name}"
       end
 
-      puts 'Missing tables:'
+      puts "Missing tables:"
       status[:missing].sort.each do |table_name|
         puts "\t#{table_name}"
       end
 
-      puts 'Ignored tables:'
+      puts "Ignored tables:"
       ignored.sort.each do |table_name|
         puts "\t#{table_name}"
       end
     end
-
-    private
-
-    def db_functions
-      @db_functions ||= IronTrail::DbFunctions.new(ActiveRecord::Base.connection)
-    end
-
-    def abort_when_unsafe!
-      run_unsafe = %w[true 1 yes].include?(ENV['IRONTRAIL_RUN_UNSAFE'])
-      return unless Rails.env.production? && !run_unsafe
-
-      puts 'Aborting: operation is dangerous in a production environment. ' \
-           'Override this behavior by setting the IRONTRAIL_RUN_UNSAFE=1 env var.'
-
-      exit(1)
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iron_trail
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - André Diego Piske
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,61 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pg_party
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.69'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.69'
-- !ruby/object:Gem::Dependency
-  name: debug
-  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'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: pg_party
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -195,8 +167,7 @@ files:
 homepage: https://github.com/trusted/iron_trail
 licenses:
 - MIT
-metadata:
-  rubygems_mfa_required: 'true'
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths: