spring 4.1.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25f487be691e4b74fec8082de6dae9c31b2b5452adea9546e615fe972bb92302
-  data.tar.gz: 7b7997de4635a441fdba39157260f18f6be1f7c4c41b3fe1b43b21a0fada61d6
+  metadata.gz: 3e92617adaa3e6c31e4d466d76894c94ec17a46fd7206864501218795ac8998d
+  data.tar.gz: aee2d23a222df8747942652dda1d6a725f59bb68b395fbd37a9084c5ed75fe7b
 SHA512:
-  metadata.gz: a5a1a3b647476c8582da82cfbaa35524e427303149a1bc2e375f115ba25ef32166fd5800e968f3873afef84e6a38b686447b68c1145e9bfffe6aecff03379cb8
-  data.tar.gz: 985b243181c0a7c6a4c37052fe504f1f3e51303f7c014924ff2dc8c10693e17b45bba8cf0b39f49a2c378da761b715b501d4f535102f3b82bf5006618461235f
+  metadata.gz: 16e03232e4453b528812c925c4186360e1157b10aab0d663d1dc3d4a80a7d4bdf1da8f06d31c6ace1456fa4f6f5e20b2c62637ce0a23da6cae705b56baa6882b
+  data.tar.gz: 1a4c70a381783cc3f96372e28efc6b702b3b75a28c31a1a88eacace55c3a3cbd2aee3d3ff81236526366149a612754c22d9ec0861bc0a3dfb8669108f9bb0aba

data/README.md

@@ -16,7 +16,7 @@ boot it every time you run a test, rake task or migration.
 
 ## Compatibility
 
-* Ruby versions: MRI 2.7, MRI 3.0, MRI 3.1
+* Ruby versions: MRI 2.7, MRI 3.0, MRI 3.1, MRI 3.2
 * Rails versions: 6.0, 6.1, 7.0
 * Bundler v2.1+
 
@@ -71,11 +71,14 @@ Rails directory.
 Spring reloads application code, and therefore needs the application to have
 reloading enabled.
 
-Please, make sure `config.cache_classes` is `false` in the environments that
+Ensure that `config.enable_reloading` is `true` in the environments that
 Spring manages. That setting is typically configured in
-`config/environments/*.rb`. In particular, make sure it is `false` for the
+`config/environments/*.rb`. In particular, make sure it is `true` for the
 `test` environment.
 
+Note: in versions of Rails before 7.1, the setting is called `cache_classes`,
+and it needs to be `false` for Spring to work.
+
 ### Usage
 
 For this walkthrough I've generated a new Rails application, and run

data/lib/spring/application/boot.rb

@@ -11,9 +11,15 @@ app = Spring::Application.new(
 
 Signal.trap("TERM") { app.terminate }
 
-Spring::ProcessTitleUpdater.run { |distance|
-  "spring app    | #{app.app_name} | started #{distance} ago | #{app.app_env} mode"
-}
+Spring::ProcessTitleUpdater.run do |distance|
+  attributes = [
+    app.app_name,
+    "started #{distance} ago",
+    "#{app.app_env} mode",
+    app.spawn_env,
+  ].compact
+  "spring app    | #{attributes.join(" | ")}"
+end
 
 app.eager_preload if ENV.delete("SPRING_PRELOAD") == "1"
 app.run

data/lib/spring/application.rb

@@ -28,6 +28,11 @@ module Spring
       @interrupt.last.write "."
     end
 
+    def spawn_env
+      env = JSON.load(ENV["SPRING_SPAWN_ENV"].dup).map { |key, value| "#{key}=#{value}" }
+      env.join(", ") if env.any?
+    end
+
     def app_env
       ENV['RAILS_ENV']
     end
@@ -119,6 +124,11 @@ module Spring
 
       if defined?(Rails) && Rails.application
         watcher.add Rails.application.paths["config/initializers"]
+        Rails::Engine.descendants.each do |engine|
+          if engine.root.to_s.start_with?(Rails.root.to_s)
+            watcher.add engine.paths["config/initializers"].expanded
+          end
+        end
         watcher.add Rails.application.paths["config/database"]
         if secrets_path = Rails.application.paths["config/secrets"]
           watcher.add secrets_path
@@ -302,13 +312,26 @@ module Spring
       Kernel.module_eval do
         old_raise = Kernel.method(:raise)
         remove_method :raise
-        define_method :raise do |*args|
-          begin
-            old_raise.call(*args)
-          ensure
-            if $!
-              lib = File.expand_path("..", __FILE__)
-              $!.backtrace.reject! { |line| line.start_with?(lib) } unless $!.backtrace.frozen?
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.2.0')
+          define_method :raise do |*args, **kwargs|
+            begin
+              old_raise.call(*args, **kwargs)
+            ensure
+              if $!
+                lib = File.expand_path("..", __FILE__)
+                $!.backtrace.reject! { |line| line.start_with?(lib) } unless $!.backtrace.frozen?
+              end
+            end
+          end
+        else
+          define_method :raise do |*args|
+            begin
+              old_raise.call(*args)
+            ensure
+              if $!
+                lib = File.expand_path("..", __FILE__)
+                $!.backtrace.reject! { |line| line.start_with?(lib) } unless $!.backtrace.frozen?
+              end
             end
           end
         end

data/lib/spring/application_manager.rb

@@ -1,9 +1,10 @@
 module Spring
   class ApplicationManager
-    attr_reader :pid, :child, :app_env, :spring_env, :status
+    attr_reader :pid, :child, :app_env, :spawn_env, :spring_env, :status
 
-    def initialize(app_env, spring_env)
+    def initialize(app_env, spawn_env, spring_env)
       @app_env    = app_env
+      @spawn_env  = spawn_env
       @spring_env = spring_env
       @mutex      = Mutex.new
       @state      = :running
@@ -100,7 +101,9 @@ module Spring
             "RAILS_ENV"           => app_env,
             "RACK_ENV"            => app_env,
             "SPRING_ORIGINAL_ENV" => JSON.dump(Spring::ORIGINAL_ENV),
-            "SPRING_PRELOAD"      => preload ? "1" : "0"
+            "SPRING_PRELOAD"      => preload ? "1" : "0",
+            "SPRING_SPAWN_ENV"    => JSON.dump(spawn_env),
+            **spawn_env,
           },
           "ruby",
           *(bundler_dir != RbConfig::CONFIG["rubylibdir"] ? ["-I", bundler_dir] : []),
