branchbot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa6c1ef194f2f10f54ac1a874d0ef1971e585f2ff9b2c8aefe958178fca3d54
-  data.tar.gz: fbfc9ffc56df62c39152ece3a5ca4ba28334bf857e9b42fdb4c19c65c08a6707
+  metadata.gz: df7287ee16f259b9e6a70200cc292c27fe9cdeb0993625e5aad7d9cc0faee1cf
+  data.tar.gz: 12c488ca1233cce3b9f9b8006df0f83acad249b9a7484bc80fa2f18fcdd48c45
 SHA512:
-  metadata.gz: 2e3b4baf23cd8108b3d096a91d946c9e0b8f175374b83103024514416ce0cb255e3e2b991ce82d6a2fb5112efe972c9891225e6294dcf7ee3f2a61f1308fc5e5
-  data.tar.gz: 263700bdbfa46eba2d124a21df567946bfed5209676ac1c45fa6d2612bb61782e44a76413e92ebce61446da03837e6352870f8716eea3058e8a10a41ee036ed1
+  metadata.gz: 8fa0b95f0774aa1aefc64c0a9bfbfe595a5391c42de155e70c4dbac71ca6ebf83d924fe0c2acf6c1520759d38e330ad2685d14a5fda7dc17cfd748ac8fbdb2d7
+  data.tar.gz: b819e74822ce02f1e0a79289501f53d2c00fed89aed1f03862d237f22a38e52b0d1065f2d3e3f7856d1b088538ff2e4a0289671483ac1a40d616017e8c5c98ea

data/README.md

@@ -16,6 +16,11 @@ This allows you to make some changes to the structure of your database on a feat
    
    Note: Be sure to keep the `post-checkout` name to match Git's expectations.
 
+# Options
+
+- `--app-root` - The app root relative to the project root (default: '.')
+- `--db-config-erb` - Interpret database.yml as ERB an template before parsing as YML (default: disabled)
+
 # Support
 
 Only PostgreSQL and MySQL databases are currently supported.
@@ -24,7 +29,7 @@ Only PostgreSQL and MySQL databases are currently supported.
 
 While this hook is geared towards Rails and depends on Ruby, it is very easy to use it in non-Ruby/Rails projects, so long as you have Ruby installed on your system.
 
-This script will look for a `database.yml` config file (default: `config/database.yml` in your project's root directory), and expects it to look like this:
+This script will look for a `config/database.yml` file in your app's root (configurable via `--app-root`), and expects it to look like this:
 
 ```yaml
 development:
@@ -34,6 +39,4 @@ development:
   database: <database name>
 ```
 
-The path to this file is configurable via the `--db-config-path` option.
-
 We currently support two adapters: `mysql2` and `postgresql`. We don't actually rely on these gems, but instead use them to determine which database's command line tools we should use (mysqldump/mysql or pg_dump/psql). Use `mysql2` if you are using a MySQL database, or `postgresql` if you are using a PostgreSQL database.

data/exe/branchbot

@@ -11,7 +11,8 @@ program :description, "Saves and restores the state of your local database as yo
 command :switch do |cmd|
   cmd.syntax = "branchbot switch [options]"
   cmd.option '--from FROM_REF', String, 'ref switching from'
-  cmd.option '--db-config-path path/to/database.yml', String, 'path to database.yml relative to project root (default: config/database.yml)'
+  cmd.option '--app-root relative/path/to/app', String, 'path to app root relative to project root (default: .)'
+  cmd.option '--db-config-erb', 'Interpret the database config as ERB before parsing YML'
 
   cmd.action do |args, options|
     unless options.from
@@ -19,10 +20,12 @@ command :switch do |cmd|
       next
     end
 
-    options.default db_config_path: 'config/database.yml'
+    options.default app_root: '.'
+    options.default db_config_erb: false
 
     Branchbot::BranchSwitcher.new(
-      database_yml_path: options.db_config_path
+      app_root: options.app_root,
+      erb_in_database_yml: options.db_config_erb
     ).switch_from(options.from)
   end
 end

data/lib/branchbot/branch_switcher.rb

@@ -1,7 +1,10 @@
 module Branchbot
   class BranchSwitcher
-    def initialize(database_yml_path: 'config/database.yml')
-      @database_yml_path = database_yml_path
+    def initialize(app_root: '.', erb_in_database_yml: true)
+      @app_root = app_root
+      @project_root = %x[git rev-parse --show-toplevel].strip
+      @dump_folder = "#{@project_root}/.db_branch_dumps"
+      @erb_in_database_yml = erb_in_database_yml
     end
 
     def switch_from(prev_ref)
@@ -13,11 +16,8 @@ module Branchbot
       # destination branch, so we can remove that immediately.
       @source_branches = branches_from_refhead(prev_ref).reject{ |b| b == @destination_branch }
 
-      @project_root = %x[git rev-parse --show-toplevel].strip
-      @dump_folder = "#{@project_root}/.db_branch_dumps"
-
       # Load Rails DB config and grab database name
-      @rails_db_config = YAML.load(ERB.new(File.read(File.join @project_root, @database_yml_path)).result)
+      @rails_db_config = YAML.load(db_config_yml)
       dev_database_name = @rails_db_config['development']['database']
 
       begin
@@ -57,24 +57,42 @@ module Branchbot
         `git show-ref --heads | grep #{ref} | awk '{print $2}'`.split("\n").map{ |b| b.sub(/^refs\/heads\//, '') }
       end
 
+      def app_root
+        File.join @project_root, @app_root
+      end
+
       def prepare_test_database
-        if File.exists?("#{@project_root}/Rakefile")
+        if File.exists?("#{app_root}/Rakefile")
           print "Preparing test database..."
 
           rake_cmd = "rake db:test:prepare"
 
-          if File.exists?("#{@project_root}/bin/rake")
+          if File.exists?("#{app_root}/bin/rake")
             rake_cmd = "./bin/#{rake_cmd}"
-          elsif File.exists?("#{@project_root}/Gemfile")
+          elsif File.exists?("#{app_root}/Gemfile")
             rake_cmd = "bundle exec #{rake_cmd}"
           end
 
-          system rake_cmd
+          system "cd #{app_root} && #{rake_cmd}"
 
           print "done!\n"
         else
           print "No Rakefile detected, skipping test database restoration\n"
         end
       end
+
+      def db_config_path
+        File.join app_root, 'config', 'database.yml'
+      end
+
+      def db_config_yml
+        database_yml_content = File.read(db_config_path)
+
+        if @erb_in_database_yml
+          ERB.new(database_yml_content).result
+        else
+          database_yml_content
+        end
+      end
     end
-end
+end

data/lib/branchbot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Branchbot
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: branchbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jim Ryan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander