spring 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8e020e7dc1eb3f27faa79634ad8c9ff4e9c1ddb
-  data.tar.gz: 5bd55b0c1e659701f4cd61afaba2b854070bc482
+  metadata.gz: 0bae3c5f77134086e25e77df5d700895438e16ba
+  data.tar.gz: 882c5139fed3fe573bb75136e683ca8ee3744069
 SHA512:
-  metadata.gz: ebecedcb2e4a616615dc33a752e54a380f685e9d43227f67a5c3a0f29ae8c500df20ab75705778e13f2efa5c52d51f4ed682472eda7b12006e3720a762232dd9
-  data.tar.gz: 349a6b90ba96409a80e90a14e5bc39d7057970d3a6a81eb8fe7e6c6b7cd48aebc7465d687ffd08b704a3977cc0c3405a72cc93521b022fd54ef7a13a154ba3e8
+  metadata.gz: c5d7a1655a09f56c5663024af741c3c58fe9542418603a59dddb0c19ee24203a1527911a4626f6a5eedd5daf5b6e19b1107582fdc2c7528563af1878034cf1a7
+  data.tar.gz: d143cad1d9b6f15440d80aa300b566a4fa19c0c90deada7fa627e3b230f9199ed56eae911c0005fa2ff83814bf3e66190777a42e0bb4cf5ee6d997df9d06b297

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/.travis.yml

@@ -2,8 +2,10 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.2
 env:
   - RAILS_VERSION="~> 3.2.0"
   - RAILS_VERSION="~> 4.0.0"
-  - RAILS_VERSION="~> 4.1.0.beta1"
+  - RAILS_VERSION="~> 4.1.0"
+before_script:
+  - travis_retry gem install rails --version "$RAILS_VERSION"

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## 1.2.0
+
+* Accept -e and --environment options for `rails console`.
+* Watch `config/secrets.yml` by default. #289 - @morgoth
+* Change monkey-patched `Kernel.raise` from public to private (to match default Ruby behavior) #351 - @mattbrictson
+* Let application_id also respect RUBY_VERSION for the use case of switching between Ruby versions for a given Rails app - @methodmissing
+* Extract the 'listen' watcher to a separate `spring-watcher-listen`
+  gem. This allows it to be developed/maintained separately.
+
+## 1.1.3
+
+* The `rails runner` command no longer passes environment switches to
+  files which it runs. Issue #272.
+* Various issues solved to do with termination / processes hanging around
+  longer than they should. Issue #290.
+
+## 1.1.2
+
+* Detect old binstubs generated with Spring 1.0 and exit with an error.
+  This prevents a situation where you can get stuck in an infinite loop
+  of spring invocations.
+* Avoid `warning: already initialized constant APP_PATH` when running
+  rails commands that do not use spring (e.g. `bin/rails server` would
+  emit this when you ^C to exit)
+* Fix `reload!` in rails console
+* Don't connect/disconnect the database if there are no connections
+  configured. Issue #256.
+
 ## 1.1.1
 
 * Fix `$0` so that it is no longer prefixed with "spring ", as doing

data/CONTRIBUTING.md

@@ -1,3 +1,8 @@
+# Don't use the issue tracker to ask questions
+
+Please use Stack Overflow or similar. If you subsequently feel that the
+documentation is inadequate then plase submit a pull request to fix it.
+
 # Contributing guide
 
 ## Getting set up
@@ -30,3 +35,18 @@ $ RAILS_VERSION="~> 3.2.0" rake test:acceptance
 
 The apps in `test/apps` will be named based on the rails version and the
 spring version.
+
+## Testing with your app
+
+You cannot link to a git repo from your Gemfile. Spring doesn't support
+this due to the way that it gets loaded (bypassing bundler for
+performance reasons).
+
+Therefore, to test changes with your app, run `rake install` to properly
+install the gem on your system.
+
+## Submitting a pull request
+
+If your change is a bugfix or feature, please make sure you add to
+`CHANGELOG.md` under the "Next Release" heading (add the heading if
+needed).

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in spring.gemspec
 gemspec