@@ -123,7 +126,8 @@ module Spring
         # as if it does we're no longer interested in the child
         loop do
           IO.select([child])
-          break if child.recv(1, Socket::MSG_PEEK).empty?
+          peek = child.recv(1, Socket::MSG_PEEK)
+          break if peek.nil? || peek.empty?
           sleep 0.01
         end
 

data/lib/spring/client/binstub.rb

@@ -20,7 +20,7 @@ module Spring
       SPRING = <<~CODE
         #!/usr/bin/env ruby
 
-        # This file loads Spring without using loading other gems in the Gemfile, in order to be fast.
+        # This file loads Spring without loading other gems in the Gemfile in order to be fast.
         # It gets overwritten when you run the `spring binstub` command.
 
         if !defined?(Spring) && [nil, "development", "test"].include?(ENV["RAILS_ENV"])

data/lib/spring/client/run.rb

@@ -6,8 +6,6 @@ module Spring
   module Client
     class Run < Command
       FORWARDED_SIGNALS = %w(INT QUIT USR1 USR2 INFO WINCH) & Signal.list.keys
-      CONNECT_TIMEOUT   = 1
-      BOOT_TIMEOUT      = 20
 
       attr_reader :server
 
@@ -73,8 +71,8 @@ module Spring
       def boot_server
         env.socket_path.unlink if env.socket_path.exist?
 
-        pid     = Process.spawn(gem_env, env.server_command, out: File::NULL)
-        timeout = Time.now + BOOT_TIMEOUT
+        pid     = Process.spawn(server_process_env, env.server_command, out: File::NULL)
+        timeout = Time.now + Spring.boot_timeout
 
         @server_booted = true
 
@@ -85,7 +83,7 @@ module Spring
             exit status.exitstatus
           elsif Time.now > timeout
             $stderr.puts "Starting Spring server with `#{env.server_command}` " \
-                         "timed out after #{BOOT_TIMEOUT} seconds"
+                         "timed out after #{Spring.boot_timeout} seconds"
             exit 1
           end
 
@@ -107,6 +105,14 @@ module Spring
         }
       end
 
+      def reset_env
+        ENV.slice(*Spring.reset_on_env)
+      end
+
+      def server_process_env
+        reset_env.merge(gem_env)
+      end
+
       def stop_server
         server.close
         @server = nil
@@ -114,7 +120,16 @@ module Spring
       end
 
       def verify_server_version
-        server_version = server.gets.chomp
+        unless IO.select([server], [], [], Spring.connect_timeout)
+          raise "Error connecting to Spring server"
+        end
+
+        line = server.gets
+        unless line
+          raise "Error connecting to Spring server"
+        end
+
+        server_version = line.chomp
         if server_version != env.version
           $stderr.puts "There is a version mismatch between the Spring client " \
                          "(#{env.version}) and the server (#{server_version})."
@@ -132,9 +147,9 @@ module Spring
 
       def connect_to_application(client)
         server.send_io client
-        send_json server, "args" => args, "default_rails_env" => default_rails_env
+        send_json server, "args" => args, "default_rails_env" => default_rails_env, "spawn_env" => spawn_env, "reset_env" => reset_env
 
-        if IO.select([server], [], [], CONNECT_TIMEOUT)
+        if IO.select([server], [], [], Spring.connect_timeout)
           server.gets or raise CommandNotFound
         else
           raise "Error connecting to Spring server"
@@ -232,6 +247,10 @@ module Spring
       def default_rails_env
         ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
       end
+
+      def spawn_env
+        ENV.slice(*Spring.spawn_on_env)
+      end
     end
   end
 end

