rails-nginx 1.0.0.pre.beta.5 → 1.0.0.pre.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956e724db5d81a082cd2f62a2419914f4277b2bec4da2ddef907f5f4e607ca32
-  data.tar.gz: 8005ef05337d08da877addccbca085cfcd704a367d82b5891c88db1485458eef
+  metadata.gz: '058189602280cfeeb47c1b5559b6f46be3ec9e28ae16cc14414a621c3a549b05'
+  data.tar.gz: 2fa39064a2fb2980faf7c637a66fca8dfb20ea6670ad5b4868a69006460a6f79
 SHA512:
-  metadata.gz: 157b532353699de538e033a85bc41235d2d4274b0bf9c64f354b8040929c57725646be887902383155a539ae22dca68eb2402d2c6c08f63425f31ef7a4a53f4a
-  data.tar.gz: 54db2698cd5c2ac95fcfa4f61f45b1eb4cbbe272722c690fe6d6d34deb3bc009324507b2a6518f08e1dc77aa8f095d0d71dd6048c3a42a3da3ba2a77fb7cf5bc
+  metadata.gz: 2219d85b6fd63d594f2d12c33a18e5317b33b216cfc0531e67f4704c31967a347c4b1bb1951a33636a82bcec5a6109d9a707df440909f07cc716d74698a1dea2
+  data.tar.gz: 538294ecdf66eb548a36849242b2be90baa67736d311d6f3764c294e15b5464c6c843b834dfb4e70b84b8a6facf066d0558fe4efbcf983e7f7127cc6529a569c

data/README.md

@@ -67,32 +67,31 @@ gem install rails-nginx
 
 Add the Puma plugin to your configuration, and limit it to your development environment.
 
-**config/puma.rb**
+**File: config/puma.rb**
 ```ruby
 plugin :rails_nginx if Rails.env.development?
 ```
 
-> [!IMPORTANT]
-> **If you skip this, NGINX reverse proxy will have a randomized port while Puma will not. The reverse proxy will not work.**
->
-> Puma's `port` configuration option makes it impossible for Rails NGINX to assign a random open port back to Puma.
->
-> To fix this issue, simply remove it from our Puma configuration.
+Then simply start Rails!
+
+**Terminal**
+```
+> ./bin/rails
+```
+
+OR
+
+```
+> ./bin/rails -p 3001
+```
+
+> [!NOTE]
+> Rails NGINX will clear all port bindings and assign back to Puma a random open port, or the provided Rails port parameter.
 >
-> **config/puma.rb**
+> The following Puma configuration will be **ignored**.
 > ```ruby
 > port ENV.fetch("PORT") { 3000 }
 > ```