-
-gem 'listen', "~> 1.0", :require => false

data/README.md

@@ -7,8 +7,6 @@ Spring is a Rails application preloader. It speeds up development by
 keeping your application running in the background so you don't need to
 boot it every time you run a test, rake task or migration.
 
-**Upgrading to 1.1? It's recommended to run `bundle exec spring binstub --all` to regenerate your binstubs.**
-
 ## Features
 
 * Totally automatic; no need to explicitly start and stop the background process
@@ -19,7 +17,7 @@ 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
-* Rails versions: 3.2, 4.0
+* Rails versions: 3.2, 4.0 (in Rails 4.1 and up Spring is included by default)
 
 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).
@@ -34,6 +32,9 @@ Add spring to your Gemfile:
 gem "spring", group: :development
 ```
 
+(Note: using `gem "spring", git: "..."` *won't* work and is not a
+supported way of using spring.)
+
 It's recommended to 'springify' the executables in your `bin/`
 directory:
 
@@ -58,8 +59,10 @@ 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) to automatically add
-`./bin` to your `PATH` when you `cd` into your application.
+can [use direnv](https://github.com/zimbatm/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.
 
 ### Usage
 
@@ -176,6 +179,17 @@ To remove spring:
 * 'Unspring' your bin/ executables: `bin/spring binstub --remove --all`
 * Remove spring from your Gemfile
 
+### Deployment
+
+You must not install Spring on your production environment. To prevent it from
+being installed, provide the `--without development test` argument to the
+`bundle install` command which is used to install gems on your production
+machines:
+
+```
+$ bundle install --without development test
+```
+
 ## Commands
 
 ### `rake`
@@ -209,9 +223,11 @@ to pick up the changes):
 
 * [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)
 * [spring-commands-cucumber](https://github.com/jonleighton/spring-commands-cucumber)
+* [spring-commands-spinach](https://github.com/jvanbaarsen/spring-commands-spinach)
 * [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-teaspoon](https://github.com/alejandrobabio/spring-commands-teaspoon.git)
 
 ## Use without adding to bundle
 
@@ -294,7 +310,7 @@ Spring.application_root = './test/dummy'
 
 There is no `Spring.before_fork` callback. To run something before the
 fork, you can place it in `~/.spring.rb` or `config/spring.rb` or in any of the files
-which get run when your application initializers, such as
+which get run when your application initializes, such as
 `config/application.rb`, `config/environments/*.rb` or
 `config/initializers/*.rb`.
 
@@ -323,18 +339,15 @@ If there are additional files or directories which should trigger an
 application restart, you can specify them with `Spring.watch`:
 
 ```ruby
-Spring.watch "spec/factories"
+Spring.watch "config/some_config_file.yml"
 ```
 
 By default Spring polls the filesystem for changes once every 0.2 seconds. This
 method requires zero configuration, but if you find that it's using too
-much CPU, then you can turn on event-based file system listening:
-
-```ruby
-Spring.watch_method = :listen
-```
-
-You may need to add the [`listen` gem](https://github.com/guard/listen) to your `Gemfile`.
+much CPU, then you can use event-based file system listening by
+installing the
+[spring-watcher-listen](https://github.com/jonleighton/spring-watcher-listen)
+gem.
 
 ## Troubleshooting
 

data/Rakefile

@@ -10,7 +10,7 @@ namespace :test do
 
   Rake::TestTask.new(:acceptance) do |t|
     t.libs << "test"
-    t.test_files = FileList["test/acceptance/*_test.rb"]
+    t.test_files = FileList["test/acceptance_test.rb"]
     t.verbose = true
   end
 

data/bin/spring

@@ -1,5 +1,21 @@
 #!/usr/bin/env ruby
 
+if defined?(Spring)
+  $stderr.puts "You've tried to invoke Spring when it's already loaded (i.e. the Spring " \
+               "constant is defined)."
+  $stderr.puts
+  $stderr.puts "This is probably because you generated binstubs with " \
+               "Spring 1.0, and you now have a Spring version > 1.0 on your system. To solve " \
+               "this, upgrade your bundle to the latest Spring version and then run " \
+               "`bundle exec spring binstub --all` to regenerate your binstubs. This is a one-time " \
+               "step necessary to upgrade from 1.0 to 1.1."
+  $stderr.puts
+  $stderr.puts "Here's the backtrace:"
+  $stderr.puts
+  $stderr.puts caller
+  exit 1
+end
+
 if defined?(Gem)
   if Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.1.0")
     warn "Warning: You're using Rubygems #{Gem::VERSION} with Spring. " \

data/lib/spring/application.rb

@@ -11,7 +11,7 @@ module Spring
       @original_env = original_env
       @spring_env   = Env.new
       @mutex        = Mutex.new
-      @waiting      = 0
+      @waiting      = Set.new
       @preloaded    = false
       @state        = :initialized
       @interrupt    = IO.pipe
@@ -91,7 +91,9 @@ module Spring
 
       require Spring.application_root_path.join("config", "environment")
 
+      @original_cache_classes = Rails.application.config.cache_classes
       Rails.application.config.cache_classes = false
+
       disconnect_database
 
       @preloaded = :success
@@ -106,6 +108,9 @@ module Spring
       if defined?(Rails) && Rails.application
         watcher.add Rails.application.paths["config/initializers"]
         watcher.add Rails.application.paths["config/database"]
+        if secrets_path = Rails.application.paths["config/secrets"]
+          watcher.add secrets_path
+        end
       end
     end
 
@@ -161,9 +166,13 @@ module Spring
         # Load in the current env vars, except those which *were* changed when spring started
         env.each { |k, v| ENV[k] ||= v }
 
-        # requiring is faster, and we don't need constant reloading in this process
-        ActiveSupport::Dependencies.mechanism = :require
-        Rails.application.config.cache_classes = true
+        # requiring is faster, so if config.cache_classes was true in
+        # the environment's config file, then we can respect that from
+        # here on as we no longer need constant reloading.
+        if @original_cache_classes
+          ActiveSupport::Dependencies.mechanism = :require
+          Rails.application.config.cache_classes = true
+        end
 
         connect_database
         srand
@@ -180,21 +189,7 @@ module Spring
       log "forked #{pid}"
       manager.puts pid
 
-      # Wait in a separate thread so we can run multiple commands at once
-      Thread.new {
-        @mutex.synchronize { @waiting += 1 }
-
-        _, status = Process.wait2 pid
-        log "#{pid} exited with #{status.exitstatus}"
-
-        streams.each(&:close)
-        client.puts(status.exitstatus)
-        client.close
-
-        @mutex.synchronize { @waiting -= 1 }
-        exit_if_finished
-      }
-
+      wait pid, streams, client
     rescue Exception => e
       log "exception: #{e}"
       manager.puts unless pid
@@ -209,7 +204,14 @@ module Spring
     end
 
     def terminate
-      state! :terminating
+      if exiting?
+        # Ensure that we do not ignore subsequent termination attempts
+        log "forced exit"
+        @waiting.each { |pid| Process.kill("TERM", pid) }
+        Kernel.exit
+      else
+        state! :terminating
+      end
     end
 
     def exit
@@ -221,7 +223,7 @@ module Spring
 
     def exit_if_finished
       @mutex.synchronize {
-        Kernel.exit if exiting? && @waiting == 0
+        Kernel.exit if exiting? && @waiting.empty?
       }
     end
 
@@ -246,11 +248,11 @@ module Spring
     end
 
     def disconnect_database
-      ActiveRecord::Base.remove_connection if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.remove_connection if active_record_configured?
     end
 
     def connect_database
-      ActiveRecord::Base.establish_connection if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.establish_connection if active_record_configured?
     end
 
     # This feels very naughty
@@ -268,6 +270,7 @@ module Spring
             end
           end
         end
+        private :raise
       end
     end
 
@@ -289,5 +292,30 @@ module Spring
       [STDOUT, STDERR].each { |stream| stream.reopen(spring_env.log_file) }
       STDIN.reopen("/dev/null")
     end
+
+    def wait(pid, streams, client)
+      @mutex.synchronize { @waiting << pid }
+
+      # Wait in a separate thread so we can run multiple commands at once
+      Thread.new {
+        begin
+          _, status = Process.wait2 pid
+          log "#{pid} exited with #{status.exitstatus}"
+
+          streams.each(&:close)
+          client.puts(status.exitstatus)
+          client.close
+        ensure
+          @mutex.synchronize { @waiting.delete pid }
+          exit_if_finished
+        end
+      }
+    end
+
+    private
+
+    def active_record_configured?
+      defined?(ActiveRecord::Base) && ActiveRecord::Base.configurations.any?
+    end
   end
 end

data/lib/spring/application_manager.rb

@@ -76,12 +76,15 @@ module Spring
     end
 
     def stop
+      log "stopping"
       @state = :stopping
 
       if pid
         Process.kill('TERM', pid)
         Process.wait(pid)
       end
+    rescue Errno::ESRCH, Errno::ECHILD
+      # Don't care
     end
 
     private

data/lib/spring/client/binstub.rb

@@ -36,7 +36,7 @@ unless defined?(Spring)
   require "rubygems"
   require "bundler"
 
-  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
+  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m)
     ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
     ENV["GEM_HOME"] = ""
     Gem.paths = ENV

data/lib/spring/client/rails.rb

@@ -25,6 +25,7 @@ module Spring
           require "spring/configuration"
           ARGV.shift
           load Dir.glob(Spring.application_root_path.join("{bin,script}/rails")).first
+          exit
         end
       end
     end

data/lib/spring/client/run.rb

@@ -5,6 +5,12 @@ module Spring
   module Client
     class Run < Command
       FORWARDED_SIGNALS = %w(INT QUIT USR1 USR2 INFO) & Signal.list.keys
+      TIMEOUT = 1
+
+      def initialize(args)
+        super
+        @signal_queue = []
+      end
 
       def log(message)
         env.log "[client] #{message}"
@@ -20,6 +26,7 @@ module Spring
 
         application, client = UNIXSocket.pair
 
+        queue_signals
         connect_to_application(client)
         run_command(client, application)
       rescue Errno::ECONNRESET
@@ -59,7 +66,12 @@ ERROR
       def connect_to_application(client)
         server.send_io client
         send_json server, "args" => args, "default_rails_env" => default_rails_env
-        server.gets or raise CommandNotFound
+
+        if IO.select([server], [], [], TIMEOUT)
+          server.gets or raise CommandNotFound
+        else
+          raise "Error connecting to Spring server"
+        end
       end
 
       def run_command(client, application)
@@ -96,14 +108,23 @@ ERROR
         application.close
       end
 
+      def queue_signals
+        FORWARDED_SIGNALS.each do |sig|
+          trap(sig) { @signal_queue << sig }
+        end
+      end
+
       def forward_signals(pid)
+        @signal_queue.each { |sig| kill sig, pid }
+
         FORWARDED_SIGNALS.each do |sig|
           trap(sig) { forward_signal sig, pid }
         end
+      rescue Errno::ESRCH
       end
 
       def forward_signal(sig, pid)
-        Process.kill(sig, -Process.getpgid(pid))
+        kill(sig, pid)
       rescue Errno::ESRCH
         # If the application process is gone, then don't block the
         # signal on this process.
@@ -111,6 +132,10 @@ ERROR
         Process.kill(sig, Process.pid)
       end
 
+      def kill(sig, pid)
+        Process.kill(sig, -Process.getpgid(pid))
+      end
+
       def send_json(socket, data)
         data = JSON.dump(data)
 

data/lib/spring/commands/rails.rb

@@ -13,7 +13,19 @@ module Spring
 
     class RailsConsole < Rails
       def env(args)
-        args.first if args.first && !args.first.index("-")
+        return args.first if args.first && !args.first.index("-")
+
+        environment = nil
+
+        args.each.with_index do |arg, i|
+          if arg =~ /--environment=(\w+)/
+            environment = $1
+          elsif i > 0 && args[i - 1] == "-e"
+            environment = arg
+          end
+        end
+
+        environment
       end
 
       def command_name
@@ -34,21 +46,41 @@ module Spring
     end
 
     class RailsRunner < Rails
-      def env(tail)
-        previous_option = nil
-        tail.reverse.each do |option|
-          case option
-          when /--environment=(\w+)/ then return $1
-          when '-e' then return previous_option
-          end
-          previous_option = option
-        end
-        nil
+      def call
+        ARGV.replace extract_environment(ARGV).first
+        super
+      end
+
+      def env(args)
+        extract_environment(args).last
       end
 
       def command_name
         "runner"
       end
+
+      def extract_environment(args)
+        environment = nil
+
+        args = args.select.with_index { |arg, i|
+          case arg
+          when "-e"
+            false
+          when /--environment=(\w+)/
+            environment = $1
+            false
+          else
+            if i > 0 && args[i - 1] == "-e"
+              environment = arg
+              false
+            else
+              true
+            end
+          end
+        }
+
+        [args, environment]
+      end
     end
 
     Spring.register_command "rails_console",  RailsConsole.new

data/lib/spring/commands.rb

@@ -32,8 +32,17 @@ module Spring
   # then we need to be under bundler.
   require "bundler/setup"
 
-  Gem::Specification.map(&:name).grep(/^spring-commands-/).each do |command|
-    require command
+  # Auto-require any spring extensions which are in the Gemfile
+  Gem::Specification.map(&:name).grep(/^spring-/).each do |command|
+    begin
+      require command
+    rescue LoadError => error
+      if error.message.include?(command)
+        require command.gsub("-", "/")
+      else
+        raise
+      end
+    end
   end
 
   config = File.expand_path("./config/spring.rb")

data/lib/spring/env.rb

@@ -16,7 +16,7 @@ module Spring
     def initialize(root = nil)
       @root         = root
       @project_root = root
-      @log_file     = File.open(ENV["SPRING_LOG"] || "/dev/null", "a")
+      @log_file     = File.open(ENV["SPRING_LOG"] || File::NULL, "a")
     end
 
     def root
@@ -32,13 +32,13 @@ module Spring
     end
 
     def tmp_path
-      path = Pathname.new(Dir.tmpdir + "/spring")
+      path = Pathname.new(File.join(ENV['XDG_RUNTIME_DIR'] || Dir.tmpdir, "spring"))
       FileUtils.mkdir_p(path) unless path.exist?
       path
     end
 
     def application_id
-      Digest::MD5.hexdigest(project_root.to_s)
+      Digest::MD5.hexdigest(RUBY_VERSION + project_root.to_s)
     end
 
     def socket_path

data/lib/spring/server.rb

@@ -92,6 +92,8 @@ module Spring
     end
 
     def shutdown
+      log "shutting down"
+
       [env.socket_path, env.pidfile_path].each do |path|
         if path.exist?
           path.unlink rescue nil

data/lib/spring/sid.rb

@@ -25,7 +25,7 @@ module Spring
         if Process.respond_to?(:getsid)
           # Ruby 2
           Process.getsid
-        elsif defined?(Fiddle)
+        elsif defined?(Fiddle) and defined?(DL)
           # Ruby 1.9.3 compiled with libffi support
           fiddle_func.call(0)
         else