activerecord-postgresql-branched 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaa20a8d3be0ae8ce7427b9b8e826fdcb561274ac39ff7c1b6c4234f06db6a1b
-  data.tar.gz: f1b437b5cb279a11234e18943d40b33e94897fa2b69cf166453f0a346ceb979e
+  metadata.gz: 1742fc285cfd6d57e93baa73da6dd675fa3b75df1f02a3320fae25bcfe08f28d
+  data.tar.gz: 2ee36f561b9a1e9b4b555f48e39499189bd0da2bbf4344bb2b52616869d52008
 SHA512:
-  metadata.gz: d1b59c69941701aa595d8def4334bdbe056ebf5b68e91898b3947ea0b2d95cda4fa20e1b1ab5d541c8eb102bcc9fcf182e62a2cdea9e02ffe392eb226d771809
-  data.tar.gz: 46d5fe4cab69a81ffa6d53a375267848a7c87fa03f6805ec58104f56320310b736ae3cd8e212bf56861105b078e04f4aaa9a6e8035959d89898f0462168eb139
+  metadata.gz: 623f743e34d6db55c2b9b3b447dcf1b2b7066d9aad8d05f656580dcf5546a6e20f142ee35d2a7f7f9a7260eea9b2dcb76e78d35006eb1ecf54d8b604d6af0f98
+  data.tar.gz: c48eefaa0809be95fdda529956160f85ba240afb0ac97b94c983d80648d4ba7bce5eab35050d100c21ffee5538f93b219bcee8db2059d7df8c442846f78ef091

data/CHANGELOG.md

@@ -1,14 +1,23 @@
 # Changelog
 
+## 0.4.0
+
+- Restore primary branch — the primary branch (default: `main`) writes to `public` so feature branches see shared state via `search_path` fallthrough
+- Comprehensive test suite: workflow tests, full DDL coverage (69 tests, 163 assertions)
+- Rewrite README from first principles
+
+## 0.3.0
+
+- Add `db:branch:console` rake task — opens psql with the branch `search_path`
+
 ## 0.2.0
 
-- Remove primary branch concept — every branch gets its own schema equally
 - Add shadow interception for `add_foreign_key`, `remove_foreign_key`, `add_check_constraint`, `remove_check_constraint`, `validate_foreign_key`, `validate_check_constraint`
 - Simplify branch resolution to `PGBRANCH` env var with git fallback
 - Remove `branch_override` config option and `BRANCH` env var
 - `db:branch:prune` accepts `KEEP=branch1,branch2` for explicit control
 - Fix railtie to reuse the adapter's existing BranchManager
-- Fix redundant Shadow instantiation in migration table shadowing
+- Pass shadow to `activate` instead of creating a redundant instance
 - Quote schema identifiers consistently in shadow SQL
 
 ## 0.1.0

data/README.md

@@ -117,22 +117,36 @@ rails db:branch:discard BRANCH=agent-0
 ## Rake tasks
 
 ```bash
-rails db:branch:reset              # drop and recreate current branch schema
+rails db:branch:reset               # drop and recreate current branch schema
 rails db:branch:discard             # drop current branch schema (or BRANCH=name)
 rails db:branch:list                # list all branch schemas and their sizes
 rails db:branch:diff                # show tables in the current branch schema
 rails db:branch:prune               # drop stale schemas (KEEP=main,feature/x or auto-detect from git)
+rails db:branch:console             # open psql with the branch search_path
 ```
 
+### psql
+
+`psql` connects directly to PostgreSQL and knows nothing about branch schemas. Use `db:branch:console` instead — it launches psql with `search_path` set to your branch schema, so you see exactly what your Rails app sees.
+
 ## Configuration
 
-The adapter needs one thing: a branch name. Resolution order:
+```yaml
+development:
+  adapter: postgresql_branched
+  database: myapp_development
+  primary_branch: main        # default, can be 'master', 'trunk', etc.
+```
+
+The adapter needs a branch name. Resolution order:
 
 1. `PGBRANCH` environment variable
 2. `git branch --show-current` (automatic fallback)
 
 If neither is available, the adapter raises an error.
 
+On the **primary branch** (`main` by default), the adapter stands aside entirely. No branch schema is created. Migrations land directly in `public`. This is how the shared baseline advances — when you pull main and run `db:migrate`, the tables go to `public` where every feature branch can see them via `search_path` fallthrough.
+
 All standard PostgreSQL connection parameters work as normal (`host`, `port`, `username`, `password`, etc.).
 
 **Do not set `schema_search_path` in database.yml** — it conflicts with the adapter's `search_path` management.

data/lib/active_record/connection_adapters/postgresql/branched/adapter.rb

@@ -31,7 +31,7 @@ module ActiveRecord
           def initialize(...)
             super
             @branch_manager = BranchManager.new(self, @config)
