Refactored configuration and added a new skip_teardown option

Author: bert-mccutchen

Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rails-nginx.gemspec
 gemspec
 
+gem "debug"
 gem "rake"
 gem "rspec"
 gem "standard"

Gemfile.lock

@@ -90,6 +90,9 @@ GEM
     connection_pool (2.5.0)
     crass (1.0.6)
     date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     diff-lcs (1.6.0)
     drb (2.2.1)
     erb (4.0.4)
@@ -130,18 +133,18 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.2)
+    nokogiri (1.18.3)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.18.2-aarch64-linux-gnu)
+    nokogiri (1.18.3-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.2-arm-linux-gnu)
+    nokogiri (1.18.3-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.2-arm64-darwin)
+    nokogiri (1.18.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-darwin)
+    nokogiri (1.18.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-linux-gnu)
+    nokogiri (1.18.3-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.26.3)
     parser (3.3.7.1)
@@ -248,7 +251,7 @@ GEM
     standard-performance (1.6.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.23.0)
-    stringio (3.1.3)
+    stringio (3.1.5)
     thor (1.3.2)
     timeout (0.4.3)
     tty-color (0.6.0)
@@ -259,13 +262,13 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
+    uri (1.0.3)
     useragent (0.16.11)
     websocket-driver (0.7.7)
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   aarch64-linux
@@ -276,6 +279,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  debug
   rails-nginx!
   rake
   rspec

README.md

@@ -107,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
 

bin/dummy

@@ -18,7 +18,7 @@ bundle install
 
 # We need Puma 6.50 for the new on_stopped hook.
 bundle remove puma
-bundle add puma ">= 6.5.0"
+bundle add puma --version ">= 6.5.0"
 
 # Configure Puma with rails-nginx
 cat >> ./config/puma.rb << EOF

lib/rails/nginx.rb

@@ -2,6 +2,7 @@
 
 require "socket"
 require "ruby/nginx"
+require_relative "nginx/configuration"
 require_relative "nginx/version"
 
 module Rails
@@ -13,48 +14,28 @@ def self.port
     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
       abort "[Ruby::Nginx] #{e.message}"
     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 @@ def self.start_message(config)
       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

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

spec/dummy/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    rails-nginx (1.0.0.pre.beta.5)
+    rails-nginx (1.0.0.pre.beta.6)
       puma
       rails
       ruby-nginx (>= 1.0.0.pre.beta.4)
@@ -84,7 +84,7 @@ GEM
     benchmark (0.4.0)
     bigdecimal (3.1.9)
     builder (3.3.0)
-    cgi (0.4.1)
+    cgi (0.4.2)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.0)
     crass (1.0.6)
@@ -127,21 +127,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.2-aarch64-linux-gnu)
+    nokogiri (1.18.3-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.2-aarch64-linux-musl)
+    nokogiri (1.18.3-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.2-arm-linux-gnu)
+    nokogiri (1.18.3-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.2-arm-linux-musl)
+    nokogiri (1.18.3-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.2-arm64-darwin)
+    nokogiri (1.18.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-darwin)
+    nokogiri (1.18.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-linux-gnu)
+    nokogiri (1.18.3-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.2-x86_64-linux-musl)
+    nokogiri (1.18.3-x86_64-linux-musl)
       racc (~> 1.4)
     pastel (0.8.0)
       tty-color (~> 0.5)
@@ -201,21 +201,21 @@ GEM
       thor
       tty-command (~> 0.10, >= 0.10.1)
     securerandom (0.4.1)
-    stringio (3.1.3)
+    stringio (3.1.5)
     thor (1.3.2)
     timeout (0.4.3)
     tty-color (0.6.0)
     tty-command (0.10.1)
       pastel (~> 0.8)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    uri (1.0.2)
+    uri (1.0.3)
     useragent (0.16.11)
     websocket-driver (0.7.7)
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   aarch64-linux-gnu

spec/support/dummy_server.rb

@@ -2,7 +2,7 @@
 
 ENV["SKIP_PROMPT"] = "true"
 APP_PATH = File.expand_path("../dummy/config/application", __dir__)
-ARGV = ["server"]
+ARGV = ["server", "-p", "3001"]
 
 class DummyServer
   include Singleton