planetscale_rails 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 619e3ba38ea708a2a1a9e3f2fd568ff0da6c03bd197f387ae73a392fc70027cc
-  data.tar.gz: 74f418e63ea9c62f460f97621ddc0bd3de2bf52cf75bc99eab961d8078a3869b
+  metadata.gz: f38096cc4396fecb1efbfba9ea4bfe7f72b39c915990fb7036f8ab4ef1a1aaa2
+  data.tar.gz: c609fbd59e9caf5682fddd1367533c3a99a80fe1bbd7c93591da6047f8ff22cf
 SHA512:
-  metadata.gz: bfe2af22a409d717347a2a929a19b59e5b2a03d40cf1ce3dd0ce92c7504edc81ed6781bc5992449662aacd95ec48802cbc0c3a55a6cad9d9dfb1713d3268a72d
-  data.tar.gz: 98c020da66de785b9a7984d521aedec6bd57798a7bf106695e97bf698067ef7afa0cccab3ada6aed4b477601d3c9b5361abe8b95285371f1f0cd1b29da228014
+  metadata.gz: b4e11cfda4e78884bd30fe672b06517320f74a36244d96c61688d5d339478c99cff30050e31f049578fa27e5358692697b9019d0032108223d4c6dbb2e9a7c97
+  data.tar.gz: d236ee3a8a70d8e37be836e344c8e1a565c99149d7f301760810c8efc03ebea30e1cdb1e78458fc788b9fd9f41b1fe98fdaa4f9fc9e29cad1fb64636bf6d579f

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    planetscale_rails (0.1.0)
+    planetscale_rails (0.1.1)
+      colorize (~> 0.8.1)
       rails (~> 7.0)
 
 GEM
@@ -74,6 +75,7 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     builder (3.2.4)
+    colorize (0.8.1)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     date (3.3.3)
@@ -95,7 +97,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.17.0)
+    minitest (5.18.0)
     net-imap (0.3.4)
       date
       net-protocol

data/README.md

@@ -1,5 +1,7 @@
 # PlanetScale Rails
 