-            @shadow = Shadow.new(self, @branch_manager.branch_schema)
+            @shadow = Shadow.new(self, @branch_manager.branch_schema) unless @branch_manager.primary_branch?
           end
 
           def configure_connection
@@ -41,7 +41,7 @@ module ActiveRecord
 
           SHADOW_BEFORE.each do |method|
             define_method(method) do |table_name, *args, **kwargs, &block|
-              @shadow.call(table_name)
+              @shadow&.call(table_name)
               super(table_name, *args, **kwargs, &block)
             end
           end
@@ -51,9 +51,10 @@ module ActiveRecord
           # the branch schema. The table and index renames succeed before the
           # sequence rename fails, so we rescue the sequence error.
           def rename_table(table_name, new_name, **options)
-            @shadow.call(table_name)
+            @shadow&.call(table_name)
             super
           rescue ActiveRecord::StatementInvalid => e
+            raise if @branch_manager.primary_branch?
             raise unless e.cause.is_a?(PG::UndefinedTable)
           end
 

data/lib/active_record/connection_adapters/postgresql/branched/branch_manager.rb

@@ -13,11 +13,17 @@ module ActiveRecord
           end
 
           def activate(shadow)
+            return if primary_branch?
+
             ensure_schema
             set_search_path
             shadow_migration_tables(shadow)
           end
 
+          def primary_branch?
+            @branch == primary_branch_name
+          end
+
           def reset
             drop_schema
             ensure_schema
@@ -26,6 +32,11 @@ module ActiveRecord
 
           def discard(branch_name = @branch)
             schema = self.class.sanitise(branch_name)
+
+            if schema == self.class.sanitise(primary_branch_name)
+              raise "Cannot discard the primary branch schema"
+            end
+
             @connection.execute("DROP SCHEMA IF EXISTS #{quote(schema)} CASCADE")
           end
 
@@ -45,6 +56,8 @@ module ActiveRecord
           end
 
           def diff
+            return [] if primary_branch?
+
             @connection.select_values(<<~SQL)
               SELECT table_name FROM information_schema.tables
               WHERE table_schema = #{@connection.quote(@branch_schema)}
@@ -107,6 +120,10 @@ module ActiveRecord
             name
           end
 
+          def primary_branch_name
+            (@config[:primary_branch] || "main").to_s
+          end
+
           def ensure_schema
             @connection.execute("CREATE SCHEMA IF NOT EXISTS #{quote(@branch_schema)}")
           end

data/lib/active_record/connection_adapters/postgresql/branched/railtie.rb

@@ -9,6 +9,12 @@ module ActiveRecord
                 desc "Drop and recreate the current branch schema"
                 task reset: :load_config do
                   manager = branch_manager
+
+                  if manager.primary_branch?
+                    puts "On primary branch (#{manager.branch}), nothing to reset."
+                    next
+                  end
+
                   manager.reset
                   puts "Reset branch schema #{manager.branch_schema}. Run db:migrate to reapply branch migrations."
                 end
@@ -53,6 +59,12 @@ module ActiveRecord
                 desc "Show objects in the current branch schema"
                 task diff: :load_config do
                   manager = branch_manager
+
+                  if manager.primary_branch?
+                    puts "On primary branch, no diff."
+                    next
+                  end
+
                   tables = manager.diff
 
                   if tables.empty?
@@ -62,6 +74,26 @@ module ActiveRecord
                     tables.each { |t| puts "  #{t}" }
                   end
                 end
+
+                desc "Open psql with the branch search_path"
+                task console: :load_config do
+                  manager = branch_manager
+                  config = ActiveRecord::Base.connection_db_config.configuration_hash
+
+                  env = {}
+                  unless manager.primary_branch?
+                    env["PGOPTIONS"] = "-c search_path=#{manager.branch_schema},public"
+                  end
+
+                  args = ["psql"]
+                  args.push("-h", config[:host].to_s) if config[:host]
+                  args.push("-p", config[:port].to_s) if config[:port]
+                  args.push("-U", config[:username].to_s) if config[:username]
+                  args.push(config[:database].to_s)
+
+                  puts "Connecting to #{config[:database]}#{" as #{manager.branch_schema}" unless manager.primary_branch?}..."
+                  exec(env, *args)
+                end
               end
             end
 

data/lib/active_record/connection_adapters/postgresql/branched/schema_dumper.rb

@@ -8,7 +8,8 @@ module ActiveRecord
           private
 
           def on_branch?
-            @connection.respond_to?(:branch_manager)
+            @connection.respond_to?(:branch_manager) &&
+              !@connection.branch_manager.primary_branch?
           end
 
           def initialize(connection, options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgresql-branched
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Carl Dawson