discharger 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ccade0fc5dd3187492ca714a564007743c6b4b18633293fcd95de540e8b8cb
-  data.tar.gz: 55833bfc91a090b58e1a853df4138699eab4dee9b5f60f5a5d01911d5adf580c
+  metadata.gz: 487fc4990548d3bae797d7538d41363f6c02064c1e0682ff3ef11bdeac4de7de
+  data.tar.gz: 7125f6b47e9fea4e457d418fcda09ef12045ed72c5c96200b4d1887ae832a658
 SHA512:
-  metadata.gz: e679dfc9501cc0d0739143785af0ef29de20295577ed0971c21fb66a4cb9506d67b3d644a19497e4a0353f925180413ae978d8366fb614b4a544150f3014b99d
-  data.tar.gz: a92efb287ab888f7ff550797cf54bbdd6d8bad18d23cedfbc1f673309c4969ac86f1b9afc4fb7b2d8d9902a6d250854592d79056e5d2692635c1f9ef5879dfde
+  metadata.gz: 5e485c19d5c6285108dad2f14172b818046edcc4cec7fd9a3e5936c76e2a76df65fb4db0729b9862fc9f6e6ebb0750cb18f1fb23080920321438e19078626d5b
+  data.tar.gz: 61431222b20ebd419407d1db9d2f969df34993cbdbce465c302d26bd80081aabacda5085f85e5e2aae758c23641f31124c2c9edbce1ff9ff733a9e5b014dbb73

data/CHANGELOG.md

@@ -5,14 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.2.31] - 2026-04-09
+## [0.3.2] - 2026-07-15
 
-### Added
+### Changed
 
-- Unified setup entry point with pre-steps support (1459633)
+- Treat generated pg_tools setup as opt-in for apps that use structure.sql or PostgreSQL CLI workflows.
 
-## [0.2.30] - 2026-03-11
+### Fixed
 
-### Changed
+- Retry `brew bundle` once before failing setup, so transient Homebrew lock contention (e.g. two `bin/setup` runs on the same host) doesn't hard-fail the whole run.
+- pg-tools wrappers no longer forward localhost -h/-p flags into docker exec, where the host-mapped port doesn't exist; remote hosts still pass through untouched (a3869d2)
+
+## [0.3.1] - 2026-05-13
+
+### Added
 
-- Use git trailer fragments for changelog generation (70396ca)
+- database.prefer_docker setup.yml option for explicit Docker vs native PostgreSQL selection (2fca81e)

data/README.md

@@ -163,6 +163,12 @@ database:
   name: "db-your-app"
   version: "14"
   password: "postgres"
+  # Optional. Controls how the docker step handles a native PostgreSQL
+  # already listening on the configured port:
+  #   omitted/nil/false - silently skip Docker and use the native instance (legacy default)
+  #   true              - always create the Docker container; fail if a native instance holds the port
+  #   "prompt"          - ask the developer (interactive shells only; non-interactive runs fall back to native)
+  prefer_docker: "prompt"
 
 redis:
   port: 6379
@@ -193,12 +199,12 @@ The `pre_steps` array defines commands that run **before Rails loads**. These ar
 
 Built-in pre_steps:
 - `homebrew` - Installs Homebrew if not present (macOS)
-- `postgresql_tools` - Installs PostgreSQL client tools (`pg_dump`, `psql`)
+- `postgresql_tools` - Optionally installs PostgreSQL client tools (`pg_dump`, `psql`) for apps that use `structure.sql` or call those tools directly
 
 ```yaml
 pre_steps:
   - homebrew
-  - postgresql_tools
+  # - postgresql_tools
 ```
 
 You can also define custom pre_steps with shell commands:
@@ -222,6 +228,7 @@ The `steps` array specifies which built-in setup commands to run. Available comm
 - `yarn` - Install JavaScript packages
 - `config` - Copy configuration files
 - `docker` - Setup Docker containers
+- `pg_tools` - Create Docker-aware `pg_dump` and `psql` wrappers for apps that use `structure.sql` or call those tools directly
 - `env` - Configure environment variables
 - `database` - Setup and migrate database
 

data/lib/discharger/setup_runner/commands/brew_command.rb

@@ -6,10 +6,12 @@ module Discharger
   module SetupRunner
     module Commands
       class BrewCommand < BaseCommand
