planetscale_rails 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b6092e8239253b330f4864fa3388c9826c326493d8d585a47e8bcb310e7dce2
-  data.tar.gz: b7457fdeb6ee47845266c63cd4baf13e80ee76746a121bf9644f3b5b9ad677c1
+  metadata.gz: 6b12ba63e8011c5a5838a651e7c6c89f4784bdf0729e571e1ce438aecf257dad
+  data.tar.gz: 2b90fe7b6861488cff954a6793a1fd30793b2c5690805ea0c1558663da2245ea
 SHA512:
-  metadata.gz: f104e35e0864e821d6e885d9f0d5b7af5067c5bea40c69440b60c1fc3d7dea6ecd2bcf3aad11dae9a606ca1d7b8d649989bcd4633ec5f805ba68c90d7bbd5bfa
-  data.tar.gz: 20aba5b8f3f8b9c7f15c0a95bc0f18bbea1a371258e293d1264599e91e015d6a721cb874594c8372cad990f9552dff724810fdaaeb867b0b223b961f1afe39a1
+  metadata.gz: ff86c5cc8e0f75a5455ad9672decf0e3be090405fc5169c431a7f03c2960ba4ffb330bb26feade3a3ff0a2cafd97b1717ad8de89ac8a00860c8360eb33508638
+  data.tar.gz: 1460c3295ae6c8cb006d0a4150e15d7bf02d1eca4e7974b795a096e79ecb7b33f1f9c7f6890ed307394310c9bd5bf5acd229656dacd2132fbc567d4f0cdb4e5a

data/README.md

@@ -90,6 +90,15 @@ We recommend using GitHub Actions to automate the creation of PlanetScale branch
 
 If your application has minimal data and schema changes are a low risk event, then running `psdb:migrate` directly against production is perfectly fine. As your datasize grows and your application becomes busier, the risk of schema changes increase and we highly recommend using the deploy request flow. It's the best way available to safely migrate your schema.
 
+## How to safely drop a column
+
+Before dropping the column in your database, there are a couple steps to take in your application to safely remove the column without any risk to your production application.
+
+1. Remove all references to the column in your code.
+2. Add the column name to `self.ignored_columns += %w(column_name)` in the model. [More on ignored_columns](https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-ignored_columns-3D).
+3. Deploy this code to production. This ensures your application is no longer making use of the column in production and it's removed from the schema cache.
+4. Follow the PlanetScale deploy request flow to drop the column.
+
 ## Usage with GitHub Actions
 
 See the [GitHub Actions examples](actions-example.md) doc for ways to automate your schema migrations with PlanetScale + Actions.

data/lib/planetscale_rails/migration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PlanetscaleRails
+  module Migration
+    module Current
+      # Allows users to set the `keyspace` option in their migration file.
+      # If the migration is being run against PlanetScale (i.e. `ENABLE_PSDB` is set), then we prepend the keyspace to the table name.
+      #
+      # For local MySQL databases, the keyspace is ignored.
+      def create_table(table_name, **options)
+        if ENV["ENABLE_PSDB"] && options[:keyspace].present?
+          table_name = "#{options[:keyspace]}.#{table_name}"
+          super(table_name, **options.except(:keyspace))
+        else
+          super(table_name, **options)
+        end
+      end
+    end
+  end
+end

data/lib/planetscale_rails/tasks/psdb.rake

@@ -7,8 +7,35 @@ require "colorize"
 
 databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
 
+def find_git_directory
+  return ENV["GIT_DIR"] if ENV["GIT_DIR"] && !ENV["GIT_DIR"].empty?
+
+  # it's not set as an env, so let's try to find it
+  current_path = Pathname.new(Dir.pwd)
+
+  until current_path.root?
+    git_dir = current_path.join(".git")
+    return current_path.to_s if git_dir.exist? # this can be a directory or a file (worktree)
+
+    current_path = current_path.parent
+  end
+
+  nil
+end
+
+def load_pscale_config
+  if File.exist?(".pscale.yml")
+    return YAML.load_file(".pscale.yml")
+  end
+
+  # otherwise, look for a git root directory and load it from there
+  git_dir = find_git_directory
+  pscale_yaml_path = File.join(git_dir, ".pscale.yml")
+  YAML.load_file(pscale_yaml_path)
+end
+
 def puts_deploy_request_instructions
-  ps_config = YAML.load_file(".pscale.yml")
+  ps_config = load_pscale_config
   database = ps_config["database"]
   branch = ps_config["branch"]
   org = ps_config["org"]
@@ -25,7 +52,7 @@ def delete_password
   password_id = ENV["PSCALE_PASSWORD_ID"]
   return unless password_id
 
-  ps_config = YAML.load_file(".pscale.yml")
+  ps_config = load_pscale_config
   database = ps_config["database"]
   branch = ps_config["branch"]
 
@@ -56,7 +83,7 @@ namespace :psdb do
   end
 
   def create_connection_string
-    ps_config = YAML.load_file(".pscale.yml")
+    ps_config = load_pscale_config
     database = ps_config["database"]
     branch = ps_config["branch"]
 
@@ -85,7 +112,7 @@ namespace :psdb do
         adapter = "trilogy"
       end
 
-      url = "#{adapter}://#{username}:#{password}@#{host}:3306/#{database}?ssl_mode=VERIFY_IDENTITY"
+      url = "#{adapter}://#{username}:#{password}@#{host}:3306/@primary?ssl_mode=VERIFY_IDENTITY"
 
       # Check common CA paths for certs.
       ssl_ca_path = %w[/etc/ssl/certs/ca-certificates.crt /etc/pki/tls/certs/ca-bundle.crt /etc/ssl/ca-bundle.pem /etc/ssl/cert.pem].find { |f| File.exist?(f) }
@@ -108,6 +135,7 @@ namespace :psdb do
   task "create_creds" => %i[environment check_ci] do
     ENV["PSCALE_DATABASE_URL"] = create_connection_string
     ENV["DISABLE_SCHEMA_DUMP"] = "true"
+    ENV["ENABLE_PSDB"] = "true"
   end
 
   desc "Connects to the current PlanetScale branch and runs rails db:migrate"

data/lib/planetscale_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlanetscaleRails
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/planetscale_rails.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
+require "active_support"
+
 require_relative "planetscale_rails/version"
+require_relative "planetscale_rails/migration"
 
 module PlanetscaleRails
   require "planetscale_rails/railtie" if defined?(Rails)
 end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Migration::Current.prepend(PlanetscaleRails::Migration::Current)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planetscale_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -71,6 +71,7 @@ files:
 - bin/setup
 - lib/Rakefile
 - lib/planetscale_rails.rb
+- lib/planetscale_rails/migration.rb
 - lib/planetscale_rails/railtie.rb
 - lib/planetscale_rails/tasks/psdb.rake
 - lib/planetscale_rails/version.rb