data/lib/spring/configuration.rb

@@ -1,8 +1,11 @@
 require "spring/errors"
 
 module Spring
+  @connect_timeout = 5
+  @boot_timeout = 20
+
   class << self
-    attr_accessor :application_root
+    attr_accessor :application_root, :connect_timeout, :boot_timeout
     attr_writer :quiet
 
     def gemfile
@@ -32,6 +35,14 @@ module Spring
       after_fork_callbacks << block
     end
 
+    def spawn_on_env
+      @spawn_on_env ||= []
+    end
+
+    def reset_on_env
+      @reset_on_env ||= []
+    end
+
     def verify_environment
       application_root_path
     end

data/lib/spring/json.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 # ### WHY SPRING VENDORS A JSON LIBRARY ###
 #
@@ -13,7 +13,6 @@
 module Spring
   module JSON
     def self.load(string)
-      string.force_encoding("utf-8")
       OkJson.decode(string)
     end
 
@@ -364,7 +363,7 @@ private
             end
           end
           if rubydoesenc?
-            a[w] = '' << uchar
+            a[w] = +'' << uchar
             w += 1
           else
             w += ucharenc(a, w, uchar)

data/lib/spring/server.rb

@@ -19,7 +19,9 @@ module Spring
     def initialize(options = {})
       @foreground   = options.fetch(:foreground, false)
       @env          = options[:env] || default_env
-      @applications = Hash.new { |h, k| h[k] = ApplicationManager.new(k, env) }
+      @applications = Hash.new do |hash, key|
+        hash[key] = ApplicationManager.new(*key, env)
+      end
       @pidfile      = env.pidfile_path.open('a')
       @mutex        = Mutex.new
     end
@@ -57,12 +59,15 @@ module Spring
       app_client = client.recv_io
       command    = JSON.load(client.read(client.gets.to_i))
 
-      args, default_rails_env = command.values_at('args', 'default_rails_env')
+      args, default_rails_env, spawn_env, reset_env = command.values_at('args', 'default_rails_env', 'spawn_env', 'reset_env')
 
       if Spring.command?(args.first)
+        application = @applications[rails_env_for(args, default_rails_env, spawn_env)]
+        reset_if_env_changed(application, reset_env)
+
         log "running command #{args.first}"
         client.puts
-        client.puts @applications[rails_env_for(args, default_rails_env)].run(app_client)
+        client.puts application.run(app_client)
       else
         log "command not found #{args.first}"
         client.close
@@ -73,8 +78,8 @@ module Spring
       redirect_output
     end
 
-    def rails_env_for(args, default_rails_env)
-      Spring.command(args.first).env(args.drop(1)) || default_rails_env
+    def rails_env_for(args, default_rails_env, spawn_env)
+      [Spring.command(args.first).env(args.drop(1)) || default_rails_env, spawn_env]
     end
 
     # Boot the server into the process group of the current session.
@@ -136,6 +141,10 @@ module Spring
 
     private
 
+    def reset_if_env_changed(application, reset_env)
+      application.stop if ENV.slice(*reset_env.keys) != reset_env
+    end
+
     def default_env
       Env.new(log_file: default_log_file)
     end

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
 module Spring
-  VERSION = "4.1.0"
+  VERSION = "4.3.0"
 end

data/lib/spring/watcher/abstract.rb

@@ -1,5 +1,4 @@
 require "pathname"
-require "mutex_m"
 
 module Spring
   module Watcher
@@ -9,13 +8,10 @@ module Spring
     #   IO.select([watcher]) # watcher is running in background
     #   watcher.stale? # => true
     class Abstract
-      include Mutex_m
-
       attr_reader :files, :directories, :root, :latency
 
       def initialize(root, latency)
-        super()
-
+        @mutex       = Mutex.new
         @root        = File.realpath(root)
         @latency     = latency
         @files       = {}
@@ -26,6 +22,11 @@ module Spring
         @on_debug    = nil
       end
 
+      def synchronize(&block)
+        # Used by some gems.
+        @mutex.synchronize(&block)
+      end
+
       def on_debug(&block)
         @on_debug = block
       end
@@ -59,7 +60,7 @@ module Spring
           end
         end
 
-        synchronize {
+        @mutex.synchronize do
           items.each do |item|
             if item.directory?
               directories[item.realpath.to_s] = true
@@ -75,7 +76,7 @@ module Spring
           end
 
           subjects_changed
-        }
+        end
       end
 
       def stale?

data/lib/spring/watcher/polling.rb

@@ -12,7 +12,7 @@ module Spring
       end
 
       def check_stale
-        synchronize do
+        @mutex.synchronize do
           computed = compute_mtime
           if mtime < computed
             debug { "check_stale: mtime=#{mtime.inspect} < computed=#{computed.inspect}" }

metadata

@@ -1,57 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Jon Leighton
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2025-03-12 00:00:00.000000000 Z
+dependencies: []
 description: Preloads your application so things like console, rake and tests run
   faster
 email:
@@ -99,7 +56,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Rails application preloader
 test_files: []