+        RETRY_DELAY_SECONDS = 2
+
         def execute
           proceed_with "brew bundle" do
             log "Ensuring brew dependencies"
-            system! "brew bundle"
+            run_brew_bundle
           end
         end
 
@@ -20,6 +22,23 @@ module Discharger
         def description
           "Install Homebrew dependencies"
         end
+
+        private
+
+        # brew bundle can fail transiently (e.g. Homebrew lock contention from a
+        # concurrent `brew` invocation) unrelated to the app's actual dependencies.
+        # Retry once before treating it as a real setup failure.
+        def run_brew_bundle
+          system! "brew bundle"
+        rescue => e
+          log "brew bundle failed, retrying once: #{e.message}"
+          sleep retry_delay
+          system! "brew bundle"
+        end
+
+        def retry_delay
+          RETRY_DELAY_SECONDS
+        end
       end
     end
   end

data/lib/discharger/setup_runner/commands/docker_command.rb

@@ -7,35 +7,8 @@ module Discharger
     module Commands
       class DockerCommand < BaseCommand
         def execute
-          # Setup database container if configured
-          if database_configured?
-            puts "  → Checking database configuration..." unless ENV["QUIET_SETUP"]
-            if native_postgresql_available?
-              puts "  → Native PostgreSQL detected on port #{native_postgresql_port}, skipping Docker setup" unless ENV["QUIET_SETUP"]
-              ENV["DB_PORT"] ||= native_postgresql_port.to_s
-            else
-              puts "  → No native PostgreSQL found, setting up Docker container..." unless ENV["QUIET_SETUP"]
-              ensure_docker_running
-              setup_container(
-                name: database_config.name || "db-app",
-                port: database_config.port || 5432,
-                image: "postgres:#{database_config.version || "14"}",
-                env: {"POSTGRES_PASSWORD" => database_config.password || "postgres"},
-                volume: "#{database_config.name || "db-app"}:/var/lib/postgresql/data",
-                internal_port: 5432
-              )
-            end
-          end
-
-          # Setup Redis container if configured
-          if redis_configured?
-            setup_container(
-              name: redis_config.name || "redis-app",
-              port: redis_config.port || 6379,
-              image: "redis:#{redis_config.version || "latest"}",
-              internal_port: 6379
-            )
-          end
+          setup_database if database_configured?
+          setup_redis if redis_configured?
         end
 
         def can_execute?
@@ -49,6 +22,84 @@ module Discharger
 
         private
 
+        def setup_database
+          puts "  → Checking database configuration..." unless ENV["QUIET_SETUP"]
+
+          case database_config.prefer_docker
+          when true
+            create_database_container_or_fail
+          when "prompt"
+            if native_postgresql_available? && wants_native_postgresql?
+              use_native_postgresql
+            else
+              create_database_container_or_fail
+            end
+          else
+            # Legacy default: prefer the native instance when one is available.
+            if native_postgresql_available?
+              use_native_postgresql
+            else
+              create_database_container
+            end
+          end
+        end
+
+        def setup_redis
+          setup_container(
+            name: redis_config.name || "redis-app",
+            port: redis_config.port || 6379,
+            image: "redis:#{redis_config.version || "latest"}",
+            internal_port: 6379
+          )
+        end
+
+        def use_native_postgresql
+          puts "  → Native PostgreSQL detected on port #{native_postgresql_port}, skipping Docker setup" unless ENV["QUIET_SETUP"]
+          ENV["DB_PORT"] ||= native_postgresql_port.to_s
+        end
+
+        def create_database_container_or_fail
+          if native_postgresql_available?
+            raise "prefer_docker is set in the database config but native PostgreSQL is " \
+                  "listening on port #{native_postgresql_port}. Stop the native instance " \
+                  "(e.g., `brew services stop postgresql@15`) or remove prefer_docker."
+          end
+          create_database_container
+        end
+
+        def create_database_container
+          puts "  → No native PostgreSQL found, setting up Docker container..." unless ENV["QUIET_SETUP"]
+          ensure_docker_running
+          setup_container(
+            name: database_config.name || "db-app",
+            port: database_config.port || 5432,
+            image: "postgres:#{database_config.version || "14"}",
+            env: {"POSTGRES_PASSWORD" => database_config.password || "postgres"},
+            volume: "#{database_config.name || "db-app"}:/var/lib/postgresql/data",
+            internal_port: 5432
+          )
+        end
+
+        # Ask the developer whether to use the detected native PostgreSQL or set up
+        # the configured Docker container instead. Falls back to native (the legacy
+        # behavior) when stdin is not a TTY, in CI, or when QUIET_SETUP is set,
+        # so non-interactive runs do not hang waiting for input.
+        def wants_native_postgresql?
+          unless interactive_prompt_available?
+            puts "  → Non-interactive shell; defaulting to native PostgreSQL on port #{native_postgresql_port}" unless ENV["QUIET_SETUP"]
+            return true
+          end
+
+          puts "Native PostgreSQL detected on port #{native_postgresql_port}. Use the Docker container anyway?\n ===> Type Y to set up the Docker container\nOtherwise hit any key to use the native PostgreSQL."
+          $stdin.gets&.chomp != "Y"
+        end
+
+        def interactive_prompt_available?
+          return true if ENV["DISCHARGER_FORCE_INTERACTIVE"]
+          return false if ENV["CI"] || ENV["QUIET_SETUP"]
+          $stdin.tty?
+        end
+
         def setup_container(name:, port:, image:, internal_port:, env: {}, volume: nil)
           log "Checking #{name} container"
 

