veksel 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91758ab594f11138bbfb291449ca7a89e5de19e6cee85e024a2bb03b7c3056d1
-  data.tar.gz: 28935ca101031e85fa0a86e5163408b5fc5cf2c25a8cea9b3c351901a04e96cd
+  metadata.gz: 5ea3fcb9a16045af635f30b41e951e002e82d3f9de54c2b015f183069bf96a27
+  data.tar.gz: db4756858dac59fe8e26b67c9d0498aa5bf34eae6c88b4cadc61b1cd326b4c4d
 SHA512:
-  metadata.gz: 22592284f0ad8be05605deaed84019da1a8b3c136cd8a1492680a6a83424ad3307193c74b44c5c581fadf9f63efe66e848c0b1f2b7933748c2215f937bf334ff
-  data.tar.gz: 1ed0d8d73e466a24e2cac00a4d334cfb834a3df7c03a621c34015dc05172c0abb8088c70984614d9dd0e4cf7e77fa2f37c5e72756c4ed0336ae8e521c61b2dc5
+  metadata.gz: 2b10cd547c563757d88b93e8293b1e3243d1d962708729c6faf1b90e16b8b75de89b52dff3e74d45b9a36ff470fbc6ddb20fdd922fae2c20aa23f9dfaac526e7
+  data.tar.gz: 23ddfb9527f9ebbee6f6e91bc01553261f0985170ac27aeef8d9717c6d307fd111c5d00b620d04a7043092a7d8f0ff7c2c2be67450003f69286b034a09b3467b

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/veksel.svg)](https://rubygems.org/gems/veksel)
+[![Build status](https://github.com/theodorton/veksel/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/theodorton/veksel/actions?query=event%3Apush+branch%3Amain)
+
 # Veksel: Database branching for Rails
 
 Veksel keeps seperate databases for every branch in your development environment. This makes it easy to experiment with schema changes and data with less risk and avoid conflicting changes to `schema.rb` when branches have different sets of migrations. The inspiration for the gem came from [branch support in Neon](https://neon.tech/docs/manage/branches).
@@ -6,30 +9,32 @@ Postgresql is currently the only supported database driver.
 
 ## Usage
 
-Change the following line in `config/database.yml`
+Out of the box, Veksel requires explicit invocation to work. Refer to [Git hook](#git-hook) below if you're interested in a more automated approach.
 
-```yaml
-development:
-  database: your_app_development<%= `bundle exec veksel suffix` %>
-```
+Checkout a new branch and run `bundle exec veksel fork`. A new database with a suffix matching your branch name will be created and `tmp/restart.txt` will be touched so your application servers restart. Both database structure and contents will be copied from your primary development database and Veksel will tell Rails on boot that the forked database should be used.
 
-Checkout a new branch and run `bin/rails veksel:fork`. A new database with a suffix matching your branch name will be created.
+When moving back to your `main` branch, run `touch tmp/restart.txt` to make Rails connect to default development database.
 
 ### Veksel tasks
 
+The CLI supports the following commands
+
 ```
-veksel:clean                       Delete forked databases
-veksel:fork                        Fork the database from the main branch
-veksel:list                        List forked databases
+veksel fork                        Create a forked database
+veksel clean                       Delete forked databases
+veksel fork                        Fork the database from the main branch
+veksel list                        List forked databases
 ```
 
+You can also run the commands as rake tasks (e.g. `bin/rails veksel:list`), albeit with a penalty hit.
+
 ## Git hook
 
 Add the following to `.git/hooks/post-checkout` to automatically fork your database when checking out a branch:
 
 ```
 #!/bin/sh
-bin/rails veksel:fork
+bundle exec veksel fork
 ```
 
 ## Installation
@@ -58,6 +63,31 @@ $ gem install veksel
 - Explicit/optional branching
 - Other database drivers
 
+## Publishing
+
+Veksel is published and distributed on [rubygems](https://rubygems.org).
+
+To publish a new version:
+
+```shell
+# Update changelog, review manually before committing
+conventional-changelog -p conventionalcommits -i CHANGELOG.md -s
+git commit -m 'chore(release): x.y.z'
+git push origin
+git tag vx.y.z
+git push origin vx.y.z
+
+# Build and push gem
+gem build
+gem push veksel-x.y.z.gem
+
+# Upload the veksel-x-y-z.gem file to the Github release page
+```
+
+## Sponsors
+
+Veksel is sponsored by [Skalar](https://github.com/Skalar)
+
 ## License
 
 Veksel is licensed under MIT.

data/bin/veksel

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
-require 'veksel'
+require 'veksel/cli'
 
 case ARGV[0]
 when 'suffix'
-  print Veksel.suffix
+  Veksel::CLI.suffix
+when 'fork'
+  Veksel::CLI.fork
 end

data/lib/tasks/veksel_tasks.rake

@@ -1,23 +1,9 @@
 namespace :veksel do
-  task :precreate do
-    ActiveSupport::Notifications.subscribe "veksel.fork" do |*args|
-      event = ActiveSupport::Notifications::Event.new(*args)
-      puts "Forked database in #{event.duration.to_i}ms"
-      File.open("log/veksel.log", "a") do |f|
-        f.puts("Forked database in #{event.duration.to_i}ms")
-        f.puts("  Source: #{event.payload[:source]}")
-        f.puts("  Target: #{event.payload[:target]}")
-      end
-    end
-  end
-
   desc "Fork the database from the main branch"
-  task fork: ['db:create', 'veksel:precreate'] do
-    next if Veksel.skip_fork?
-    require 'veksel/commands/fork'
+  task :fork do
+    require 'veksel/cli'
 
-    db = ActiveRecord::Base.configurations.find_db_config('development')
-    Veksel::Commands::Fork.new(db).perform
+    Veksel::CLI.fork
   end
 
   desc "List forked databases"

data/lib/veksel/cli.rb

@@ -0,0 +1,28 @@
+require 'veksel'
+
+module Veksel
+  module CLI
+    def self.suffix
+      print Veksel.suffix
+    end
+
+    def self.fork
+      return if Veksel.skip_fork?
+      t1 = Time.now.to_f
+
+      require 'veksel/commands/fork'
+      require 'psych'
+      require 'ostruct'
+      require 'fileutils'
+
+      config = Psych.safe_load(File.read('config/database.yml'), aliases: true)['development'].transform_keys(&:to_sym)
+      target_database = config[:database] + Veksel.suffix
+      db = OpenStruct.new(configuration_hash: config, database: target_database)
+      Veksel::Commands::Fork.new(db).perform
+
+      duration = ((Time.now.to_f - t1) * 1000).to_i
+      FileUtils.touch('tmp/restart.txt')
+      puts "Forked database in #{duration.to_i}ms"
+    end
+  end
+end

data/lib/veksel/commands/fork.rb

@@ -15,9 +15,8 @@ module Veksel
       def perform
         return if pg_cluster.target_populated?(target_db)
 
-        ActiveSupport::Notifications.instrument "veksel.fork", source: source_db, target: target_db do
-          pg_cluster.transfer(from: source_db, to: target_db)
-        end
+        pg_cluster.kill_connection(source_db)
+        pg_cluster.create_database(target_db, template: source_db)
       end
     end
   end

data/lib/veksel/pg_cluster.rb

@@ -15,14 +15,12 @@ module Veksel
       end
     end
 
-    def transfer(from:, to:)
-      r, w = IO.pipe(autoclose: true)
-      spawn(pg_env, "pg_dump #{pg_connection_args(from)} --format=c", out: w)
-      pid_psql = spawn(pg_env, "pg_restore --single-transaction --exit-on-error #{pg_connection_args(to)}", in: r)
-      unless Process::Status.wait(pid_psql).success?
-        # TODO: Write error log to a tempfile inside the tmp directory of the current directory
-        raise "pg_restore failed with status #{status.exitstatus}"
-      end
+    def kill_connection(dbname)
+      system(pg_env, %[psql #{pg_connection_args('postgres')} -c "select pg_terminate_backend(pid) from pg_stat_activity where datname = '#{dbname}' and pid <> pg_backend_pid();"], exception: true, out: '/dev/null')
+    end
+
+    def create_database(dbname, template:)
+      system(pg_env, %[createdb --no-password --template=#{template} #{dbname}], exception: true)
     end
 
     def list_databases(prefix:)

data/lib/veksel/railtie.rb

@@ -3,5 +3,23 @@ module Veksel
     rake_tasks do
       load "tasks/veksel_tasks.rake"
     end
+
+    initializer "my_railtie.configure_rails_initialization", before: "active_record.initialize_database" do |app|
+      require 'veksel/pg_cluster'
+      require 'active_record/database_configurations'
+
+      ActiveRecord::DatabaseConfigurations.register_db_config_handler do |env_name, name, url, config|
+        next if url.present?
+        next unless env_name == 'development' || env_name == 'test'
+
+        if PgCluster.new(config).target_populated?("#{config[:database]}#{Veksel.suffix}")
+          ActiveRecord::DatabaseConfigurations::HashConfig.new(env_name, name, config.merge({
+            database: "#{config[:database]}#{Veksel.suffix}"
+          }))
+        else
+          ActiveRecord::DatabaseConfigurations::HashConfig.new(env_name, name, config)
+        end
+      end
+    end
   end
 end

data/lib/veksel/version.rb

@@ -1,3 +1,3 @@
 module Veksel
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/veksel.rb

@@ -15,7 +15,7 @@ module Veksel
     end
 
     def skip_fork?
-      suffix.blank?
+      suffix.to_s.strip.empty?
     end
 
     def suffix

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veksel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Theodor Tonum
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 7.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -58,20 +58,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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'
 description: Seperate databases for every branch in your development environment
 email:
 - theodor@tonum.no
@@ -86,6 +72,7 @@ files:
 - bin/veksel
 - lib/tasks/veksel_tasks.rake
 - lib/veksel.rb
+- lib/veksel/cli.rb
 - lib/veksel/commands/clean.rb
 - lib/veksel/commands/fork.rb
 - lib/veksel/pg_cluster.rb