->
-> OR simply disable it in your development environment:
-> ```ruby
-> port ENV.fetch("PORT") { 3000 } unless Rails.env.development?
-> ```
->
-> OR always manually provide an open port when starting Rails:
-> ```
-> ./bin/rails server -p 3001
-> ```
 
 ### Default Configuration
 By default, Rails NGINX will configure [Ruby NGINX](https://github.com/bert-mccutchen/ruby-nginx) with the following options. For the examples, pretend I have an application called "HelloWorld".
@@ -108,6 +107,9 @@ By default, Rails NGINX will configure [Ruby NGINX](https://github.com/bert-mccu
 | `ssl_certificate_key_path` | `Rails.root` + `tmp/nginx/_[DOMAIN]-key.pem` | `/home/bert/hello_world/tmp/nginx/_hello-world.test-key.pem` |
 | `access_log_path` | `Rails.root` + `log/nginx/[DOMAIN].access.log` | `/home/bert/hello_world/log/hello-world.test.access.log` |
 | `error_log_path` | `Rails.root` + `log/nginx/[DOMAIN].error.log` | `/home/bert/hello_world/log/hello-world.test.error.log` |
+| `skip_teardown`* | `false` | |
+
+\* Skipping teardown simply leaves the NGINX configuration and hosts mapping in place. This can be useful if you require elevated permissions to change the hosts file, and you don't want to be asked to enter your credentials every time. Any attempts to visit the server's domain while the server is offline will result in a NGINX error page.
 
 ### Advanced Usage
 

data/lib/puma/plugin/rails_nginx.rb

@@ -30,6 +30,7 @@ Puma::Plugin.create do
   def config(puma_config)
     rails_port!
 
+    puma_config.clear_binds!
     puma_config.port Rails::Nginx.port
 
     puma_config.on_booted do

data/lib/rails/nginx/configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Rails
+  module Nginx
+    class Configuration
+      def initialize(options = {})
+        @options = options if rails_server?
+      end
+
+      def rails_server?
+        defined?(Rails::Server)
+      end
+
+      def teardown?
+        !@options[:skip_teardown]
+      end
+
+      def nginx_options
+        defaults.merge(@options).except(:skip_teardown)
+      end
+
+      private
+
+      def domain
+        @options[:domain] || "#{Rails.application.class.module_parent.name.underscore.dasherize}.test"
+      end
+
+      def defaults
+        {
+          domain: domain,
+          port: ENV["PORT"],
+          root_path: Rails.public_path,
+          template_path: File.expand_path("templates/nginx.conf.erb", __dir__),
+          ssl: true,
+          log: true,
+          ssl_certificate_path: Rails.root.join("tmp/nginx/_#{domain}.pem"),
+          ssl_certificate_key_path: Rails.root.join("tmp/nginx/_#{domain}-key.pem"),
+          access_log_path: Rails.root.join("log/nginx/#{domain}.access.log"),
+          error_log_path: Rails.root.join("log/nginx/#{domain}.error.log"),
+          skip_teardown: false
+        }
+      end
+    end
+  end
+end

data/lib/rails/nginx/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module Nginx
-    VERSION = "1.0.0-beta.5"
+    VERSION = "1.0.0-beta.6"
   end
 end

data/lib/rails/nginx.rb

@@ -2,6 +2,7 @@
 
 require "socket"
 require "ruby/nginx"
+require_relative "nginx/configuration"
 require_relative "nginx/version"
 
 module Rails
@@ -13,9 +14,10 @@ module Rails
     end
 
     def self.start!(options = {}, &block)
-      return unless rails_server?
+      rails_config = Configuration.new(options)
+      return unless rails_config.rails_server?
 
-      config = Ruby::Nginx.add!(options.reverse_merge(defaults(options)), &block)
+      config = Ruby::Nginx.add!(rails_config.nginx_options, &block)
 
       puts start_message(config.options)
     rescue Ruby::Nginx::Error => e
@@ -23,38 +25,17 @@ module Rails
     end
 
     def self.stop!(options = {}, &block)
-      return unless rails_server?
+      rails_config = Configuration.new(options)
+      return unless rails_config.rails_server? && rails_config.teardown?
 
-      Ruby::Nginx.remove!(options.reverse_merge(defaults(options)), &block)
+      puts stop_message(rails_config.nginx_options)
+      Ruby::Nginx.remove!(rails_config.nginx_options, &block)
     rescue Ruby::Nginx::Error => e
       abort "[Ruby::Nginx] #{e.message}"
     end
 
     private
 
-    def self.rails_server?
-      defined?(Rails::Server)
-    end
-    private_class_method :rails_server?
-
-    def self.defaults(options)
-      domain = options[:domain] || "#{Rails.application.class.module_parent.name.underscore.dasherize}.test"
-
-      {
-        domain: domain,
-        port: port,
-        root_path: Rails.public_path,
-        template_path: File.expand_path("nginx/templates/nginx.conf.erb", __dir__),
-        ssl: true,
-        log: true,
-        ssl_certificate_path: Rails.root.join("tmp/nginx/_#{domain}.pem"),
-        ssl_certificate_key_path: Rails.root.join("tmp/nginx/_#{domain}-key.pem"),
-        access_log_path: Rails.root.join("log/nginx/#{domain}.access.log"),
-        error_log_path: Rails.root.join("log/nginx/#{domain}.error.log")
-      }
-    end
-    private_class_method :defaults
-
     def self.start_message(config)
       message = ["* Rails NGINX version: #{Rails::Nginx::VERSION}"]
       message << "*       HTTP Endpoint: http://#{config[:domain]}"
@@ -65,5 +46,10 @@ module Rails
       message.join("\n")
     end
     private_class_method :start_message
+
+    def self.stop_message(config)
+      "- Tearing down Rails NGINX config: #{config[:domain]}"
+    end
+    private_class_method :stop_message
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-nginx
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.5
+  version: 1.0.0.pre.beta.6
 platform: ruby
 authors:
 - Bert McCutchen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -64,6 +64,7 @@ files:
 - README.md
 - lib/puma/plugin/rails_nginx.rb
 - lib/rails/nginx.rb
+- lib/rails/nginx/configuration.rb
 - lib/rails/nginx/templates/nginx.conf.erb
 - lib/rails/nginx/version.rb
 homepage: https://github.com/bert-mccutchen/rails-nginx