data/lib/discharger/setup_runner/commands/pg_tools_command.rb

@@ -62,6 +62,8 @@ module Discharger
               # When running in Docker, we need to output to stdout and redirect locally
               OUTPUT_FILE=""
               HAS_USER=""
+              HOST=""
+              PORT=""
               ARGS=()
               while [[ $# -gt 0 ]]; do
                 case $1 in
@@ -82,6 +84,38 @@ module Discharger
                     ARGS+=("$1")
                     shift
                     ;;
+                  -h|--host)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    HOST="$2"
+                    shift 2
+                    ;;
+                  -h?*)
+                    HOST="${1#-h}"
+                    shift
+                    ;;
+                  --host=*)
+                    HOST="${1#*=}"
+                    shift
+                    ;;
+                  -p|--port)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    PORT="$2"
+                    shift 2
+                    ;;
+                  -p?*)
+                    PORT="${1#-p}"
+                    shift
+                    ;;
+                  --port=*)
+                    PORT="${1#*=}"
+                    shift
+                    ;;
                   *)
                     ARGS+=("$1")
                     shift
@@ -94,6 +128,19 @@ module Discharger
                 ARGS=("-U" "postgres" "${ARGS[@]}")
               fi
 
+              # Drop localhost host/port flags: they target the host-mapped
+              # port, but inside the container Postgres listens on its default
+              # port. Remote hosts pass through untouched.
+              case "$HOST" in
+                ""|localhost|127.0.0.1|::1) ;;
+                *)
+                  ARGS+=("-h" "$HOST")
+                  if [[ -n "$PORT" ]]; then
+                    ARGS+=("-p" "$PORT")
+                  fi
+                  ;;
+              esac
+
               if [[ -n "$OUTPUT_FILE" ]]; then
                 # Run pg_dump in container, output to stdout, redirect to local file
                 docker exec -i "$CONTAINER" pg_dump "${ARGS[@]}" > "$OUTPUT_FILE"
@@ -133,6 +180,8 @@ module Discharger
               # so we pipe file content via stdin instead
               INPUT_FILE=""
               HAS_USER=""
+              HOST=""
+              PORT=""
               ARGS=()
               while [[ $# -gt 0 ]]; do
                 case $1 in
@@ -153,6 +202,38 @@ module Discharger
                     ARGS+=("$1")
                     shift
                     ;;
+                  -h|--host)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    HOST="$2"
+                    shift 2
+                    ;;
+                  -h?*)
+                    HOST="${1#-h}"
+                    shift
+                    ;;
+                  --host=*)
+                    HOST="${1#*=}"
+                    shift
+                    ;;
+                  -p|--port)
+                    if [[ $# -lt 2 ]]; then
+                      echo "Error: $1 requires an argument" >&2
+                      exit 2
+                    fi
+                    PORT="$2"
+                    shift 2
+                    ;;
+                  -p?*)
+                    PORT="${1#-p}"
+                    shift
+                    ;;
+                  --port=*)
+                    PORT="${1#*=}"
+                    shift
+                    ;;
                   *)
                     ARGS+=("$1")
                     shift