+[![Gem Version](https://badge.fury.io/rb/planetscale_rails.svg)](https://badge.fury.io/rb/planetscale_rails)
+
 Rake tasks for easily running Rails migrations against PlanetScale database branches.
 
 For information on how to connect your Rails app to PlanetScale, please [see our guide here](https://planetscale.com/docs/tutorials/connect-rails-app).
@@ -10,10 +12,10 @@ The rake tasks allow you to use local MySQL for development. When you're ready t
 against it. See [usage](#usage) for details.
 
 ```
-rake psdb:migrate                                      # Migrate the database for current environment
-rake psdb:rollback                                     # Rollback primary database for current environment
-rake psdb:schema:load                                  # Load the current schema into the database
-rake psdb:setup_pscale                                 # Setup a proxy to connect to PlanetScale
+rake psdb:migrate                    # Migrate the database for current environment
+rake psdb:rollback                   # Rollback primary database for current environment
+rake psdb:schema:load                # Load the current schema into the database
+rake psdb:setup_pscale               # Setup a proxy to connect to PlanetScale
 ```
 
 ## Installation
@@ -26,19 +28,23 @@ group :development do
 end
 ```
 
-And then execute:
+And then execute in your terminal:
 
-    $ bundle install
+```
+bundle install
+```
 
 ## Usage
 
 First, make sure you have the [`pscale` CLI installed](https://github.com/planetscale/cli#installation). You'll use `pscale` to create a new branch.
 
-1. `pscale branch switch my-new-branch-name --database my-db-name --create`
-
-Run this locally, it will create a new branch off of `main`. The `switch` command will update a `.pscale.yml` file to track 
+1. Run this locally, it will create a new branch off of `main`. The `switch` command will update a `.pscale.yml` file to track 
 that this is the branch you want to migrate.
 
+```
+pscale branch switch my-new-branch-name --database my-db-name --create
+```
+
 **Tip:** In your database settings. Enable "Automatically copy migration data." Select "Rails/Phoenix" as the migration framework. This will auto copy your `schema_migrations` table between branches.
 
 2. Once your branch is ready, you can then use the `psdb` rake task to connect to your branch and run `db:migrate`.

data/lib/planetscale_rails/tasks/psdb.rake

@@ -3,6 +3,7 @@
 require "English"
 require "yaml"
 require "pty"
+require "colorize"
 
 databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
 
@@ -11,6 +12,16 @@ def shared_deps(name = nil)
   return %i[environment check_ci] if name.nil?
 end
 
+def puts_deploy_request_instructions
+  ps_config = YAML.load_file(".pscale.yml")
+  database = ps_config["database"]
+  branch = ps_config["branch"]
+  org = ps_config["org"]
+
+  puts "Create a deploy request for '#{branch}' by running:\n"
+  puts "     pscale deploy-request create #{database} #{branch} --org #{org}\n\n"
+end
+
 def kill_pscale_process
   Process.kill("TERM", ENV["PSCALE_PID"].to_i) if ENV["PSCALE_PID"]
 end
@@ -35,15 +46,14 @@ namespace :psdb do
     database = ps_config["database"]
     branch = ps_config["branch"]
 
-    raise "You must have `pscale` installed on your computer" unless command?("pscale")
+    raise "You must have `pscale` installed on your computer".colorize(:red) unless command?("pscale")
     if branch.blank? || database.blank?
-      raise "Your branch is not properly setup, please switch to a branch by using the CLI."
+      raise "Your branch is not properly setup, please switch to a branch by using the CLI.".colorize(:red)
     end
-    raise "Unable to run migrations against the main branch" if branch == "main"
 
     r, = PTY.open
 
-    puts "Spawning background connect process..."
+    puts "Connecting to PlanetScale..."
 
     # Spawns the process in the background
     pid = Process.spawn("pscale connect #{database} #{branch} --port 3305 #{ENV["SERVICE_TOKEN_CONFIG"]}", out: r)
@@ -59,10 +69,7 @@ namespace :psdb do
       time_elapsed = Time.current - start_time
     end
 
-    raise "Timed out waiting for PlanetScale connection to be established" if time_elapsed > 10.seconds
-
-    # Comment out for now, this messes up when running migrations.
-    # Kernel.system("bundle exec rails db:environment:set RAILS_ENV=development")
+    raise "Timed out waiting for PlanetScale connection to be established".colorize(:red) if time_elapsed > 10.seconds
   ensure
     r&.close
   end
@@ -89,7 +96,7 @@ namespace :psdb do
 
         r, = PTY.open
 
-        puts "Spawning background connect process..."
+        puts "Connecting to PlanetScale..."
 
         # Spawns the process in the background
         pid = Process.spawn("pscale connect #{database} #{branch} --port 3305 #{ENV["SERVICE_TOKEN_CONFIG"]}", out: r)
@@ -120,13 +127,13 @@ namespace :psdb do
     db_configs = ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
 
     unless db_configs.size == 1
-      raise "Found multiple database configurations, please specify which database you want to migrate using `psdb:migrate:<database_name>`"
+      raise "Found multiple database configurations, please specify which database you want to migrate using `psdb:migrate:<database_name>`".colorize(:red)
     end
 
     puts "Running migrations..."
     Kernel.system("bundle exec rails db:migrate")
-    puts "Finished running migrations"
-
+    puts "Finished running migrations\n".colorize(:green)
+    puts_deploy_request_instructions
   ensure
     kill_pscale_process
   end
@@ -139,7 +146,9 @@ namespace :psdb do
         # We run it using the Kernel.system here because this properly handles
         # when exceptions occur whereas Rake::Task.invoke does not.
         Kernel.system("bundle exec rake db:migrate:#{name}")
-        puts "Finished running migrations."
+
+        puts "Finished running migrations\n".colorize(:green)
+        puts_deploy_request_instructions
       ensure
         kill_pscale_process
       end
@@ -186,7 +195,7 @@ namespace :psdb do
         # We run it using the Kernel.system here because this properly handles
         # when exceptions occur whereas Rake::Task.invoke does not.
         Kernel.system("bundle exec rake db:rollback:#{name}")
-        puts "Finished rolling back migrations."
+        puts "Finished rolling back migrations.".colorize(:green)
       ensure
         kill_pscale_process
       end

data/lib/planetscale_rails/version.rb

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

data/planetscale_rails.gemspec

@@ -28,8 +28,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "colorize", "~> 0.8.1"
   spec.add_dependency "rails", "~> 7.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planetscale_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement