spring 1.7.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85d4ab3b84aa6f12fb90e262bcd8adf394cb94ef
-  data.tar.gz: 69c83b9fe81004f4c25b9a429bd1222316e1d25e
+SHA256:
+  metadata.gz: 90758ca717a756e672dfeaaf8295f17fcfa38f3ea3bc8bd27093a4354d45b82f
+  data.tar.gz: 82533f3a3e3f5dc53c3f89d3b2734557bfefcf06b5cbe714238dba64160d56a3
 SHA512:
-  metadata.gz: 491bc17d5c922c974ebe995469c5ebaa099c95351067eab312dad022426feecc006e6dd2211955e390eabb2371392a99e8cdfa39f07dc5b6938f5de73a30d1a7
-  data.tar.gz: 61f6d055f6b22aa94858dbd82227c0c4edbbdd6631a933a8bd5b2ebb0499c3d9c8cff27f1d41c6dca115a084cb0ddbffedef133345385069c87df69673e44ed5
+  metadata.gz: 80d8a7138fa74ad857a43671e54234da3a9b6265727f170c21905694397ebe5ec9b1102dbce3098835157e49e808cbbc52d74e1894a228ab0b25e521987cc4ca
+  data.tar.gz: 4366760559dfa2bae19ce7478302b35ca050cd431e39241427dfb5666de3a4eb704039ccdc4b02634556041aba71cebe22a053f4553e63db9d7ecdfbb980bf66

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2016 Jon Leighton
+Copyright (c) 2012-2017 Jon Leighton
 
 MIT License
 

data/README.md

@@ -16,8 +16,9 @@ boot it every time you run a test, rake task or migration.
 
 ## Compatibility
 
-* Ruby versions: MRI 1.9.3, MRI 2.0, MRI 2.1, MRI 2.2
-* Rails versions: 4.0+ (in Rails 4.1 and up Spring is included by default)
+* Ruby versions: MRI 2.4, MRI 2.5, MRI 2.6
+* Rails versions: 4.2, 5.0, 5.1, 5.2, 6.0 (Spring is installed by default when you do
+  `rails new` to generate your application)
 
 Spring makes extensive use of `Process.fork`, so won't be able to
 provide a speed up on platforms which don't support forking (Windows, JRuby).
@@ -26,14 +27,14 @@ provide a speed up on platforms which don't support forking (Windows, JRuby).
 
 ### Setup
 
-Add spring to your Gemfile:
+Add Spring to your Gemfile:
 
 ``` ruby
 gem "spring", group: :development
 ```
 
 (Note: using `gem "spring", git: "..."` *won't* work and is not a
-supported way of using spring.)
+supported way of using Spring.)
 
 It's recommended to 'springify' the executables in your `bin/`
 directory:
@@ -53,13 +54,13 @@ rescue LoadError
 end
 ```
 
-On platforms where spring is installed and supported, this snippet
-hooks spring into the execution of commands. In other cases, the snippet
+On platforms where Spring is installed and supported, this snippet
+hooks Spring into the execution of commands. In other cases, the snippet
 will just be silently ignored and the lines after it will be executed as
 normal.
 
 If you don't want to prefix every command you type with `bin/`, you
-can [use direnv](https://github.com/zimbatm/direnv#the-stdlib) to
+can [use direnv](https://github.com/direnv/direnv#the-stdlib) to
 automatically add `./bin` to your `PATH` when you `cd` into your application.
 Simply create an `.envrc` file with the command `PATH_add bin` in your
 Rails directory.
@@ -89,7 +90,7 @@ user    0m0.281s
 sys     0m0.066s
 ```
 
-That wasn't particularly fast because it was the first run, so spring
+That wasn't particularly fast because it was the first run, so Spring
 had to boot the application. It's now running:
 
 ```
@@ -166,7 +167,7 @@ Spring is running:
 26707 spring app    | spring-demo-app | started 2 secs ago | development mode
 ```
 
-There's no need to "shut down" spring. This will happen automatically
+There's no need to "shut down" Spring. This will happen automatically
 when you close your terminal. However if you do want to do a manual shut
 down, use the `stop` command:
 
@@ -175,9 +176,11 @@ $ bin/spring stop
 Spring stopped.
 ```
 
+From within your code, you can check whether Spring is active with `if defined?(Spring)`.
+
 ### Removal
 
-To remove spring:
+To remove Spring:
 
 * 'Unspring' your bin/ executables: `bin/spring binstub --remove --all`
 * Remove spring from your Gemfile
@@ -215,7 +218,7 @@ Spring::Commands::Rake.environment_matchers[:default] = "development"
 ### `rails console`, `rails generate`, `rails runner`
 
 These execute the rails command you already know and love. If you run
-a different sub command (e.g. `rails server`) then spring will automatically
+a different sub command (e.g. `rails server`) then Spring will automatically
 pass it through to the underlying `rails` executable (without the
 speed-up).
 
@@ -229,18 +232,21 @@ You can add these to your Gemfile for additional commands:
 * [spring-commands-testunit](https://github.com/jonleighton/spring-commands-testunit) - useful for
   running `Test::Unit` tests on Rails 3, since only Rails 4 allows you
   to use `rake test path/to/test` to run a particular test/directory.
+* [spring-commands-parallel-tests](https://github.com/DocSpring/spring-commands-parallel-tests) - Adds the `parallel_*` commands from [`parallel_tests`](https://github.com/grosser/parallel_tests).
 * [spring-commands-teaspoon](https://github.com/alejandrobabio/spring-commands-teaspoon.git)
 * [spring-commands-m](https://github.com/gabrieljoelc/spring-commands-m.git)
 * [spring-commands-rubocop](https://github.com/p0deje/spring-commands-rubocop)
+* [spring-commands-rackup](https://github.com/wintersolutions/spring-commands-rackup)
+* [spring-commands-rack-console](https://github.com/wintersolutions/spring-commands-rack-console)
 
 ## Use without adding to bundle
 
-If you don't want spring-related code checked into your source
-repository, it's possible to use spring without adding to your Gemfile.
-However, using spring binstubs without adding spring to the Gemfile is not
+If you don't want Spring-related code checked into your source
+repository, it's possible to use Spring without adding to your Gemfile.
+However, using Spring binstubs without adding Spring to the Gemfile is not
 supported.
 
-To use spring like this, do a `gem install spring` and then prefix
+To use Spring like this, do a `gem install spring` and then prefix
 commands with `spring`. For example, rather than running `bin/rake -T`,
 you'd run `spring rake -T`.
 
@@ -396,14 +402,14 @@ The following environment variables are used by Spring:
   the long-running Spring server process. By default this is related to
   the socket path; if the socket path is `/foo/bar/spring.sock` the
   pidfile will be `/foo/bar/spring.pid`.
-* `SPRING_SERVER_COMMAND` - The command to run to start up the spring
+* `SPRING_SERVER_COMMAND` - The command to run to start up the Spring
   server when it is not already running. Defaults to `spring _[version]_
   server --background`.
 
 ## Troubleshooting
 
-If you want to get more information about what spring is doing, you can
-run spring explicitly in a separate terminal:
+If you want to get more information about what Spring is doing, you can
+run Spring explicitly in a separate terminal:
 
 ```
 $ spring server

data/lib/spring/application.rb

@@ -66,7 +66,17 @@ module Spring
 
     def start_watcher
       @watcher = Spring.watcher
-      @watcher.on_stale { state! :watcher_stale }
+
+      @watcher.on_stale do
+        state! :watcher_stale
+      end
+
+      if @watcher.respond_to? :on_debug
+        @watcher.on_debug do |message|
+          spring_env.log "[watcher:#{app_env}] #{message}"
+        end
+      end
+
       @watcher.start
     end
 
@@ -81,6 +91,10 @@ module Spring
 
       require Spring.application_root_path.join("config", "application")
 
+      unless Rails.respond_to?(:gem_version) && Rails.gem_version >= Gem::Version.new('4.2.0')
+        raise "Spring only supports Rails >= 4.2.0"
+      end
+
       # config/environments/test.rb will have config.cache_classes = true. However
       # we want it to be false so that we can reload files. This is a hack to
       # override the effect of config.cache_classes = true. We can then actually
@@ -137,7 +151,7 @@ module Spring
       log "got client"
       manager.puts
 
-      stdout, stderr, stdin = streams = 3.times.map { client.recv_io }
+      _stdout, stderr, _stdin = streams = 3.times.map { client.recv_io }
       [STDOUT, STDERR, STDIN].zip(streams).each { |a, b| a.reopen(b) }
 
       preload unless preloaded?
@@ -158,20 +172,35 @@ module Spring
         end
       end
 