@@ -165,6 +246,19 @@ module Discharger
                 ARGS=("-U" "postgres" "${ARGS[@]}")
               fi
 
+              # Drop localhost host/port flags: they target the host-mapped
+              # port, but inside the container Postgres listens on its default
+              # port. Remote hosts pass through untouched.
+              case "$HOST" in
+                ""|localhost|127.0.0.1|::1) ;;
+                *)
+                  ARGS+=("-h" "$HOST")
+                  if [[ -n "$PORT" ]]; then
+                    ARGS+=("-p" "$PORT")
+                  fi
+                  ;;
+              esac
+
               if [[ -n "$INPUT_FILE" ]]; then
                 docker exec -i "$CONTAINER" #{tool} "${ARGS[@]}" < "$INPUT_FILE"
               else

data/lib/discharger/setup_runner/configuration.rb

@@ -37,13 +37,14 @@ module Discharger
     end
 
     class DatabaseConfig
-      attr_accessor :port, :name, :version, :password
+      attr_accessor :port, :name, :version, :password, :prefer_docker
 
       def initialize
         @port = 5432
         @name = "db-app"
         @version = "14"
         @password = "postgres"
+        @prefer_docker = nil
       end
 
       def from_hash(hash)
@@ -51,6 +52,7 @@ module Discharger
         @name = hash["name"] if hash["name"]
         @version = hash["version"] if hash["version"]
         @password = hash["password"] if hash["password"]
+        @prefer_docker = hash["prefer_docker"] if hash.key?("prefer_docker")
       end
     end
 

data/lib/discharger/setup_runner/prerequisites_loader.rb

@@ -55,14 +55,36 @@ module Discharger
       def set_db_port(db_config)
         if db_config["port"] && !ENV["DB_PORT"]
           ENV["DB_PORT"] = db_config["port"].to_s
-          ENV["PGPORT"] = db_config["port"].to_s
+          set_pgport_if_needed(db_config["port"].to_s)
           puts "  Setting DB_PORT=#{db_config["port"]} from config/setup.yml"
         elsif ENV["DB_PORT"]
           warn_if_mismatch("DB_PORT", ENV["DB_PORT"], db_config["port"].to_s)
-          ENV["PGPORT"] = ENV["DB_PORT"]
+          set_pgport_if_needed(ENV["DB_PORT"])
         end
       end
 
+      def set_pgport_if_needed(port)
+        ENV["PGPORT"] = port if postgresql_cli_setup_enabled?
+      end
+
+      def postgresql_cli_setup_enabled?
+        configured_pre_steps.include?("postgresql_tools") ||
+          configured_steps.include?("pg_tools") ||
+          all_regular_steps_enabled?
+      end
+
+      def configured_pre_steps
+        Array(config["pre_steps"]).select { |step| step.is_a?(String) }
+      end
+
+      def configured_steps
+        Array(config["steps"]).select { |step| step.is_a?(String) }
+      end
+
+      def all_regular_steps_enabled?
+        !config.key?("steps") || Array(config["steps"]).empty?
+      end
+
       def set_db_name(db_config)
         if db_config["name"] && !ENV["DB_NAME"]
           container_name = db_config["name"].to_s

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/lib/generators/discharger/install/templates/setup.yml

@@ -24,7 +24,7 @@ redis:
 #
 # Built-in pre_steps:
 #   - homebrew         # Installs Homebrew if not present
-#   - postgresql_tools # Installs PostgreSQL client tools (pg_dump, psql)
+#   - postgresql_tools # Optional: installs PostgreSQL client tools for structure.sql workflows
 #
 # Custom pre_steps (run shell commands):
 #   - description: "Description of step"
@@ -33,7 +33,7 @@ redis:
 #
 pre_steps: []
   # - homebrew
-  # - postgresql_tools
+  # - postgresql_tools # Optional: for apps that use structure.sql or pg_dump/psql directly
 
 # Built-in commands to run (empty array runs all available commands)
 # Available commands: brew, asdf, git, bundler, yarn, config, docker, pg_tools, env, database
@@ -45,10 +45,12 @@ steps:
   - yarn
   - config
   - docker
-  - pg_tools
   - env
   - database
 
+# Optional for apps that use structure.sql or other pg_dump/psql workflows:
+#   - pg_tools
+
 # Custom commands for application-specific setup (run AFTER Rails loads)
 custom_steps:
   - description: "Seed application data"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Jim Gay