safer_migrations 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ad6bd8008a2d391b97b18ec2c14b12a51a35c875c34b0cfa2f61ec079ed89b9
-  data.tar.gz: c5892a3dfd9646c4c1d8b38a7538189f056b1deb771d6302220efde903eec311
+  metadata.gz: 4c294834ff3b4b77adb2e284fe48078e3b7482559539b1fa6974f2dc0a13ec8d
+  data.tar.gz: 3773b0eb7ccf1ed43514caabb462caf12ac7383641e796c305a92f100e803860
 SHA512:
-  metadata.gz: 6b7d30166b71ad5a053f5fdcef23ee166004e5867867cd841fbf133cf517666c27e3289203e5936cc4f17f3bdbfbdc0ca74c7110809b2d380cb2658a1c952b9b
-  data.tar.gz: 12e0ba7df956e5678ffa13bc4cbc8851f0265017e3c2498da953d60bff02f55f1384f4272fda52b4cc298da28650f1256d275a8cf3928ecf41acc05aeb6e1c02
+  metadata.gz: 6fa2ec4033335b64091a95defeabe042ffd6ee86cdfbe8c0517516b199211b059fd410377448001571392231d1163e16cf9655ff6c0aed5da69c38047c0522c8
+  data.tar.gz: c9253a672f540ecec3fc46d74ac4f4862bce92d42324e772b652a8833d5972c7d1d9b179d9923cad086a6c3c87dbf3709d848a4b0a6fbf3f86bf6f455626cb3a

data/README.md

@@ -1,6 +1,7 @@
 # SaferMigrations
 
 `SaferMigrations` provides safer methods for Active Record Migrations.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -13,7 +14,18 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem provides the following methods for Active Record Migrations.
+
+* `safer_remove_column`
+* `safer_remove_columns`
+* `safer_rename_column`
+* `t.safer_remove`
+* `t.safer_rename`
+
+These methods check whether a column that will be removed is still used in a model. If a model uses it, these methods raise an error. In that case, you should specify a column to `ignored_columns` first.
+
+Except for checking it, the behavior is same as well as the Rail's default methods.
+
 
 ## Development
 

data/lib/safer_migrations/command_recorder.rb

@@ -17,5 +17,13 @@ module SaferMigrations
     def invert_safer_remove_columns(args)
       invert_remove_columns(args)
     end
+
+    ruby2_keywords def safer_rename_column(*args, &block)
+      record(:safer_rename_column, args, &block)
+    end
+
+    def invert_safer_rename_column(args)
+      invert_rename_column(args)
+    end
   end
 end

data/lib/safer_migrations/schema_definitions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SaferMigrations
+  module TableDefinition
+    def safer_remove(*column_names, **options)
+      @base.safer_remove_columns(name, *column_names, **options)
+    end
+
+    def safer_rename(column_name, new_column_name)
+      @base.safer_rename_column(name, column_name, new_column_name)
+    end
+  end
+end

data/lib/safer_migrations/schema_statements.rb

@@ -2,16 +2,45 @@
 
 module SaferMigrations
   module SchemaStatements
-    def safer_remove_column(table_name, column_name, type = nil, **options)
-      validate_remove_column(table_name, column_name)
-      remove_column(table_name, column_name, type = nil, **options)
-    end
+    if SaferMigrations.enforce_safer_methods
+      def remove_column(table_name, column_name, type = nil, **options)
+        validate_remove_column(table_name, column_name)
+        super
+      end
+
+      def remove_columns(table_name, *column_names, type: nil, **options)
+        column_names.each do |column_name|
+          validate_remove_column(table_name, column_name)
+        end
+        super
+      end
+
+      def rename_column(table_name, column_name, new_column_name)
+        validate_remove_column(table_name, column_name)
+        super
+      end
+
+      alias_method :safer_remove_column, :remove_column
+      alias_method :safer_remove_columns, :remove_columns
+      alias_method :safer_rename_column, :rename_column
+    else
+      def safer_remove_column(table_name, column_name, type = nil, **options)
+        validate_remove_column(table_name, column_name)
+        remove_column(table_name, column_name, type, **options)
+      end
+
+      def safer_remove_columns(table_name, *column_names, type: nil, **options)
+        column_names.each do |column_name|
+          validate_remove_column(table_name, column_name)
+        end
+
+        remove_columns(table_name, *column_names, type: type, **options)
+      end
 
-    def safer_remove_columns(table_name, *column_names, type: nil, **options)
-      column_names.each do |column_name|
+      def safer_rename_column(table_name, column_name, new_column_name)
         validate_remove_column(table_name, column_name)
+        rename_column(table_name, column_name, new_column_name)
       end
-      remove_columns(table_name, *column_names, type = nil, **options)
     end
 
     private

data/lib/safer_migrations/version.rb

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

data/lib/safer_migrations.rb

@@ -3,12 +3,39 @@
 require "active_support"
 require "active_record"
 
+module SaferMigrations
+  class << self
+    attr_accessor :enforce_safer_methods
+  end
+end
+
 require_relative "safer_migrations/version"
 require_relative "safer_migrations/errors"
-require_relative "safer_migrations/command_recorder"
-require_relative "safer_migrations/schema_statements"
 
 ActiveSupport.on_load(:active_record) do
-  ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(SaferMigrations::SchemaStatements)
+  require_relative "safer_migrations/command_recorder"
+  require_relative "safer_migrations/schema_definitions"
+
+  ActiveRecord::ConnectionAdapters::Table.prepend(SaferMigrations::TableDefinition)
   ActiveRecord::Migration::CommandRecorder.prepend(SaferMigrations::CommandRecorder)
 end
+
+ActiveSupport.on_load(:active_record_sqlite3adapter) do
+  require_relative "safer_migrations/schema_statements"
+  self.prepend(SaferMigrations::SchemaStatements)
+end
+
+ActiveSupport.on_load(:active_record_mysql2adapter) do
+  require_relative "safer_migrations/schema_statements"
+  self.prepend(SaferMigrations::SchemaStatements)
+end
+
+ActiveSupport.on_load(:active_record_trilogyadapter) do
+  require_relative "safer_migrations/schema_statements"
+  self.prepend(SaferMigrations::SchemaStatements)
+end
+
+ActiveSupport.on_load(:active_record_postgresqladapter) do
+  require_relative "safer_migrations/schema_statements"
+  self.prepend(SaferMigrations::SchemaStatements)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safer_migrations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Yuji yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-30 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -51,13 +51,14 @@ files:
 - lib/safer_migrations.rb
 - lib/safer_migrations/command_recorder.rb
 - lib/safer_migrations/errors.rb
+- lib/safer_migrations/schema_definitions.rb
 - lib/safer_migrations/schema_statements.rb
 - lib/safer_migrations/version.rb
-homepage: https://github.com/y-yagi
+homepage: https://github.com/y-yagi/safer_migrations
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/y-yagi
+  homepage_uri: https://github.com/y-yagi/safer_migrations
 post_install_message: 
 rdoc_options: []
 require_paths: