rails_caddy_dev 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7582dcb4c27a58a8bfc19966a8faeaf55ff65af7bb2833a49e2982a4c8107ebb
-  data.tar.gz: 1611241404ceb557cae40f39b5a704a0b165b794dcd3f34b6939174502160039
+  metadata.gz: d16f9c9a33775c67c8b401c336720da85f5f4c4fa339f5d31d49791d099984f9
+  data.tar.gz: 4c271464f5ad808dd8a60ef93d3e6aeafe722270752caaaa62cf635cbddbfe71
 SHA512:
-  metadata.gz: 315440bc4de9560a21572b305d9b1bfcae9df7480e07d5574d310a97aee2b30e7ca6be318ecc942aaa1dc7ee072bf8692a1efae4e2749a5e601a6069884123d8
-  data.tar.gz: 3e241c92e93ec16d7e5d5896a0087dfafe81015d61e3561d5a1d3c68fac03ce2fbcaf399e2870257719ee0918a34e4ca01116aaaae6120deba3fd71ef930157f
+  metadata.gz: bd9c245265f8f913940ac2f593de24ecf9e14293f3328b75c347810b6bb57507e63f0825075a7085184cfc129dbc0866481123ba650db3a4db5f94192c121a9e
+  data.tar.gz: 2c7e83d684ed7cec4e76d9a141b2512af2a7f8876c729a4abc0b5e88f75647b4017985a3305e41978e0487a90ae60e7f4be56a23b74c19aa49f100baf3518014

data/README.md

@@ -53,35 +53,24 @@ This will configure Caddy to proxy `myapp.localhost` to your Rails server, acces
 |---|---|---|
 | `DEVCADDY` | Enables Caddy configuration (must be set) | — |
 | `PROJECT_NAME` | Used to derive the `.localhost` hostname (required) | — |
-| `PORT` | Rails server port to proxy to | `3000` |
+| `PORT` | Rails server port to proxy to | Auto-detected available port (falls back to `3000`) |
 | `CADDY_HOST` | Caddy admin API host | `localhost` |
 | `CADDY_PORT` | Caddy admin API port | `2019` |
 
 ### Dynamic Port Allocation
 
-The gem includes a standalone executable to find an available TCP port, which can be useful if you want to run multiple Rails servers without port conflicts:
+If `PORT` is not set, the gem automatically detects an available TCP port and uses it. This means you can run multiple Rails servers without port conflicts — no manual configuration needed.
+
+You can also use the standalone executable to find an available port yourself:
 
 ```bash
 export PORT=$(bundle exec rails_caddy_dev port)
 ```
 
-RailsCaddyDev will then configure Caddy to proxy to the dynamically allocated port, and start your Rails server on that port.
-
 ### Subdomains
 
 Subdomains are also supported due to a wildcard Caddy route that will be configured. For example, if you set `PROJECT_NAME=myapp`, then `api.myapp.localhost` will also proxy to your Rails server.
 
-### Usage with Mise
-
-If you're using [Mise](https://github.com/joelmoss/mise), you can integrate RailsCaddyDev by setting the `PORT` environment variable dynamically using the CLI command provided by RailsCaddyDev. Add this to your Mise config (eg. `mise.toml`):
-
-```toml
-[env]
-PORT = { value = "${env.PORT:-{{exec(command='bundle exec rails rails_caddy_dev:available_port')}}}", tools = true }
-```
-
-Now the `PORT` environment variable will be set to an available port each time you start your Mise environment, allowing you to run multiple Rails servers without port conflicts.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/rails_caddy_dev

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 if ARGV[0] == 'port'
-  require 'socket';
-  puts Addrinfo.tcp('', 0).bind { |s| s.local_address.ip_port }
+  require 'socket'
+  puts(Addrinfo.tcp('', 0).bind { |s| s.local_address.ip_port })
   exit 0
 else
-  puts "Usage: `rails_caddy_dev port` to get an available port number."
+  puts 'Usage: `rails_caddy_dev port` to get an available port number.'
   exit 1
-end
+end

data/lib/rails_caddy_dev/update_config.rb

@@ -6,30 +6,17 @@
 # `<project_name>.localhost` to the locally running Rails server.
 #
 # This file is intended to be run as part of the `rails server` startup process, and will only
-# execute in the development environment, and when the `DEVCADDY` environment variable is set. It
-# should be required from the application's 'bin/rails' file., making it look something like this:
-#
-#   #!/usr/bin/env ruby
-#
-#   APP_PATH = File.expand_path("../config/application", __dir__)
-#   require_relative "../config/boot"
-#
-#   if ENV['RAILS_ENV'] == 'development' && ENV.key?('DEVCADDY') &&
-#      (ARGV.first == 's' || ARGV.first == 'server')
-#     require 'rails_caddy_dev/update_config'
-#   end
-#
-#   require "rails/commands"
-#
+# execute in the development environment, and when the `DEVCADDY` environment variable is set.#
 #
 # The script checks if a Caddy config for the project already exists by querying the admin API. If
 # it does, it sends a PATCH request to update it; if not, it attempts to append a new route to the
 # existing config or initialize a new config structure if necessary.
 #
-# The script expects the following environment variables:
+# The script accepts the following environment variables:
 #   - PROJECT_NAME: Used to derive subdomain hostnames (e.g. "my_project" → my_project.localhost).
 #     This is required to ensure unique routing for each project.
-#   - PORT: Rails server port (default: 3000)
+#   - PORT: Rails server port (defaults to an available port if not set, or 3000 if port detection
+#     fails)
 #   - CADDY_HOST: Caddy admin API host (default: localhost)
 #   - CADDY_PORT: Caddy admin API port (default: 2019)
 #
@@ -38,10 +25,14 @@
 
 require 'net/http'
 require 'json'
+require 'socket'
 
 return if ENV.fetch('RAILS_ENV', 'development') != 'development' || !ENV.key?('DEVCADDY')
 
-PORT = ENV.fetch('PORT', '3000')
+PORT = ENV['PORT'] = ENV.fetch('PORT') do
+  Addrinfo.tcp('', 0).bind { |s| s.local_address.ip_port }&.to_s || '3000'
+end
+
 CADDY_HOST = ENV.fetch('CADDY_HOST', 'localhost')
 CADDY_PORT = ENV.fetch('CADDY_PORT', '2019').to_i
 PROJECT_NAME = ENV.fetch('PROJECT_NAME')&.downcase

data/lib/rails_caddy_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsCaddyDev
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_caddy_dev
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Moss