veksel 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ea3fcb9a16045af635f30b41e951e002e82d3f9de54c2b015f183069bf96a27
-  data.tar.gz: db4756858dac59fe8e26b67c9d0498aa5bf34eae6c88b4cadc61b1cd326b4c4d
+  metadata.gz: 692cda4c884d09fd6388bc304b72a0c41270942654815bebf08a91025a164e89
+  data.tar.gz: 81dabd57bfdf2096d6ab75a5bc870a3e39ff122bc790758551830d11414fbcd4
 SHA512:
-  metadata.gz: 2b10cd547c563757d88b93e8293b1e3243d1d962708729c6faf1b90e16b8b75de89b52dff3e74d45b9a36ff470fbc6ddb20fdd922fae2c20aa23f9dfaac526e7
-  data.tar.gz: 23ddfb9527f9ebbee6f6e91bc01553261f0985170ac27aeef8d9717c6d307fd111c5d00b620d04a7043092a7d8f0ff7c2c2be67450003f69286b034a09b3467b
+  metadata.gz: 38a76367d2ab7f8603a646f8236c027acea8f5104a4c342169cbacf9d35a02878b9f477a924afe4f9421dc1a9fe0e1abc89bc3918404296e9f883517fceabeae
+  data.tar.gz: f919b8fcbdfa107a15e8d784731570656561a0c843b32d489324166431da4897e10e357b4dac2989910c7f49ea3c060888777c0eabcfd97708206b0be760fb1b

data/README.md

@@ -63,13 +63,14 @@ $ gem install veksel
 - Explicit/optional branching
 - Other database drivers
 
-## Publishing
+## Release process
 
-Veksel is published and distributed on [rubygems](https://rubygems.org).
+```shell
+# Bump version number in lib/veksel/version.rb
 
-To publish a new version:
+# Update lockfile
+bundle install
 
-```shell
 # Update changelog, review manually before committing
 conventional-changelog -p conventionalcommits -i CHANGELOG.md -s
 git commit -m 'chore(release): x.y.z'

data/bin/veksel

@@ -2,8 +2,6 @@
 require 'veksel/cli'
 
 case ARGV[0]
-when 'suffix'
-  Veksel::CLI.suffix
 when 'fork'
   Veksel::CLI.fork
 end

data/lib/tasks/veksel_tasks.rake

@@ -8,40 +8,13 @@ namespace :veksel do
 
   desc "List forked databases"
   task list: 'db:load_config' do
-    require 'veksel/commands/clean'
+    require 'veksel/commands/list'
 
     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"
+    begin
+      Veksel::Commands::List.new(db).perform
+    rescue Veksel::AdapterNotSupported => e
+      $stderr.puts e.message
     end
   end
 
@@ -50,6 +23,10 @@ namespace :veksel do
     require 'veksel/commands/clean'
 
     db = ActiveRecord::Base.configurations.find_db_config('development')
-    Veksel::Commands::Clean.new(db).perform
+    begin
+      Veksel::Commands::Clean.new(db).perform
+    rescue Veksel::AdapterNotSupported => e
+      $stderr.puts "#{e.message} - clean skipped"
+    end
   end
 end

data/lib/veksel/cli.rb

@@ -2,27 +2,44 @@ require 'veksel'
 
 module Veksel
   module CLI
-    def self.suffix
-      print Veksel.suffix
-    end
+    DbConfig = Struct.new('DbConfig', :configuration_hash)
+
+    class << self
+      def fork
+        return if Veksel.skip_fork?
+        t1 = Time.now.to_f
+
+        require 'veksel/commands/fork'
+        require 'psych'
+        require 'fileutils'
+
+        config = read_config('config/database.yml')[:development]
+        if config.key?(:primary)
+          config = config[:primary]
+          $stderr.puts "Warning: Only your primary database will be forked"
+        end
 
-    def self.fork
-      return if Veksel.skip_fork?
-      t1 = Time.now.to_f
+        target_database = config[:database] + Veksel.suffix
+        db = DbConfig.new(config)
+        if 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
+      rescue AdapterNotSupported => e
+        $stderr.puts "#{e.message} - fork skipped"
+      end
 
-      require 'veksel/commands/fork'
-      require 'psych'
-      require 'ostruct'
-      require 'fileutils'
+      def read_config(path)
+        raw_config = File.read(path)
 
-      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
+        if raw_config.include?('<%=')
+          require 'erb'
+          raw_config = ERB.new(raw_config).result
+        end
 
-      duration = ((Time.now.to_f - t1) * 1000).to_i
-      FileUtils.touch('tmp/restart.txt')
-      puts "Forked database in #{duration.to_i}ms"
+        Psych.safe_load(raw_config, aliases: true, symbolize_names: true)
+      end
     end
   end
 end

data/lib/veksel/commands/clean.rb

@@ -1,33 +1,22 @@
-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])
+        @adapter = Veksel.adapter_for(db.configuration_hash)
         @dry_run = dry_run
       end
 
       def perform
-        all_databases = @pg_cluster.list_databases(prefix: @prefix)
+        all_databases = @adapter.forked_databases
+        active_branches = Veksel.active_branches
+
         stale_databases = all_databases.filter do |database|
-          active_branches.none? { |branch| database.end_with?("_#{branch}") }
+          active_branches.none? { |branch| database.branch == branch }
         end
         stale_databases.each do |database|
-          @pg_cluster.drop_database(database, dry_run: @dry_run)
+          @adapter.drop_database(database.name, 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

@@ -1,22 +1,23 @@
-require_relative '../pg_cluster'
-
 module Veksel
   module Commands
     class Fork
-      attr_reader :pg_cluster, :source_db, :target_db
+      attr_reader :adapter, :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
+        @adapter = Veksel.adapter_for(db.configuration_hash)
+        @source_db = adapter.main_database
+        @target_db = adapter.db_name_for_suffix(Veksel.suffix)
         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)
+        return false unless adapter
+        return false if adapter.target_populated?(target_db)
+
+        adapter.kill_connection(source_db)
+        adapter.create_database(target_db, template: source_db)
 
-        pg_cluster.kill_connection(source_db)
-        pg_cluster.create_database(target_db, template: source_db)
+        true
       end
     end
   end

data/lib/veksel/commands/list.rb

@@ -0,0 +1,45 @@
+module Veksel
+  module Commands
+    class List
+      attr_reader :adapter
+
+      def initialize(db)
+        @adapter = Veksel.adapter_for(db.configuration_hash)
+      end
+
+      def perform
+        databases = adapter.forked_databases
+        active_branches = Veksel.active_branches
+
+        if databases.empty?
+          puts "No databases created by Veksel"
+          return
+        end
+
+        hash = {}
+        databases.each do |database|
+          branch = database.branch
+          hash[branch] = database.name
+        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
+    end
+  end
+end

data/lib/veksel/pg_cluster.rb

@@ -1,11 +1,28 @@
 module Veksel
   class PgCluster
+    Database = Struct.new(:name, :branch)
+
     attr_reader :configuration_hash
 
     def initialize(configuration_hash)
       @configuration_hash = configuration_hash
     end
 
+    def main_database
+      configuration_hash[:veksel_main_database] || configuration_hash[:database]
+    end
+
+    def forked_databases
+      list_databases(prefix: forked_database_prefix).map do |name|
+        Database.new(name, name.sub(forked_database_prefix, ''))
+      end
+    end
+
+    def db_name_for_suffix(suffix)
+      return main_database if suffix.empty?
+      "#{forked_database_prefix}#{suffix}"
+    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')
@@ -42,6 +59,10 @@ module Veksel
 
     private
 
+    def forked_database_prefix
+      "#{main_database}_"
+    end
+
     def pg_connection_args(dbname)
       "-d #{dbname} --no-password"
     end

data/lib/veksel/railtie.rb

@@ -11,14 +11,16 @@ module Veksel
       ActiveRecord::DatabaseConfigurations.register_db_config_handler do |env_name, name, url, config|
         next if url.present?
         next unless env_name == 'development' || env_name == 'test'
+        veksel_adapter = Veksel.adapter_for(config, exception: false)
+        next unless veksel_adapter
 
-        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
+        database_name = veksel_adapter.db_name_for_suffix(Veksel.suffix)
+        next unless veksel_adapter.target_populated?(database_name)
+
+        ActiveRecord::DatabaseConfigurations::HashConfig.new(env_name, name, config.merge({
+          database: database_name,
+          veksel_main_database: config[:database],
+        }))
       end
     end
   end

data/lib/veksel/suffix.rb

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

data/lib/veksel/version.rb

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

data/lib/veksel.rb

@@ -1,19 +1,30 @@
-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 AdapterNotSupported < StandardError; end
+
   class << self
+    def adapter_for(config, exception: true)
+      case config[:adapter]
+      when 'postgresql'
+        require_relative './veksel/pg_cluster'
+        Veksel::PgCluster.new(config)
+      else
+        return unless exception
+        raise AdapterNotSupported, "Veksel does not yet support #{config[:adapter]}"
+      end
+    end
+
     def current_branch
       `git rev-parse --abbrev-ref HEAD`.strip
     end
 
+    def active_branches
+      `git for-each-ref 'refs/heads/' --format '%(refname)'`.split("\n").map { |ref| ref.sub('refs/heads/', '') }
+    end
+
     def skip_fork?
       suffix.to_s.strip.empty?
     end
@@ -21,9 +32,5 @@ module Veksel
     def suffix
       Suffix.new(current_branch).to_s
     end
-
-    def prefix(dbname)
-      dbname.sub(%r[#{Veksel.suffix}$], '_')
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veksel
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Theodor Tonum
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,20 +44,6 @@ dependencies:
     - - ">="
       - !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'
 description: Seperate databases for every branch in your development environment
 email:
 - theodor@tonum.no
@@ -75,6 +61,7 @@ files:
 - lib/veksel/cli.rb
 - lib/veksel/commands/clean.rb
 - lib/veksel/commands/fork.rb
+- lib/veksel/commands/list.rb
 - lib/veksel/pg_cluster.rb
 - lib/veksel/railtie.rb
 - lib/veksel/suffix.rb
@@ -102,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Veksel keeps seperate databases for every branch in your development environment.