planetscale_rails 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c96f1384c6bcee4a33e81124384b80ce8cff99823b1d5fc77ad926967087a4
-  data.tar.gz: '0880e54628a3c0b22a98f1883dce8fd6ac4aee57315fffab014d07c9da66e014'
+  metadata.gz: a94c9bffa66e63c43ca885083022c938fd8d36f2b61f221b5a6b55456db04ec2
+  data.tar.gz: 48d42fccafd3a78f526e334f3db0579efe2f08dfbb7fb69f6d01dd5a9dfc2197
 SHA512:
-  metadata.gz: c4fabd32053c4456bdd002729f21fd9548905a7fc8472a97dd23fb0f1aed9df5798381cae839fd4495b0acacdc97170c47b92312cc38c78a0a31df3911097765
-  data.tar.gz: 2f50ab3be8305f60c81c11d625f470775678bf311d103c1301d982fb1aa5f6c39ac8b176f21bd8eb4ea511098f22e8a77a3b09cdb459130ea60bdddcee37ae57
+  metadata.gz: b5fadeddff7396b8d6347c07549a24979e5766fc9207b140ed44ee055b1e1d73ed04966892052f440efe5f82d133c7fb7107a0bf7987739e2421d7f9d25fcead
+  data.tar.gz: cfe46c69ed1b3366c1ac3a98f8298c9c73e5e8213a6ff1dcc29dc16c4f675965ccd363b4e903342a2a6ee487c4fef18dc74f7746d39704ee75565977c8170f2f

data/README.md

@@ -35,6 +35,18 @@ bundle install
 
 Make sure you have the [`pscale` CLI installed](https://github.com/planetscale/cli#installation).
 
+### Disable schema dump
+
+Add the following to your `config/application.rb`.
+
+```ruby
+if ENV["DISABLE_SCHEMA_DUMP"]
+  config.active_record.dump_schema_after_migration = false
+end
+```
+
+This will allow the gem to disable schema dumping after running `psdb:migrate`.
+
 ## Usage
 
 1. Using pscale, create a new branch. This command will create a local `.pscale.yml` file. You should add it to your `.gitignore`.
@@ -78,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/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,8 +112,7 @@ namespace :psdb do
         adapter = "trilogy"
       end
 
-      # Setting schema_dump to nil is intentional. It prevents Rails from creating a dump after running migrations.
-      url = "#{adapter}://#{username}:#{password}@#{host}:3306/#{database}?ssl_mode=VERIFY_IDENTITY&schema_dump="
+      url = "#{adapter}://#{username}:#{password}@#{host}:3306/#{database}?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 +134,7 @@ namespace :psdb do
   desc "Create credentials for PlanetScale and sets them to ENV['PSCALE_DATABASE_URL']"
   task "create_creds" => %i[environment check_ci] do
     ENV["PSCALE_DATABASE_URL"] = create_connection_string
+    ENV["DISABLE_SCHEMA_DUMP"] = "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.1"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planetscale_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize