spring 1.2.0 → 4.7.0

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,7 @@
 module Spring
   module JSON
     def self.load(string)
-      string.force_encoding("utf-8")
+      string = string.dup.force_encoding("utf-8") unless string.encoding == Encoding::UTF_8
       OkJson.decode(string)
     end
 
@@ -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'
@@ -366,7 +364,7 @@ private
             end
           end
           if rubydoesenc?
-            a[w] = '' << uchar
+            a[w] = +'' << uchar
             w += 1
           else
             w += ucharenc(a, w, uchar)
@@ -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
@@ -10,7 +10,7 @@ module Spring
     def self.run(&block)
       updater = new(&block)
 
-      Thread.new {
+      Spring.failsafe_thread {
         $0 = updater.value
         loop { $0 = updater.next }
       }

data/lib/spring/server.rb

@@ -10,19 +10,26 @@ require "spring/commands"
 
 module Spring
   class Server
-    def self.boot
-      new.boot
+    def self.boot(options = {})
+      new(options).boot
     end
 
     attr_reader :env
 
-    def initialize(env = Env.new)
-      @env          = env
-      @applications = Hash.new { |h, k| h[k] = ApplicationManager.new(k) }
+    def initialize(options = {})
+      @foreground   = options.fetch(:foreground, false)
+      @env          = options[:env] || default_env
+      @applications = Hash.new do |hash, key|
+        hash[key] = ApplicationManager.new(*key, env)
+      end
       @pidfile      = env.pidfile_path.open('a')
       @mutex        = Mutex.new
     end
 
+    def foreground?
+      @foreground
+    end
+
     def log(message)
       env.log "[server] #{message}"
     end
@@ -31,8 +38,8 @@ module Spring
       Spring.verify_environment
 
       write_pidfile
-      set_pgid
-      ignore_signals
+      set_pgid unless foreground?
+      ignore_signals unless foreground?
       set_exit_hook
       set_process_title
       start_server
@@ -42,6 +49,7 @@ module Spring
       server = UNIXServer.open(env.socket_name)
       log "started on #{env.socket_name}"
       loop { serve server.accept }
+    rescue Interrupt
     end
 
     def serve(client)
@@ -51,31 +59,37 @@ 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
       end
     rescue SocketError => e
       raise e unless client.eof?
+    rescue Errno::EPIPE => e
+      log "client disconnected with error #{e.message}, ignoring command"
     ensure
       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
@@ -100,7 +114,7 @@ module Spring
         end
       end
 
-      @applications.values.map { |a| Thread.new { a.stop } }.map(&:join)
+      @applications.values.map { |a| Spring.failsafe_thread { a.stop } }.map(&:join)
     end
 
     def write_pidfile
@@ -126,5 +140,23 @@ module Spring
         "spring server | #{env.app_name} | started #{distance} ago"
       }
     end
+
+    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
+
+    def default_log_file
+      if foreground? && !ENV["SPRING_LOG"]
+        $stdout
+      else
+        nil
+      end
+    end
   end
 end

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
 module Spring
-  VERSION = "1.2.0"
+  VERSION = "4.7.0"
 end

data/lib/spring/watcher/abstract.rb

@@ -1,6 +1,4 @@
-require "set"
 require "pathname"
-require "mutex_m"
 
 module Spring
   module Watcher
@@ -10,22 +8,36 @@ 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       = Set.new
-        @directories = Set.new
+        @files       = {}
+        @directories = {}
         @stale       = false
         @listeners   = []
+
+        @on_debug    = nil
+      end
+
+      def synchronize(&block)
+        # Used by some gems.
+        @mutex.synchronize(&block)
+      end
+
+      def on_debug(&block)
+        @on_debug = block
+      end
+
+      def debug
+        @on_debug.call(yield) if @on_debug
       end
 
       def add(*items)
+        debug { "watcher: add: #{items.inspect}" }
+
         items = items.flatten.map do |item|
           item = Pathname.new(item)
 
@@ -36,19 +48,35 @@ module Spring
           end
         end
 
-        items = items.select(&:exist?)
+        items = items.select do |item|
+          if item.symlink?
+            item.readlink.exist?.tap do |exists|
+              if !exists
+                debug { "add: ignoring dangling symlink: #{item.inspect} -> #{item.readlink.inspect}" }
+              end
+            end
+          else
+            item.exist?
+          end
+        end
 
-        synchronize {
+        @mutex.synchronize do
           items.each do |item|
             if item.directory?
-              directories << item.realpath.to_s
+              directories[item.realpath.to_s] = true
             else
-              files << item.realpath.to_s
+              begin
+                files[item.realpath.to_s] = true
+              rescue Errno::ENOENT
+                # Race condition. Ignore symlinks whose target was removed
+                # since the check above, or are deeply chained.
+                debug { "add: ignoring now-dangling symlink: #{item.inspect} -> #{item.readlink.inspect}" }
+              end
             end
           end
 
           subjects_changed
-        }
+        end
       end
 
       def stale?
@@ -56,16 +84,19 @@ module Spring
       end
 
       def on_stale(&block)
+        debug { "added listener: #{block.inspect}" }
         @listeners << block
       end
 
       def mark_stale
         return if stale?
         @stale = true
+        debug { "marked stale, calling listeners: listeners=#{@listeners.inspect}" }
         @listeners.each(&:call)
       end
 
       def restart
+        debug { "restarting" }
         stop
         start
       end

data/lib/spring/watcher/polling.rb

@@ -1,4 +1,4 @@
-require "spring/watcher"
+require "spring/watcher/abstract"
 
 module Spring
   module Watcher
@@ -12,7 +12,13 @@ module Spring
       end
 
       def check_stale
-        synchronize { mark_stale if mtime < compute_mtime }
+        @mutex.synchronize do
+          computed = compute_mtime
+          if mtime < computed
+            debug { "check_stale: mtime=#{mtime.inspect} < computed=#{computed.inspect}" }
+            mark_stale
+          end
+        end
       end
 
       def add(*)
@@ -21,40 +27,71 @@ module Spring
       end
 
       def start
+        debug { "start: poller=#{@poller.inspect}" }
         unless @poller
           @poller = Thread.new {
             Thread.current.abort_on_exception = true
 
-            loop do
-              Kernel.sleep latency
-              check_stale
+            begin
+              until stale?
+                Kernel.sleep latency
+                check_stale
+              end
+            rescue Exception => e
+              debug do
+                "poller: aborted: #{e.class}: #{e}\n  #{e.backtrace.join("\n  ")}"
+              end
+              raise
+            ensure
+              @poller = nil
             end
           }
         end
       end
 
       def stop
+        debug { "stopping poller: #{@poller.inspect}" }
         if @poller
           @poller.kill
           @poller = nil
         end
       end
 
+      def running?
+        @poller && @poller.alive?
+      end
+
       def subjects_changed
-        @mtime = compute_mtime
+        computed = compute_mtime
+        debug { "subjects_changed: mtime #{@mtime} -> #{computed}" }
+        @mtime = computed
       end
 
       private
 
       def compute_mtime
-        expanded_files.map { |f| File.mtime(f).to_f }.max || 0
-      rescue Errno::ENOENT
-        # if a file does no longer exist, the watcher is always stale.
-        Float::MAX
+        expanded_files.map do |f|
+          # Get the mtime of symlink targets. Ignore dangling symlinks.
+          if File.symlink?(f)
+            begin
+              File.mtime(f)
+            rescue Errno::ENOENT
+              0
+            end
+          # If a file no longer exists, treat it as changed.
+          else
+            begin
+              File.mtime(f)
+            rescue Errno::ENOENT
+              debug { "compute_mtime: no longer exists: #{f}" }
+              Float::MAX
+            end
+          end.to_f
+        end.max || 0
       end
 
       def expanded_files
-        files + Dir["{#{directories.map { |d| "#{d}/**/*" }.join(",")}}"]
+        (files.keys + Dir["{#{directories.keys.map { |d| "#{d}/**/*" }.join(",")}}"]).uniq
       end
     end
   end

data/lib/spring/watcher.rb

@@ -25,6 +25,6 @@ module Spring
   end
 
   def self.watch(*items)
-    watcher.add *items
+    watcher.add(*items)
   end
 end

metadata

@@ -1,44 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: spring
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Jon Leighton
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
-dependencies:
-- !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'
-- !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'
-description: Rails application preloader
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Preloads your application so things like console, rake and tests run
+  faster
 email:
 - j@jonathanleighton.com
 executables:
@@ -46,14 +18,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/spring
 - lib/spring/application.rb
 - lib/spring/application/boot.rb
@@ -66,6 +32,7 @@ files:
 - lib/spring/client/help.rb
 - lib/spring/client/rails.rb
 - lib/spring/client/run.rb
+- lib/spring/client/server.rb
 - lib/spring/client/status.rb
 - lib/spring/client/stop.rb
 - lib/spring/client/version.rb
@@ -76,34 +43,20 @@ files:
 - lib/spring/configuration.rb
 - lib/spring/env.rb
 - lib/spring/errors.rb
+- lib/spring/failsafe_thread.rb
 - lib/spring/json.rb
 - lib/spring/process_title_updater.rb
 - lib/spring/server.rb
-- lib/spring/sid.rb
-- lib/spring/test.rb
-- lib/spring/test/acceptance_test.rb
-- lib/spring/test/application.rb
-- lib/spring/test/application_generator.rb
-- lib/spring/test/rails_version.rb
-- lib/spring/test/watcher_test.rb
 - lib/spring/version.rb
 - lib/spring/watcher.rb
 - lib/spring/watcher/abstract.rb
 - lib/spring/watcher/polling.rb
-- spring.gemspec
-- test/acceptance_test.rb
-- test/apps/.gitignore
-- test/helper.rb
-- test/unit/client/help_test.rb
-- test/unit/client/version_test.rb
-- test/unit/commands_test.rb
-- test/unit/process_title_updater_test.rb
-- test/unit/watcher_test.rb
-homepage: http://github.com/rails/spring
+homepage: https://github.com/rails/spring
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  changelog_uri: https://github.com/rails/spring/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -111,24 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Rails application preloader
-test_files:
-- test/acceptance_test.rb
-- test/apps/.gitignore
-- test/helper.rb
-- test/unit/client/help_test.rb
-- test/unit/client/version_test.rb
-- test/unit/commands_test.rb
-- test/unit/process_title_updater_test.rb
-- test/unit/watcher_test.rb
+test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.rvmrc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.ruby-version

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
-env:
-  - RAILS_VERSION="~> 3.2.0"
-  - RAILS_VERSION="~> 4.0.0"
-  - RAILS_VERSION="~> 4.1.0"
-before_script:
-  - travis_retry gem install rails --version "$RAILS_VERSION"