spring 2.0.2 → 4.2.1

data/lib/spring/client/binstub.rb

@@ -1,56 +1,48 @@
-require 'set'
-
 module Spring
   module Client
     class Binstub < Command
-      SHEBANG = /\#\!.*\n/
+      SHEBANG = /\#\!.*\n(\#.*\n)*/
 
-      # If loading the bin/spring file works, it'll run spring which will
+      # If loading the bin/spring file works, it'll run Spring which will
       # eventually call Kernel.exit. This means that in the client process
-      # we will never execute the lines after this block. But if the spring
+      # we will never execute the lines after this block. But if the Spring
       # client is not invoked for whatever reason, then the Kernel.exit won't
       # happen, and so we'll fall back to the lines after this block, which
       # should cause the "unsprung" version of the command to run.
-      LOADER = <<CODE
-begin
-  load File.expand_path('../spring', __FILE__)
-rescue LoadError => e
-  raise unless e.message.include?('spring')
-end
-CODE
+      LOADER = <<~CODE
+        load File.expand_path("spring", __dir__)
+      CODE
 
       # The defined? check ensures these lines don't execute when we load the
       # binstub from the application process. Which means that in the application
       # process we'll execute the lines which come after the LOADER block, which
       # is what we want.
-      SPRING = <<'CODE'
-#!/usr/bin/env ruby
-
-# This file loads spring without using Bundler, in order to be fast.
-# It gets overwritten when you run the `spring binstub` command.
-
-unless defined?(Spring)
-  require 'rubygems'
-  require 'bundler'
-
-  lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
-  spring = lockfile.specs.detect { |spec| spec.name == "spring" }
-  if spring
-    Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
-    gem 'spring', spring.version
-    require 'spring/binstub'
-  end
-end
-CODE
+      SPRING = <<~CODE
+        #!/usr/bin/env ruby
+
+        # 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"])
+          require "bundler"
+
+          Bundler.locked_gems.specs.find { |spec| spec.name == "spring" }&.tap do |spring|
+            Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
+            gem "spring", spring.version
+            require "spring/binstub"
+          end
+        end
+      CODE
 
       OLD_BINSTUB = %{if !Process.respond_to?(:fork) || Gem::Specification.find_all_by_name("spring").empty?}
 
       BINSTUB_VARIATIONS = Regexp.union [
-        %{begin\n  load File.expand_path("../spring", __FILE__)\nrescue LoadError\nend\n},
+        %{load File.expand_path("spring", __dir__)\n},
+        %{begin\n  load File.expand_path('../spring', __FILE__)\nrescue LoadError => e\n  raise unless e.message.include?('spring')\nend\n},
         %{begin\n  load File.expand_path('../spring', __FILE__)\nrescue LoadError\nend\n},
         %{begin\n  spring_bin_path = File.expand_path('../spring', __FILE__)\n  load spring_bin_path\nrescue LoadError => e\n  raise unless e.message.end_with? spring_bin_path, 'spring/binstub'\nend\n},
         LOADER
-      ]
+      ].map { |binstub| /#{Regexp.escape(binstub).gsub("'", "['\"]")}/ }
 
       class Item
         attr_reader :command, :existing
@@ -79,7 +71,7 @@ CODE
               generate(fallback)
               status "upgraded"
             elsif existing.include?(LOADER)
-              status "spring already present"
+              status "Spring already present"
             elsif existing =~ BINSTUB_VARIATIONS
               upgraded = existing.sub(BINSTUB_VARIATIONS, LOADER)
               File.write(command.binstub, upgraded)
@@ -94,15 +86,15 @@ CODE
                 end
 
                 File.write(command.binstub, "#{head}#{shebang}#{LOADER}#{tail}")
-                status "spring inserted"
+                status "Spring inserted"
               else
-                status "doesn't appear to be ruby, so cannot use spring", $stderr
+                status "doesn't appear to be ruby, so cannot use Spring", $stderr
                 exit 1
               end
             end
           else
             generate
-            status "generated with spring"
+            status "generated with Spring"
           end
         end
 
@@ -119,7 +111,7 @@ CODE
         def remove
           if existing
             File.write(command.binstub, existing.sub(BINSTUB_VARIATIONS, ""))
-            status "spring removed"
+            status "Spring removed"
           end
         end
       end
@@ -127,7 +119,7 @@ CODE
       attr_reader :bindir, :items
 
       def self.description
-        "Generate spring based binstubs. Use --all to generate a binstub for all known commands. Use --remove to revert."
+        "Generate Spring based binstubs. Use --all to generate a binstub for all known commands. Use --remove to revert."
       end
 
       def self.rails_command
@@ -147,7 +139,7 @@ CODE
         @mode   = :add
         @items  = args.drop(1)
                       .map { |name| find_commands name }
-                      .inject(Set.new, :|)
+                      .flatten.uniq
                       .map { |command| Item.new(command) }
       end
 

data/lib/spring/client/help.rb

@@ -32,7 +32,7 @@ module Spring
       def formatted_help
         ["Version: #{env.version}\n",
          "Usage: spring COMMAND [ARGS]\n",
-         *command_help("spring itself", spring_commands),
+         *command_help("Spring itself", spring_commands),
          '',
          *command_help("your application", application_commands)].join("\n")
       end

data/lib/spring/client/rails.rb

@@ -1,9 +1,7 @@
-require "set"
-
 module Spring
   module Client
     class Rails < Command
-      COMMANDS = Set.new %w(console runner generate destroy test)
+      COMMANDS = %w(console runner generate destroy test)
 
       ALIASES = {
         "c" => "console",
@@ -14,7 +12,7 @@ module Spring
       }
 
       def self.description
-        "Run a rails command. The following sub commands will use spring: #{COMMANDS.to_a.join ', '}."
+        "Run a rails command. The following sub commands will use Spring: #{COMMANDS.to_a.join ', '}."
       end
 
       def call
@@ -22,6 +20,8 @@ module Spring
 
         if COMMANDS.include?(command_name)
           Run.call(["rails_#{command_name}", *args.drop(2)])
+        elsif command_name&.start_with?("db:") && !command_name.start_with?("db:system")
+          Run.call(["rake", *args.drop(1)])
         else
           require "spring/configuration"
           ARGV.shift

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
 
@@ -44,7 +42,7 @@ module Spring
         require "spring/commands"
 
         if Spring.command?(args.first)
-          # Command installed since spring started
+          # Command installed since Spring started
           stop_server
           cold_run
         else
@@ -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,9 +120,18 @@ 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 " \
+          $stderr.puts "There is a version mismatch between the Spring client " \
                          "(#{env.version}) and the server (#{server_version})."
 
           if server_booted?
@@ -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"
@@ -142,12 +157,17 @@ module Spring
       end
 
       def run_command(client, application)
-        log "sending command"
-
         application.send_io STDOUT
         application.send_io STDERR
         application.send_io STDIN
 
+        log "waiting for the application to be preloaded"
+        preload_status = application.gets
+        preload_status = preload_status.chomp if preload_status
+        log "app preload status: #{preload_status}"
+        exit 1 if preload_status == "1"
+
+        log "sending command"
         send_json application, "args" => args, "env" => ENV.to_hash
 
         pid = server.gets
@@ -161,6 +181,8 @@ module Spring
         if pid && !pid.empty?
           log "got pid: #{pid}"
 
+          suspend_resume_on_tstp_cont(pid)
+
           forward_signals(application)
           status = application.read.to_i
 
@@ -181,6 +203,18 @@ module Spring
         end
       end
 
+      def suspend_resume_on_tstp_cont(pid)
+        trap("TSTP") {
+          log "suspended"
+          Process.kill("STOP", pid.to_i)
+          Process.kill("STOP", Process.pid)
+        }
+        trap("CONT") {
+          log "resumed"
+          Process.kill("CONT", pid.to_i)
+        }
+      end
+
       def forward_signals(application)
         @signal_queue.each { |sig| kill sig, application }
 
@@ -213,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/client/stop.rb

@@ -4,7 +4,7 @@ module Spring
   module Client
     class Stop < Command
       def self.description
-        "Stop all spring processes for this project."
+        "Stop all Spring processes for this project."
       end
 
       def call

data/lib/spring/commands.rb

@@ -28,11 +28,18 @@ module Spring
   config = File.expand_path("~/.spring.rb")
   require config if File.exist?(config)
 
-  # If the config/spring.rb contains requires for commands from other gems,
-  # then we need to be under bundler.
-  require "bundler/setup"
+  # We force the TTY so bundler doesn't show a backtrace in case gems are missing.
+  old_env = ENV["BUNDLER_FORCE_TTY"]
+  ENV["BUNDLER_FORCE_TTY"] = "true"
+  begin
+    # If the config/spring.rb contains requires for commands from other gems,
+    # then we need to be under bundler.
+    require "bundler/setup"
+  ensure
+    ENV["BUNDLER_FORCE_TTY"] = old_env
+  end
 
-  # Auto-require any spring extensions which are in the Gemfile
+  # Auto-require any Spring extensions which are in the Gemfile
   Gem::Specification.map(&:name).grep(/^spring-/).each do |command|
     begin
       require command

data/lib/spring/configuration.rb

@@ -1,11 +1,30 @@
 require "spring/errors"
 
 module Spring
+  @connect_timeout = 5
+  @boot_timeout = 20
+
   class << self
-    attr_accessor :application_root, :quiet
+    attr_accessor :application_root, :connect_timeout, :boot_timeout
+    attr_writer :quiet
 
     def gemfile
-      ENV['BUNDLE_GEMFILE'] || "Gemfile"
+      require "bundler"
+
+      if /\s1.9.[0-9]/ ===  Bundler.ruby_scope.gsub(/[\/\s]+/,'')
+        Pathname.new(ENV["BUNDLE_GEMFILE"] || "Gemfile").expand_path
+      else
+        Bundler.default_gemfile
+      end
+    end
+
+    def gemfile_lock
+      case gemfile.to_s
+      when /\bgems\.rb\z/
+        gemfile.sub_ext('.locked')
+      else
+        gemfile.sub_ext('.lock')
+      end
     end
 
     def after_fork_callbacks
@@ -16,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
@@ -37,6 +64,10 @@ module Spring
       @project_root_path ||= find_project_root(Pathname.new(File.expand_path(Dir.pwd)))
     end
 
+    def quiet
+      @quiet || ENV.key?('SPRING_QUIET')
+    end
+
     private
 
     def find_project_root(current_dir)

data/lib/spring/env.rb

@@ -1,10 +1,6 @@
 require "pathname"
-require "fileutils"
-require "digest/md5"
-require "tmpdir"
 
 require "spring/version"
-require "spring/sid"
 require "spring/configuration"
 
 module Spring
@@ -33,15 +29,18 @@ module Spring
     end
 
     def tmp_path
+      require "tmpdir"
       path = Pathname.new(
         ENV["SPRING_TMP_PATH"] ||
           File.join(ENV['XDG_RUNTIME_DIR'] || Dir.tmpdir, "spring-#{Process.uid}")
       )
+      require "fileutils"
       FileUtils.mkdir_p(path) unless path.exist?
       path
     end
 
     def application_id
+      require "digest/md5"
       ENV["SPRING_APPLICATION_ID"] || Digest::MD5.hexdigest(RUBY_VERSION + project_root.to_s)
     end
 

data/lib/spring/errors.rb

@@ -24,7 +24,7 @@ module Spring
 
     def message
       "Spring was unable to find your config/application.rb file. " \
-        "Your project root was detected at #{project_root}, so spring " \
+        "Your project root was detected at #{project_root}, so Spring " \
         "looked for #{project_root}/config/application.rb but it doesn't exist. You can " \
         "configure the root of your application by setting Spring.application_root in " \
         "config/spring.rb."

data/lib/spring/json.rb

@@ -46,11 +46,9 @@ end
 
 # See https://github.com/kr/okjson for updates.
 
-require 'stringio'
-
 # Some parts adapted from
-# http://golang.org/src/pkg/json/decode.go and
-# http://golang.org/src/pkg/utf8/utf8.go
+# https://golang.org/src/pkg/json/decode.go and
+# https://golang.org/src/pkg/utf8/utf8.go
 module Spring
 module OkJson
   Upstream = '43'
@@ -468,19 +466,18 @@ private
 
 
   def strenc(s)
-    t = StringIO.new
-    t.putc(?")
+    t = '"'.b
     r = 0
 
     while r < s.length
       case s[r]
-      when ?"  then t.print('\\"')
-      when ?\\ then t.print('\\\\')
-      when ?\b then t.print('\\b')
-      when ?\f then t.print('\\f')
-      when ?\n then t.print('\\n')
-      when ?\r then t.print('\\r')
-      when ?\t then t.print('\\t')
+      when ?"  then t << '\\"'
+      when ?\\ then t << '\\\\'
+      when ?\b then t << '\\b'
+      when ?\f then t << '\\f'
+      when ?\n then t << '\\n'
+      when ?\r then t << '\\r'
+      when ?\t then t << '\\t'
       else
         c = s[r]
         # In ruby >= 1.9, s[r] is a codepoint, not a byte.
@@ -490,14 +487,14 @@ private
             if c.ord < Spc.ord
               c = "\\u%04x" % [c.ord]
             end
-            t.write(c)
+            t << c
           rescue
-            t.write(Ustrerr)
+            t << Ustrerr
           end
         elsif c < Spc
-          t.write("\\u%04x" % c)
+          t << "\\u%04x" % c
         elsif Spc <= c && c <= ?~
-          t.putc(c)
+          t << c
         else
           n = ucharcopy(t, s, r) # ensure valid UTF-8 output
           r += n - 1 # r is incremented below
@@ -505,8 +502,8 @@ private
       end
       r += 1
     end
-    t.putc(?")
-    t.string
+    t << '"'
+    t
   end
 
 
@@ -531,7 +528,7 @@ private
 
     # 1-byte, 7-bit sequence?
     if c0 < Utagx
-      t.putc(c0)
+      t << c0
       return 1
     end
 
@@ -544,8 +541,8 @@ private
     # 2-byte, 11-bit sequence?
     if c0 < Utag3
       raise Utf8Error if ((c0&Umask2)<<6 | (c1&Umaskx)) <= Uchar1max
-      t.putc(c0)
-      t.putc(c1)
+      t << c0
+      t << c1
       return 2
     end
 
@@ -559,9 +556,9 @@ private
     if c0 < Utag4
       u = (c0&Umask3)<<12 | (c1&Umaskx)<<6 | (c2&Umaskx)
       raise Utf8Error if u <= Uchar2max
-      t.putc(c0)
-      t.putc(c1)
-      t.putc(c2)
+      t << c0
+      t << c1
+      t << c2
       return 3
     end
 
@@ -574,16 +571,16 @@ private
     if c0 < Utag5
       u = (c0&Umask4)<<18 | (c1&Umaskx)<<12 | (c2&Umaskx)<<6 | (c3&Umaskx)
       raise Utf8Error if u <= Uchar3max
-      t.putc(c0)
-      t.putc(c1)
-      t.putc(c2)
-      t.putc(c3)
+      t << c0
+      t << c1
+      t << c2
+      t << c3
       return 4
     end
 
     raise Utf8Error
   rescue Utf8Error
-    t.write(Ustrerr)
+    t << Ustrerr
     return 1
   end
 

data/lib/spring/process_title_updater.rb

@@ -1,6 +1,6 @@
 module Spring
   # Yes, I know this reimplements a bunch of stuff in Active Support, but
-  # I don't want the spring client to depend on AS, in order to keep its
+  # I don't want the Spring client to depend on AS, in order to keep its
   # load time down.
   class ProcessTitleUpdater
     SECOND = 1

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,15 +78,16 @@ 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.
     # This will cause it to be automatically killed once the session
     # ends (i.e. when the user closes their terminal).
     def set_pgid
-      Process.setpgid(0, SID.pgid)
+      pgid = Process.getpgid(Process.getsid)
+      Process.setpgid(0, pgid)
     end
 
     # Ignore SIGINT and SIGQUIT otherwise the user typing ^C or ^\ on the command line
@@ -135,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 = "2.0.2"
+  VERSION = "4.2.1"
 end