+      # Ensure we boot the process in the directory the command was called from,
+      # not from the directory Spring started in
+      original_dir = Dir.pwd
+      Dir.chdir(env['PWD'] || original_dir)
+
       pid = fork {
         Process.setsid
         IGNORE_SIGNALS.each { |sig| trap(sig, "DEFAULT") }
         trap("TERM", "DEFAULT")
 
-        STDERR.puts "Running via Spring preloader in process #{Process.pid}" unless Spring.quiet
+        unless Spring.quiet
+          STDERR.puts "Running via Spring preloader in process #{Process.pid}"
+
+          if Rails.env.production?
+            STDERR.puts "WARNING: Spring is running in production. To fix "         \
+                        "this make sure the spring gem is only present "            \
+                        "in `development` and `test` groups in your Gemfile "       \
+                        "and make sure you always use "                             \
+                        "`bundle install --without development test` in production"
+          end
+        end
 
         ARGV.replace(args)
         $0 = command.exec_name
 
-        # Delete all env vars which are unchanged from before spring started
+        # Delete all env vars which are unchanged from before Spring started
         original_env.each { |k, v| ENV.delete k if ENV[k] == v }
 
-        # Load in the current env vars, except those which *were* changed when spring started
+        # Load in the current env vars, except those which *were* changed when Spring started
         env.each { |k, v| ENV[k] ||= v }
 
         # requiring is faster, so if config.cache_classes was true in
@@ -192,7 +221,6 @@ module Spring
       }
 
       disconnect_database
-      reset_streams
 
       log "forked #{pid}"
       manager.puts pid
@@ -209,6 +237,12 @@ module Spring
 
       client.puts(1) if pid
       client.close
+    ensure
+      # Redirect STDOUT and STDERR to prevent from keeping the original FDs
+      # (i.e. to prevent `spring rake -T | grep db` from hanging forever),
+      # even when exception is raised before forking (i.e. preloading).
+      reset_streams
+      Dir.chdir(original_dir)
     end
 
     def terminate
@@ -291,9 +325,13 @@ module Spring
     def with_pty
       PTY.open do |master, slave|
         [STDOUT, STDERR, STDIN].each { |s| s.reopen slave }
-        Thread.new { master.read }
-        yield
-        reset_streams
+        reader_thread = Spring.failsafe_thread { master.read }
+        begin
+          yield
+        ensure
+          reader_thread.kill
+          reset_streams
+        end
       end
     end
 

data/lib/spring/application_manager.rb

@@ -7,6 +7,7 @@ module Spring
       @spring_env = spring_env
       @mutex      = Mutex.new
       @state      = :running
+      @pid        = nil
     end
 
     def log(message)
@@ -92,7 +93,8 @@ module Spring
     def start_child(preload = false)
       @child, child_socket = UNIXSocket.pair
 
-      Bundler.with_clean_env do
+      Bundler.with_original_env do
+        bundler_dir = File.expand_path("../..", $LOADED_FEATURES.grep(/bundler\/setup\.rb$/).first)
         @pid = Process.spawn(
           {
             "RAILS_ENV"           => app_env,
@@ -101,7 +103,7 @@ module Spring
             "SPRING_PRELOAD"      => preload ? "1" : "0"
           },
           "ruby",
-          "-I", File.expand_path("../..", $LOADED_FEATURES.grep(/bundler\/setup\.rb$/).first),
+          *(bundler_dir != RbConfig::CONFIG["rubylibdir"] ? ["-I", bundler_dir] : []),
           "-I", File.expand_path("../..", __FILE__),
           "-e", "require 'spring/application/boot'",
           3 => child_socket,

data/lib/spring/client/binstub.rb

@@ -3,11 +3,11 @@ 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.
@@ -23,23 +23,21 @@ CODE
       # 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.
-      #
-      # Parsing the lockfile in this way is pretty nasty but reliable enough
-      # The regex ensures that the match must be between a GEM line and an empty
-      # line, so it won't go on to the next section.
       SPRING = <<'CODE'
 #!/usr/bin/env ruby
 
-# This file loads spring without using Bundler, in order to be fast.
+# 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'
 
-  if (match = Bundler.default_lockfile.read.match(/^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m))
-    Gem.paths = { 'GEM_PATH' => [Bundler.bundle_path.to_s, *Gem.path].uniq.join(Gem.path_separator) }
-    gem 'spring', match[1]
+  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
@@ -48,11 +46,10 @@ 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},
         %{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
@@ -81,7 +78,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)
@@ -96,15 +93,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
 
@@ -121,7 +118,7 @@ CODE
         def remove
           if existing
             File.write(command.binstub, existing.sub(BINSTUB_VARIATIONS, ""))
-            status "spring removed"
+            status "Spring removed"
           end
         end
       end
@@ -129,7 +126,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

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

@@ -14,7 +14,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

data/lib/spring/client/run.rb

@@ -44,7 +44,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
@@ -116,7 +116,7 @@ module Spring
       def verify_server_version
         server_version = server.gets.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?
@@ -161,6 +161,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 +183,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 }