veksel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91758ab594f11138bbfb291449ca7a89e5de19e6cee85e024a2bb03b7c3056d1
+  data.tar.gz: 28935ca101031e85fa0a86e5163408b5fc5cf2c25a8cea9b3c351901a04e96cd
+SHA512:
+  metadata.gz: 22592284f0ad8be05605deaed84019da1a8b3c136cd8a1492680a6a83424ad3307193c74b44c5c581fadf9f63efe66e848c0b1f2b7933748c2215f937bf334ff
+  data.tar.gz: 1ed0d8d73e466a24e2cac00a4d334cfb834a3df7c03a621c34015dc05172c0abb8088c70984614d9dd0e4cf7e77fa2f37c5e72756c4ed0336ae8e521c61b2dc5

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright Theodor Tonum
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# 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).
+
+Postgresql is currently the only supported database driver.
+
+## Usage
+
+Change the following line in `config/database.yml`
+
+```yaml
+development:
+  database: your_app_development<%= `bundle exec veksel suffix` %>
+```
+
+Checkout a new branch and run `bin/rails veksel:fork`. A new database with a suffix matching your branch name will be created.
+
+### Veksel tasks
+
+```
+veksel:clean                       Delete forked databases
+veksel:fork                        Fork the database from the main branch
+veksel:list                        List forked databases
+```
+
+## 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
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "veksel", group: :development
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install veksel
+```
+
+## Roadmap
+
+- Promote a forked database to main
+- Explicit/optional branching
+- Other database drivers
+
+## License
+
+Veksel is licensed under MIT.

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/bin/veksel

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

data/lib/tasks/veksel_tasks.rake

@@ -0,0 +1,69 @@
+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'
+
+    db = ActiveRecord::Base.configurations.find_db_config('development')
+    Veksel::Commands::Fork.new(db).perform
+  end
+
+  desc "List forked databases"
+  task list: 'db:load_config' do
+    require 'veksel/commands/clean'
+
+    db = ActiveRecord::Base.configurations.find_db_config('development')
+    command = Veksel::Commands::Clean.new(db)
+    databases = command.all_databases
+    active_branches = command.active_branches
+
+    if databases.empty?
+      puts "No databases created by Veksel"
+      next
+    end
+
+    hash = {}
+    databases.each do |database|
+      branch = database.sub(command.prefix, '')
+      hash[branch] = database
+    end
+
+    longest_branch_name = hash.keys.max_by(&:length).length
+    longest_database_name = hash.values.max_by(&:length).length
+    puts "Databases created by Veksel:"
+    puts ""
+    puts "#{'Branch'.ljust(longest_branch_name)}   #{'Database'.ljust(longest_database_name)}   Active"
+    inactive_count = 0
+    hash.each do |branch, database|
+      # Print a formatted string padded to fit the longest branch name
+      active = active_branches.include?(branch) ? 'Yes' : 'No'
+      inactive_count += 1 if active == 'No'
+      puts "#{branch.ljust(longest_branch_name)}   #{database.ljust(longest_database_name)}   #{active}"
+    end
+
+    if inactive_count > 0
+      puts ""
+      puts "Clean inactive databases with bin/rails veksel:clean"
+    end
+  end
+
+  desc "Delete forked databases"
+  task clean: 'db:load_config' do
+    require 'veksel/commands/clean'
+
+    db = ActiveRecord::Base.configurations.find_db_config('development')
+    Veksel::Commands::Clean.new(db).perform
+  end
+end

data/lib/veksel/commands/clean.rb

@@ -0,0 +1,33 @@
+require_relative '../pg_cluster'
+
+module Veksel
+  module Commands
+    class Clean
+      attr_reader :prefix
+
+      def initialize(db, dry_run: false)
+        @pg_cluster = PgCluster.new(db.configuration_hash)
+        @prefix = Veksel.prefix(db.configuration_hash[:database])
+        @dry_run = dry_run
+      end
+
+      def perform
+        all_databases = @pg_cluster.list_databases(prefix: @prefix)
+        stale_databases = all_databases.filter do |database|
+          active_branches.none? { |branch| database.end_with?("_#{branch}") }
+        end
+        stale_databases.each do |database|
+          @pg_cluster.drop_database(database, dry_run: @dry_run)
+        end
+      end
+
+      def active_branches
+        `git for-each-ref 'refs/heads/' --format '%(refname)'`.split("\n").map { |ref| ref.sub('refs/heads/', '') }
+      end
+
+      def all_databases
+        @pg_cluster.list_databases(prefix: @prefix)
+      end
+    end
+  end
+end

data/lib/veksel/commands/fork.rb

@@ -0,0 +1,24 @@
+require_relative '../pg_cluster'
+
+module Veksel
+  module Commands
+    class Fork
+      attr_reader :pg_cluster, :source_db, :target_db
+
+      def initialize(db)
+        @pg_cluster = PgCluster.new(db.configuration_hash)
+        @source_db = db.database.sub(%r[#{Veksel.suffix}$], '')
+        @target_db = db.database
+        raise "Source and target databases cannot be the same" if source_db == target_db
+      end
+
+      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
+      end
+    end
+  end
+end

data/lib/veksel/pg_cluster.rb

@@ -0,0 +1,60 @@
+module Veksel
+  class PgCluster
+    attr_reader :configuration_hash
+
+    def initialize(configuration_hash)
+      @configuration_hash = configuration_hash
+    end
+
+    def target_populated?(dbname)
+      IO.pipe do |r, w|
+        spawn(pg_env, %[psql -t #{pg_connection_args(dbname)} -c "SELECT 'ok' FROM ar_internal_metadata LIMIT 1;"], out: w, err: '/dev/null')
+        pid_grep = spawn(pg_env, %[grep -qw ok], in: r, err: '/dev/null')
+        w.close
+        Process::Status.wait(pid_grep).success?
+      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
+    end
+
+    def list_databases(prefix:)
+      IO.pipe(autoclose: true) do |r, w|
+        sql = %[SELECT datname FROM pg_database WHERE datname LIKE '#{prefix}%'];
+        psql = spawn(pg_env, %[psql -t #{pg_connection_args('postgres')} -c "#{sql}"], out: w, err: '/dev/null')
+        w.close
+        Process::Status.wait(psql)
+        r.read.split("\n").map(&:strip)
+      end
+    end
+
+    def drop_database(dbname, dry_run: false)
+      if dry_run
+        puts "[Veksel] Would drop database #{dbname}"
+      end
+      spawn(pg_env, %[dropdb --no-password #{dbname}])
+    end
+
+    private
+
+    def pg_connection_args(dbname)
+      "-d #{dbname} --no-password"
+    end
+
+    def pg_env
+      {
+        'PGHOST' => configuration_hash[:host],
+        'PGPORT' => configuration_hash[:port]&.to_s,
+        'PGUSER' => configuration_hash[:username],
+        'PGPASSWORD' => configuration_hash[:password],
+      }.compact
+    end
+  end
+end

data/lib/veksel/railtie.rb

@@ -0,0 +1,7 @@
+module Veksel
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load "tasks/veksel_tasks.rake"
+    end
+  end
+end

data/lib/veksel/suffix.rb

@@ -0,0 +1,18 @@
+module Veksel
+  PROTECTED_BRANCHES = %w[master main HEAD].freeze
+
+  class Suffix
+    def initialize(branch_name)
+      @branch_name = branch_name
+    end
+
+    def to_s
+      case @branch_name
+      when *PROTECTED_BRANCHES
+        ""
+      else
+        "_#{@branch_name}"
+      end
+    end
+  end
+end

data/lib/veksel/version.rb

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

data/lib/veksel.rb

@@ -0,0 +1,29 @@
+if defined?(Rails::VERSION)
+  if Rails::VERSION::MAJOR < 6
+    raise "Veksel requires Rails 6 or later"
+  end
+end
+
+require "veksel/version"
+require "veksel/railtie" if defined?(Rails::Railtie)
+require "veksel/suffix"
+
+module Veksel
+  class << self
+    def current_branch
+      `git rev-parse --abbrev-ref HEAD`.strip
+    end
+
+    def skip_fork?
+      suffix.blank?
+    end
+
+    def suffix
+      Suffix.new(current_branch).to_s
+    end
+
+    def prefix(dbname)
+      dbname.sub(%r[#{Veksel.suffix}$], '_')
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: veksel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Theodor Tonum
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+executables:
+- veksel
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/veksel
+- lib/tasks/veksel_tasks.rake
+- lib/veksel.rb
+- lib/veksel/commands/clean.rb
+- lib/veksel/commands/fork.rb
+- lib/veksel/pg_cluster.rb
+- lib/veksel/railtie.rb
+- lib/veksel/suffix.rb
+- lib/veksel/version.rb
+homepage: https://github.com/theodorton/veksel
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/theodorton/veksel
+  source_code_uri: https://github.com/theodorton/veksel
+  changelog_uri: https://github.com/theodorton/veksel/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: 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
+  schema.rb headache when switching branches that has different sets of migrations.
+  The inspiration for the gem came from neons branch support.
+test_files: []